Module org.snmp4j

Package org.snmp4j.smi

Class Opaque

java.lang.Object

org.snmp4j.smi.AbstractVariable

org.snmp4j.smi.OctetString

org.snmp4j.smi.Opaque

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Variable>, BERSerializable, AssignableFromByteArray, AssignableFromString, Variable

public class Opaque
extends OctetString

The Opaque class represents the SMI type Opaque which is used to transparently exchange BER encoded values.

Version:

1.7.6

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static long	serialVersionUID

Fields inherited from class org.snmp4j.smi.AbstractVariable

SMISYNTAXES_PROPERTIES

Constructor Summary

Constructors

Constructor	Description
Opaque()
Opaque(byte[] bytes)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()	Clones this variable.
void	decodeBER(BERInputStream inputStream)	Decodes a Variable from an BERInputStream.
void	encodeBER(java.io.OutputStream outputStream)	Encodes a Variable to an OutputStream.
int	getSyntax()	Gets the ASN.1 syntax identifier value of this SNMP variable.
void	setValue(OctetString value)
java.lang.String	toString()	Returns a String representation of this OctetString.

Methods inherited from class org.snmp4j.smi.OctetString

append, append, append, append, clear, compareTo, equals, equalsValue, fromByteArray, fromCharArray, fromCharArray, fromHexString, fromHexString, fromHexStringPairs, fromIndex, fromString, fromString, fromString, fromSubIndex, get, getBERLength, getBERPayloadLength, getValue, hashCode, isPrintable, length, mask, set, setValue, setValue, split, startsWith, substring, toASCII, toByteArray, toByteArray, toHexString, toHexString, toInt, toLong, toString, toString, toSubIndex

Methods inherited from class org.snmp4j.smi.AbstractVariable

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

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Opaque

public Opaque()

Opaque

public Opaque(byte[] bytes)

Method Detail

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

Overrides:

getSyntax in class OctetString

Returns:

an integer value less than 128 for regular SMI objects and a value greater or equal than 128 for exception values like noSuchObject, noSuchInstance, and endOfMibView.

encodeBER

public void encodeBER(java.io.OutputStream outputStream)
               throws java.io.IOException

Description copied from class: AbstractVariable

Encodes a Variable to an OutputStream.

Specified by:

encodeBER in interface BERSerializable

Overrides:

encodeBER in class OctetString

Parameters:

outputStream - an OutputStream.

Throws:

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

decodeBER

public void decodeBER(BERInputStream inputStream)
               throws java.io.IOException

Description copied from class: AbstractVariable

Decodes a Variable from an BERInputStream.

Specified by:

decodeBER in interface BERSerializable

Overrides:

decodeBER in class OctetString

Parameters:

inputStream - an BERInputStream containing a BER encoded byte stream.

Throws:

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

setValue

public void setValue(OctetString value)

toString

public java.lang.String toString()

Description copied from class: OctetString

Returns a String representation of this OctetString. If the OctetString contains non-printable characters, a hex-string representation is returned unless SNMP4JSettings.getDefaultNonPrintableEscapeCharacter() returns a non-null character that is then used to replace all non-printable characters in the output.

Specified by:

toString in interface Variable

Overrides:

toString in class OctetString

Returns:

a String representation of this OctetString.

clone

public java.lang.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

Overrides:

clone in class OctetString

Returns:

a new instance of this Variable with the same value.