|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectpy4j.ReturnObject
public class ReturnObject
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)
.
Method Summary | |
---|---|
static ReturnObject |
getErrorReturnObject()
|
static ReturnObject |
getListReturnObject(String name,
int size)
|
static ReturnObject |
getMapReturnObject(String name,
int size)
|
String |
getName()
|
static ReturnObject |
getNullReturnObject()
|
Object |
getPrimitiveObject()
|
static ReturnObject |
getPrimitiveReturnObject(Object primitive)
|
static ReturnObject |
getReferenceReturnObject(String name)
|
int |
getSize()
|
static ReturnObject |
getVoidReturnObject()
|
boolean |
isError()
|
boolean |
isList()
|
boolean |
isMap()
|
boolean |
isNull()
|
boolean |
isReference()
|
boolean |
isVoid()
|
void |
setError(boolean isError)
|
void |
setList(boolean isList)
|
void |
setMap(boolean isMap)
|
void |
setName(String name)
|
void |
setNull(boolean isNull)
|
void |
setPrimitiveObject(Object primitiveObject)
|
void |
setReference(boolean isReference)
|
void |
setSize(int size)
|
void |
setVoid(boolean isVoid)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static ReturnObject getMapReturnObject(String name, int size)
public static ReturnObject getListReturnObject(String name, int size)
public static ReturnObject getPrimitiveReturnObject(Object primitive)
public static ReturnObject getReferenceReturnObject(String name)
public static ReturnObject getNullReturnObject()
public static ReturnObject getVoidReturnObject()
public static ReturnObject getErrorReturnObject()
public String getName()
public void setName(String name)
public boolean isMap()
public void setMap(boolean isMap)
public boolean isList()
public void setList(boolean isList)
public int getSize()
public void setSize(int size)
public boolean isNull()
public void setNull(boolean isNull)
public boolean isError()
public void setError(boolean isError)
public Object getPrimitiveObject()
public void setPrimitiveObject(Object primitiveObject)
public boolean isReference()
public void setReference(boolean isReference)
public boolean isVoid()
public void setVoid(boolean isVoid)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |