You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltaspike.apache.org by ra...@apache.org on 2014/12/15 23:31:28 UTC
svn commit: r1645776 [2/7] - /deltaspike/site/trunk/content/documentation/
Added: deltaspike/site/trunk/content/documentation/configure.html
URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/documentation/configure.html?rev=1645776&view=auto
==============================================================================
--- deltaspike/site/trunk/content/documentation/configure.html (added)
+++ deltaspike/site/trunk/content/documentation/configure.html Mon Dec 15 22:31:27 2014
@@ -0,0 +1,372 @@
+<!DOCTYPE html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta name="description" content="deltaspike-generate-pages">
+<meta name="author" content="chm">
+
+<title>Configure DeltaSpike in Your Projects</title>
+
+<!-- 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. -->
+
+<!-- Styles -->
+
+<link href="https://deltaspike.apache.org/resources/css/bootstrap.css" rel="stylesheet">
+<link href="https://deltaspike.apache.org/resources/css/bootstrap-responsive.css" rel="stylesheet">
+
+<style type="text/css">
+/* 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}
+body {
+ padding-top: 60px;
+ padding-bottom: 40px;
+}
+</style>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-36103647-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</head>
+
+<body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse"
+ data-target=".nav-collapse"> <span class="icon-bar"></span> <span
+ class="icon-bar"></span> <span class="icon-bar"></span>
+ </a> <a class="brand logocolor"
+ href="http://deltaspike.apache.org/index.html">Apache DeltaSpike []</a>
+ <div class="nav-collapse">
+ <ul class="nav">
+ <li class="active"><a
+ href="index.html">Home</a></li>
+ <li><a href="../documentation">Documentation</a></li>
+ <li><a href="../javadoc.html">Javadoc</a></li>
+ <li><a href="../documentation/source.html">Source</a></li>
+ <li><a href="../download.html">Download</a></li>
+ <li><a href="../community.html">Community</a></li>
+ <!-- <li><a href="./support.html">Support</a></li> -->
+ <li><a href="../news.html">News</a></li>
+ <li><a href="../migration-guide.html">Migration</a></li>
+ </ul>
+ </div>
+ <!--/.nav-collapse -->
+ <form id="search-form" action="http://www.google.com/search"
+ method="get" class="navbar-search pull-right">
+ <input value="deltaspike.apache.org" name="sitesearch"
+ type="hidden"> <input class="search-query" name="q"
+ id="query" type="text">
+ </form>
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div class="row">
+ <div class="span12">
+ <div class="page-title">
+ <h1>Configure DeltaSpike in Your Projects</h1>
+ </div>
+
+ <div id="toc" class="toc">
+ <ul class="sectlevel1">
+<li><a href="#_option_a_configure_deltaspike_in_maven_based_projects">Option A: Configure DeltaSpike in Maven-based Projects</a></li>
+<li><a href="#config-maven-indep">Option B: Configure DeltaSpike in Maven-independent Projects</a></li>
+<li><a href="#_next">Next</a></li>
+</ul>
+ <hr>
+
+ <div id="preamble">
+<div class="sectionbody">
+<div class="paragraph">
+<p>DeltaSpike is available for use in Maven-based and Maven-independent projects. Instructions are given here for obtaining released final versions of DeltaSpike for both approaches.</p>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+You can also opt to use the lastest DeltaSpike snapshots; for more information, see <a href="snapshots.html">Use DeltaSpike Snapshots</a>.
+</td>
+</tr>
+</table>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_option_a_configure_deltaspike_in_maven_based_projects">Option A: Configure DeltaSpike in Maven-based Projects</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>DeltaSpike released versions are available from the Maven Central repository for use in Maven-based projects. This means that you do not need to modify your Maven configuration <code>settings.xml</code> file; when building projects, Maven automatically searches the online Maven Central repository for project dependencies and downloads sources to your local Maven repository.</p>
+</div>
+<div class="paragraph">
+<p>To begin use the DeltaSpike releases from Maven Central, you simply need to configure the project <code>pom.xml</code> file for each project with information about the release version and modules you want to use. At a minimum, you must add the DeltaSpike Core module, which provides the DeltaSpike API and utility classes.</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Open the project <code>pom.xml</code> file for editing</p>
+</li>
+<li>
+<p>Add the DeltaSpike version to the list of properties</p>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><properties></span>
+ <span class="tag"><deltaspike.version></span>1.2.0<span class="tag"></deltaspike.version></span>
+<span class="tag"></properties></span></code></pre>
+</div>
+</div>
+</li>
+<li>
+<p>Add the DeltaSpike Core module to the list of dependencies</p>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
+ <span class="tag"><groupId></span>org.apache.deltaspike.core<span class="tag"></groupId></span>
+ <span class="tag"><artifactId></span>deltaspike-core-api<span class="tag"></artifactId></span>
+ <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
+ <span class="tag"><scope></span>compile<span class="tag"></scope></span>
+<span class="tag"></dependency></span>
+
+<span class="tag"><dependency></span>
+ <span class="tag"><groupId></span>org.apache.deltaspike.core<span class="tag"></groupId></span>
+ <span class="tag"><artifactId></span>deltaspike-core-impl<span class="tag"></artifactId></span>
+ <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
+ <span class="tag"><scope></span>runtime<span class="tag"></scope></span>
+<span class="tag"></dependency></span></code></pre>
+</div>
+</div>
+</li>
+<li>
+<p>Save the <code>pom.xml</code> file changes</p>
+</li>
+</ol>
+</div>
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Tip</div>
+</td>
+<td class="content">
+The API is scoped for compile time and implementation only included for runtime, assisting to prevent you from inadvertantly depending on an implementation class.
+</td>
+</tr>
+</table>
+</div>
+<div class="paragraph">
+<p>For instructions on adding the optional DeltaSpike modules, see the relevant module page:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><a href="bean-validation.html">Bean Validation</a></p>
+</li>
+<li>
+<p><a href="container-control.html">Container Control</a></p>
+</li>
+<li>
+<p><a href="data.html">Data</a></p>
+</li>
+<li>
+<p><a href="jpa.html">JPA</a></p>
+</li>
+<li>
+<p><a href="jsf.html">JSF</a></p>
+</li>
+<li>
+<p><a href="partial-bean.html">Partial-Bean</a></p>
+</li>
+<li>
+<p><a href="scheduler.html">Scheduler</a></p>
+</li>
+<li>
+<p><a href="security.html">Security</a></p>
+</li>
+<li>
+<p><a href="servlet.html">Servlet</a></p>
+</li>
+<li>
+<p><a href="test-control.html">Test-Control</a></p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="config-maven-indep">Option B: Configure DeltaSpike in Maven-independent Projects</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>Deltaspike is provided as a set of downloadable .jar files for projects not utilizing the Maven build system. Alternatively, you can build the DeltaSpike .jar files from source; for instructions, see <a href="build.html">Build DeltaSpike from Source</a>. In both cases, you must add the DeltaSpike .jar files directly to your projects.</p>
+</div>
+<div class="paragraph">
+<p>To use DeltaSpike without Maven from the downloadable .jar files, complete the following steps:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Download the latest <code>distribution-full-<version>.zip</code> from <a href="https://deltaspike.apache.org/download.html" class="bare">https://deltaspike.apache.org/download.html</a></p>
+</li>
+<li>
+<p>Extract the archive contents</p>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="shell">$ unzip distribution-full-<version>.zip</code></pre>
+</div>
+</div>
+</li>
+<li>
+<p>Add the source to your project</p>
+<div class="olist loweralpha">
+<ol class="loweralpha" type="a">
+<li>
+<p>For .war projects, copy the .jar files to the <code>WEB-INF/lib</code> directory</p>
+</li>
+<li>
+<p>For .ear projects, copy the .jar files to the <code>EAR/lib directory</code> and add the following to <code>META-INF/application.xml</code>:</p>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><library-directory></span>lib<span class="tag"></library-directory></span></code></pre>
+</div>
+</div>
+</li>
+</ol>
+</div>
+</li>
+</ol>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_next">Next</h2>
+<div class="sectionbody">
+<div class="ulist">
+<ul>
+<li>
+<p>To check whether your Java environment needs any additional CDI-specific configuration, see <a href="cdiimp.html">Enable CDI For Your Java Environment</a>.</p>
+</li>
+<li>
+<p>To see ready-to-deploy example DeltaSpike applications, see <a href="examples.html">See DeltaSpike in Action</a>.</p>
+</li>
+<li>
+<p>To understand how the various DeltaSpike modules can enhance and extend your applications, see <a href="modules.html">Overview of DeltaSpike Modules</a> and the individual module pages.</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+ </div>
+
+ <hr>
+
+ <footer>
+ <p>Copyright © 2011-2014 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.</p>
+ <p>Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
+ </footer>
+
+ </div>
+ <!-- /.container -->
+
+</body>
+</html>
\ No newline at end of file
Modified: deltaspike/site/trunk/content/documentation/container-control.html
URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/documentation/container-control.html?rev=1645776&r1=1645775&r2=1645776&view=diff
==============================================================================
--- deltaspike/site/trunk/content/documentation/container-control.html (original)
+++ deltaspike/site/trunk/content/documentation/container-control.html Mon Dec 15 22:31:27 2014
@@ -6,7 +6,7 @@
<meta name="description" content="deltaspike-generate-pages">
<meta name="author" content="chm">
-<title>Container & Control</title>
+<title>Container Control Module</title>
<!-- 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. -->
@@ -134,7 +134,7 @@ body {
data-target=".nav-collapse"> <span class="icon-bar"></span> <span
class="icon-bar"></span> <span class="icon-bar"></span>
</a> <a class="brand logocolor"
- href="http://deltaspike.apache.org/index.html">Apache DeltaSpike</a>
+ href="http://deltaspike.apache.org/index.html">Apache DeltaSpike []</a>
<div class="nav-collapse">
<ul class="nav">
<li class="active"><a
@@ -164,15 +164,26 @@ body {
<div class="row">
<div class="span12">
<div class="page-title">
- <h1>Container & Control</h1>
+ <h1>Container Control Module</h1>
</div>
<div id="toc" class="toc">
<ul class="sectlevel1">
-<li><a href="#_introduction">Introduction</a>
+<li><a href="#_overview">Overview</a></li>
+<li><a href="#_configure_your_projects">Configure Your Projects</a>
+<ul class="sectlevel2">
+<li><a href="#_declare_container_control_module_dependencies">Declare Container Control Module Dependencies</a></li>
+</ul>
+</li>
+<li><a href="#_use_the_module_features">Use the Module Features</a>
<ul class="sectlevel2">
<li><a href="#_cdicontainer">CdiContainer</a></li>
-<li><a href="#_contextcontrol_usage">ContextControl usage</a></li>
+<li><a href="#_contextcontrol_usage">ContextControl Usage</a>
+<ul class="sectlevel3">
+<li><a href="#_restart_the_requestcontext_in_unit_tests">Restart the RequestContext in Unit Tests</a></li>
+<li><a href="#_attach_a_requestcontext_to_a_new_thread_in_ee">Attach a RequestContext to a New Thread in EE</a></li>
+</ul>
+</li>
<li><a href="#_embedded_servlet_support">Embedded Servlet Support</a>
<ul class="sectlevel3">
<li><a href="#_jetty">Jetty</a></li>
@@ -186,61 +197,60 @@ body {
<hr>
<div class="sect1">
-<h2 id="_introduction">Introduction</h2>
+<h2 id="_overview">Overview</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>There are basically two parts:</p>
+<p>The Container Control module provides CDI container booting and shutdown, crucial for CDI use in Java SE6+ environments, and associated context lifecycle management. The module abstracts individual CDI container implementations, ensuring projects are container-independent.</p>
</div>
-<div class="ulist">
-<ul>
-<li>
-<p>The <code>CdiContainer</code> interface allows to boot and shutdown the CDI container in SE applications.</p>
-</li>
-<li>
-<p>The <code>ContextControl</code> interface allows to control the life-cycle of the built-in contexts of the CDI container.</p>
-</li>
-</ul>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_configure_your_projects">Configure Your Projects</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The configuration information provided here is for Maven-based projects and it assumes that you have already declared the DeltaSpike version and DeltaSpike Core module for your projects, as detailed in <a href="configure.html">Configure DeltaSpike in Your Projects</a>. For Maven-independent projects, see <a href="configure.html#config-maven-indep">Configure DeltaSpike in Maven-independent Projects</a>.</p>
</div>
<div class="sect2">
-<h3 id="_cdicontainer">CdiContainer</h3>
+<h3 id="_declare_container_control_module_dependencies">Declare Container Control Module Dependencies</h3>
<div class="paragraph">
-<p>You can use the <code>CdiContainerLoader</code> as a simple factory to gain access
-to the underlying <code>CdiContainer</code> implementation. This is of little
-interest for Java EE applications since the CDI Container already gets
-properly booted and shut down by the Servlet container integration.</p>
+<p>Add the Container Control module to the list of dependencies in the project <code>pom.xml</code> file using this code snippet:</p>
</div>
<div class="listingblock">
<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="comment">// this will give you a CdiContainer for Weld or OWB, depending on the jar you added</span>
-CdiContainer cdiContainer = CdiContainerLoader.getCdiContainer();
-
-<span class="comment">// now we gonna boot the CDI container. This will trigger the classpath scan, etc</span>
-cdiContainer.boot();
-
-<span class="comment">// and finally we like to start all built-in contexts</span>
-cdiContainer.getContextControl().startContexts();
-
-<span class="comment">// now we can use CDI in our SE application.</span>
-<span class="comment">// And there is not a single line of OWB or Weld specific code in your project!</span>
-
-<span class="comment">// finally we gonna stop the container</span>
-cdiContainer.shutdown();</code></pre>
+<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
+ <span class="tag"><groupId></span>org.apache.deltaspike.cdictrl<span class="tag"></groupId></span>
+ <span class="tag"><artifactId></span>deltaspike-cdictrl-api<span class="tag"></artifactId></span>
+ <span class="tag"><version></span>${deltaspike.version}<span class="tag"></version></span>
+ <span class="tag"><scope></span>compile<span class="tag"></scope></span>
+<span class="tag"></dependency></span></code></pre>
+</div>
+</div>
</div>
</div>
</div>
+<div class="sect1">
+<h2 id="_use_the_module_features">Use the Module Features</h2>
+<div class="sectionbody">
<div class="sect2">
-<h3 id="_contextcontrol_usage">ContextControl usage</h3>
+<h3 id="_cdicontainer">CdiContainer</h3>
<div class="paragraph">
-<p>The <code>ContextControl</code> interface allows you to start and stop built-in
-standard Contexts like <code>@RequestScoped</code>, <code>@ConversationScoped</code>,
-<code>@SessionScoped</code>, etc. It is provided as <code>@Dependent</code> bean and can get
-injected in the classic CDI way. This is not only usable in Java SE
-projects but also very helpful in Servlets and Java EE containers.</p>
+<p>The <code>CdiContainer</code> interface provides booting and shutdown of the CDI containers from deployed applications, with <code>CdiContainerLoader</code> a simple factory providing access to the underlying <code>CdiContainer</code> implementation.</p>
</div>
<div class="paragraph">
-<p><strong>Restarting the RequestContext in unit tests</strong></p>
+<p>This is useful to Java SE6+ applications in which a standalone CDI implementation must be provided and booted and shutdown by the application. Booting and shutdown of the CDI container for Java EE and servlet containers is managed by the servlet container integration.</p>
</div>
<div class="paragraph">
+<p>For instructions and examples on using this feature in your projects, see <a href="cdiimp.html#javase6">Enable CDI For Your Java Environment: Java SE6+</a>.</p>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_contextcontrol_usage">ContextControl Usage</h3>
+<div class="paragraph">
+<p>The <code>ContextControl</code> interface provides life-cycle control of the CDI container built-in contexts. This includes starting and stoping built-in standard contexts like <code>@RequestScoped</code>, <code>@ConversationScoped</code>, and <code>@SessionScoped</code>. It is provided as an <code>@Dependent</code> bean and can be injected in the classic CDI way. This feature can be used and is helpful in all Java environments, including Java SE, as illustrated here.</p>
+</div>
+<div class="sect3">
+<h4 id="_restart_the_requestcontext_in_unit_tests">Restart the RequestContext in Unit Tests</h4>
+<div class="paragraph">
<p>In unit testing it can be necessary to test with attached and also with
detached JPA entities. A very common approach for JPA is the
<a href="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Web_Server/1.0/html/Hibernate_Entity_Manager_Reference_Guide/transactions.html">entitymanager-per-request
@@ -248,10 +258,8 @@ approach</a> and thus have a producer me
EntityManager. Since a single unit test is usually treated as one
ârequestâ a problem arises detaching entities.</p>
</div>
-<div class="paragraph">
-<p>Using ContextControl to detach entities:</p>
-</div>
<div class="listingblock">
+<div class="title">Using ContextControl to Detach Entities</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Test</span>
<span class="directive">public</span> <span class="type">void</span> testMyBusinessLogic()
@@ -261,32 +269,30 @@ EntityManager. Since a single unit test
ContextControl ctxCtrl = BeanProvider.getContextualReference(ContextControl.class);
- <span class="comment">//stopping the request context will dispose the @RequestScoped EntityManager</span>
+ <span class="comment">//stop the RequestContext to dispose of the @RequestScoped EntityManager</span>
ctxCtrl.stopContext(RequestScoped.class);
- <span class="comment">// and now immediately restart the context again</span>
+ <span class="comment">//immediately restart the context again</span>
ctxCtrl.startContext(RequestScoped.class);
- <span class="comment">// the entity 'em' is now in a detached state!</span>
+ <span class="comment">//the entity 'em' is now in a detached state!</span>
doSomeStuffWithTheDetachedEntity(em);
}</code></pre>
</div>
</div>
-<div class="paragraph">
-<p>Attaching a Request Context to a new thread in EE</p>
</div>
+<div class="sect3">
+<h4 id="_attach_a_requestcontext_to_a_new_thread_in_ee">Attach a RequestContext to a New Thread in EE</h4>
<div class="paragraph">
<p>Accessing the <code>@RequestScoped</code> bean in a new thread will result in a
-<code>ContextNotActiveException</code>. The request-context usually gets started
+<code>ContextNotActiveException</code>. The RequestContext usually gets started
for a particular thread via a simple <code>ServletRequestListener</code>. So "no
servlet-request" means that there is no Servlet-Context for the current
(/new) Thread. You might face such issues, if you would like to reuse
-business services in e.g. a Quartz Job.</p>
-</div>
-<div class="paragraph">
-<p>Controlling the request-context for a Quartz-Job:</p>
+business services in for example a Quartz Job.</p>
</div>
<div class="listingblock">
+<div class="title">Using ContextControl to Control the RequestContext for a Quartz-Job</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="type">class</span> <span class="class">CdiJob</span> <span class="directive">implements</span> org.quartz.Job
{
@@ -311,10 +317,11 @@ business services in e.g. a Quartz Job.<
</div>
</div>
</div>
+</div>
<div class="sect2">
<h3 id="_embedded_servlet_support">Embedded Servlet Support</h3>
<div class="paragraph">
-<p>Starting with 1.0.2, you can use DeltaSpike to power embedded Servlet
+<p>From DeltaSpike 1.0.2, you can use DeltaSpike to power embedded Servlet
runtimes. This work is done via Servlet Listeners. The configuration is
specific to each container, below are some examples.</p>
</div>
@@ -327,7 +334,7 @@ use <code>CdiServletContextListener</cod
<code>CdiServletRequestListener</code>.</p>
</div>
<div class="paragraph">
-<p>The main usecase for this feature is for lightweight embedded runtimes,
+<p>The main use case for this feature is for lightweight embedded runtimes,
microservices. For each of these, it is assumed that you are using the
following start up code somewhere:</p>
</div>
Modified: deltaspike/site/trunk/content/documentation/core.html
URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/documentation/core.html?rev=1645776&r1=1645775&r2=1645776&view=diff
==============================================================================
--- deltaspike/site/trunk/content/documentation/core.html (original)
+++ deltaspike/site/trunk/content/documentation/core.html Mon Dec 15 22:31:27 2014
@@ -6,7 +6,7 @@
<meta name="description" content="deltaspike-generate-pages">
<meta name="author" content="chm">
-<title>Core</title>
+<title>Core Module</title>
<!-- 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. -->
@@ -134,7 +134,7 @@ body {
data-target=".nav-collapse"> <span class="icon-bar"></span> <span
class="icon-bar"></span> <span class="icon-bar"></span>
</a> <a class="brand logocolor"
- href="http://deltaspike.apache.org/index.html">Apache DeltaSpike</a>
+ href="http://deltaspike.apache.org/index.html">Apache DeltaSpike []</a>
<div class="nav-collapse">
<ul class="nav">
<li class="active"><a
@@ -164,69 +164,57 @@ body {
<div class="row">
<div class="span12">
<div class="page-title">
- <h1>Core</h1>
+ <h1>Core Module</h1>
</div>
<div id="toc" class="toc">
<ul class="sectlevel1">
-<li><a href="#_core_api">Core - API</a>
+<li><a href="#_overview">Overview</a></li>
+<li><a href="#_configure_your_projects">Configure Your Projects</a></li>
+<li><a href="#_use_the_module_features">Use the Module Features</a>
<ul class="sectlevel2">
+<li><a href="#_core_api">Core - API</a>
+<ul class="sectlevel3">
<li><a href="#_deltaspike_configuration">DeltaSpike Configuration</a></li>
<li><a href="#_beanprovider">BeanProvider</a></li>
<li><a href="#_beanmanagerprovider">BeanManagerProvider</a></li>
<li><a href="#_type_safe_projectstage">Type-safe ProjectStage</a></li>
<li><a href="#__exclude">@Exclude</a>
-<ul class="sectlevel3">
+<ul class="sectlevel4">
<li><a href="#_custom_expressioninterpreter">Custom ExpressionInterpreter</a></li>
</ul>
</li>
<li><a href="#_type_safe_view_config">Type-safe View-Config</a></li>
<li><a href="#_literals">Literals</a></li>
-<li><a href="#_messages_i18n">Messages & I18n</a></li>
+<li><a href="#_messages_and_i18n">Messages and I18n</a></li>
<li><a href="#_dynamic_message_builder">Dynamic Message Builder</a>
-<ul class="sectlevel3">
-<li><a href="#_creating_message_instances">Creating message instances</a></li>
-<li><a href="#_customizing_the_message_context">Customizing the message context</a>
<ul class="sectlevel4">
-<li><a href="#_messageresolver">MessageResolver</a></li>
-<li><a href="#_messageinterpolator">MessageInterpolator</a></li>
-<li><a href="#_localeresolver">LocaleResolver</a></li>
-</ul>
-</li>
+<li><a href="#_creating_message_instances">Creating Message Instances</a></li>
+<li><a href="#_customizing_the_message_context">Customizing the Message Context</a></li>
</ul>
</li>
<li><a href="#_injecting_resources">Injecting Resources</a></li>
<li><a href="#_exception_control">Exception Control</a>
-<ul class="sectlevel3">
-<li><a href="#_usage">Usage</a></li>
-<li><a href="#_exception_handlers">Exception handlers</a>
<ul class="sectlevel4">
-<li><a href="#__exceptionhandler">@ExceptionHandler</a></li>
-<li><a href="#__handles_and_beforehandles">@Handles and @BeforeHandles</a></li>
-<li><a href="#_ordinal">Ordinal</a></li>
-</ul>
-</li>
+<li><a href="#_usage">Usage</a></li>
+<li><a href="#_exception_handlers">Exception Handlers</a></li>
<li><a href="#_exception_chain_processing">Exception Chain Processing</a></li>
-<li><a href="#_apis_for_exception_information_and_flow_control">APIs for exception information and flow control</a>
-<ul class="sectlevel4">
-<li><a href="#_exceptionevent">ExceptionEvent</a></li>
-</ul>
-</li>
+<li><a href="#_apis_for_exception_information_and_flow_control">APIs for Exception Information and Flow Control</a></li>
</ul>
</li>
<li><a href="#_scopes">Scopes</a>
-<ul class="sectlevel3">
+<ul class="sectlevel4">
<li><a href="#__windowscoped">@WindowScoped</a></li>
<li><a href="#__viewaccessscoped">@ViewAccessScoped</a></li>
<li><a href="#__groupedconversationscoped">@GroupedConversationScoped</a></li>
</ul>
</li>
-<li><a href="#_creating_a_custom_cdi_scope">Creating a custom CDI Scope</a></li>
+<li><a href="#_creating_a_custom_cdi_scope">Creating a Custom CDI Scope</a></li>
<li><a href="#_deactivatable">Deactivatable</a></li>
</ul>
</li>
<li><a href="#_core_utils">Core - Utils</a>
-<ul class="sectlevel2">
+<ul class="sectlevel3">
<li><a href="#_arraysutils">ArraysUtils</a></li>
<li><a href="#_beanutils">BeanUtils</a></li>
<li><a href="#_classdeactivationutils">ClassDeactivationUtils</a></li>
@@ -237,50 +225,66 @@ body {
</ul>
</li>
</ul>
+</li>
+</ul>
<hr>
<div class="sect1">
-<h2 id="_core_api">Core - API</h2>
+<h2 id="_overview">Overview</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The Core module provides fundamental and defining DeltaSpike API and utility classes. As such, this module must be included in every project that uses DeltaSpike.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_configure_your_projects">Configure Your Projects</h2>
<div class="sectionbody">
-<div class="sect2">
-<h3 id="_deltaspike_configuration">DeltaSpike Configuration</h3>
<div class="paragraph">
-<p>This is described in an own chapter solely targeting our <a href="configuration.html">configuration</a> mechanics, API and SPI.</p>
+<p>Instructions for configuring your Maven-based and Maven-independent projects to use the DeltaSpike Core module are detailed in <a href="configure.html">Configure DeltaSpike in Your Projects</a> as part of the general instructions for configuring your projects for DeltaSpike.</p>
+</div>
</div>
</div>
+<div class="sect1">
+<h2 id="_use_the_module_features">Use the Module Features</h2>
+<div class="sectionbody">
<div class="sect2">
-<h3 id="_beanprovider">BeanProvider</h3>
+<h3 id="_core_api">Core - API</h3>
+<div class="sect3">
+<h4 id="_deltaspike_configuration">DeltaSpike Configuration</h4>
+<div class="paragraph">
+<p>This is described in a separate page solely targeting <a href="configuration.html">configuration</a> mechanics, API and SPI.</p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_beanprovider">BeanProvider</h4>
<div class="paragraph">
<p>The <code>BeanProvider</code> is a class which provides (static) util methods which
-allow to lookup beans if it isn’t possible to inject them via <code>@Inject</code>
+allow to lookup beans if it is not possible to inject them via <code>@Inject</code>
or if the lookup depends on dynamic conditions. Instead of using the
term 'bean', the term 'contextual instance' is used because that’s the
term used by CDI itself.</p>
</div>
<div class="paragraph">
<p>The following example shows a simple lookup. With the second parameter
-it’s possible to specify if the contextual instance is optional. If it
-isn’t expected that the contextual instance is optional, but no instance
+it is possible to specify if the contextual instance is optional. If it
+is not expected that the contextual instance is optional, but no instance
has been found, an <code>IllegalStateException</code> will be thrown.</p>
</div>
-<div class="paragraph">
-<p>Resolving a simple contextual instance:</p>
-</div>
<div class="listingblock">
+<div class="title">Resolving a Simple Contextual Instance</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java">MyBean myBean = BeanProvider.getContextualReference(MyBean.class, <span class="predefined-constant">false</span>);</code></pre>
</div>
</div>
<div class="paragraph">
<p>Pass <code>true</code> as second argument, if you look for an implementation of the
-given interface and an implementation isn’t required or it isn’t
+given interface and an implementation is not required or it is not
required that there is an instance with the given qualifier (see the
qualifier example for further details).</p>
</div>
-<div class="paragraph">
-<p>Resolving an optional contextual instance:</p>
-</div>
<div class="listingblock">
+<div class="title">Resolving an Optional Contextual Instance</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java">MyServiceInterface optionalService = BeanProvider.getContextualReference(MyServiceInterface.class, <span class="predefined-constant">true</span>);</code></pre>
</div>
@@ -290,10 +294,8 @@ qualifier example for further details).<
question. CDI qualifiers are annotations, therefore you need to
implement a corresponding literal for providing an instance.</p>
</div>
-<div class="paragraph">
-<p>Literal implementation for '@MyQualifier':</p>
-</div>
<div class="listingblock">
+<div class="title">Literal Implementation for '@MyQualifier'</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">import</span> <span class="include">javax.enterprise.util.AnnotationLiteral</span>;
<span class="comment">//...</span>
@@ -305,12 +307,10 @@ implement a corresponding literal for pr
</div>
<div class="paragraph">
<p>The following example will return a contextual instance with the
-qualifier <code>@MyQualifier</code></p>
-</div>
-<div class="paragraph">
-<p>Resolving a simple contextual instance with qualifier:</p>
+qualifier <code>@MyQualifier</code>.</p>
</div>
<div class="listingblock">
+<div class="title">Resolving a Simple Contextual Instance with Qualifier</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java">MyBean myBean = BeanProvider.getContextualReference(MyBean.class, <span class="predefined-constant">false</span>, <span class="keyword">new</span> MyQualifierLiteral());</code></pre>
</div>
@@ -320,46 +320,40 @@ qualifier <code>@MyQualifier</code></p>
based name (e.g. for referencing CDI beans in EL-expressions). However,
the following examples show how to do a manual lookup by name.</p>
</div>
-<div class="paragraph">
-<p>Resolving a simple contextual instance by name:</p>
-</div>
<div class="listingblock">
+<div class="title">Resolving a Simple Contextual Instance by Name</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">Object</span> myBean = BeanProvider.getContextualReference(<span class="string"><span class="delimiter">"</span><span class="content">myBean</span><span class="delimiter">"</span></span>, <span class="predefined-constant">false</span>);</code></pre>
</div>
</div>
-<div class="paragraph">
-<p>Resolving a simple contextual instance by name and expected type:</p>
-</div>
<div class="listingblock">
+<div class="title">Resolving a Simple Contextual Instance by Name and Expected Type</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java">MyBean myBean = BeanProvider.getContextualReference(<span class="string"><span class="delimiter">"</span><span class="content">myBean</span><span class="delimiter">"</span></span>, <span class="predefined-constant">false</span>, MyBean.class);</code></pre>
</div>
</div>
<div class="paragraph">
-<p>Sometimes it’s essential to resolve all contextual instances which
-implement e.g. an interface or all beans with the same type but a
+<p>Sometimes it is essential to resolve all contextual instances which
+implement for example an interface or all beans with the same type but a
different qualifier. The following example shows how to do such a lookup
which returns all contextual instances (independent of the scope → also
dependent scoped instances).</p>
</div>
-<div class="paragraph">
-<p>Resolving all contextual instances of a given type:</p>
-</div>
<div class="listingblock">
+<div class="title">Resolving All Contextual Instances of a Given Type</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">List</span><MyServiceInterface> myServiceList = BeanProvider.getContextualReferences(MyServiceInterface.class, <span class="predefined-constant">false</span>);</code></pre>
</div>
</div>
<div class="paragraph">
<p>Since dependent scoped beans have a special role in CDI (you have to
-destroy them manually - esp. if you get them via a manual lookup), you
+destroy them manually - especially if you get them via a manual lookup), you
can also call the previous util method with an additional parameter to
filter dependent scoped instances.</p>
</div>
<div class="paragraph">
-<p>Resolving all contextual instances of a given type without dependent
-scoped instances:</p>
+<div class="title">Resolving All Contextual Instances of a Given Type without Dependent</div>
+<p>Scoped Instances</p>
</div>
<div class="listingblock">
<div class="content">
@@ -367,33 +361,29 @@ scoped instances:</p>
</div>
</div>
<div class="paragraph">
-<p>Furthermore, it’s possible to trigger the injection of fields of any
-given instance, if it wasn’t done by the container (e.g. because the
+<p>Furthermore, it is possible to trigger the injection of fields of any
+given instance, if it was not done by the container (e.g. because the
class is in a jar-file without beans.xml) and <code>@Inject</code> is used for 1-n
fields.</p>
</div>
-<div class="paragraph">
-<p>Manually inject fields:</p>
-</div>
<div class="listingblock">
+<div class="title">Manually Inject Fields</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java">BeanProvider.injectFields(myObject);</code></pre>
</div>
</div>
</div>
-<div class="sect2">
-<h3 id="_beanmanagerprovider">BeanManagerProvider</h3>
+<div class="sect3">
+<h4 id="_beanmanagerprovider">BeanManagerProvider</h4>
<div class="paragraph">
<p>This mechanism provides access to the <code>BeanManager</code> by registering the
current <code>BeanManager</code> during the startup. This is really handy if you
like to access CDI functionality from places where no CDI based
injection is available. If a simple but manual bean-lookup is needed,
-it’s easier to use the <code>BeanProvider</code>.</p>
-</div>
-<div class="paragraph">
-<p>Resolving the Bean-Manager:</p>
+it is easier to use the <code>BeanProvider</code>.</p>
</div>
<div class="listingblock">
+<div class="title">Resolving the BeanManager</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="comment">//in most cases the following works without problems:</span>
<span class="annotation">@Inject</span>
@@ -406,8 +396,8 @@ BeanManager beanManager = BeanManagerPro
</div>
</div>
<div class="paragraph">
-<p><code>BeanManagerProvider</code> uses an own approach to find the correct <code>BeanManager</code>,
-because a portable API for it is only available since CDI 1.1.
+<p><code>BeanManagerProvider</code> uses a different approach to find the correct <code>BeanManager</code>,
+because a portable API for it has only been available from CDI 1.1.
However, once you are using CDI 1.1+ DeltaSpike delegates the lookup to the CDI container
instead of using its own approach.
If you migrate from CDI 1.0 to a later version of CDI and you would like to keep
@@ -416,24 +406,22 @@ the lookup strategy you used before, you
(e.g. in <code>/META-INF/apache-deltaspike.properties</code>).</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_type_safe_projectstage">Type-safe ProjectStage</h3>
+<div class="sect3">
+<h4 id="_type_safe_projectstage">Type-safe ProjectStage</h4>
<div class="paragraph">
<p>The DeltaSpike <a href="projectstage.html">ProjectStage</a> mechanism allows to
use configuration and implementations depending on the server
environment you currently run on.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="__exclude">@Exclude</h3>
+<div class="sect3">
+<h4 id="__exclude">@Exclude</h4>
<div class="paragraph">
-<p>With <code>@Exclude</code> it’s possible to annotate beans which should be ignored
+<p>With <code>@Exclude</code> it is possible to annotate beans which should be ignored
by CDI even if they are in a CDI enabled archive.</p>
</div>
-<div class="paragraph">
-<p>Excluding a bean in any case:</p>
-</div>
<div class="listingblock">
+<div class="title">Excluding a Bean in any Case</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Exclude</span>
<span class="directive">public</span> <span class="type">class</span> <span class="class">NoBean</span>
@@ -441,10 +429,8 @@ by CDI even if they are in a CDI enabled
}</code></pre>
</div>
</div>
-<div class="paragraph">
-<p>Excluding a bean in case of project-stage development:</p>
-</div>
<div class="listingblock">
+<div class="title">Excluding a Bean in Case of ProjectStageDevelopment</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Exclude</span>(ifProjectStage = ProjectStage.Development.class)
<span class="directive">public</span> <span class="type">class</span> <span class="class">MyBean</span>
@@ -452,10 +438,8 @@ by CDI even if they are in a CDI enabled
}</code></pre>
</div>
</div>
-<div class="paragraph">
-<p>Excluding a bean if the project-stage is different from development:</p>
-</div>
<div class="listingblock">
+<div class="title">Excluding a Bean if the pProjectStageis Different from Development</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Exclude</span>(exceptIfProjectStage = ProjectStage.Development.class)
<span class="directive">public</span> <span class="type">class</span> <span class="class">MyDevBean</span>
@@ -465,12 +449,10 @@ by CDI even if they are in a CDI enabled
</div>
<div class="paragraph">
<p>The following usage allows to exclude a bean based on a configured value
-(see the <a href="configuration.html#_configsources_provided_by_default">supported config sources</a>).</p>
-</div>
-<div class="paragraph">
-<p>Excluding a bean based on an expression which eval. to true:</p>
+(see the <a href="configuration.html#_configsources_provided_by_default">supported configuration sources</a>).</p>
</div>
<div class="listingblock">
+<div class="title">Excluding a Bean based on an Expression which Evaluates to True</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Exclude</span>(onExpression = <span class="string"><span class="delimiter">"</span><span class="content">db==prodDB</span><span class="delimiter">"</span></span>)
<span class="directive">public</span> <span class="type">class</span> <span class="class">DevDbBean</span>
@@ -479,14 +461,12 @@ by CDI even if they are in a CDI enabled
</div>
</div>
<div class="paragraph">
-<p>By default a simple syntax is supported ([TODO]), however, it’s possible
+<p>By default a simple syntax is supported ([TODO]), however, it is possible
to provide a custom <code>ExpressionInterpreter</code> for interpreting custom
expressions.</p>
</div>
-<div class="paragraph">
-<p>Excluding a bean based on a custom expression:</p>
-</div>
<div class="listingblock">
+<div class="title">Excluding a Bean based on a Custom Expression</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Exclude</span>(onExpression = <span class="string"><span class="delimiter">"</span><span class="content">db eq prodDB</span><span class="delimiter">"</span></span>, interpretedBy = SimpleExpressionInterpreter.class)
<span class="directive">public</span> <span class="type">class</span> <span class="class">DevDbBean</span>
@@ -508,18 +488,18 @@ expressions.</p>
</div>
</div>
<div class="paragraph">
-<p>In several cases it’s also useful to combine this feature with the
+<p>In several cases it is also useful to combine this feature with the
<code>@Alternative</code> annotation provided by CDI.</p>
</div>
<div class="paragraph">
-<p>In addition to the following snippet, it’s required to configure the
-implementation as alternative in the beans.xml file. This config entry
-won’t be changed e.g. for different environments, because it just gets
-active if it isn’t excluded during the bootstrapping process.</p>
+<p>In addition to the following snippet, it is required to configure the
+implementation as alternative in the beans.xml file. This configuration entry
+will not be changed, for example for different environments, because it just gets
+active if it is not excluded during the bootstrapping process.</p>
</div>
<div class="paragraph">
-<p>Excluding an alternative implementation if the project-stage is
-different from development:</p>
+<div class="title">Excluding an Alternative Implementation if the pProjectStageis</div>
+<p>Different from Development</p>
</div>
<div class="listingblock">
<div class="content">
@@ -530,12 +510,12 @@ different from development:</p>
}</code></pre>
</div>
</div>
-<div class="sect3">
-<h4 id="_custom_expressioninterpreter">Custom ExpressionInterpreter</h4>
+<div class="sect4">
+<h5 id="_custom_expressioninterpreter">Custom ExpressionInterpreter</h5>
<div class="paragraph">
-<p>Per default only a very simple and limited syntax is supported. In real
+<p>By default only a very simple and limited syntax is supported. In real
projects there are usually quite concrete requirements. Since it would
-be very complex to support most of them, it’s easier for users to
+be very complex to support most of them, it is easier for users to
implement an optimized syntax. For such cases a custom
ExpressionInterpreter is needed:</p>
</div>
@@ -560,7 +540,7 @@ ExpressionInterpreter is needed:</p>
<span class="keyword">if</span> (values.length != <span class="integer">2</span>)
{
- <span class="keyword">throw</span> <span class="keyword">new</span> <span class="exception">IllegalArgumentException</span>(<span class="string"><span class="delimiter">"</span><span class="content">'</span><span class="delimiter">"</span></span> + expression + <span class="string"><span class="delimiter">"</span><span class="content">' isn't a supported syntax</span><span class="delimiter">"</span></span>);
+ <span class="keyword">throw</span> <span class="keyword">new</span> <span class="exception">IllegalArgumentException</span>(<span class="string"><span class="delimiter">"</span><span class="content">'</span><span class="delimiter">"</span></span> + expression + <span class="string"><span class="delimiter">"</span><span class="content">' is not a supported syntax</span><span class="delimiter">"</span></span>);
}
<span class="predefined-type">String</span> configuredValue = ConfigResolver.getPropertyValue(values[<span class="integer">0</span>], <span class="predefined-constant">null</span>);
@@ -573,22 +553,20 @@ ExpressionInterpreter is needed:</p>
</div>
</div>
</div>
-<div class="sect2">
-<h3 id="_type_safe_view_config">Type-safe View-Config</h3>
+<div class="sect3">
+<h4 id="_type_safe_view_config">Type-safe View-Config</h4>
<div class="paragraph">
<p>TODO (Overview)</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_literals">Literals</h3>
+<div class="sect3">
+<h4 id="_literals">Literals</h4>
<div class="paragraph">
<p>Literals allow the instantiation of annotations by extending the
abstract class 'javax.enterprise.util.AnnotationLiteral'</p>
</div>
-<div class="paragraph">
-<p><strong>Example</strong></p>
-</div>
<div class="listingblock">
+<div class="title">Example</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="directive">abstract</span> <span class="type">class</span> <span class="class">PayByQualifier</span>
<span class="directive">extends</span> AnnotationLiteral<PayBy>
@@ -598,7 +576,7 @@ abstract class 'javax.enterprise.util.An
</div>
</div>
<div class="paragraph">
-<p>DeltaSpike provides many annotation literals that you can use - e.g.:</p>
+<p>DeltaSpike provides many annotation literals that you can use, including the following:</p>
</div>
<div class="ulist">
<ul>
@@ -647,16 +625,14 @@ abstract class 'javax.enterprise.util.An
</ul>
</div>
</div>
-<div class="sect2">
-<h3 id="_messages_i18n">Messages & I18n</h3>
+<div class="sect3">
+<h4 id="_messages_and_i18n">Messages and I18n</h4>
<div class="paragraph">
<p>The following implementation is the minimal effort to use type-safe
messages (which are hardcoded in this case).</p>
</div>
-<div class="paragraph">
-<p><strong>Simple type-safe message</strong></p>
-</div>
<div class="listingblock">
+<div class="title">Simple Type-safe Message</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@MessageBundle</span>
<span class="directive">public</span> <span class="type">interface</span> <span class="class">SimpleMessage</span>
@@ -672,10 +648,8 @@ a lookup in the default message bundle.
name as the interface (but .properties instead of .java (/.class) as
file extension).</p>
</div>
-<div class="paragraph">
-<p><strong>Internationalized type-safe message</strong></p>
-</div>
<div class="listingblock">
+<div class="title">Internationalized Type-safe Message</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@MessageBundle</span>
<span class="directive">public</span> <span class="type">interface</span> <span class="class">SimpleMessage</span>
@@ -701,10 +675,8 @@ welcome_to_deltaspike=Welcome to DeltaSp
<p>The following implementation uses the key <code>welcome_to_deltaspike</code> to do
a lookup in a custom message bundle known by <code>CustomMessageResolver</code>.</p>
</div>
-<div class="paragraph">
-<p><strong>Internationalized type-safe message</strong></p>
-</div>
<div class="listingblock">
+<div class="title">Internationalized Type-safe Message</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@MessageBundle</span>
<span class="annotation">@MessageContextConfig</span>(messageResolver = CustomMessageResolver.class)
@@ -723,10 +695,8 @@ a lookup in a custom message bundle know
<p>The following implementation shows the usage of an internationalized
simple type-safe message.</p>
</div>
-<div class="paragraph">
-<p><strong>Internationalized type-safe message with parameter/s</strong></p>
-</div>
<div class="listingblock">
+<div class="title">Internationalized Type-safe Message with Parameter/s</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@MessageBundle</span>
<span class="annotation">@MessageContextConfig</span>(messageInterpolator = CustomMessageInterpolator.class)
@@ -752,10 +722,10 @@ simple type-safe message.</p>
</div>
</div>
</div>
-<div class="sect2">
-<h3 id="_dynamic_message_builder">Dynamic Message Builder</h3>
<div class="sect3">
-<h4 id="_creating_message_instances">Creating message instances</h4>
+<h4 id="_dynamic_message_builder">Dynamic Message Builder</h4>
+<div class="sect4">
+<h5 id="_creating_message_instances">Creating Message Instances</h5>
<div class="paragraph">
<p>The following implementation creates an instance of <code>Message</code> for the
key <code>hello</code>. The final text will be resolved and interpolated lazily.
@@ -785,7 +755,7 @@ uses printf-style format strings.</p>
</div>
</div>
<div class="paragraph">
-<p>Besides the static config via <code>@MessageContextConfig#messageSource</code>, you
+<p>Besides the static configuration via <code>@MessageContextConfig#messageSource</code>, you
can also specify the message sources dynamically.</p>
</div>
<div class="listingblock">
@@ -811,14 +781,14 @@ hello=Hello %s from %s</code></pre>
</div>
</div>
</div>
-<div class="sect3">
-<h4 id="_customizing_the_message_context">Customizing the message context</h4>
<div class="sect4">
-<h5 id="_messageresolver">MessageResolver</h5>
+<h5 id="_customizing_the_message_context">Customizing the Message Context</h5>
+<div class="sect5">
+<h6 id="_messageresolver">MessageResolver</h6>
<div class="paragraph">
<p>A message-resolver is responsible for creating the message-text based on
the message-descriptor (key or inline-text), the current locale (and in
-some cases the message-payload). (The supported format e.g. if it’s
+some cases the message-payload). (The supported format, for example, if it is
required to escape a key, if inline-text is supported,…​ depends on the
concrete implementation.) In case of a message-key, the message-resolver
has to transform it to the message-text by looking it up in a message
@@ -828,7 +798,7 @@ source like a resource-bundle.</p>
<p><strong>Configuration of a message-resolver</strong></p>
</div>
<div class="paragraph">
-<p>Besides the static config via <code>@MessageContextConfig#messageResolver</code>,
+<p>Besides the static configuration via <code>@MessageContextConfig#messageResolver</code>,
you can use it dynamically via passing a custom message-resolver
instance to the current messageContext:</p>
</div>
@@ -847,8 +817,8 @@ Message message = <span class="local-var
contain placeholders which are processed by a <code>MessageInterpolator</code></p>
</div>
</div>
-<div class="sect4">
-<h5 id="_messageinterpolator">MessageInterpolator</h5>
+<div class="sect5">
+<h6 id="_messageinterpolator">MessageInterpolator</h6>
<div class="paragraph">
<p>A <code>MessageInterpolator</code> replaces the placeholders in a message-text with
the arguments of the message.</p>
@@ -857,7 +827,7 @@ the arguments of the message.</p>
<p><strong>Configuration of a message-interpolator</strong></p>
</div>
<div class="paragraph">
-<p>Besides the static config via
+<p>Besides the static configuration via
`@MessageContextConfig#messageInterpolator, you can use it dynamically
via passing a custom message-interpolator instance to the current
messageContext:</p>
@@ -872,10 +842,10 @@ Message message = <span class="local-var
</div>
</div>
</div>
-<div class="sect4">
-<h5 id="_localeresolver">LocaleResolver</h5>
+<div class="sect5">
+<h6 id="_localeresolver">LocaleResolver</h6>
<div class="paragraph">
-<p>A locale resolver provides the current locale. The locale is e.g. used
+<p>A locale resolver provides the current locale. The locale is, for example, used
to by a <code>MessageResolver</code> to choose the correct language for the
message-text.</p>
</div>
@@ -883,7 +853,7 @@ message-text.</p>
<p><strong>Configuration of a locale-resolver</strong></p>
</div>
<div class="paragraph">
-<p>Besides the static config via `@MessageContextConfig#localeResolver, you
+<p>Besides the static configuration via `@MessageContextConfig#localeResolver, you
can use it dynamically via passing a custom locale-resolver instance to
the current messageContext:</p>
</div>
@@ -899,8 +869,8 @@ Message message = this.messageContext.lo
</div>
</div>
</div>
-<div class="sect2">
-<h3 id="_injecting_resources">Injecting Resources</h3>
+<div class="sect3">
+<h4 id="_injecting_resources">Injecting Resources</h4>
<div class="paragraph">
<p>DeltaSpike has simple APIs for performing basic resource loading and
property file reading.</p>
@@ -920,8 +890,8 @@ the <code>InjectableResourceProvider</co
alternate sources, if needed (e.g. database LOBs, NoSQL storage areas).</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_exception_control">Exception Control</h3>
+<div class="sect3">
+<h4 id="_exception_control">Exception Control</h4>
<div class="paragraph">
<p>Exception handling in DeltaSpike is based around the CDI eventing model.
While the implementation of exception handlers may not be the same as a
@@ -944,8 +914,8 @@ developer. In most cases, you register a
annotating a handler method. Alternatively, you can handle an exception
programmatically, just as you would observe an event in CDI.</p>
</div>
-<div class="sect3">
-<h4 id="_usage">Usage</h4>
+<div class="sect4">
+<h5 id="_usage">Usage</h5>
<div class="paragraph">
<p>The entire exception handling process starts with an event. This helps
keep your application minimally coupled to DeltaSpike, but also allows
@@ -956,7 +926,7 @@ event is the main way of starting the ex
</div>
<div class="paragraph">
<p>Manually firing an event to use DeltaSpike’s exception handling is
-primarily used in your own try/catch blocks. It’s very painless and also
+primarily used in your own try/catch blocks. It is very painless and also
easy. Let’s examine a sample that might exist inside of a simple
business logic lookup into an inventory database:</p>
</div>
@@ -987,8 +957,8 @@ your class for use later within a try/ca
constructed with the exception to be handled.</p>
</div>
</div>
-<div class="sect3">
-<h4 id="_exception_handlers">Exception handlers</h4>
+<div class="sect4">
+<h5 id="_exception_handlers">Exception Handlers</h5>
<div class="paragraph">
<p>As an application developer (i.e., an end user of DeltaSpike’s exception
handling), you’ll be focused on writing exception handlers. An exception
@@ -1033,8 +1003,8 @@ methods which have a parameter which is
<code>ExceptionEvent<T extends Throwable></code> annotated with the <code>@Handles</code>
annotation.</p>
</div>
-<div class="sect4">
-<h5 id="__exceptionhandler">@ExceptionHandler</h5>
+<div class="sect5">
+<h6 id="__exceptionhandler">@ExceptionHandler</h6>
<div class="paragraph">
<p>The <code>@ExceptionHandler</code> annotation is simply a marker annotation that
instructs the DeltaSpike exception handling CDI extension to scan the
@@ -1055,8 +1025,8 @@ bean for handler methods.</p>
methods on this bean.</p>
</div>
</div>
-<div class="sect4">
-<h5 id="__handles_and_beforehandles">@Handles and @BeforeHandles</h5>
+<div class="sect5">
+<h6 id="__handles_and_beforehandles">@Handles and @BeforeHandles</h6>
<div class="paragraph">
<p><code>@Handles</code> is a method parameter annotation that designates a method as
an exception handler. Exception handler methods are registered on beans
@@ -1087,7 +1057,7 @@ represents all exceptions).</p>
<p>The <code>@Handles</code> annotation on the first parameter designates this method
as an exception handler (though it is not required to be the first
parameter). This parameter must be of type
-<code>ExceptionEvent<T extends Throwable></code>, otherwise it’s detected as a
+<code>ExceptionEvent<T extends Throwable></code>, otherwise it is detected as a
definition error. The type parameter designates which exception the
method should handle. This method is notified of all exceptions
(requested by the base exception type <code>Throwable</code>).</p>
@@ -1095,7 +1065,7 @@ method should handle. This method is not
<div class="paragraph">
<p>The <code>ExceptionEvent</code> instance provides access to information about the
exception and can be used to control exception handling flow. In this
-case, it’s used to read the current exception being handled in the
+case, it is used to read the current exception being handled in the
exception chain, as returned by <code>getException()</code>.</p>
</div>
<div class="paragraph">
@@ -1186,8 +1156,8 @@ will propagate up the stack and all hand
cease. Any exception that was being handled will be lost.</p>
</div>
</div>
-<div class="sect4">
-<h5 id="_ordinal">Ordinal</h5>
+<div class="sect5">
+<h6 id="_ordinal">Ordinal</h6>
<div class="paragraph">
<p>When DeltaSpike finds more than one handler for the same exception type,
it orders the handlers by ordinal. Handlers with higher ordinal are
@@ -1243,10 +1213,10 @@ invoke (until a handler marks exception
</div>
</div>
</div>
-<div class="sect3">
-<h4 id="_exception_chain_processing">Exception Chain Processing</h4>
+<div class="sect4">
+<h5 id="_exception_chain_processing">Exception Chain Processing</h5>
<div class="paragraph">
-<p>When an exception is thrown, chances are it’s nested (wrapped) inside
+<p>When an exception is thrown, chances are it is nested (wrapped) inside
other exceptions. (If you’ve ever examined a server log, you’ll
appreciate this fact). The collection of exceptions in its entirety is
termed an exception chain.</p>
@@ -1254,7 +1224,7 @@ termed an exception chain.</p>
<div class="paragraph">
<p>The outermost exception of an exception chain (e.g., EJBException,
ServletException, etc) is probably of little use to exception handlers.
-That’s why DeltaSpike doesn’t simply pass the exception chain directly
+That’s why DeltaSpike does not simply pass the exception chain directly
to the exception handlers. Instead, it intelligently unwraps the chain
and treats the root exception cause as the primary exception.</p>
</div>
@@ -1316,8 +1286,8 @@ thing since what useful information can
<code>EJBException</code>?</p>
</div>
</div>
-<div class="sect3">
-<h4 id="_apis_for_exception_information_and_flow_control">APIs for exception information and flow control</h4>
+<div class="sect4">
+<h5 id="_apis_for_exception_information_and_flow_control">APIs for Exception Information and Flow Control</h5>
<div class="paragraph">
<p>There are two APIs provided by DeltaSpike that should be familiar to
application developers:</p>
@@ -1332,8 +1302,8 @@ application developers:</p>
</li>
</ul>
</div>
-<div class="sect4">
-<h5 id="_exceptionevent">ExceptionEvent</h5>
+<div class="sect5">
+<h6 id="_exceptionevent">ExceptionEvent</h6>
<div class="paragraph">
<p>In addition to providing information about the exception being handled,
the <code>ExceptionEvent</code> object contains methods to control the exception
@@ -1374,42 +1344,42 @@ invoked</p>
</div>
<div class="paragraph">
<p>Once a handler is invoked it is muted, meaning it will not be run again
-for that exception chain, unless it’s explicitly marked as unmuted via
+for that exception chain, unless it is explicitly marked as unmuted via
the <code>unmute()</code> method on <code>ExceptionEvent</code>.</p>
</div>
</div>
</div>
</div>
-<div class="sect2">
-<h3 id="_scopes">Scopes</h3>
+<div class="sect3">
+<h4 id="_scopes">Scopes</h4>
<div class="paragraph">
<p>DeltaSpike Core provides the API and SPI for several scopes. Currently
all scopes are only implemented in the <a href="jsf.html#_scopes">JSF module</a>.</p>
</div>
-<div class="sect3">
-<h4 id="__windowscoped">@WindowScoped</h4>
+<div class="sect4">
+<h5 id="__windowscoped">@WindowScoped</h5>
</div>
-<div class="sect3">
-<h4 id="__viewaccessscoped">@ViewAccessScoped</h4>
+<div class="sect4">
+<h5 id="__viewaccessscoped">@ViewAccessScoped</h5>
</div>
-<div class="sect3">
-<h4 id="__groupedconversationscoped">@GroupedConversationScoped</h4>
+<div class="sect4">
+<h5 id="__groupedconversationscoped">@GroupedConversationScoped</h5>
</div>
</div>
-<div class="sect2">
-<h3 id="_creating_a_custom_cdi_scope">Creating a custom CDI Scope</h3>
-<div class="paragraph">
-<p>If you want to create a custom CDI scope to match your needs, you will
-need to follow these steps:</p>
-</div>
+<div class="sect3">
+<h4 id="_creating_a_custom_cdi_scope">Creating a Custom CDI Scope</h4>
<div class="paragraph">
-<p>First, create an Annotation with annotated with @javax.inject.Scope;
-Example:</p>
+<p>To create a custom CDI scope to match your needs, complete the following steps:</p>
</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Create an Annotation with annotated with @javax.inject.Scope;</p>
<div class="listingblock">
+<div class="title">Example</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Scope</span>
<span class="annotation">@Retention</span>(<span class="predefined-type">RetentionPolicy</span>.RUNTIME)
@@ -1417,11 +1387,11 @@ Example:</p>
<span class="directive">public</span> <span class="annotation">@interface</span> ACustomScope {}</code></pre>
</div>
</div>
-<div class="paragraph">
-<p>Second, create an Extension to add the scope and a context for it.
-Example:</p>
-</div>
+</li>
+<li>
+<p>Create an Extension to add the scope and a context for it.</p>
<div class="listingblock">
+<div class="title">Example</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="type">class</span> <span class="class">ACustomScopeExtension</span> <span class="directive">implements</span> Extension, <span class="predefined-type">Serializable</span> {
@@ -1435,11 +1405,12 @@ Example:</p>
}</code></pre>
</div>
</div>
-<div class="paragraph">
+</li>
+<li>
<p>Implement a javax.enterprise.context.spi.Context interface to hold the
-javax.enterprise.inject.spi.Bean instances according to your needs</p>
-</div>
+javax.enterprise.inject.spi.Bean instances according to your needs.</p>
<div class="listingblock">
+<div class="title">Example</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="type">class</span> <span class="class">ACustomScopeContext</span> <span class="directive">implements</span> <span class="predefined-type">Context</span>, <span class="predefined-type">Serializable</span> {
@@ -1481,9 +1452,12 @@ javax.enterprise.inject.spi.Bean instanc
}</code></pre>
</div>
</div>
+</li>
+</ol>
</div>
-<div class="sect2">
-<h3 id="_deactivatable">Deactivatable</h3>
+</div>
+<div class="sect3">
+<h4 id="_deactivatable">Deactivatable</h4>
<div class="paragraph">
<p>DeltaSpike allows you to deactivate its own Extensions. You just need to
implement your <a href="spi.html#_classdeactivator">ClassDeactivator</a>.</p>
@@ -1513,7 +1487,7 @@ example, we can disable SecurityExtensio
</div>
</div>
<div class="paragraph">
-<p>now, we can use the file <code>/META-INF/apache-deltaspike.properties</code> (or any
+<p>Now, we can use the file <code>/META-INF/apache-deltaspike.properties</code> (or any
other <a href="configuration.html#_configsources_provided_by_default">ConfigSource</a>) with the following key/value:</p>
</div>
<div class="listingblock">
@@ -1523,10 +1497,8 @@ other <a href="configuration.html#_confi
</div>
</div>
</div>
-</div>
-<div class="sect1">
-<h2 id="_core_utils">Core - Utils</h2>
-<div class="sectionbody">
+<div class="sect2">
+<h3 id="_core_utils">Core - Utils</h3>
<div class="paragraph">
<p>DeltaSpike provides many utility-classes (no constructor / static
methods) that can be useful for your project.</p>
@@ -1534,8 +1506,8 @@ methods) that can be useful for your pro
<div class="paragraph">
<p>Below you can find an information about these classes.</p>
</div>
-<div class="sect2">
-<h3 id="_arraysutils">ArraysUtils</h3>
+<div class="sect3">
+<h4 id="_arraysutils">ArraysUtils</h4>
<div class="paragraph">
<p>A collection of utilities for working with Arrays</p>
</div>
@@ -1548,8 +1520,8 @@ objects, the last object in the array wi
</ul>
</div>
</div>
-<div class="sect2">
-<h3 id="_beanutils">BeanUtils</h3>
+<div class="sect3">
+<h4 id="_beanutils">BeanUtils</h4>
<div class="paragraph">
<p>A set of utility methods for working with beans.</p>
</div>
@@ -1567,8 +1539,8 @@ objects, the last object in the array wi
</ul>
</div>
</div>
-<div class="sect2">
-<h3 id="_classdeactivationutils">ClassDeactivationUtils</h3>
+<div class="sect3">
+<h4 id="_classdeactivationutils">ClassDeactivationUtils</h4>
<div class="paragraph">
<p>Helper methods for <code>ClassDeactivator</code></p>
</div>
@@ -1583,8 +1555,8 @@ objects, the last object in the array wi
<p>To add a custom <code>ClassDeactivator</code> add <code>org.apache.deltaspike.core.spi.activation.ClassDeactivator=my.CustomClassDeactivator</code> to <code>META-INF\apache-deltaspike.properties</code>. Or configure it via a custom <code>ConfigSource</code>.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_exceptionutils">ExceptionUtils</h3>
+<div class="sect3">
+<h4 id="_exceptionutils">ExceptionUtils</h4>
<div class="paragraph">
<p>Helper methods to deal with Exceptions</p>
</div>
@@ -1599,8 +1571,8 @@ objects, the last object in the array wi
</ul>
</div>
</div>
-<div class="sect2">
-<h3 id="_propertyfileutils">PropertyFileUtils</h3>
+<div class="sect3">
+<h4 id="_propertyfileutils">PropertyFileUtils</h4>
<div class="paragraph">
<p>Helper methods for Property files</p>
</div>
@@ -1618,8 +1590,8 @@ objects, the last object in the array wi
</ul>
</div>
</div>
-<div class="sect2">
-<h3 id="_proxyutils">ProxyUtils</h3>
+<div class="sect3">
+<h4 id="_proxyutils">ProxyUtils</h4>
<div class="paragraph">
<p>Helper for CDI proxies</p>
</div>
@@ -1634,8 +1606,8 @@ objects, the last object in the array wi
</ul>
</div>
</div>
-<div class="sect2">
-<h3 id="_stringutils">StringUtils</h3>
+<div class="sect3">
+<h4 id="_stringutils">StringUtils</h4>
<div class="paragraph">
<p>A collection of utilities for working with Strings.</p>
</div>
@@ -1648,6 +1620,7 @@ objects, the last object in the array wi
</div>
</div>
</div>
+</div>
</div>
</div>