SSF.OS.BGP4.Path
Class AtomicAggregate

java.lang.Object
  |
  +--SSF.OS.BGP4.Path.Attribute
        |
        +--SSF.OS.BGP4.Path.AtomicAggregate
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable

public class AtomicAggregate
extends Attribute

The atomic aggregate path attribute. It is used to inform other BGP speakers that the local system selected a less specific route without selecting a more specific route which is included in it. It is well-known and discretionary.

See Also:
Serialized Form

Field Summary
static java.lang.String dmlname
          The name of the path attribute as a DML attribute.
static java.lang.String name
          The name of the attribute as a string.
static int TYPECODE
          The atomic aggregate path attribute type code.
 
Fields inherited from class SSF.OS.BGP4.Path.Attribute
dmlnames, MAX_TYPECODE, MIN_TYPECODE, names, nhidmlnames, undefined
 
Constructor Summary
AtomicAggregate()
          Constructs an atomic aggregate path attribute.
 
Method Summary
 int bytecount()
          Returns the number of octets (bytes) needed to represent this atomic aggregate path attribute in an update message.
 Attribute copy()
          Constructs and returns a copy of the attribute.
 boolean equals(Attribute attrib)
          Determines whether or not this path attribute is equivalent to another.
 boolean opt()
          Returns whether the path attribute is optional (true) or well-known (false).
 boolean partial()
          Returns whether or not the information contained in the optional transitive attribute is partial (true) or complete (false).
 java.lang.String toString()
          Returns this path attribute as a string.
 boolean trans()
          Returns whether an optional attribute is transitive (true) or non-transitive (false).
 
Methods inherited from class SSF.OS.BGP4.Path.Attribute
readExternal, readExternal, writeExternal, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPECODE

public static final int TYPECODE
The atomic aggregate path attribute type code.

See Also:
Constant Field Values

name

public static final java.lang.String name
The name of the attribute as a string.

See Also:
Constant Field Values

dmlname

public static final java.lang.String dmlname
The name of the path attribute as a DML attribute.

See Also:
Constant Field Values
Constructor Detail

AtomicAggregate

public AtomicAggregate()
Constructs an atomic aggregate path attribute.

Method Detail

copy

public Attribute copy()
Constructs and returns a copy of the attribute.

Specified by:
copy in class Attribute
Returns:
a copy of the attribute

opt

public final boolean opt()
Description copied from class: Attribute
Returns whether the path attribute is optional (true) or well-known (false).

Specified by:
opt in class Attribute

trans

public final boolean trans()
Description copied from class: Attribute
Returns whether an optional attribute is transitive (true) or non-transitive (false). For well-known attributes it must be true.

Specified by:
trans in class Attribute

partial

public final boolean partial()
Description copied from class: Attribute
Returns whether or not the information contained in the optional transitive attribute is partial (true) or complete (false). For well-known attributes and for optional non-transitive attributes, it must be false.

Specified by:
partial in class Attribute

bytecount

public int bytecount()
Returns the number of octets (bytes) needed to represent this atomic aggregate path attribute in an update message. The number is the sum of the two octets needed for the attribute type (which contains attribute flags and the attribute type code), the one octet needed for the attribute length, and the zero octets needed for the attribute value.

Specified by:
bytecount in class Attribute
Returns:
the number of octets (bytes) needed to represent this atomic aggregate path attribute in an update message

equals

public boolean equals(Attribute attrib)
Determines whether or not this path attribute is equivalent to another.

Specified by:
equals in class Attribute
Parameters:
attrib - A path attribute to compare to this one.
Returns:
true only if the two attributes are equivalent

toString

public final java.lang.String toString()
Returns this path attribute as a string.

Overrides:
toString in class java.lang.Object
Returns:
the attribute as a string