Author: anatole Date: Tue Mar 3 11:07:15 2015 New Revision: 1663641 URL: http://svn.apache.org/r1663641 Log: Added/updated documentation.
Added: incubator/tamaya/site/trunk/content/documentation/index.html incubator/tamaya/site/trunk/content/documentation/injection.html incubator/tamaya/site/trunk/content/documentation/modules.html incubator/tamaya/site/trunk/content/documentation/requirements.html Modified: incubator/tamaya/site/trunk/content/documentation/API.html incubator/tamaya/site/trunk/content/documentation/Core.html Modified: incubator/tamaya/site/trunk/content/documentation/API.html URL: http://svn.apache.org/viewvc/incubator/tamaya/site/trunk/content/documentation/API.html?rev=1663641&r1=1663640&r2=1663641&view=diff ============================================================================== --- incubator/tamaya/site/trunk/content/documentation/API.html (original) +++ incubator/tamaya/site/trunk/content/documentation/API.html Tue Mar 3 11:07:15 2015 @@ -535,6 +535,7 @@ table.CodeRay td.code>pre{padding:0} <li><a href="#_adding_a_custom_configuration">3.3. Adding a Custom Configuration</a></li> </ul> </li> +<li><a href="#APIImpl">4. API Implementation</a></li> </ul> </div> </div> @@ -544,7 +545,7 @@ table.CodeRay td.code>pre{padding:0} <hr> <div style="page-break-after: always;"></div> <div class="paragraph"> -<p>→ add image : : <a href="https://raw.githubusercontent.com/JavaConfig/config-api/master/src/main/asciidoc/images/javaconfig.jpg" class="bare">https://raw.githubusercontent.com/JavaConfig/config-api/master/src/main/asciidoc/images/javaconfig.jpg</a></p> +<p>→ add image : : <a href="http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png" class="bare">http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png</a></p> </div> <!-- toc disabled --> <div style="page-break-after: always;"></div> @@ -1517,17 +1518,23 @@ Tamaya core module you just have to perf <pre class="CodeRay highlight"><code data-lang="listing">comp.mapackage.MyPropertySource</code></pre> </div> </div> -<div class="paragraph"> -<p>Basically thst’s all.</p> </div> </div> </div> +<div class="sect1"> +<h2 id="APIImpl">4. API Implementation</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The API is implemented by the Tamaya _Core_module. Refer to the <a href="Core.html">Core documentation</a> for +further details.</p> +</div> +</div> </div> </div> <div id="footer"> <div id="footer-text"> Version 0.1-SNAPSHOT<br> -Last updated 2015-03-02 22:18:21 MEZ +Last updated 2015-03-03 08:44:33 MEZ </div> </div> </body> Modified: incubator/tamaya/site/trunk/content/documentation/Core.html URL: http://svn.apache.org/viewvc/incubator/tamaya/site/trunk/content/documentation/Core.html?rev=1663641&r1=1663640&r2=1663641&view=diff ============================================================================== --- incubator/tamaya/site/trunk/content/documentation/Core.html (original) +++ incubator/tamaya/site/trunk/content/documentation/Core.html Tue Mar 3 11:07:15 2015 @@ -5,7 +5,8 @@ <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="generator" content="Asciidoctor 1.5.2"> -<title>Tamaya Core</title> +<meta name="author" content="Anatole Tresch"> +<title>Apache Tamaya Core</title> <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400"> <style> /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */ @@ -502,17 +503,58 @@ table.CodeRay td.code>pre{padding:0} </head> <body class="article"> <div id="header"> +<h1>Apache Tamaya — Core</h1> +<div class="details"> +<span id="author" class="author">Anatole Tresch</span><br> +<span id="email" class="email"><<a href="mailto:anat...@apache.org" title="Apache Tamaya Core">anat...@apache.org</a>></span><br> +<span id="revnumber">version 0.1.1,</span> +<span id="revdate">March 2015</span> +<br><span id="revremark">Incubator</span> +</div> +<div id="toc" class="toc"> +<div id="toctitle">Table of Contents</div> +<ul class="sectlevel1"> +<li><a href="#Core">Tamaya Core</a> +<ul class="sectlevel2"> +<li><a href="#_overview">Overview</a></li> +<li><a href="#CorePropertyConverters">Default PropertyConverters in Core</a></li> +<li><a href="#_registering_propertyconverters">Registering PropertyConverters</a></li> +<li><a href="#ComponentLoadingAndPriorization">Component Loading and Priorization</a></li> +<li><a href="#RegisteringPropertySources">Registering Property Sources</a></li> +</ul> +</li> +<li><a href="#CorePropertySources">Configuration Setup in Core</a> +<ul class="sectlevel2"> +<li><a href="#_overview_of_registered_default_property_sources_and_providers">Overview of Registered Default Property Sources and Providers</a></li> +<li><a href="#_abstract_class_propertiesfilepropertysource">Abstract Class PropertiesFilePropertySource</a></li> +<li><a href="#CorePropertySourceProviders">Default PropertySourceProvider in Core</a></li> +</ul> +</li> +<li><a href="#Extensions">Adding Extensions</a></li> +</ul> +</div> </div> <div id="content"> +<div id="preamble"> +<div class="sectionbody"> +<hr> +<div style="page-break-after: always;"></div> +<div class="paragraph"> +<p>→ add image : : <a href="http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png" class="bare">http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png</a></p> +</div> +<!-- toc disabled --> +<div style="page-break-after: always;"></div> <div style="page-break-after: always;"></div> +</div> +</div> <div class="sect1"> <h2 id="Core">Tamaya Core</h2> <div class="sectionbody"> <div class="sect2"> <h3 id="_overview">Overview</h3> <div class="paragraph"> -<p>Tamaya Core provides an implementation of the Tamaya Configuration API and adds additional functionality and -building blocks for supporting SPI implementations.</p> +<p>Tamaya Core provides an implementation of the <a href="API.html">Tamaya Configuration API</a> and adds additional functionality +and building blocks for supporting SPI implementations.</p> </div> <div class="paragraph"> <p>Tamaya Core contains the following artifacts:</p> @@ -520,59 +562,32 @@ building blocks for supporting SPI imple <div class="ulist"> <ul> <li> -<p>Implementations of Configuration, ConfigurationContext, ConfigurationContextBuilder ConfigurationProvider+</p> -</li> -<li> -<p>A ServiceLoader based ServiceContext implementation.</p> -</li> -<li> -<p>A PropertyConverterManager+ that loads and stores references to all the rconfigured PropertyConverter instances.</p> -</li> -<li> -<p>Default PropertySources for environment data.</p> -</li> -</ul> -</div> -<div class="paragraph"> -<p>All minimally required components are implemented and registered, so basically the RI is a complete configuration -solution. Nevertheless it is also very minimalistic:</p> -</div> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>It collects all PropertySource and PropertySourceProvider instances registered with the ServiceLoader and -registers them in the global ConfigurationContext</p> -</li> -<li> -<p>It provides a ConfigurationContextBuilder and allows changing the current ConfigurationContext.</p> +<p>Implementations of <code>Configuration, ConfigurationContext, ConfigurationContextBuilder</code> ConfigurationProviderSpi+</p> </li> <li> -<p>It provides PropertyConverter instances for the most commonly used types.</p> +<p>A <code>java.util.ServiceLoader</code> based <code>ServiceContext</code> implementation. Hereby it implements component priorization based +on the <code>@Priority</code> annotations.</p> </li> <li> -<p>It implements component priorization based on the @Priority annotations.</p> +<p>A PropertyConverterManager+ that loads and stores references to all the preconfigured <code>PropertyConverter</code> instances +hereby providing type conversion for all important types.</p> </li> <li> -<p>It provides default PropertySource implementations for</p> -<div class="olist loweralpha"> -<ol class="loweralpha" type="a"> -<li> -<p>Environment Properties</p> +<p>A simple default configuration setup using the current classpath and an optional staging variable.</p> </li> <li> -<p>System Properties</p> +<p>It collects all <code>PropertySource</code> and <code>PropertySourceProvider</code> instances registered with the <code>ServiceLoader</code> and +registers them in the global <code>ConfigurationContext</code></p> </li> <li> -<p>PropertySources based on Properties.</p> -</li> -</ol> -</div> +<p>It provides a <code>ConfigurationContextBuilder</code> and allows changing the current <code>ConfigurationContext</code>.</p> </li> -</ol> +</ul> </div> <div class="paragraph"> -<p>The overall size of the library is very small. Nevertheless it is flexible enough to be extended with additional -features as needed, such as</p> +<p>The overall size of the library is very small. All required components are implemented and registered, so basically the +Core module is a complete configuration solution. Nevertheless it is also very minimalistic, but fortunately is flexible +enough to be extended/accommodated with additional features as needed, such as</p> </div> <div class="ulist"> <ul> @@ -609,13 +624,14 @@ features as needed, such as</p> </ul> </div> <div class="paragraph"> -<p>For details about the extension modules available and their functionality refer to the extension user guide.</p> +<p>For details about the extension modules available and their functionality refer to the <a href="modules.html">extension user guide</a>.</p> </div> </div> <div class="sect2"> <h3 id="CorePropertyConverters">Default PropertyConverters in Core</h3> <div class="paragraph"> -<p>As said the <em>Core</em> module delivers several default PropertyConverter instances out of the box:</p> +<p>As mentioned the Core module delivers several default <code>PropertyConverter</code> instances out of the box. Find below the +listing of converters automatically registered with the Core module:</p> </div> <table class="tableblock frame-1 grid-all spread"> <colgroup> @@ -654,7 +670,7 @@ features as needed, such as</p> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">java.lang.Character</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">CharConverter</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">0xFF, 'a', 'H', 123</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">0xFF, <em>a</em>, <em>H</em>, 123</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">java.lang.Class</p></td> @@ -737,33 +753,44 @@ features as needed, such as</p> <div class="sect2"> <h3 id="_registering_propertyconverters">Registering PropertyConverters</h3> <div class="paragraph"> -<p>Additional PropertyConverters can be implemented easily. It is recommended to register then using the ServiceLoader, -menaing you add a file under META-INF/service/org.apache.tamaya.spi.PropertyConverter containing the fully qualified +<p>Additional <code>PropertyConverters</code> can be implemented easily. It is recommended to register then using the <code>java.util.ServiceLoader</code>, +meaning you add a file under <code>META-INF/service/org.apache.tamaya.spi.PropertyConverter</code> containing the fully qualified class names of the converters to be registered (one line per each).</p> </div> <div class="paragraph"> -<p>Alternatively you can also use a ConfigurationContextBuilder to add additional converters programmatically, Note -hereby that implementations can be read-only thus not allowing adding additional converters programmatically.</p> +<p>Alternatively you can also use a <code>ConfigurationContextBuilder</code> to add additional converters programmatically.</p> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<img src="data:image/png:base64," alt="Note"> +</td> +<td class="content"> +API Implementations can be read-only thus not allowing adding additional converters programmatically. +</td> +</tr> +</table> </div> </div> <div class="sect2"> -<h3 id="ComponentPriorization">Component Loading and Priorization</h3> +<h3 id="ComponentLoadingAndPriorization">Component Loading and Priorization</h3> <div class="paragraph"> -<p>Tamaya Core in general loads all components using the ServiceLoader mechanism. This means that new components -must be registered by adding a file under META-INF/service/<myInterfaceName> containing the fully qualified +<p>Tamaya Core in general loads all components using the <code>java.util.ServiceLoader</code> mechanism. This means that new components +must be registered by adding a file under <code>META-INF/service/<myInterfaceName></code> containing the fully qualified implementation class names of the components to be registered (one line per each). -The ServiceLoader itself does not provide any functionality for overriding or ordering of components. Tamaya -core adds this functionality by the possibility to add @Priority annotations to the components registered. -By default, and if no annotation is added 0 is used as priority. Hereby higher values preceed lower values, meaning</p> +The <code>ServiceLoader</code> itself does not provide any functionality for overriding or ordering of components. Tamaya +core adds this functionality by the possibility to add <code>@Priority</code> annotations to the components registered. +By default, and if no annotation is added <code>0</code> is used as priority. Hereby higher values preceed lower values, meaning</p> </div> <div class="ulist"> <ul> <li> -<p>if a singleton component is accessed from the current ServiceContext the component with the higher value +<p>if a singleton component is accessed from the current <code>ServiceContext</code> the component with the higher value effectively <em>overrides/replaces</em> any component with lower values.</p> </li> <li> -<p>if a collection of components is obtained from the ServiceContext the components are ordered in order, where the +<p>if a collection of components is obtained from the <code>ServiceContext</code> the components are ordered in order, where the ones with higher priority are before components with lower priority.</p> </li> <li> @@ -777,8 +804,8 @@ still defined and predictable in almost <h3 id="RegisteringPropertySources">Registering Property Sources</h3> <div class="paragraph"> <p>PropertySources that provide configuration properties are registered as ordinary components as described in the previous -section. Nevertheless the priority is not managed based on @Priority annotations, but based on an explicit -int getOrdinal() method. This allows to define the ordinal/priority of a PropertySource explicitly. This is useful +section. Nevertheless the priority is not managed based on <code>@Priority</code> annotations, but based on an explicit +<code>int getOrdinal()</code> method. This allows to define the ordinal/priority of a <code>PropertySource</code> explicitly. This is useful due to several reasons:</p> </div> <div class="ulist"> @@ -793,24 +820,56 @@ whatever may be appropriate.</p> </li> </ul> </div> -<div class="admonitionblock note"> -<table> -<tr> -<td class="icon"> -<div class="title">Note</div> -</td> -<td class="content"> -TODO Discuss the defaults provided by core! -</td> -</tr> -</table> </div> </div> +</div> +<div class="sect1"> +<h2 id="CorePropertySources">Configuration Setup in Core</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>Tamaya Core provides a minimal, but already powerful configuration setting, that allows you to configure SE +applications already easily. Basically you can provide configuration properties using the following formats and +locations (from weakest to strongest):</p> +</div> +<div class="olist arabic"> +<ol class="arabic"> +<li> +<p>Read environment properties and add them prefixed with <code>env.</code></p> +</li> +<li> +<p>Read all files found in <code>META-INF/cfg/defaults.properties</code></p> +</li> +<li> +<p>Read all files found in <code>META-INF/cfg/${tamaya.stage}/defaults.properties</code></p> +</li> +<li> +<p>Read all files found in <code>META-INF/cfg/config.properties</code></p> +</li> +<li> +<p>Read all files found in <code>META-INF/cfg/${tamaya.stage}/config.properties</code></p> +</li> +<li> +<p>Read current system properties.</p> +</li> +</ol> +</div> +<div class="paragraph"> +<p>Hereby <code>tamaya.stage</code> can be set by setting an according environment property, or by applying (overriding any environment +property) a corresponding system property:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="listing">-Dtamaya.stage=test</code></pre> +</div> +</div> +<div class="paragraph"> +<p>If not set the staging locations will be ignored.</p> +</div> <div class="sect2"> -<h3 id="CorePropertySources">Default PropertySources in Core</h3> +<h3 id="_overview_of_registered_default_property_sources_and_providers">Overview of Registered Default Property Sources and Providers</h3> <div class="paragraph"> -<p>The Tamaya Core implementation provides a couple of default PropertySource implementations, which are automatically -registered. They are all in the package org.apache.tamaya.core.propertysource:</p> +<p>The Tamaya Core implementation provides a couple of default <code>PropertySource</code> implementations, which are automatically +registered. They are all in the package <code>org.apache.tamaya.core.propertysource</code>:</p> </div> <table class="tableblock frame-1 grid-all spread"> <colgroup> @@ -854,15 +913,15 @@ registered. They are all in the package </tbody> </table> <div class="paragraph"> -<p>There is also a class DefaultOrdinal, which defines several default ordinals. Beside the ordinals for system +<p>There is also a class <code>DefaultOrdinal</code>, which defines several default ordinals. Beside the ordinals for system and environment properties above, there may additional default ordinals defined in the future.</p> </div> </div> <div class="sect2"> <h3 id="_abstract_class_propertiesfilepropertysource">Abstract Class PropertiesFilePropertySource</h3> <div class="paragraph"> -<p>The abstract class PropertiesFilePropertySource can be used for implementing a PropertySource based on a URL -instance that points to a .properites file. It requires a URL to be passed on the constructor:</p> +<p>The abstract class <code>PropertiesFilePropertySource</code> can be used for implementing a <code>PropertySource</code> based on a <code>URL</code> +instance that points to a <code>.properites</code> file. It requires a <code>URL</code> to be passed on the constructor:</p> </div> <div class="listingblock"> <div class="content"> @@ -872,8 +931,8 @@ instance that points to a .properites fi <div class="sect3"> <h4 id="_abstract_class_propertiespropertysource">Abstract Class PropertiesPropertySource</h4> <div class="paragraph"> -<p>The abstract class PropertiesPropertySource can be used for implementing a PropertySource based on a Properties -instance. It requires a PropertySource to be passed on the constructor:</p> +<p>The abstract class <code>PropertiesPropertySource</code> can be used for implementing a <code>PropertySource</code> based on a <code>Properties</code> +instance. It requires a <code>PropertySource</code> to be passed on the constructor:</p> </div> <div class="listingblock"> <div class="content"> @@ -884,7 +943,7 @@ instance. It requires a PropertySource t <div class="sect3"> <h4 id="_abstract_class_basepropertysource">Abstract Class BasePropertySource</h4> <div class="paragraph"> -<p>The abstract class BasePropertySource can be used for implementing custom PropertySource classes. It requires only +<p>The abstract class <code>BasePropertySource</code> can be used for implementing custom <code>PropertySource</code> classes. It requires only one method to implemented:</p> </div> <div class="listingblock"> @@ -908,25 +967,39 @@ one method to implemented:</p> </div> </div> <div class="paragraph"> -<p>By default the ordinal of the property sources will be 1000, unless the key tamaya.ordinal asdefined in -PropertySource.TAMAYA_ORDINAL is present in the current PropertySource. Of course it is also possible to override -the inherited protected void initializeOrdinal(final int defaultOrdinal), or directly int getOrdinal().</p> +<p>By default the ordinal of the property sources will be 1000, unless the key <code>tamaya.ordinal</code> asdefined in +<code>PropertySource.TAMAYA_ORDINAL</code> is present in the current <code>PropertySource</code>. Of course it is also possible to override +the inherited <code>protected void initializeOrdinal(final int defaultOrdinal)</code>, or directly <code>int getOrdinal()</code>.</p> </div> </div> </div> <div class="sect2"> <h3 id="CorePropertySourceProviders">Default PropertySourceProvider in Core</h3> <div class="paragraph"> -<p>With org.apache.tamaya.core.provider.JavaConfigurationProvider there is also a default PropertySourceProvider -present that loads all .properties files found at META-INF/javaconfiguration.properties.</p> +<p>With <code>org.apache.tamaya.core.provider.JavaConfigurationProvider</code> there is also a default <code>PropertySourceProvider</code> +present that loads all .properties files found at <code>META-INF/javaconfiguration.properties</code>.</p> +</div> +</div> +</div> </div> +<div class="sect1"> +<h2 id="Extensions">Adding Extensions</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>The Core module only implements the <a href="API.html">API</a>. Many users require/wish additional functionality from a +configuration system. Fortunately there are numerous extensions available, that add different functionality. +Loading extensions hereby is trivial: you only are required to add the corresponding dependency to the classpath.</p> +</div> +<div class="paragraph"> +<p>For detailed information on the extensions available refer to the <a href="modules.html">extensions documentation</a>.</p> </div> </div> </div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2015-02-28 22:08:52 MEZ +Version 0.1.1<br> +Last updated 2015-03-03 09:31:17 MEZ </div> </div> </body> Added: incubator/tamaya/site/trunk/content/documentation/index.html URL: http://svn.apache.org/viewvc/incubator/tamaya/site/trunk/content/documentation/index.html?rev=1663641&view=auto ============================================================================== --- incubator/tamaya/site/trunk/content/documentation/index.html (added) +++ incubator/tamaya/site/trunk/content/documentation/index.html Tue Mar 3 11:07:15 2015 @@ -0,0 +1,791 @@ +<!DOCTYPE html> +<html lang="en"> +<head> +<meta charset="UTF-8"> +<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<meta name="generator" content="Asciidoctor 1.5.2"> +<meta name="author" content="Anatole Tresch"> +<title>Apache Tamaya</title> +<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400"> +<style> +/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */ +/* Remove the comments around the @import statement below when using this as a custom stylesheet */ +/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400";*/ +article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block} +audio,canvas,video{display:inline-block} +audio:not([controls]){display:none;height:0} +[hidden],template{display:none} +script{display:none!important} +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} +body{margin:0} +a{background:transparent} +a:focus{outline:thin dotted} +a:active,a:hover{outline:0} +h1{font-size:2em;margin:.67em 0} +abbr[title]{border-bottom:1px dotted} +b,strong{font-weight:bold} +dfn{font-style:italic} +hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0} +mark{background:#ff0;color:#000} +code,kbd,pre,samp{font-family:monospace;font-size:1em} +pre{white-space:pre-wrap} +q{quotes:"\201C" "\201D" "\2018" "\2019"} +small{font-size:80%} +sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} +sup{top:-.5em} +sub{bottom:-.25em} +img{border:0} +svg:not(:root){overflow:hidden} +figure{margin:0} +fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} +legend{border:0;padding:0} +button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} +button,input{line-height:normal} +button,select{text-transform:none} +button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer} +button[disabled],html input[disabled]{cursor:default} +input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0} +input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box} +input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none} +button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} +textarea{overflow:auto;vertical-align:top} +table{border-collapse:collapse;border-spacing:0} +*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box} +html,body{font-size:100%} +body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto} +a:hover{cursor:pointer} +img,object,embed{max-width:100%;height:auto} +object,embed{height:100%} +img{-ms-interpolation-mode:bicubic} +#map_canvas img,#map_canvas embed,#map_canvas object,.map_canvas img,.map_canvas embed,.map_canvas object{max-width:none!important} +.left{float:left!important} +.right{float:right!important} +.text-left{text-align:left!important} +.text-right{text-align:right!important} +.text-center{text-align:center!important} +.text-justify{text-align:justify!important} +.hide{display:none} +.antialiased,body{-webkit-font-smoothing:antialiased} +img{display:inline-block;vertical-align:middle} +textarea{height:auto;min-height:50px} +select{width:100%} +p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6} +.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} +div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr} +a{color:#2156a5;text-decoration:underline;line-height:inherit} +a:hover,a:focus{color:#1d4b8f} +a img{border:none} +p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} +p aside{font-size:.875em;line-height:1.35;font-style:italic} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} +h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} +h1{font-size:2.125em} +h2{font-size:1.6875em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} +h4,h5{font-size:1.125em} +h6{font-size:1em} +hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} +em,i{font-style:italic;line-height:inherit} +strong,b{font-weight:bold;line-height:inherit} +small{font-size:60%;line-height:inherit} +code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} +ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} +ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em} +ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} +ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} +ul.square{list-style-type:square} +ul.circle{list-style-type:circle} +ul.disc{list-style-type:disc} +ul.no-bullet{list-style:none} +ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} +dl dt{margin-bottom:.3125em;font-weight:bold} +dl dd{margin-bottom:1.25em} +abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} +abbr{text-transform:none} +blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} +blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} +blockquote cite:before{content:"\2014 \0020"} +blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} +blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} +@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} +h1{font-size:2.75em} +h2{font-size:2.3125em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} +h4{font-size:1.4375em}}table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} +table thead,table tfoot{background:#f7f8f7;font-weight:bold} +table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} +table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} +table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7} +table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} +h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} +.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table} +.clearfix:after,.float-group:after{clear:both} +*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed} +pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed} +.keyseq{color:rgba(51,51,51,.8)} +kbd{display:inline-block;color:rgba(0,0,0,.8);font-size:.75em;line-height:1.4;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:-.15em .15em 0 .15em;padding:.2em .6em .2em .5em;vertical-align:middle;white-space:nowrap} +.keyseq kbd:first-child{margin-left:0} +.keyseq kbd:last-child{margin-right:0} +.menuseq,.menu{color:rgba(0,0,0,.8)} +b.button:before,b.button:after{position:relative;top:-1px;font-weight:400} +b.button:before{content:"[";padding:0 3px 0 2px} +b.button:after{content:"]";padding:0 2px 0 3px} +p a>code:hover{color:rgba(0,0,0,.9)} +#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} +#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table} +#header:after,#content:after,#footnotes:after,#footer:after{clear:both} +#content{margin-top:1.25em} +#content:before{content:none} +#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} +#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8} +#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px} +#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap} +#header .details span:first-child{margin-left:-.125em} +#header .details span.email a{color:rgba(0,0,0,.85)} +#header .details br{display:none} +#header .details br+span:before{content:"\00a0\2013\00a0"} +#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} +#header .details br+span#revremark:before{content:"\00a0|\00a0"} +#header #revnumber{text-transform:capitalize} +#header #revnumber:after{content:"\00a0"} +#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} +#toc{border-bottom:1px solid #efefed;padding-bottom:.5em} +#toc>ul{margin-left:.125em} +#toc ul.sectlevel0>li>a{font-style:italic} +#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} +#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} +#toc a{text-decoration:none} +#toc a:active{text-decoration:underline} +#toctitle{color:#7a2518;font-size:1.2em} +@media only screen and (min-width:768px){#toctitle{font-size:1.375em} +body.toc2{padding-left:15em;padding-right:0} +#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} +#toc.toc2 #toctitle{margin-top:0;font-size:1.2em} +#toc.toc2>ul{font-size:.9em;margin-bottom:0} +#toc.toc2 ul ul{margin-left:0;padding-left:1em} +#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} +body.toc2.toc-right{padding-left:0;padding-right:15em} +body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} +#toc.toc2{width:20em} +#toc.toc2 #toctitle{font-size:1.375em} +#toc.toc2>ul{font-size:.95em} +#toc.toc2 ul ul{padding-left:1.25em} +body.toc2.toc-right{padding-left:0;padding-right:20em}}#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +#content #toc>:first-child{margin-top:0} +#content #toc>:last-child{margin-bottom:0} +#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em} +#footer-text{color:rgba(255,255,255,.8);line-height:1.44} +.sect1{padding-bottom:.625em} +@media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}.sect1+.sect1{border-top:1px solid #efefed} +#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} +#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} +#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} +#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none} +#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} +.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} +.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic} +table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0} +.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)} +table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit} +.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} +.admonitionblock>table td.icon{text-align:center;width:80px} +.admonitionblock>table td.icon img{max-width:none} +.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} +.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)} +.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} +.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px} +.exampleblock>.content>:first-child{margin-top:0} +.exampleblock>.content>:last-child{margin-bottom:0} +.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +.sidebarblock>:first-child{margin-top:0} +.sidebarblock>:last-child{margin-bottom:0} +.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} +.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} +.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8} +.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1} +.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em} +.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal} +@media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)} +.listingblock pre.highlightjs{padding:0} +.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} +.listingblock pre.prettyprint{border-width:0} +.listingblock>.content{position:relative} +.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999} +.listingblock:hover code[data-lang]:before{display:block} +.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999} +.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"} +table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none} +table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0} +table.pyhltable td.code{padding-left:.75em;padding-right:0} +pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8} +pre.pygments .lineno{display:inline-block;margin-right:.25em} +table.pyhltable .linenodiv{background:none!important;padding-right:0!important} +.quoteblock{margin:0 1em 1.25em 1.5em;display:table} +.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em} +.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} +.quoteblock blockquote{margin:0;padding:0;border:0} +.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} +.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} +.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right} +.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)} +.quoteblock .quoteblock blockquote{padding:0 0 0 .75em} +.quoteblock .quoteblock blockquote:before{display:none} +.verseblock{margin:0 1em 1.25em 1em} +.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} +.verseblock pre strong{font-weight:400} +.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} +.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} +.quoteblock .attribution br,.verseblock .attribution br{display:none} +.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.05em;color:rgba(0,0,0,.6)} +.quoteblock.abstract{margin:0 0 1.25em 0;display:block} +.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0} +.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none} +table.tableblock{max-width:100%;border-collapse:separate} +table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0} +table.spread{width:100%} +table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} +table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0} +table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0} +table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0} +table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0} +table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0} +table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0} +table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0} +table.frame-all{border-width:1px} +table.frame-sides{border-width:0 1px} +table.frame-topbot{border-width:1px 0} +th.halign-left,td.halign-left{text-align:left} +th.halign-right,td.halign-right{text-align:right} +th.halign-center,td.halign-center{text-align:center} +th.valign-top,td.valign-top{vertical-align:top} +th.valign-bottom,td.valign-bottom{vertical-align:bottom} +th.valign-middle,td.valign-middle{vertical-align:middle} +table thead th,table tfoot th{font-weight:bold} +tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} +tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} +p.tableblock>code:only-child{background:none;padding:0} +p.tableblock{font-size:1em} +td>div.verse{white-space:pre} +ol{margin-left:1.75em} +ul li ol{margin-left:1.5em} +dl dd{margin-left:1.125em} +dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} +ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} +ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none} +ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em} +ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em} +ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px} +ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden} +ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block} +ul.inline>li>*{display:block} +.unstyled dl dt{font-weight:400;font-style:normal} +ol.arabic{list-style-type:decimal} +ol.decimal{list-style-type:decimal-leading-zero} +ol.loweralpha{list-style-type:lower-alpha} +ol.upperalpha{list-style-type:upper-alpha} +ol.lowerroman{list-style-type:lower-roman} +ol.upperroman{list-style-type:upper-roman} +ol.lowergreek{list-style-type:lower-greek} +.hdlist>table,.colist>table{border:0;background:none} +.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} +td.hdlist1{padding-right:.75em;font-weight:bold} +td.hdlist1,td.hdlist2{vertical-align:top} +.literalblock+.colist,.listingblock+.colist{margin-top:-.5em} +.colist>table tr>td:first-of-type{padding:0 .75em;line-height:1} +.colist>table tr>td:last-of-type{padding:.25em 0} +.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd} +.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0} +.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em} +.imageblock>.title{margin-bottom:0} +.imageblock.thumb,.imageblock.th{border-width:6px} +.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} +.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} +.image.left{margin-right:.625em} +.image.right{margin-left:.625em} +a.image{text-decoration:none} +span.footnote,span.footnoteref{vertical-align:super;font-size:.875em} +span.footnote a,span.footnoteref a{text-decoration:none} +span.footnote a:active,span.footnoteref a:active{text-decoration:underline} +#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} +#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0} +#footnotes .footnote{padding:0 .375em;line-height:1.3;font-size:.875em;margin-left:1.2em;text-indent:-1.2em;margin-bottom:.2em} +#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none} +#footnotes .footnote:last-of-type{margin-bottom:0} +#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} +.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0} +.gist .file-data>table td.line-data{width:99%} +div.unbreakable{page-break-inside:avoid} +.big{font-size:larger} +.small{font-size:smaller} +.underline{text-decoration:underline} +.overline{text-decoration:overline} +.line-through{text-decoration:line-through} +.aqua{color:#00bfbf} +.aqua-background{background-color:#00fafa} +.black{color:#000} +.black-background{background-color:#000} +.blue{color:#0000bf} +.blue-background{background-color:#0000fa} +.fuchsia{color:#bf00bf} +.fuchsia-background{background-color:#fa00fa} +.gray{color:#606060} +.gray-background{background-color:#7d7d7d} +.green{color:#006000} +.green-background{background-color:#007d00} +.lime{color:#00bf00} +.lime-background{background-color:#00fa00} +.maroon{color:#600000} +.maroon-background{background-color:#7d0000} +.navy{color:#000060} +.navy-background{background-color:#00007d} +.olive{color:#606000} +.olive-background{background-color:#7d7d00} +.purple{color:#600060} +.purple-background{background-color:#7d007d} +.red{color:#bf0000} +.red-background{background-color:#fa0000} +.silver{color:#909090} +.silver-background{background-color:#bcbcbc} +.teal{color:#006060} +.teal-background{background-color:#007d7d} +.white{color:#bfbfbf} +.white-background{background-color:#fafafa} +.yellow{color:#bfbf00} +.yellow-background{background-color:#fafa00} +span.icon>.fa{cursor:default} +.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} +.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c} +.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} +.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900} +.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400} +.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000} +.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} +.conum[data-value] *{color:#fff!important} +.conum[data-value]+b{display:none} +.conum[data-value]:after{content:attr(data-value)} +pre .conum[data-value]{position:relative;top:-.125em} +b.conum *{color:inherit!important} +.conum:not([data-value]):empty{display:none} +h1,h2{letter-spacing:-.01em} +dt,th.tableblock,td.content{text-rendering:optimizeLegibility} +p,td.content{letter-spacing:-.01em} +p strong,td.content strong{letter-spacing:-.005em} +p,blockquote,dt,td.content{font-size:1.0625rem} +p{margin-bottom:1.25rem} +.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} +.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} +.print-only{display:none!important} +@media print{@page{margin:1.25cm .75cm} +*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important} +a{color:inherit!important;text-decoration:underline!important} +a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} +a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} +abbr[title]:after{content:" (" attr(title) ")"} +pre,blockquote,tr,img{page-break-inside:avoid} +thead{display:table-header-group} +img{max-width:100%!important} +p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} +h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} +#toc,.sidebarblock,.exampleblock>.content{background:none!important} +#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important} +.sect1{padding-bottom:0!important} +.sect1+.sect1{border:0!important} +#header>h1:first-child{margin-top:1.25rem} +body.book #header{text-align:center} +body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0} +body.book #header .details{border:0!important;display:block;padding:0!important} +body.book #header .details span:first-child{margin-left:0!important} +body.book #header .details br{display:block} +body.book #header .details br+span:before{content:none!important} +body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} +body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} +.listingblock code[data-lang]:before{display:block} +#footer{background:none!important;padding:0 .9375em} +#footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em} +.hide-on-print{display:none!important} +.print-only{display:block!important} +.hide-for-print{display:none!important} +.show-for-print{display:inherit!important}} +</style> +<style> +/* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */ +/*pre.CodeRay {background-color:#f7f7f8;}*/ +.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em} +.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)} +.CodeRay .line-numbers strong{font-weight: normal} +table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none} +table.CodeRay td{vertical-align: top} +table.CodeRay td.line-numbers{text-align:right} +table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)} +table.CodeRay td.code{padding:0 0 0 .5em} +table.CodeRay td.code>pre{padding:0} +.CodeRay .debug{color:#fff !important;background:#000080 !important} +.CodeRay .annotation{color:#007} +.CodeRay .attribute-name{color:#000080} +.CodeRay .attribute-value{color:#700} +.CodeRay .binary{color:#509} +.CodeRay .comment{color:#998;font-style:italic} +.CodeRay .char{color:#04d} +.CodeRay .char .content{color:#04d} +.CodeRay .char .delimiter{color:#039} +.CodeRay .class{color:#458;font-weight:bold} +.CodeRay .complex{color:#a08} +.CodeRay .constant,.CodeRay .predefined-constant{color:#008080} +.CodeRay .color{color:#099} +.CodeRay .class-variable{color:#369} +.CodeRay .decorator{color:#b0b} +.CodeRay .definition{color:#099} +.CodeRay .delimiter{color:#000} +.CodeRay .doc{color:#970} +.CodeRay .doctype{color:#34b} +.CodeRay .doc-string{color:#d42} +.CodeRay .escape{color:#666} +.CodeRay .entity{color:#800} +.CodeRay .error{color:#808} +.CodeRay .exception{color:inherit} +.CodeRay .filename{color:#099} +.CodeRay .function{color:#900;font-weight:bold} +.CodeRay .global-variable{color:#008080} +.CodeRay .hex{color:#058} +.CodeRay .integer,.CodeRay .float{color:#099} +.CodeRay .include{color:#555} +.CodeRay .inline{color:#00} +.CodeRay .inline .inline{background:#ccc} +.CodeRay .inline .inline .inline{background:#bbb} +.CodeRay .inline .inline-delimiter{color:#d14} +.CodeRay .inline-delimiter{color:#d14} +.CodeRay .important{color:#555;font-weight:bold} +.CodeRay .interpreted{color:#b2b} +.CodeRay .instance-variable{color:#008080} +.CodeRay .label{color:#970} +.CodeRay .local-variable{color:#963} +.CodeRay .octal{color:#40e} +.CodeRay .predefined{color:#369} +.CodeRay .preprocessor{color:#579} +.CodeRay .pseudo-class{color:#555} +.CodeRay .directive{font-weight:bold} +.CodeRay .type{font-weight:bold} +.CodeRay .predefined-type{color:inherit} +.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold} +.CodeRay .key{color:#808} +.CodeRay .key .delimiter{color:#606} +.CodeRay .key .char{color:#80f} +.CodeRay .value{color:#088} +.CodeRay .regexp .delimiter{color:#808} +.CodeRay .regexp .content{color:#808} +.CodeRay .regexp .modifier{color:#808} +.CodeRay .regexp .char{color:#d14} +.CodeRay .regexp .function{color:#404;font-weight:bold} +.CodeRay .string{color:#d20} +.CodeRay .string .string .string{background:#ffd0d0} +.CodeRay .string .content{color:#d14} +.CodeRay .string .char{color:#d14} +.CodeRay .string .delimiter{color:#d14} +.CodeRay .shell{color:#d14} +.CodeRay .shell .delimiter{color:#d14} +.CodeRay .symbol{color:#990073} +.CodeRay .symbol .content{color:#a60} +.CodeRay .symbol .delimiter{color:#630} +.CodeRay .tag{color:#008080} +.CodeRay .tag-special{color:#d70} +.CodeRay .variable{color:#036} +.CodeRay .insert{background:#afa} +.CodeRay .delete{background:#faa} +.CodeRay .change{color:#aaf;background:#007} +.CodeRay .head{color:#f8f;background:#505} +.CodeRay .insert .insert{color:#080} +.CodeRay .delete .delete{color:#800} +.CodeRay .change .change{color:#66f} +.CodeRay .head .head{color:#f4f} +</style> +</head> +<body class="article"> +<div id="header"> +<h1>Apache Tamaya — Documentation</h1> +<div class="details"> +<span id="author" class="author">Anatole Tresch</span><br> +<span id="email" class="email"><<a href="mailto:anat...@apache.org" title="Apache Tamaya">anat...@apache.org</a>></span><br> +<span id="revnumber">version 0.1-SNAPSHOT,</span> +<span id="revdate">November 2014</span> +<br><span id="revremark">Incubator</span> +</div> +<div id="toc" class="toc"> +<div id="toctitle">Table of Contents</div> +<ul class="sectlevel1"> +<li><a href="#_introduction">1. Introduction</a> +<ul class="sectlevel2"> +<li><a href="#_working_group">1.1. Working Group</a></li> +<li><a href="#_goals">1.2. Goals</a></li> +<li><a href="#_required_java_version">1.3. Required Java version</a></li> +</ul> +</li> +<li><a href="#_overview">2. Overview</a> +<ul class="sectlevel2"> +<li><a href="#_how_is_tamaya_organized">2.1. How is Tamaya organized</a></li> +</ul> +</li> +<li><a href="#_further_information">3. Further Information</a></li> +<li><a href="#_detailed_documentation">4. Detailed Documentation</a></li> +<li><a href="#_examples">5. Examples</a></li> +</ul> +</div> +</div> +<div id="content"> +<div id="preamble"> +<div class="sectionbody"> +<hr> +<div style="page-break-after: always;"></div> +<div class="paragraph"> +<p>→ add image : : <a href="http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png" class="bare">http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png</a></p> +</div> +<!-- toc disabled --> +<div style="page-break-after: always;"></div> +<div class="listingblock"> +<div class="content"> +<pre>Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License.</pre> +</div> +</div> +<div style="page-break-after: always;"></div> +</div> +</div> +<div class="sect1"> +<h2 id="_introduction">1. Introduction</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>This documentation describes the Tamaya Configuration System. It provides an overview of the different building blocks and +links you to more detailed documentations.</p> +</div> +<div class="sect2"> +<h3 id="_working_group">1.1. Working Group</h3> +<div class="paragraph"> +<p>This work is being conducted as part of a community lead joint effort under the Apache Software Foundation. This +specification is the result of the collaborative work of the members of the Tamaya Users Group and the community at +large.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_goals">1.2. Goals</h3> +<div class="paragraph"> +<p>Configuration is a key feature in all kind of programming languages. Basically configuration is the parametrization of +well defined aspects of a software product without having to recompile/rebuild the code. Summarizing configuration +can affect basically every part of a system, which renders configuration to a real cross-cutting concern, usable in +many facets.</p> +</div> +<div class="sect3"> +<h4 id="_targets">1.2.1. Targets</h4> +<div class="paragraph"> +<p>Tamaya targets to support all general configuration aspects in a system, e.g.</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>application configuration</p> +<div class="ulist"> +<ul> +<li> +<p>plugins</p> +</li> +<li> +<p>modules</p> +</li> +<li> +<p>components</p> +</li> +</ul> +</div> +</li> +<li> +<p>Container configuration, e.g. of Java EE enabling portability and dynamic provisioning</p> +</li> +<li> +<p>Configuration of CDI (interceptors, decorators and alternatives)</p> +</li> +<li> +<p>Configuration of Bean Validation, JSF, web applications etc.</p> +</li> +<li> +<p>Configuration of instances within Java SE, e.g. by passing instances to a method that injects configured values, +and by providing accessors to evaluate current configuration values. This can be used explicitly or transparently +by client code.</p> +</li> +</ul> +</div> +<div class="paragraph"> +<p>Since configuration is implemented and applied in various ways Tamaya will allow you to use</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>multiple configuration locations, including remote locations</p> +</li> +<li> +<p>multiple configuration formats, including custom formats</p> +</li> +<li> +<p>multiple configuration loading mechanisms, including custom mechanisms. By default reading the classpath, files und +URIs are supported by default.</p> +</li> +<li> +<p>type conversion</p> +</li> +<li> +<p>configuration filtering and property adapters</p> +</li> +<li> +<p>configuration of collections</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_required_java_version">1.3. Required Java version</h3> +<div class="paragraph"> +<p>The full API is based on Java SE 8.0 language features, whereas a compatible implementation of API and Core +is similarly available for Java SE 7 as well.</p> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_overview">2. Overview</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_how_is_tamaya_organized">2.1. How is Tamaya organized</h3> +<div class="paragraph"> +<p>The Tamaya project consists of the following parts:</p> +</div> +<div class="ulist"> +<ul> +<li> +<p>The <a href="API.html">API</a> is a complete SE based configuration API, that provides the minimum of functionality needed. +It is modelled in a extensible way and only requires a few kb. The main features supported by the <a href="API.html" class="bare">API.html</a> are:</p> +<div class="ulist"> +<ul> +<li> +<p>Reading configuration as String/String key/value pairs</p> +</li> +<li> +<p>Reading configuration as type safe values, including type conversion.</p> +</li> +<li> +<p>Extending configuration using operators and queries.</p> +</li> +<li> +<p>An SPI providing abstractions for component lifecycle, property sources, property source providers, configuration +context and property filters.</p> +</li> +</ul> +</div> +</li> +<li> +<p>The <a href="Core.html">Core</a> implements the <a href="API.html">API</a>. Basically with the core part (and the API) you are ready to go, but you may +add additional extensions that provide more features that are very useful.</p> +</li> +<li> +<p>Extensions are additional libraries that you can add to your project setup. Most important features are:</p> +<div class="ulist"> +<ul> +<li> +<p>Dynamic resolution of configured values.</p> +</li> +<li> +<p>Pattern based resource location</p> +</li> +<li> +<p>Configuration injection and configuration template support</p> +</li> +<li> +<p>Support for additional configuration formats</p> +</li> +<li> +<p>Collection Support</p> +</li> +<li> +<p>Prepared configuration metamodels</p> +</li> +<li> +<p>Integration with other frameworks as configuration consumer or producer.</p> +</li> +</ul> +</div> +</li> +<li> +<p>Finally the <strong>documentation</strong> module provides comprehensive documentation on all features provided.</p> +</li> +</ul> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_further_information">3. Further Information</h2> +<div class="sectionbody"> +<div class="ulist"> +<ul> +<li> +<p>There is a small document discussing <a href="usecases.html">Use Cases</a> and</p> +</li> +<li> +<p>a document discussing <a href="requirements.html">Requirements</a>.</p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_detailed_documentation">4. Detailed Documentation</h2> +<div class="sectionbody"> +<div class="ulist"> +<ul> +<li> +<p><a href="API.html">Tamaya API Documentation</a> and <a href="../javadoc/api/index.html">API Javadoc</a></p> +</li> +<li> +<p><a href="Core.html">Tamaya Core Documentation</a> and <a href="../javadoc/core/index.html">Core Javadoc</a></p> +</li> +<li> +<p><a href="modules.html">Tamaya Modules Documentation</a> and <a href="../javadoc/modules/index.html">Extensions Javadoc</a></p> +</li> +</ul> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_examples">5. Examples</h2> +<div class="sectionbody"> +<div class="ulist"> +<ul> +<li> +<p>A comprehensive set of examples can be found <a href="../examples.html">here</a>.</p> +</li> +</ul> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="footer-text"> +Version 0.1-SNAPSHOT<br> +Last updated 2015-03-03 09:44:36 MEZ +</div> +</div> +</body> +</html> \ No newline at end of file