Package com.codingchili.core.configuration

Interface Configurable

All Superinterfaces:
Serializable
All Known Implementing Classes:
AttributeConfigurable, BaseConfigurable, LauncherSettings, SecuritySettings, ServiceConfigurable, StorageSettings, SystemSettings, Validator
public interface Configurable extends Serializable
Base configuration interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getPath()
    Get the path of a loaded configuration file.
    default void
    save()
    Saves the configurable back to disk.
    default io.vertx.core.json.JsonObject
    serialize()
    Serializes a configuration for permanent storage, allows the configuration container to remove computed attributes that are used when serializing over network but not to disk.
    default Configurable
    setPath​(String path)
    Set the path of a configurable to allow saving to the same location it was loaded from.

  • Method Details

    • getPath

      String getPath()
      Get the path of a loaded configuration file.
      Returns:
      the directory path to the configuration file.

    • setPath

      default Configurable setPath​(String path)
      Set the path of a configurable to allow saving to the same location it was loaded from.
      Parameters:
      path - the path to the configurable on disk for reloading and saving.
      Returns:
      fluent

    • serialize

      default io.vertx.core.json.JsonObject serialize()
      Serializes a configuration for permanent storage, allows the configuration container to remove computed attributes that are used when serializing over network but not to disk.
      Returns:
      a JsonObject that is equal to the JsonObject loaded from disk.

    • save

      default void save()
      Saves the configurable back to disk.