FileDocCategorySizeDatePackage
EnumRowStatus.javaAPI DocJava SE 5 API9529Fri Aug 26 14:55:02 BST 2005com.sun.jmx.snmp

EnumRowStatus

public class EnumRowStatus extends com.sun.jmx.snmp.Enumerated implements Serializable
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.

Fields Summary
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.
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;
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;
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);
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;
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);
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.
static final Hashtable
intTable
static final Hashtable
stringTable
Constructors Summary
public EnumRowStatus(int valueIndex)
Build an EnumRowStatus from an int.

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


                                                           
       
	  
	super(valueIndex);
public EnumRowStatus(com.sun.jmx.snmp.Enumerated valueIndex)
Build an EnumRowStatus from an Enumerated.

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

	this(valueIndex.intValue());
public EnumRowStatus(long valueIndex)
Build an EnumRowStatus from a long.

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

	this((int)valueIndex);
public EnumRowStatus(Integer valueIndex)
Build an EnumRowStatus from an Integer.

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

	super(valueIndex);
public EnumRowStatus(Long valueIndex)
Build an EnumRowStatus from a Long.

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

	this(valueIndex.longValue());
public EnumRowStatus()
Build an EnumRowStatus with unspecified value.

	this(unspecified);
public EnumRowStatus(String x)
Build an EnumRowStatus from a String.

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

	super(x);
public EnumRowStatus(com.sun.jmx.snmp.SnmpInt valueIndex)
Build an EnumRowStatus from an SnmpInt.

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

	this(valueIndex.intValue());
Methods Summary
protected java.util.HashtablegetIntTable()

	return EnumRowStatus.getRSIntTable();
static final java.util.HashtablegetRSIntTable()

	return intTable ;
static final java.util.HashtablegetRSStringTable()

	return stringTable ;
protected java.util.HashtablegetStringTable()

	return  EnumRowStatus.getRSStringTable();
public static booleanisValidValue(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)

	if (value < 0) return false;
	if (value > 6) return false;
	return true;
public com.sun.jmx.snmp.SnmpInttoSnmpValue()
Build an SnmpValue from this object.

exception
IllegalArgumentException if this object holds an unspecified value.
return
an SnmpInt containing this object value.

	if (value == unspecified) 
	    throw new 
        IllegalArgumentException("`unspecified' is not a valid SNMP value.");
	return new SnmpInt(value);