Module io.helidon.config.yaml

Package io.helidon.config.yaml

Class YamlConfigParser

java.lang.Object

io.helidon.config.yaml.YamlConfigParser

All Implemented Interfaces:

ConfigParser

@Priority(200)
public class YamlConfigParser
extends Object
implements ConfigParser

YAML ConfigParser implementation that supports "application/x-yaml".

The parser implementation supports ServiceLoader, i.e. Config.Builder can automatically load and register YamlConfigParser instance, if not disabled. And of course it can be registered programmatically.

Priority of the YamlConfigParser to be used by Config.Builder, if loaded automatically as a service, is 200.

See Also:

Config.Builder.addParser(ConfigParser), Config.Builder.disableParserServices()

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.config.spi.ConfigParser

ConfigParser.Content

Field Summary

Fields

Modifier and Type	Field	Description
static String	MEDIA_TYPE_APPLICATION_YAML	A String constant representing "application/x-yaml" media type.
static int	PRIORITY	Priority of the parser used if registered by Config.Builder automatically.

Constructor Summary

Constructors

Constructor	Description
YamlConfigParser()	Deprecated. This method should not be directly used, use create()

Method Summary

Modifier and Type	Method	Description
static YamlConfigParser	create()	Create a new YAML Config Parser.
ConfigNode.ObjectNode	parse(ConfigParser.Content content)	Parses a specified ConfigContent into a hierarchical configuration representation.
Set<String>	supportedMediaTypes()	Returns set of supported media types by the parser.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MEDIA_TYPE_APPLICATION_YAML

public static final String MEDIA_TYPE_APPLICATION_YAML

A String constant representing "application/x-yaml" media type.

See Also:

Constant Field Values

PRIORITY

public static final int PRIORITY

Priority of the parser used if registered by Config.Builder automatically.

See Also:

Constant Field Values

Constructor Detail

YamlConfigParser

@Deprecated
public YamlConfigParser()

Deprecated.

This method should not be directly used, use create()

Default constructor needed by Java Service loader.

Method Detail

create

public static YamlConfigParser create()

Create a new YAML Config Parser.

Returns:

a new instance of parser for YAML

supportedMediaTypes

public Set<String> supportedMediaTypes()

Description copied from interface: ConfigParser

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).

Specified by:

supportedMediaTypes in interface ConfigParser

Returns:

supported media types by the parser

parse

public ConfigNode.ObjectNode parse(ConfigParser.Content content)
                            throws ConfigParserException

Description copied from interface: ConfigParser

Parses a specified ConfigContent into a hierarchical configuration representation.

Never returns null.

Specified by:

parse in interface ConfigParser

Parameters:

content - a content to be parsed

Returns:

parsed hierarchical configuration representation

Throws:

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