org.apache.tamaya.spi

Interface ConfigurationContextBuilder

public interface ConfigurationContextBuilder

A builder for creating new or adapting instances of ConfigurationContext. Builders can be obtained in exactly two ways:

1. By accessing a preinitialized builder from an existing ConfigurationContext, by calling ConfigurationContext.toBuilder().
2. By accessing an empty builder instance from ConfigurationProvider.getConfigurationContextBuilder().

After all changes are applied to a builder a new ConfigurationContext instance can be created and can be applied by calling ConfigurationProvider.setConfigurationContext(org.apache.tamaya.spi.ConfigurationContext).

Method Summary

Methods

Modifier and Type	Method and Description
<T> ConfigurationContextBuilder	addPropertyConverter(TypeLiteral<T> typeToConvert, PropertyConverter<T> propertyConverter) This method can be used for programmatically adding PropertyConverters.
ConfigurationContextBuilder	addPropertyFilters(Collection<PropertyFilter> filters) Adds the given PropertyFilter instances.
ConfigurationContextBuilder	addPropertyFilters(PropertyFilter... filters) Adds the given PropertyFilter instances.
ConfigurationContextBuilder	addPropertySources(Collection<PropertySource> propertySourcesToAdd) This method can be used for programmatically adding PropertySources.
ConfigurationContextBuilder	addPropertySources(PropertySource... propertySourcesToAdd) This method can be used for programmatically adding PropertySources.
ConfigurationContext	build() Builds a ConfigurationContext based on the data set.
ConfigurationContextBuilder	removePropertyConverters(TypeLiteral<?> typeToConvert, Collection<PropertyConverter<?>> converters) Removes the given PropertyConverter instances.
ConfigurationContextBuilder	removePropertyConverters(TypeLiteral<?> typeToConvert, PropertyConverter<?>... converters) Removes the given PropertyConverter instances.
ConfigurationContextBuilder	removePropertyFilters(Collection<PropertyFilter> filters) Removes the given PropertyFilter instances.
ConfigurationContextBuilder	removePropertyFilters(PropertyFilter... filters) Removes the given PropertyFilter instances.
ConfigurationContextBuilder	removePropertySources(Collection<String> propertySourcesNames) This method can be used for programmatically adding PropertySources.
ConfigurationContextBuilder	removePropertySources(String... propertySourcesNames) This method can be used for programmatically adding PropertySources.
ConfigurationContextBuilder	setContext(ConfigurationContext context) Init this builder instance with the given ConfigurationContext instance.
ConfigurationContextBuilder	setPropertyValueCombinationPolicy(PropertyValueCombinationPolicy policy) Sets the PropertyValueCombinationPolicy used to evaluate the final property values.

Method Detail

setContext

ConfigurationContextBuilder setContext(ConfigurationContext context)

Init this builder instance with the given ConfigurationContext instance. This method will replace any existing data in the current builder with the data contained in the given ConfigurationContext.

Parameters:

context - the ConfigurationContext instance to be used, not null.

Returns:

this builder, for chaining, never null.

addPropertySources

ConfigurationContextBuilder addPropertySources(PropertySource... propertySourcesToAdd)

This method can be used for programmatically adding PropertySources. It is not needed for normal 'usage' by end users, but only for Extension Developers!

Parameters:

propertySourcesToAdd - the PropertySources to add

Returns:

this builder, for chaining, never null.

addPropertySources

ConfigurationContextBuilder addPropertySources(Collection<PropertySource> propertySourcesToAdd)

This method can be used for programmatically adding PropertySources. It is not needed for normal 'usage' by end users, but only for Extension Developers!

Parameters:

propertySourcesToAdd - the PropertySources to add

Returns:

this builder, for chaining, never null.

removePropertySources

ConfigurationContextBuilder removePropertySources(String... propertySourcesNames)

This method can be used for programmatically adding PropertySources. It is not needed for normal 'usage' by end users, but only for Extension Developers!

Parameters:

propertySourcesNames - the PropertySource names of the sources to remove

Returns:

this builder, for chaining, never null.

removePropertySources

ConfigurationContextBuilder removePropertySources(Collection<String> propertySourcesNames)

This method can be used for programmatically adding PropertySources. It is not needed for normal 'usage' by end users, but only for Extension Developers!

Parameters:

propertySourcesNames - the PropertySource names of the sources to remove

Returns:

this builder, for chaining, never null.

addPropertyFilters

ConfigurationContextBuilder addPropertyFilters(PropertyFilter... filters)

Adds the given PropertyFilter instances.

Parameters:

filters - the filters to add

Returns:

this builder, for chaining, never null.

addPropertyFilters

ConfigurationContextBuilder addPropertyFilters(Collection<PropertyFilter> filters)

Adds the given PropertyFilter instances.

Parameters:

filters - the filters to add

Returns:

this builder, for chaining, never null.

removePropertyFilters

ConfigurationContextBuilder removePropertyFilters(PropertyFilter... filters)

Removes the given PropertyFilter instances.

Parameters:

filters - the filters to remove

Returns:

this builder, for chaining, never null.

removePropertyFilters

ConfigurationContextBuilder removePropertyFilters(Collection<PropertyFilter> filters)

Removes the given PropertyFilter instances.

Parameters:

filters - the filters to remove

Returns:

this builder, for chaining, never null.

addPropertyConverter

<T> ConfigurationContextBuilder addPropertyConverter(TypeLiteral<T> typeToConvert,
                                                   PropertyConverter<T> propertyConverter)

This method can be used for programmatically adding PropertyConverters. It is not needed for normal 'usage' by end users, but only for Extension Developers!

Type Parameters:

T - the type of the type literal

Parameters:

typeToConvert - the type for which the converter is for

propertyConverter - the PropertyConverters to add for this type

Returns:

this builder, for chaining, never null.

removePropertyConverters

ConfigurationContextBuilder removePropertyConverters(TypeLiteral<?> typeToConvert,
                                                   PropertyConverter<?>... converters)

Removes the given PropertyConverter instances.

Parameters:

typeToConvert - the type which the converter is for

converters - the converters to remove

Returns:

this builder, for chaining, never null.

removePropertyConverters

ConfigurationContextBuilder removePropertyConverters(TypeLiteral<?> typeToConvert,
                                                   Collection<PropertyConverter<?>> converters)

Removes the given PropertyConverter instances.

Parameters:

typeToConvert - the type which the converter is for

converters - the converters to remove

Returns:

this builder, for chaining, never null.

setPropertyValueCombinationPolicy

ConfigurationContextBuilder setPropertyValueCombinationPolicy(PropertyValueCombinationPolicy policy)

Sets the PropertyValueCombinationPolicy used to evaluate the final property values.

Parameters:

policy - the PropertyValueCombinationPolicy used, not null

Returns:

this builder, for chaining, never null.

build

ConfigurationContext build()

Builds a ConfigurationContext based on the data set.

Returns:

final context with the current builder's properties.