org.snmp4j.smi
Class TimeTicks

java.lang.Object
  extended by org.snmp4j.smi.AbstractVariable
      extended by org.snmp4j.smi.UnsignedInteger32
          extended by org.snmp4j.smi.TimeTicks
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, BERSerializable, AssignableFromLong, AssignableFromString, Variable

public class TimeTicks
extends UnsignedInteger32

The TimeTicks class represents the time in 1/100 seconds since some epoch (which should be have been defined in the corresponding MIB specification).

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

Field Summary
 
Fields inherited from class org.snmp4j.smi.UnsignedInteger32
value
 
Fields inherited from class org.snmp4j.smi.AbstractVariable
SMISYNTAXES_PROPERTIES
 
Constructor Summary
TimeTicks()
           
TimeTicks(long value)
           
TimeTicks(TimeTicks other)
          Copy constructor.
 
Method Summary
 java.lang.Object clone()
          Clones this variable.
 void decodeBER(BERInputStream inputStream)
          Decodes a Variable from an InputStream.
 void encodeBER(java.io.OutputStream os)
          Encodes a Variable to an OutputStream.
 void fromMilliseconds(long millis)
          Sets the timeticks value by milliseconds.
 int getSyntax()
          Gets the ASN.1 syntax identifier value of this SNMP variable.
 long toMilliseconds()
          Returns the timeticks value as milliseconds (instead 1/100 seconds).
 java.lang.String toString()
          Returns string with the value of this TimeTicks object as "[days,]hh:mm:ss.hh".
 java.lang.String toString(java.lang.String pattern)
          Formats the content of this TimeTicks object according to a supplied MessageFormat pattern.
 
Methods inherited from class org.snmp4j.smi.UnsignedInteger32
compareTo, equals, fromSubIndex, getBERLength, getValue, hashCode, setValue, setValue, toInt, toLong, toSubIndex
 
Methods inherited from class org.snmp4j.smi.AbstractVariable
createFromBER, createFromSyntax, getBERPayloadLength, getSyntaxFromString, getSyntaxString, getSyntaxString, isDynamic, isException
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TimeTicks

public TimeTicks()

TimeTicks

public TimeTicks(TimeTicks other)
Copy constructor.

Parameters:
other - a TimeTicks instance.
Since:
1.7

TimeTicks

public TimeTicks(long value)
Method Detail

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 immutable clone for internal processing.

Specified by:
clone in interface Variable
Overrides:
clone in class UnsignedInteger32
Returns:
a new instance of this Variable with the same value.

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 UnsignedInteger32
Returns:
an integer value < 128 for regular SMI objects and a value >= 128 for exception values like noSuchObject, noSuchInstance, and endOfMibView.

encodeBER

public void encodeBER(java.io.OutputStream os)
               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 UnsignedInteger32
Parameters:
os - 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 InputStream.

Specified by:
decodeBER in interface BERSerializable
Overrides:
decodeBER in class UnsignedInteger32
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.

toString

public java.lang.String toString()
Returns string with the value of this TimeTicks object as "[days,]hh:mm:ss.hh".

Specified by:
toString in interface Variable
Overrides:
toString in class UnsignedInteger32
Returns:
a String representation of this object.

toString

public java.lang.String toString(java.lang.String pattern)
Formats the content of this TimeTicks object according to a supplied MessageFormat pattern.

Parameters:
pattern - a MessageFormat pattern that takes up to five parameters which are: days, hours, minutes, seconds, and 1/100 seconds.
Returns:
the formatted string representation.

toMilliseconds

public long toMilliseconds()
Returns the timeticks value as milliseconds (instead 1/100 seconds).

Returns:
getValue()*10.
Since:
1.7

fromMilliseconds

public void fromMilliseconds(long millis)
Sets the timeticks value by milliseconds.

Parameters:
millis - sets the value as setValue(millis/10).
Since:
1.7

Copyright 2005-2010 Frank Fock (SNMP4J.org)

Copyright © 2011 SNMP4J.org. All Rights Reserved.