net.percederberg.mibble.snmp
Class SnmpModuleCompliance

java.lang.Object
  |
  +--net.percederberg.mibble.snmp.SnmpModuleCompliance
All Implemented Interfaces:
MibType

public class SnmpModuleCompliance
extends java.lang.Object
implements MibType

An SNMP module compliance type.

Since:

Constructor Summary
SnmpModuleCompliance(SnmpStatus status, java.lang.String description, java.lang.String reference, java.util.ArrayList modules)
          Creates a new SNMP module compliance type.
 
Method Summary
 java.lang.String getDescription()
          Returns the type description.
 java.util.ArrayList getModules()
          Returns the list of SNMP modules.
 java.lang.String getReference()
          Returns the type reference.
 SnmpStatus getStatus()
          Returns the type 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

SnmpModuleCompliance

public SnmpModuleCompliance(SnmpStatus status,
                            java.lang.String description,
                            java.lang.String reference,
                            java.util.ArrayList modules)
Creates a new SNMP module compliance type.

Parameters:
status - the type status
description - the type description
reference - the type reference, or null
modules - the list of SNMP modules
Method Detail

initialize

public MibType initialize(MibLoaderLog log)
                   throws MibException
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
Throws:
MibException - if an error was encountered during the initialization

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 type status.

Returns:
the type status

getDescription

public java.lang.String getDescription()
Returns the type description.

Returns:
the type description

getReference

public java.lang.String getReference()
Returns the type reference.

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

getModules

public java.util.ArrayList getModules()
Returns the list of SNMP modules.

Returns:
the list of SNMP modules
See Also:
SnmpModule

toString

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

Overrides:
toString in class java.lang.Object
Returns:
a string representation of this object