fr.liglab.adele.icasa.common

Interface StateVariable

All Known Subinterfaces:

ContextualStateVariable

public interface StateVariable

Represents a state with a defined type. A state variable explicitly defines if it is able to push notifications of state value changes.

Author:

Thomas Leveque

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(StateVariableListener listener) Add a listener which listens of value changes.
boolean	canBeModified() Returns true if its value can be modified using the setValue method.
boolean	canSendNotifications() Returns true if it is able to push notifications of state value changes.
String	getDescription() Returns variable description.
Object	getMetadataValue(String name) Returns value of specified metadata.
Map<String,Object>	getMetadataValues() Returns a map containing all metadata of this variable.
String	getName() Returns variable name.
Object	getOwner() Returns object which owns this variable.
VariableType	getType() Returns variable type.
Object	getValue() Returns variable value.
Class	getValueType() Returns variable value type.
boolean	hasMetadata(String name) Returns true if a metadata with specified has been set.
boolean	hasValue() Returns true if this variable has a defined value.
void	removeListener(StateVariableListener listener) Removes specified listener.
void	setMetadataValue(String name, Object value) Sets specified value to corresponding metadata.
void	setValue(Object value) Sets specified value.

Method Detail

getName

String getName()

Returns variable name.

Returns:

variable name.

canSendNotifications

boolean canSendNotifications()

Returns true if it is able to push notifications of state value changes. This does not mean that it is able to push one notification for every value change but that a value change will be sent at least with a certain latency.

Returns:

true if it is able to push notifications of state value changes.

canBeModified

boolean canBeModified()

Returns true if its value can be modified using the setValue method. If false, this does not mean that the value cannot be changed outside current digital service.

Returns:

true if its value can be modified using the setValue method.

addListener

void addListener(StateVariableListener listener)

Add a listener which listens of value changes.

Parameters:

listener - a listener of value changes.

removeListener

void removeListener(StateVariableListener listener)

Removes specified listener.

Parameters:

listener - a listener of value changes.

getValue

Object getValue()

Returns variable value. Null means that there is no value defined.

Returns:

variable value.

getDescription

String getDescription()

Returns variable description.

Returns:

variable description.

getType

VariableType getType()

Returns variable type.

Returns:

variable type.

getValueType

Class getValueType()

Returns variable value type.

Returns:

variable value type.

setValue

void setValue(Object value)

Sets specified value.

Parameters:

value - the new value to set

Throws:

IllegalArgumentException - if this value cannot be modified.

hasValue

boolean hasValue()

Returns true if this variable has a defined value.

Returns:

true if this variable has a defined value.

getOwner

Object getOwner()

Returns object which owns this variable.

Returns:

object which owns this variable.

hasMetadata

boolean hasMetadata(String name)

Returns true if a metadata with specified has been set.

Parameters:

name - a metadata name

Returns:

true if a metadata with specified has been set.

getMetadataValue

Object getMetadataValue(String name)

Returns value of specified metadata. Returns null if there is no such metadata.

Parameters:

name - a metadata name

Returns:

value of specified metadata.

setMetadataValue

void setMetadataValue(String name,
                    Object value)

Sets specified value to corresponding metadata.

Parameters:

name - a metadata name

value - metadata value to set

getMetadataValues

Map<String,Object> getMetadataValues()

Returns a map containing all metadata of this variable.

Returns:

a map containing all metadata of this variable.