- java.lang.Object
-
- org.snmp4j.smi.AbstractVariable
-
- org.snmp4j.smi.Null
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.lang.Comparable<Variable>
,BERSerializable
,Variable
public class Null extends AbstractVariable
TheNull
class represents SMI Null and the derived SMIv2 exception syntaxes.- Version:
- 1.8
- Author:
- Frank Fock
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static Null
endOfMibView
static Null
instance
static Null
noSuchInstance
static Null
noSuchObject
-
Fields inherited from class org.snmp4j.smi.AbstractVariable
SMISYNTAXES_PROPERTIES
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
Clones this variable.int
compareTo(Variable o)
void
decodeBER(BERInputStream inputStream)
Decodes aVariable
from anBERInputStream
.void
encodeBER(java.io.OutputStream outputStream)
Encodes aVariable
to anOutputStream
.boolean
equals(java.lang.Object o)
void
fromSubIndex(OID subIndex, boolean impliedLength)
Sets the value of thisVariable
from the supplied (sub-)index.int
getBERLength()
Returns the length of thisVariable
in bytes when encoded according to the Basic Encoding Rules (BER).int
getSyntax()
Gets the ASN.1 syntax identifier value of this SNMP variable.int
hashCode()
static boolean
isExceptionSyntax(int syntax)
void
setSyntax(int syntax)
int
toInt()
Returns the syntax of this Null variable.long
toLong()
Returns the syntax of this Null variable.java.lang.String
toString()
Gets a string representation of the variable.OID
toSubIndex(boolean impliedLength)
Converts the value of thisVariable
to a (sub-)index value.-
Methods inherited from class org.snmp4j.smi.AbstractVariable
createFromBER, createFromSyntax, equal, getBERPayloadLength, getSyntaxFromString, getSyntaxString, getSyntaxString, isDynamic, isException
-
-
-
-
Method Detail
-
decodeBER
public void decodeBER(BERInputStream inputStream) throws java.io.IOException
Description copied from class:AbstractVariable
Decodes aVariable
from anBERInputStream
.- Specified by:
decodeBER
in interfaceBERSerializable
- Specified by:
decodeBER
in classAbstractVariable
- Parameters:
inputStream
- anBERInputStream
containing a BER encoded byte stream.- Throws:
java.io.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 interfaceVariable
- Specified by:
getSyntax
in classAbstractVariable
- 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.
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfaceVariable
- Specified by:
hashCode
in classAbstractVariable
-
getBERLength
public int getBERLength()
Description copied from class:AbstractVariable
Returns the length of thisVariable
in bytes when encoded according to the Basic Encoding Rules (BER).- Specified by:
getBERLength
in interfaceBERSerializable
- Specified by:
getBERLength
in classAbstractVariable
- Returns:
- the BER encoded length of this variable.
-
equals
public boolean equals(java.lang.Object o)
- Specified by:
equals
in interfaceVariable
- Specified by:
equals
in classAbstractVariable
-
compareTo
public int compareTo(Variable o)
- Specified by:
compareTo
in interfacejava.lang.Comparable<Variable>
- Specified by:
compareTo
in interfaceVariable
- Specified by:
compareTo
in classAbstractVariable
-
toString
public java.lang.String toString()
Description copied from class:AbstractVariable
Gets a string representation of the variable.- Specified by:
toString
in interfaceVariable
- Specified by:
toString
in classAbstractVariable
- Returns:
- a string representation of the variable's value.
-
encodeBER
public void encodeBER(java.io.OutputStream outputStream) throws java.io.IOException
Description copied from class:AbstractVariable
Encodes aVariable
to anOutputStream
.- Specified by:
encodeBER
in interfaceBERSerializable
- Specified by:
encodeBER
in classAbstractVariable
- Parameters:
outputStream
- anOutputStream
.- Throws:
java.io.IOException
- if an error occurs while writing to the stream.
-
setSyntax
public void setSyntax(int syntax)
-
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 interfaceVariable
- Specified by:
clone
in classAbstractVariable
- Returns:
- a new instance of this
Variable
with the same value.
-
isExceptionSyntax
public static boolean isExceptionSyntax(int syntax)
-
toInt
public final int toInt()
Returns the syntax of this Null variable.- Specified by:
toInt
in interfaceVariable
- Specified by:
toInt
in classAbstractVariable
- Returns:
SMIConstants.SYNTAX_NULL
or one of the exception syntaxesSMIConstants.EXCEPTION_NO_SUCH_OBJECT
,SMIConstants.EXCEPTION_NO_SUCH_INSTANCE
, orSMIConstants.EXCEPTION_END_OF_MIB_VIEW
- Since:
- 1.7
-
toLong
public final long toLong()
Returns the syntax of this Null variable.- Specified by:
toLong
in interfaceVariable
- Specified by:
toLong
in classAbstractVariable
- Returns:
SMIConstants.SYNTAX_NULL
or one of the exception syntaxesSMIConstants.EXCEPTION_NO_SUCH_OBJECT
,SMIConstants.EXCEPTION_NO_SUCH_INSTANCE
, orSMIConstants.EXCEPTION_END_OF_MIB_VIEW
- Since:
- 1.7
-
toSubIndex
public OID toSubIndex(boolean impliedLength)
Description copied from class:AbstractVariable
Converts the value of thisVariable
to a (sub-)index value.- Specified by:
toSubIndex
in interfaceVariable
- Specified by:
toSubIndex
in classAbstractVariable
- Parameters:
impliedLength
- specifies if the sub-index has an implied length. This parameter applies to variable length variables only (e.g.OctetString
andOID
). 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 thisVariable
from the supplied (sub-)index.- Specified by:
fromSubIndex
in interfaceVariable
- Specified by:
fromSubIndex
in classAbstractVariable
- 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
andOID
). For other variables it has no effect.
-
-