ValueSerializer (fiber 0.22.1-2 API)

Type Parameters:

A - The type of the serialized element representation, e.g. JsonElement.

T - The type of the serialized aggregate representation, e.g. JsonObject. For recursive serialized forms, like JSON, this may be the same as or a subtype of A, but for non-recursive serialized forms this is may be an unrelated type.

All Known Implementing Classes:

JanksonValueSerializer
```
public interface ValueSerializer<A,T>
```
Adapter between a tree serialization library and Fiber. To use a library like GSON, Jankson, etc. with Fiber, simply implement this interface.
The values passed to the serialize* methods fulfill the constraints of their corresponding types. However, in general, the serialized form passed to the deserialize* methods may not fulfill the constraints, nor even be a correct representation of the platform type. If a serializer cannot deserialize a value of the correct platform type as determined by SerializableType.cast(Object), then it shall throw a ValueDeserializationException containing the element that could not be converted and the erased class type it was trying to convert to. However, a serializer is not expected to produce values that satisfy the ancillary constraints of the passed type. Client code is responsible for coercing deserialized values into a form consistent with its type's constraints.
The methods of this interface which operate on serialized elements or targets may consume or otherwise mutate the serialized representations passed to them.

See Also:

SerializableType.serializeValue(Object, ValueSerializer), SerializableType.deserializeValue(Object, ValueSerializer)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addElement(String name, A elem, T target, String comment)` Aggregates a serialized value, associated with the given key, into the target.
`void`	`addSubElement(String name, T elem, T target, String comment)` Aggregates an existing target, associated with the given key, into the target as a sub-target.
`boolean`	`deserializeBoolean(A elem, BooleanSerializableType type)` Converts the serialized form to a boolean.
`String`	`deserializeEnum(A elem, EnumSerializableType type)` Converts the serialized form to a enumerated value.
`<E> List<E>`	`deserializeList(A elem, ListSerializableType<E> type)` Converts the serialized form to a list of values.
`<V> Map<String,V>`	`deserializeMap(A elem, MapSerializableType<V> type)` Converts the serialized form to a map.
`BigDecimal`	`deserializeNumber(A elem, DecimalSerializableType type)` Converts the serialized form to a number.
`Map<String,Object>`	`deserializeRecord(A elem, RecordSerializableType type)` Converts the serialized form to a record.
`String`	`deserializeString(A elem, StringSerializableType type)` Converts the serialized form to a string.
`Iterator<Map.Entry<String,A>>`	`elements(T target)` Extracts an `Iterator` over all aggregated key-value pairs in the given target.
`T`	`newTarget()` Creates a new, empty aggregate target.
`T`	`readTarget(InputStream in)` Reads an aggregate target from the given input stream.
`A`	`serializeBoolean(boolean value, BooleanSerializableType type)` Converts a boolean into the serialized form.
`A`	`serializeEnum(String value, EnumSerializableType type)` Converts a enumerated string into the serialized form.
`<E> A`	`serializeList(List<E> value, ListSerializableType<E> type)` Converts a list into the serialized form.
`<V> A`	`serializeMap(Map<String,V> value, MapSerializableType<V> type)` Converts a map into the serialized form.
`A`	`serializeNumber(BigDecimal value, DecimalSerializableType type)` Converts a number into the serialized form.
`A`	`serializeRecord(Map<String,Object> value, RecordSerializableType type)` Converts a record into the serialized form.
`A`	`serializeString(String value, StringSerializableType type)` Converts a string into the serialized form.
`Iterator<Map.Entry<String,A>>`	`subElements(A elem)` Extracts an `Iterator` over all aggregated key-value pairs in the given sub-target element.
`void`	`writeTarget(T target, OutputStream out)` Writes a aggregate target to the given output stream.

- Method Detail
  - serializeBoolean
```
A serializeBoolean(boolean value,
                   BooleanSerializableType type)
```
    Converts a boolean into the serialized form.
    
    Parameters:
    
    value - The boolean value.
    
    type - The type of the boolean value.
  - deserializeBoolean
```
boolean deserializeBoolean(A elem,
                           BooleanSerializableType type)
                    throws ValueDeserializationException
```
    Converts the serialized form to a boolean.
    
    Parameters:
    
    elem - The serialized form.
    
    type - The type of the boolean value.
    
    Throws:
    
    ValueDeserializationException - If the serialized form cannot be converted into an object of the correct platform type.
  - serializeNumber
```
A serializeNumber(BigDecimal value,
                  DecimalSerializableType type)
```
    Converts a number into the serialized form.
    
    Parameters:
    
    value - The numeric value.
    
    type - The type of the numeric value.
  - deserializeNumber
```
BigDecimal deserializeNumber(A elem,
                             DecimalSerializableType type)
                      throws ValueDeserializationException
```
    Converts the serialized form to a number.
    
    Parameters:
    
    elem - The serialized form.
    
    type - The type of the numeric value.
    
    Throws:
    
    ValueDeserializationException - If the serialized form cannot be converted into an object of the correct platform type.
  - serializeString
```
A serializeString(String value,
                  StringSerializableType type)
```
    Converts a string into the serialized form.
    
    Parameters:
    
    value - The string value.
    
    type - The type of the string value.
  - deserializeString
```
String deserializeString(A elem,
                         StringSerializableType type)
                  throws ValueDeserializationException
