Package me.a8kj.config.file.properties

Interface ConfigMeta

All Known Implementing Classes:
BasicConfigMeta
public interface ConfigMeta
Defines the metadata and properties associated with a configuration file. This interface acts as a descriptor, providing essential information such as identity, location, and behavioral toggles for the configuration system.
Since:
0.1
Author:
a8kj7sea

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Retrieves the unique name of the configuration.
    String
    getRelativePath()
    Retrieves the relative path where the configuration file is located.
    default String
    getVersion()
    Retrieves the version string of the configuration schema.
    default boolean
    isLoggingEnabled()
    Determines whether logging is enabled for operations performed on this configuration.

  • Method Details

    • getName

      String getName()
      Retrieves the unique name of the configuration. This name is typically used for identification in logs and internal registries.
      Returns:
      the configuration name.
      Since:
      0.1

    • getRelativePath

      String getRelativePath()
      Retrieves the relative path where the configuration file is located. This path is resolved against a base directory to find the physical file.
      Returns:
      the relative file path.
      Since:
      0.1

    • isLoggingEnabled

      default boolean isLoggingEnabled()
      Determines whether logging is enabled for operations performed on this configuration. Defaults to true.
      Returns:
      true if logging is enabled, false otherwise.
      Since:
      0.1

    • getVersion

      default String getVersion()
      Retrieves the version string of the configuration schema. Useful for tracking changes and managing data migrations. Defaults to "1.0.0".
      Returns:
      the configuration version.
      Since:
      0.1