com.therandomlabs.randompatches

Class TOMLConfigSerializer<T extends me.shedaniel.autoconfig1u.ConfigData>

java.lang.Object

com.therandomlabs.randompatches.TOMLConfigSerializer<T>

Type Parameters:

T - the configuration type.

All Implemented Interfaces:

me.shedaniel.autoconfig1u.serializer.ConfigSerializer<T>

public final class TOMLConfigSerializer<T extends me.shedaniel.autoconfig1u.ConfigData>
extends Object
implements me.shedaniel.autoconfig1u.serializer.ConfigSerializer<T>

A ConfigSerializer for TOML that uses NightConfig.

Compared to Toml4jConfigSerializer, this ConfigSerializer ensures that ConfigData.validatePostLoad() is always called and any updated values are written to disk on both serialization and deserialization.

In addition, NightConfig's Spec* annotations are supported, and invalid values are automatically reset to the defaults.

Furthermore, lower_snake_case for key names is enforced, and comments for properties, categories and configuration files may be specified through the use of TOMLConfigSerializer.Comment.

reloadFromDisk() may be used to reload the configuration from disk if a reference to the TOMLConfigSerializer is stored.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TOMLConfigSerializer.Comment A TOML configuration comment.

Nested classes/interfaces inherited from interface me.shedaniel.autoconfig1u.serializer.ConfigSerializer

me.shedaniel.autoconfig1u.serializer.ConfigSerializer.Factory<T extends me.shedaniel.autoconfig1u.ConfigData>, me.shedaniel.autoconfig1u.serializer.ConfigSerializer.SerializationException

Constructor Summary

Constructors

Constructor and Description
TOMLConfigSerializer(me.shedaniel.autoconfig1u.annotation.Config definition, Class<T> configClass) Constructs a TOMLConfigSerializer with the specified definition and configuration class.

Method Summary

Modifier and Type	Method and Description
T	createDefault()
T	deserialize()
T	getConfig() Returns this TOMLConfigSerializer's configuration.
void	reloadFromDisk() Reloads this TOMLConfigSerializer's configuration from disk.
void	serialize(T config)

Methods inherited from class java.lang.Object

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

Constructor Detail

TOMLConfigSerializer

public TOMLConfigSerializer(me.shedaniel.autoconfig1u.annotation.Config definition,
                            Class<T> configClass)

Constructs a TOMLConfigSerializer with the specified definition and configuration class.

Parameters:

definition - a definition.

configClass - a configuration class.

Method Detail

serialize

public void serialize(T config)

Specified by:

serialize in interface me.shedaniel.autoconfig1u.serializer.ConfigSerializer<T extends me.shedaniel.autoconfig1u.ConfigData>

deserialize

public T deserialize()

Specified by:

deserialize in interface me.shedaniel.autoconfig1u.serializer.ConfigSerializer<T extends me.shedaniel.autoconfig1u.ConfigData>

createDefault

public T createDefault()

Specified by:

createDefault in interface me.shedaniel.autoconfig1u.serializer.ConfigSerializer<T extends me.shedaniel.autoconfig1u.ConfigData>

getConfig

public T getConfig()

Returns this TOMLConfigSerializer's configuration.

Returns:

this TOMLConfigSerializer's configuration.

reloadFromDisk

public void reloadFromDisk()

Reloads this TOMLConfigSerializer's configuration from disk.