Module org.tquadrat.foundation.config
Package org.tquadrat.foundation.config

Annotation Interface INIValue

@ClassVersion(sourceVersion="$Id: INIValue.java 946 2021-12-23 14:48:19Z tquadrat $") @Documented @Retention(CLASS) @Target(METHOD) @API(status=STABLE, since="0.1.0") public @interface INIValue

The marker for properties that will be persisted in an INI file.

This annotation implies the @NoPreference annotation.

Any type of a property can be persisted to an INI file as long as a proper implementation of StringConverter can be provided for that type.

Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: INIValue.java 946 2021-12-23 14:48:19Z tquadrat $
Since:
0.1.0
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    group
    The mandatory group for the value in the configuration file.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    comment
    The comment for the value.
    String
    key
    The key for the value in the configuration file.

  • Element Details

    • comment

      String comment
      The comment for the value.
      Returns:
      The comment.
      Default:
      ""

    • group

      String group
      The mandatory group for the value in the configuration file.
      Returns:
      The group.

    • key

      String key
      The key for the value in the configuration file. If not provided, the property name is used instead.
      Returns:
      The key.
      Default:
      ""