Package org.snmp4j.smi

Class Counter64

java.lang.Object
org.snmp4j.smi.AbstractVariable
org.snmp4j.smi.Counter64
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Variable>, BERSerializable, AssignableFromLong, AssignableFromString, Variable
public class Counter64 extends AbstractVariable implements AssignableFromLong, AssignableFromString
The Counter64 class represents a 64bit unsigned integer type. It is used for monotonically increasing values that wrap around at 2^64-1 (18446744073709551615). The unsigned 64bit value is represented by a signed 64bit long value internally.
Version:
1.8
Author:
Frank Fock
See Also:

  • Constructor Details

    • Counter64

      public Counter64()

    • Counter64

      public Counter64(long value)

  • Method Details

    • 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 BERInputStream.
      Specified by:
      decodeBER in interface BERSerializable
      Specified by:
      decodeBER in class AbstractVariable
      Parameters:
      inputStream - an BERInputStream 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 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 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.

    • increment

      public void increment()
      Increment the value of the counter by one. If the current value is 2^63-1 (9223372036854775807) then value will be set to -2^63. Nevertheless, the BER encoded value of this counter will always be unsigned!

    • increment

      public long increment(long increment)
      Increment the value by more than one in one step.
      Parameters:
      increment - an increment value greater than zero.
      Returns:
      the current value of the counter.
      Since:
      2.4.2

    • 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.