org.snmp4j.event

Class CounterEvent

java.lang.Object

java.util.EventObject

org.snmp4j.event.CounterEvent

All Implemented Interfaces:

Serializable

public class CounterEvent
extends 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:

2.4.2

Author:

Frank Fock

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
CounterEvent(Object source, OID oid) Creates a CounterEvent for the specified counter.
CounterEvent(Object source, OID oid, long increment) Creates a CounterEvent for the specified counter.
CounterEvent(Object source, OID oid, Object index, long increment) Creates a CounterEvent for the specified counter.

Method Summary

Methods

Modifier and Type	Method and Description
Variable	getCurrentValue() Gets the current value of the counter, as set by the maintainer of the counter (one of the event listeners).
long	getIncrement() The increment to be added to the counter value on behalf of this event.
Object	getIndex() The index identifier of the counter value (if the counter belongs to a table of counters).
OID	getOid() Gets the instance object identifier of the counter.
void	setCurrentValue(Variable currentValue) Sets the current value of the counter.
void	setIncrement(long increment) Sets the increment of the event.
String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CounterEvent

public CounterEvent(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).

CounterEvent

public CounterEvent(Object source,
            OID oid,
            long increment)

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

increment - a positive natural number (default is 1) that defines the increment that needs to be added to the counter on behalf of this event.

CounterEvent

public CounterEvent(Object source,
            OID oid,
            Object index,
            long increment)

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

index - an counter defined object that identifies the counter row within a table of counters.

increment - a positive natural number (default is 1) that defines the increment that needs to be added to the counter on behalf of this event.

Since:

2.4.2

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.

getIncrement

public long getIncrement()

The increment to be added to the counter value on behalf of this event. The default is 1.

Returns:

the counter increment of this event.

Since:

2.4.2

setIncrement

public void setIncrement(long increment)

Sets the increment of the event. This has to be done before the event is fired to have an effect!

Parameters:

increment - the counter increment (must be a positive value for Counter32 counters!). For Counter64 counters, the value might be negative but is then interpreted as an unsinged long value.

getIndex

public Object getIndex()

The index identifier of the counter value (if the counter belongs to a table of counters).

Returns:

the row index identifier for this counter event or null if the counter is a scalar value.

Since:

2.4.2

toString

public String toString()

Overrides:

toString in class EventObject