org.camunda.bpm.engine.variable.value

Interface ObjectValue

All Superinterfaces:

Serializable, SerializableValue, TypedValue

All Known Implementing Classes:

ObjectValueImpl

public interface ObjectValue
extends SerializableValue

A typed value representing a Java Object.

Since:

7.2

Author:

Daniel Meyer

Method Summary

Methods

Modifier and Type	Method and Description
Class<?>	getObjectType() Returns the Class this object is an instance of.
String	getObjectTypeName() A String representation of the Object's type name.
Object	getValue() Returns the Object or null in case the value is null.
<T> T	getValue(Class<T> type) Returns the object provided by this VariableValue.
boolean	isDeserialized() Returns true in case the object is deserialized.

Methods inherited from interface org.camunda.bpm.engine.variable.value.SerializableValue

getSerializationDataFormat, getType, getValueSerialized

Method Detail

isDeserialized

boolean isDeserialized()

Returns true in case the object is deserialized. If this method returns true, it is safe to call the methods

• getValue() and getValue(Class)
• getObjectType()

Specified by:

isDeserialized in interface SerializableValue

Returns:

true if the object is deserialized.

getValue

Object getValue()

Returns the Object or null in case the value is null.

Specified by:

getValue in interface SerializableValue

Specified by:

getValue in interface TypedValue

Returns:

the object represented by this TypedValue.

Throws:

IllegalStateException - in case the object is not deserialized. See isDeserialized().

getValue

<T> T getValue(Class<T> type)

Returns the object provided by this VariableValue. Allows type-safe access to objects by passing in the class.

Parameters:

type - the java class the value should be cast to

Returns:

the object represented by this TypedValue.

Throws:

IllegalStateException - in case the object is not deserialized. See isDeserialized().

getObjectType

Class<?> getObjectType()

Returns the Class this object is an instance of.

Returns:

the Class this object is an instance of

Throws:

IllegalStateException - in case the object is not deserialized. See isDeserialized().

getObjectTypeName

String getObjectTypeName()

A String representation of the Object's type name. Usually the canonical class name of the Java Class this object is an instance of.

Returns:

the Object's type name.