Package me.a8kj.config.file

Interface ConfigFile<K>

Type Parameters:
K - the type of data keys used in the configuration.
All Known Implementing Classes:
BasicConfigFile
public interface ConfigFile<K>
Represents a configuration file as a unified object. This interface links the configuration's metadata, its physical location on disk, and its data representation in memory.
Since:
0.1
Author:
a8kj7sea

  • Method Summary

    Modifier and Type
    Method
    Description
    File
    file()
    Retrieves the physical file object pointing to the configuration's location on the disk.
    DataMemory<K>
    memory()
    Retrieves the memory storage holding the configuration's loaded data.
    ConfigMeta
    meta()
    Retrieves the metadata associated with this configuration.

  • Method Details

    • meta

      ConfigMeta meta()
      Retrieves the metadata associated with this configuration. Metadata includes identifying properties like name, relative path, and logging preferences.
      Returns:
      the ConfigMeta instance.
      Since:
      0.1

    • file

      File file()
      Retrieves the physical file object pointing to the configuration's location on the disk.
      Returns:
      the File object.
      Since:
      0.1

    • memory

      DataMemory<K> memory()
      Retrieves the memory storage holding the configuration's loaded data.
      Returns:
      the DataMemory implementation instance.
      Since:
      0.1