Module datarush.commons

Package com.pervasive.datarush.monitoring

Class GaugeSnapshot

java.lang.Object

com.pervasive.datarush.monitoring.GaugeSnapshot

All Implemented Interfaces:

GaugeSupplier, StatisticSupplier, Serializable

public final class GaugeSnapshot
extends Object
implements GaugeSupplier, Serializable

A snapshot that reflects a point-in-time of a GaugeSupplier.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final GaugeSnapshot	UNAVAILABLE	Constant that corresponds to a snapshot of a counter whose value is unavailable

Constructor Summary

Constructors

Constructor	Description
GaugeSnapshot(GaugeSupplier supplier)	Create a snapshot of the given gauge.
GaugeSnapshot(StatisticState state, long currentValue, long minAllowedValue, long maxAllowedValue)	Create a snapshot with the specified values

Method Summary

Modifier and Type	Method	Description
long	getCurrentValue()	Returns the current value of the gauge or an unspecified value if the gauge is unavailable.
long	getMaxAllowedValue()	Returns the maximum allowed value for the gauge of Long.MAX_VALUE if there is no maximum
long	getMinAllowedValue()	Returns the minimum allowed value for the gauge or Long.MIN_VALUE if there is no minimum.
StatisticState	getState()	Returns the current state of the supplier.
GaugeSupplier	snapshot()	Returns a snapshot of this statistic.

Methods inherited from class java.lang.Object

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

Field Details

UNAVAILABLE

public static final GaugeSnapshot UNAVAILABLE

Constant that corresponds to a snapshot of a counter whose value is unavailable

Constructor Details

GaugeSnapshot

public GaugeSnapshot(GaugeSupplier supplier)

Create a snapshot of the given gauge.

Parameters:

supplier - the gauge

GaugeSnapshot

public GaugeSnapshot(StatisticState state,
 long currentValue,
 long minAllowedValue,
 long maxAllowedValue)

Create a snapshot with the specified values

Parameters:

state - the state of the gauge

currentValue - the current value of the gauge

minAllowedValue - the minimum allowed value of the gauge

maxAllowedValue - the maximum allowed value of the gauge

Method Details

getState

public StatisticState getState()

Description copied from interface: StatisticSupplier

Returns the current state of the supplier.

Specified by:

getState in interface StatisticSupplier

Returns:

the state of the supplier

getCurrentValue

public long getCurrentValue()

Description copied from interface: GaugeSupplier

Returns the current value of the gauge or an unspecified value if the gauge is unavailable.

Specified by:

getCurrentValue in interface GaugeSupplier

Returns:

the current value of the gauge

getMinAllowedValue

public long getMinAllowedValue()

Description copied from interface: GaugeSupplier

Returns the minimum allowed value for the gauge or Long.MIN_VALUE if there is no minimum.

Specified by:

getMinAllowedValue in interface GaugeSupplier

Returns:

the minimum allowed value for the gauge

getMaxAllowedValue

public long getMaxAllowedValue()

Description copied from interface: GaugeSupplier

Returns the maximum allowed value for the gauge of Long.MAX_VALUE if there is no maximum

Specified by:

getMaxAllowedValue in interface GaugeSupplier

Returns:

the maximum allowed value for the gauge

snapshot

public GaugeSupplier snapshot()

Description copied from interface: StatisticSupplier

Returns a snapshot of this statistic.

Specified by:

snapshot in interface GaugeSupplier

Specified by:

snapshot in interface StatisticSupplier

Returns:

a snapshot of this statistic.