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

Annotation Interface SystemPreference

@ClassVersion(sourceVersion="$Id: SystemPreference.java 942 2021-12-20 02:04:04Z tquadrat $") @Documented @Retention(CLASS) @Target(METHOD) @API(status=STABLE, since="0.0.1") public @interface SystemPreference

This annotation indicates that the property for the annotated getter is initialised from a SYSTEM Preferences value with the path and name.

This annotation implies the NoPreference annotation.

Notes:
  • Even when no setter is defined for a property with this annotation \u2013 making it effectively immutable \u2013 the field for it will not be final. This is because of the way the initialisation works.
  • Changes to the value of a property marked with this annotation will not be reflected to the SYSTEM Preferences.
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: SystemPreference.java 942 2021-12-20 02:04:04Z tquadrat $
Since:
0.0.1
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<? extends PreferenceAccessor<?>>
    accessor
    The implementation of PreferenceAccessor that is used to access the Preferences and to translate the value into the type of the property.
    String
    key
    The key for the SYSTEM preference value to read.
    String
    path
    The path for the SYSTEM preference node that holds the value.

  • Element Details

    • key

      String key
      The key for the SYSTEM preference value to read.
      Returns:
      The key for the SYSTEM preference.

    • path

      String path
      The path for the SYSTEM preference node that holds the value.
      Returns:
      The path for the SYSTEM preference node.

    • accessor

      @API(status=STABLE, since="0.1.0") Class<? extends PreferenceAccessor<?>> accessor

      The implementation of PreferenceAccessor that is used to access the Preferences and to translate the value into the type of the property.

      This is mandatory, no default is used, nor will it be somehow inferred.

      Returns:
      The class for the preferences accessor.