com.atlassian.instrumentation

Class ExternalGauge

java.lang.Object

com.atlassian.instrumentation.ExternalGauge

All Implemented Interfaces:

Gauge, Instrument, Comparable<Instrument>

public class ExternalGauge
extends Object
implements Gauge

An ExternalGauge is a Gauge that bases its value of an ExternalValue value

This object is read only and the mutating methods throw UnsupportedOperationException if called. The reasoning for this is that it cant know how to change its delegate ExternalValue.

Since:

v4.0

Constructor Summary

Constructors

Constructor and Description
ExternalGauge(String name, ExternalValue externalValue) Constructs a Gauge that reads its value from the ExternalValue provided.

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

Constructor Detail

ExternalGauge

public ExternalGauge(String name,
                     ExternalValue externalValue)

Constructs a Gauge that reads its value from the ExternalValue provided.

Parameters:

name - the name of the Gauge

externalValue - - the ExternalInstrument to read its value from.

Throws:

IllegalArgumentException - if the externalValue is null

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