org.refcodes.remoting.messages.impls

Class ReplyDescriptorImpl

java.lang.Object

org.refcodes.remoting.messages.impls.ReplyDescriptorImpl

All Implemented Interfaces:

Serializable, org.refcodes.exception.mixins.ExceptionAccessor<Throwable>, org.refcodes.exception.mixins.ExceptionAccessor.ExceptionMutator<Throwable>, org.refcodes.exception.mixins.ExceptionAccessor.ExceptionProperty<Throwable>, Instance, InstanceIdAccessor, Reply, Session, SessionIdAccessor

Direct Known Subclasses:

CancelMethodReplyMessageImpl, MethodReplyMessageImpl, PublishSubjectReplyMessageImpl

public class ReplyDescriptorImpl
extends Object
implements Reply, Serializable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.remoting.mixins.InstanceIdAccessor

InstanceIdAccessor.InstanceIdMutator, InstanceIdAccessor.InstanceIdProperty

Nested classes/interfaces inherited from interface org.refcodes.remoting.mixins.SessionIdAccessor

SessionIdAccessor.SessionIdMutator, SessionIdAccessor.SessionIdProperty

Nested classes/interfaces inherited from interface org.refcodes.exception.mixins.ExceptionAccessor

org.refcodes.exception.mixins.ExceptionAccessor.ExceptionMutator<E>, org.refcodes.exception.mixins.ExceptionAccessor.ExceptionProperty<E extends Throwable>

Constructor Summary

Constructors

Modifier	Constructor and Description
	ReplyDescriptorImpl() Creates a Reply instance.
	ReplyDescriptorImpl(Object aReturnValue, Throwable aException, MethodRequest aMethodRequestDescriptor) Creates a Reply instance.
	ReplyDescriptorImpl(Object aReturnValue, Throwable aException, String aInstanceId, String aSessionId) Creates a Reply instance.
protected	ReplyDescriptorImpl(String sessionId) Creates a Reply instance.
	ReplyDescriptorImpl(String instanceId, String sessionId) Creates a Reply instance.

Method Summary

Modifier and Type	Method and Description
protected void	clear() Same as Clearable.clear().
Throwable	getException()
String	getInstanceId() Retrieves the instance ID from the instance ID property.
Object	getReturnValue() Returns the return value of a method call.
String	getSessionId() Retrieves the sessionId from the session ID property.
boolean	hasReply() Returns true if this reply is not empty and waiting to be feeded with a reply.
boolean	isException() Returns true if the reply carries an exception which occurred when executing the method call.
boolean	isReturnValue() Returns true if the reply carries a valid return value.
void	setException(Throwable aException)
protected void	setHasReply(boolean hasReply)
protected void	setInstanceId(String instanceId)
protected void	setMethodReplyDescriptor(Reply methodReplyDescriptor)
void	setReply(Reply methodReply) Sets a reply.
void	setReturnValue(Object returnValue)
protected void	setSessionId(String sessionId)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplyDescriptorImpl

public ReplyDescriptorImpl()

Creates a Reply instance.

ReplyDescriptorImpl

public ReplyDescriptorImpl(Object aReturnValue,
                           Throwable aException,
                           MethodRequest aMethodRequestDescriptor)

Creates a Reply instance.

Parameters:

aReturnValue - The return value; if any regular return then no exception must be set.

aException - The exception in case an exception occurred (then there must not be a return value).

aMethodRequestDescriptor - The MethodRequest describing the according method request.

ReplyDescriptorImpl

public ReplyDescriptorImpl(Object aReturnValue,
                           Throwable aException,
                           String aInstanceId,
                           String aSessionId)

Creates a Reply instance.

Parameters:

aReturnValue - The return value; if any regular return then no exception must be set.

aException - The exception in case an exception occurred (then there must not be a return value).

aInstanceId - The instance ID in question.

aSessionId - The session ID in question.

ReplyDescriptorImpl

public ReplyDescriptorImpl(String instanceId,
                           String sessionId)

Creates a Reply instance.

Parameters:

instanceId - Description is currently not available!

sessionId - Description is currently not available!

Throws:

IllegalArgumentPredictableException - Documentation currently not available

ReplyDescriptorImpl

protected ReplyDescriptorImpl(String sessionId)

Creates a Reply instance.

Parameters:

sessionId - Description is currently not available!

Method Detail

getInstanceId

public String getInstanceId()

Retrieves the instance ID from the instance ID property.

Specified by:

getInstanceId in interface InstanceIdAccessor

Returns:

The instance ID stored by the instance ID property.

getReturnValue

public Object getReturnValue()

Returns the return value of a method call. To test first if the reply does not contain a Throwable object (exception occured!) use the method isThrowable().

Specified by:

getReturnValue in interface Reply

Returns:

The return value of the method call (if any),

getSessionId

public String getSessionId()

Retrieves the sessionId from the session ID property.

Specified by:

getSessionId in interface SessionIdAccessor

Returns:

The sessionId stored by the session ID property.

getException

public Throwable getException()

Specified by:

getException in interface org.refcodes.exception.mixins.ExceptionAccessor<Throwable>

hasReply

public boolean hasReply()

Returns true if this reply is not empty and waiting to be feeded with a reply. Important for an object waiting for a reply - when method setMethodReply() has been called, then thi method returns true, or if an instance has been created already containing a repy (not being empty).

Specified by:

hasReply in interface Reply

Returns:

True if an instance of this interface (which did not contain a valid reply) has been feeded with a reply.

isReturnValue

public boolean isReturnValue()

Returns true if the reply carries a valid return value.

Specified by:

isReturnValue in interface Reply

Returns:

True if this object contains valid return value.

isException

public boolean isException()

Returns true if the reply carries an exception which occurred when executing the method call.

Specified by:

isException in interface Reply

Returns:

True if this object contains an exception (Throwable object) instead of a return value.

setReply

public void setReply(Reply methodReply)

Sets a reply. The results (getThrowable(), getReturnValue()) from the provided reply are taken and set inside this instance. If this instance did not contain a reply before, then the method hasReply will return true from after this method call.

Specified by:

setReply in interface Reply

Parameters:

methodReply - An object of type BlueprintMethodReply from which the replied values (throwable or return value) will be taken.

setReturnValue

public void setReturnValue(Object returnValue)

Specified by:

setReturnValue in interface Reply

Parameters:

returnValue - Description is currently not available!

setException

public void setException(Throwable aException)

Specified by:

setException in interface org.refcodes.exception.mixins.ExceptionAccessor.ExceptionMutator<Throwable>

Specified by:

setException in interface Reply

setHasReply

protected void setHasReply(boolean hasReply)

Parameters:

hasReply - Description is currently not available!

setInstanceId

protected void setInstanceId(String instanceId)

Parameters:

instanceId - Description is currently not available!

setMethodReplyDescriptor

protected void setMethodReplyDescriptor(Reply methodReplyDescriptor)

Parameters:

methodReplyDescriptor - Description is currently not available!

setSessionId

protected void setSessionId(String sessionId)

Parameters:

sessionId - Description is currently not available!

clear

protected void clear()

Same as Clearable.clear().