Package com.ultikits.ultitools.annotations

Annotation Interface ConfigEntry

@Target(FIELD) @Retention(RUNTIME) public @interface ConfigEntry
Config entry annotation.
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    comment
    A single trimmed {key} token resolves through the module catalogue, so the entry's comment follows the server's language: start-up and /ul reload rewrite the framework's own comment lines in the current language, and a write that inserts the entry writes its comment; a save, an operator change or a panel edit rewrites no comment.
    Class<? extends ConfigParser>
    parser
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use ConfigConverter with ConfigConverterFor; removed in the next version.
    String
    path
    Declares a nested entry path split at every dot.
    String[]
    previousComments
    Comment texts earlier versions of the module shipped for this entry - for example the literal comment it had before comment() became a {key} token whose catalogue wording then changed.

  • Element Details

    • path

      String path
      Declares a nested entry path split at every dot. Dots inside keys of a bound map are whole map keys instead; they are not interpreted as annotation path separators.
      Returns:
      the nested config entry path
      Default:
      ""

    • comment

      String comment
      A single trimmed {key} token resolves through the module catalogue, so the entry's comment follows the server's language: start-up and /ul reload rewrite the framework's own comment lines in the current language, and a write that inserts the entry writes its comment; a save, an operator change or a panel edit rewrites no comment. Only comment lines the framework can identify as its own are rewritten: the entry's comment, as a whole or as its trailing run of lines, equal byte for byte (at the entry's column, "# " and the text) to the framework's rendering of the token in a catalogue the module's jar ships, of a text an earlier module version shipped and listed in previousComments(), of the text the module resolves now, or of the bare token. Any other comment line above the entry - an operator's note, a framework comment the operator edited - is kept byte for byte, permanently. Literal comments are only supplied for new entries and existing operator comments are retained. Comments on individual list items are kept only while the list keeps its length - the same as Bukkit, which keeps none.
      Returns:
      the literal comment or single catalogue-key token
      Default:
      ""

    • previousComments

      String[] previousComments
      Comment texts earlier versions of the module shipped for this entry - for example the literal comment it had before comment() became a {key} token whose catalogue wording then changed. On a token entry, a comment in a server's file that equals one of these texts in the exact form the framework writes (the entry's column, "# " and the text) counts as written by the framework: it is replaced by the current catalogue text and follows the server's language from then on. A comment that differs in any character stays the operator's and is kept byte for byte. Ignored on an entry whose comment is literal, which is never rewritten.
      Returns:
      the texts earlier versions shipped, one element per comment (a text may span lines)
      Since:
      6.3.0
      Default:
      {}

    • parser

      @Deprecated(since="6.3.0", forRemoval=true) Class<? extends ConfigParser> parser
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use ConfigConverter with ConfigConverterFor; removed in the next version.
      The default selects the declared-type converter registry. An explicit non-default parser selects the frozen legacy adapter, including its old dotted-key behavior.
      Returns:
      the legacy parser override, or the registry-selecting default
      See Also:
      Scheduled removal version:
      6.4.0
      Default:
      com.ultikits.ultitools.interfaces.impl.pasers.DefaultConfigParser.class