Author: paulmerlin
Date: Wed Jul 8 15:17:12 2015
New Revision: 1689899
URL: http://svn.apache.org/r1689899
Log:
zest: develop minisite review + some more documentation
Added:
zest/site/content/java/develop/howto-depend-on-zest.html
Removed:
zest/site/content/java/develop/howto-depend-on-qi4j.html
Modified:
zest/site/content/java/develop/build-system.html
zest/site/content/java/develop/community-docs.html
zest/site/content/java/develop/core-api.html
zest/site/content/java/develop/core-bootstrap-assembly.html
zest/site/content/java/develop/core-functional.html
zest/site/content/java/develop/core-io.html
zest/site/content/java/develop/core-runtime.html
zest/site/content/java/develop/core-spi.html
zest/site/content/java/develop/core-testsupport.html
zest/site/content/java/develop/core.html
zest/site/content/java/develop/extension-cache-ehcache.html
zest/site/content/java/develop/extension-cache-memcache.html
zest/site/content/java/develop/extension-es-file.html
zest/site/content/java/develop/extension-es-hazelcast.html
zest/site/content/java/develop/extension-es-jclouds.html
zest/site/content/java/develop/extension-es-jdbm.html
zest/site/content/java/develop/extension-es-leveldb.html
zest/site/content/java/develop/extension-es-memory.html
zest/site/content/java/develop/extension-es-mongodb.html
zest/site/content/java/develop/extension-es-preferences.html
zest/site/content/java/develop/extension-es-redis.html
zest/site/content/java/develop/extension-es-riak.html
zest/site/content/java/develop/extension-es-sql.html
zest/site/content/java/develop/extension-es-voldemort.html
zest/site/content/java/develop/extension-index-elasticsearch.html
zest/site/content/java/develop/extension-index-rdf.html
zest/site/content/java/develop/extension-index-solr.html
zest/site/content/java/develop/extension-indexing-sql.html
zest/site/content/java/develop/extension-metrics-yammer.html
zest/site/content/java/develop/extension-migration.html
zest/site/content/java/develop/extension-reindexer.html
zest/site/content/java/develop/extension-vs-jackson.html
zest/site/content/java/develop/extension-vs-orgjson.html
zest/site/content/java/develop/extension-vs-stax.html
zest/site/content/java/develop/howto-assemble-application.html
zest/site/content/java/develop/howto-configure-service.html
zest/site/content/java/develop/howto-contextual-fragments.html
zest/site/content/java/develop/howto-create-concern.html
zest/site/content/java/develop/howto-create-constraint.html
zest/site/content/java/develop/howto-create-entity.html
zest/site/content/java/develop/howto-create-sideeffect.html
zest/site/content/java/develop/howto-invocation-annotation.html
zest/site/content/java/develop/howto-leverage-properties.html
zest/site/content/java/develop/howto-use-io.html
zest/site/content/java/develop/javadocs.html
zest/site/content/java/develop/js/progressive-enhancement.js
zest/site/content/java/develop/lang-scala.html
zest/site/content/java/develop/libraries.html
zest/site/content/java/develop/library-alarm.html
zest/site/content/java/develop/library-circuitbreaker.html
zest/site/content/java/develop/library-constraints.html
zest/site/content/java/develop/library-conversion.html
zest/site/content/java/develop/library-eventsourcing-jdbm.html
zest/site/content/java/develop/library-eventsourcing-rest.html
zest/site/content/java/develop/library-eventsourcing.html
zest/site/content/java/develop/library-fileconfig.html
zest/site/content/java/develop/library-http.html
zest/site/content/java/develop/library-invocation-cache.html
zest/site/content/java/develop/library-jmx.html
zest/site/content/java/develop/library-locking.html
zest/site/content/java/develop/library-logging.html
zest/site/content/java/develop/library-osgi.html
zest/site/content/java/develop/library-rdf.html
zest/site/content/java/develop/library-rest-client-primer.html
zest/site/content/java/develop/library-rest-client.html
zest/site/content/java/develop/library-rest-common.html
zest/site/content/java/develop/library-rest-server.html
zest/site/content/java/develop/library-scheduler.html
zest/site/content/java/develop/library-script-groovy.html
zest/site/content/java/develop/library-script-javascript.html
zest/site/content/java/develop/library-servlet.html
zest/site/content/java/develop/library-shiro-web.html
zest/site/content/java/develop/library-shiro.html
zest/site/content/java/develop/library-spring.html
zest/site/content/java/develop/library-sql.html
zest/site/content/java/develop/library-uid.html
zest/site/content/java/develop/library-uowfile.html
zest/site/content/java/develop/sample-car-rental.html
zest/site/content/java/develop/sample-dci-cargo.html
zest/site/content/java/develop/sample-dci.html
zest/site/content/java/develop/sample-forum.html
zest/site/content/java/develop/sample-sql-support.html
zest/site/content/java/develop/sample-swing.html
zest/site/content/java/develop/ten-minutes-intro.html
zest/site/content/java/develop/thirty-minutes-intro.html
zest/site/content/java/develop/tools-envisage.html
zest/site/content/java/develop/tut-composites.html
zest/site/content/java/develop/tut-services.html
zest/site/content/java/develop/tutorials.html
zest/site/content/java/develop/two-hours-intro.html
zest/site/content/java/develop/two-minutes-intro.html
zest/site/content/java/develop/website.html
Modified: zest/site/content/java/develop/build-system.html
URL:
http://svn.apache.org/viewvc/zest/site/content/java/develop/build-system.html?rev=1689899&r1=1689898&r2=1689899&view=diff
==============================================================================
--- zest/site/content/java/develop/build-system.html (original)
+++ zest/site/content/java/develop/build-system.html Wed Jul 8 15:17:12 2015
@@ -66,10 +66,10 @@
})();
</script>
- </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><span
xmlns="" href="tutorials.html">Tutorials</span></span></dt><dt><span
class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span
class="section"><a href="samples.html">Samples</a></span></dt><dt><span
class="section"><a href="core.html">Core</a></span></dt><dt><span
class="section"><a href="libraries.html">Libraries</a></span></dt><dt><span
class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span
class="section"><a href="tools.html">Tools</a></span></dt><dt><span
class="section"><a href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span
class="section"><a
href="tutorials.html#_overview">Overview</a></span></dt><dt><span
class="section"><a href="two-minutes-intro.html">Zest⢠in 2
minutes</a></span></dt><dt><span class="section"><a
href="ten-minutes-intro.html">Zest⢠in 10 minutes</a></span></dt><dt><span
class="section"><a href="thirty-minutes-intro.html">Zest⢠in 30
minutes</a></span></dt><dt><span class="section"><a
href="two-hours-intro.html">Zest⢠in 2 hours</a></span></dt><dt><span
class="section"><a href="howto-depend-on-qi4j.html">Depend on Zest⢠in your
build</a></span></dt><dt><span class="section"><a
href="howto-assemble-application.html">Assemble an
Application</a></span></dt><dt><span class="section"><a
href="tut-composites.html">Transient Composites
Tutorial</a></span></dt><dt><span class="section">
<a href="tut-services.html">Services Composites
Tutorial</a></span></dt><dt><span class="section"><a
href="howto-contextual-fragments.html">Use contextual
fragments</a></span></dt><dt><span class="section"><a
href="howto-leverage-properties.html">Leverage
Properties</a></span></dt><dt><span class="section"><a
href="howto-create-constraint.html">Create a
Constraint</a></span></dt><dt><span class="section"><a
href="howto-create-concern.html">Create a Concern</a></span></dt><dt><span
class="section"><a href="howto-create-sideeffect.html">Create a
SideEffect</a></span></dt><dt><span class="section"><a
href="howto-create-entity.html">Create an Entity</a></span></dt><dt><span
class="section"><a href="howto-configure-service.html">Configure a
Service</a></span></dt><dt><span class="section"><a
href="howto-invocation-annotation.html">Use
@Invocation</a></span></dt><dt><span class="section"><a
href="howto-use-io.html">Use I/O API</a></span></dt><dt><span
class="section"><span xmlns="" href="
build-system.html">Build System</span></span></dt><dt><span class="section"><a
href="community-docs.html">Writing Zestâ¢
Documentation</a></span></dt></dl></div></div><div class="section" title="Build
System"><div class="titlepage"><div><div><h3 class="title"><a
id="build-system"></a>Build System</h3></div></div></div><p>This tutorial is
intended for developpers who want to build the Zest⢠SDK themselves.
+ </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><span
xmlns="" href="tutorials.html">Tutorials</span></span></dt><dt><span
class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span
class="section"><a href="samples.html">Samples</a></span></dt><dt><span
class="section"><a href="core.html">Core</a></span></dt><dt><span
class="section"><a href="libraries.html">Libraries</a></span></dt><dt><span
class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span
class="section"><a href="tools.html">Tools</a></span></dt><dt><span
class="section"><a href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span
class="section"><a
href="tutorials.html#_overview">Overview</a></span></dt><dt><span
class="section"><a href="two-minutes-intro.html">Zest⢠in 2
minutes</a></span></dt><dt><span class="section"><a
href="ten-minutes-intro.html">Zest⢠in 10 minutes</a></span></dt><dt><span
class="section"><a href="thirty-minutes-intro.html">Zest⢠in 30
minutes</a></span></dt><dt><span class="section"><a
href="two-hours-intro.html">Zest⢠in 2 hours</a></span></dt><dt><span
class="section"><a href="howto-depend-on-zest.html">Depend on Zest⢠in your
build</a></span></dt><dt><span class="section"><a
href="howto-assemble-application.html">Assemble an
Application</a></span></dt><dt><span class="section"><a
href="tut-composites.html">Transient Composites
Tutorial</a></span></dt><dt><span class="section">
<a href="tut-services.html">Services Composites
Tutorial</a></span></dt><dt><span class="section"><a
href="howto-contextual-fragments.html">Use contextual
fragments</a></span></dt><dt><span class="section"><a
href="howto-leverage-properties.html">Leverage
Properties</a></span></dt><dt><span class="section"><a
href="howto-create-constraint.html">Create a
Constraint</a></span></dt><dt><span class="section"><a
href="howto-create-concern.html">Create a Concern</a></span></dt><dt><span
class="section"><a href="howto-create-sideeffect.html">Create a
SideEffect</a></span></dt><dt><span class="section"><a
href="howto-create-entity.html">Create an Entity</a></span></dt><dt><span
class="section"><a href="howto-configure-service.html">Configure a
Service</a></span></dt><dt><span class="section"><a
href="howto-invocation-annotation.html">Use
@Invocation</a></span></dt><dt><span class="section"><a
href="howto-use-io.html">Use I/O API</a></span></dt><dt><span
class="section"><span xmlns="" href="
build-system.html">Build System</span></span></dt><dt><span class="section"><a
href="community-docs.html">Writing Zestâ¢
Documentation</a></span></dt></dl></div></div><div class="section" title="Build
System"><div class="titlepage"><div><div><h3 class="title"><a
id="build-system"></a>Build System</h3></div></div></div><p>This tutorial is
intended for developpers who want to build the Zest⢠SDK themselves.
It describe the Zest⢠SDK Build System from compilation to publication of
artifacts for consumption by other
applications.</p><p>If instead you want to setup your project build system to
depend on modules of the Zest⢠SDK see the
-<a class="link" href="howto-depend-on-qi4j.html" title="Depend on Zest⢠in
your build">dedicated tutorial</a>.</p><div class="section" title="Gradle"><div
class="titlepage"><div><div><h4 class="title"><a
id="_gradle"></a>Gradle</h4></div></div></div><div class="note" title="Note"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Note</h3><p>All major Java IDEs have great Gradle support.
+<a class="link" href="howto-depend-on-zest.html" title="Depend on Zest⢠in
your build">dedicated tutorial</a>.</p><div class="section" title="Gradle"><div
class="titlepage"><div><div><h4 class="title"><a
id="_gradle"></a>Gradle</h4></div></div></div><div class="note" title="Note"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Note</h3><p>All major Java IDEs have great Gradle support.
Visit the <a class="ulink" href="http://www.gradle.org/tooling"
target="_top">Gradle Tooling</a> page to learn how to import the Zest⢠SDK
build into your
favorite IDE.</p></div><p>Zest⢠community migrated away from Maven after
several years of frustration, especially around release management,
versioning and cross-module dependency resolution issues, in Feb 2011.
@@ -87,24 +87,24 @@ clean
</span></dt><dd>Clean up of all build output and restore the code base to a
fresh state.</dd><dt><span class="term">
check
</span></dt><dd>Run the tests and other checks like checkstyle.
-Reports are generated in <code
class="literal">qi4j-sdk/build/reports</code>.</dd><dt><span class="term">
+Reports are generated in <code
class="literal">build/reports</code>.</dd><dt><span class="term">
install
</span></dt><dd>Is roughly the same as Mavenâs install goal.
It produces the test reports, javadocs and installs all the Jars into the
local disk repository, for consumption
by other applications.</dd><dt><span class="term">
buildAll
</span></dt><dd>Produces all the archives, javadocs, manuals and website
content.
-The output is generated to <code
class="literal">qi4j-sdk/build</code>.</dd><dt><span class="term">
+The output is generated to <code class="literal">build</code>.</dd><dt><span
class="term">
release
</span></dt><dd>Uploads the release artifacts to the distribution servers and
creates the release output into the
-<code class="literal">qi4j-sdk/build/distributions</code>
directory.</dd></dl></div></div><div class="section" title="Submodules
tasks"><div class="titlepage"><div><div><h4 class="title"><a
id="_submodules_tasks"></a>Submodules tasks</h4></div></div></div><p>In
addition to that, some submodules have specific tasks.
+<code class="literal">build/distributions</code>
directory.</dd></dl></div></div><div class="section" title="Submodules
tasks"><div class="titlepage"><div><div><h4 class="title"><a
id="_submodules_tasks"></a>Submodules tasks</h4></div></div></div><p>In
addition to that, some submodules have specific tasks.
To see all available tasks on a submodule issue the following command:</p><pre
class="programlisting brush: bash">./gradlew -p tests/performance
tasks</pre><p>This example will output all gradle tasks available in the <code
class="literal">tests/performance</code> module where you should find
the <code class="literal">testPerf</code> task that run the Zestâ¢
performance test suite.</p></div><div class="section" title="Versions"><div
class="titlepage"><div><div><h4 class="title"><a
id="_versions"></a>Versions</h4></div></div></div><p>By default, the build
system produces a "zero build".
It means that there is no version assigned to the build, and a "0" is used in
the produced artifacts.
This is due to our disagreement (with Maven community) that the "next" version
name/number is known prior to
the release.
This is in our opinion a delayed decision.
-To build a particular version, you specify a <code
class="literal">version</code> property on the command-line, like</p><pre
class="programlisting brush: bash">./gradlew -Dversion=2.0-FLAVOUR
install</pre><p>If a <code class="literal">version</code> property is not
defined, the build system will refuse to make a release and
upload.</p></div><div class="section" title="Tests"><div
class="titlepage"><div><div><h4 class="title"><a
id="_tests"></a>Tests</h4></div></div></div><div class="note" title="Note"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Note</h3><p>See the <a class="ulink"
href="http://qi4j.org/community/ci.html" target="_top">Zest⢠Continuous
Integration</a> for current tests results</p></div><div class="section"
title="Regression tests"><div class="titlepage"><div><div><h5 class="title"><a
id="_regression_tests"></a>Regression tests</h5></div></div></div><p>They are
not part of the default build.</p></div><div class="section" title="Performance
tests"><div class="titlepage"><div><div><h5 class="title"><a
id="_performance_tests"></a>Performance
tests</h5></div></div></div><p>Performance tests provide performance
mesurements for typical Zest⢠use cases.
+To build a particular version, you specify a <code
class="literal">version</code> property on the command-line, like</p><pre
class="programlisting brush: bash">./gradlew -Dversion=2.0-FLAVOUR
install</pre><p>If a <code class="literal">version</code> property is not
defined, the build system will refuse to make a release and
upload.</p></div><div class="section" title="Tests"><div
class="titlepage"><div><div><h4 class="title"><a
id="_tests"></a>Tests</h4></div></div></div><div class="note" title="Note"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Note</h3><p>See the <a class="ulink"
href="https://builds.apache.org/view/S-Z/view/Zest/" target="_top">Zestâ¢
Continuous Integration</a> for current tests results</p></div><div
class="section" title="Regression tests"><div class="titlepage"><div><div><h5
class="title"><a id="_regression_tests"></a>Regression
tests</h5></div></div></div><p>They are not part of the default
build.</p></div><div class="section" title="
Performance tests"><div class="titlepage"><div><div><h5 class="title"><a
id="_performance_tests"></a>Performance
tests</h5></div></div></div><p>Performance tests provide performance
mesurements for typical Zest⢠use cases.
They are not part of the default build.</p></div><div class="section"
title="Complex tests"><div class="titlepage"><div><div><h5 class="title"><a
id="_complex_tests"></a>Complex tests</h5></div></div></div><p>Complex tests
are the ones that requires manual operation to be executed.
They are not part of the default build.</p></div><div class="section"
title="Unit tests requiring external services"><div
class="titlepage"><div><div><h5 class="title"><a
id="_unit_tests_requiring_external_services"></a>Unit tests requiring external
services</h5></div></div></div><div class="note" title="Note"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Note</h3><p>The HTML test reports generated by Gradle show
skipped tests.</p></div><p>Among unit tests, some require an external service
to be run.
For example, the MongoDB EntityStore extension requires an actual MongoDB
server to run its tests.</p><p>All thoses tests should be part of the default
build and check if the service is available at its default location
Modified: zest/site/content/java/develop/community-docs.html
URL:
http://svn.apache.org/viewvc/zest/site/content/java/develop/community-docs.html?rev=1689899&r1=1689898&r2=1689899&view=diff
==============================================================================
--- zest/site/content/java/develop/community-docs.html (original)
+++ zest/site/content/java/develop/community-docs.html Wed Jul 8 15:17:12 2015
@@ -66,13 +66,13 @@
})();
</script>
- </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><span
xmlns="" href="tutorials.html">Tutorials</span></span></dt><dt><span
class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span
class="section"><a href="samples.html">Samples</a></span></dt><dt><span
class="section"><a href="core.html">Core</a></span></dt><dt><span
class="section"><a href="libraries.html">Libraries</a></span></dt><dt><span
class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span
class="section"><a href="tools.html">Tools</a></span></dt><dt><span
class="section"><a href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span
class="section"><a
href="tutorials.html#_overview">Overview</a></span></dt><dt><span
class="section"><a href="two-minutes-intro.html">Zest⢠in 2
minutes</a></span></dt><dt><span class="section"><a
href="ten-minutes-intro.html">Zest⢠in 10 minutes</a></span></dt><dt><span
class="section"><a href="thirty-minutes-intro.html">Zest⢠in 30
minutes</a></span></dt><dt><span class="section"><a
href="two-hours-intro.html">Zest⢠in 2 hours</a></span></dt><dt><span
class="section"><a href="howto-depend-on-qi4j.html">Depend on Zest⢠in your
build</a></span></dt><dt><span class="section"><a
href="howto-assemble-application.html">Assemble an
Application</a></span></dt><dt><span class="section"><a
href="tut-composites.html">Transient Composites
Tutorial</a></span></dt><dt><span class="section">
<a href="tut-services.html">Services Composites
Tutorial</a></span></dt><dt><span class="section"><a
href="howto-contextual-fragments.html">Use contextual
fragments</a></span></dt><dt><span class="section"><a
href="howto-leverage-properties.html">Leverage
Properties</a></span></dt><dt><span class="section"><a
href="howto-create-constraint.html">Create a
Constraint</a></span></dt><dt><span class="section"><a
href="howto-create-concern.html">Create a Concern</a></span></dt><dt><span
class="section"><a href="howto-create-sideeffect.html">Create a
SideEffect</a></span></dt><dt><span class="section"><a
href="howto-create-entity.html">Create an Entity</a></span></dt><dt><span
class="section"><a href="howto-configure-service.html">Configure a
Service</a></span></dt><dt><span class="section"><a
href="howto-invocation-annotation.html">Use
@Invocation</a></span></dt><dt><span class="section"><a
href="howto-use-io.html">Use I/O API</a></span></dt><dt><span
class="section"><a href="build-system
.html">Build System</a></span></dt><dt><span class="section"><span xmlns=""
href="community-docs.html">Writing Zestâ¢
Documentation</span></span></dt></dl></div></div><div class="section"
title="Writing Zest⢠Documentation"><div class="titlepage"><div><div><h3
class="title"><a id="community-docs"></a>Writing Zestâ¢
Documentation</h3></div></div></div><p>The documents use the asciidoc format,
see:</p><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem">
+ </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><span
xmlns="" href="tutorials.html">Tutorials</span></span></dt><dt><span
class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span
class="section"><a href="samples.html">Samples</a></span></dt><dt><span
class="section"><a href="core.html">Core</a></span></dt><dt><span
class="section"><a href="libraries.html">Libraries</a></span></dt><dt><span
class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span
class="section"><a href="tools.html">Tools</a></span></dt><dt><span
class="section"><a href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span
class="section"><a
href="tutorials.html#_overview">Overview</a></span></dt><dt><span
class="section"><a href="two-minutes-intro.html">Zest⢠in 2
minutes</a></span></dt><dt><span class="section"><a
href="ten-minutes-intro.html">Zest⢠in 10 minutes</a></span></dt><dt><span
class="section"><a href="thirty-minutes-intro.html">Zest⢠in 30
minutes</a></span></dt><dt><span class="section"><a
href="two-hours-intro.html">Zest⢠in 2 hours</a></span></dt><dt><span
class="section"><a href="howto-depend-on-zest.html">Depend on Zest⢠in your
build</a></span></dt><dt><span class="section"><a
href="howto-assemble-application.html">Assemble an
Application</a></span></dt><dt><span class="section"><a
href="tut-composites.html">Transient Composites
Tutorial</a></span></dt><dt><span class="section">
<a href="tut-services.html">Services Composites
Tutorial</a></span></dt><dt><span class="section"><a
href="howto-contextual-fragments.html">Use contextual
fragments</a></span></dt><dt><span class="section"><a
href="howto-leverage-properties.html">Leverage
Properties</a></span></dt><dt><span class="section"><a
href="howto-create-constraint.html">Create a
Constraint</a></span></dt><dt><span class="section"><a
href="howto-create-concern.html">Create a Concern</a></span></dt><dt><span
class="section"><a href="howto-create-sideeffect.html">Create a
SideEffect</a></span></dt><dt><span class="section"><a
href="howto-create-entity.html">Create an Entity</a></span></dt><dt><span
class="section"><a href="howto-configure-service.html">Configure a
Service</a></span></dt><dt><span class="section"><a
href="howto-invocation-annotation.html">Use
@Invocation</a></span></dt><dt><span class="section"><a
href="howto-use-io.html">Use I/O API</a></span></dt><dt><span
class="section"><a href="build-system
.html">Build System</a></span></dt><dt><span class="section"><span xmlns=""
href="community-docs.html">Writing Zestâ¢
Documentation</span></span></dt></dl></div></div><div class="section"
title="Writing Zest⢠Documentation"><div class="titlepage"><div><div><h3
class="title"><a id="community-docs"></a>Writing Zestâ¢
Documentation</h3></div></div></div><p>The documents use the asciidoc format,
see:</p><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem">
<a class="ulink" href="http://www.methods.co.nz/asciidoc/"
target="_top">Aciidoc Reference</a>
</li><li class="listitem">
<a class="ulink" href="http://powerman.name/doc/asciidoc"
target="_top">AsciiDoc cheatsheet</a>
</li></ul></div><p>The cheatsheet is really useful!</p><div class="section"
title="Overall Flow"><div class="titlepage"><div><div><h4 class="title"><a
id="community-docs-overall-flow"></a>Overall Flow</h4></div></div></div><div
class="tip" title="Tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Tip</h3><p>To generate the website locally use <code
class="literal">./gradlew -p manual website</code>. Output is in <code
class="literal">~/manual/build/docs/website</code>.</p></div><p>Each
(sub)project has its own documentation, in <span
class="emphasis"><em>src/docs/</em></span> and all the Asciidoc documents have
the <code class="literal">.txt</code> file extension.</p><p>The documents can
use code snippets which will extract code from the project. This is preferred
way to include
source code in the documentation, since any refactoring will be reflected in
the documentation.</p><p>The above files are all consumed by the build of the
manual (by adding them as dependencies).
-To get content included in the manual, it has to be explicitly included by a
document in the manual as well.</p><p>The whole documentation set is generated
from the <span class="emphasis"><em>*manual*</em></span> module in the <code
class="literal">qi4j-sdk</code>, and we are currently only creating the website.
+To get content included in the manual, it has to be explicitly included by a
document in the manual as well.</p><p>The whole documentation set is generated
from the <span class="emphasis"><em>*manual*</em></span> module in the SDK, and
we are currently only creating the website.
The User Guide and Reference Manual are future projects.</p></div><div
class="section" title="Headings and document structure"><div
class="titlepage"><div><div><h4 class="title"><a
id="_headings_and_document_structure"></a>Headings and document
structure</h4></div></div></div><p>Each document starts over with headings from
level zero (the document title).
Each document should have an id.
In some cases sections in the document need to have idâs as well, this
depends on where they fit in the overall structure.
@@ -101,7 +101,7 @@ As <code class="literal">{}</code> are u
What you have to do is to escape the opening brace: <code
class="literal">\{</code>.
If you donât, the braces and the text inside them will be removed without
any warning being issued!
</li></ul></div></div><div class="section" title="Links"><div
class="titlepage"><div><div><h4 class="title"><a
id="_links"></a>Links</h4></div></div></div><p>To link to other parts of the
manual the id of the target is used.
-This is how such a reference looks:</p><pre class="programlisting brush:
plain"><<community-docs-overall-flow>></pre><p>Which will render
like: <a class="xref" href="community-docs.html#community-docs-overall-flow"
title="Overall Flow">Documentation Flow</a></p><div class="note" title="Note"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Note</h3><p>Just write "see <<target-id>>" and
similar, thatâs enough in most cases.</p></div><p>If you need to link to
another document with your own link text, this is what to do:</p><pre
class="programlisting brush: plain"><<target-id, link text that fits in
the context>></pre><div class="note" title="Note" style="margin-left:
0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Having lots of
linked text may work well in a web context but is a pain in print, and we aim
for both!</p></div><p>External links are added like this:</p><pre
class="programlisting brush: plain">http://www
.qi4j.org/[Link text here]</pre><p>Which renders like: <a class="ulink"
href="http://www.qi4j.org/" target="_top">Link text here</a></p><p>For short
links it may be better not to add a link text, just do:</p><pre
class="programlisting brush: plain">http://www.qi4j.org/</pre><p>Which renders
like: <a class="ulink" href="http://www.qi4j.org/"
target="_top">http://www.qi4j.org/</a></p><p>Itâs ok to have a dot right
after the URL, it wonât be part of the link.</p><pre class="programlisting
brush: plain">http://www.qi4j.org/.</pre><p>Which renders like: <a
class="ulink" href="http://www.qi4j.org/"
target="_top">http://www.qi4j.org/</a>.</p></div><div class="section"
title="Text Formatting"><div class="titlepage"><div><div><h4 class="title"><a
id="_text_formatting"></a>Text Formatting</h4></div></div></div><div
class="itemizedlist"><ul class="itemizedlist"><li class="listitem">
+This is how such a reference looks:</p><pre class="programlisting brush:
plain"><<community-docs-overall-flow>></pre><p>Which will render
like: <a class="xref" href="community-docs.html#community-docs-overall-flow"
title="Overall Flow">Documentation Flow</a></p><div class="note" title="Note"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Note</h3><p>Just write "see <<target-id>>" and
similar, thatâs enough in most cases.</p></div><p>If you need to link to
another document with your own link text, this is what to do:</p><pre
class="programlisting brush: plain"><<target-id, link text that fits in
the context>></pre><div class="note" title="Note" style="margin-left:
0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Having lots of
linked text may work well in a web context but is a pain in print, and we aim
for both!</p></div><p>External links are added like this:</p><pre
class="programlisting brush: plain">https://ze
st.apache.org/[Link text here]</pre><p>Which renders like: <a class="ulink"
href="https://zest.apache.org/" target="_top">Link text here</a></p><p>For
short links it may be better not to add a link text, just do:</p><pre
class="programlisting brush: plain">https://zest.apache.org/</pre><p>Which
renders like: <a class="ulink" href="https://zest.apache.org/"
target="_top">https://zest.apache.org/</a></p><p>Itâs ok to have a dot right
after the URL, it wonât be part of the link.</p><pre class="programlisting
brush: plain">https://zest.apache.org/.</pre><p>Which renders like: <a
class="ulink" href="https://zest.apache.org/"
target="_top">https://zest.apache.org/</a>.</p></div><div class="section"
title="Text Formatting"><div class="titlepage"><div><div><h4 class="title"><a
id="_text_formatting"></a>Text Formatting</h4></div></div></div><div
class="itemizedlist"><ul class="itemizedlist"><li class="listitem">
<span class="strong"><strong>Bold</strong></span> - just donât do it, the
editor in charge is likely to remove it anyhow!
</li><li class="listitem">
_Italics_ is rendered as <span class="emphasis"><em>Italics</em></span>
@@ -122,7 +122,7 @@ Then go:</p><pre class="programlisting b
-----------
source=tutorials/introduction/tenminutes/src/main/java/org/qi4j/demo/tenminute/OrderEntity.java
tag=mainClass
- -----------</pre><p>The source file is relative to the <code
class="literal">qi4j-sdk</code> root, and the <span
class="emphasis"><em>tag</em></span> is defined in the source file.
+ -----------</pre><p>The source file is relative to the SDK root, and the
<span class="emphasis"><em>tag</em></span> is defined in the source file.
The above could be bringing in content that looks like;</p><pre
class="programlisting brush: plain">package org.qi4j.demo.tenminute;
import org.qi4j.api.concern.Concerns;
Modified: zest/site/content/java/develop/core-api.html
URL:
http://svn.apache.org/viewvc/zest/site/content/java/develop/core-api.html?rev=1689899&r1=1689898&r2=1689899&view=diff
==============================================================================
--- zest/site/content/java/develop/core-api.html (original)
+++ zest/site/content/java/develop/core-api.html Wed Jul 8 15:17:12 2015
@@ -67,7 +67,7 @@
</script>
</head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><a
href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a
href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a
href="samples.html">Samples</a></span></dt><dt><span class="section"><span
xmlns="" href="core.html">Core</span></span></dt><dt><span class="section"><a
href="libraries.html">Libraries</a></span></dt><dt><span class="section"><a
href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a
href="tools.html">Tools</a></span></dt><dt><span class="section"><a
href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span
class="section"><a
href="core.html#_overview_3">Overview</a></span></dt><dt><span
class="section"><span xmlns="" href="core-api.html">Core
API</span></span></dt><dt><span class="section"><a
href="core-bootstrap-assembly.html">Core Bootstrap</a></span></dt><dt><span
class="section"><a href="core-testsupport.html">Core Test
Support</a></span></dt><dt><span class="section"><a
href="core-functional.html">Core Functional API</a></span></dt><dt><span
class="section"><a href="core-io.html">Core I/O API</a></span></dt><dt><span
class="section"><a href="core-spi.html">Core Extension
SPI</a></span></dt><dt><span class="section"><a href="core-runtime.html">Core
Runtime</a></span></dt></dl></div></div><div class="section" title="Core
API"><div class="titlepage"><div><div><h3 class="title"><a
id="core-api"></a>Core
API</h3></div></div></div><p class="remark"><em><span
class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p
class="devstatus-docs-good">docs</p><p
class="devstatus-tests-good">tests</p><p>The Zest⢠Core API is the primary
interface for client application code during the main execution phase, i.e.
after the
-application has been activated.</p><div class="table"><a
id="idm415578101648"></a><p class="title"><strong>Table 15.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.api</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><div class="section" title="Composition"><div
class="titlepage"><div><div><h4 class="title"><a
id="core-api-composition"></a>Composition</h4></div></div></div><p>Composition
is at the heart of COP, and refers to two different levels of
constructs;</p><div class="orderedlist"><ol class="orderedlist" type="1"><li
class="li
stitem">
+application has been activated.</p><div class="table"><a
id="idm161697953152"></a><p class="title"><strong>Table 15.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.api</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><div class="section" title="Composition"><div
class="titlepage"><div><div><h4 class="title"><a
id="core-api-composition"></a>Composition</h4></div></div></div><p>Composition
is at the heart of COP, and refers to two different levels of
constructs;</p><div class="orderedlist"><ol class="orderedlist" type="1"><li
class="li
stitem">
the ability to assemble (compose) objects from smaller pieces, called
Fragments.
</li><li class="listitem">
the construction of applications by assembling Composites into Modules and
Modules into Layers.
Modified: zest/site/content/java/develop/core-bootstrap-assembly.html
URL:
http://svn.apache.org/viewvc/zest/site/content/java/develop/core-bootstrap-assembly.html?rev=1689899&r1=1689898&r2=1689899&view=diff
==============================================================================
--- zest/site/content/java/develop/core-bootstrap-assembly.html (original)
+++ zest/site/content/java/develop/core-bootstrap-assembly.html Wed Jul 8
15:17:12 2015
@@ -87,7 +87,7 @@ Set <span class="emphasis"><em>meta info
Import external services to be available as Zest⢠services.
</li><li class="listitem">
Tag services with markers
-</li></ul></div><div class="table"><a id="idm415577683952"></a><p
class="title"><strong>Table 16. Artifact</strong></p><div
class="table-contents"><table summary="Artifact" border="1"><colgroup><col
class="col_1" /><col class="col_2" /><col class="col_3"
/></colgroup><thead><tr><th align="left" valign="top">Group ID</th><th
align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.bootstrap</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><div class="section" title="Defining Objects"><div
class="titlepage"><div><div><h4 class="title"><a
id="_defining_objects"></a>Defining Objects</h4></div></div></div><pre
class="programlisting brush: java">@Override
+</li></ul></div><div class="table"><a id="idm161696848864"></a><p
class="title"><strong>Table 16. Artifact</strong></p><div
class="table-contents"><table summary="Artifact" border="1"><colgroup><col
class="col_1" /><col class="col_2" /><col class="col_3"
/></colgroup><thead><tr><th align="left" valign="top">Group ID</th><th
align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.bootstrap</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><div class="section" title="Defining Objects"><div
class="titlepage"><div><div><h4 class="title"><a
id="_defining_objects"></a>Defining Objects</h4></div></div></div><pre
class="programlisting brush: java">@Override
public void assemble( ModuleAssembly module )
throws AssemblyException
{
Modified: zest/site/content/java/develop/core-functional.html
URL:
http://svn.apache.org/viewvc/zest/site/content/java/develop/core-functional.html?rev=1689899&r1=1689898&r2=1689899&view=diff
==============================================================================
--- zest/site/content/java/develop/core-functional.html (original)
+++ zest/site/content/java/develop/core-functional.html Wed Jul 8 15:17:12 2015
@@ -67,7 +67,7 @@
</script>
</head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><a
href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a
href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a
href="samples.html">Samples</a></span></dt><dt><span class="section"><span
xmlns="" href="core.html">Core</span></span></dt><dt><span class="section"><a
href="libraries.html">Libraries</a></span></dt><dt><span class="section"><a
href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a
href="tools.html">Tools</a></span></dt><dt><span class="section"><a
href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span
class="section"><a
href="core.html#_overview_3">Overview</a></span></dt><dt><span
class="section"><a href="core-api.html">Core API</a></span></dt><dt><span
class="section"><a href="core-bootstrap-assembly.html">Core
Bootstrap</a></span></dt><dt><span class="section"><a
href="core-testsupport.html">Core Test Support</a></span></dt><dt><span
class="section"><span xmlns="" href="core-functional.html">Core Functional
API</span></span></dt><dt><span class="section"><a href="core-io.html">Core I/O
API</a></span></dt><dt><span class="section"><a href="core-spi.html">Core
Extension SPI</a></span></dt><dt><span class="section"><a
href="core-runtime.html">Core Runtime</a></span></dt></dl></div></div><div
class="section" title="Core Functional API"><div
class="titlepage"><div><div><h3 class="title"><a id="core-fun
ctional"></a>Core Functional API</h3></div></div></div><p
class="remark"><em><span class="comment"></span></em></p><p
class="devstatus-code-beta">code</p><p class="devstatus-docs-good">docs</p><p
class="devstatus-tests-good">tests</p><p>The Zest⢠Core Functional API is a
generic package to work with Iterables in a "functional programming language"
style.</p><p>This package is completely independent of everything else in
Zest⢠and may be used on its own in any kind of environment
-such as Spring or Java EE applications.</p><div class="table"><a
id="idm415577558752"></a><p class="title"><strong>Table 18.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.functional</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><div class="section" title="First Example"><div
class="titlepage"><div><div><h4 class="title"><a id="_first_example"></a>First
Example</h4></div></div></div><p>Letâs say that you have an Iterable of
Integers and you want to sum them all up. Most people would create a loop and
+such as Spring or Java EE applications.</p><div class="table"><a
id="idm161696723680"></a><p class="title"><strong>Table 18.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.functional</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><div class="section" title="First Example"><div
class="titlepage"><div><div><h4 class="title"><a id="_first_example"></a>First
Example</h4></div></div></div><p>Letâs say that you have an Iterable of
Integers and you want to sum them all up. Most people would create a loop and
sum it all up in something like this;</p><pre class="programlisting brush:
java">Iterable<Long> data = new ArrayList<Long>();
[...snip...]
Modified: zest/site/content/java/develop/core-io.html
URL:
http://svn.apache.org/viewvc/zest/site/content/java/develop/core-io.html?rev=1689899&r1=1689898&r2=1689899&view=diff
==============================================================================
--- zest/site/content/java/develop/core-io.html (original)
+++ zest/site/content/java/develop/core-io.html Wed Jul 8 15:17:12 2015
@@ -70,7 +70,7 @@
independently of Zest, together with the Zest⢠Core Functional API, which
the Core I/O API depends on.</p><p>The Zest⢠Core I/O API tries to address
the problem around shuffling data around from various I/O inputs and outputs,
possibly with transformations and filtering along the way. It was identified
that there is a general mix-up of concerns
in the stereotypical I/O handling codebases that people deal with all the
time. The reasoning around this, can be found
-in the <a class="xref" href="howto-use-io.html" title="Use I/O API">Use I/O
API</a>, and is recommended reading.</p><div class="table"><a
id="idm415577520400"></a><p class="title"><strong>Table 19.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.io</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><div class="section" title="The Problem"><div
class="titlepage"><div><div><h4 class="title"><a id="_the_problem"></a>The
Problem</h4></div></div></div><p>Why does I/O operations in Java have to be so
complicated, with nested try/catch/finally
and loops? Donât you wish
+in the <a class="xref" href="howto-use-io.html" title="Use I/O API">Use I/O
API</a>, and is recommended reading.</p><div class="table"><a
id="idm161696685328"></a><p class="title"><strong>Table 19.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.io</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><div class="section" title="The Problem"><div
class="titlepage"><div><div><h4 class="title"><a id="_the_problem"></a>The
Problem</h4></div></div></div><p>Why does I/O operations in Java have to be so
complicated, with nested try/catch/finally
and loops? Donât you wish
that the operations could be expressed in a more natural way, such as;</p><pre
class="programlisting brush: java">File source = ...
File destination = ...
source.copyTo( destination );</pre><p>It seems natural to do, yet it is not
present for us. We need to involve FileInputStream/FileOutputStream, wrap them
Modified: zest/site/content/java/develop/core-runtime.html
URL:
http://svn.apache.org/viewvc/zest/site/content/java/develop/core-runtime.html?rev=1689899&r1=1689898&r2=1689899&view=diff
==============================================================================
--- zest/site/content/java/develop/core-runtime.html (original)
+++ zest/site/content/java/develop/core-runtime.html Wed Jul 8 15:17:12 2015
@@ -68,7 +68,7 @@
</head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><a
href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a
href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a
href="samples.html">Samples</a></span></dt><dt><span class="section"><span
xmlns="" href="core.html">Core</span></span></dt><dt><span class="section"><a
href="libraries.html">Libraries</a></span></dt><dt><span class="section"><a
href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a
href="tools.html">Tools</a></span></dt><dt><span class="section"><a
href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span
class="section"><a
href="core.html#_overview_3">Overview</a></span></dt><dt><span
class="section"><a href="core-api.html">Core API</a></span></dt><dt><span
class="section"><a href="core-bootstrap-assembly.html">Core
Bootstrap</a></span></dt><dt><span class="section"><a
href="core-testsupport.html">Core Test Support</a></span></dt><dt><span
class="section"><a href="core-functional.html">Core Functional
API</a></span></dt><dt><span class="section"><a href="core-io.html">Core I/O
API</a></span></dt><dt><span class="section"><a href="core-spi.html">Core
Extension SPI</a></span></dt><dt><span class="section"><span xmlns=""
href="core-runtime.html">Core Runtime</span></span></dt></dl></div></div><div
class="section" title="Core Runtime"><div class="titlepage"><div><div><h3
class="title"><a id="core-runtime"><
/a>Core Runtime</h3></div></div></div><p class="remark"><em><span
class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p
class="devstatus-docs-brief">docs</p><p
class="devstatus-tests-good">tests</p><p>First of all, your code should never,
ever, have a dependency on Core Runtime. If you think you need this, you should
probably contact qi4j-dev forum at Google Groups and see if your usecase can
either be solved in a existing way or perhaps
-that a new Core SPI Extension is needed.</p><div class="table"><a
id="idm415577379984"></a><p class="title"><strong>Table 21.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.runtime</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><p>Letâs repeat that; <span
class="strong"><strong>Never, never, ever depend on Core
Runtime</strong></span>. Make sure that the compile dependency does NOT include
+that a new Core SPI Extension is needed.</p><div class="table"><a
id="idm161696544912"></a><p class="title"><strong>Table 21.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.runtime</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><p>Letâs repeat that; <span
class="strong"><strong>Never, never, ever depend on Core
Runtime</strong></span>. Make sure that the compile dependency does NOT include
the <code class="literal">org.qi4j.core.runtime</code> jar.</p></div><div
xmlns="" xmlns:exsl="http://exslt.org/common" class="footer"><p>
Copyright © 2015 The Apache Software Foundation, Licensed under the
<a href="http://www.apache.org/licenses/" target="_blank">Apache License,
Version 2.0</a>.
<br /><small>
Modified: zest/site/content/java/develop/core-spi.html
URL:
http://svn.apache.org/viewvc/zest/site/content/java/develop/core-spi.html?rev=1689899&r1=1689898&r2=1689899&view=diff
==============================================================================
--- zest/site/content/java/develop/core-spi.html (original)
+++ zest/site/content/java/develop/core-spi.html Wed Jul 8 15:17:12 2015
@@ -68,7 +68,7 @@
</head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><a
href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a
href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a
href="samples.html">Samples</a></span></dt><dt><span class="section"><span
xmlns="" href="core.html">Core</span></span></dt><dt><span class="section"><a
href="libraries.html">Libraries</a></span></dt><dt><span class="section"><a
href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a
href="tools.html">Tools</a></span></dt><dt><span class="section"><a
href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span
class="section"><a
href="core.html#_overview_3">Overview</a></span></dt><dt><span
class="section"><a href="core-api.html">Core API</a></span></dt><dt><span
class="section"><a href="core-bootstrap-assembly.html">Core
Bootstrap</a></span></dt><dt><span class="section"><a
href="core-testsupport.html">Core Test Support</a></span></dt><dt><span
class="section"><a href="core-functional.html">Core Functional
API</a></span></dt><dt><span class="section"><a href="core-io.html">Core I/O
API</a></span></dt><dt><span class="section"><span xmlns=""
href="core-spi.html">Core Extension SPI</span></span></dt><dt><span
class="section"><a href="core-runtime.html">Core
Runtime</a></span></dt></dl></div></div><div class="section" title="Core
Extension SPI"><div class="titlepage"><div><div><h3 class="title"><a
id="core-spi"
></a>Core Extension SPI</h3></div></div></div><p class="remark"><em><span
>class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p
>class="devstatus-docs-brief">docs</p><p
>class="devstatus-tests-good">tests</p><p>The Zest⢠Core Runtime has a
>number of extension points, which we call the <span class="emphasis"><em>Qi4j
>Core Extension SPI</em></span>. These are defined
interfaces used <span class="strong"><strong>only</strong></span> by the Core
Runtime and <span class="strong"><strong>never</strong></span> directly by
application code. <a class="xref" href="extensions.html"
title="Extensions">Extensions</a> are assembled in
-applications during the bootstrap phase.</p><div class="table"><a
id="idm415577440624"></a><p class="title"><strong>Table 20.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.spi</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><p>There are currently 5 Core SPI extensions;</p><div
class="itemizedlist"><ul class="itemizedlist"><li class="listitem">
+applications during the bootstrap phase.</p><div class="table"><a
id="idm161696605552"></a><p class="title"><strong>Table 20.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.spi</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><p>There are currently 5 Core SPI extensions;</p><div
class="itemizedlist"><ul class="itemizedlist"><li class="listitem">
<a class="xref" href="core-spi.html#core-spi-valueserialization"
title="ValueSerialization SPI">ValueSerialization SPI</a>
</li><li class="listitem">
<a class="xref" href="core-spi.html#core-spi-entitystore" title="EntityStore
SPI">EntityStore SPI</a>
Modified: zest/site/content/java/develop/core-testsupport.html
URL:
http://svn.apache.org/viewvc/zest/site/content/java/develop/core-testsupport.html?rev=1689899&r1=1689898&r2=1689899&view=diff
==============================================================================
--- zest/site/content/java/develop/core-testsupport.html (original)
+++ zest/site/content/java/develop/core-testsupport.html Wed Jul 8 15:17:12
2015
@@ -69,7 +69,7 @@
</head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><a
href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a
href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a
href="samples.html">Samples</a></span></dt><dt><span class="section"><span
xmlns="" href="core.html">Core</span></span></dt><dt><span class="section"><a
href="libraries.html">Libraries</a></span></dt><dt><span class="section"><a
href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a
href="tools.html">Tools</a></span></dt><dt><span class="section"><a
href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span
class="section"><a
href="core.html#_overview_3">Overview</a></span></dt><dt><span
class="section"><a href="core-api.html">Core API</a></span></dt><dt><span
class="section"><a href="core-bootstrap-assembly.html">Core
Bootstrap</a></span></dt><dt><span class="section"><span xmlns=""
href="core-testsupport.html">Core Test Support</span></span></dt><dt><span
class="section"><a href="core-functional.html">Core Functional
API</a></span></dt><dt><span class="section"><a href="core-io.html">Core I/O
API</a></span></dt><dt><span class="section"><a href="core-spi.html">Core
Extension SPI</a></span></dt><dt><span class="section"><a
href="core-runtime.html">Core Runtime</a></span></dt></dl></div></div><div
class="section" title="Core Test Support"><div class="titlepage"><div><div><h3
class="title"><a id="core-tests
upport"></a>Core Test Support</h3></div></div></div><p
class="remark"><em><span class="comment"></span></em></p><p
class="devstatus-code-stable">code</p><p
class="devstatus-docs-brief">docs</p><p
class="devstatus-tests-none">tests</p><p>Zest⢠comes with classes to help
with testing. For general development, only a couple of classes are of interest
as the
others are mostly for EntityStore and Index/Query SPI implementations. There
is also some mocking support, to allow
some of Zestâs unique aspects to be mocked, but since Zest⢠is so flexible
at a fine-granular level, we have found that
-mocking is seldom, if ever, needed.</p><div class="table"><a
id="idm415577585936"></a><p class="title"><strong>Table 17.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.testsupport</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><div class="section" title="Your First Testcase"><div
class="titlepage"><div><div><h4 class="title"><a
id="_your_first_testcase"></a>Your First Testcase</h4></div></div></div><p>In
most cases, you will probably use the AbstractQi4jTest class to simplify
starting a Zest⢠test instance.</p><pre class="prog
ramlisting brush: java">public class HelloTest extends AbstractQi4jTest
+mocking is seldom, if ever, needed.</p><div class="table"><a
id="idm161696750864"></a><p class="title"><strong>Table 17.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.core</p></td><td align="left"
valign="top"><p>org.qi4j.core.testsupport</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><div class="section" title="Your First Testcase"><div
class="titlepage"><div><div><h4 class="title"><a
id="_your_first_testcase"></a>Your First Testcase</h4></div></div></div><p>In
most cases, you will probably use the AbstractQi4jTest class to simplify
starting a Zest⢠test instance.</p><pre class="prog
ramlisting brush: java">public class HelloTest extends AbstractQi4jTest
{
[...snip...]
Modified: zest/site/content/java/develop/core.html
URL:
http://svn.apache.org/viewvc/zest/site/content/java/develop/core.html?rev=1689899&r1=1689898&r2=1689899&view=diff
==============================================================================
--- zest/site/content/java/develop/core.html (original)
+++ zest/site/content/java/develop/core.html Wed Jul 8 15:17:12 2015
@@ -68,7 +68,7 @@
</head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><a
href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a
href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a
href="samples.html">Samples</a></span></dt><dt><span class="section"><span
xmlns="" href="core.html">Core</span></span></dt><dt><span class="section"><a
href="libraries.html">Libraries</a></span></dt><dt><span class="section"><a
href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a
href="tools.html">Tools</a></span></dt><dt><span class="section"><a
href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span
class="section"><span xmlns=""
href="core.html#_overview_3">Overview</span></span></dt><dt><span
class="section"><a href="core-api.html">Core API</a></span></dt><dt><span
class="section"><a href="core-bootstrap-assembly.html">Core
Bootstrap</a></span></dt><dt><span class="section"><a
href="core-testsupport.html">Core Test Support</a></span></dt><dt><span
class="section"><a href="core-functional.html">Core Functional
API</a></span></dt><dt><span class="section"><a href="core-io.html">Core I/O
API</a></span></dt><dt><span class="section"><a href="core-spi.html">Core
Extension SPI</a></span></dt><dt><span class="section"><a
href="core-runtime.html">Core Runtime</a></span></dt></dl></div></div><div
class="section" title="Core"><div class="titlepage"><div><div><h2
class="title"><a id="core"></a>Core</h2></di
v></div></div><div class="section" title="Overview"><div
class="titlepage"><div><div><h3 class="title"><a
id="_overview_3"></a>Overview</h3></div></div></div><p>The Zest⢠Core is
composed of several artifacts described in this section.</p><p>The following
figure show the Core artifacts alongside <a class="link" href="libraries.html"
title="Libraries">libraries</a> and <a class="link" href="extensions.html"
title="Extensions">extensions</a>, and, in green,
typical applications artifacts. This is not a full code dependency graph but
should give you a good overview of how the
-pieces fit together. Find out more about each of the Zest⢠Core artifacts
below.</p><div class="figure"><a id="idm415578151280"></a><p
class="title"><strong>Figure 1. Zest⢠Core Overview</strong></p><div
class="figure-contents"><a class="ulink" href="images/core-overview.png"
target="_top">
+pieces fit together. Find out more about each of the Zest⢠Core artifacts
below.</p><div class="figure"><a id="idm161702197744"></a><p
class="title"><strong>Figure 1. Zest⢠Core Overview</strong></p><div
class="figure-contents"><a class="ulink" href="images/core-overview.png"
target="_top">
<span class="inlinemediaobject"><img src="images/core-overview.png"
alt="core-overview.png" /></span>
</a></div></div><br class="figure-break" /><div class="section" title="Core
API"><div class="titlepage"><div><div><h4 class="title"><a
id="_core_api"></a>Core API</h4></div></div></div><p>The Zest⢠Core API is
the primary interface for client application code during the main execution
phase, i.e. after the
application has been activated.</p><p><a class="link" href="core-api.html"
title="Core API">Learn more</a></p></div><div class="section" title="Core
Bootstrap"><div class="titlepage"><div><div><h4 class="title"><a
id="_core_bootstrap"></a>Core Bootstrap</h4></div></div></div><p>Zest⢠has a
distinct bootstrap phase, also known as the <span
class="emphasis"><em>Assembly</em></span> of an application, where the
applications structure
@@ -78,10 +78,10 @@ to a module and visibility rules define
aspects to be mocked, but since Zest⢠is so flexible at a fine-granular
level, we have found that mocking is seldom,
if ever, needed.</p><p><a class="link" href="core-testsupport.html"
title="Core Test Support">Learn more</a></p></div><div class="section"
title="Core Functional API"><div class="titlepage"><div><div><h4
class="title"><a id="_core_functional_api"></a>Core Functional
API</h4></div></div></div><p>The Zest⢠Core Functional API is a generic
package to work with Iterables in a "functional programming language"
style.</p><p>This package is completely independent of everything else in
Zest⢠and may be used on its own in any kind of environment
such as Spring or Java EE applications.</p><p><a class="link"
href="core-functional.html" title="Core Functional API">Learn
more</a></p></div><div class="section" title="Core I/O API"><div
class="titlepage"><div><div><h4 class="title"><a id="_core_i_o_api"></a>Core
I/O API</h4></div></div></div><p>The Zest⢠Core I/O API tries to address the
problem around shuffling data around from various I/O inputs and outputs,
-possibly with transformations and filtering along the way.</p><p><a
class="link" href="core-io.html" title="Core I/O API">Learn
more</a></p></div><div class="section" title="Core Extension SPI"><div
class="titlepage"><div><div><h4 class="title"><a
id="_core_extension_spi"></a>Core Extension SPI</h4></div></div></div><p>The
Zest⢠Core Runtime has a number of extension points, which we call the <span
class="emphasis"><em>Qi4j Core Extension SPI</em></span>. These are defined
+possibly with transformations and filtering along the way.</p><p><a
class="link" href="core-io.html" title="Core I/O API">Learn
more</a></p></div><div class="section" title="Core Extension SPI"><div
class="titlepage"><div><div><h4 class="title"><a
id="_core_extension_spi"></a>Core Extension SPI</h4></div></div></div><p>The
Zest⢠Core Runtime has a number of extension points, which we call the <span
class="emphasis"><em>Zest⢠Core Extension SPI</em></span>. These are defined
interfaces used <span class="strong"><strong>only</strong></span> by the Core
Runtime and <span class="strong"><strong>never</strong></span> directly by
application code. <a class="xref" href="extensions.html"
title="Extensions">Extensions</a> are assembled in
applications during the bootstrap phase.</p><p><a class="link"
href="core-spi.html" title="Core Extension SPI">Learn more</a></p></div><div
class="section" title="Core Runtime"><div class="titlepage"><div><div><h4
class="title"><a id="_core_runtime"></a>Core
Runtime</h4></div></div></div><p>Your code should <span
class="strong"><strong>never</strong></span>, <span
class="strong"><strong>ever</strong></span>, have a dependency on Zest⢠Core
Runtime. If you think you need this, you should
-probably contact qi4j-dev forum at Google Groups and see if your usecase can
either be solved in a existing way or
+probably contact <a class="ulink" href="mailto:[email protected]"
target="_top">[email protected]</a> and see if your usecase can either be
solved in a existing way or
perhaps that a new Core Extension SPI is needed.</p><p><a class="link"
href="core-runtime.html" title="Core Runtime">Learn
more</a></p></div></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="footer"><p>
Copyright © 2015 The Apache Software Foundation, Licensed under the
<a href="http://www.apache.org/licenses/" target="_blank">Apache License,
Version 2.0</a>.
<br /><small>
Modified: zest/site/content/java/develop/extension-cache-ehcache.html
URL:
http://svn.apache.org/viewvc/zest/site/content/java/develop/extension-cache-ehcache.html?rev=1689899&r1=1689898&r2=1689899&view=diff
==============================================================================
--- zest/site/content/java/develop/extension-cache-ehcache.html (original)
+++ zest/site/content/java/develop/extension-cache-ehcache.html Wed Jul 8
15:17:12 2015
@@ -66,7 +66,7 @@
})();
</script>
- </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><a
href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a
href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a
href="samples.html">Samples</a></span></dt><dt><span class="section"><a
href="core.html">Core</a></span></dt><dt><span class="section"><a
href="libraries.html">Libraries</a></span></dt><dt><span class="section"><span
xmlns="" href="extensions.html">Extensions</span></span></dt><dt><span
class="section"><a href="tools.html">Tools</a></span></dt><dt><span
class="section"><a href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span
class="section"><a
href="extensions.html#_overview_7">Overview</a></span></dt><dt><span
class="section"><a href="extension-vs-orgjson.html">org.json
ValueSerialization</a></span></dt><dt><span class="section"><a
href="extension-vs-jackson.html">Jackson
ValueSerialization</a></span></dt><dt><span class="section"><a
href="extension-vs-stax.html">StAX ValueSerialization</a></span></dt><dt><span
class="section"><span xmlns="" href="extension-cache-ehcache.html">Ehcache
Cache</span></span></dt><dt><span class="section"><a
href="extension-cache-memcache.html">Memcache Cache</a></span></dt><dt><span
class="section"><a href="extension-es-memory.html">Memory
EntityStore</a></span></dt><dt><span class="section"><a
href="extension-es-file.html">File EntityStore</a></span></dt><dt><span
class="section"><a href="ext
ension-es-hazelcast.html">Hazelcast EntityStore</a></span></dt><dt><span
class="section"><a href="extension-es-jclouds.html">JClouds
EntityStore</a></span></dt><dt><span class="section"><a
href="extension-es-jdbm.html">JDBM EntityStore</a></span></dt><dt><span
class="section"><a href="extension-es-leveldb.html">LevelDB
EntityStore</a></span></dt><dt><span class="section"><a
href="extension-es-mongodb.html">MongoDB EntityStore</a></span></dt><dt><span
class="section"><a href="extension-es-preferences.html">Preferences
EntityStore</a></span></dt><dt><span class="section"><a
href="extension-es-redis.html">Redis EntityStore</a></span></dt><dt><span
class="section"><a href="extension-es-riak.html">Riak
EntityStore</a></span></dt><dt><span class="section"><a
href="extension-es-sql.html">SQL EntityStore</a></span></dt><dt><span
class="section"><a href="extension-es-voldemort.html">Voldemort
EntityStore</a></span></dt><dt><span class="section"><a
href="extension-index-elasticsearch.html">El
asticSearch Index/Query</a></span></dt><dt><span class="section"><a
href="extension-index-rdf.html">OpenRDF Index/Query</a></span></dt><dt><span
class="section"><a href="extension-index-solr.html">Apache Solr
Index/Query</a></span></dt><dt><span class="section"><a
href="extension-indexing-sql.html">SQL Index/Query</a></span></dt><dt><span
class="section"><a href="extension-metrics-yammer.html">Yammer
Metrics</a></span></dt><dt><span class="section"><a
href="extension-migration.html">Migration</a></span></dt><dt><span
class="section"><a
href="extension-reindexer.html">Reindexer</a></span></dt></dl></div></div><div
class="section" title="Ehcache Cache"><div class="titlepage"><div><div><h3
class="title"><a id="extension-cache-ehcache"></a>Ehcache
Cache</h3></div></div></div><p class="remark"><em><span
class="comment"></span></em></p><p class="devstatus-code-beta">code</p><p
class="devstatus-docs-brief">docs</p><p
class="devstatus-tests-some">tests</p><p>EntityStore cache backed by <a c
lass="ulink" href="http://ehcache.org/" target="_top">EhCache</a>.</p><div
class="table"><a id="idm415586899600"></a><p class="title"><strong>Table 57.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.extension</p></td><td align="left"
valign="top"><p>org.qi4j.extension.cache-ehcache</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><p>Not all EntityStore implementations use the Cache
extension, so check the implementation details of the
+ </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><a
href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a
href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a
href="samples.html">Samples</a></span></dt><dt><span class="section"><a
href="core.html">Core</a></span></dt><dt><span class="section"><a
href="libraries.html">Libraries</a></span></dt><dt><span class="section"><span
xmlns="" href="extensions.html">Extensions</span></span></dt><dt><span
class="section"><a href="tools.html">Tools</a></span></dt><dt><span
class="section"><a href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common" class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span
class="section"><a
href="extensions.html#_overview_7">Overview</a></span></dt><dt><span
class="section"><a href="extension-vs-orgjson.html">org.json
ValueSerialization</a></span></dt><dt><span class="section"><a
href="extension-vs-jackson.html">Jackson
ValueSerialization</a></span></dt><dt><span class="section"><a
href="extension-vs-stax.html">StAX ValueSerialization</a></span></dt><dt><span
class="section"><span xmlns="" href="extension-cache-ehcache.html">Ehcache
Cache</span></span></dt><dt><span class="section"><a
href="extension-cache-memcache.html">Memcache Cache</a></span></dt><dt><span
class="section"><a href="extension-es-memory.html">Memory
EntityStore</a></span></dt><dt><span class="section"><a
href="extension-es-file.html">File EntityStore</a></span></dt><dt><span
class="section"><a href="ext
ension-es-hazelcast.html">Hazelcast EntityStore</a></span></dt><dt><span
class="section"><a href="extension-es-jclouds.html">JClouds
EntityStore</a></span></dt><dt><span class="section"><a
href="extension-es-jdbm.html">JDBM EntityStore</a></span></dt><dt><span
class="section"><a href="extension-es-leveldb.html">LevelDB
EntityStore</a></span></dt><dt><span class="section"><a
href="extension-es-mongodb.html">MongoDB EntityStore</a></span></dt><dt><span
class="section"><a href="extension-es-preferences.html">Preferences
EntityStore</a></span></dt><dt><span class="section"><a
href="extension-es-redis.html">Redis EntityStore</a></span></dt><dt><span
class="section"><a href="extension-es-riak.html">Riak
EntityStore</a></span></dt><dt><span class="section"><a
href="extension-es-sql.html">SQL EntityStore</a></span></dt><dt><span
class="section"><a href="extension-es-voldemort.html">Voldemort
EntityStore</a></span></dt><dt><span class="section"><a
href="extension-index-elasticsearch.html">El
asticSearch Index/Query</a></span></dt><dt><span class="section"><a
href="extension-index-rdf.html">OpenRDF Index/Query</a></span></dt><dt><span
class="section"><a href="extension-index-solr.html">Apache Solr
Index/Query</a></span></dt><dt><span class="section"><a
href="extension-indexing-sql.html">SQL Index/Query</a></span></dt><dt><span
class="section"><a href="extension-metrics-yammer.html">Yammer
Metrics</a></span></dt><dt><span class="section"><a
href="extension-migration.html">Migration</a></span></dt><dt><span
class="section"><a
href="extension-reindexer.html">Reindexer</a></span></dt></dl></div></div><div
class="section" title="Ehcache Cache"><div class="titlepage"><div><div><h3
class="title"><a id="extension-cache-ehcache"></a>Ehcache
Cache</h3></div></div></div><p class="remark"><em><span
class="comment"></span></em></p><p class="devstatus-code-beta">code</p><p
class="devstatus-docs-brief">docs</p><p
class="devstatus-tests-some">tests</p><p>EntityStore cache backed by <a c
lass="ulink" href="http://ehcache.org/" target="_top">EhCache</a>.</p><div
class="table"><a id="idm161695371088"></a><p class="title"><strong>Table 57.Â
Artifact</strong></p><div class="table-contents"><table summary="Artifact"
border="1"><colgroup><col class="col_1" /><col class="col_2" /><col
class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group
ID</th><th align="left" valign="top">Artifact ID</th><th align="left"
valign="top">Version</th></tr></thead><tbody><tr><td align="left"
valign="top"><p>org.qi4j.extension</p></td><td align="left"
valign="top"><p>org.qi4j.extension.cache-ehcache</p></td><td align="left"
valign="top"><p>0</p></td></tr></tbody></table></div></div><br
class="table-break" /><p>Not all EntityStore implementations use the Cache
extension, so check the implementation details of the
EntityStore whether the cache extension can bring any benefits or not.</p><div
class="section" title="Assembly"><div class="titlepage"><div><div><h4
class="title"><a
id="_assembly_8"></a>Assembly</h4></div></div></div><p>Assembly is done using
the provided Assembler:</p><pre class="programlisting brush: java">public void
assemble( ModuleAssembly module )
throws AssemblyException
{