Package dev.the_fireplace.lib.api.io.interfaces

Interface ConfigBasedSerializable

All Superinterfaces:
Readable, Writable
All Known Subinterfaces:
Config
public interface ConfigBasedSerializable extends Readable, Writable

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId()
    Config ID.
    default String
    getSubfolderName()
    Subfolder name.

    Methods inherited from interface dev.the_fireplace.lib.api.io.interfaces.Readable

    readFrom

    Methods inherited from interface dev.the_fireplace.lib.api.io.interfaces.Writable

    writeTo

  • Method Details

    • getSubfolderName

      default String getSubfolderName()
      Subfolder name. If not empty, this is used to make a folder within the config folder. Required to match ^[a-zA-Z0-9_\-]+$ Dashes will be removed and capitals converted to lowercase.

    • getId

      String getId()
      Config ID. This is used to determine the file name before the extension. Required to match ^[a-zA-Z0-9_\-]+$ Dashes will be removed and capitals converted to lowercase.