Repository: incubator-tamaya-site Updated Branches: refs/heads/master 5cc9fccf2 -> 85d5c29ed
TAMAYA-318: Fix docs for spisupport 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/85d5c29e Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/85d5c29e Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/85d5c29e Branch: refs/heads/master Commit: 85d5c29edf633c80576b327289d26fcac10701ae Parents: 5cc9fcc Author: Phil Ottlinger <[email protected]> Authored: Mon Nov 20 21:43:59 2017 +0100 Committer: Phil Ottlinger <[email protected]> Committed: Mon Nov 20 21:43:59 2017 +0100 ---------------------------------------------------------------------- content/documentation/spisupport.adoc | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/85d5c29e/content/documentation/spisupport.adoc ---------------------------------------------------------------------- diff --git a/content/documentation/spisupport.adoc b/content/documentation/spisupport.adoc index b88eb78..e2fb1b0 100644 --- a/content/documentation/spisupport.adoc +++ b/content/documentation/spisupport.adoc @@ -9,12 +9,11 @@ toc::[] [[SPISupport]] == Tamaya SPI Support (Extension Module) -Tamaya _SPI Support_ is an core module only dependong on the API. It implements lots of API and SPI related -artifacts in portable way. Tamaya's core module reuses this functionality to build up a full fledged +Tamaya _SPI Support_ is a core module only depending on the API. It implements lots of API and SPI related +artifacts in a portable way. Tamaya's core module reuses this functionality to build up a fully fledged Tamaya API implementatation. - -=== What functionality this module provides ? +=== What functionality this module provide? Tamaya _SPI Support_ provides a few helpful base classes that can be used to implement aspects of Tamaya: @@ -23,14 +22,14 @@ Tamaya _SPI Support_ provides a few helpful base classes that can be used to imp +ConfigurationContext+ provided. This is also very useful for mocking configuration during test execution, but not only constraint to that use case. * +DefaultConfigurationContext+ provides you with a working implementation of the +ConfigurationContext+. -* Numerous *converters*, including an +EnumConverter+ is a converter implementation that can automatically select the currect enumeration values based +* Numerous *converters*, including an +EnumConverter+,that is a converter implementation that can automatically select the currect enumeration values based on a configured entry. * +MapPropertySource+ implements a property source based on +java.util.Map+. * +PriorityServiceComparator+ compares arbitrary services based on their +@Priority+ annotations (also handling the case, where no such annotation is present). * +PropertiesResourcePropertySource+ is an implementation of a +PropertySource+ based on a +Properties+ instance, - lodable from any +URL+. -+ +PropertyConverterManager+ is a service class very useful, when implementing instances of +ConfigurationContext+. + loadable from any +URL+. ++ +PropertyConverterManager+ is a useful service class, when implementing instances of +ConfigurationContext+. It manages registered instances of +PropertyConverter+ and provides easy to use type conversion logic. + +PropertyFiltering+ provides another helpful class that manages +PropertyFilter+ instances and provides an easy to use high level API. @@ -39,11 +38,10 @@ Tamaya _SPI Support_ provides a few helpful base classes that can be used to imp + The default configuration implementation also allows to replace the raw value evaluation logic using a +ConfigValueEvaluator+, similar to Tamaya's core implementation. -NOTE: It is highly recommended that you read also the link:../core.html[documentation] of Tamaya's - implementation core, since this describes the abstrations in use in more +NOTE: It is highly recommended that you also read the link:../core.html[documentation] of Tamaya's + core implementation, since this describes the abstrations in use in more detail. This module allows to reuse Tamaya's implementation artifacts but - still allow alternate implementations of the core API to be used. - + still allows alternate implementations of the core API to be used. === Compatibility @@ -52,7 +50,7 @@ The module is based on Java 8, so it will run on Java 8 and beyond. === Installation -To use Tamaya's _spisupport_ you only must add the corresponding dependency to your module: +To use Tamaya's _spisupport_ you only have to add the corresponding dependency to your module: [source, xml] ----------------------------------------------- @@ -63,6 +61,6 @@ To use Tamaya's _spisupport_ you only must add the corresponding dependency to y </dependency> ----------------------------------------------- -The component will not register any components but only providing portable base classes for some common SPI +The component will not register any components but only provides portable base classes for some common SPI implementation tasks. It only depends on the API, so it should be safely reusable also with other implementations -of the Tamaya API similarly. +of the Tamaya API as well.
