org.jdiameter.common.impl.validation
Class VAvpRepresentation

java.lang.Object
  org.jdiameter.common.impl.validation.VAvpRepresentation

All Implemented Interfaces:

java.lang.Cloneable

public class VAvpRepresentation
extends java.lang.Object
implements java.lang.Cloneable

Start time:10:50:39 2009-05-26
Project: diameter-parent
Represents command avp, it stores info about presence, multiplicity, avp code, vendor.

Since:

1.5.189

Author:

Bartosz Baranowski , Alexandre Mendonca

Nested Class Summary

static class	VAvpRepresentation.Rule
static class	VAvpRepresentation.Type

Field Summary

static java.lang.String	_DEFAULT_MANDATORY
static java.lang.String	_DEFAULT_PROTECTED
static java.lang.String	_DEFAULT_VENDOR
protected boolean	_mandatory
static java.lang.String	_MP_NOT_ALLOWED 0 The AVP MUST NOT be present in the message. 0+ Zero or more instances of the AVP MAY be present in the message. 0-1 Zero or one instance of the AVP MAY be present in the message.
static java.lang.String	_MP_ONE
static java.lang.String	_MP_ONE_AND_MORE
static java.lang.String	_MP_ZERO_OR_MORE
static java.lang.String	_MP_ZERO_OR_ONE
protected boolean	_protected
protected boolean	allowed
protected java.util.List<VAvpRepresentation>	children
protected int	code
protected boolean	constrained
protected java.lang.String	description
protected boolean	grouped
protected boolean	mayEncrypt
protected java.lang.String	multiplicityIndicator
protected java.lang.String	name
protected java.lang.String	ruleMandatory
protected java.lang.String	ruleProtected
protected java.lang.String	ruleVendorBit
protected java.lang.String	type
protected long	vendor
protected boolean	weak

Constructor Summary

VAvpRepresentation()

VAvpRepresentation(int positionIndex, int code, long vendor, java.lang.String multiplicityIndicator, java.lang.String name)

VAvpRepresentation(int code, long vendor)
This constructor is used my validator to lookup correct representation.

VAvpRepresentation(int code, long vendor, java.lang.String name)

VAvpRepresentation(java.lang.String name, long vendor)
Constructor used to represent weak children. - weak means its only defined by name in some other avp.

VAvpRepresentation(java.lang.String name, java.lang.String description, int code, boolean mayEncrypt, java.lang.String ruleMandatory, java.lang.String ruleProtected, java.lang.String ruleVendorBit, long vendorId, boolean constrained, java.lang.String type)

VAvpRepresentation(VAvpRepresentation clone)

Method Summary

java.lang.Object	clone()
boolean	equals(java.lang.Object obj)
static int	get_FIX_POSITION_INDEX()
java.util.List<VAvpRepresentation>	getChildren()
int	getCode()
java.lang.String	getDescription()
java.lang.String	getMultiplicityIndicator()
java.lang.String	getName()
int	getPositionIndex()
java.lang.String	getRuleMandatory()
int	getRuleMandatoryAsInt()
java.lang.String	getRuleProtected()
int	getRuleProtectedAsInt()
java.lang.String	getRuleVendorBit()
int	getRuleVendorBitAsInt()
java.lang.String	getType()
long	getVendorId()
int	hashCode()
boolean	isAllowed()
boolean	isConstrained()
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(java.util.List<VAvpRepresentation> children)
void	setCode(int code)
void	setGrouped(boolean grouped)
void	setMultiplicityIndicator(java.lang.String multiplicityIndicator)
void	setName(java.lang.String name)
void	setVendorId(long vendor)
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_MP_NOT_ALLOWED

public static final java.lang.String _MP_NOT_ALLOWED

 0     The AVP MUST NOT be present in the message.
 0+    Zero or more instances of the AVP MAY be present in the
       message.
 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.
 1     One instance of the AVP MUST be present in the message.
 1+    At least one instance of the AVP MUST be present in the
       message.
 

See Also:

Constant Field Values

_MP_ZERO_OR_MORE

public static final java.lang.String _MP_ZERO_OR_MORE

See Also:

Constant Field Values

_MP_ZERO_OR_ONE

public static final java.lang.String _MP_ZERO_OR_ONE

