com.neeve.stats

Interface IStats.Gauge

All Known Implementing Classes:

AbstractGauge, BooleanGauge, ByteGauge, CharGauge, DoubleGauge, FieldReflectingGauge, FloatGauge, IntGauge, LongGauge, MethodReflectingGauge, ShortGauge, StringGauge

Enclosing interface:

IStats

public static interface IStats.Gauge

Interface used to collect an instantaneous value.

A IStats.Gauge is useful for reporting a value at the time of a statistics collection.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IStats.Gauge.Type Used to indicate the type of value that a Gauge returns.

Method Summary

Modifier and Type	Method and Description
void	get(StringBuilder builder, NumberFormat format) Appends the current value of this IStats.Gauge.
boolean	getBooleanValue() Gets the current value for a IStats.Gauge.Type.Boolean Gauge.
byte	getByteValue() Gets the current value for a IStats.Gauge.Type.Byte Gauge.
char	getCharValue() Gets the current value for a IStats.Gauge.Type.Char Gauge.
double	getDoubleValue() Gets the current value for a IStats.Gauge.Type.Double Gauge.
float	getFloatValue() Gets the current value for a IStats.Gauge.Type.Float Gauge.
int	getIntValue() Gets the current value for a IStats.Gauge.Type.Int Gauge.
long	getLongValue() Gets the current value for a IStats.Gauge.Type.Long Gauge.
String	getName() Gets statistic name.
XString	getNameAsRaw() Gets the stat's name as a XString.
short	getShortValue() Gets the current value for a IStats.Gauge.Type.Short Gauge.
XString	getStringValue() Gets the current value for a IStats.Gauge.Type.String Gauge.
IStats.Gauge.Type	getType() Gets the IStats.Gauge.Type of the IStats.Gauge.

Method Detail

getType

IStats.Gauge.Type getType()

Gets the IStats.Gauge.Type of the IStats.Gauge.

Returns:

Returns the IStats.Gauge.Type of the IStats.Gauge.

getName

String getName()

Gets statistic name.

Returns:

The statistic name

getNameAsRaw

XString getNameAsRaw()

Gets the stat's name as a XString.

Returns:

The statistic name in raw form

getBooleanValue

boolean getBooleanValue()

Gets the current value for a IStats.Gauge.Type.Boolean Gauge.

Returns:

The current value for a IStats.Gauge.Type.Boolean Gauge.

getByteValue

byte getByteValue()

Gets the current value for a IStats.Gauge.Type.Byte Gauge.

Returns:

The current value for a IStats.Gauge.Type.Byte Gauge.

getCharValue

char getCharValue()

Gets the current value for a IStats.Gauge.Type.Char Gauge.

Returns:

The current value for a IStats.Gauge.Type.Char Gauge.

getShortValue

short getShortValue()

Gets the current value for a IStats.Gauge.Type.Short Gauge.

Returns:

The current value for a IStats.Gauge.Type.Short Gauge.

getIntValue

int getIntValue()

Gets the current value for a IStats.Gauge.Type.Int Gauge.

Returns:

The current value for a IStats.Gauge.Type.Int Gauge.

getLongValue

long getLongValue()

Gets the current value for a IStats.Gauge.Type.Long Gauge.

Returns:

The current value for a IStats.Gauge.Type.Long Gauge.

getFloatValue

float getFloatValue()

Gets the current value for a IStats.Gauge.Type.Float Gauge.

Returns:

The current value for a IStats.Gauge.Type.Float Gauge.

getDoubleValue

double getDoubleValue()

Gets the current value for a IStats.Gauge.Type.Double Gauge.

Returns:

The current value for a IStats.Gauge.Type.Double Gauge.

getStringValue

XString getStringValue()

Gets the current value for a IStats.Gauge.Type.String Gauge.

Returns:

The current value for a IStats.Gauge.Type.String Gauge.

get

void get(StringBuilder builder,
         NumberFormat format)

Appends the current value of this IStats.Gauge. to the provided StringBuilder.

Parameters:

builder - The builder to which to append the gauge value results.

format - The number format to use for numeric formats.