Module io.helidon.config.hocon

Package io.helidon.config.hocon

Class HoconConfigParser

java.lang.Object

io.helidon.config.hocon.HoconConfigParser

All Implemented Interfaces:

ConfigParser

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

Typesafe (Lightbend) Config (HOCON) ConfigParser implementation that supports following media types: "application/hocon" and "application/json".

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

Priority of the HoconConfigParser 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_HOCON	A String constant representing "application/hocon" media type.
static String	MEDIA_TYPE_APPLICATION_JSON	A String constant representing "application/json" media type.
static int	PRIORITY	Priority of the parser used if registered by Config.Builder automatically.

Constructor Summary

Constructors

Constructor	Description
HoconConfigParser()	Deprecated. Use builder() to construct a customized instance, or create() to get an instance with defaults

Method Summary

Modifier and Type	Method	Description
static HoconConfigParserBuilder	builder()	Create a new fluent API builder for a HOCON config parser.
static HoconConfigParser	create()	Create a new instance of HOCON config parser using default configuration.
ConfigNode.ObjectNode	parse(ConfigParser.Content content)	Parses a specified ConfigContent into a hierarchical configuration representation.
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.
List<String>	supportedSuffixes()	Config parser can define supported file suffixes.

Methods inherited from class java.lang.Object

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

Field Detail

MEDIA_TYPE_APPLICATION_HOCON

public static final String MEDIA_TYPE_APPLICATION_HOCON

A String constant representing "application/hocon" media type.

See Also:

Constant Field Values

MEDIA_TYPE_APPLICATION_JSON

public static final String MEDIA_TYPE_APPLICATION_JSON

A String constant representing "application/json" 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

HoconConfigParser

@Deprecated
public HoconConfigParser()

Deprecated.

Use builder() to construct a customized instance, or create() to get an instance with defaults

To be used by Java Service Loader only!!!

Method Detail

create

public static HoconConfigParser create()

Create a new instance of HOCON config parser using default configuration.

Returns:

a new instance of parser

See Also:

builder()

builder

public static HoconConfigParserBuilder builder()

Create a new fluent API builder for a HOCON config parser.

Returns:

a new builder instance

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)

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

parse

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

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

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

Returns:

parsed hierarchical configuration representation

supportedSuffixes

public List<String> supportedSuffixes()

Description copied from interface: ConfigParser

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

Specified by:

supportedSuffixes in interface ConfigParser

Returns:

a set of file suffixes supported by this config parser.