org.bspfsystems.yamlconfiguration.serialization

Annotation Type SerializableAs

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

Represents an "alias" that a ConfigurationSerializable may be stored as. If this is not present on a ConfigurationSerializable Class, it will use the fully qualified name of the Class.

This value will be stored in the ConfigurationSerialization so that the ConfigurationSerialization can determine what type it is.

Using this annotation on any other Class than a ConfigurationSerializable 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 your ConfigurationSerialization Class will be stored and retrieved as.

Element Detail

value

@NotNull
public abstract @NotNull String value

This is the name your ConfigurationSerialization Class will be stored and retrieved as.

This name MUST be unique. We recommend using names such as "MyPluginThing" instead of "Thing".

Returns:

The name to serialize the Class as.