net.percederberg.mibble.snmp
Class SnmpObjectIdentity

java.lang.Object
  extended bynet.percederberg.mibble.snmp.SnmpObjectIdentity
All Implemented Interfaces:
MibType

public class SnmpObjectIdentity
extends java.lang.Object
implements MibType

An SNMP object identity.

Since:
2.0

Constructor Summary
SnmpObjectIdentity(SnmpStatus status, java.lang.String description, java.lang.String reference)
          Creates a new SNMP object identity.
 
Method Summary
 java.lang.String getDescription()
          Returns the object identity description.
 java.lang.String getReference()
          Returns the object identity reference.
 SnmpStatus getStatus()
          Returns the object identity status.
 MibType initialize(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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SnmpObjectIdentity

public SnmpObjectIdentity(SnmpStatus status,
                          java.lang.String description,
                          java.lang.String reference)
Creates a new SNMP object identity.

Parameters:
status - the object identity status
description - the object identity description
reference - the object identity reference, or null
Method Detail

initialize

public MibType initialize(MibLoaderLog log)
Initializes the MIB type. This will remove all levels of indirection present, such as references to other types, and returns the basic type. No type information is lost by this operation. This method may modify this object as a side-effect, and will be called by the MIB loader.

Specified by:
initialize in interface MibType
Parameters:
log - the MIB loader log
Returns:
the basic MIB type

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 interface MibType
Parameters:
value - the value to check
Returns:
true if the value is compatible, or false otherwise

getStatus

public SnmpStatus getStatus()
Returns the object identity status.

Returns:
the object identity status

getDescription

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

Returns:
the object identity description

getReference

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

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

toString

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

Returns:
a string representation of this object