Interface Source

All Known Subinterfaces:

ConfigSource, NodeConfigSource, OverrideSource, ParsableSource

All Known Implementing Classes:

AbstractConfigSource, AbstractSource, ClasspathConfigSource, ClasspathOverrideSource, ConfigSources.SystemPropertiesConfigSource, DirectoryConfigSource, FileConfigSource, FileOverrideSource, InMemoryOverrideSource, MapConfigSource, PrefixedConfigSource, UrlConfigSource, UrlOverrideSource

public interface Source

Source of data. The actual loading of the data depends on the type of the source.

See Also:

• ParsableSource
• NodeConfigSource
• LazyConfigSource

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Source.Builder<B extends Source.Builder<B>>	Configurable options of a Source.

Method Summary

Modifier and Type	Method	Description
default String	description()	Short, human-readable summary referring to the underlying source.
default boolean	exists()	If the underlying data exist at this time.
default boolean	optional()	Whether this source is optional.
default Optional<RetryPolicy>	retryPolicy()	Retry policy configured on this config source.

Method Details

description

default String description()

Short, human-readable summary referring to the underlying source.

For example, a file path or a URL or any other information that helps the user recognize the underlying origin of the data this Source provides.

Default is the implementation class simple name with any "Source" suffix removed.

Returns:

description of the source

exists

default boolean exists()

If the underlying data exist at this time. This is to prevent us loading such a source if we know it does not exist.

Returns:

true if the source exists, false otherwise

retryPolicy

default Optional<RetryPolicy> retryPolicy()

Retry policy configured on this config source.

Returns:

configured retry policy

optional

default boolean optional()

Whether this source is optional.

Returns:

return true for optional source, returns false by default