org.lsst.ccs.gconsole.services.lock

Class Locker

java.lang.Object

org.lsst.ccs.gconsole.services.lock.Locker

public class Locker
extends Object

Lock management service handle for a specific agent. The equality of instances of this class is based on agent names. All access to this class should be on EDT.

Method Summary

Modifier and Type	Method and Description
boolean	addListener(ChangeListener listener)
boolean	equals(Object obj) Checks equality based on agent name.
Map<String,org.lsst.ccs.command.Dictionary>	getDictionaries() Returns command dictionaries for the agent.
org.lsst.ccs.bus.data.AgentInfo	getInfo() Returns agent descriptor, if available.
int	getLevel() Returns current level for the agent.
org.lsst.ccs.bus.data.AgentLock	getLock() Returns current lock for the agent.
String	getName() Returns agent name.
LockService.State	getState() Returns current state for the agent.
int	hashCode() Computes hash code based on agent name.
boolean	isAdjusting() Checks whether the locking state of the agent is in the process of being adjusted.
boolean	isOnline() Checks whether the agent is currently connected to the busses and its command dictionary is available.
boolean	removeAllListeners()
boolean	removeListener(ChangeListener listener)

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Returns agent name.

Returns:

Agent name (never changes).

getInfo

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

Returns agent descriptor, if available.

Returns:

Agent descriptor, or null in the agent has never been online since this handle creation.

getLock

public org.lsst.ccs.bus.data.AgentLock getLock()

Returns current lock for the agent.

Returns:

Current lock, or null if the agent is unlocked.

getLevel

public int getLevel()

Returns current level for the agent.

Returns:

Current level (always 0 if the agent is not attached to this console).

getState

public LockService.State getState()

Returns current state for the agent.

Returns:

Current state.

isOnline

public boolean isOnline()

Checks whether the agent is currently connected to the busses and its command dictionary is available.

Returns:

True if the agent is online.

isAdjusting

public boolean isAdjusting()

Checks whether the locking state of the agent is in the process of being adjusted.

Returns:

True if this console is performing an operation that might result in the status change.

getDictionaries

public Map<String,org.lsst.ccs.command.Dictionary> getDictionaries()

Returns command dictionaries for the agent.

Returns:

Command dictionaries.

addListener

public boolean addListener(ChangeListener listener)

removeListener

public boolean removeListener(ChangeListener listener)

removeAllListeners

public boolean removeAllListeners()

hashCode

public int hashCode()

Computes hash code based on agent name.

Overrides:

hashCode in class Object

Returns:

Hash code.

equals

public boolean equals(Object obj)

Checks equality based on agent name.

Overrides:

equals in class Object

Parameters:

obj - The other object.

Returns:

True if equal.