Module org.github.gestalt.core

Package org.github.gestalt.config.builder

Class SourceBuilder<SELF extends SourceBuilder<SELF,T>,T extends ConfigSource>

java.lang.Object

org.github.gestalt.config.builder.SourceBuilder<SELF,T>

Direct Known Subclasses:

ClassPathConfigSourceBuilder, EnvironmentConfigSourceBuilder, FileConfigSourceBuilder, KubernetesSecretConfigSourceBuilder, MapConfigSourceBuilder, StringConfigSourceBuilder, SystemPropertiesConfigSourceBuilder, URLConfigSourceBuilder

public abstract class SourceBuilder<SELF extends SourceBuilder<SELF,T>,T extends ConfigSource>
extends java.lang.Object

Base class for all source builders.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<ConfigReloadStrategy>	configReloadStrategies
protected ConfigSource	source
protected Tags	tags

Constructor Summary

Constructors

Constructor	Description
SourceBuilder()

Method Summary

Modifier and Type	Method	Description
SELF	addConfigReloadStrategy(ConfigReloadStrategy configReloadStrategy)	Add a ConfigReloadStrategyBuilder to the builder.
SELF	addTag(Tag tag)	Add a tag to the builder.
abstract ConfigSourcePackage	build()	Build the ConfigSourcePackage with the config source, tags and any reload strategies.
protected ConfigSourcePackage	buildPackage(ConfigSource source)
java.util.List<ConfigReloadStrategy>	getConfigReloadStrategies()	Get the list of ConfigReloadStrategyBuilder for the builder.
Tags	getTags()	Get the tags for the builder.
protected SELF	self()
SELF	setTags(Tags tags)	Set the tags for the builder.

Methods inherited from class java.lang.Object

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

Field Detail

configReloadStrategies

protected final java.util.List<ConfigReloadStrategy> configReloadStrategies

source

protected ConfigSource source

tags

protected Tags tags

Constructor Detail

SourceBuilder

public SourceBuilder()

Method Detail

getTags

public Tags getTags()

Get the tags for the builder.

Returns:

the tags for the builder

setTags

public SELF setTags(Tags tags)

Set the tags for the builder.

Parameters:

tags - the tags for the builder.

Returns:

the builder

addTag

public SELF addTag(Tag tag)

Add a tag to the builder.

Parameters:

tag - tag to add to the builder

Returns:

the builder

getConfigReloadStrategies

public java.util.List<ConfigReloadStrategy> getConfigReloadStrategies()

Get the list of ConfigReloadStrategyBuilder for the builder.

Returns:

list of ConfigReloadStrategyBuilder for the builder.

addConfigReloadStrategy

public SELF addConfigReloadStrategy(ConfigReloadStrategy configReloadStrategy)

Add a ConfigReloadStrategyBuilder to the builder.

Parameters:

configReloadStrategy - ConfigReloadStrategyBuilder to add to the builder

Returns:

the builder

build

public abstract ConfigSourcePackage build()
                                   throws GestaltException

Build the ConfigSourcePackage with the config source, tags and any reload strategies.

Returns:

the ConfigSourcePackage with the config source, tags and any reload strategies.

Throws:

GestaltException - exceptions if any of the required properties are not set.

buildPackage

protected ConfigSourcePackage buildPackage(ConfigSource source)
                                    throws GestaltException

Throws:

GestaltException

self

protected final SELF self()