Package yt.sehrschlecht.classconfig.options

Annotation Interface MigrateOption

@Retention(RUNTIME) @Target(FIELD) public @interface MigrateOption
Used to set old keys for a config option that has been renamed. The annotation can also be used just to delete old options: Set oldKeys() to an empty array and enable deleteOldKeys().
Warning: Changing the type of a config option is not supported and will cause errors. Create a new option instead.
Since:
1.0
Author:
sehrschlechtYT | https://github.com/sehrschlechtYT

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    oldKeys
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    deleteOldKeys
     

  • Element Details

    • oldKeys

      String[] oldKeys
      Returns:
      An array of the keys the option previously had.

    • deleteOldKeys

      boolean deleteOldKeys
      Returns:
      Whether the old keys should be removed from the config after migrating.
      Default:
      true