com.j_spaces.jms.utils

Class Counter

java.lang.Object

com.j_spaces.jms.utils.Counter

Direct Known Subclasses:

CyclicCounter

public class Counter
extends Object

A generic thread-safe counter. Range between Integer.MIN_VALUE and Integer.MAX_VALUE.

Author:

Shai Wolf

Field Summary

Fields

Modifier and Type	Field and Description
protected ReentrantLock	lock Synchronization lock.
protected int	start The counter's start value.
protected int	value The counter's value.

Constructor Summary

Constructors

Constructor and Description
Counter() Creates a new Counter instance.
Counter(int startValue) Creates a new Counter instance.

Method Summary

Modifier and Type	Method and Description
int	decrement() Decrements the counter by 1.
int	decrement(int val) Decrements the counter by val.
int	getValue() Returns the value of the counter.
int	increment() Increments the counter by 1.
int	increment(int val) Increments the counter by val.
void	reset() Resets the counter to the start value.
void	setValue(int val) Sets the value of the counter.
String	toString() API method.

Methods inherited from class java.lang.Object

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

Field Detail

lock

protected ReentrantLock lock

Synchronization lock.

value

protected int value

The counter's value.

start

protected int start

The counter's start value.

Constructor Detail

Counter

public Counter()

Creates a new Counter instance.

Counter

public Counter(int startValue)

Creates a new Counter instance.

Parameters:

startValue - the start value of the counter, 0 by default.

Method Detail

reset

public void reset()

Resets the counter to the start value.

setValue

public void setValue(int val)

Sets the value of the counter.

Parameters:

val - the new value.

getValue

public int getValue()

Returns the value of the counter.

Returns:

the value of the counter.

increment

public int increment()

Increments the counter by 1.

Returns:

the new counter's value.

increment

public int increment(int val)

Increments the counter by val.

Parameters:

val - the value by which to increment the counter.

Returns:

the new counter's value.

decrement

public int decrement()

Decrements the counter by 1.

Returns:

the new counter's value.

decrement

public int decrement(int val)

Decrements the counter by val.

Parameters:

val - the value by which to decrement the counter.

Returns:

the new counter's value.

toString

public String toString()

API method.

Overrides:

toString in class Object