io.github.fablabsmc.fablabs.api.fiber.v1.serialization

Class JanksonValueSerializer

java.lang.Object

io.github.fablabsmc.fablabs.api.fiber.v1.serialization.JanksonValueSerializer

All Implemented Interfaces:

ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

public class JanksonValueSerializer
extends Object
implements ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

ValueSerializer for Jankson.

Constructor Summary

Constructors

Constructor and Description
JanksonValueSerializer(boolean minify)
JanksonValueSerializer(boolean minify, blue.endless.jankson.Jankson jankson)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JanksonValueSerializer

public JanksonValueSerializer(boolean minify)

JanksonValueSerializer

public JanksonValueSerializer(boolean minify,
                              blue.endless.jankson.Jankson jankson)

Method Detail

serializeBoolean

public blue.endless.jankson.JsonElement serializeBoolean(boolean value,
                                                         BooleanSerializableType type)

Description copied from interface: ValueSerializer

Converts a boolean into the serialized form.

Specified by:

serializeBoolean in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

Parameters:

value - The boolean value.

type - The type of the boolean value.

deserializeBoolean

public boolean deserializeBoolean(blue.endless.jankson.JsonElement elem,
                                  BooleanSerializableType type)
                           throws ValueDeserializationException

Description copied from interface: ValueSerializer

Converts the serialized form to a boolean.

Specified by:

deserializeBoolean in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

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

public blue.endless.jankson.JsonElement serializeNumber(BigDecimal value,
                                                        DecimalSerializableType type)

Description copied from interface: ValueSerializer

Converts a number into the serialized form.

Specified by:

serializeNumber in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

Parameters:

value - The numeric value.

type - The type of the numeric value.

deserializeNumber

public BigDecimal deserializeNumber(blue.endless.jankson.JsonElement elem,
                                    DecimalSerializableType type)
                             throws ValueDeserializationException

Description copied from interface: ValueSerializer

Converts the serialized form to a number.

Specified by:

deserializeNumber in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

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

public blue.endless.jankson.JsonElement serializeString(String value,
                                                        StringSerializableType type)

Description copied from interface: ValueSerializer

Converts a string into the serialized form.

Specified by:

serializeString in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

Parameters:

value - The string value.

type - The type of the string value.

deserializeString

public String deserializeString(blue.endless.jankson.JsonElement elem,
                                StringSerializableType type)
                         throws ValueDeserializationException

Description copied from interface: ValueSerializer

Converts the serialized form to a string.

Specified by:

deserializeString in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

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

public blue.endless.jankson.JsonElement serializeEnum(String value,
                                                      EnumSerializableType type)

Description copied from interface: ValueSerializer

Converts a enumerated string into the serialized form.

Specified by:

serializeEnum in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

Parameters:

value - The enum value.

type - The type of the enum value.

deserializeEnum

public String deserializeEnum(blue.endless.jankson.JsonElement elem,
                              EnumSerializableType type)
                       throws ValueDeserializationException

Description copied from interface: ValueSerializer

Converts the serialized form to a enumerated value.

Specified by:

deserializeEnum in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

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

public <E> blue.endless.jankson.JsonElement serializeList(List<E> value,
                                                          ListSerializableType<E> type)

Description copied from interface: ValueSerializer

Converts a list into the serialized form.

Specified by:

serializeList in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

Parameters:

value - The list value.

type - The type of the list value.

deserializeList

public <E> List<E> deserializeList(blue.endless.jankson.JsonElement elem,
                                   ListSerializableType<E> type)
                            throws ValueDeserializationException

Description copied from interface: ValueSerializer

Converts the serialized form to a list of values.

Specified by:

deserializeList in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

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

public <V> blue.endless.jankson.JsonElement serializeMap(Map<String,V> value,
                                                         MapSerializableType<V> type)

Description copied from interface: ValueSerializer

Converts a map into the serialized form.

Specified by:

serializeMap in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

Parameters:

value - The map value.

type - The type of the map value.

deserializeMap

public <V> Map<String,V> deserializeMap(blue.endless.jankson.JsonElement elem,
                                        MapSerializableType<V> type)
                                 throws ValueDeserializationException

Description copied from interface: ValueSerializer

Converts the serialized form to a map.

Specified by:

deserializeMap in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

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

public blue.endless.jankson.JsonElement serializeRecord(Map<String,Object> value,
                                                        RecordSerializableType type)

Description copied from interface: ValueSerializer

Converts a record into the serialized form.

Specified by:

serializeRecord in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

Parameters:

value - The record value.

type - The type of the record value.

deserializeRecord

public Map<String,Object> deserializeRecord(blue.endless.jankson.JsonElement elem,
                                            RecordSerializableType type)
                                     throws ValueDeserializationException

Description copied from interface: ValueSerializer

Converts the serialized form to a record.

Specified by:

deserializeRecord in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

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

public void addElement(String name,
                       blue.endless.jankson.JsonElement elem,
                       blue.endless.jankson.JsonObject target,
                       @Nullable
                       String comment)

Description copied from interface: ValueSerializer

Aggregates a serialized value, associated with the given key, into the target. It is unspecified whether duplicate keys are allowed.

Specified by:

addElement in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

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

public void addSubElement(String name,
                          blue.endless.jankson.JsonObject elem,
                          blue.endless.jankson.JsonObject target,
                          @Nullable
                          String comment)

Description copied from interface: ValueSerializer

Aggregates an existing target, associated with the given key, into the target as a sub-target. It is unspecified whether duplicate keys are allowed.

Specified by:

addSubElement in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

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

public Iterator<Map.Entry<String,blue.endless.jankson.JsonElement>> elements(blue.endless.jankson.JsonObject target)

Description copied from interface: ValueSerializer

Extracts an Iterator over all aggregated key-value pairs in the given target.

Specified by:

elements in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

Parameters:

target - The target.

Returns:

An Iterator over the elements in the target.

subElements

public Iterator<Map.Entry<String,blue.endless.jankson.JsonElement>> subElements(blue.endless.jankson.JsonElement elem)
                                                                         throws ValueDeserializationException

Description copied from interface: ValueSerializer

Extracts an Iterator over all aggregated key-value pairs in the given sub-target element.

Specified by:

subElements in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

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

public void writeTarget(blue.endless.jankson.JsonObject target,
                        OutputStream out)
                 throws IOException

Description copied from interface: ValueSerializer

Writes a aggregate target to the given output stream.

Specified by:

writeTarget in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

Parameters:

target - The target.

out - The output stream.

Throws:

IOException - If an IO error occurs while writing to the stream.

readTarget

public blue.endless.jankson.JsonObject readTarget(InputStream in)
                                           throws ValueDeserializationException,
                                                  IOException

Description copied from interface: ValueSerializer

Reads an aggregate target from the given input stream.

Specified by:

readTarget in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>

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

public blue.endless.jankson.JsonObject newTarget()

Description copied from interface: ValueSerializer

Creates a new, empty aggregate target.

Specified by:

newTarget in interface ValueSerializer<blue.endless.jankson.JsonElement,blue.endless.jankson.JsonObject>