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:

  • Method Details

    • ofUserRoot

      @NotNull @NotNull PreferencesConfigBuilder ofUserRoot()
      Selects the user preferences tree root node.
      Returns:
      Next builder, for method chaining.
      See Also:

    • ofUser

      @NotNull @NotNull PreferencesConfigBuilder ofUser(@NotNull @NotNull 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:

    • ofUser

      @NotNull @NotNull PreferencesConfigBuilder ofUser(@NotNull @NotNull 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:

    • ofUser

      @NotNull @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.
      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:

    • ofSystemRoot

      @NotNull @NotNull PreferencesConfigBuilder ofSystemRoot()
      Selects the system preferences tree root node.
      Returns:
      Next builder, for method chaining.
      See Also:

    • ofSystem

      @NotNull @NotNull PreferencesConfigBuilder ofSystem(@NotNull @NotNull 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:

    • ofSystem

      @NotNull @NotNull PreferencesConfigBuilder ofSystem(@NotNull @NotNull 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:

    • ofSystem

      @NotNull @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.
      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:

    • ofNode

      @NotNull @NotNull PreferencesConfigBuilder ofNode(@NotNull @NotNull Preferences preferences)
      Selects the specified preferences node.
      Parameters:
      preferences - The Preferences node to use.
      Returns:
      Next builder, for method chaining.