org.snmp4j.event
Class CounterEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.snmp4j.event.CounterEvent
All Implemented Interfaces:
java.io.Serializable

public class CounterEvent
extends java.util.EventObject

CounterEvent is an event object that indicates that a specific counter needs to be incremented.

At the same time a CounterEvent can be used by the event originator to retrieve the actual value of the specified counter. Listeners that maintain the specified counter value, must set the new value when receiving the CounterEvent by using the setCurrentValue(Variable currentValue) method.

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

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
CounterEvent(java.lang.Object source, OID oid)
          Creates a CounterEvent for the specified counter.
 
Method Summary
 Variable getCurrentValue()
          Gets the current value of the counter, as set by the maintainer of the counter (one of the event listeners).
 OID getOid()
          Gets the instance object identifier of the counter.
 void setCurrentValue(Variable currentValue)
          Sets the current value of the counter.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CounterEvent

public CounterEvent(java.lang.Object source,
                    OID oid)
Creates a CounterEvent for the specified counter.

Parameters:
source - the source of the event.
oid - the OID of the counter instance (typically, the counter is a scalar and thus the OID has to end on zero).
Method Detail

getOid

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

Returns:
an OID.

getCurrentValue

public Variable getCurrentValue()
Gets the current value of the counter, as set by the maintainer of the counter (one of the event listeners).

Returns:
a Counter32 or Counter64 instance.

setCurrentValue

public void setCurrentValue(Variable currentValue)
Sets the current value of the counter. This method has to be called by the maintainer of the counter's value.

Parameters:
currentValue - a Counter32 or Counter64 instance.

Copyright 2005-2010 Frank Fock (SNMP4J.org)

Copyright © 2011 SNMP4J.org. All Rights Reserved.