com.atlassian.instrumentation

Class ExternalCounter

java.lang.Object

com.atlassian.instrumentation.ExternalCounter

All Implemented Interfaces:

Counter, Instrument, Comparable<Instrument>

public class ExternalCounter
extends Object
implements Counter

An ExternalCounter is a Counter 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

See Also:

ExternalValue

Constructor Summary

Constructors

Constructor and Description
ExternalCounter(String name, ExternalValue externalValue) Constructs a Counter 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 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

Constructor Detail

ExternalCounter

public ExternalCounter(String name,
                       ExternalValue externalValue)

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

Parameters:

name - the name of the external counter

externalValue - - the external value 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: 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

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