Module io.helidon.config

Package io.helidon.config

Class ConfigSources

java.lang.Object

io.helidon.config.ConfigSources

public final class ConfigSources
extends Object

Provides access to built-in ConfigSource implementations.

See Also:

• ConfigSource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ConfigSources.SystemPropertiesConfigSource	System properties config source.

Method Summary

Modifier and Type	Method	Description
static ClasspathConfigSource.Builder	classpath(String resource)	Provides a Builder for creating a ConfigSource from the specified resource located on the classpath of the current thread's context classloader.
static List<UrlConfigSource.Builder>	classpathAll(String resource)	Create builders for each instance of the resource on the current classpath.
static ConfigSource	create(Config config)	Returns a ConfigSource that contains the same configuration model as the provided config.
static NodeConfigSource	create(ConfigNode.ObjectNode objectNode)	Returns a ConfigSource that wraps the specified objectNode.
static ConfigSource	create(InputStream data, MediaType mediaType)	Provides a ConfigSource from the provided readable content and with the specified mediaType.
static ConfigSource	create(String content, MediaType mediaType)	Provides a ConfigSource from the provided String content and with the specified mediaType.
static MapConfigSource.Builder	create(Map<String,String> map)	Provides a MapConfigSource.Builder for creating a ConfigSource for a Map.
static MapConfigSource.Builder	create(Map<String,String> map, String name)	Provides a MapConfigSource.Builder for creating a ConfigSource for a Map.
static MapConfigSource.Builder	create(Properties properties)	Provides a MapConfigSource.Builder for creating a ConfigSource for a Map from a Properties object.
static MapConfigSource.Builder	create(Properties properties, String name)	Provides a MapConfigSource.Builder for creating a ConfigSource for a Map from a Properties object.
static DirectoryConfigSource.Builder	directory(String path)	Provides a Builder for creating a ConfigSource from the specified directory path.
static ConfigSource	empty()	Provides an empty config source.
static MapConfigSource	environmentVariables()	Provides a @{code ConfigSource} for creating a Config from environment variables.
static FileConfigSource.Builder	file(String path)	Provides a Builder for creating a ConfigSource from the specified file path.
static FileConfigSource.Builder	file(Path path)	Provides a Builder for creating a ConfigSource from the specified file path.
static ConfigSource	prefixed(String key, Supplier<? extends ConfigSource> sourceSupplier)	Provides a ConfigSource from a sourceSupplier, adding the specified prefix to the keys in the source.
static ConfigSources.SystemPropertiesConfigSource.Builder	systemProperties()	Provides a ConfigSource for creating a Config derived from system properties.
static UrlConfigSource.Builder	url(URL url)	Provides a Builder for creating a ConfigSource from the specified URL.

Methods inherited from class java.lang.Object

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

Method Details

empty

public static ConfigSource empty()

Provides an empty config source.

Returns:

empty config source

create

public static ConfigSource create(Config config)

Returns a ConfigSource that contains the same configuration model as the provided config.

Parameters:

config - the original Config

Returns:

ConfigSource for the same Config as the original

create

public static NodeConfigSource create(ConfigNode.ObjectNode objectNode)

Returns a ConfigSource that wraps the specified objectNode.

Parameters:

objectNode - hierarchical configuration representation that will be returned by the created config source

Returns:

new instance of ConfigSource

See Also:

• ConfigNode.ObjectNode
• ConfigNode.ListNode
• ConfigNode.ValueNode
• ConfigNode.ObjectNode.Builder
• ConfigNode.ListNode.Builder

create

public static ConfigSource create(InputStream data,
 MediaType mediaType)

Provides a ConfigSource from the provided readable content and with the specified mediaType.

Instant.now() is the content timestamp.

Parameters:

data - a InputStream providing the configuration content

mediaType - a configuration media type

Returns:

a config source

create

public static ConfigSource create(String content,
 MediaType mediaType)

Provides a ConfigSource from the provided String content and with the specified mediaType.

Instant.now() is the content timestamp.

Parameters:

content - a configuration content

mediaType - a configuration media type

Returns:

a config source

create

public static MapConfigSource.Builder create(Map<String,String> map)

Provides a MapConfigSource.Builder for creating a ConfigSource for a Map.

Parameters:

map - a map

Returns:

new Builder instance

See Also:

• create(Properties)

create

public static MapConfigSource.Builder create(Map<String,String> map,
 String name)

Provides a MapConfigSource.Builder for creating a ConfigSource for a Map.

Parameters:

map - a map

name - the name.

Returns:

new Builder instance

See Also:

• create(Properties)

create

public static MapConfigSource.Builder create(Properties properties)

Provides a MapConfigSource.Builder for creating a ConfigSource for a Map from a Properties object.

Parameters:

properties - properties

Returns:

new Builder instance

See Also:

• create(Map)

create

public static MapConfigSource.Builder create(Properties properties,
 String name)

Provides a MapConfigSource.Builder for creating a ConfigSource for a Map from a Properties object.

Parameters:

properties - properties

name - the name.

Returns:

new Builder instance

See Also:

• create(Map)

prefixed

public static ConfigSource prefixed(String key,
 Supplier<? extends ConfigSource> sourceSupplier)

Provides a ConfigSource from a sourceSupplier, adding the specified prefix to the keys in the source.

Parameters:

key - key prefix to be added to all keys

sourceSupplier - a config source supplier

Returns:

new @{code ConfigSource} for the newly-prefixed content

systemProperties

public static ConfigSources.SystemPropertiesConfigSource.Builder systemProperties()

Provides a ConfigSource for creating a Config derived from system properties.

Returns:

ConfigSource for config derived from system properties

environmentVariables

public static MapConfigSource environmentVariables()

Provides a @{code ConfigSource} for creating a Config from environment variables.

Returns:

ConfigSource for config derived from environment variables

classpath

public static ClasspathConfigSource.Builder classpath(String resource)

Provides a Builder for creating a ConfigSource from the specified resource located on the classpath of the current thread's context classloader.

The name of a resource is a '/'-separated full path name that identifies the resource. If the resource name has a leading slash then it is dropped before lookup.

Parameters:

resource - a name of the resource

Returns:

builder for a ConfigSource for the classpath-based resource

classpathAll

public static List<UrlConfigSource.Builder> classpathAll(String resource)

Create builders for each instance of the resource on the current classpath.

Parameters:

resource - resource to look for

Returns:

a list of classpath config source builders

file

public static FileConfigSource.Builder file(String path)

Provides a Builder for creating a ConfigSource from the specified file path.

Parameters:

path - a file path

Returns:

builder for the file-based ConfigSource

file

public static FileConfigSource.Builder file(Path path)

Provides a Builder for creating a ConfigSource from the specified file path.

Parameters:

path - a file path

Returns:

builder for the file-based ConfigSource

directory

public static DirectoryConfigSource.Builder directory(String path)

Provides a Builder for creating a ConfigSource from the specified directory path.

Parameters:

path - a directory path

Returns:

new Builder instance

url

public static UrlConfigSource.Builder url(URL url)

Provides a Builder for creating a ConfigSource from the specified URL.

Parameters:

url - a URL with configuration

Returns:

new Builder instance

See Also:

• url(URL)