net.percederberg.mibble.snmp
Class SnmpVariation

java.lang.Object
  extended bynet.percederberg.mibble.snmp.SnmpVariation

public class SnmpVariation
extends java.lang.Object

An SNMP module variation declaration. This declaration is used inside a module support declaration.

Since:
2.0

Constructor Summary
SnmpVariation(MibValue value, MibType syntax, MibType writeSyntax, SnmpAccess access, java.util.ArrayList requiredCells, MibValue defaultValue, java.lang.String description)
          Creates a new SNMP module variation.
 
Method Summary
 SnmpAccess getAccess()
          Returns the access mode.
 MibValue getDefaultValue()
          Returns the default value.
 java.lang.String getDescription()
          Returns the variation description.
 java.util.ArrayList getRequiredCells()
          Returns cell values required for creation.
 MibType getSyntax()
          Returns the value syntax.
 MibValue getValue()
          Returns the value.
 MibType getWriteSyntax()
          Returns the value write syntax.
 void initialize(MibLoaderLog log)
          Initializes the object.
 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

SnmpVariation

public SnmpVariation(MibValue value,
                     MibType syntax,
                     MibType writeSyntax,
                     SnmpAccess access,
                     java.util.ArrayList requiredCells,
                     MibValue defaultValue,
                     java.lang.String description)
Creates a new SNMP module variation.

Parameters:
value - the variation value
syntax - the value syntax, or null
writeSyntax - the value write syntax, or null
access - the access mode, or null
requiredCells - the cell values required for creation
defaultValue - the default value, or null
description - the variation description
Method Detail

initialize

public void initialize(MibLoaderLog log)
                throws MibException
Initializes the object. 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.

Parameters:
log - the MIB loader log
Throws:
MibException - if an error was encountered during the initialization

getValue

public MibValue getValue()
Returns the value.

Returns:
the value

getSyntax

public MibType getSyntax()
Returns the value syntax.

Returns:
the value syntax, or null if not set

getWriteSyntax

public MibType getWriteSyntax()
Returns the value write syntax.

Returns:
the value write syntax, or null if not set

getAccess

public SnmpAccess getAccess()
Returns the access mode.

Returns:
the access mode, or null if not set

getRequiredCells

public java.util.ArrayList getRequiredCells()
Returns cell values required for creation.

Returns:
cell values required for creation
See Also:
MibValue

getDefaultValue

public MibValue getDefaultValue()
Returns the default value.

Returns:
the default value, or null if no default value has been set

getDescription

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

Returns:
the variation description

toString

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

Returns:
a string representation of this object