src/main/java/org/bukkit/configuration/serialization/SerializableAs.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

package org.bukkit.configuration.serialization;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Represents an "alias" that a {@link ConfigurationSerializable} may be stored as.
 * If this is not present on a {@link ConfigurationSerializable} class, it will use the
 * fully qualified name of the class.
 * <p />
 * This value will be stored in the configuration so that the configuration deserialization
 * can determine what type it is.
 * <p />
 * Using this annotation on any other class than a {@link ConfigurationSerializable} will
 * have no effect.
 * @see ConfigurationSerialization#registerClass(Class, String)
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface SerializableAs {
    /**
     * This is the name your class will be stored and retrieved as.
     * <p />
     * This name MUST be unique. We recommend using names such as "MyPluginThing" instead of
     * "Thing".
     *
     * @return Name to serialize the class as.
     */
    public String value();
}