Class ClasspathOverrideSource

java.lang.Object

io.helidon.config.AbstractSource

io.helidon.config.ClasspathOverrideSource

All Implemented Interfaces:

OverrideSource, Source, Supplier<OverrideSource>

public class ClasspathOverrideSource
extends AbstractSource
implements OverrideSource

OverrideSource implementation that loads override definitions from a resource on a classpath.

See Also:

• Source.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ClasspathOverrideSource.Builder	Classpath OverrideSource Builder.

Nested classes/interfaces inherited from interface OverrideSource

OverrideSource.OverrideData

Modifier and Type	Interface	Description
static final class	OverrideSource.OverrideData	Group of config override settings.

Method Summary

Modifier and Type	Method	Description
static ClasspathOverrideSource.Builder	builder()	Create a new fluent API builder.
static ClasspathOverrideSource	create(Config config)	Create a new classpath override source from meta configuration, containing resource key and other options.
Optional<ConfigContent.OverrideContent>	load()	Load override data from the underlying source.
protected String	uid()	Returns universal id of source to be used to construct AbstractSource.description().

Methods inherited from class AbstractSource

changeWatcher, description, optional, pollingStrategy, retryPolicy

Modifier and Type	Method	Description
protected Optional<ChangeWatcher<Object>>	changeWatcher()	A change watcher of this source, if it implements WatchableSource and has one configured.
String	description()	Short, human-readable summary referring to the underlying source.
boolean	optional()	Whether this source is optional.
protected Optional<PollingStrategy>	pollingStrategy()	A polling strategy of this source, if it implements PollableSource and has one configured.
Optional<RetryPolicy>	retryPolicy()	Retry policy configured on this config source.

Methods inherited from class Object

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

Methods inherited from interface OverrideSource

get

Modifier and Type	Method	Description
default OverrideSource	get()

Methods inherited from interface Source

exists

Modifier and Type	Method	Description
default boolean	exists()	If the underlying data exist at this time.

Method Details

uid

protected String uid()

Description copied from class: AbstractSource

Returns universal id of source to be used to construct AbstractSource.description().

Overrides:

uid in class AbstractSource

Returns:

universal id of source

load

public Optional<ConfigContent.OverrideContent> load()
                                             throws ConfigException

Description copied from interface: OverrideSource

Load override data from the underlying source.

Specified by:

load in interface OverrideSource

Returns:

override data if present, empty otherwise

Throws:

ConfigException - in case the loading of data failed

create

public static ClasspathOverrideSource create(Config config)

Create a new classpath override source from meta configuration, containing resource key and other options.

Parameters:

config - meta configuration

Returns:

a new classpath override source

builder

public static ClasspathOverrideSource.Builder builder()

Create a new fluent API builder.

Returns:

a new builder