Module org.snmp4j

Class VariantVariable

    • Constructor Detail

      • VariantVariable

        public VariantVariable​(Variable initialVariable)
        Creates a variant variable wrapping the specified value.
        Parameters:
        initialVariable - a Variable.
      • VariantVariable

        public VariantVariable​(Variable initialVariable,
                               VariantVariableCallback callback)
        Creates a variant variable wrapping the specified value and a callback that monitors value modifications.
        Parameters:
        initialVariable - a Variable.
        callback - a callback handler that is called before the value is to be modified and after it has been modified.
    • Method Detail

      • updateVariable

        protected void updateVariable()
      • variableUpdated

        protected void variableUpdated()
      • 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
        Specified by:
        encodeBER in class AbstractVariable
        Parameters:
        outputStream - an OutputStream.
        Throws:
        java.io.IOException - if an error occurs while writing to the stream.
      • 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.
      • 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.
      • 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 less than 128 for regular SMI objects and a value greater or equal than 128 for exception values like noSuchObject, noSuchInstance, and endOfMibView.
      • toInt

        public int toInt()
        Description copied from class: AbstractVariable
        Returns an integer representation of this variable if such a representation exists.
        Specified by:
        toInt in interface AssignableFromInteger
        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).
      • 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.
      • toString

        public java.lang.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.
      • 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
        Specified by:
        clone in class AbstractVariable
        Returns:
        a new instance of this Variable with the same value.
      • setValue

        public void setValue​(OctetString value)
      • getVariable

        public Variable getVariable()
        Returns the typed variable that holds the wrapped value.
        Returns:
        a Variable instance.