Package org.camunda.spin.plugin.impl

Class SpinValueSerializer

java.lang.Object

org.camunda.bpm.engine.impl.variable.serializer.AbstractTypedValueSerializer<T>

org.camunda.bpm.engine.impl.variable.serializer.AbstractSerializableValueSerializer<SpinValue>

org.camunda.spin.plugin.impl.SpinValueSerializer

All Implemented Interfaces:

TypedValueSerializer<SpinValue>

Direct Known Subclasses:

JsonValueSerializer, XmlValueSerializer

public abstract class SpinValueSerializer
extends AbstractSerializableValueSerializer<SpinValue>

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field	Description
protected org.camunda.spin.spi.DataFormat<?>	dataFormat
protected java.lang.String	name

Fields inherited from class org.camunda.bpm.engine.impl.variable.serializer.AbstractSerializableValueSerializer

serializationDataFormat

Fields inherited from class org.camunda.bpm.engine.impl.variable.serializer.AbstractTypedValueSerializer

BINARY_VALUE_TYPES, valueType

Constructor Summary

Constructors

Constructor	Description
SpinValueSerializer(SerializableValueType type, org.camunda.spin.spi.DataFormat<?> dataFormat, java.lang.String name)

Method Summary

Modifier and Type	Method	Description
protected boolean	canSerializeValue(java.lang.Object value)	return true if this serializer is able to serialize the provided object.
protected java.lang.Object	deserializeFromByteArray(byte[] object, ValueFields valueFields)	Deserialize the object from a byte array.
java.lang.String	getName()	The name of this serializer.
protected boolean	isSerializationTextBased()	Return true if the serialization is text based.
protected byte[]	serializeToByteArray(java.lang.Object deserializedObject)	Implementations must return a byte[] representation of the provided object.
protected void	updateTypedValue(SpinValue value, java.lang.String serializedStringValue)
protected void	writeToValueFields(SpinValue value, ValueFields valueFields, byte[] serializedValue)

Methods inherited from class org.camunda.bpm.engine.impl.variable.serializer.AbstractSerializableValueSerializer

canWriteValue, createDeserializedValue, createSerializedValue, getSerializationDataformat, getSerializedBytesValue, getSerializedStringValue, readSerializedValueFromFields, readValue, writeValue

Methods inherited from class org.camunda.bpm.engine.impl.variable.serializer.AbstractTypedValueSerializer

canHandle, getType, isMutableValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.camunda.bpm.engine.impl.variable.serializer.TypedValueSerializer

convertToTypedValue

Field Detail

dataFormat

protected org.camunda.spin.spi.DataFormat<?> dataFormat

name

protected java.lang.String name

Constructor Detail

SpinValueSerializer

public SpinValueSerializer(SerializableValueType type,
                           org.camunda.spin.spi.DataFormat<?> dataFormat,
                           java.lang.String name)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: TypedValueSerializer

The name of this serializer. The name is used when persisting the ValueFields populated by this serializer.

Returns:

the name of this serializer.

writeToValueFields

protected void writeToValueFields(SpinValue value,
                                  ValueFields valueFields,
                                  byte[] serializedValue)

Specified by:

writeToValueFields in class AbstractSerializableValueSerializer<SpinValue>

updateTypedValue

protected void updateTypedValue(SpinValue value,
                                java.lang.String serializedStringValue)

Specified by:

updateTypedValue in class AbstractSerializableValueSerializer<SpinValue>

canSerializeValue

protected boolean canSerializeValue(java.lang.Object value)

Description copied from class: AbstractSerializableValueSerializer

return true if this serializer is able to serialize the provided object.

Specified by:

canSerializeValue in class AbstractSerializableValueSerializer<SpinValue>

Parameters:

value - the object to test (guaranteed to be a non-null value)

Returns:

true if the serializer can handle the object.

serializeToByteArray

protected byte[] serializeToByteArray(java.lang.Object deserializedObject)
                               throws java.lang.Exception

Description copied from class: AbstractSerializableValueSerializer

Implementations must return a byte[] representation of the provided object. The object is guaranteed not to be null.

Specified by:

serializeToByteArray in class AbstractSerializableValueSerializer<SpinValue>

Parameters:

deserializedObject - the object to serialize

Returns:

the byte array value of the object

Throws:

java.lang.Exception

deserializeFromByteArray

protected java.lang.Object deserializeFromByteArray(byte[] object,
                                                    ValueFields valueFields)
                                             throws java.lang.Exception

Description copied from class: AbstractSerializableValueSerializer

Deserialize the object from a byte array.

Specified by:

deserializeFromByteArray in class AbstractSerializableValueSerializer<SpinValue>

Parameters:

object - the object to deserialize

valueFields - the value fields

Returns:

the deserialized object

Throws:

java.lang.Exception

isSerializationTextBased

protected boolean isSerializationTextBased()

Description copied from class: AbstractSerializableValueSerializer

Return true if the serialization is text based. Return false otherwise

Specified by:

isSerializationTextBased in class AbstractSerializableValueSerializer<SpinValue>