Package org.lsst.ccs.services

Class AgentCommandDictionaryService.AgentCommandDictionaryEvent

java.lang.Object

org.lsst.ccs.services.AgentCommandDictionaryService.AgentCommandDictionaryEvent

Enclosing class:

AgentCommandDictionaryService

public static class AgentCommandDictionaryService.AgentCommandDictionaryEvent
extends Object

An event fired to AgentCommandDictionaryListeners when an agent command dictionary has changed. It contains the EventType describing the nature of the change: * ADDED: fired when an Agent first joins the buses * UPDATED: fired when an existing dictionary is updated. Currently unused. * REMOVED: fired when an agent leaves the buses. The corresponding dictionary is null. An AgentCommandDictionaryEvent also contains the AgentInfo for which the event was fired and the Map<String,Dictionary> containing all the targets and corresponding dictionaries for the given Agent.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AgentCommandDictionaryService.AgentCommandDictionaryEvent.EventType	EventType enumeration describing the nature of the dictionary change.

Method Summary

Modifier and Type	Method	Description
AgentInfo	getAgentInfo()	The AgentInfo for the Agent that triggered the event.
HashMap<String,Dictionary>	getDictionary()	Get the Map<String,Dictionary> of targets with corresponding Dictionary that are available for the given AgentInfo.
AgentCommandDictionaryService.AgentCommandDictionaryEvent.EventType	getEventType()	Get the EventType describing this event.

Methods inherited from class java.lang.Object

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

Method Details

getEventType

public AgentCommandDictionaryService.AgentCommandDictionaryEvent.EventType getEventType()

Get the EventType describing this event.

Returns:

The EventType that describes the event.

getAgentInfo

public AgentInfo getAgentInfo()

The AgentInfo for the Agent that triggered the event.

Returns:

The AgentInfo object.

getDictionary

public HashMap<String,Dictionary> getDictionary()

Get the Map<String,Dictionary> of targets with corresponding Dictionary that are available for the given AgentInfo.

Returns:

The Map of targets, Dictionaries.