Module dev.orne.config

Package dev.orne.config.impl

Class PreferencesConfigBuilderImpl

java.lang.Object

dev.orne.config.impl.AbstractConfigBuilderImpl<PreferencesConfigBuilder>

dev.orne.config.impl.PreferencesConfigBuilderImpl

All Implemented Interfaces:

ConfigBuilder<PreferencesConfigBuilder>, MutableCapableConfigBuilder<PreferencesConfigBuilder>, PreferencesConfigBuilder, PreferencesConfigInitialBuilder

@API(status=INTERNAL,
     since="1.0")
public class PreferencesConfigBuilderImpl
extends AbstractConfigBuilderImpl<PreferencesConfigBuilder>
implements PreferencesConfigInitialBuilder, PreferencesConfigBuilder

Implementation of Preferences based immutable configuration builder.

Since:

1.0

Version:

1.0, 2025-05

Author:

(w) Iker Hernaez

See Also:

• PreferencesConfigBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull PreferencesConfigOptions	preferencesOptions	The preferences based configuration options.

Fields inherited from class dev.orne.config.impl.AbstractConfigBuilderImpl

options

Constructor Summary

Constructors

Constructor	Description
PreferencesConfigBuilderImpl()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
@NotNull PreferencesConfigImpl	build()	Creates the configuration instance.
@NotNull PreferencesMutableConfigBuilder	mutable()	Makes the configuration instance mutable.
@NotNull PreferencesConfigBuilder	ofNode(@NotNull Preferences preferences)	Selects the specified preferences node.
@NotNull PreferencesConfigBuilder	ofSystem(@NotNull Class<?> clazz)	Selects the node for the package of the specified class on the system preferences tree.
@NotNull PreferencesConfigBuilder	ofSystem(@NotNull Class<?> clazz, @NotNull 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.
@NotNull PreferencesConfigBuilder	ofSystem(@NotNull String path)	Selects the node with the specified path on the system preferences tree.
@NotNull PreferencesConfigBuilder	ofSystemRoot()	Selects the system preferences tree root node.
@NotNull PreferencesConfigBuilder	ofUser(@NotNull Class<?> clazz)	Selects the node for the package of the specified class on the user preferences tree.
@NotNull PreferencesConfigBuilder	ofUser(@NotNull Class<?> clazz, @NotNull 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.
@NotNull PreferencesConfigBuilder	ofUser(@NotNull String path)	Selects the node with the specified path on the user preferences tree.
@NotNull PreferencesConfigBuilder	ofUserRoot()	Selects the user preferences tree root node.

Methods inherited from class dev.orne.config.impl.AbstractConfigBuilderImpl

thisBuilder, withDecoder, withDecorator, withEncryption, withOverrideParentProperties, withParent, withVariableResolution

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.orne.config.ConfigBuilder

as, withDecoder, withDecorator, withEncryption, withOverrideParentProperties, withParent, withParent, withVariableResolution

Field Details

preferencesOptions

@NotNull
protected final @NotNull PreferencesConfigOptions preferencesOptions

The preferences based configuration options.

Constructor Details

PreferencesConfigBuilderImpl

public PreferencesConfigBuilderImpl()

Creates a new instance.

Method Details

ofUserRoot

@NotNull
public @NotNull PreferencesConfigBuilder ofUserRoot()

Selects the user preferences tree root node.

Specified by:

ofUserRoot in interface PreferencesConfigInitialBuilder

Returns:

Next builder, for method chaining.

See Also:

• Preferences.userRoot()

ofUser

@NotNull
public @NotNull PreferencesConfigBuilder ofUser(@NotNull
 @NotNull String path)

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

Specified by:

ofUser in interface PreferencesConfigInitialBuilder

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

@NotNull
public @NotNull PreferencesConfigBuilder ofUser(@NotNull
 @NotNull Class<?> clazz)

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

Specified by:

ofUser in interface PreferencesConfigInitialBuilder

Parameters:

clazz - The class which package use when calculating base node

Returns:

Next builder, for method chaining.

See Also:

• Preferences.userNodeForPackage(Class)

ofUser

@NotNull
public @NotNull PreferencesConfigBuilder ofUser(@NotNull
 @NotNull Class<?> clazz,
 @NotNull
 @NotNull 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.

Specified by:

ofUser in interface PreferencesConfigInitialBuilder

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

@NotNull
public @NotNull PreferencesConfigBuilder ofSystemRoot()

Selects the system preferences tree root node.

Specified by:

ofSystemRoot in interface PreferencesConfigInitialBuilder

Returns:

Next builder, for method chaining.

See Also:

• Preferences.systemRoot()

ofSystem

@NotNull
public @NotNull PreferencesConfigBuilder ofSystem(@NotNull
 @NotNull String path)

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

Specified by:

ofSystem in interface PreferencesConfigInitialBuilder

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

@NotNull
public @NotNull PreferencesConfigBuilder ofSystem(@NotNull
 @NotNull Class<?> clazz)

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

Specified by:

ofSystem in interface PreferencesConfigInitialBuilder

Parameters:

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

Returns:

Next builder, for method chaining.

See Also:

• Preferences.systemNodeForPackage(Class)

ofSystem

@NotNull
public @NotNull PreferencesConfigBuilder ofSystem(@NotNull
 @NotNull Class<?> clazz,
 @NotNull
 @NotNull 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.

Specified by:

ofSystem in interface PreferencesConfigInitialBuilder

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

@NotNull
public @NotNull PreferencesConfigBuilder ofNode(@NotNull
 @NotNull Preferences preferences)

Selects the specified preferences node.

Specified by:

ofNode in interface PreferencesConfigInitialBuilder

Parameters:

preferences - The Preferences node to use.

Returns:

Next builder, for method chaining.

mutable

@NotNull
public @NotNull PreferencesMutableConfigBuilder mutable()

Makes the configuration instance mutable.

Specified by:

mutable in interface MutableCapableConfigBuilder<PreferencesConfigBuilder>

Specified by:

mutable in interface PreferencesConfigBuilder

Returns:

This instance, for method chaining.

build

@NotNull
public @NotNull PreferencesConfigImpl build()

Creates the configuration instance.

Specified by:

build in interface ConfigBuilder<PreferencesConfigBuilder>

Returns:

The configuration instance.