com.ibm.diameter.packet
Class AvpABNF

java.lang.Object
  extended by com.ibm.diameter.packet.AvpABNF

public class AvpABNF
extends java.lang.Object

The AvpABNF class is used to define the characteristics that a grouped AVP must have to be a valid AVP. It applies to grouped AVPs which include other AVPs some of which might be required, others that are optional, and so on. This information is used by the AvpValidatorUtil classes to validate the structure of the Avp object.


Field Summary
protected  java.util.ArrayList<java.lang.Integer> optionalButSingleInstanceAvps
          A list of all the AVPs that are optional, but if present are only allowed a single instance
protected  java.util.ArrayList<java.lang.Integer> optionalMoreThanOneAvps
          A list of all the AVPs that are optional
protected  java.util.ArrayList<java.lang.Integer> requiredButSingleInstanceAvps
          A list of all the AVPs that are required and must contain only a single instance.
protected  java.util.ArrayList<java.lang.Integer> requiredMoreThanOneAvps
          A list of all the AVPs that require at least one instance, but allow multiple instances.
 
Constructor Summary
AvpABNF(java.util.ArrayList<java.lang.Integer> optionalButSingleInstanceAvps, java.util.ArrayList<java.lang.Integer> optionalMoreThanOneAvps, java.util.ArrayList<java.lang.Integer> requiredButSingleInstanceAvps, java.util.ArrayList<java.lang.Integer> requiredMoreThanOneAvps)
          Creates an instance of AvpABNF
 
Method Summary
 java.util.ArrayList<java.lang.Integer> getOptionalButSingleInstanceAvps()
          Returns the ArrayList of Integers representing AVPs that are optional, but may occur only once.
 java.util.ArrayList<java.lang.Integer> getOptionalMoreThanOneAvps()
          Returns the ArrayList of Integers representing AVPs that are optional, but may occur multiple times.
 java.util.ArrayList<java.lang.Integer> getRequiredButSingleInstanceAvps()
          Returns the ArrayList of Integers representing AVPs that are required, but must only once.
 java.util.ArrayList<java.lang.Integer> getRequiredMoreThanOneAvps()
          Returns the ArrayList of Integers representing AVPs that are required, but may occur more than once.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

requiredButSingleInstanceAvps

protected java.util.ArrayList<java.lang.Integer> requiredButSingleInstanceAvps
A list of all the AVPs that are required and must contain only a single instance.


requiredMoreThanOneAvps

protected java.util.ArrayList<java.lang.Integer> requiredMoreThanOneAvps
A list of all the AVPs that require at least one instance, but allow multiple instances.


optionalMoreThanOneAvps

protected java.util.ArrayList<java.lang.Integer> optionalMoreThanOneAvps
A list of all the AVPs that are optional


optionalButSingleInstanceAvps

protected java.util.ArrayList<java.lang.Integer> optionalButSingleInstanceAvps
A list of all the AVPs that are optional, but if present are only allowed a single instance

Constructor Detail

AvpABNF

public AvpABNF(java.util.ArrayList<java.lang.Integer> optionalButSingleInstanceAvps,
               java.util.ArrayList<java.lang.Integer> optionalMoreThanOneAvps,
               java.util.ArrayList<java.lang.Integer> requiredButSingleInstanceAvps,
               java.util.ArrayList<java.lang.Integer> requiredMoreThanOneAvps)
Creates an instance of AvpABNF

Parameters:
optionalButSingleInstanceAvps - An ArrayList of Integer objects containing the AVP codes of AVPs that are optional, but can only be present once.
optionalMoreThanOneAvps - An ArrayList of Integer objects containing the AVP codes of AVPs that are optional, but can have multiple occurences.
requiredButSingleInstanceAvps - An ArrayList of Integer objects containing the AVP codes of AVPs that are required, and must occur only once.
requiredMoreThanOneAvps - An ArrayList of Integer objects containing the AVP codes of AVPs that are required, but may have multiple occurences.
Method Detail

getOptionalButSingleInstanceAvps

public java.util.ArrayList<java.lang.Integer> getOptionalButSingleInstanceAvps()
Returns the ArrayList of Integers representing AVPs that are optional, but may occur only once.

Returns:
An ArrayList of Integer objects containing AVP codes. Note that the collection is a cloned, but that the Integer objects that are hold are not cloned.

getOptionalMoreThanOneAvps

public java.util.ArrayList<java.lang.Integer> getOptionalMoreThanOneAvps()
Returns the ArrayList of Integers representing AVPs that are optional, but may occur multiple times.

Returns:
An ArrayList of Integer objects containing AVP codes. Note that the collection is a cloned, but that the Integer objects that are hold are not cloned.

getRequiredButSingleInstanceAvps

public java.util.ArrayList<java.lang.Integer> getRequiredButSingleInstanceAvps()
Returns the ArrayList of Integers representing AVPs that are required, but must only once.

Returns:
An ArrayList of Integer objects containing AVP codes. Note that the collection is a cloned, but that the Integer objects that are hold are not cloned.

getRequiredMoreThanOneAvps

public java.util.ArrayList<java.lang.Integer> getRequiredMoreThanOneAvps()
Returns the ArrayList of Integers representing AVPs that are required, but may occur more than once.

Returns:
An ArrayList of Integer objects containing AVP codes. Note that the collection is a cloned, but that the Integer objects that are hold are not cloned.


Copyright © 2006 IBM Corp. All Rights Reserved.