AvpRepresentationImpl (Restcomm :: Diameter Stack :: jdiameter-impl 1.7.0.101 API)

java.lang.Object
- org.jdiameter.common.impl.validation.AvpRepresentationImpl

All Implemented Interfaces:

AvpRepresentation
```
public class AvpRepresentationImpl
extends Object
implements AvpRepresentation
```
Implementation of AvpRepresentation interface.

Since:

1.5.4.0-build404

Author:

Bartosz Baranowski , Alexandre Mendonca

Nested Class Summary
- Nested classes/interfaces inherited from interface org.jdiameter.api.validation.AvpRepresentation
  AvpRepresentation.Rule, AvpRepresentation.Type

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`_mandatory`
`protected boolean`	`_protected`
`protected boolean`	`allowed`
`protected List<AvpRepresentation>`	`children`
`protected int`	`code`
`protected String`	`description`
`protected boolean`	`grouped`
`protected boolean`	`mayEncrypt`
`protected String`	`multiplicityIndicator`
`protected String`	`name`
`protected String`	`ruleMandatory`
`protected String`	`ruleProtected`
`protected String`	`ruleVendorBit`
`protected String`	`type`
`protected long`	`vendor`
`protected boolean`	`weak`

Fields inherited from interface org.jdiameter.api.validation.AvpRepresentation
_DEFAULT_MANDATORY, _DEFAULT_PROTECTED, _DEFAULT_VENDOR, _FIX_POSITION_INDEX, _MP_NOT_ALLOWED, _MP_ONE, _MP_ONE_AND_MORE, _MP_ZERO_OR_MORE, _MP_ZERO_OR_ONE

Constructor Summary

Constructors
Constructor and Description
`AvpRepresentationImpl()`
`AvpRepresentationImpl(AvpRepresentationImpl clone)`
`AvpRepresentationImpl(int positionIndex, int code, long vendor, String multiplicityIndicator, String name)`
`AvpRepresentationImpl(int code, long vendor)` This constructor is used my validator to lookup correct representation.
`AvpRepresentationImpl(int code, long vendor, String name)`
`AvpRepresentationImpl(String name, long vendor)` Constructor used to represent weak children.
`AvpRepresentationImpl(String name, String description, int code, boolean mayEncrypt, String ruleMandatory, String ruleProtected, String ruleVendorBit, long vendorId, String type)`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`boolean`	`equals(Object obj)`
`static int`	`get_FIX_POSITION_INDEX()`
`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()`
`void`	`markFixPosition(int index)`
`void`	`markWeak(boolean isWeak)`
`void`	`setChildren(List<AvpRepresentation> children)`
`void`	`setCode(int code)`
`void`	`setGrouped(boolean grouped)`
`void`	`setMultiplicityIndicator(String multiplicityIndicator)`
`void`	`setName(String name)`
`void`	`setVendorId(long vendor)`
`String`	`toString()`
`void`	`validate(Avp avp)`
`void`	`validate(AvpSet avpSet)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - description
```
protected String description
```
  - mayEncrypt
```
protected boolean mayEncrypt
```
  - _protected
```
protected boolean _protected
```
  - _mandatory
```
protected boolean _mandatory
```
  - ruleMandatory
```
protected String ruleMandatory
```
  - ruleProtected
```
protected String ruleProtected
```
  - ruleVendorBit
```
protected String ruleVendorBit
```
  - type
```
protected String type
```
  - code
```
protected int code
```
  - vendor
```
protected long vendor
```
  - allowed
```
protected boolean allowed
```
  - multiplicityIndicator
```
protected String multiplicityIndicator
```
  - name
```
protected String name
```
  - grouped
```
protected boolean grouped
```
  - children
```
protected List<AvpRepresentation> children
```
  - weak
```
protected boolean weak
```
- Constructor Detail
  - AvpRepresentationImpl
```
public AvpRepresentationImpl(AvpRepresentationImpl clone)
```
  - AvpRepresentationImpl
```
public AvpRepresentationImpl()
```
  - AvpRepresentationImpl
```
public AvpRepresentationImpl(String name,
                     long vendor)
```
    Constructor used to represent weak children. - weak means its only defined by name in some other AVP. After configuration parse procedure is complete weak children are resolved. Weak children should not be stored in Set or any other has structure, its due to nature of hashing, which is done on vendor and code, which for weak children is always different than fully defined AVP representation.
    This constructor should be generally used by extending classes, as well as no argument constructor.
    
    Parameters:
    name -
    vendor -
  - AvpRepresentationImpl
```
public AvpRepresentationImpl(int code,
                     long vendor)
```
    This constructor is used my validator to lookup correct representation. Its hash and equals methods will match to fully populated avp representation in any data structure
    
    Parameters:
    code -
    vendor -
  - AvpRepresentationImpl
```
public AvpRepresentationImpl(int positionIndex,
                     int code,
                     long vendor,
                     String multiplicityIndicator,
                     String name)
```
  - AvpRepresentationImpl
```
public AvpRepresentationImpl(int code,
                     long vendor,
                     String name)
```
  - AvpRepresentationImpl
```
public AvpRepresentationImpl(String name,
                     String description,
                     int code,
                     boolean mayEncrypt,
                     String ruleMandatory,
                     String ruleProtected,
                     String ruleVendorBit,
                     long vendorId,
                     String type)
```
- Method Detail
  - isPositionFixed
```
public boolean isPositionFixed()
```
    Specified by:
    
    isPositionFixed in interface AvpRepresentation
  - markFixPosition
```
public void markFixPosition(int index)
```
  - isCountValidForMultiplicity
```
public boolean isCountValidForMultiplicity(AvpSet destination,
                                  int numberToAdd)
