Package com.qfs.snl.dtos

Class StateDto

java.lang.Object

com.qfs.snl.dtos.StateDto

All Implemented Interfaces:

ISentinelState, Serializable

public class StateDto
extends Object
implements ISentinelState, Serializable

The state data transfer object.

Author:

ActiveViam

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.qfs.snl.data.ISentinelState

TABLE_NAME

Constructor Summary

Constructors

Constructor	Description
StateDto()	Constructor.
StateDto(ISentinelState state)	Copy constructor.
StateDto(String id, String caption, Double value, String formattedValue)	Full constructor.

Method Summary

Modifier and Type	Method	Description
static boolean	equals(ISentinelState state, Object obj)	Tests the equality between a ISentinelState and an object.
boolean	equals(Object obj)
String	getCaption()	Return the caption of the state.
String	getFormattedValue()	Return the formatted value of the state.
String	getId()	Gets the id of the state.
Double	getValue()	Return the value of the state.
int	hashCode()
static int	hashCode(ISentinelState state)	Computes the hashcode of a state.
static Map<String,ISentinelState>	mapById(Collection<? extends ISentinelState> states)	Maps the states by id.
void	setCaption(String caption)	Sets the state caption.
void	setFormattedValue(String formattedValue)	Sets the formatted value for the state value.
void	setId(String id)	Sets the id of the state.
void	setValue(double value)	Sets the state value.
String	toString()
static String	toString(ISentinelState state)	Returns a string representation of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StateDto

public StateDto()

Constructor.

StateDto

public StateDto(String id,
 String caption,
 Double value,
 String formattedValue)

Full constructor.

Parameters:

id - id of the state

caption - state caption

value - state value

formattedValue - state formatted value

StateDto

public StateDto(ISentinelState state)

Copy constructor.

Parameters:

state - state to copy

Method Details

getId

public String getId()

Description copied from interface: ISentinelState

Gets the id of the state.

Specified by:

getId in interface ISentinelState

Returns:

a list of strings composing the id

setId

public void setId(String id)

Sets the id of the state.

Parameters:

id - state id

getCaption

public String getCaption()

Description copied from interface: ISentinelState

Return the caption of the state.

Specified by:

getCaption in interface ISentinelState

Returns:

the caption of the state

setCaption

public void setCaption(String caption)

Sets the state caption.

Parameters:

caption - state caption

getValue

public Double getValue()

Description copied from interface: ISentinelState

Return the value of the state.

Specified by:

getValue in interface ISentinelState

Returns:

the value of the state

setValue

public void setValue(double value)

Sets the state value.

Parameters:

value - state value

getFormattedValue

public String getFormattedValue()

Description copied from interface: ISentinelState

Return the formatted value of the state.

Specified by:

getFormattedValue in interface ISentinelState

Returns:

the formatted value of the state

setFormattedValue

public void setFormattedValue(String formattedValue)

Sets the formatted value for the state value.

Parameters:

formattedValue - formatted value.

hashCode

public int hashCode()

Cache the hashcode for performance reasons, as this object is not supposed to be mutable.

Overrides:

hashCode in class Object

hashCode

public static int hashCode(ISentinelState state)

Computes the hashcode of a state.

Parameters:

state - state to consider.

Returns:

resulting hash code

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equals

public static boolean equals(ISentinelState state,
 Object obj)

Tests the equality between a ISentinelState and an object.

Two states are equals if they share the same id.

Parameters:

state - the reference state

obj - the object to test

Returns:

true for equality

toString

public String toString()

Overrides:

toString in class Object

toString

public static String toString(ISentinelState state)

Returns a string representation of the object.

Parameters:

state - state to consider

Returns:

a string representation of the object.

mapById

public static Map<String,ISentinelState> mapById(Collection<? extends ISentinelState> states)

Maps the states by id.

Parameters:

states - the states to map

Returns:

the mapped states