public class ReturnObject
extends java.lang.Object
A ReturnObject wraps a value returned by a method. If the value is a primitive, a primitive wrapper object (e.g., Integer) or a String, the value is kept in the primitiveObject field.
If the return value is an object, a key to the reference is kept in the name
field. This value can be retrieved by calling
Gateway.getObject(String)
with the key.
Various methods are defined to determine the type of the return value. For
example, if the return value is void, the name and primitiveObject fields are
null, but isVoid()
returns true.
ReturnObject objects can only be constructed through static factory methods
such as getListReturnObject(String, int)
.
Modifier and Type | Method and Description |
---|---|
static ReturnObject |
getArrayReturnObject(java.lang.String name,
int size) |
java.lang.String |
getCommandPart() |
static ReturnObject |
getDecimalReturnObject(java.lang.Object object) |
static ReturnObject |
getErrorReferenceReturnObject(java.lang.String name) |
static ReturnObject |
getErrorReturnObject() |
static ReturnObject |
getErrorReturnObject(java.lang.Throwable throwable) |
static ReturnObject |
getIteratorReturnObject(java.lang.String name) |
static ReturnObject |
getListReturnObject(java.lang.String name,
int size) |
static ReturnObject |
getMapReturnObject(java.lang.String name,
int size) |
java.lang.String |
getName() |
static ReturnObject |
getNullReturnObject() |
java.lang.Object |
getPrimitiveObject() |
static ReturnObject |
getPrimitiveReturnObject(java.lang.Object primitive) |
static ReturnObject |
getReferenceReturnObject(java.lang.String name) |
static ReturnObject |
getSetReturnObject(java.lang.String name,
int size) |
int |
getSize() |
static ReturnObject |
getVoidReturnObject() |
boolean |
isArray() |
boolean |
isDecimal() |
boolean |
isError() |
boolean |
isIterator() |
boolean |
isList() |
boolean |
isMap() |
boolean |
isNull() |
boolean |
isReference() |
boolean |
isSet() |
boolean |
isVoid() |
void |
setArray(boolean isArray) |
void |
setCommandPart(java.lang.String commandPart) |
void |
setError(boolean isError) |
void |
setIterator(boolean isIterator) |
void |
setList(boolean isList) |
void |
setMap(boolean isMap) |
void |
setName(java.lang.String name) |
void |
setNull(boolean isNull) |
void |
setPrimitiveObject(java.lang.Object primitiveObject) |
void |
setReference(boolean isReference) |
void |
setSet(boolean isSet) |
void |
setSize(int size) |
void |
setVoid(boolean isVoid) |
public static ReturnObject getArrayReturnObject(java.lang.String name, int size)
public static ReturnObject getDecimalReturnObject(java.lang.Object object)
public static ReturnObject getErrorReferenceReturnObject(java.lang.String name)
public static ReturnObject getErrorReturnObject()
public static ReturnObject getErrorReturnObject(java.lang.Throwable throwable)
public static ReturnObject getIteratorReturnObject(java.lang.String name)
public static ReturnObject getListReturnObject(java.lang.String name, int size)
public static ReturnObject getMapReturnObject(java.lang.String name, int size)
public static ReturnObject getNullReturnObject()
public static ReturnObject getPrimitiveReturnObject(java.lang.Object primitive)
public static ReturnObject getReferenceReturnObject(java.lang.String name)
public static ReturnObject getSetReturnObject(java.lang.String name, int size)
public static ReturnObject getVoidReturnObject()
public java.lang.String getCommandPart()
public java.lang.String getName()
public java.lang.Object getPrimitiveObject()
public int getSize()
public boolean isArray()
public boolean isDecimal()
public boolean isError()
public boolean isIterator()
public boolean isList()
public boolean isMap()
public boolean isNull()
public boolean isReference()
public boolean isSet()
public boolean isVoid()
public void setArray(boolean isArray)
public void setCommandPart(java.lang.String commandPart)
public void setError(boolean isError)
public void setIterator(boolean isIterator)
public void setList(boolean isList)
public void setMap(boolean isMap)
public void setName(java.lang.String name)
public void setNull(boolean isNull)
public void setPrimitiveObject(java.lang.Object primitiveObject)
public void setReference(boolean isReference)
public void setSet(boolean isSet)
public void setSize(int size)
public void setVoid(boolean isVoid)