TPTP 4.1.0 Platform Project
Public API Specification

org.eclipse.hyades.execution.invocation
Class MarshalData

java.lang.Object
  extended byorg.eclipse.hyades.execution.invocation.MarshalData
Direct Known Subclasses:
CallData, ReturnData

public abstract class MarshalData
extends java.lang.Object

This is the supertype of classes that are essentially data holders that are used during the marshalling and unmarshalling of data that is to be sent between processes in support of remote method invocation semantics. The state of MarshalData instances is intended to be immutable. It should only be set during instantiation, by the constructors provided. The intention is to prevent invalid data combinations.


Field Summary
protected  java.lang.Class[] argTypes
          the argument types of the method that is to be or has already been invoked
protected  java.lang.String call
          the name of the method that is to be or has already been invoked
protected  java.lang.Integer targetId
          the unique id associated with the object on which some action is to be performed
 
Constructor Summary
protected MarshalData(java.lang.Integer targetId, java.lang.Class[] argTypes, java.lang.String call)
           
 
Method Summary
 java.lang.Class[] getArgTypes()
          Get the argument type list of the method that is to be or already has been invoked.
 java.lang.String getCall()
          Get the name of the method that is to be or already has been invoked.
 java.lang.Integer getTargetId()
          Get the unique id associated with the target instance -- the object on which some action is to be performed.
 boolean isForSameCallAs(MarshalData comp)
          Determine if this instance was created for the same method call as the specified instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

targetId

protected java.lang.Integer targetId
the unique id associated with the object on which some action is to be performed


argTypes

protected java.lang.Class[] argTypes
the argument types of the method that is to be or has already been invoked


call

protected java.lang.String call
the name of the method that is to be or has already been invoked

Constructor Detail

MarshalData

protected MarshalData(java.lang.Integer targetId,
                      java.lang.Class[] argTypes,
                      java.lang.String call)
Parameters:
targetId -
argTypes -
call -
Method Detail

getTargetId

public java.lang.Integer getTargetId()
Get the unique id associated with the target instance -- the object on which some action is to be performed.

Returns:
an Integer

getArgTypes

public java.lang.Class[] getArgTypes()
Get the argument type list of the method that is to be or already has been invoked.

Returns:
an array of Class objects

getCall

public java.lang.String getCall()
Get the name of the method that is to be or already has been invoked.

Returns:
a method name

isForSameCallAs

public boolean isForSameCallAs(MarshalData comp)
Determine if this instance was created for the same method call as the specified instance.

Parameters:
comp - a MarshalData instance
Returns:
true if this instance was created for the same method call as that for which comp was created, false otherwise

TPTP 4.1.0 Platform Project
Public API Specification