Package yt.sehrschlecht.classconfig.options

Annotation Interface ConfigOption

@Retention(RUNTIME) @Target(FIELD) public @interface ConfigOption
Defines a config option. The annotated field will be set to the value from the config file.
Since:
1.0
Author:
sehrschlechtYT | https://github.com/sehrschlechtYT

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    comments
     
    String
    key
     
    Class<?>
    type
    Deprecated, for removal: This API element is subject to removal in a future version.
    Redundant parameter.

  • Element Details

    • key

      String key
      Returns:
      The key of the config option. If empty, the field name will be used.
      Default:
      ""

    • type

      @Deprecated(forRemoval=true) Class<?> type
      Deprecated, for removal: This API element is subject to removal in a future version.
      Redundant parameter. Will be removed in the stable release (1.0)
      Returns:
      The type of the config option. Used to verify the type of the value.
      Default:
      yt.sehrschlecht.classconfig.options.ConfigOption.class

    • comments

      String[] comments
      Returns:
      An array of comments that will be added to the config file. Comments will be overwritten every time the config file is saved.
      Default:
      {""}