Module org.bspfsystems.yamlconfiguration
Package org.bspfsystems.yamlconfiguration.serialization

Interface ConfigurationSerializable

public interface ConfigurationSerializable
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 Map<String, Object> and returns the class.
  • A static method "valueOf" that accepts a single Map<String, Object> and returns the class.
  • A constructor that accepts a single Map<String, Object>.
In addition to implementing this interface, you must register the class with ConfigurationSerialization.registerClass(Class).

* Synchronized with the commit on 23-April-2019.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Map<String,Object>
    serialize()
    Creates a map representation of this configuration serializable.

  • Method Details

    • serialize

      @NotNull @NotNull Map<String,Object> serialize()
      Creates a map representation of this configuration serializable.

      This class must provide a method to restore this class, as defined in the configuration serializable interface javadocs.

      The map cannot be modified. The map will also only represent a snapshot of this configuration serializable when it was taken.

      Returns:
      A map containing the current state of this configuration serializable.