Boeing Simulation 3.1 API Specification

util
Class ReturnValue

java.lang.Object
  |
  +--util.ReturnValue
All Implemented Interfaces:
Serializable

public final class ReturnValue
extends Object
implements Serializable

This class is intended to encapsulate the return values for remote method calls.

Version:
$Revision: 1.14 $
Author:
Dave Jurgens
See Also:
Serialized Form

Nested Class Summary
private static class ReturnValue.NULL
          a null wrapper class
 
Field Summary
private  String methodName
          The name of the method that generated this return value
static int NOT_REQUESTED
          a final int signifying that this return value was not generated from a MethodRequest.
private  int requestID
          the associated ID from MethodRequest.
private  Object returnVal
           
private static long serialVersionUID
           
 
Constructor Summary
ReturnValue(String methodName, Object returnVal)
           
ReturnValue(String methodName, Object returnVal, int requestID)
           
 
Method Summary
 Object getReturnValue()
          Returns the object that was specified as the return value.
 int getReturnValueID()
          Return the ID from the associated MethodRequest.
 boolean isRequested()
          If this ReturnValue was generated on behalf of a MethodRequest.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

NOT_REQUESTED

public static final int NOT_REQUESTED
a final int signifying that this return value was not generated from a MethodRequest.

See Also:
Constant Field Values

methodName

private final String methodName
The name of the method that generated this return value


returnVal

private final Object returnVal

requestID

private final int requestID
the associated ID from MethodRequest.

Constructor Detail

ReturnValue

public ReturnValue(String methodName,
                   Object returnVal)

ReturnValue

public ReturnValue(String methodName,
                   Object returnVal,
                   int requestID)
Method Detail

getReturnValue

public Object getReturnValue()
Returns the object that was specified as the return value.


getReturnValueID

public int getReturnValueID()
Return the ID from the associated MethodRequest.


isRequested

public boolean isRequested()
If this ReturnValue was generated on behalf of a MethodRequest.


toString

public String toString()
Overrides:
toString in class Object

Boeing Simulation 3.1 API Specification

To submit a bug or feature email the author of that class. Funding for this research was provided by Boeing and DARPA.