AvpRepresentation (Restcomm :: Diameter Stack :: jdiameter-api 1.7.0.117 API)

```
public interface AvpRepresentation
```
Represents avp, it stores info about presence, multiplicity, avp code, vendor.

Since:

1.5.4.0-build404

Author:

Bartosz Baranowski , Alexandre Mendonca

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class AvpRepresentation.Rule

static class AvpRepresentation.Type

Nested Classes
Modifier and Type	Interface and Description
`static class`	`AvpRepresentation.Rule`
`static class`	`AvpRepresentation.Type`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`_DEFAULT_MANDATORY`
`static String`	`_DEFAULT_PROTECTED`
`static String`	`_DEFAULT_VENDOR`
`static int`	`_FIX_POSITION_INDEX`
`static String`	`_MP_NOT_ALLOWED` Represents multiplicity of AVP: 0 The AVP MUST NOT be present in the message.
`static String`	`_MP_ONE` Represents multiplicity of AVP: 1 One instance of the AVP MUST be present in the message.
`static String`	`_MP_ONE_AND_MORE` Represents multiplicity of AVP: 1+ At least one instance of the AVP MUST be present in the message.
`static String`	`_MP_ZERO_OR_MORE` Represents multiplicity of AVP: 0+ Zero or more instances of the AVP MAY be present in the message.
`static String`	`_MP_ZERO_OR_ONE` Represents multiplicity of AVP: 0-1 Zero or one instance of the AVP MAY be present in the message.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`boolean`	`equals(Object obj)`
`List<AvpRepresentation>`	`getChildren()`
`int`	`getCode()`
`String`	`getDescription()`
`String`	`getMultiplicityIndicator()`
`String`	`getName()`
`int`	`getPositionIndex()`
`String`	`getRuleMandatory()`
`int`	`getRuleMandatoryAsInt()`
`String`	`getRuleProtected()`
`int`	`getRuleProtectedAsInt()`
`String`	`getRuleVendorBit()`
`int`	`getRuleVendorBitAsInt()`
`String`	`getType()`
`long`	`getVendorId()`
`int`	`hashCode()`
`boolean`	`isAllowed()`
`boolean`	`isAllowed(int avpCode)`
`boolean`	`isAllowed(int avpCode, long vendorId)`
`boolean`	`isCountValidForMultiplicity(AvpSet destination, int numberToAdd)`
`boolean`	`isCountValidForMultiplicity(int avpCount)`
`boolean`	`isGrouped()`
`boolean`	`isMandatory()`
`boolean`	`isMayEncrypt()`
`boolean`	`isPositionFixed()`
`boolean`	`isProtected()`
`boolean`	`isWeak()`
`String`	`toString()`
`void`	`validate(Avp avp)` Validates passed avp.
`void`	`validate(AvpSet avpSet)` Validates passed avp.

Field Detail

_MP_NOT_ALLOWED

static final String _MP_NOT_ALLOWED

 Represents multiplicity of AVP:
 0     The AVP MUST NOT be present in the message.

See Also:: Constant Field Values

_MP_ZERO_OR_MORE

static final String _MP_ZERO_OR_MORE

 Represents multiplicity of AVP:
 0+    Zero or more instances of the AVP MAY be present in the message.

See Also:: Constant Field Values

_MP_ZERO_OR_ONE

static final String _MP_ZERO_OR_ONE

 Represents multiplicity of AVP:
 0-1   Zero or one instance of the AVP MAY be present in the message.
       It is considered an error if there are more than one instance of the AVP.

See Also:: Constant Field Values

_MP_ONE

static final String _MP_ONE

 Represents multiplicity of AVP:
 1     One instance of the AVP MUST be present in the message.
       message.

See Also:: Constant Field Values

_MP_ONE_AND_MORE

static final String _MP_ONE_AND_MORE

 Represents multiplicity of AVP:
 1+    At least one instance of the AVP MUST be present in the
       message.

See Also:: Constant Field Values

_DEFAULT_MANDATORY
```
static final String _DEFAULT_MANDATORY
```
See Also:
Constant Field Values

_DEFAULT_PROTECTED
```
static final String _DEFAULT_PROTECTED
```
See Also:
Constant Field Values

_DEFAULT_VENDOR
```
static final String _DEFAULT_VENDOR
```
See Also:
Constant Field Values

_FIX_POSITION_INDEX
```
static final int _FIX_POSITION_INDEX
```
See Also:
Constant Field Values

Method Detail

isPositionFixed
```
boolean isPositionFixed()
```

isCountValidForMultiplicity

boolean isCountValidForMultiplicity(int avpCount)

isCountValidForMultiplicity

boolean isCountValidForMultiplicity(AvpSet destination,
                                  int numberToAdd)

isAllowed

boolean isAllowed(int avpCode,
                long vendorId)

isAllowed
```
boolean isAllowed(int avpCode)
```

getPositionIndex
```
int getPositionIndex()
```

getCode
```
int getCode()
```

getVendorId
```
long getVendorId()
```

isAllowed
```
boolean isAllowed()
```

getMultiplicityIndicator
```
String getMultiplicityIndicator()
```

getName
```
String getName()
```

isGrouped
```
boolean isGrouped()
```

getChildren
```
List<AvpRepresentation> getChildren()
```

isWeak
```
boolean isWeak()
```

getDescription
```
String getDescription()
```

isMayEncrypt
```
boolean isMayEncrypt()
```

getRuleMandatory
```
String getRuleMandatory()
```

getRuleMandatoryAsInt
```
int getRuleMandatoryAsInt()
```

getRuleProtected
```
String getRuleProtected()
```

getRuleProtectedAsInt
```
int getRuleProtectedAsInt()
```

getRuleVendorBit
```
String getRuleVendorBit()
```

getRuleVendorBitAsInt
```
int getRuleVendorBitAsInt()
```

getType
```
String getType()
```

isProtected
```
boolean isProtected()
```

isMandatory
```
boolean isMandatory()
```

validate
```
void validate(Avp avp)
              throws AvpNotAllowedException
```
Validates passed avp.

Parameters:
avp - - simply avp which should be confronted vs definition

Throws:

AvpNotAllowedException

validate
```
void validate(AvpSet avpSet)
              throws AvpNotAllowedException
```
Validates passed avp.

Parameters:
avpSet - - AvpSet which represents internal content of this avp

Throws:

AvpNotAllowedException

toString
```
String toString()
```
Overrides:

toString in class Object

hashCode
```
int hashCode()
```
Overrides:

hashCode in class Object

equals
```
boolean equals(Object obj)
```
Overrides:

equals in class Object

clone

Object clone()
             throws CloneNotSupportedException

Throws:: CloneNotSupportedException

Interface AvpRepresentation

Nested Class Summary

Field Summary

Method Summary

Field Detail

_MP_NOT_ALLOWED

_MP_ZERO_OR_MORE

_MP_ZERO_OR_ONE

_MP_ONE

_MP_ONE_AND_MORE

_DEFAULT_MANDATORY

_DEFAULT_PROTECTED

_DEFAULT_VENDOR

_FIX_POSITION_INDEX

Method Detail

isPositionFixed

isCountValidForMultiplicity

isCountValidForMultiplicity

isAllowed

isAllowed

getPositionIndex

getCode

getVendorId

isAllowed

getMultiplicityIndicator

getName

isGrouped

getChildren

isWeak

getDescription

isMayEncrypt

getRuleMandatory

getRuleMandatoryAsInt

getRuleProtected

getRuleProtectedAsInt

getRuleVendorBit

getRuleVendorBitAsInt

getType

isProtected

isMandatory

validate

validate

toString

hashCode

equals

clone