public class

EnumRowStatus

extends Enumerated
implements Serializable
java.lang.Object
   ↳ com.sun.jmx.snmp.Enumerated
     ↳ com.sun.jmx.snmp.EnumRowStatus

Class Overview

This class is an internal class which is used to represent RowStatus codes as defined in RFC 2579. It defines an additional code, unspecified, which is implementation specific, and is used to identify unspecified actions (when for instance the RowStatus variable is not present in the varbind list) or uninitialized values. mibgen does not generate objects of this class but any variable using the RowStatus textual convention can be converted into an object of this class thanks to the EnumRowStatus(Enumerated valueIndex) constructor.

This API is a Sun Microsystems internal API and is subject to change without notice.

Summary

Constants
int active This value corresponds to the active RowStatus, as defined in RFC 2579 from SMIv2:
    active indicates that the conceptual row is available for use by the managed device;
int createAndGo This value corresponds to the createAndGo RowStatus, as defined in RFC 2579 from SMIv2:
    createAndGo is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device;
int createAndWait This value corresponds to the createAndWait RowStatus, as defined in RFC 2579 from SMIv2:
    createAndWait is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device);
int destroy This value corresponds to the destroy RowStatus, as defined in RFC 2579 from SMIv2:
    destroy is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.
int notInService This value corresponds to the notInService RowStatus, as defined in RFC 2579 from SMIv2:
    notInService indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device; notInService has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device;
int notReady This value corresponds to the notReady RowStatus, as defined in RFC 2579 from SMIv2:
    notReady indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instantiated);
int unspecified This value is SNMP Runtime implementation specific, and is used to identify unspecified actions (when for instance the RowStatus variable is not present in the varbind list) or uninitialized values.
[Expand]
Inherited Fields
From class com.sun.jmx.snmp.Enumerated
Public Constructors
EnumRowStatus(int valueIndex)
Build an EnumRowStatus from an int.
EnumRowStatus(Enumerated valueIndex)
Build an EnumRowStatus from an Enumerated.
EnumRowStatus(long valueIndex)
Build an EnumRowStatus from a long.
EnumRowStatus(Integer valueIndex)
Build an EnumRowStatus from an Integer.
EnumRowStatus(Long valueIndex)
Build an EnumRowStatus from a Long.
EnumRowStatus()
Build an EnumRowStatus with unspecified value.
EnumRowStatus(String x)
Build an EnumRowStatus from a String.
EnumRowStatus(SnmpInt valueIndex)
Build an EnumRowStatus from an SnmpInt.
Public Methods
static boolean isValidValue(int value)
Check that the given value is valid.
SnmpInt toSnmpValue()
Build an SnmpValue from this object.
Protected Methods
Hashtable getIntTable()
Returns the hashtable of the integer forms.
Hashtable getStringTable()
Returns the hashtable of the string forms.
[Expand]
Inherited Methods
From class com.sun.jmx.snmp.Enumerated
From class java.lang.Object

Constants

public static final int active

This value corresponds to the active RowStatus, as defined in RFC 2579 from SMIv2:

    active indicates that the conceptual row is available for use by the managed device;

Constant Value: 1 (0x00000001)

public static final int createAndGo

This value corresponds to the createAndGo RowStatus, as defined in RFC 2579 from SMIv2:

    createAndGo is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device;

Constant Value: 4 (0x00000004)

public static final int createAndWait

This value corresponds to the createAndWait RowStatus, as defined in RFC 2579 from SMIv2:

    createAndWait is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device);

Constant Value: 5 (0x00000005)

public static final int destroy

This value corresponds to the destroy RowStatus, as defined in RFC 2579 from SMIv2:

    destroy is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.

Constant Value: 6 (0x00000006)

public static final int notInService

This value corresponds to the notInService RowStatus, as defined in RFC 2579 from SMIv2:

    notInService indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device; notInService has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device;

Constant Value: 2 (0x00000002)

public static final int notReady

This value corresponds to the notReady RowStatus, as defined in RFC 2579 from SMIv2:

    notReady indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instantiated);

Constant Value: 3 (0x00000003)

public static final int unspecified

This value is SNMP Runtime implementation specific, and is used to identify unspecified actions (when for instance the RowStatus variable is not present in the varbind list) or uninitialized values.

Constant Value: 0 (0x00000000)

Public Constructors

public EnumRowStatus (int valueIndex)

Build an EnumRowStatus from an int.

Parameters
valueIndex should be either 0 (unspecified), or one of the values defined in RFC 2579.
Throws
IllegalArgumentException if the given valueIndex is not valid.

public EnumRowStatus (Enumerated valueIndex)

Build an EnumRowStatus from an Enumerated.

Parameters
valueIndex should be either 0 (unspecified), or one of the values defined in RFC 2579.
Throws
IllegalArgumentException if the given valueIndex is not valid.

public EnumRowStatus (long valueIndex)

Build an EnumRowStatus from a long.

Parameters
valueIndex should be either 0 (unspecified), or one of the values defined in RFC 2579.
Throws
IllegalArgumentException if the given valueIndex is not valid.

public EnumRowStatus (Integer valueIndex)

Build an EnumRowStatus from an Integer.

Parameters
valueIndex should be either 0 (unspecified), or one of the values defined in RFC 2579.
Throws
IllegalArgumentException if the given valueIndex is not valid.

public EnumRowStatus (Long valueIndex)

Build an EnumRowStatus from a Long.

Parameters
valueIndex should be either 0 (unspecified), or one of the values defined in RFC 2579.
Throws
IllegalArgumentException if the given valueIndex is not valid.

public EnumRowStatus ()

Build an EnumRowStatus with unspecified value.

public EnumRowStatus (String x)

Build an EnumRowStatus from a String.

Parameters
x should be either "unspecified", or one of the values defined in RFC 2579 ("active", "notReady", etc...)
Throws
IllegalArgumentException if the given String x is not valid.

public EnumRowStatus (SnmpInt valueIndex)

Build an EnumRowStatus from an SnmpInt.

Parameters
valueIndex should be either 0 (unspecified), or one of the values defined in RFC 2579.
Throws
IllegalArgumentException if the given valueIndex is not valid.

Public Methods

public static boolean isValidValue (int value)

Check that the given value is valid. Valid values are:

  • unspecified(0)
  • active(1)
  • notInService(2)
  • notReady(3)
  • createAndGo(4)
  • createAndWait(5)
  • destroy(6)

public SnmpInt toSnmpValue ()

Build an SnmpValue from this object.

Returns
  • an SnmpInt containing this object value.
Throws
IllegalArgumentException if this object holds an unspecified value.

Protected Methods

protected Hashtable getIntTable ()

Returns the hashtable of the integer forms. getIntTable().get(x) returns the string form associated to the integer x. This method must be implemented by the derived class.

Returns
  • An hashtable for read-only purpose

protected Hashtable getStringTable ()

Returns the hashtable of the string forms. getStringTable().get(s) returns the integer form associated to the string s. This method must be implemented by the derived class.

Returns
  • An hashtable for read-only purpose