org.bspfsystems.yamlconfiguration.serialization

Class ConfigurationSerialization

java.lang.Object

org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization

public final class ConfigurationSerialization
extends Object

Utility class for storing and retrieving classes for Configuration. Synchronized with the commit on 23-April-2019.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_TYPE_KEY

Method Summary

Modifier and Type	Method and Description
static @Nullable ConfigurationSerializable	deserializeObject(@NotNull Map<String,?> map) Attempts to deserialize the given arguments into a new instance of the given class.
static @Nullable ConfigurationSerializable	deserializeObject(@NotNull Map<String,?> map, @NotNull Class<? extends ConfigurationSerializable> clazz) Attempts to deserialize the given Map into a new instance of the given Class.
static @NotNull String	getAlias(@NotNull Class<? extends ConfigurationSerializable> clazz) Gets the primary alias for the given ConfigurationSerializable Class.
static @Nullable Class<? extends ConfigurationSerializable>	getClassByAlias(@NotNull String alias) Attempts to get a registered ConfigurationSerializable Class by its alias.
static void	registerClass(@NotNull Class<? extends ConfigurationSerializable> clazz) Registers the given ConfigurationSerializable Class by its alias.
static void	registerClass(@NotNull Class<? extends ConfigurationSerializable> clazz, @NotNull String alias) Registers the given alias to the specified ConfigurationSerializable Class
static void	unregisterClass(@NotNull Class<? extends ConfigurationSerializable> clazz) Unregisters any aliases for the specified ConfigurationSerializable Class.
static void	unregisterClass(@NotNull String alias) Unregisters the specified alias from a ConfigurationSerializable.

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_TYPE_KEY

public static final String SERIALIZED_TYPE_KEY

See Also:

Constant Field Values

Method Detail

deserializeObject

@Nullable
public static @Nullable ConfigurationSerializable deserializeObject(@NotNull
                                                                              @NotNull Map<String,?> map,
                                                                              @NotNull
                                                                              @NotNull Class<? extends ConfigurationSerializable> clazz)

Attempts to deserialize the given Map into a new instance of the given Class.

The Class must implement ConfigurationSerializable, including the extra methods as specified in the javadoc of a ConfigurationSerializable.

If a new instance could not be made (an example being the Class not fully implementing the interface), null will be returned.

Parameters:

map - The Map to deserialize.

clazz - The Class to deserialize into.

Returns:

The new instance of the specified Class.

deserializeObject

@Nullable
public static @Nullable ConfigurationSerializable deserializeObject(@NotNull
                                                                              @NotNull Map<String,?> map)

Attempts to deserialize the given arguments into a new instance of the given class.

The class must implement ConfigurationSerializable, including the extra methods as specified in the javadoc of ConfigurationSerializable.

If a new instance could not be made, an example being the class not fully implementing the interface, null will be returned.

Parameters:

map - The data as a Map to deserialize.

Returns:

The ConfigurationSerializable with the data from the given Map.

registerClass

public static void registerClass(@NotNull
                                 @NotNull Class<? extends ConfigurationSerializable> clazz)

Registers the given ConfigurationSerializable Class by its alias.

Parameters:

clazz - The Class to register.

registerClass

public static void registerClass(@NotNull
                                 @NotNull Class<? extends ConfigurationSerializable> clazz,
                                 @NotNull
                                 @NotNull String alias)

Registers the given alias to the specified ConfigurationSerializable Class

Parameters:

clazz - The Class to register.

alias - Alias to register the Class as.

See Also:

SerializableAs

unregisterClass

public static void unregisterClass(@NotNull
                                   @NotNull String alias)

Unregisters the specified alias from a ConfigurationSerializable.

Parameters:

alias - The alias to unregister.

unregisterClass

public static void unregisterClass(@NotNull
                                   @NotNull Class<? extends ConfigurationSerializable> clazz)

Unregisters any aliases for the specified ConfigurationSerializable Class.

Parameters:

clazz - The Class to unregister.

getClassByAlias

@Nullable
public static @Nullable Class<? extends ConfigurationSerializable> getClassByAlias(@NotNull
                                                                                             @NotNull String alias)

Attempts to get a registered ConfigurationSerializable Class by its alias.

Parameters:

alias - The alias of the ConfigurationSerializable to retrieve.

Returns:

The requested ConfigurationSerializable, or null if one is not found.

getAlias

@NotNull
public static @NotNull String getAlias(@NotNull
                                                @NotNull Class<? extends ConfigurationSerializable> clazz)

Gets the primary alias for the given ConfigurationSerializable Class.

Parameters:

clazz - The Class to retrieve the alias of.

Returns:

The requested primary alias of the given ConfigurationSerializable.