Updated docs related to the (removed) builder module.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/c934f2f8 Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/c934f2f8 Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/c934f2f8 Branch: refs/heads/master Commit: c934f2f8697efbd4e0122bbd958342abaa351a93 Parents: 45cc779 Author: anatole <[email protected]> Authored: Tue Jan 24 21:27:07 2017 +0100 Committer: anatole <[email protected]> Committed: Tue Jan 24 21:27:07 2017 +0100 ---------------------------------------------------------------------- content/documentation/extensions.adoc | 2 + .../documentation/extensions/mod_builder.adoc | 86 -------------------- 2 files changed, 2 insertions(+), 86 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/c934f2f8/content/documentation/extensions.adoc ---------------------------------------------------------------------- diff --git a/content/documentation/extensions.adoc b/content/documentation/extensions.adoc index 20457ed..fb5a144 100644 --- a/content/documentation/extensions.adoc +++ b/content/documentation/extensions.adoc @@ -32,6 +32,8 @@ Mature extensions have a stable API and SPI, similar to the API and Implementati |+org.apache.tamaya.ext:tamaya-spring+ | Integration for Spring / Spring Boot. | link:extensions/mod_spring.html[Documentation] |======= +NOTE: The former Tamaya _Builder_ extension module has been removed. The corresponding methods were integrated into +Tamaya's main API's +ConfigurationContextBuilder+ API. === Extensions Sandbox http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/c934f2f8/content/documentation/extensions/mod_builder.adoc ---------------------------------------------------------------------- diff --git a/content/documentation/extensions/mod_builder.adoc b/content/documentation/extensions/mod_builder.adoc deleted file mode 100644 index 9766870..0000000 --- a/content/documentation/extensions/mod_builder.adoc +++ /dev/null @@ -1,86 +0,0 @@ -:jbake-type: page -:jbake-status: published - -= Apache Tamaya -- Extension: Builder - -[[BuilderCore]] -== Tamaya Builder (Extension Module) - -Tamaya _Builder_ is an extension module. Refer to the link:../extensions.html[extensions documentation] for further details. - -=== What functionality this module provides ? - -Tamaya _Builder_ provides a generic (one time) builder for creating +Configuration+ instances, -e.g. as follows: - -[source,java] ---------------------------------------------------------------- -ConfigurationBuilder builder = new ConfigurationBuilder(); -// do something -Configuration config = builder.build(); ---------------------------------------------------------------- - -Basically the builder allows to create configuration instances completely independent of the current configuration -setup. This gives you full control on the +Configuration+ setup. - -=== Compatibility - -The module is based on Java 7, so it will run on Java 7 and does -not require Java 8. The +ConfigurationProvider+ -as defined by the API, provides a builder instance for +ConfigurationContext+ -in a similar way. A +Configuration+ can also be created by passing an instance of a +ConfigurationContext+: - - -=== Installation - -To benefit from configuration builder support you only must add the corresponding -dependency to your module: - -[source,xml,subs="verbatim,attributes"] ------------------------------------------------ -<dependency> - <groupId>org.apache.tamaya.ext</groupId> - <artifactId>tamaya-builder</artifactId> - <version>{tamaya_version}</version> -</dependency> ------------------------------------------------ - -=== Supported Functionality - -The builder allows you to add +PropertySource+ instances: - -[source,java] ----------------------------------------------------------------- -ConfigurationBuilder builder = new ConfigurationBuilder(); -builder.addPropertySources(sourceOne).addPropertySources(sourceTwo); -Configuration config = builder.build(); ----------------------------------------------------------------- - -Similarly you can add filters: - -[source,java] ----------------------------------------------------------------- -builder.addPropertyFilters(new MyConfigFilter()); ----------------------------------------------------------------- - -...or +PropertySourceProvider+ instances: - -[source,java] ----------------------------------------------------------------- -builder.addPropertySourceProvider(new MyPropertySourceProvider()); ----------------------------------------------------------------- - -Also the builder module allows to include/exclude any filters and property source already known to the current -+ConfigurationContext+: - -[source,java] ----------------------------------------------------------------- -builder.disableProvidedPropertyConverters(); -builder.enableProvidedPropertyConverters(); - -builder.disableProvidedPropertyFilters(); -builder.enableProvidedPropertyFilters(); - -builder.disableProvidedPropertySources(); -builder.enableProvidedPropertySources(); -----------------------------------------------------------------
