TPTP 4.4.0 Platform Project
Public API Specification

org.eclipse.hyades.execution.invocation
Class ReturnData

java.lang.Object
  extended byorg.eclipse.hyades.execution.invocation.MarshalData
      extended byorg.eclipse.hyades.execution.invocation.ReturnData

public class ReturnData
extends MarshalData

ReturnData instances store data that is needed to marshal or unmarshal values that are to be returned as a result of a method invocation.


Field Summary
 
Fields inherited from class org.eclipse.hyades.execution.invocation.MarshalData
argTypes, call, targetId
 
Constructor Summary
ReturnData(java.lang.Integer targetId, java.lang.Class[] argTypes, java.lang.String call, java.lang.Object returnValue)
           
 
Method Summary
 java.lang.Object getReturnValue()
          Get the return value resulting from a method invocation.
 boolean isError()
          Indicates whether or not this instance wraps an exception that has been thrown.
 
Methods inherited from class org.eclipse.hyades.execution.invocation.MarshalData
getArgTypes, getCall, getTargetId, isForSameCallAs
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReturnData

public ReturnData(java.lang.Integer targetId,
                  java.lang.Class[] argTypes,
                  java.lang.String call,
                  java.lang.Object returnValue)
Parameters:
targetId - the unique id associated with the target object
argTypes - the list of types matching those declared as parameters in the signature of call
call - the method that is to be invoked
returnValue - the value returned from call. If this value is assignment compatible with Throwable, the ReturnData instance to be created represents an exception that has been thrown as a result of call having been invoked. If call returns a primitive type, returnValue should be a wrapper object of the appropriate type. If call does not return a value, returnValue can be null.
Method Detail

getReturnValue

public java.lang.Object getReturnValue()
Get the return value resulting from a method invocation.

Returns:
an Object if the method that was invoked is one that returns a value or if the invocation resulted in an exception being thrown, or null if the method does not return a value

isError

public boolean isError()
Indicates whether or not this instance wraps an exception that has been thrown.

Returns:
false if an exception was not thrown, true if the value wrapped by this instance is assignment compatible with Throwable

TPTP 4.4.0 Platform Project
Public API Specification