org.snmp4j.smi

Class UnsignedInteger32

java.lang.Object

org.snmp4j.smi.AbstractVariable

org.snmp4j.smi.UnsignedInteger32

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Variable>, BERSerializable, AssignableFromLong, AssignableFromString, Variable

Direct Known Subclasses:

Counter32, Gauge32, TimeTicks

public class UnsignedInteger32
extends AbstractVariable
implements AssignableFromLong, AssignableFromString

UnsignedInteger32 type is an SNMP type that represents unsigned 32bit integer values (0 to 4294967295).

Version:

1.8

Author:

Frank Fock

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	value

Fields inherited from class org.snmp4j.smi.AbstractVariable

SMISYNTAXES_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
UnsignedInteger32()
UnsignedInteger32(byte signedByteValue) Creates an unsigned integer from a signed byte value.
UnsignedInteger32(int signedIntValue) Creates an unsigned integer from a signed int value.
UnsignedInteger32(long value) Creates an UnsignedInteger32 from a long value.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Clones this variable.
int	compareTo(Variable o)
void	decodeBER(BERInputStream inputStream) Decodes a Variable from an InputStream.
void	encodeBER(OutputStream outputStream) Encodes a Variable to an OutputStream.
boolean	equals(Object o)
void	fromSubIndex(OID subIndex, boolean impliedLength) Sets the value of this Variable from the supplied (sub-)index.
int	getBERLength() Returns the length of this Variable in bytes when encoded according to the Basic Encoding Rules (BER).
int	getSyntax() Gets the ASN.1 syntax identifier value of this SNMP variable.
long	getValue()
int	hashCode()
void	setValue(long value)
void	setValue(String value)
int	toInt() Returns an integer representation of this variable if such a representation exists.
long	toLong() Returns a long representation of this variable if such a representation exists.
String	toString() Gets a string representation of the variable.
OID	toSubIndex(boolean impliedLength) Converts the value of this Variable to a (sub-)index value.

Methods inherited from class org.snmp4j.smi.AbstractVariable

createFromBER, createFromSyntax, equal, getBERPayloadLength, getSyntaxFromString, getSyntaxString, getSyntaxString, isDynamic, isException

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

protected long value

Constructor Detail

UnsignedInteger32

public UnsignedInteger32()

UnsignedInteger32

public UnsignedInteger32(long value)

Creates an UnsignedInteger32 from a long value.

Parameters:

value - a long value which must not be greater 2^32-1 and not less zero.

Throws:

IllegalArgumentException - if value < 0 or > 2^32-1.

UnsignedInteger32

public UnsignedInteger32(int signedIntValue)

Creates an unsigned integer from a signed int value. Negative values will become 2^31-1 through 2^32-1.

Parameters:

signedIntValue - a signed int value.

Since:

1.7

UnsignedInteger32

public UnsignedInteger32(byte signedByteValue)

Creates an unsigned integer from a signed byte value. Negative values will become 2^7-1 through 2^8-1.

Parameters:

signedByteValue - a signed byte value.

Since:

1.7

Method Detail

encodeBER

public void encodeBER(OutputStream outputStream)
               throws IOException

Description copied from class: AbstractVariable

Encodes a Variable to an OutputStream.

Specified by:

encodeBER in interface BERSerializable

Specified by:

encodeBER in class AbstractVariable

Parameters:

outputStream - an OutputStream.

Throws:

IOException - if an error occurs while writing to the stream.

decodeBER

public void decodeBER(BERInputStream inputStream)
               throws IOException

Description copied from class: AbstractVariable

Decodes a Variable from an InputStream.

Specified by:

decodeBER in interface BERSerializable

Specified by:

decodeBER in class AbstractVariable

Parameters:

inputStream - an InputStream containing a BER encoded byte stream.

Throws:

IOException - if the stream could not be decoded by using BER rules.

getSyntax

public int getSyntax()

Description copied from class: AbstractVariable

Gets the ASN.1 syntax identifier value of this SNMP variable.

Specified by:

getSyntax in interface Variable

Specified by:

getSyntax in class AbstractVariable

Returns:

an integer value < 128 for regular SMI objects and a value >= 128 for exception values like noSuchObject, noSuchInstance, and endOfMibView.

hashCode

public int hashCode()

Specified by:

hashCode in interface Variable

Specified by:

hashCode in class AbstractVariable

getBERLength

public int getBERLength()

Description copied from class: AbstractVariable

Returns the length of this Variable in bytes when encoded according to the Basic Encoding Rules (BER).

Specified by:

getBERLength in interface BERSerializable

Specified by:

getBERLength in class AbstractVariable

Returns:

the BER encoded length of this variable.

equals

public boolean equals(Object o)

Specified by:

equals in interface Variable

Specified by:

equals in class AbstractVariable

compareTo

public int compareTo(Variable o)

Specified by:

compareTo in interface Comparable<Variable>

Specified by:

compareTo in interface Variable

Specified by:

compareTo in class AbstractVariable

toString

public String toString()

Description copied from class: AbstractVariable

Gets a string representation of the variable.

Specified by:

toString in interface Variable

Specified by:

toString in class AbstractVariable

Returns:

a string representation of the variable's value.

setValue

public void setValue(String value)

Specified by:

setValue in interface AssignableFromString

setValue

public void setValue(long value)

Specified by:

setValue in interface AssignableFromLong

getValue

public long getValue()

clone

public Object clone()

Description copied from interface: Variable

Clones this variable. Cloning can be used by the SNMP4J API to better support concurrency by creating a clone for internal processing. The content of this object is independent to the content of the clone. Thus, changes to the clone will have no effect to this object.

Specified by:

clone in interface Variable

Specified by:

clone in class AbstractVariable

Returns:

a new instance of this Variable with the same value.

toInt

public final int toInt()

Description copied from class: AbstractVariable

Returns an integer representation of this variable if such a representation exists.

Specified by:

toInt in interface Variable

Specified by:

toInt in class AbstractVariable

Returns:

an integer value (if the native representation of this variable would be a long, then the long value will be casted to int).

toLong

public final long toLong()

Description copied from class: AbstractVariable

Returns a long representation of this variable if such a representation exists.

Specified by:

toLong in interface AssignableFromLong

Specified by:

toLong in interface Variable

Specified by:

toLong in class AbstractVariable

Returns:

a long value.

toSubIndex

public OID toSubIndex(boolean impliedLength)

Description copied from class: AbstractVariable

Converts the value of this Variable to a (sub-)index value.

Specified by:

toSubIndex in interface Variable

Specified by:

toSubIndex in class AbstractVariable

Parameters:

impliedLength - specifies if the sub-index has an implied length. This parameter applies to variable length variables only (e.g. OctetString and OID). For other variables it has no effect.

Returns:

an OID that represents this value as an (sub-)index.

fromSubIndex

public void fromSubIndex(OID subIndex,
                boolean impliedLength)

Description copied from class: AbstractVariable

Sets the value of this Variable from the supplied (sub-)index.

Specified by:

fromSubIndex in interface Variable

Specified by:

fromSubIndex in class AbstractVariable

Parameters:

subIndex - the sub-index OID.

impliedLength - specifies if the sub-index has an implied length. This parameter applies to variable length variables only (e.g. OctetString and OID). For other variables it has no effect.