com.sleepycat.je.utilint

Class LongDiffStat

java.lang.Object

com.sleepycat.je.utilint.BaseStat<T>

com.sleepycat.je.utilint.MapStatComponent<Long,LongDiffStat>

com.sleepycat.je.utilint.LongDiffStat

All Implemented Interfaces:

Serializable

public class LongDiffStat
extends MapStatComponent<Long,LongDiffStat>

A long JE stat component that computes the difference between another stat and a specified value. Reports 0 if the value is greater than the stat value. The computed difference remains valid for a specified amount of time, which should represent the maximum amount of time expected to elapse between when new values are provided. If no value is specified within the validity interval, then the difference is recomputed using the current base stat value and the last specified value. The idea is to treat the specified value as up-to-date for a certain period of time, and then represent that the lack of updates means it is falling behind.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LongDiffStat(Stat<Long> base, long validityMillis) Creates an instance of this class.

Method Summary

Modifier and Type	Method and Description
void	clear() Resets the statistic to its initial state.
LongDiffStat	copy() Narrow the return type to the component type.
Long	get() Returns the value of the stat for the current time.
long	get(long time) Returns the value of the stat for the specified time.
protected String	getFormattedValue(boolean useCommas) Returns the value of the statistic as a formatted string, either using or not using commas as requested.
boolean	isNotSet() Returns whether the statistic is in its initial state.
void	set(long newValue) Specifies a new value for the current time.
void	set(long newValue, long time) Specifies a new value for the specified time.
String	toString()

Methods inherited from class com.sleepycat.je.utilint.MapStatComponent

getFormattedValue

Methods inherited from class java.lang.Object

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

Constructor Detail

LongDiffStat

public LongDiffStat(Stat<Long> base,
                    long validityMillis)

Creates an instance of this class.

Parameters:

base - the base stat used for computing differences

validityMillis - the amount of time, in milliseconds, which a computed difference remains valid

Method Detail

get

public long get(long time)

Returns the value of the stat for the specified time.

Parameters:

time - the time

Returns:

the value of the stat

set

public void set(long newValue)

Specifies a new value for the current time.

Parameters:

newValue - the new value

set

public void set(long newValue,
                long time)

Specifies a new value for the specified time.

Parameters:

newValue - the new value

time - the time

get

public Long get()

Returns the value of the stat for the current time.

Specified by:

get in class BaseStat<Long>

Returns:

the value

clear

public void clear()

Description copied from class: BaseStat

Resets the statistic to its initial state.

Specified by:

clear in class BaseStat<Long>

copy

public LongDiffStat copy()

Description copied from class: MapStatComponent

Narrow the return type to the component type.

Specified by:

copy in class MapStatComponent<Long,LongDiffStat>

Returns:

a copy

getFormattedValue

protected String getFormattedValue(boolean useCommas)

Description copied from class: MapStatComponent

Returns the value of the statistic as a formatted string, either using or not using commas as requested. Implementations should make sure that the result does not contain commas when useCommas is false, because the value will be used in a comma-separated value file, where embedded commas would cause problems.

Specified by:

getFormattedValue in class MapStatComponent<Long,LongDiffStat>

Parameters:

useCommas - whether to use commas

Returns:

the value as a formatted string

isNotSet

public boolean isNotSet()

Description copied from class: BaseStat

Returns whether the statistic is in its initial state.

Specified by:

isNotSet in class BaseStat<Long>

Returns:

if the statistic is in its initial state

toString

public String toString()

Overrides:

toString in class Object