kz.charles_grozny.bukkitConfig.configuration.serialization.ConfigurationSerializable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bukkit-config-library Show documentation

Library for configuration from bukkit

The newest version!

package kz.charles_grozny.bukkitConfig.configuration.serialization;

import java.util.Map;

/**
 * Represents an object that may be serialized.
 * 
 * These objects MUST implement one of the following, in addition to the
 * methods as defined by this interface:
 * 

 * A static method "deserialize" that accepts a single {@link Map}<
 * {@link String}, {@link Object}> and returns the class.
 * A static method "valueOf" that accepts a single {@link Map}<{@link
 * String}, {@link Object}> and returns the class.
 * A constructor that accepts a single {@link Map}<{@link String},
 * {@link Object}>.
 * 
 * In addition to implementing this interface, you must register the class
 * with {@link ConfigurationSerialization#registerClass(Class)}.
 *
 * @see DelegateDeserialization
 * @see SerializableAs
 */
public interface ConfigurationSerializable {

    /**
     * Creates a Map representation of this class.
     * 
     * This class must provide a method to restore this class, as defined in
     * the {@link ConfigurationSerializable} interface javadocs.
     *
     * @return Map containing the current state of this class
     */
    public Map serialize();
}