Package space.b00tload.utils.configuration

Interface ConfigValues

public interface ConfigValues
An interface to implement in enums containing all configurable values.
Since:
1.0.0
Version:
1.0.0
Author:
Alix von Schirp

  • Method Details

    • getFlag

      String getFlag()
      The command line flag for this config value.
      Returns:
      the command line flag
      Usage example:
      --discord-token

    • getFlagAlias

      String getFlagAlias()
      The command line alias for this config value.
      Returns:
      the command line alias
      Usage example:
      -d

    • getEnvironmentVariable

      String getEnvironmentVariable()
      The environment variable name for this config value.
      Returns:
      the environment variable name
      Usage example:
      DISCORD_APP_TOKEN

    • getTomlPath

      String getTomlPath()
      The path to the config value in a toml file.
      Returns:
      the toml path.
      Usage example:
      discord.token

    • getDefaultValue

      String getDefaultValue()
      The default value used if not set via other configuration means.
      Returns:
      the default value.