Package py4j
Class ReturnObject
java.lang.Object
py4j.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)
.
- Author:
- barthelemy
-
Method Summary
Modifier and TypeMethodDescriptionstatic ReturnObject
getArrayReturnObject
(String name, int size) static ReturnObject
getDecimalReturnObject
(Object object) static ReturnObject
static ReturnObject
static ReturnObject
getErrorReturnObject
(Throwable throwable) static ReturnObject
static ReturnObject
getListReturnObject
(String name, int size) static ReturnObject
getMapReturnObject
(String name, int size) getName()
static ReturnObject
static ReturnObject
getPrimitiveReturnObject
(Object primitive) static ReturnObject
static ReturnObject
getSetReturnObject
(String name, int size) int
getSize()
static ReturnObject
boolean
isArray()
boolean
boolean
isError()
boolean
boolean
isList()
boolean
isMap()
boolean
isNull()
boolean
boolean
isSet()
boolean
isVoid()
void
setArray
(boolean isArray) void
setCommandPart
(String commandPart) void
setError
(boolean isError) void
setIterator
(boolean isIterator) void
setList
(boolean isList) void
setMap
(boolean isMap) void
void
setNull
(boolean isNull) void
setPrimitiveObject
(Object primitiveObject) void
setReference
(boolean isReference) void
setSet
(boolean isSet) void
setSize
(int size) void
setVoid
(boolean isVoid)
-
Method Details
-
getArrayReturnObject
-
getDecimalReturnObject
-
getErrorReferenceReturnObject
-
getErrorReturnObject
-
getErrorReturnObject
-
getIteratorReturnObject
-
getListReturnObject
-
getMapReturnObject
-
getNullReturnObject
-
getPrimitiveReturnObject
-
getReferenceReturnObject
-
getSetReturnObject
-
getVoidReturnObject
-
getCommandPart
-
getName
-
getPrimitiveObject
-
getSize
public int getSize() -
isArray
public boolean isArray() -
isDecimal
public boolean isDecimal() -
isError
public boolean isError() -
isIterator
public boolean isIterator() -
isList
public boolean isList() -
isMap
public boolean isMap() -
isNull
public boolean isNull() -
isReference
public boolean isReference() -
isSet
public boolean isSet() -
isVoid
public boolean isVoid() -
setArray
public void setArray(boolean isArray) -
setCommandPart
-
setError
public void setError(boolean isError) -
setIterator
public void setIterator(boolean isIterator) -
setList
public void setList(boolean isList) -
setMap
public void setMap(boolean isMap) -
setName
-
setNull
public void setNull(boolean isNull) -
setPrimitiveObject
-
setReference
public void setReference(boolean isReference) -
setSet
public void setSet(boolean isSet) -
setSize
public void setSize(int size) -
setVoid
public void setVoid(boolean isVoid)
-