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

Annotation Interface Preference

@ClassVersion(sourceVersion="$Id: Preference.java 941 2021-12-18 22:34:37Z tquadrat $") @Documented @Retention(CLASS) @Target(METHOD) @API(status=STABLE, since="0.0.1") public @interface Preference
Forces a property to have a preferences reference and configures it. Usually, all attributes of a property that are required for the preferences will be inferred from the property itself. This annotation allows to modify these default values.
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: Preference.java 941 2021-12-18 22:34:37Z tquadrat $
Since:
0.0.1

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<?>
    accessor
    The accessor that is used to set the property from the preference, and the preference from the property value. For most types, this can be derived from the type, but for others, it needs to be set explicitly.
    String
    key
    The key for the preference; the default is the property name.

  • Element Details

    • accessor

      Class<?> accessor

      The accessor that is used to set the property from the preference, and the preference from the property value. For most types, this can be derived from the type, but for others, it needs to be set explicitly.

      The value PreferenceAccessor.class indicates the default setting.

      Returns:
      The class for the accessor.
      See Also:
      Default:
      org.tquadrat.foundation.config.spi.prefs.PreferenceAccessor.class

    • key

      String key
      The key for the preference; the default is the property name.
      Returns:
      The key.
      Default:
      ""