org.lsst.ccs.bus.data

Class AgentInfo

java.lang.Object

org.lsst.ccs.bus.data.AgentInfo

All Implemented Interfaces:

Serializable

public final class AgentInfo
extends Object
implements Serializable

A class to encapsulate an agent's name and type. This class is used to represent an Agent across the buses. The Agent's name is its unique name on the Buses. Its type defines its role on the buses. Two AgentInfo instances are considered equal if they have the same name and type. When two AgentInfo instances are equal, they represent the same Agent on the buses.

Author:

emarin

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentInfo.AgentType Enumeration of known agent types.

Constructor Summary

Constructors

Constructor and Description
AgentInfo(String name, AgentInfo.AgentType type) The base constructor of an AgentInfo.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object a)
String	getName() The Agent's name on the Buses.
AgentInfo.AgentType	getType() The Agent's AgentType.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentInfo

public AgentInfo(String name,
                 AgentInfo.AgentType type)

The base constructor of an AgentInfo. It takes the Agent's name and its AgentType.

Parameters:

name - The name of the Agent as defined on the Buses.

type - The AgentType of the Agent. This determines its role.

Method Detail

getName

public String getName()

The Agent's name on the Buses. This must be unique.

Returns:

The name of the Agent on the Buses.

getType

public AgentInfo.AgentType getType()

The Agent's AgentType. This represents its role on the buses.

Returns:

The AgentType of the Agent.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object a)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object