com.atlassian.instrumentation

Class AtomicCounter

java.lang.Object

com.atlassian.instrumentation.AtomicCounter

All Implemented Interfaces:

Counter, Instrument, Comparable<Instrument>

Direct Known Subclasses:

AbsoluteAtomicCounter

public class AtomicCounter
extends Object
implements Counter

An implementation of Counter that uses an AtomicLong for its value.

THREAD SAFETY - This classes uses AtomicLong under the covers to ensure consistent reads and writes of value

Since:

v4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected AtomicLong	value

Constructor Summary

Constructors

Constructor and Description
AtomicCounter(String name)
AtomicCounter(String name, AtomicLong atomicLongRef) This constructor takes a reference to an AtomicLong that may be outside this Counter.
AtomicCounter(String name, long value)

Method Summary

Modifier and Type	Method and Description
long	addAndGet(long delta) Adds the delta value to the current value and returns the new value.
int	compareTo(Instrument that)
String	getName()
long	getValue()
long	incrementAndGet() Returns the new value after one has been added to the Counter.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

value

protected final AtomicLong value

name

protected final String name

Constructor Detail

AtomicCounter

public AtomicCounter(String name)

AtomicCounter

public AtomicCounter(String name,
                     long value)

AtomicCounter

public AtomicCounter(String name,
                     AtomicLong atomicLongRef)

This constructor takes a reference to an AtomicLong that may be outside this Counter. This could be used to expose an external AtomicLong as a counter.

Parameters:

name - the name of the counter

atomicLongRef - the reference to an AtomicLong

Method Detail

incrementAndGet

public long incrementAndGet()

Description copied from interface: Counter

Returns the new value after one has been added to the Counter.

Specified by:

incrementAndGet in interface Counter

Returns:

the new value after one has been added to the previous value

addAndGet

public long addAndGet(long delta)

Description copied from interface: Counter

Adds the delta value to the current value and returns the new value. delta MUSt be >= 0. It can never be negative otherwise a IllegalArgumentException will be throw

Specified by:

addAndGet in interface Counter

Parameters:

delta - the value to add

Returns:

the new value after delta has been added to the current value

getName

public String getName()

Specified by:

getName in interface Instrument

Returns:

the name of the Instrument.

getValue

public long getValue()

Specified by:

getValue in interface Instrument

Returns:

returns the value of the monitored reading at the time the call was made

compareTo

public int compareTo(Instrument that)

Specified by:

compareTo in interface Comparable<Instrument>

toString

public String toString()

Overrides:

toString in class Object