Module dev.orne.config
Package dev.orne.config

Interface JsonConfigBaseBuilder<S extends JsonConfigBaseBuilder<S>>

Type Parameters:
S - The concrete type of the builder.
All Superinterfaces:
ConfigBuilder<S>
All Known Subinterfaces:
JsonConfigBuilder, JsonMutableConfigBuilder
All Known Implementing Classes:
JsonConfigBuilderImpl, JsonMutableConfigBuilderImpl
@API(status=STABLE, since="1.0") public interface JsonConfigBaseBuilder<S extends JsonConfigBaseBuilder<S>> extends ConfigBuilder<S>
JSON files based configuration base builder.
Since:
1.0
Version:
1.0, 2025-07
Author:
(w) Iker Hernaez
See Also:

  • Field Details

    • DEFAULT_SEPARATOR

      static final String DEFAULT_SEPARATOR
      The default configuration nested properties separator.
      See Also:

  • Method Details

    • withSeparator

      @NotNull S withSeparator(@NotEmpty @NotEmpty String separator)
      Sets the configuration nested properties separator.
      Parameters:
      separator - The configuration nested properties separator.
      Returns:
      This instance, for method chaining.

    • add

      @NotNull S add(@NotNull @NotNull Map<String,String> values)
      Adds the specified custom properties to the configuration properties.

      Note that property keys will be processed with the configured nested properties separator.

      Parameters:
      values - The configuration properties.
      Returns:
      This instance, for method chaining.

    • load

      @NotNull S load(@NotNull @NotNull String path)
      Loads the configuration properties from the specified ClassLoader resource.
      Parameters:
      path - The ClassLoader resource path.
      Returns:
      This instance, for method chaining.

    • load

      @NotNull S load(@NotNull @NotNull Path path)
      Loads the configuration properties from the file in the specified path.
      Parameters:
      path - The file path.
      Returns:
      This instance, for method chaining.

    • load

      @NotNull S load(@NotNull @NotNull File file)
      Loads the configuration properties from the specified file.
      Parameters:
      file - The file to load.
      Returns:
      This instance, for method chaining.

    • load

      @NotNull S load(@NotNull @NotNull URL url)
      Loads the configuration properties from the specified URL.
      Parameters:
      url - The URL to load.
      Returns:
      This instance, for method chaining.