Class AbstractConfigSourceBuilder<B extends AbstractConfigSourceBuilder<B,U>, U>

java.lang.Object
io.helidon.config.AbstractSourceBuilder<B,U>
io.helidon.config.AbstractConfigSourceBuilder<B,U>
Type Parameters:
B - Type of the builder implementation
U - Type of a target if this builder supports change watching, use Void if not
All Implemented Interfaces:
Source.Builder<B>
Direct Known Subclasses:
ClasspathConfigSource.Builder, DirectoryConfigSource.Builder, FileConfigSource.Builder, MapConfigSource.MapBuilder, UrlConfigSource.Builder
public abstract class AbstractConfigSourceBuilder<B extends AbstractConfigSourceBuilder<B,U>, U> extends AbstractSourceBuilder<B,U> implements Source.Builder<B>
Common ancestor for config source builders, taking care of configurable options understood by the config module.

  • Constructor Details

    • AbstractConfigSourceBuilder

      protected AbstractConfigSourceBuilder()
      There is no side effect.

  • Method Details

    • config

      protected B config(Config metaConfig)
      Configure builder from meta configuration.

      The following configuration options are supported:

      Optional configuration parameters
      key default value description
      optional false Configure to true if this source should not fail configuration setup when underlying data is missing.
      polling-strategy No polling strategy is added by default Meta configuration of a polling strategy to be used with this source, add configuration to properties sub node.
      change-watcher No change watcher is added by default Meta configuration of a change watcher to be used with this source, add configuration to properties sub node.
      retry-policy No retry policy is added by default Meta configuration of a retry policy to be used to load this source, add configuration to properties sub node.
      Media type and type mapping
      media-type Media type from loaded data is used by default for parsable config sources Explicit media type to use, such as when a file has invalid suffix, or when we need to explicitly mark the media type.
      media-type-mapping No media type mapping is done by default A mapping of key to a media type, allowing us to have a key that contains a sub-tree (e.g. a key that contains json data) - when we configure a mapping of the key to application/json, the data would be expanded into config as a proper tree structure
      Overrides:
      config in class AbstractSourceBuilder<B extends AbstractConfigSourceBuilder<B,U>, U>
      Parameters:
      metaConfig - meta configuration of this source
      Returns:
      updated builder instance

    • mediaTypeMapping

      public B mediaTypeMapping(Function<Config.Key, Optional<MediaType>> mediaTypeMapping)
      Sets a function that maps keys to media type. This supports parsing of values using a ConfigParser to expand an inlined configuration.
      Parameters:
      mediaTypeMapping - a mapping function
      Returns:
      a modified builder

    • parserMapping

      public B parserMapping(Function<Config.Key, Optional<ConfigParser>> parserMapping)
      Sets a function that maps keys to a parser. This supports parsing of specific values using a custom parser to expand an inlined configuration.
      Parameters:
      parserMapping - a mapping function
      Returns:
      a modified builder

    • parser

      protected B parser(ConfigParser parser)
      A parser if this is a ParsableSource and explicit parser is configured.
      Parameters:
      parser - parser configured for this source
      Returns:
      updated builder instance

    • mediaType

      protected B mediaType(MediaType mediaType)
      Media type if this is a ParsableSource and explicit media type is configured.
      Parameters:
      mediaType - media type configured for this source
      Returns:
      updated builder instance