Package io.helidon.config.spi

Interface ConfigParser

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.

See Also:

Config.Builder.addParser(ConfigParser), Source.load(), AbstractParsableConfigSource, ConfigParsers - access built-in implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ConfigParser.Content<S>	ConfigSource configuration Content to be parsed into hierarchical configuration representation.

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
java.util.Set<java.lang.String>	getSupportedMediaTypes()	Returns set of supported media types by the parser.
<S> ConfigNode.ObjectNode	parse(ConfigParser.Content<S> content)	Parses a specified ConfigParser.Content into a hierarchical configuration representation.

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

getSupportedMediaTypes

java.util.Set<java.lang.String> getSupportedMediaTypes()

Returns set of supported media types by the parser.

Set of supported media types is used while looking for appropriate parser by ConfigSource implementations.

ConfigSource implementations usually use Files.probeContentType(Path) method to guess source media type, if not explicitly set.

Returns:

supported media types by the parser

parse

<S> ConfigNode.ObjectNode parse(ConfigParser.Content<S> content)
                         throws ConfigParserException

Parses a specified ConfigParser.Content into a hierarchical configuration representation.

Never returns null.

Type Parameters:

S - a type of data stamp

Parameters:

content - a content to be parsed

Returns:

parsed hierarchical configuration representation

Throws:

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