Interface SerializableValue
-
- All Superinterfaces:
Serializable
,TypedValue
- All Known Subinterfaces:
JsonValue
,ObjectValue
,SpinValue
,XmlValue
- All Known Implementing Classes:
JsonValueImpl
,ObjectValueImpl
,SpinValueImpl
,XmlValueImpl
public interface SerializableValue extends TypedValue
ATypedValue
for which a serialized value can be obtained and specified- Author:
- Daniel Meyer
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getSerializationDataFormat()
The serialization format used to serialize this value.SerializableValueType
getType()
The type of the value.Object
getValue()
Returns the value or null in case the value is null.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 thegetValue()
method- Returns:
- true if the object is deserialized.
-
getValue
Object getValue()
Returns the value or null in case the value is null.- Specified by:
getValue
in interfaceTypedValue
- Returns:
- the value represented by this TypedValue.
- Throws:
IllegalStateException
- in case the value is not deserialized. SeeisDeserialized()
.
-
getValueSerialized
String getValueSerialized()
Returns the serialized value. In case the serializaton data format (as returned bygetSerializationDataFormat()
) 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
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 interfaceTypedValue
- Returns:
- the type of the value.
-
-