Package org.camunda.bpm.engine.variable.value

Interface SerializableValue

All Superinterfaces:

java.io.Serializable, TypedValue

All Known Subinterfaces:

JsonValue, ObjectValue, SpinValue, XmlValue

All Known Implementing Classes:

JsonValueImpl, ObjectValueImpl, SpinValueImpl, XmlValueImpl

public interface SerializableValue
extends TypedValue

A TypedValue for which a serialized value can be obtained and specified

Author:

Daniel Meyer

Method Summary

Modifier and Type	Method	Description
java.lang.String	getSerializationDataFormat()	The serialization format used to serialize this value.
SerializableValueType	getType()	The type of the value.
java.lang.Object	getValue()	Returns the value or null in case the value is null.
java.lang.String	getValueSerialized()	Returns the serialized value.
boolean	isDeserialized()	Returns true in case the value is deserialized.

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

isTransient

Method Detail

isDeserialized

boolean isDeserialized()

Returns true in case the value is deserialized. If this method returns true, it is safe to call the getValue() method

Returns:

true if the object is deserialized.

getValue

java.lang.Object getValue()

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

Specified by:

getValue in interface TypedValue

Returns:

the value represented by this TypedValue.

Throws:

java.lang.IllegalStateException - in case the value is not deserialized. See isDeserialized().

getValueSerialized

java.lang.String getValueSerialized()

Returns the serialized value. In case the serializaton data format (as returned by getSerializationDataFormat()) is not text based, a base 64 encoded representation of the value is returned The serialized value is a snapshot of the state of the value as it is serialized to the process engine database.

getSerializationDataFormat

java.lang.String getSerializationDataFormat()

The serialization format used to serialize this value.

Returns:

the serialization format used to serialize this variable.

getType

SerializableValueType getType()

Description copied from interface: TypedValue

The type of the value. See ValueType for a list of built-in ValueTypes.

Specified by:

getType in interface TypedValue

Returns:

the type of the value.