org.snmp4j.agent.mo.snmp.tc
Class TruthValueTC

java.lang.Object
  org.snmp4j.agent.mo.snmp.tc.TruthValueTC

All Implemented Interfaces:

TextualConvention

public class TruthValueTC
extends java.lang.Object
implements TextualConvention

Field Summary

static int	FALSE
static int	TRUE

Constructor Summary

TruthValueTC()

Method Summary

MOColumn	createColumn(int columnID, int syntax, MOAccess access, org.snmp4j.smi.Variable defaultValue, boolean mutableInService) Creates a MOColumn instance of this TC specified by the column ID, access, default value, and mutable flag.
org.snmp4j.smi.Variable	createInitialValue() Creates an initial value for an object instance of this textual convention.
MOScalar	createScalar(org.snmp4j.smi.OID oid, MOAccess access, org.snmp4j.smi.Variable value) Creates a MOScalar instance of this TC specified by OID, access, and optional value.
static boolean	getBooleanValue(org.snmp4j.smi.Integer32 truthValue) Gets the boolean value of a TruthValue variable.
java.lang.String	getModuleName() Returns the MIB module name that defined this textual convention.
java.lang.String	getName() Returns the name of the textual convention as defined in the MIB module.
static org.snmp4j.smi.Integer32	getValue(boolean b)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TRUE

public static final int TRUE

See Also:

Constant Field Values

FALSE

public static final int FALSE

See Also:

Constant Field Values

Constructor Detail

TruthValueTC

public TruthValueTC()

Method Detail

createColumn

public MOColumn createColumn(int columnID,
                             int syntax,
                             MOAccess access,
                             org.snmp4j.smi.Variable defaultValue,
                             boolean mutableInService)

Description copied from interface: TextualConvention

Creates a MOColumn instance of this TC specified by the column ID, access, default value, and mutable flag.

Specified by:

createColumn in interface TextualConvention

Parameters:

columnID - the column id as defined in the MIB module (typically starting at one).

access - the access definition.

defaultValue - the default value or null if there is no DEFVAL clause for this column.

mutableInService - true if this column may be modified while row is in service.

Returns:

the MOColumn created.

createScalar

public MOScalar createScalar(org.snmp4j.smi.OID oid,
                             MOAccess access,
                             org.snmp4j.smi.Variable value)

Description copied from interface: TextualConvention

Creates a MOScalar instance of this TC specified by OID, access, and optional value.

Specified by:

createScalar in interface TextualConvention

Parameters:

oid - the OID of the scalar isntance.

access - the access definition.

value - the Variable instance containing the value of the scalar. If value is null, the TC should create an initial value with TextualConvention.createInitialValue().

Returns:

a MOScalar instance.

getModuleName

public java.lang.String getModuleName()

Description copied from interface: TextualConvention

Returns the MIB module name that defined this textual convention.

Specified by:

getModuleName in interface TextualConvention

Returns:

an unique module name

getName

public java.lang.String getName()

Description copied from interface: TextualConvention

Returns the name of the textual convention as defined in the MIB module.

Specified by:

getName in interface TextualConvention

Returns:

the unique name (within the MIB module) of the TC.

getValue

public static org.snmp4j.smi.Integer32 getValue(boolean b)

createInitialValue

public org.snmp4j.smi.Variable createInitialValue()

Description copied from interface: TextualConvention

Creates an initial value for an object instance of this textual convention.

Specified by:

createInitialValue in interface TextualConvention

Returns:

a Variable instance with a valid value (according to this TC).

getBooleanValue

public static boolean getBooleanValue(org.snmp4j.smi.Integer32 truthValue)

Gets the boolean value of a TruthValue variable.

Parameters:

truthValue - a TruthValue.

Returns:

true if truthValue equals TRUE.

Since:

2.0