com.cloudhopper.commons.util

Class TimedStateBoolean

java.lang.Object

com.cloudhopper.commons.util.TimedStateBoolean

public class TimedStateBoolean
extends Object

Wrapper around Java AtomicBoolean to include the DateTime of when the state last changed, effectively providing a "time" of the current state.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Constructor Summary

Constructors

Constructor and Description
TimedStateBoolean(boolean initialValue) Creates a new instance with the initalValue.
TimedStateBoolean(boolean initialValue, boolean expectedValue) Creates a new instance with the initalValue.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	get() Returns the current value.
boolean	getAndSet(boolean newValue) Sets to the given value and returns the previous value.
boolean	getExpected() Returns the expected value of this state boolean.
org.joda.time.DateTime	getValueDateTime() Returns a DateTime that represents the last time this boolean changed state.
org.joda.time.Period	getValueDuration() Based on the time this method is called (System.currentTimeMillis), this method returns a Period that represents the duration of time this value has retained this value.
long	getValueDurationInMills() Based on the time this method is called (System.currentTimeMillis), this method returns a long that represents the duration of time this value has retained this value.
long	getValueTimeMillis() Returns the timestamp (num of milliseconds via System.currentTimeMillis) of the last time this boolean changed state.
boolean	isExpected() Tests whether this state boolean is what we would expect it to be.
void	set(boolean newValue) Unconditionally sets to the given value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TimedStateBoolean

public TimedStateBoolean(boolean initialValue)

Creates a new instance with the initalValue. This constructor does not setup an expectedValue, so either value will be ok.

Parameters:

initialValue - The initial value of the boolean.

TimedStateBoolean

public TimedStateBoolean(boolean initialValue,
                 boolean expectedValue)

Creates a new instance with the initalValue. The expectedValue is the value we would expect if this is in a good state.

Parameters:

initialValue - The initial value of the boolean.

expectedValue - The expected value of the boolean if this was in a good state.

Method Detail

getExpected

public boolean getExpected()

Returns the expected value of this state boolean. If this instance does not have an expectedValue set, this will always return the current value.

Returns:

isExpected

public boolean isExpected()

Tests whether this state boolean is what we would expect it to be. If no expectedValue is actually set, this will always return true.

Returns:

getAndSet

public boolean getAndSet(boolean newValue)

Sets to the given value and returns the previous value. If the previous value is different than the new value, the internal "valueTime" will be updated.

Parameters:

newValue - The new boolean value

Returns:

set

public void set(boolean newValue)

Unconditionally sets to the given value.

Parameters:

newValue - The new boolean value

get

public boolean get()

Returns the current value.

Returns:

Returns the current value.

getValueTimeMillis

public long getValueTimeMillis()

Returns the timestamp (num of milliseconds via System.currentTimeMillis) of the last time this boolean changed state. In order to calculate the total number of milliseconds this boolean has retained this value, you'll need to do your own call to System.currentTimeMillis() and substract this value.

getValueDateTime

public org.joda.time.DateTime getValueDateTime()

Returns a DateTime that represents the last time this boolean changed state.

getValueDuration

public org.joda.time.Period getValueDuration()

Based on the time this method is called (System.currentTimeMillis), this method returns a Period that represents the duration of time this value has retained this value.

See Also:

getValueDurationInMills()

getValueDurationInMills

public long getValueDurationInMills()

Based on the time this method is called (System.currentTimeMillis), this method returns a long that represents the duration of time this value has retained this value.

See Also:

getValueDuration()

toString

public String toString()

Overrides:

toString in class Object