py4j
Class ReturnObject

java.lang.Object
  extended by py4j.ReturnObject

public class ReturnObject
extends 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).

Author:
barthelemy

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

getMapReturnObject

public static ReturnObject getMapReturnObject(String name,
                                              int size)

getListReturnObject

public static ReturnObject getListReturnObject(String name,
                                               int size)

getPrimitiveReturnObject

public static ReturnObject getPrimitiveReturnObject(Object primitive)

getReferenceReturnObject

public static ReturnObject getReferenceReturnObject(String name)

getNullReturnObject

public static ReturnObject getNullReturnObject()

getVoidReturnObject

public static ReturnObject getVoidReturnObject()

getErrorReturnObject

public static ReturnObject getErrorReturnObject()

getName

public String getName()

setName

public void setName(String name)

isMap

public boolean isMap()

setMap

public void setMap(boolean isMap)

isList

public boolean isList()

setList

public void setList(boolean isList)

getSize

public int getSize()

setSize

public void setSize(int size)

isNull

public boolean isNull()

setNull

public void setNull(boolean isNull)

isError

public boolean isError()

setError

public void setError(boolean isError)

getPrimitiveObject

public Object getPrimitiveObject()

setPrimitiveObject

public void setPrimitiveObject(Object primitiveObject)

isReference

public boolean isReference()

setReference

public void setReference(boolean isReference)

isVoid

public boolean isVoid()

setVoid

public void setVoid(boolean isVoid)