```
    Converts the serialized form to a string.
    
    Parameters:
    
    elem - The serialized form.
    
    type - The type of the string value.
    
    Throws:
    
    ValueDeserializationException - If the serialized form cannot be converted into an object of the correct platform type.
  - serializeEnum
```
A serializeEnum(String value,
                EnumSerializableType type)
```
    Converts a enumerated string into the serialized form.
    
    Parameters:
    
    value - The enum value.
    
    type - The type of the enum value.
  - deserializeEnum
```
String deserializeEnum(A elem,
                       EnumSerializableType type)
                throws ValueDeserializationException
```
    Converts the serialized form to a enumerated value.
    
    Parameters:
    
    elem - The serialized form.
    
    type - The type of the enumerated value.
    
    Throws:
    
    ValueDeserializationException - If the serialized form cannot be converted into an object of the correct platform type.
  - serializeList
```
<E> A serializeList(List<E> value,
                    ListSerializableType<E> type)
```
    Converts a list into the serialized form.
    
    Parameters:
    
    value - The list value.
    
    type - The type of the list value.
  - deserializeList
```
<E> List<E> deserializeList(A elem,
                            ListSerializableType<E> type)
                     throws ValueDeserializationException
```
    Converts the serialized form to a list of values.
    
    Parameters:
    
    elem - The serialized form.
    
    type - The type of the list value.
    
    Throws:
    
    ValueDeserializationException - If the serialized form cannot be converted into an object of the correct platform type.
  - serializeMap
```
<V> A serializeMap(Map<String,V> value,
                   MapSerializableType<V> type)
```
    Converts a map into the serialized form.
    
    Parameters:
    
    value - The map value.
    
    type - The type of the map value.
  - deserializeMap
```
<V> Map<String,V> deserializeMap(A elem,
                                 MapSerializableType<V> type)
                          throws ValueDeserializationException
```
    Converts the serialized form to a map.
    
    Parameters:
    
    elem - The serialized form.
    
    type - The type of the map value.
    
    Throws:
    
    ValueDeserializationException - If the serialized form cannot be converted into an object of the correct platform type.
  - serializeRecord
```
A serializeRecord(Map<String,Object> value,
                  RecordSerializableType type)
```
    Converts a record into the serialized form.
    
    Parameters:
    
    value - The record value.
    
    type - The type of the record value.
  - deserializeRecord
```
Map<String,Object> deserializeRecord(A elem,
                                     RecordSerializableType type)
                              throws ValueDeserializationException
```
    Converts the serialized form to a record.
    
    Parameters:
    
    elem - The serialized form.
    
    type - The type of the record value.
    
    Throws:
    
    ValueDeserializationException - If the serialized form cannot be converted into an object of the correct platform type.
  - addElement
```
void addElement(String name,
                A elem,
                T target,
                @Nullable
                String comment)
```
    Aggregates a serialized value, associated with the given key, into the target. It is unspecified whether duplicate keys are allowed.
    
    Parameters:
    
    name - The key with which to associate the value.
    
    elem - The serialized value.
    
    target - The target aggregate.
    
    comment - an optional comment associated with the element.
  - addSubElement
```
void addSubElement(String name,
                   T elem,
                   T target,
                   @Nullable
                   String comment)
```
    Aggregates an existing target, associated with the given key, into the target as a sub-target. It is unspecified whether duplicate keys are allowed.
    
    Parameters:
    
    name - The key with which to associate the sub-target.
    
    elem - The sub-target.
    
    target - The target aggregate.
    
    comment - an optional comment associated with the element
  - elements
```
Iterator<Map.Entry<String,A>> elements(T target)
```
    Extracts an Iterator over all aggregated key-value pairs in the given target.
    
    Parameters:
    
    target - The target.
    
    Returns:
    
    An Iterator over the elements in the target.
  - subElements
```
Iterator<Map.Entry<String,A>> subElements(A elem)
                                   throws ValueDeserializationException
```
    Extracts an Iterator over all aggregated key-value pairs in the given sub-target element.
    
    Parameters:
    
    elem - The serialized sub-target element.
    
    Returns:
    
    An Iterator over the elements in the sub-target.
    
    Throws:
    
    ValueDeserializationException - If elem does not represent a sub-target.
  - writeTarget
```
void writeTarget(T target,
                 OutputStream out)
          throws IOException
```
    Writes a aggregate target to the given output stream.
    
    Parameters:
    
    target - The target.
    
    out - The output stream.
    
    Throws:
    
    IOException - If an IO error occurs while writing to the stream.
  - readTarget
```
T readTarget(InputStream in)
      throws ValueDeserializationException,
             IOException
```
    Reads an aggregate target from the given input stream.
    
    Parameters:
    
    in - The input stream.
    
    Returns:
    
    The target read from the stream.
    
    Throws:
    
    ValueDeserializationException - If a target cannot be read from the stream.
    
    IOException - If an IO error occurs while reading from the stream.
  - newTarget
```
T newTarget()
```
    Creates a new, empty aggregate target.

Interface ValueSerializer<A,T>

Method Summary

Method Detail

serializeBoolean

deserializeBoolean

serializeNumber

deserializeNumber

serializeString

deserializeString

serializeEnum

deserializeEnum

serializeList

deserializeList

serializeMap

deserializeMap

serializeRecord

deserializeRecord

addElement

addSubElement

elements

subElements

writeTarget

readTarget

newTarget