org.lsst.ccs.gconsole.agent

Class BasicChannel

java.lang.Object

org.lsst.ccs.gconsole.agent.BasicChannel

All Implemented Interfaces:

AgentChannel, MutableAgentChannel

public class BasicChannel
extends Object
implements MutableAgentChannel

Author:

onoprien

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.gconsole.agent.AgentChannel

AgentChannel.Key

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<String,Object>	data
protected Object	value

Constructor Summary

Constructors

Modifier	Constructor and Description
	BasicChannel(AgentChannel other) Copy constructor.
	BasicChannel(BasicChannel other) Copy constructor.
protected	BasicChannel(String path, org.lsst.ccs.bus.data.AgentInfo agent) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
<T> T	get() Returns the current central value of this channel.
<T> T	get(Object key) Returns the value of the channel attribute identified by the key.
org.lsst.ccs.bus.data.AgentInfo	getAgent() Returns the descriptor of the Agent this channel belongs to.
String	getAgentName() Returns the name of the Agent this channel belongs to.
List<String>	getAttributes() Returns the list of keys of attributes this channel has.
String	getLocalPath() Returns the path of this channel with the agent name and the following slash stripped.
String	getPath() Return the unique path of this channel.
int	hashCode()
boolean	set(Object value) Sets the value of this channel.
boolean	set(Object key, Object value) Sets the value of the specified attribute.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

protected Object value

data

protected HashMap<String,Object> data

Constructor Detail

BasicChannel

protected BasicChannel(String path,
                       org.lsst.ccs.bus.data.AgentInfo agent)

Constructs an instance.

Parameters:

path - Unique path identifying this channel.

agent - Agent this channel belongs to.

BasicChannel

public BasicChannel(BasicChannel other)

Copy constructor.

Parameters:

other - Channel to copy.

BasicChannel

public BasicChannel(AgentChannel other)

Copy constructor.

Parameters:

other - Channel to copy.

Method Detail

getPath

public String getPath()

Return the unique path of this channel.

Specified by:

getPath in interface AgentChannel

Returns:

Channel path in (agent name)/(local path) form.

getAgentName

public String getAgentName()

Returns the name of the Agent this channel belongs to.

Specified by:

getAgentName in interface AgentChannel

Returns:

Agent name.

getAgent

public org.lsst.ccs.bus.data.AgentInfo getAgent()

Returns the descriptor of the Agent this channel belongs to.

Specified by:

getAgent in interface AgentChannel

Returns:

Agent descriptor.

getLocalPath

public String getLocalPath()

Returns the path of this channel with the agent name and the following slash stripped. Local paths are unique inside an agent.

Specified by:

getLocalPath in interface AgentChannel

Returns:

Local path.

get

public <T> T get(Object key)

Returns the value of the channel attribute identified by the key.

Specified by:

get in interface AgentChannel

Type Parameters:

T - Type of the attribute value.

Parameters:

key - Attribute key. If VALUE_KEY or null, the central value is returned.

Returns:

Attribute value, or null if this channel does not have the specified attribute.

get

public <T> T get()

Returns the current central value of this channel.

Specified by:

get in interface AgentChannel

Type Parameters:

T - Type of the central value.

Returns:

Current value.

getAttributes

public List<String> getAttributes()

Description copied from interface: AgentChannel

Returns the list of keys of attributes this channel has.

Specified by:

getAttributes in interface AgentChannel

Returns:

List of existing attribute keys.

set

public boolean set(Object key,
                   Object value)

Sets the value of the specified attribute. The attribute value does not change if the new value is equal to the old one.

Specified by:

set in interface MutableAgentChannel

Parameters:

key - The attribute is identified by the string returned by toString() method of the key object. If key is null or evaluates to VALUE_KEY, the central value is set.

value - The new value.

Returns:

true if the attribute value has changed as a result of this call.

set

public boolean set(Object value)

Sets the value of this channel. The value will not change if the new value is equal to the old one.

Specified by:

set in interface MutableAgentChannel

Parameters:

value - New value.

Returns:

true if the value has changed as a result of this call.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object