org.snmp4j.smi
Class VariableBinding

java.lang.Object
  extended by org.snmp4j.smi.VariableBinding
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, BERSerializable

public class VariableBinding
extends java.lang.Object
implements java.io.Serializable, BERSerializable, java.lang.Cloneable

A VariableBinding is an association of a object instance identifier (OID) and the instance's value (Variable).

Version:
1.9
Author:
Frank Fock
See Also:
Serialized Form

Constructor Summary
VariableBinding()
          Creates a variable binding with a zero length OID and a Null value.
VariableBinding(OID oid)
          Creates a variable binding with the supplied object instance identifier and a Null value.
VariableBinding(OID oid, Variable variable)
          Creates a variable binding with the supplied OID and value.
 
Method Summary
 java.lang.Object clone()
           
 void decodeBER(BERInputStream inputStream)
          Decodes a Variable from an InputStream.
 void encodeBER(java.io.OutputStream outputStream)
          Encodes a Variable to an OutputStream.
 boolean equals(java.lang.Object o)
           
 int getBERLength()
          Returns the length of this BERSerializable object in bytes when encoded according to the Basic Encoding Rules (BER).
 int getBERPayloadLength()
          Returns the length of the payload of this BERSerializable object in bytes when encoded according to the Basic Encoding Rules (BER).
 OID getOid()
          Gets the object instance identifier of the variable binding.
 int getSyntax()
          Gets the syntax of the variable bindings value.
 Variable getVariable()
          Gets the value of the variable binding.
 int hashCode()
           
 boolean isException()
          Returns whether the variable bindings value has an exception syntax.
 void setOid(OID oid)
          Sets the object instance identifier for the variable binding.
 void setVariable(Variable variable)
          Sets the value of the variable binding.
 java.lang.String toString()
          Gets a string representation of this variable binding using the VariableTextFormat configured by SNMP4JSettings.
 java.lang.String toValueString()
          Gets a string representation of this variable binding's value using the VariableTextFormat configured by SNMP4JSettings.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VariableBinding

public VariableBinding()
Creates a variable binding with a zero length OID and a Null value.


VariableBinding

public VariableBinding(OID oid)
Creates a variable binding with the supplied object instance identifier and a Null value.

Parameters:
oid - the OID for the new variable binding.

VariableBinding

public VariableBinding(OID oid,
                       Variable variable)
Creates a variable binding with the supplied OID and value.

Parameters:
oid - the OID for the new variable binding (must not be null).
variable - the value for the new variable binding (must not be null).
Method Detail

getOid

public OID getOid()
Gets the object instance identifier of the variable binding.

Returns:
an OID.

setOid

public void setOid(OID oid)
Sets the object instance identifier for the variable binding.

Parameters:
oid - an OID (must not be null) that is cloned when added to this binding.

setVariable

public void setVariable(Variable variable)
Sets the value of the variable binding.

Parameters:
variable - a Variable (must not be null) that is cloned when added to this binding.

getVariable

public Variable getVariable()
Gets the value of the variable binding.

Returns:
a Variable instance.

getSyntax

public final int getSyntax()
Gets the syntax of the variable bindings value.

Returns:
a SMI syntax identifier (see SMIConstants).

isException

public boolean isException()
Returns whether the variable bindings value has an exception syntax.

Returns:
true if the syntax of this variable is an instance of Null and its syntax equals one of the following:
See Also:
Variable

getBERPayloadLength

public final int getBERPayloadLength()
Description copied from interface: BERSerializable
Returns the length of the payload of this BERSerializable object in bytes when encoded according to the Basic Encoding Rules (BER).

Specified by:
getBERPayloadLength in interface BERSerializable
Returns:
the BER encoded length of this variable.

getBERLength

public final int getBERLength()
Description copied from interface: BERSerializable
Returns the length of this BERSerializable object in bytes when encoded according to the Basic Encoding Rules (BER).

Specified by:
getBERLength in interface BERSerializable
Returns:
the BER encoded length of this variable.

decodeBER

public final void decodeBER(BERInputStream inputStream)
                     throws java.io.IOException
Description copied from interface: BERSerializable
Decodes a Variable from an InputStream.

Specified by:
decodeBER in interface BERSerializable
Parameters:
inputStream - an InputStream containing a BER encoded byte stream.
Throws:
java.io.IOException - if the stream could not be decoded by using BER rules.

encodeBER

public final void encodeBER(java.io.OutputStream outputStream)
                     throws java.io.IOException
Description copied from interface: BERSerializable
Encodes a Variable to an OutputStream.

Specified by:
encodeBER in interface BERSerializable
Parameters:
outputStream - an OutputStream.
Throws:
java.io.IOException - if an error occurs while writing to the stream.

toString

public java.lang.String toString()
Gets a string representation of this variable binding using the VariableTextFormat configured by SNMP4JSettings.

Overrides:
toString in class java.lang.Object
Returns:
a string of the form <OID> = <Variable>.

toValueString

public java.lang.String toValueString()
Gets a string representation of this variable binding's value using the VariableTextFormat configured by SNMP4JSettings.

Returns:
a string of the form <Variable>.
Since:
1.10

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

Copyright 2005-2010 Frank Fock (SNMP4J.org)

Copyright © 2011 SNMP4J.org. All Rights Reserved.