```
    Specified by:
    
    isCountValidForMultiplicity in interface AvpRepresentation
  - isCountValidForMultiplicity
```
public boolean isCountValidForMultiplicity(int avpCount)
```
    Specified by:
    
    isCountValidForMultiplicity in interface AvpRepresentation
  - get_FIX_POSITION_INDEX
```
public static int get_FIX_POSITION_INDEX()
```
  - getPositionIndex
```
public int getPositionIndex()
```
    Specified by:
    
    getPositionIndex in interface AvpRepresentation
  - getCode
```
public int getCode()
```
    Specified by:
    
    getCode in interface AvpRepresentation
  - getVendorId
```
public long getVendorId()
```
    Specified by:
    
    getVendorId in interface AvpRepresentation
  - isAllowed
```
public boolean isAllowed()
```
    Specified by:
    
    isAllowed in interface AvpRepresentation
  - isAllowed
```
public boolean isAllowed(int avpCode,
                long vendorId)
```
    Specified by:
    
    isAllowed in interface AvpRepresentation
  - isAllowed
```
public boolean isAllowed(int avpCode)
```
    Specified by:
    
    isAllowed in interface AvpRepresentation
  - getMultiplicityIndicator
```
public String getMultiplicityIndicator()
```
    Specified by:
    
    getMultiplicityIndicator in interface AvpRepresentation
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface AvpRepresentation
  - isGrouped
```
public boolean isGrouped()
```
    Specified by:
    
    isGrouped in interface AvpRepresentation
  - setGrouped
```
public void setGrouped(boolean grouped)
```
  - getChildren
```
public List<AvpRepresentation> getChildren()
```
    Specified by:
    
    getChildren in interface AvpRepresentation
  - setChildren
```
public void setChildren(List<AvpRepresentation> children)
```
  - setCode
```
public void setCode(int code)
```
  - setVendorId
```
public void setVendorId(long vendor)
```
  - setMultiplicityIndicator
```
public void setMultiplicityIndicator(String multiplicityIndicator)
```
  - setName
```
public void setName(String name)
```
  - isWeak
```
public boolean isWeak()
```
    Specified by:
    
    isWeak in interface AvpRepresentation
  - markWeak
```
public void markWeak(boolean isWeak)
```
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface AvpRepresentation
  - isMayEncrypt
```
public boolean isMayEncrypt()
```
    Specified by:
    
    isMayEncrypt in interface AvpRepresentation
  - getRuleMandatory
```
public String getRuleMandatory()
```
    Specified by:
    
    getRuleMandatory in interface AvpRepresentation
  - getRuleMandatoryAsInt
```
public int getRuleMandatoryAsInt()
```
    Specified by:
    
    getRuleMandatoryAsInt in interface AvpRepresentation
  - getRuleProtected
```
public String getRuleProtected()
```
    Specified by:
    
    getRuleProtected in interface AvpRepresentation
  - getRuleProtectedAsInt
```
public int getRuleProtectedAsInt()
```
    Specified by:
    
    getRuleProtectedAsInt in interface AvpRepresentation
  - getRuleVendorBit
```
public String getRuleVendorBit()
```
    Specified by:
    
    getRuleVendorBit in interface AvpRepresentation
  - getRuleVendorBitAsInt
```
public int getRuleVendorBitAsInt()
```
    Specified by:
    
    getRuleVendorBitAsInt in interface AvpRepresentation
  - getType
```
public String getType()
```
    Specified by:
    
    getType in interface AvpRepresentation
  - isProtected
```
public boolean isProtected()
```
    Specified by:
    
    isProtected in interface AvpRepresentation
  - isMandatory
```
public boolean isMandatory()
```
    Specified by:
    
    isMandatory in interface AvpRepresentation
  - validate
```
public void validate(Avp avp)
              throws AvpNotAllowedException
```
    Specified by:
    
    validate in interface AvpRepresentation
    
    Throws:
    
    AvpNotAllowedException
  - validate
```
public void validate(AvpSet avpSet)
              throws AvpNotAllowedException
```
    Specified by:
    
    validate in interface AvpRepresentation
    
    Throws:
    
    AvpNotAllowedException
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface AvpRepresentation
    
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface AvpRepresentation
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface AvpRepresentation
    
    Overrides:
    
    equals in class Object
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Specified by:
    
    clone in interface AvpRepresentation
    
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException

Class AvpRepresentationImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.jdiameter.api.validation.AvpRepresentation

Field Summary

Fields inherited from interface org.jdiameter.api.validation.AvpRepresentation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

description

mayEncrypt

_protected

_mandatory

ruleMandatory

ruleProtected

ruleVendorBit

type

code

vendor

allowed

multiplicityIndicator

name

grouped

children

weak

Constructor Detail

AvpRepresentationImpl

AvpRepresentationImpl

AvpRepresentationImpl

AvpRepresentationImpl

AvpRepresentationImpl

AvpRepresentationImpl

AvpRepresentationImpl

Method Detail

isPositionFixed

markFixPosition

isCountValidForMultiplicity

isCountValidForMultiplicity

get_FIX_POSITION_INDEX

getPositionIndex

getCode

getVendorId

isAllowed

isAllowed

isAllowed

getMultiplicityIndicator

getName

isGrouped

setGrouped

getChildren

setChildren

setCode

setVendorId

setMultiplicityIndicator

setName

isWeak

markWeak

getDescription

isMayEncrypt

getRuleMandatory

getRuleMandatoryAsInt

getRuleProtected

getRuleProtectedAsInt

getRuleVendorBit

getRuleVendorBitAsInt

getType

isProtected

isMandatory

validate

validate

toString

hashCode

equals

clone