org.bspfsystems.yamlconfiguration.serialization

Annotation Type SerializableAs

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface SerializableAs

Represents an "alias" that a configuration serializable may be known as.

If this annotation is no present on a configuration serializable class, the class's fully-qualified name (Class.getName()) will be used.

This value will be stored in the configuration serialization so that it can determine what type it is during serialization and deserialization operations.

Using this annotation on a class that does not extend or implement a configuration serializable will have no effect.

Synchronized with the commit on 23-April-2019.

See Also:

ConfigurationSerialization.registerClass(Class, String)

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
@NotNull String	value This is the name the configuration serializable class will be known by.

Element Detail

value

@NotNull
public abstract @NotNull String value

This is the name the configuration serializable class will be known by.

This name MUST be unique. It is recommended to use names such as "MyApplicationThing" instead of "Thing".

Returns:

The name to serialize the class as.