net.lenni0451.optconfig.serializer.impl

Class StringTypeSerializer<C>

java.lang.Object

net.lenni0451.optconfig.serializer.ConfigTypeSerializer<C,java.lang.String>

net.lenni0451.optconfig.serializer.impl.StringTypeSerializer<C>

Type Parameters:

C - The type of the config instance

public class StringTypeSerializer<C>
extends ConfigTypeSerializer<C,java.lang.String>

A serializer for the String type.
Yaml allows having strings without quotes which causes issues if the value is also a number or boolean.
The config deserializer will throw an exception if the value is not a string, which is why this serializer is needed.

Example:

     key: 123
     key2: true
     key3: "string"
     key4: string
 

All the values are valid strings, but only `key3` and `key4` are interpreted as strings by yaml.
If `key` and `key2` are string option types, a ClassCastException will be thrown because the value is a number or boolean.

Field Summary

Fields inherited from class net.lenni0451.optconfig.serializer.ConfigTypeSerializer

config

Constructor Summary

Constructors

Constructor and Description
StringTypeSerializer(C config, boolean emptyIsNull)

Method Summary

Modifier and Type	Method and Description
java.lang.String	deserialize(java.lang.Object serializedObject) Deserializes the given yaml object to the type T.
java.lang.Object	serialize(java.lang.String object) Serializes the given object to a yaml object.

Methods inherited from class net.lenni0451.optconfig.serializer.ConfigTypeSerializer

deserialize, deserialize, deserialize, serialize, serialize

Methods inherited from class java.lang.Object

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

Constructor Detail

StringTypeSerializer

public StringTypeSerializer(C config,
                            boolean emptyIsNull)

Parameters:

config - The config instance

emptyIsNull - If empty strings should be deserialized as null and null serialized as empty strings

Method Detail

deserialize

public java.lang.String deserialize(java.lang.Object serializedObject)

Description copied from class: ConfigTypeSerializer

Deserializes the given yaml object to the type T.
See Tag for the possible types.

Overrides:

deserialize in class ConfigTypeSerializer<C,java.lang.String>

Parameters:

serializedObject - The object to deserialize

Returns:

The deserialized object

serialize

public java.lang.Object serialize(java.lang.String object)

Description copied from class: ConfigTypeSerializer

Serializes the given object to a yaml object.
See Tag for the possible types.

Overrides:

serialize in class ConfigTypeSerializer<C,java.lang.String>

Parameters:

object - The object to serialize

Returns:

The serialized object