Module dev.orne.config

Package dev.orne.config

Interface PreferencesConfigInitialBuilder

All Known Implementing Classes:

PreferencesConfigBuilderImpl

@API(status=STABLE,
     since="1.0")
public interface PreferencesConfigInitialBuilder

Preferences based configuration node selection builder.

Since:

1.0

Version:

1.0, 2025-05

Author:

(w) Iker Hernaez

See Also:

• Preferences
• Config

Method Summary

Modifier and Type	Method	Description
PreferencesConfigBuilder	ofNode(Preferences preferences)	Selects the specified preferences node.
PreferencesConfigBuilder	ofSystem(Class<?> clazz)	Selects the node for the package of the specified class on the system preferences tree.
PreferencesConfigBuilder	ofSystem(Class<?> clazz, String path)	Selects the node with the specified path relative to the node for the package of the specified class on the system preferences tree.
PreferencesConfigBuilder	ofSystem(String path)	Selects the node with the specified path on the system preferences tree.
PreferencesConfigBuilder	ofSystemRoot()	Selects the system preferences tree root node.
PreferencesConfigBuilder	ofUser(Class<?> clazz)	Selects the node for the package of the specified class on the user preferences tree.
PreferencesConfigBuilder	ofUser(Class<?> clazz, String path)	Selects the node with the specified path relative to the node for the package of the specified class on the user preferences tree.
PreferencesConfigBuilder	ofUser(String path)	Selects the node with the specified path on the user preferences tree.
PreferencesConfigBuilder	ofUserRoot()	Selects the user preferences tree root node.

Method Details

ofUserRoot

PreferencesConfigBuilder ofUserRoot()

Selects the user preferences tree root node.

Returns:

Next builder, for method chaining.

See Also:

• Preferences.userRoot()

ofUser

PreferencesConfigBuilder ofUser(String path)

Selects 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

Returns:

Next builder, for method chaining.

See Also:

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

ofUser

PreferencesConfigBuilder ofUser(Class<?> clazz)

Selects 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

Returns:

Next builder, for method chaining.

See Also:

• Preferences.userNodeForPackage(Class)

ofUser

PreferencesConfigBuilder ofUser(Class<?> clazz,
 String path)

Selects 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

Returns:

Next builder, for method chaining.

See Also:

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

ofSystemRoot

PreferencesConfigBuilder ofSystemRoot()

Selects the system preferences tree root node.

Returns:

Next builder, for method chaining.

See Also:

• Preferences.systemRoot()

ofSystem

PreferencesConfigBuilder ofSystem(String path)

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

Parameters:

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

Returns:

Next builder, for method chaining.

See Also:

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

ofSystem

PreferencesConfigBuilder ofSystem(Class<?> clazz)

Selects 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.

Returns:

Next builder, for method chaining.

See Also:

• Preferences.systemNodeForPackage(Class)

ofSystem

PreferencesConfigBuilder ofSystem(Class<?> clazz,
 String path)

Selects the node with 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

Returns:

Next builder, for method chaining.

See Also:

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

ofNode

PreferencesConfigBuilder ofNode(Preferences preferences)

Selects the specified preferences node.

Parameters:

preferences - The Preferences node to use.

Returns:

Next builder, for method chaining.