com.atlassian.instrumentation

Class AtomicGauge

java.lang.Object

com.atlassian.instrumentation.AtomicGauge

All Implemented Interfaces:

Gauge, Instrument, Comparable<Instrument>

Direct Known Subclasses:

DerivedAtomicCounter

public class AtomicGauge
extends Object
implements Gauge

A simple implementation of Gauge

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
AtomicGauge(String name)
AtomicGauge(String name, AtomicLong atomicLongRef) This constructor takes a reference to an AtomicLong that may be outside this Gauge.
AtomicGauge(String name, long value)

Method Summary

Modifier and Type	Method and Description
long	addAndGet(long delta) Adds the delta value to the Gauge and returns the new value.
int	compareTo(Instrument that)
long	decrementAndGet() Decrements one from the Gauge and returns the new value
String	getName()
long	getValue()
long	incrementAndGet() Adds one to the Gauge and returns the new value
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

AtomicGauge

public AtomicGauge(String name)

AtomicGauge

public AtomicGauge(String name,
                   long value)

AtomicGauge

public AtomicGauge(String name,
                   AtomicLong atomicLongRef)

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

Parameters:

name - the name of the gauge

atomicLongRef - the reference to an AtomicLong

Method Detail

getName

public String getName()

Specified by:

getName in interface Instrument

Returns:

the name of the Instrument.

incrementAndGet

public long incrementAndGet()

Description copied from interface: Gauge

Adds one to the Gauge and returns the new value

Specified by:

incrementAndGet in interface Gauge

Returns:

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

decrementAndGet

public long decrementAndGet()

Description copied from interface: Gauge

Decrements one from the Gauge and returns the new value

Specified by:

decrementAndGet in interface Gauge

Returns:

the new value after one has been decremented from the previous value

addAndGet

public long addAndGet(long delta)

Description copied from interface: Gauge

Adds the delta value to the Gauge and returns the new value.

Specified by:

addAndGet in interface Gauge

Parameters:

delta - this can be positive or negative

Returns:

the new value after the delta has been added to the previous value.

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