See Also:

Constant Field Values

_MP_ONE

public static final java.lang.String _MP_ONE

See Also:

Constant Field Values

_MP_ONE_AND_MORE

public static final java.lang.String _MP_ONE_AND_MORE

See Also:

Constant Field Values

description

protected java.lang.String description

mayEncrypt

protected boolean mayEncrypt

_protected

protected boolean _protected

_mandatory

protected boolean _mandatory

ruleMandatory

protected java.lang.String ruleMandatory

ruleProtected

protected java.lang.String ruleProtected

ruleVendorBit

protected java.lang.String ruleVendorBit

type

protected java.lang.String type

constrained

protected boolean constrained

_DEFAULT_MANDATORY

public static final java.lang.String _DEFAULT_MANDATORY

See Also:

Constant Field Values

_DEFAULT_PROTECTED

public static final java.lang.String _DEFAULT_PROTECTED

See Also:

Constant Field Values

_DEFAULT_VENDOR

public static final java.lang.String _DEFAULT_VENDOR

See Also:

Constant Field Values

code

protected int code

vendor

protected long vendor

allowed

protected boolean allowed

multiplicityIndicator

protected java.lang.String multiplicityIndicator

name

protected java.lang.String name

grouped

protected boolean grouped

children

protected java.util.List<VAvpRepresentation> children

weak

protected boolean weak

Constructor Detail

VAvpRepresentation

public VAvpRepresentation(VAvpRepresentation clone)

VAvpRepresentation

public VAvpRepresentation()

VAvpRepresentation

public VAvpRepresentation(java.lang.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 rep.
This constructor should be generaly used by extending classes, as well as no arg constructor.

Parameters:

name -

vendor -

VAvpRepresentation

public VAvpRepresentation(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 -

VAvpRepresentation

public VAvpRepresentation(int positionIndex,
                          int code,
                          long vendor,
                          java.lang.String multiplicityIndicator,
                          java.lang.String name)

VAvpRepresentation

public VAvpRepresentation(int code,
                          long vendor,
                          java.lang.String name)

VAvpRepresentation

public VAvpRepresentation(java.lang.String name,
                          java.lang.String description,
                          int code,
                          boolean mayEncrypt,
                          java.lang.String ruleMandatory,
                          java.lang.String ruleProtected,
                          java.lang.String ruleVendorBit,
                          long vendorId,
                          boolean constrained,
                          java.lang.String type)

Method Detail

isPositionFixed

public boolean isPositionFixed()

markFixPosition

public void markFixPosition(int index)

isCountValidForMultiplicity

public boolean isCountValidForMultiplicity(int avpCount)

get_FIX_POSITION_INDEX

public static int get_FIX_POSITION_INDEX()

getPositionIndex

public int getPositionIndex()

getCode

public int getCode()

getVendorId

public long getVendorId()

isAllowed

public boolean isAllowed()

getMultiplicityIndicator

public java.lang.String getMultiplicityIndicator()

getName

public java.lang.String getName()

isGrouped

public boolean isGrouped()

setGrouped

public void setGrouped(boolean grouped)

getChildren

public java.util.List<VAvpRepresentation> getChildren()

setChildren

public void setChildren(java.util.List<VAvpRepresentation> children)

setCode

public void setCode(int code)

setVendorId

public void setVendorId(long vendor)

setMultiplicityIndicator

public void setMultiplicityIndicator(java.lang.String multiplicityIndicator)

setName

public void setName(java.lang.String name)

isWeak

public boolean isWeak()

markWeak

public void markWeak(boolean isWeak)

getDescription

public java.lang.String getDescription()

isMayEncrypt

public boolean isMayEncrypt()

getRuleMandatory

public java.lang.String getRuleMandatory()

getRuleMandatoryAsInt

public int getRuleMandatoryAsInt()

getRuleProtected

public java.lang.String getRuleProtected()

getRuleProtectedAsInt

public int getRuleProtectedAsInt()

getRuleVendorBit

public java.lang.String getRuleVendorBit()

getRuleVendorBitAsInt

public int getRuleVendorBitAsInt()

isConstrained

public boolean isConstrained()

getType

public java.lang.String getType()

isProtected

public boolean isProtected()

isMandatory

public boolean isMandatory()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException