org.arl.fjage

Class AgentID

java.lang.Object

org.arl.fjage.AgentID

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AgentID>

public class AgentID
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<AgentID>

An identifier for an agent or a topic.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AgentID(AgentID aid, Messenger owner) Constructor to create an owned agent id from another agent id.
AgentID(java.lang.String name) Constructor to create an agent id given the agent's name.
AgentID(java.lang.String name, boolean isTopic) Constructor to create an agent id for an agent or a topic.
AgentID(java.lang.String name, boolean isTopic, Messenger owner) Constructor to create an owned agent id for an agent or a topic.
AgentID(java.lang.String name, Messenger owner) Constructor to create an owned agent id given the agent's name.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AgentID aid) Compares two agent ids to determine an ordering.
boolean	equals(java.lang.Object obj) Compares this agent id with another object.
java.lang.Object	get(Parameter param) Sends a parameter request to the agent represented by this id and returns the parameter value from the agent, or null if unavailable.
java.lang.Object	get(Parameter param, int ndx) Sends a parameter request to the agent represented by this id and returns the parameter value from the agent, or null if unavailable.
java.lang.String	getName() Gets the name of the agent or topic.
Messenger	getOwner() Gets the owner of the agent id.
java.lang.String	getType() Gets the type of the agent, if available.
int	hashCode() Computes a hashcode for the agent id.
boolean	isTopic() Returns true if the agent id represents a topic.
Message	leftShift(Message msg) Sends a request to the agent represented by this id and waits for a return message for 1 second.
Message	request(Message msg) Sends a request to the agent represented by this id and waits for a return message for 1 second.
Message	request(Message msg, long timeout) Sends a request to the agent represented by this id and waits for a return message for a specified timeout.
boolean	send(Message msg) Sends a message to the agent represented by this id.
java.lang.Object	set(Parameter param, java.lang.Object value) Sends a parameter request to the agent represented by this id to change the parameter value from the agent.
java.lang.Object	set(Parameter param, java.lang.Object value, int ndx) Sends a parameter request to the agent represented by this id to change the parameter value from the agent.
void	setType(java.lang.String type) Sets the type of the agent.
java.lang.String	toString() Gets a string representation of the agent id.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentID

public AgentID(java.lang.String name)

Constructor to create an agent id given the agent's name.

Parameters:

name - name of the agent.

AgentID

public AgentID(java.lang.String name,
               boolean isTopic)

Constructor to create an agent id for an agent or a topic.

Parameters:

name - name of the agent or topic.

isTopic - true if the agent id is to represent a topic, false if it is to represent an agent.

AgentID

public AgentID(java.lang.String name,
               Messenger owner)

Constructor to create an owned agent id given the agent's name.

Parameters:

name - name of the agent.

owner - owner agent.

AgentID

public AgentID(java.lang.String name,
               boolean isTopic,
               Messenger owner)

Constructor to create an owned agent id for an agent or a topic.

Parameters:

name - name of the agent or topic.

isTopic - true if the agent id is to represent a topic, false if it is to represent an agent.

owner - owner agent.

AgentID

public AgentID(AgentID aid,
               Messenger owner)

Constructor to create an owned agent id from another agent id.

Parameters:

aid - agent id to inherit.

owner - owner agent.

Method Detail

isTopic

public boolean isTopic()

Returns true if the agent id represents a topic.

Returns:

true if the agent id represents a topic, false if it represents an agent.

getName

public java.lang.String getName()

Gets the name of the agent or topic.

Returns:

name of agent or topic.

getOwner

public Messenger getOwner()

Gets the owner of the agent id. This is usually the agent that created the agent id, and will be used to send messages to this agent id.

Returns:

owner agent.

getType

public java.lang.String getType()

Gets the type of the agent, if available. For Java or Groovy agents, the type is the fully qualified class name of the agent.

Returns:

type of the agent if available, null otherwise.

setType

public void setType(java.lang.String type)

Sets the type of the agent. For Java or Groovy agents, the type is the fully qualified class name of the agent.

Parameters:

type - type of the agent.

send

public boolean send(Message msg)

Sends a message to the agent represented by this id.

Parameters:

msg - message to send.

request

public Message request(Message msg)

Sends a request to the agent represented by this id and waits for a return message for 1 second.

Parameters:

msg - request to send.

Returns:

response.

leftShift

public Message leftShift(Message msg)

Sends a request to the agent represented by this id and waits for a return message for 1 second. This method implements the Groovy << operator, so that agentID << msg works in both dynamically and statically compiled Groovy agents.

Parameters:

msg - request to send.

Returns:

response.

request

public Message request(Message msg,
                       long timeout)

Sends a request to the agent represented by this id and waits for a return message for a specified timeout.

Parameters:

msg - request to send.

timeout - timeout in milliseconds.

Returns:

response.

get

public java.lang.Object get(Parameter param)

Sends a parameter request to the agent represented by this id and returns the parameter value from the agent, or null if unavailable.

Parameters:

param - parameter name or enum.

get

public java.lang.Object get(Parameter param,
                            int ndx)

Sends a parameter request to the agent represented by this id and returns the parameter value from the agent, or null if unavailable.

Parameters:

param - parameter name or enum.

ndx - index of parameter (-1 for non-indexed parameters).

set

public java.lang.Object set(Parameter param,
                            java.lang.Object value)

Sends a parameter request to the agent represented by this id to change the parameter value from the agent.

Parameters:

param - parameter name or enum.

value - value of the parameter.

Returns:

new value of the parameter, or null if unavailable/failed.

set

public java.lang.Object set(Parameter param,
                            java.lang.Object value,
                            int ndx)

Sends a parameter request to the agent represented by this id to change the parameter value from the agent.

Parameters:

param - parameter name or enum.

value - value of the parameter.

ndx - index of parameter (-1 for non-indexed parameters).

Returns:

new value of the parameter, or null if unavailable/failed.

toString

public java.lang.String toString()

Gets a string representation of the agent id.

Overrides:

toString in class java.lang.Object

Returns:

string representation of the agent id.

See Also:

Object.toString()

hashCode

public int hashCode()

Computes a hashcode for the agent id. If two agent ids are equal, their hashcodes are equal.

Overrides:

hashCode in class java.lang.Object

Returns:

the hashcode.

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Compares this agent id with another object. Two agent ids are considered to be equal if both represent the same type of id, i.e. agent or topic, and the names are the same. An agent id is considered to be equal to a string if its name matches the string. An agent id does not match any other type of object.

Overrides:

equals in class java.lang.Object

Returns:

true if the object is considered equal to the agent id, false otherwise.

See Also:

Object.equals(java.lang.Object)

compareTo

public int compareTo(AgentID aid)

Compares two agent ids to determine an ordering. If the agent ids are identical, this method returns 0. If they are not identical, the ordering is deterministic, but arbitrary.

Specified by:

compareTo in interface java.lang.Comparable<AgentID>

Parameters:

aid - agent id to compare to.

Returns:

0 if equal, +1 if larger and -1 if smaller.