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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_TYPE_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurationSerialization(@NotNull Class<? extends ConfigurationSerializable> clazz) Constructs a new ConfigurationSerialization for the given ConfigurationSerializable.

Method Summary

Modifier and Type	Method and Description
@Nullable ConfigurationSerializable	deserialize(@NotNull Map<String,?> args) Deserializes the given Map into a ConfigurationSerializable.
static @Nullable ConfigurationSerializable	deserializeObject(@NotNull Map<String,?> args) Attempts to deserialize the given arguments into a new instance of the given class.
static @Nullable ConfigurationSerializable	deserializeObject(@NotNull Map<String,?> args, @NotNull Class<? extends ConfigurationSerializable> clazz) Attempts to deserialize the given arguments into a new instance of the given class.
protected @Nullable ConfigurationSerializable	deserializeViaConstructor(@NotNull Constructor<? extends ConfigurationSerializable> constructor, @NotNull Map<String,?> args) Deserializes the data in the Map via the given Constructor.
protected @Nullable ConfigurationSerializable	deserializeViaMethod(@NotNull Method method, @NotNull Map<String,?> args) Deserializes the data in the Map via the given Method.
static @NotNull String	getAlias(@NotNull Class<? extends ConfigurationSerializable> clazz) Gets the correct 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
protected @Nullable Constructor<? extends ConfigurationSerializable>	getConstructor() Gets the Constructor of the ConfigurationSerializable that performs the deserialization.
protected @Nullable Method	getMethod(@NotNull String name, boolean isStatic) Gets the Method of the ConfigurationSerializable that performs the deserialization.
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 to 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

Constructor Detail

ConfigurationSerialization

protected ConfigurationSerialization(@NotNull
                                     @NotNull Class<? extends ConfigurationSerializable> clazz)

Constructs a new ConfigurationSerialization for the given ConfigurationSerializable.

Parameters:

clazz - The ConfigurationSerializable Class.

Method Detail

deserialize

@Nullable
public @Nullable ConfigurationSerializable deserialize(@NotNull
                                                                 @NotNull Map<String,?> args)

Deserializes the given Map into a ConfigurationSerializable.

Parameters:

args - The serialized data.

Returns:

The deserialized Object, or null if the data cannot be deserialized.

getConstructor

@Nullable
protected @Nullable Constructor<? extends ConfigurationSerializable> getConstructor()

Gets the Constructor of the ConfigurationSerializable that performs the deserialization. If none can be found, null is returned.

Returns:

The Constructor that performs the deserialization, or null if none can be found.

getMethod

@Nullable
protected @Nullable Method getMethod(@NotNull
                                               @NotNull String name,
                                               boolean isStatic)

Gets the Method of the ConfigurationSerializable that performs the deserialization. If none can be found, null is returned.

Returns:

The Method that performs the deserialization, or null if none can be found.

deserializeViaConstructor

@Nullable
protected @Nullable ConfigurationSerializable deserializeViaConstructor(@NotNull
                                                                                  @NotNull Constructor<? extends ConfigurationSerializable> constructor,
                                                                                  @NotNull
                                                                                  @NotNull Map<String,?> args)

Deserializes the data in the Map via the given Constructor. If any Throwable is thrown, null will be returned.

Parameters:

constructor - The Constructor to use to deserialize the data.

args - The data to deserialize.

Returns:

The deserialized ConfigurationSerializable, or null if there is an issue.

deserializeViaMethod

@Nullable
protected @Nullable ConfigurationSerializable deserializeViaMethod(@NotNull
                                                                             @NotNull Method method,
                                                                             @NotNull
                                                                             @NotNull Map<String,?> args)

Deserializes the data in the Map via the given Method. If any Throwable is thrown, null will be returned.

Parameters:

method - The Method to use to deserialize the data.

args - The data to deserialize.

Returns:

The deserialized ConfigurationSerializable, or null if there is an issue.

deserializeObject

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

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:

args - Arguments for deserialization

clazz - Class to deserialize into

Returns:

New instance of the specified class

deserializeObject

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

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:

args - Arguments for deserialization

Returns:

New instance of the specified class

registerClass

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

Registers the given ConfigurationSerializable class by its alias

Parameters:

clazz - 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 - Class to register

alias - Alias to register as

See Also:

SerializableAs

unregisterClass

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

Unregisters the specified alias to a ConfigurationSerializable

Parameters:

alias - Alias to unregister

unregisterClass

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

Unregisters any aliases for the specified ConfigurationSerializable class

Parameters:

clazz - 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 - Alias of the serializable

Returns:

Registered class, or null if not found

getAlias

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

Gets the correct alias for the given ConfigurationSerializable class

Parameters:

clazz - Class to get alias for

Returns:

Alias to use for the class