org.arl.fjage.param

Class ParameterRsp

java.lang.Object

org.arl.fjage.Message

org.arl.fjage.param.ParameterRsp

All Implemented Interfaces:

java.io.Serializable

public class ParameterRsp
extends Message

Response message for ParameterReq.

See Also:

ParameterReq, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	index
protected Parameter	param
protected java.util.Set<Parameter>	readonly
protected GenericValue	value
protected java.util.Map<Parameter,GenericValue>	values

Fields inherited from class org.arl.fjage.Message

inReplyTo, msgID, perf, recipient, sender, sentAt

Constructor Summary

Constructors

Constructor and Description
ParameterRsp(Message msg) Constructs a response message.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all parameter and values.
java.lang.Object	get(Parameter param) Gets the queried parameter value.
int	getIndex() Gets the index.
java.util.Map<Parameter,java.lang.Object>	getParameters() Gets all requested parameters as map.
boolean	isReadonly(Parameter param) Checks if a parameter is read-only.
java.util.Set<Parameter>	parameters() Gets all requested parameters as set.
protected Parameter	resolve(Parameter param) Convert named parameters to qualified parameters, if they match.
void	set(Parameter param, java.lang.Object value, boolean readonly) Sets the parameter.
void	setIndex(int index) Sets the index for parameter.
java.lang.String	toString() Gets a string representation of the message.

Methods inherited from class org.arl.fjage.Message

getInReplyTo, getJsonCache, getMessageID, getPerformative, getRecipient, getSender, getSentAt, setInReplyTo, setJsonCache, setMessageID, setPerformative, setRecipient, setSender, setSentAt

Methods inherited from class java.lang.Object

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

Field Detail

index

protected int index

values

protected java.util.Map<Parameter,GenericValue> values

param

protected Parameter param

value

protected GenericValue value

readonly

protected java.util.Set<Parameter> readonly

Constructor Detail

ParameterRsp

public ParameterRsp(Message msg)

Constructs a response message.

Parameters:

msg - message to which this response corresponds to.

Method Detail

clear

public void clear()

Clears all parameter and values.

getIndex

public int getIndex()

Gets the index.

Returns:

index or -1 if not indexed

setIndex

public void setIndex(int index)

Sets the index for parameter.

Parameters:

index - index or -1 if not indexed

set

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

Sets the parameter.

Parameters:

param - parameter

value - value

readonly - true if read-only, false if read-write

get

public java.lang.Object get(Parameter param)

Gets the queried parameter value.

Parameters:

param - Parameter

Returns:

value of requested parameter

isReadonly

public boolean isReadonly(Parameter param)

Checks if a parameter is read-only.

Parameters:

param - Parameter

Returns:

true if parameter is read-only, false if read-write

parameters

public java.util.Set<Parameter> parameters()

Gets all requested parameters as set.

Returns:

the parameter set

getParameters

public java.util.Map<Parameter,java.lang.Object> getParameters()

Gets all requested parameters as map.

Returns:

the parameter map

resolve

protected Parameter resolve(Parameter param)

Convert named parameters to qualified parameters, if they match.

Parameters:

param - parameter to resolve

Returns:

resolved parameter

toString

public java.lang.String toString()

Description copied from class: Message

Gets a string representation of the message.

Overrides:

toString in class Message

Returns:

string representation.

See Also:

Object.toString()