Module io.helidon.config

Package io.helidon.config.spi

Interface ConfigParser

All Known Implementing Classes:

HoconConfigParser, PropertiesConfigParser, YamlConfigParser

public interface ConfigParser

Transforms config ConfigParser.Content into a ConfigNode.ObjectNode that represents the original structure and values from the content.

The application can register parsers on a Builder using the Config.Builder.addParser(ConfigParser) method. The config system also locates parsers using the Java ServiceLoader mechanism and automatically adds them to every Builder unless the application disables this feature for a given Builder by invoking Config.Builder.disableParserServices().

A parser can specify a Priority. If no priority is explicitly assigned, the value of 100 is assumed.

Parser is used by the config system and a config source provides data as an input stream.

See Also:

Config.Builder.addParser(ConfigParser), ParsableSource, ConfigParsers - access built-in implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ConfigParser.Content	Config content to be parsed by a ConfigParser.

Field Summary

Fields

Modifier and Type	Field	Description
static int	PRIORITY	Default priority of the parser if registered by Config.Builder automatically.

Method Summary

Modifier and Type	Method	Description
ConfigNode.ObjectNode	parse(ConfigParser.Content content)	Deprecated. use parse(io.helidon.config.spi.ConfigParser.Content, java.util.function.Function) instead
default ConfigNode.ObjectNode	parse(ConfigParser.Content content, Function<String,Optional<InputStream>> relativeResolver)	Parses a specified ConfigContent into a hierarchical configuration representation.
Set<String>	supportedMediaTypes()	Returns set of supported media types by the parser.
default List<String>	supportedSuffixes()	Config parser can define supported file suffixes.

Field Detail

PRIORITY

static final int PRIORITY

Default priority of the parser if registered by Config.Builder automatically.

See Also:

Constant Field Values

Method Detail

supportedMediaTypes

Set<String> supportedMediaTypes()

Returns set of supported media types by the parser.

Set of supported media types is used when config system looks for appropriate parser based on media type of content.

ParsableSource implementations can use MediaTypes to probe for media type of content to provide it to config system through ConfigParser.Content.Builder.mediaType(String).

Returns:

supported media types by the parser

parse

@Deprecated
ConfigNode.ObjectNode parse(ConfigParser.Content content)
                     throws ConfigParserException

Deprecated.

use parse(io.helidon.config.spi.ConfigParser.Content, java.util.function.Function) instead

Parses a specified ConfigContent into a hierarchical configuration representation.

Never returns null.

Parameters:

content - a content to be parsed

Returns:

parsed hierarchical configuration representation

Throws:

ConfigParserException - in case of problem to parse configuration from the source

parse

default ConfigNode.ObjectNode parse(ConfigParser.Content content,
                                    Function<String,Optional<InputStream>> relativeResolver)

Parses a specified ConfigContent into a hierarchical configuration representation.

Never returns null.

Parameters:

content - a content to be parsed

relativeResolver - function to resolve relative resources to this resource (if supported by the source)

Returns:

parsed hierarchical configuration representation

Throws:

ConfigParserException - in case of problem to parse configuration from the source

supportedSuffixes

default List<String> supportedSuffixes()

Config parser can define supported file suffixes. If such are defined, Helidon will use these to discover default configuration sources. For example if there is a ConfigParser that returns xml, config would look for meta-config.xml to discover meta configuration, and for application.xml on file system and on classpath to discover configuration files.

Note that the suffixes must resolve into a media type supported by a config parser (see MediaTypes.detectExtensionType(String)).

Returns:

a set of file suffixes supported by this config parser.