Module dev.orne.config

Package dev.orne.config.impl

Class PreferencesConfigOptions

java.lang.Object

dev.orne.config.impl.PreferencesConfigOptions

@API(status=INTERNAL,
     since="1.0")
public class PreferencesConfigOptions
extends Object

Options of Preferences based configuration builder.

Since:

1.0

Version:

1.0, 2025-05

Author:

(w) Iker Hernaez

See Also:

• PreferencesConfigImpl

Constructor Summary

Constructors

Constructor	Description
PreferencesConfigOptions()	Empty constructor.
PreferencesConfigOptions(@NotNull PreferencesConfigOptions copy)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
@NotNull Preferences	getPreferences()	Returns the preferences node to use as storage of configuration properties.
void	setPreferences(Preferences preferences)	Sets the preferences node to use as storage of configuration properties.
void	setSystemPreferences()	Sets the system preferences tree root node.
void	setSystemPreferences(@NotNull Class<?> clazz)	Sets the node for the package of the specified class on the system preferences tree.
void	setSystemPreferences(@NotNull Class<?> clazz, @NotNull String path)	Sets the specified path relative to the node for the package of the specified class on the system preferences tree.
void	setSystemPreferences(@NotNull String path)	Sets the node with the specified path on the system preferences tree.
void	setUserPreferences()	Sets the user preferences tree root node.
void	setUserPreferences(@NotNull Class<?> clazz)	Sets the node for the package of the specified class on the user preferences tree.
void	setUserPreferences(@NotNull Class<?> clazz, @NotNull String path)	Set the node with the specified path relative to the node for the package of the specified class on the user preferences tree.
void	setUserPreferences(@NotNull String path)	Sets the node with the specified path on the user preferences tree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PreferencesConfigOptions

public PreferencesConfigOptions()

Empty constructor.

PreferencesConfigOptions

public PreferencesConfigOptions(@NotNull
 @NotNull PreferencesConfigOptions copy)

Copy constructor.

Parameters:

copy - The instance to copy.

Method Details

getPreferences

@NotNull
public @NotNull Preferences getPreferences()

Returns the preferences node to use as storage of configuration properties.

Returns:

The preferences node to use as storage of configuration properties.

setPreferences

public void setPreferences(Preferences preferences)

Sets the preferences node to use as storage of configuration properties.

Parameters:

preferences - The preferences node to use as storage of configuration properties.

setUserPreferences

public void setUserPreferences()

Sets the user preferences tree root node.

See Also:

• Preferences.userRoot()

setUserPreferences

public void setUserPreferences(@NotNull
 @NotNull String path)

Sets the node with the specified path on the user preferences tree.

Parameters:

path - The path of the configuration's preferences, relative to user preference tree's root node

See Also:

• Preferences.userRoot()
• Preferences.node(String)

setUserPreferences

public void setUserPreferences(@NotNull
 @NotNull Class<?> clazz)

Sets the node for the package of the specified class on the user preferences tree.

Parameters:

clazz - The class which package use when calculating base node

See Also:

• Preferences.userNodeForPackage(Class)

setUserPreferences

public void setUserPreferences(@NotNull
 @NotNull Class<?> clazz,
 @NotNull
 @NotNull String path)

Set the node with the specified path relative to the node for the package of the specified class on the user preferences tree.

Parameters:

clazz - The class which package use when calculating base node

path - The path of the configuration's preferences, relative to base node

See Also:

• Preferences.userNodeForPackage(Class)
• Preferences.node(String)

setSystemPreferences

public void setSystemPreferences()

Sets the system preferences tree root node.

See Also:

• Preferences.systemRoot()

setSystemPreferences

public void setSystemPreferences(@NotNull
 @NotNull String path)

Sets the node with the specified path on the system preferences tree.

Parameters:

path - The path of the configuration's preferences, relative to root node.

See Also:

• Preferences.systemRoot()
• Preferences.node(String)

setSystemPreferences

public void setSystemPreferences(@NotNull
 @NotNull Class<?> clazz)

Sets the node for the package of the specified class on the system preferences tree.

Parameters:

clazz - The class which package use when calculating base node.

See Also:

• Preferences.systemNodeForPackage(Class)

setSystemPreferences

public void setSystemPreferences(@NotNull
 @NotNull Class<?> clazz,
 @NotNull
 @NotNull String path)

Sets the specified path relative to the node for the package of the specified class on the system preferences tree.

Parameters:

clazz - The class which package use when calculating base node

path - The path of the configuration's preferences, relative to base node

See Also:

• Preferences.systemNodeForPackage(Class)
• Preferences.node(String)