net.anotheria.moskito.core.stats.impl

Class DoubleValueHolder

java.lang.Object

net.anotheria.moskito.core.stats.impl.DoubleValueHolder

All Implemented Interfaces:

IIntervalListener, ValueHolder

public class DoubleValueHolder
extends java.lang.Object

This class implements a ValueHolder that is able to process double values.

Author:

Michael König

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_DEFAULT_VALUE This is the value that will be used as defaultValue if no other one was specified.

Constructor Summary

Constructors

Constructor and Description
DoubleValueHolder(Interval aInterval) Constructs an instance of DoubleValueHolder.

Method Summary

Modifier and Type	Method and Description
void	decrease() This method shall decrement the value by one.
void	decreaseByDouble(double aValue) This method shall decrement the current value by the given amount.
void	decreaseByInt(int aValue) This method shall decrement the current value by the given amount.
void	decreaseByLong(long aValue) This method shall decrement the current value by the given amount.
double	getCurrentValueAsDouble() This method shall return the current value as double for internal use only.
int	getCurrentValueAsInt() This method shall return the current value as int for internal use only.
long	getCurrentValueAsLong() This method shall return the current value as long for internal use only.
java.lang.String	getCurrentValueAsString()
double	getValueAsDouble() This method shall return the current value as double.
int	getValueAsInt() This method shall return the current value as int.
long	getValueAsLong() This method shall return the current value as long.
java.lang.String	getValueAsString()
void	increase() This method shall increment the value by one.
void	increaseByDouble(double aValue) This method shall increment the current value by the given amount.
void	increaseByInt(int aValue) This method shall increment the current value by the given amount.
void	increaseByLong(long aValue) This method shall increment the current value by the given amount.
void	intervalUpdated(Interval aCaller) This method will be called if the time of the given Interval was elapsed.
void	reset() This method shall reset the ValueHolder.
void	setDefaultValueAsDouble(double aValue) This method shall set a new default value.
void	setDefaultValueAsInt(int aValue) This method shall set a new default value.
void	setDefaultValueAsLong(long aValue) This method shall set a new default value.
void	setValueAsDouble(double aValue) This method shall assign the given value to the current value.
void	setValueAsInt(int aValue) This method shall assign the given value to the current value.
void	setValueAsLong(long aValue) This method shall assign the given value to the current value.
void	setValueAsString(java.lang.String aValue) This method shall assign the given value to the current value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DEFAULT_VALUE

public static final double DEFAULT_DEFAULT_VALUE

This is the value that will be used as defaultValue if no other one was specified.

See Also:

Constant Field Values

Constructor Detail

DoubleValueHolder

public DoubleValueHolder(Interval aInterval)

Constructs an instance of DoubleValueHolder.

Parameters:

aInterval - Interval

Method Detail

intervalUpdated

public void intervalUpdated(Interval aCaller)

This method will be called if the time of the given Interval was elapsed.

Parameters:

aCaller - The Interval that calls this method

reset

public void reset()

This method shall reset the ValueHolder. After calling reset() it must have the same state as directly after creation.

increase

public void increase()

This method shall increment the value by one.

decrease

public void decrease()

This method shall decrement the value by one.

getValueAsInt

public int getValueAsInt()

This method shall return the current value as int.

Returns:

the current value

getValueAsLong

public long getValueAsLong()

This method shall return the current value as long.

Returns:

the current value

getValueAsDouble

public double getValueAsDouble()

This method shall return the current value as double.

Returns:

the current value

getValueAsString

public java.lang.String getValueAsString()

getCurrentValueAsInt

public int getCurrentValueAsInt()

This method shall return the current value as int for internal use only.

Returns:

the current value

getCurrentValueAsLong

public long getCurrentValueAsLong()

This method shall return the current value as long for internal use only.

Returns:

the current value

getCurrentValueAsDouble

public double getCurrentValueAsDouble()

This method shall return the current value as double for internal use only.

Returns:

the current value

getCurrentValueAsString

public java.lang.String getCurrentValueAsString()

setValueAsInt

public void setValueAsInt(int aValue)

This method shall assign the given value to the current value.

Parameters:

aValue - the new value

setValueAsString

public void setValueAsString(java.lang.String aValue)

This method shall assign the given value to the current value.

Parameters:

aValue - the new value

setValueAsLong

public void setValueAsLong(long aValue)

This method shall assign the given value to the current value.

Parameters:

aValue - the new value

setValueAsDouble

public void setValueAsDouble(double aValue)

This method shall assign the given value to the current value.

Parameters:

aValue - the new value

increaseByInt

public void increaseByInt(int aValue)

This method shall increment the current value by the given amount.

Parameters:

aValue - the amount

increaseByLong

public void increaseByLong(long aValue)

This method shall increment the current value by the given amount.

Parameters:

aValue - the amount

increaseByDouble

public void increaseByDouble(double aValue)

This method shall increment the current value by the given amount.

Parameters:

aValue - the amount

decreaseByInt

public void decreaseByInt(int aValue)

This method shall decrement the current value by the given amount.

Parameters:

aValue - the amount

decreaseByLong

public void decreaseByLong(long aValue)

This method shall decrement the current value by the given amount.

Parameters:

aValue - the amount

decreaseByDouble

public void decreaseByDouble(double aValue)

This method shall decrement the current value by the given amount.

Parameters:

aValue - the amount

setDefaultValueAsInt

public void setDefaultValueAsInt(int aValue)

This method shall set a new default value. The default value shall be set as current value if the reset method will be called.

Parameters:

aValue - the new default value

setDefaultValueAsLong

public void setDefaultValueAsLong(long aValue)

This method shall set a new default value. The default value shall be set as current value if the reset method will be called.

Parameters:

aValue - the new default value

setDefaultValueAsDouble

public void setDefaultValueAsDouble(double aValue)

This method shall set a new default value. The default value shall be set as current value if the reset method will be called.

Parameters:

aValue - the new default value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()