net.percederberg.mibble.snmp
Class SnmpObjectGroup

java.lang.Object
  extended bynet.percederberg.mibble.MibType
      extended bynet.percederberg.mibble.snmp.SnmpObjectGroup

public class SnmpObjectGroup
extends MibType

The SNMP object group macro type. This macro type was added to SNMPv2 and is defined in RFC 2580.

Since:
2.0
See Also:
RFC 2580 (SNMPv2-CONF)

Constructor Summary
SnmpObjectGroup(java.util.ArrayList objects, SnmpStatus status, java.lang.String description, java.lang.String reference)
          Creates a new SNMP object group.
 
Method Summary
 java.lang.String getDescription()
          Returns the object group description.
 java.util.ArrayList getObjects()
          Returns the value objects.
 java.lang.String getReference()
          Returns the object group reference.
 SnmpStatus getStatus()
          Returns the object group status.
 MibType initialize(MibSymbol symbol, MibLoaderLog log)
          Initializes the MIB type.
 boolean isCompatible(MibValue value)
          Checks if the specified value is compatible with this type.
 java.lang.String toString()
          Returns a string representation of this object.
 
Methods inherited from class net.percederberg.mibble.MibType
createReference, createReference, createReference, getName, getReferenceSymbol, getTag, hasReferenceTo, hasReferenceTo, hasTag, hasTag, isPrimitive, setReferenceSymbol, setTag
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SnmpObjectGroup

public SnmpObjectGroup(java.util.ArrayList objects,
                       SnmpStatus status,
                       java.lang.String description,
                       java.lang.String reference)
Creates a new SNMP object group.

Parameters:
objects - the value objects
status - the object group status
description - the object group description
reference - the object group reference, or null
Method Detail

initialize

public MibType initialize(MibSymbol symbol,
                          MibLoaderLog log)
                   throws MibException
Initializes the MIB type. This will remove all levels of indirection present, such as references to types or values. No information is lost by this operation. This method may modify this object as a side-effect, and will return the basic type.

NOTE: This is an internal method that should only be called by the MIB loader.

Specified by:
initialize in class MibType
Parameters:
symbol - the MIB symbol containing this type
log - the MIB loader log
Returns:
the basic MIB type
Throws:
MibException - if an error was encountered during the initialization
Since:
2.2

isCompatible

public boolean isCompatible(MibValue value)
Checks if the specified value is compatible with this type. A value is compatible if and only if it is an object identifier value.

Specified by:
isCompatible in class MibType
Parameters:
value - the value to check
Returns:
true if the value is compatible, or false otherwise

getObjects

public java.util.ArrayList getObjects()
Returns the value objects. The returned list will consist of MibValue instances.

Returns:
the value objects
See Also:
MibValue

getStatus

public SnmpStatus getStatus()
Returns the object group status.

Returns:
the object group status

getDescription

public java.lang.String getDescription()
Returns the object group description.

Returns:
the object group description

getReference

public java.lang.String getReference()
Returns the object group reference.

Returns:
the object group reference, or null if no reference has been set

toString

public java.lang.String toString()
Returns a string representation of this object.

Overrides:
toString in class MibType
Returns:
a string representation of this object