Package org.kingdoms.utils.config.adapters

Interface YamlContainer

All Known Implementing Classes:
YamlAbstractContainer, YamlFile, YamlFiledDefaults, YamlHierarchyDefaults, YamlResource, YamlWithDefaults
public interface YamlContainer

  • Method Details

    • getConfig

      ConfigSection getConfig()

    • accessor

      ConfigAccessor accessor()

    • saveConfig

      void saveConfig()

    • setResolveAliases

      YamlContainer setResolveAliases(boolean resolveAliases)

    • setImportDeclarations

      YamlContainer setImportDeclarations(boolean importDeclarations)

    • getImportDeclarations

      boolean getImportDeclarations()

    • isLoaded

      default boolean isLoaded()

    • getFile

      @Nullable @Nullable File getFile()

    • simpleName

      String simpleName()
      A simpler and less verbose name than Object.toString() usually the file name or path of the config.

    • createFile

      default void createFile()

    • setImporter

      YamlContainer setImporter(YamlImporter importer)

    • getImporter

      YamlImporter getImporter()

    • importDeclarations

      @NotNull default @NotNull YamlContainer importDeclarations()

    • parse

      @NotNull static @NotNull org.snakeyaml.nodes.MappingNode parse(YamlParseContext context)

    • parseNode

      @NotNull static @NotNull org.snakeyaml.nodes.Node parseNode(YamlParseContext context)

    • parseValidator

      static org.snakeyaml.validation.NodeValidator parseValidator(String label, String resourcePath)

    • parseValidator

      static org.snakeyaml.validation.NodeValidator parseValidator(InputStream is, String label)

    • load

      YamlContainer load()

    • reload

      void reload()
      Reloads the YAML from the local file (getFile()) if it exists.
      See Also:

    • reloadHandle

      void reloadHandle()
      Doesn't reload the YAML nodes themselves, but triggers additional reloading mechanics that are needed when reload() is called. Mostly used for ConfigWatcher or other manual reloading mechanics like /k reload.