Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config

Annotation Interface PreferencesRoot

@ClassVersion(sourceVersion="$Id: PreferencesRoot.java 944 2021-12-21 21:56:24Z tquadrat $")
@Documented
@Retention(CLASS)
@Target(TYPE)
@API(status=STABLE,
     since="0.1.0")
public @interface PreferencesRoot

Provides some general configuration settings for a configuration bean that implements PreferencesBeanSpec.

At default, the node for the "preferences" is determined by the class of the configuration bean specification, but with this annotation, it could get another name.

Also usually, there is no listener for changes to the underlying preferences. But this annotation allows to configure it.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: PreferencesRoot.java 944 2021-12-21 21:56:24Z tquadrat $

Since:

0.1.0

See Also:

• Preferences.userNodeForPackage(Class)

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
Class<? extends PreferenceChangeListenerBase>	changeListenerClass	The class for the preferences change listener.
String	nodeName	The alternative name for the "preferences" node.

Element Details

nodeName

String nodeName

The alternative name for the "preferences" node.

Returns:

The node name.

changeListenerClass

Class<? extends PreferenceChangeListenerBase> changeListenerClass

The class for the preferences change listener. It has to extend PreferenceChangeListenerBase.

The class PreferenceChangeListenerImpl provides a default implementation.

Returns:

The class for the change listener; if null, no listener support will be generated.