You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/06/02 15:32:14 UTC
[13/51] [partial] incubator-juneau-website git commit: Javadoc
updates.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/org/apache/juneau/svl/package-summary.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/svl/package-summary.html b/content/site/apidocs/org/apache/juneau/svl/package-summary.html
index 33115aa..e9ed0ed 100644
--- a/content/site/apidocs/org/apache/juneau/svl/package-summary.html
+++ b/content/site/apidocs/org/apache/juneau/svl/package-summary.html
@@ -251,37 +251,37 @@
The following shows the class hierarchy of the <a href="../../../../org/apache/juneau/svl/Var.html" title="class in org.apache.juneau.svl"><code>Var</code></a> class and all current
predefined implementations.
</p>
- <ul class='javahierarchy'>
- <li class='a'><a href="../../../../org/apache/juneau/svl/Var.html" title="class in org.apache.juneau.svl"><code>Var</code></a> - Superclass of all vars.
+ <ul class='doctree'>
+ <li class='jac'><a href="../../../../org/apache/juneau/svl/Var.html" title="class in org.apache.juneau.svl"><code>Var</code></a> - Superclass of all vars.
<ul>
- <li class='a'><a href="../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl"><code>SimpleVar</code></a> - Superclass of all vars that return strings.
+ <li class='jac'><a href="../../../../org/apache/juneau/svl/SimpleVar.html" title="class in org.apache.juneau.svl"><code>SimpleVar</code></a> - Superclass of all vars that return strings.
<ul>
- <li class='a'><a href="../../../../org/apache/juneau/svl/DefaultingVar.html" title="class in org.apache.juneau.svl"><code>DefaultingVar</code></a> - Variables that define a default value if the resolve method returns null.
+ <li class='jac'><a href="../../../../org/apache/juneau/svl/DefaultingVar.html" title="class in org.apache.juneau.svl"><code>DefaultingVar</code></a> - Variables that define a default value if the resolve method returns null.
<ul>
- <li class='a'><a href="../../../../org/apache/juneau/svl/MapVar.html" title="class in org.apache.juneau.svl"><code>MapVar</code></a> - Variables that pull values from maps.
+ <li class='jac'><a href="../../../../org/apache/juneau/svl/MapVar.html" title="class in org.apache.juneau.svl"><code>MapVar</code></a> - Variables that pull values from maps.
<ul>
- <li class='c'><a href="../../../../org/apache/juneau/svl/vars/SystemPropertiesVar.html" title="class in org.apache.juneau.svl.vars"><code>SystemPropertiesVar</code></a> - Resolves system properties.
+ <li class='jc'><a href="../../../../org/apache/juneau/svl/vars/SystemPropertiesVar.html" title="class in org.apache.juneau.svl.vars"><code>SystemPropertiesVar</code></a> - Resolves system properties.
</ul>
</li>
- <li class='c'><a href="../../../../org/apache/juneau/svl/vars/ArgsVar.html" title="class in org.apache.juneau.svl.vars"><code>ArgsVar</code></a> - Resolves variables from an <a href="../../../../org/apache/juneau/utils/Args.html" title="class in org.apache.juneau.utils"><code>Args</code></a> object.
- <li class='c'><a href="../../../../org/apache/juneau/svl/vars/ConfigFileVar.html" title="class in org.apache.juneau.svl.vars"><code>ConfigFileVar</code></a> - Resolves variables from a <a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini"><code>ConfigFile</code></a> object.
- <li class='c'><a href="../../../../org/apache/juneau/svl/vars/EnvVariablesVar.html" title="class in org.apache.juneau.svl.vars"><code>EnvVariablesVar</code></a> - Resolves environment variables.
- <li class='c'><a href="../../../../org/apache/juneau/svl/vars/ManifestFileVar.html" title="class in org.apache.juneau.svl.vars"><code>ManifestFileVar</code></a> - Resolves variables from a <a href="../../../../org/apache/juneau/utils/ManifestFile.html" title="class in org.apache.juneau.utils"><code>ManifestFile</code></a> object.
- <li class='c'><a href="../../../../org/apache/juneau/rest/vars/ServletInitParamVar.html" title="class in org.apache.juneau.rest.vars"><code>ServletInitParamVar</code></a> - Resolves servlet initialization parameters.
+ <li class='jc'><a href="../../../../org/apache/juneau/svl/vars/ArgsVar.html" title="class in org.apache.juneau.svl.vars"><code>ArgsVar</code></a> - Resolves variables from an <a href="../../../../org/apache/juneau/utils/Args.html" title="class in org.apache.juneau.utils"><code>Args</code></a> object.
+ <li class='jc'><a href="../../../../org/apache/juneau/svl/vars/ConfigFileVar.html" title="class in org.apache.juneau.svl.vars"><code>ConfigFileVar</code></a> - Resolves variables from a <a href="../../../../org/apache/juneau/ini/ConfigFile.html" title="class in org.apache.juneau.ini"><code>ConfigFile</code></a> object.
+ <li class='jc'><a href="../../../../org/apache/juneau/svl/vars/EnvVariablesVar.html" title="class in org.apache.juneau.svl.vars"><code>EnvVariablesVar</code></a> - Resolves environment variables.
+ <li class='jc'><a href="../../../../org/apache/juneau/svl/vars/ManifestFileVar.html" title="class in org.apache.juneau.svl.vars"><code>ManifestFileVar</code></a> - Resolves variables from a <a href="../../../../org/apache/juneau/utils/ManifestFile.html" title="class in org.apache.juneau.utils"><code>ManifestFile</code></a> object.
+ <li class='jc'><a href="../../../../org/apache/juneau/rest/vars/ServletInitParamVar.html" title="class in org.apache.juneau.rest.vars"><code>ServletInitParamVar</code></a> - Resolves servlet initialization parameters.
</ul>
</li>
- <li class='a'><a href="../../../../org/apache/juneau/svl/MultipartVar.html" title="class in org.apache.juneau.svl"><code>MultipartVar</code></a> - Variables that consist of 2 or more comma-delimited arguments.
+ <li class='jac'><a href="../../../../org/apache/juneau/svl/MultipartVar.html" title="class in org.apache.juneau.svl"><code>MultipartVar</code></a> - Variables that consist of 2 or more comma-delimited arguments.
<ul>
- <li class='c'><a href="../../../../org/apache/juneau/rest/vars/LocalizationVar.html" title="class in org.apache.juneau.rest.vars"><code>LocalizationVar</code></a> - Resolves localized strings for an HTTP request.
+ <li class='jc'><a href="../../../../org/apache/juneau/rest/vars/LocalizationVar.html" title="class in org.apache.juneau.rest.vars"><code>LocalizationVar</code></a> - Resolves localized strings for an HTTP request.
</ul>
</li>
- <li class='c'><a href="../../../../org/apache/juneau/rest/vars/RequestVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestVar</code></a> - Resolves specialized HTTP request values.
- <li class='c'><a href="../../../../org/apache/juneau/rest/vars/UrlEncodeVar.html" title="class in org.apache.juneau.rest.vars"><code>UrlEncodeVar</code></a> - URL-encodes the value inside the variable.
+ <li class='jc'><a href="../../../../org/apache/juneau/rest/vars/RequestVar.html" title="class in org.apache.juneau.rest.vars"><code>RequestVar</code></a> - Resolves specialized HTTP request values.
+ <li class='jc'><a href="../../../../org/apache/juneau/rest/vars/UrlEncodeVar.html" title="class in org.apache.juneau.rest.vars"><code>UrlEncodeVar</code></a> - URL-encodes the value inside the variable.
</ul>
</li>
- <li class='a'><a href="../../../../org/apache/juneau/svl/StreamedVar.html" title="class in org.apache.juneau.svl"><code>StreamedVar</code></a> - Superclass of all vars that stream their value to writers.
+ <li class='jac'><a href="../../../../org/apache/juneau/svl/StreamedVar.html" title="class in org.apache.juneau.svl"><code>StreamedVar</code></a> - Superclass of all vars that stream their value to writers.
<ul>
- <li class='c'><a href="../../../../org/apache/juneau/rest/vars/SerializedRequestAttrVar.html" title="class in org.apache.juneau.rest.vars"><code>SerializedRequestAttrVar</code></a> - Resolves HTTP request attribute values passed through a <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializer</code></a>.
+ <li class='jc'><a href="../../../../org/apache/juneau/rest/vars/SerializedRequestAttrVar.html" title="class in org.apache.juneau.rest.vars"><code>SerializedRequestAttrVar</code></a> - Resolves HTTP request attribute values passed through a <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializer</code></a>.
</ul>
</li>
</ul>
@@ -297,9 +297,9 @@
The main class for performing variable resolution is <a href="../../../../org/apache/juneau/svl/VarResolver.html" title="class in org.apache.juneau.svl"><code>VarResolver</code></a>.
Two methods are provided for resolving variables:
</p>
- <ul class='javahierarchy'>
- <li class='m'><a href="../../../../org/apache/juneau/svl/VarResolver.html#resolve-java.lang.String-"><code>VarResolver.resolve(String)</code></a> - Resolves variables and returns the results as a simple string.
- <li class='m'><a href="../../../../org/apache/juneau/svl/VarResolver.html#resolveTo-java.lang.String-java.io.Writer-"><code>VarResolver.resolveTo(String,Writer)</code></a> - Resolves variables and sends results to a writer.
+ <ul class='doctree'>
+ <li class='jm'><a href="../../../../org/apache/juneau/svl/VarResolver.html#resolve-java.lang.String-"><code>VarResolver.resolve(String)</code></a> - Resolves variables and returns the results as a simple string.
+ <li class='jm'><a href="../../../../org/apache/juneau/svl/VarResolver.html#resolveTo-java.lang.String-java.io.Writer-"><code>VarResolver.resolveTo(String,Writer)</code></a> - Resolves variables and sends results to a writer.
</ul>
<p>
Var resolvers can have zero or more context objects associated with them.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/org/apache/juneau/uon/UonParserContext.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/uon/UonParserContext.html b/content/site/apidocs/org/apache/juneau/uon/UonParserContext.html
index dd5a90a..4be47da 100644
--- a/content/site/apidocs/org/apache/juneau/uon/UonParserContext.html
+++ b/content/site/apidocs/org/apache/juneau/uon/UonParserContext.html
@@ -137,10 +137,10 @@ extends <a href="../../../../org/apache/juneau/parser/ParserContext.html" title=
See <a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau"><code>PropertyStore</code></a> for more information about context properties.
<h5 class='section'>Inherited configurable properties:</h5>
- <ul class='javahierarchy'>
- <li class='c'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> - Properties associated with handling beans on serializers and parsers.
+ <ul class='doctree'>
+ <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> - Properties associated with handling beans on serializers and parsers.
<ul>
- <li class='c'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> - Configurable properties common to all parsers.
+ <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> - Configurable properties common to all parsers.
</ul>
</ul></div>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/org/apache/juneau/uon/UonSerializerContext.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/uon/UonSerializerContext.html b/content/site/apidocs/org/apache/juneau/uon/UonSerializerContext.html
index 646325d..6c475ee 100644
--- a/content/site/apidocs/org/apache/juneau/uon/UonSerializerContext.html
+++ b/content/site/apidocs/org/apache/juneau/uon/UonSerializerContext.html
@@ -137,10 +137,10 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.html
See <a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau"><code>PropertyStore</code></a> for more information about context properties.
<h5 class='section'>Inherited configurable properties:</h5>
- <ul class='javahierarchy'>
- <li class='c'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> - Properties associated with handling beans on serializers and parsers.
+ <ul class='doctree'>
+ <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> - Properties associated with handling beans on serializers and parsers.
<ul>
- <li class='c'><a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a> - Configurable properties common to all serializers.
+ <li class='jc'><a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a> - Configurable properties common to all serializers.
</ul>
</ul></div>
</li>
@@ -176,7 +176,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.html
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonSerializerContext.html#UON_paramFormat">UON_paramFormat</a></span></code>
-<div class="block"><b>Configuration property:</b> Format to use for top-level query names and simple parameters.</div>
+<div class="block"><b>Configuration property:</b> Format to use for query/form-data/header values.</div>
</td>
</tr>
</table>
@@ -337,7 +337,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.html
<li class="blockList">
<h4>UON_paramFormat</h4>
<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/uon/UonSerializerContext.html#line.99">UON_paramFormat</a></pre>
-<div class="block"><b>Configuration property:</b> Format to use for top-level query names and simple parameters.
+<div class="block"><b>Configuration property:</b> Format to use for query/form-data/header values.
<p>
<ul>
<li><b>Name:</b> <js>"UrlEncodingSerializer.paramFormat"</js>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/org/apache/juneau/xml/XmlParserContext.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/xml/XmlParserContext.html b/content/site/apidocs/org/apache/juneau/xml/XmlParserContext.html
index fed0057..aecb85e 100644
--- a/content/site/apidocs/org/apache/juneau/xml/XmlParserContext.html
+++ b/content/site/apidocs/org/apache/juneau/xml/XmlParserContext.html
@@ -137,10 +137,10 @@ extends <a href="../../../../org/apache/juneau/parser/ParserContext.html" title=
See <a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau"><code>PropertyStore</code></a> for more information about context properties.
<h5 class='section'>Inherited configurable properties:</h5>
- <ul class='javahierarchy'>
- <li class='c'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> - Properties associated with handling beans on serializers and parsers.
+ <ul class='doctree'>
+ <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> - Properties associated with handling beans on serializers and parsers.
<ul>
- <li class='c'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> - Configurable properties common to all parsers.
+ <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> - Configurable properties common to all parsers.
</ul>
</ul></div>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/org/apache/juneau/xml/XmlSerializerContext.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/xml/XmlSerializerContext.html b/content/site/apidocs/org/apache/juneau/xml/XmlSerializerContext.html
index 82a0287..504adce 100644
--- a/content/site/apidocs/org/apache/juneau/xml/XmlSerializerContext.html
+++ b/content/site/apidocs/org/apache/juneau/xml/XmlSerializerContext.html
@@ -137,10 +137,10 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.html
See <a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau"><code>PropertyStore</code></a> for more information about context properties.
<h5 class='section'>Inherited configurable properties:</h5>
- <ul class='javahierarchy'>
- <li class='c'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> - Properties associated with handling beans on serializers and parsers.
+ <ul class='doctree'>
+ <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> - Properties associated with handling beans on serializers and parsers.
<ul>
- <li class='c'><a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a> - Configurable properties common to all serializers.
+ <li class='jc'><a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a> - Configurable properties common to all serializers.
</ul>
</ul></div>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/org/apache/juneau/xml/annotation/XmlFormat.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/xml/annotation/XmlFormat.html b/content/site/apidocs/org/apache/juneau/xml/annotation/XmlFormat.html
index 9e9cf16..bbf759a 100644
--- a/content/site/apidocs/org/apache/juneau/xml/annotation/XmlFormat.html
+++ b/content/site/apidocs/org/apache/juneau/xml/annotation/XmlFormat.html
@@ -452,7 +452,7 @@ the order they are declared.</div>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
-<pre>public static <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a>[] <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.41">values</a>()</pre>
+<pre>public static <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a>[] <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.45">values</a>()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
@@ -472,7 +472,7 @@ for (XmlFormat c : XmlFormat.values())
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
-<pre>public static <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.41">valueOf</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
+<pre>public static <a href="../../../../../org/apache/juneau/xml/annotation/XmlFormat.html" title="enum in org.apache.juneau.xml.annotation">XmlFormat</a> <a href="../../../../../src-html/org/apache/juneau/xml/annotation/XmlFormat.html#line.45">valueOf</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/org/apache/juneau/xml/package-summary.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/xml/package-summary.html b/content/site/apidocs/org/apache/juneau/xml/package-summary.html
index 96d6567..aa0d242 100644
--- a/content/site/apidocs/org/apache/juneau/xml/package-summary.html
+++ b/content/site/apidocs/org/apache/juneau/xml/package-summary.html
@@ -1002,9 +1002,10 @@
</xt></td>
</tr>
</table>
- <p class='info'>
- <code>string</code>, <code>number</code>, <code>boolean</code>, <code>object</code>, <code>array</code>, and <code>null</code> are reserved keywords that cannot be used as type names.
- </p>
+ <ul class='doctree'>
+ <li class='info'>
+ <code>string</code>, <code>number</code>, <code>boolean</code>, <code>object</code>, <code>array</code>, and <code>null</code> are reserved keywords that cannot be used as type names.
+ </ul>
<p>
Beans with type names are often used in conjunction with the <a href="../../../../org/apache/juneau/annotation/Bean.html#beanDictionary--"><code>@Bean.beanDictionary()</code></a> and
<a href="../../../../org/apache/juneau/annotation/BeanProperty.html#beanDictionary--"><code>@BeanProperty.beanDictionary()</code></a> annotations so that the beans can be
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/overview-summary.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/overview-summary.html b/content/site/apidocs/overview-summary.html
index 48e5d7a..a9599f9 100644
--- a/content/site/apidocs/overview-summary.html
+++ b/content/site/apidocs/overview-summary.html
@@ -594,10 +594,10 @@
<p>
Juneau requires Java 6+. The majority of the code has no other dependencies except for the following packages:
</p>
- <ul class='javahierarchy'>
- <li class='p'> <a class='doclink' href='org/apache/juneau/jena/package-summary.html#TOC'>org.apache.juneau.jena</a> - RDF support. Requires Apache Jena 2.7.1+.
- <li class='p'> <a class='doclink' href='org/apache/juneau/rest/package-summary.html#TOC'>org.apache.juneau.rest</a> - REST servlet support. Requires JEE 1.3+.
- <li class='p'> <a class='doclink' href='org/apache/juneau/rest/client/package-summary.html#TOC'>org.apache.juneau.rest.client</a> - REST client support. Requires Apache HttpClient 4.5+.
+ <ul class='doctree'>
+ <li class='jp'> <a class='doclink' href='org/apache/juneau/jena/package-summary.html#TOC'>org.apache.juneau.jena</a> - RDF support. Requires Apache Jena 2.7.1+.
+ <li class='jp'> <a class='doclink' href='org/apache/juneau/rest/package-summary.html#TOC'>org.apache.juneau.rest</a> - REST servlet support. Requires JEE 1.3+.
+ <li class='jp'> <a class='doclink' href='org/apache/juneau/rest/client/package-summary.html#TOC'>org.apache.juneau.rest.client</a> - REST client support. Requires Apache HttpClient 4.5+.
</ul>
<p>
OSGi bundles are also provided that break down Juneau into the following components:
@@ -617,11 +617,11 @@
These are discussed in detail in the <a class='doclink' href="#Samples">Samples</a> section.
</ul>
- <h5 class='topic'>A note about examples</h5>
- <p class='info'>
- Many of the examples below use beans with public field properties instead of standard getters/setters.
- This is to simplify the examples.
- </p>
+ <ul class='doctree'>
+ <li class='info'>
+ Many of the examples below use beans with public field properties instead of standard getters/setters.
+ This is to simplify the examples.
+ </ul>
</div>
<!-- ======================================================================================================== -->
@@ -714,8 +714,8 @@
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/serializer/package-summary.html#TOC'>org.apache.juneau.serializer</a> - Serializer API Javadoc
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/serializer/package-summary.html#TOC'>org.apache.juneau.serializer</a> - Serializer API Javadoc
</ul>
</div>
@@ -785,18 +785,17 @@
Map<String,Person> m3 = <jk>new</jk> TreeMap<String,Person>();
parser.parseIntoMap(json, m3, String.<jk>class</jk>, Person.<jk>class</jk>);
</p>
- <p class='info'>
+ <ul class='doctree'>
+ <li class='info'>
In the example above, we're parsing "lax" JSON (single quotes, unquoted attributes).
The JSON parser can handle any valid JSON syntax (such as quoted or unquoted attributes, single or double quotes).<br>
It can also handle JSON fragements and embedded Javascript comments.
Many of the JSON examples provided will use lax syntax which is easier to read since we don't have to deal with escapes.
- </p>
- <p>
- </p>
+ </ul>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/parser/package-summary.html#TOC'>org.apache.juneau.parser</a> - Parser API Javadoc
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/parser/package-summary.html#TOC'>org.apache.juneau.parser</a> - Parser API Javadoc
</ul>
</div>
@@ -834,9 +833,9 @@
to work with requests and responses as POJOs.
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='c'><a href="org/apache/juneau/serializer/SerializerGroup.html" title="class in org.apache.juneau.serializer"><code>SerializerGroup</code></a>
- <li class='c'><a href="org/apache/juneau/parser/ParserGroup.html" title="class in org.apache.juneau.parser"><code>ParserGroup</code></a>
+ <ul class='doctree'>
+ <li class='jc'><a href="org/apache/juneau/serializer/SerializerGroup.html" title="class in org.apache.juneau.serializer"><code>SerializerGroup</code></a>
+ <li class='jc'><a href="org/apache/juneau/parser/ParserGroup.html" title="class in org.apache.juneau.parser"><code>ParserGroup</code></a>
</ul>
</div>
@@ -852,14 +851,14 @@
<p>
These classes extend directly from the following JCF classes:
</p>
- <ul class='javahierarchy'>
- <li class='c'> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMap.html?is-external=true" title="class or interface in java.util"><code>java.util.LinkedHashMap</code></a>
+ <ul class='doctree'>
+ <li class='jc'> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMap.html?is-external=true" title="class or interface in java.util"><code>java.util.LinkedHashMap</code></a>
<ul>
- <li class='c'> <a href="org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau"><code>org.apache.juneau.ObjectMap</code></a>
+ <li class='jc'> <a href="org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau"><code>org.apache.juneau.ObjectMap</code></a>
</ul>
- <li class='c'> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.html?is-external=true" title="class or interface in java.util"><code>java.util.LinkedList</code></a>
+ <li class='jc'> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.html?is-external=true" title="class or interface in java.util"><code>java.util.LinkedList</code></a>
<ul>
- <li class='c'> <a href="org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau"><code>org.apache.juneau.ObjectList</code></a>
+ <li class='jc'> <a href="org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau"><code>org.apache.juneau.ObjectList</code></a>
</ul>
</ul>
<p>
@@ -894,14 +893,15 @@
<jc>// Or convert it to XML.</jc>
String xml = XmlSerializer.<jsf>DEFAULT</jsf>.serialize(m);
</p>
- <p class='info'>
- As a general rule, if you do not specify a target type during parsing, or if the target type cannot be determined
- through reflection, the parsers automatically generate <l>ObjectMaps</l> and <l>ObjectLists</l>.
- </p>
+ <ul class='doctree'>
+ <li class='info'>
+ As a general rule, if you do not specify a target type during parsing, or if the target type cannot be determined
+ through reflection, the parsers automatically generate <l>ObjectMaps</l> and <l>ObjectLists</l>.
+ </ul>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='c'><a href="org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau"><code>ObjectMap</code></a>
- <li class='c'><a href="org/apache/juneau/ObjectList.html" title="class in org.apache.juneau"><code>ObjectList</code></a>
+ <ul class='doctree'>
+ <li class='jc'><a href="org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau"><code>ObjectMap</code></a>
+ <li class='jc'><a href="org/apache/juneau/ObjectList.html" title="class in org.apache.juneau"><code>ObjectList</code></a>
</ul>
</div>
@@ -920,18 +920,18 @@
However, each of the serializers and parsers already contain reusable instances with common configurations.<br>
For example, JSON has the following predefined reusable serializers and parsers:
</p>
- <ul class='javahierarchy'>
- <li class='c'><a href="org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json"><code>JsonSerializer</code></a>
+ <ul class='doctree'>
+ <li class='jc'><a href="org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json"><code>JsonSerializer</code></a>
<ul>
- <li class='f'><a href="org/apache/juneau/json/JsonSerializer.html#DEFAULT"><code>DEFAULT</code></a>
- <li class='f'><a href="org/apache/juneau/json/JsonSerializer.html#DEFAULT_LAX"><code>DEFAULT_LAX</code></a>
- <li class='f'><a href="org/apache/juneau/json/JsonSerializer.html#DEFAULT_READABLE"><code>DEFAULT_READABLE</code></a>
- <li class='f'><a href="org/apache/juneau/json/JsonSerializer.html#DEFAULT_LAX_READABLE"><code>DEFAULT_LAX_READABLE</code></a>
+ <li class='jf'><a href="org/apache/juneau/json/JsonSerializer.html#DEFAULT"><code>DEFAULT</code></a>
+ <li class='jf'><a href="org/apache/juneau/json/JsonSerializer.html#DEFAULT_LAX"><code>DEFAULT_LAX</code></a>
+ <li class='jf'><a href="org/apache/juneau/json/JsonSerializer.html#DEFAULT_READABLE"><code>DEFAULT_READABLE</code></a>
+ <li class='jf'><a href="org/apache/juneau/json/JsonSerializer.html#DEFAULT_LAX_READABLE"><code>DEFAULT_LAX_READABLE</code></a>
</ul>
- <li class='c'><a href="org/apache/juneau/json/JsonParser.html" title="class in org.apache.juneau.json"><code>JsonParser</code></a>
+ <li class='jc'><a href="org/apache/juneau/json/JsonParser.html" title="class in org.apache.juneau.json"><code>JsonParser</code></a>
<ul>
- <li class='f'><a href="org/apache/juneau/json/JsonParser.html#DEFAULT"><code>DEFAULT</code></a>
- <li class='f'><a href="org/apache/juneau/json/JsonParser.html#DEFAULT_STRICT"><code>DEFAULT_STRICT</code></a>
+ <li class='jf'><a href="org/apache/juneau/json/JsonParser.html#DEFAULT"><code>DEFAULT</code></a>
+ <li class='jf'><a href="org/apache/juneau/json/JsonParser.html#DEFAULT_STRICT"><code>DEFAULT_STRICT</code></a>
</ul>
</ul>
<p>
@@ -960,39 +960,39 @@
<p>
The following is a list of all configurable properties across all serializers and parsers.
</p>
- <ul class='javahierarchy'>
- <li class='c'><a class='doclink' href='org/apache/juneau/BeanContext.html#ConfigProperties'>BeanContext</a> - Properties associated with handling beans on serializers and parsers.
+ <ul class='doctree'>
+ <li class='jc'><a class='doclink' href='org/apache/juneau/BeanContext.html#ConfigProperties'>BeanContext</a> - Properties associated with handling beans on serializers and parsers.
<ul>
- <li class='c'><a class='doclink' href='org/apache/juneau/serializer/SerializerContext.html#ConfigProperties'>SerializerContext</a> - Configurable properties common to all serializers.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/serializer/SerializerContext.html#ConfigProperties'>SerializerContext</a> - Configurable properties common to all serializers.
<ul>
- <li class='c'><a class='doclink' href='org/apache/juneau/html/HtmlSerializerContext.html#ConfigProperties'>HtmlSerializerContext</a> - Configurable properties on the HTML serializer.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/html/HtmlSerializerContext.html#ConfigProperties'>HtmlSerializerContext</a> - Configurable properties on the HTML serializer.
<ul>
- <li class='c'><a class='doclink' href='org/apache/juneau/html/HtmlDocSerializerContext.html#ConfigProperties'>HtmlDocSerializerContext</a> - Configurable properties on the HTML document serializer.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/html/HtmlDocSerializerContext.html#ConfigProperties'>HtmlDocSerializerContext</a> - Configurable properties on the HTML document serializer.
</ul>
- <li class='i'><a class='doclink' href='org/apache/juneau/jena/RdfCommonContext.html#ConfigProperties'>RdfCommonContext</a> - Configurable properties common to the RDF serializers and parsers.
+ <li class='jic'><a class='doclink' href='org/apache/juneau/jena/RdfCommonContext.html#ConfigProperties'>RdfCommonContext</a> - Configurable properties common to the RDF serializers and parsers.
<ul>
- <li class='c'><a class='doclink' href='org/apache/juneau/jena/RdfSerializerContext.html#ConfigProperties'>RdfSerializerContext</a> - Configurable properties on the RDF serializers.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/jena/RdfSerializerContext.html#ConfigProperties'>RdfSerializerContext</a> - Configurable properties on the RDF serializers.
</ul>
- <li class='c'><a class='doclink' href='org/apache/juneau/json/JsonSerializerContext.html#ConfigProperties'>JsonSerializerContext</a> - Configurable properties on the JSON serializer.
- <li class='c'><a class='doclink' href='org/apache/juneau/msgpack/MsgPackSerializerContext.html#ConfigProperties'>MsgPackSerializerContext</a> - Configurable properties on the MessagePack serializer.
- <li class='c'><a class='doclink' href='org/apache/juneau/soap/SoapXmlSerializerContext.html#ConfigProperties'>SoapXmlSerializerContext</a> - Configurable properties on the SOAP/XML serializer.
- <li class='c'><a class='doclink' href='org/apache/juneau/urlencoding/UonSerializerContext.html#ConfigProperties'>UonSerializerContext</a> - Configurable properties on the URL-Encoding and UON serializers.
- <li class='c'><a class='doclink' href='org/apache/juneau/xml/XmlSerializerContext.html#ConfigProperties'>XmlSerializerContext</a> - Configurable properties on the XML serializer.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/json/JsonSerializerContext.html#ConfigProperties'>JsonSerializerContext</a> - Configurable properties on the JSON serializer.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/msgpack/MsgPackSerializerContext.html#ConfigProperties'>MsgPackSerializerContext</a> - Configurable properties on the MessagePack serializer.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/soap/SoapXmlSerializerContext.html#ConfigProperties'>SoapXmlSerializerContext</a> - Configurable properties on the SOAP/XML serializer.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/urlencoding/UonSerializerContext.html#ConfigProperties'>UonSerializerContext</a> - Configurable properties on the URL-Encoding and UON serializers.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/xml/XmlSerializerContext.html#ConfigProperties'>XmlSerializerContext</a> - Configurable properties on the XML serializer.
</ul>
- <li class='c'><a class='doclink' href='org/apache/juneau/parser/ParserContext.html#ConfigProperties'>ParserContext</a> - Configurable properties common to all parsers.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/parser/ParserContext.html#ConfigProperties'>ParserContext</a> - Configurable properties common to all parsers.
<ul>
- <li class='c'><a class='doclink' href='org/apache/juneau/html/HtmlParserContext.html#ConfigProperties'>HtmlParserContext</a> - Configurable properties on the HTML parser.
- <li class='i'><a class='doclink' href='org/apache/juneau/jena/RdfCommonContext.html#ConfigProperties'>RdfCommonContext</a> - Configurable properties common to the RDF serializers and parsers.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/html/HtmlParserContext.html#ConfigProperties'>HtmlParserContext</a> - Configurable properties on the HTML parser.
+ <li class='jic'><a class='doclink' href='org/apache/juneau/jena/RdfCommonContext.html#ConfigProperties'>RdfCommonContext</a> - Configurable properties common to the RDF serializers and parsers.
<ul>
- <li class='c'><a class='doclink' href='org/apache/juneau/jena/RdfParserContext.html#ConfigProperties'>RdfParserContext</a> - Configurable properties on the RDF parsers.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/jena/RdfParserContext.html#ConfigProperties'>RdfParserContext</a> - Configurable properties on the RDF parsers.
</ul>
- <li class='c'><a class='doclink' href='org/apache/juneau/json/JsonParserContext.html#ConfigProperties'>JsonParserContext</a> - Configurable properties on the JSON parser.
- <li class='c'><a class='doclink' href='org/apache/juneau/msgpack/MsgPackParserContext.html#ConfigProperties'>MsgPackParserContext</a> - Configurable properties on the MessagePack parser.
- <li class='c'><a class='doclink' href='org/apache/juneau/urlencoding/UonParserContext.html#ConfigProperties'>UonParserContext</a> - Configurable properties on the URL-Encoding and UON parsers.
- <li class='c'><a class='doclink' href='org/apache/juneau/xml/XmlParserContext.html#ConfigProperties'>XmlParserContext</a> - Configurable properties on the XML parser.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/json/JsonParserContext.html#ConfigProperties'>JsonParserContext</a> - Configurable properties on the JSON parser.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/msgpack/MsgPackParserContext.html#ConfigProperties'>MsgPackParserContext</a> - Configurable properties on the MessagePack parser.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/urlencoding/UonParserContext.html#ConfigProperties'>UonParserContext</a> - Configurable properties on the URL-Encoding and UON parsers.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/xml/XmlParserContext.html#ConfigProperties'>XmlParserContext</a> - Configurable properties on the XML parser.
</ul>
</ul>
- <li class='c'><a class='doclink' href='org/apache/juneau/server/RestContext.html#ConfigProperties'>RestContext</a> - Configurable properties on the REST servlet.
+ <li class='jc'><a class='doclink' href='org/apache/juneau/server/RestContext.html#ConfigProperties'>RestContext</a> - Configurable properties on the REST servlet.
</ul>
</div>
@@ -1005,22 +1005,22 @@
However, two special classes are provided tailor how certain Java objects are handled by the framework.
These classes are:
</p>
- <ul class='javahierarchy'>
- <li class='c'><a href="org/apache/juneau/transform/PojoSwap.html" title="class in org.apache.juneau.transform"><code>PojoSwap</code></a> - Tailor how specific non-bean classes are handled by the framework.
- <li class='c'><a href="org/apache/juneau/transform/BeanFilter.html" title="class in org.apache.juneau.transform"><code>BeanFilter</code></a> - Tailor how specific bean classes are handled by the framework.
+ <ul class='doctree'>
+ <li class='jc'><a href="org/apache/juneau/transform/PojoSwap.html" title="class in org.apache.juneau.transform"><code>PojoSwap</code></a> - Tailor how specific non-bean classes are handled by the framework.
+ <li class='jc'><a href="org/apache/juneau/transform/BeanFilter.html" title="class in org.apache.juneau.transform"><code>BeanFilter</code></a> - Tailor how specific bean classes are handled by the framework.
</ul>
<p>
Annotations are also provided that allow you to use transformations directly on class definitions:
</p>
- <ul class='javahierarchy'>
- <li class='n'><a href="org/apache/juneau/annotation/Pojo.html" title="annotation in org.apache.juneau.annotation"><code>@Pojo</code></a> - Used to tailor how non-bean POJOs get interpreted by the framework.
- <li class='n'><a href="org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> - Used to tailor how beans get interpreted by the framework.
- <li class='n'><a href="org/apache/juneau/annotation/BeanConstructor.html" title="annotation in org.apache.juneau.annotation"><code>@BeanConstructor</code></a> - Maps constructor arguments to property names on beans with read-only properties.
- <li class='n'><a href="org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><code>@BeanIgnore</code></a> - Ignore classes, fields, and methods from being interpreted as bean or bean components.
- <li class='n'><a href="org/apache/juneau/annotation/BeanProperty.html" title="annotation in org.apache.juneau.annotation"><code>@BeanProperty</code></a> - Used to tailor how bean properties get interpreted by the framework.
- <li class='n'><a href="org/apache/juneau/annotation/NameProperty.html" title="annotation in org.apache.juneau.annotation"><code>@NameProperty</code></a> - Identifies a setter as a method for setting the name of a POJO as it's known by its parent object.
- <li class='n'><a href="org/apache/juneau/annotation/ParentProperty.html" title="annotation in org.apache.juneau.annotation"><code>@ParentProperty</code></a> - Identifies a setter as a method for adding a parent reference to a child object.
- <li class='n'><a href="org/apache/juneau/annotation/URI.html" title="annotation in org.apache.juneau.annotation"><code>@URI</code></a> - Used to identify a class or bean property as a URI.
+ <ul class='doctree'>
+ <li class='ja'><a href="org/apache/juneau/annotation/Pojo.html" title="annotation in org.apache.juneau.annotation"><code>@Pojo</code></a> - Used to tailor how non-bean POJOs get interpreted by the framework.
+ <li class='ja'><a href="org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> - Used to tailor how beans get interpreted by the framework.
+ <li class='ja'><a href="org/apache/juneau/annotation/BeanConstructor.html" title="annotation in org.apache.juneau.annotation"><code>@BeanConstructor</code></a> - Maps constructor arguments to property names on beans with read-only properties.
+ <li class='ja'><a href="org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><code>@BeanIgnore</code></a> - Ignore classes, fields, and methods from being interpreted as bean or bean components.
+ <li class='ja'><a href="org/apache/juneau/annotation/BeanProperty.html" title="annotation in org.apache.juneau.annotation"><code>@BeanProperty</code></a> - Used to tailor how bean properties get interpreted by the framework.
+ <li class='ja'><a href="org/apache/juneau/annotation/NameProperty.html" title="annotation in org.apache.juneau.annotation"><code>@NameProperty</code></a> - Identifies a setter as a method for setting the name of a POJO as it's known by its parent object.
+ <li class='ja'><a href="org/apache/juneau/annotation/ParentProperty.html" title="annotation in org.apache.juneau.annotation"><code>@ParentProperty</code></a> - Identifies a setter as a method for adding a parent reference to a child object.
+ <li class='ja'><a href="org/apache/juneau/annotation/URI.html" title="annotation in org.apache.juneau.annotation"><code>@URI</code></a> - Used to identify a class or bean property as a URI.
</ul>
<!-- ======================================================================================================== -->
@@ -1087,26 +1087,27 @@
<p>
Several <code>PojoSwaps</code> are already provided for common Java objects:
</p>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/transforms/package-summary.html#TOC'>org.apache.juneau.transforms</a>
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/transforms/package-summary.html#TOC'>org.apache.juneau.transforms</a>
<ul>
- <li class='c'><a href="org/apache/juneau/transforms/ByteArrayBase64Swap.html" title="class in org.apache.juneau.transforms"><code>ByteArrayBase64Swap</code></a>
- <li class='a'><a href="org/apache/juneau/transforms/CalendarSwap.html" title="class in org.apache.juneau.transforms"><code>CalendarSwap</code></a>
- <li class='a'><a href="org/apache/juneau/transforms/DateSwap.html" title="class in org.apache.juneau.transforms"><code>DateSwap</code></a>
- <li class='c'><a href="org/apache/juneau/transforms/EnumerationSwap.html" title="class in org.apache.juneau.transforms"><code>EnumerationSwap</code></a>
- <li class='c'><a href="org/apache/juneau/transforms/IteratorSwap.html" title="class in org.apache.juneau.transforms"><code>IteratorSwap</code></a>
- <li class='c'><a href="org/apache/juneau/transforms/ReaderSwap.html" title="class in org.apache.juneau.transforms"><code>ReaderSwap</code></a>
- <li class='c'><a href="org/apache/juneau/transforms/XMLGregorianCalendarSwap.html" title="class in org.apache.juneau.transforms"><code>XMLGregorianCalendarSwap</code></a>
+ <li class='jc'><a href="org/apache/juneau/transforms/ByteArrayBase64Swap.html" title="class in org.apache.juneau.transforms"><code>ByteArrayBase64Swap</code></a>
+ <li class='jac'><a href="org/apache/juneau/transforms/CalendarSwap.html" title="class in org.apache.juneau.transforms"><code>CalendarSwap</code></a>
+ <li class='jac'><a href="org/apache/juneau/transforms/DateSwap.html" title="class in org.apache.juneau.transforms"><code>DateSwap</code></a>
+ <li class='jc'><a href="org/apache/juneau/transforms/EnumerationSwap.html" title="class in org.apache.juneau.transforms"><code>EnumerationSwap</code></a>
+ <li class='jc'><a href="org/apache/juneau/transforms/IteratorSwap.html" title="class in org.apache.juneau.transforms"><code>IteratorSwap</code></a>
+ <li class='jc'><a href="org/apache/juneau/transforms/ReaderSwap.html" title="class in org.apache.juneau.transforms"><code>ReaderSwap</code></a>
+ <li class='jc'><a href="org/apache/juneau/transforms/XMLGregorianCalendarSwap.html" title="class in org.apache.juneau.transforms"><code>XMLGregorianCalendarSwap</code></a>
</ul>
</ul>
<p>
In particular, the <a href="org/apache/juneau/transforms/CalendarSwap.html" title="class in org.apache.juneau.transforms"><code>CalendarSwap</code></a> and <a href="org/apache/juneau/transforms/DateSwap.html" title="class in org.apache.juneau.transforms"><code>DateSwap</code></a> tramsforms
provide a large number of customized swaps to ISO, RFC, or localized strings.
</p>
- <p class='info'>
- The 'swapped' class type must be a serializable type.<br>
- See the definition for Category 4 objects in <a class='doclink' href='#Core.PojoCategories'>POJO Categories</a>.
- </p>
+ <ul class='doctree'>
+ <li class='info'>
+ The 'swapped' class type must be a serializable type.<br>
+ See the definition for Category 4 objects in <a class='doclink' href='#Core.PojoCategories'>POJO Categories</a>.
+ </ul>
</div>
<!-- ======================================================================================================== -->
@@ -1311,8 +1312,8 @@
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/transform/package-summary.html#TOC'>org.apache.juneau.transform</a>
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/transform/package-summary.html#TOC'>org.apache.juneau.transform</a>
</ul>
</div>
@@ -1388,20 +1389,18 @@
<li>On individual bean properties through the <a href="org/apache/juneau/annotation/BeanProperty.html#beanDictionary--"><code>@BeanProperty.beanDictionary()</code></a> annotation.
<li>Globally for a parser using the <a href="org/apache/juneau/parser/ParserBuilder.html#beanDictionary-java.lang.Class...-"><code>ParserBuilder.beanDictionary(Class...)</code></a> method.
</ul>
- <p class='info'>
- Type names do not need to be universally unique.
- However, they must be unique within a dictionary.
- </p>
- <p class='info'>
- The following reserved words cannot be used as type names: <code>object, array, number, boolean, null</code>.
- </p>
- <p class='info'>
- Serialized type names are DISABLED by default.
- They must be enabled on the serializer using the <a href="org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_addBeanTypeProperties"><code>SerializerContext.SERIALIZER_addBeanTypeProperties</code></a> configuration property.
- </p>
- <p class='info'>
- The <js>"_type"</js> property name can be overridden using the <a href="org/apache/juneau/BeanContext.html#BEAN_beanTypePropertyName"><code>BeanContext.BEAN_beanTypePropertyName</code></a> configuration property.
- </p>
+ <ul class='doctree'>
+ <li class='info'>
+ Type names do not need to be universally unique.
+ However, they must be unique within a dictionary.
+ <li class='info'>
+ The following reserved words cannot be used as type names: <code>object, array, number, boolean, null</code>.
+ <li class='info'>
+ Serialized type names are DISABLED by default.
+ They must be enabled on the serializer using the <a href="org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_addBeanTypeProperties"><code>SerializerContext.SERIALIZER_addBeanTypeProperties</code></a> configuration property.
+ <li class='info'>
+ The <js>"_type"</js> property name can be overridden using the <a href="org/apache/juneau/BeanContext.html#BEAN_beanTypePropertyName"><code>BeanContext.BEAN_beanTypePropertyName</code></a> configuration property.
+ </ul>
<!-- ======================================================================================================== -->
<a id="Core.BeanSubTypes"></a>
@@ -1734,12 +1733,13 @@
<td style='background-color:salmon;text-align:center'><b>no</b></td>
</tr>
</table>
- <p class='info'>
- Serializers are designed to work on tree-shaped POJO models.
- These are models where there are no referential loops (e.g. leaves with references to nodes, or nodes in one branch referencing nodes in another branch).
- There is a serializer setting <code>detectRecursions</code> to look for and handle these kinds of loops (by setting these references to <jk>null</jk>),
- but it is not enabled by default since it introduces a moderate performance penalty.
- </p>
+ <ul class='doctree'>
+ <li class='info'>
+ Serializers are designed to work on tree-shaped POJO models.
+ These are models where there are no referential loops (e.g. leaves with references to nodes, or nodes in one branch referencing nodes in another branch).
+ There is a serializer setting <code>detectRecursions</code> to look for and handle these kinds of loops (by setting these references to <jk>null</jk>),
+ but it is not enabled by default since it introduces a moderate performance penalty.
+ </ul>
</div>
<!-- ======================================================================================================== -->
@@ -1773,8 +1773,8 @@
It is used extensively in the ConfigFile, REST and Microservice APIs.
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/svl/package-summary.html#TOC'>org.apache.juneau.svl</a> - Simple Variable Language Javadocs.
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/svl/package-summary.html#TOC'>org.apache.juneau.svl</a> - Simple Variable Language Javadocs.
</ul>
</div>
@@ -2009,8 +2009,8 @@
cf.save();
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/ini/package-summary.html#TOC'>org.apache.juneau.ini</a> - Config API Javadocs.
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/ini/package-summary.html#TOC'>org.apache.juneau.ini</a> - Config API Javadocs.
</ul>
</div>
@@ -2023,18 +2023,18 @@
Refer to these docs for language-specific information.
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/html/package-summary.html#TOC'>org.apache.juneau.html</a> - HTML support.
- <li class='p'><a class='doclink' href='org/apache/juneau/jena/package-summary.html#TOC'>org.apache.juneau.jena</a> - RDF support.
- <li class='p'><a class='doclink' href='org/apache/juneau/jso/package-summary.html#TOC'>org.apache.juneau.jso</a> - Java Serialized Object support.
- <li class='p'><a class='doclink' href='org/apache/juneau/json/package-summary.html#TOC'>org.apache.juneau.json</a> - JSON support.
- <li class='p'><a class='doclink' href='org/apache/juneau/msgpack/package-summary.html#TOC'>org.apache.juneau.msgpack</a> - MessagePack support.
- <li class='p'><a class='doclink' href='org/apache/juneau/plaintext/package-summary.html#TOC'>org.apache.juneau.plaintext</a> - Plain-text support.
- <li class='p'><a class='doclink' href='org/apache/juneau/soap/package-summary.html#TOC'>org.apache.juneau.soap</a> - SOAP support.
- <li class='p'><a class='doclink' href='org/apache/juneau/urlencoding/package-summary.html#TOC'>org.apache.juneau.urlencoding</a> - URL-Encoding and UON support.
- <li class='p'><a class='doclink' href='org/apache/juneau/xml/package-summary.html#TOC'>org.apache.juneau.xml</a> - XML support.
- <li class='p'><a class='doclink' href='org/apache/juneau/dto/atom/package-summary.html#TOC'>org.apache.juneau.dto.atom</a> - ATOM support.
- <li class='p'><a class='doclink' href='org/apache/juneau/dto/cognos/package-summary.html#TOC'>org.apache.juneau.dto.cognos</a> - Cognos support.
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/html/package-summary.html#TOC'>org.apache.juneau.html</a> - HTML support.
+ <li class='jp'><a class='doclink' href='org/apache/juneau/jena/package-summary.html#TOC'>org.apache.juneau.jena</a> - RDF support.
+ <li class='jp'><a class='doclink' href='org/apache/juneau/jso/package-summary.html#TOC'>org.apache.juneau.jso</a> - Java Serialized Object support.
+ <li class='jp'><a class='doclink' href='org/apache/juneau/json/package-summary.html#TOC'>org.apache.juneau.json</a> - JSON support.
+ <li class='jp'><a class='doclink' href='org/apache/juneau/msgpack/package-summary.html#TOC'>org.apache.juneau.msgpack</a> - MessagePack support.
+ <li class='jp'><a class='doclink' href='org/apache/juneau/plaintext/package-summary.html#TOC'>org.apache.juneau.plaintext</a> - Plain-text support.
+ <li class='jp'><a class='doclink' href='org/apache/juneau/soap/package-summary.html#TOC'>org.apache.juneau.soap</a> - SOAP support.
+ <li class='jp'><a class='doclink' href='org/apache/juneau/urlencoding/package-summary.html#TOC'>org.apache.juneau.urlencoding</a> - URL-Encoding and UON support.
+ <li class='jp'><a class='doclink' href='org/apache/juneau/xml/package-summary.html#TOC'>org.apache.juneau.xml</a> - XML support.
+ <li class='jp'><a class='doclink' href='org/apache/juneau/dto/atom/package-summary.html#TOC'>org.apache.juneau.dto.atom</a> - ATOM support.
+ <li class='jp'><a class='doclink' href='org/apache/juneau/dto/cognos/package-summary.html#TOC'>org.apache.juneau.dto.cognos</a> - Cognos support.
</ul>
</div>
@@ -2253,8 +2253,8 @@
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/dto/html5/package-summary.html#TOC'>org.apache.juneau.dto.html5</a> - HTML5 beans.
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/dto/html5/package-summary.html#TOC'>org.apache.juneau.dto.html5</a> - HTML5 beans.
</ul>
</div>
@@ -2371,8 +2371,8 @@
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/dto/atom/package-summary.html#TOC'>org.apache.juneau.dto.atom</a> - Atom DTOs.
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/dto/atom/package-summary.html#TOC'>org.apache.juneau.dto.atom</a> - Atom DTOs.
</ul>
</div>
@@ -2794,8 +2794,8 @@
Refer to the additional information for an in-depth examination of the API.
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/server/package-summary.html#TOC'>org.apache.juneau.rest</a> - Juneau Server API Javadocs.
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/server/package-summary.html#TOC'>org.apache.juneau.rest</a> - Juneau Server API Javadocs.
</ul>
</div>
@@ -2837,8 +2837,8 @@
Refer to the additional information for an in-depth examination of the API.
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/client/package-summary.html#TOC'>org.apache.juneau.rest.client</a> - Juneau Client API Javadocs.
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/client/package-summary.html#TOC'>org.apache.juneau.rest.client</a> - Juneau Client API Javadocs.
</ul>
</div>
@@ -2987,8 +2987,8 @@
recreated on the client side.
</ul>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/server/remoteable/package-summary.html#TOC'>org.apache.juneau.rest.remoteable</a> - Juneau Remoteable API Javadocs.
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/server/remoteable/package-summary.html#TOC'>org.apache.juneau.rest.remoteable</a> - Juneau Remoteable API Javadocs.
</ul>
<!-- ======================================================================================================== -->
@@ -3070,8 +3070,8 @@
</ul>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/remoteable/package-summary.html#TOC'>org.apache.juneau.remoteable</a> - Juneau Remoteable API Javadocs.
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/remoteable/package-summary.html#TOC'>org.apache.juneau.remoteable</a> - Juneau Remoteable API Javadocs.
</ul>
</div>
</div>
@@ -3100,8 +3100,8 @@
and easy-to-use REST interfaces with minimal overhead.
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/microservice/package-summary.html#TOC'>org.apache.juneau.microservice</a> - Juneau Microservice API Javadocs.
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/microservice/package-summary.html#TOC'>org.apache.juneau.microservice</a> - Juneau Microservice API Javadocs.
</ul>
</div>
@@ -3237,10 +3237,10 @@
If you open up a command prompt in the <l>build/microservice</l> folder, you can start your microservice as follows:
</p>
<img class='bordered' src='doc-files/Samples.Building.2.png'>
- <p class='warn'>
- If you get an error message saying <code class='snippet'>java.net.BindException: Address already in use</code>, this means that the microservice
- is already running elsewhere, so it cannot bind to port 10000.
- </p>
+ <ul class='doctree'>
+ <li class='warn'>If you get an error message saying <code class='snippet'>java.net.BindException: Address already in use</code>, this means that the microservice
+ is already running elsewhere, so it cannot bind to port 10000.
+ </ul>
</div>
<!-- ======================================================================================================== -->
@@ -3289,9 +3289,9 @@
However, if you need to add extra libraries to your microservice, you'll need to copy them into your <l>lib</l>
directory and add them to the classpath here.
</ul>
- <p class='warn'>
- If you modify the manifest file and get <l>NoClassDefFoundErrors</l>, ensure that the classpath entries contain trailing spaces.
- </p>
+ <ul class='doctree'>
+ <li class='warn'>If you modify the manifest file and get <l>NoClassDefFoundErrors</l>, ensure that the classpath entries contain trailing spaces.
+ </ul>
</div>
<!-- ======================================================================================================== -->
@@ -3305,20 +3305,20 @@
<p>
The class hierarchy for this class is:
</p>
- <ul class='javahierarchy'>
- <li class='a'><a href="org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>org.apache.juneau.rest.RestServlet</code></a>
+ <ul class='doctree'>
+ <li class='jac'><a href="org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>org.apache.juneau.rest.RestServlet</code></a>
<br>Contains all the REST servlet logic.
<ul>
- <li class='a'><a href="org/apache/juneau/rest/RestServletDefault.html" title="class in org.apache.juneau.rest"><code>org.apache.juneau.rest.RestServletDefault</code></a>
+ <li class='jac'><a href="org/apache/juneau/rest/RestServletDefault.html" title="class in org.apache.juneau.rest"><code>org.apache.juneau.rest.RestServletDefault</code></a>
<br>Defines default serializers and parsers, and OPTIONs page logic.
<ul>
- <li class='a'><a href="org/apache/juneau/rest/RestServletGroupDefault.html" title="class in org.apache.juneau.rest"><code>org.apache.juneau.rest.RestServletGroupDefault</code></a>
+ <li class='jac'><a href="org/apache/juneau/rest/RestServletGroupDefault.html" title="class in org.apache.juneau.rest"><code>org.apache.juneau.rest.RestServletGroupDefault</code></a>
<br>Specialized subclass for grouping other resources
<ul>
- <li class='a'><a href="org/apache/juneau/microservice/ResourceGroup.html" title="class in org.apache.juneau.microservice"><code>org.apache.juneau.microservice.ResourceGroup</code></a>
+ <li class='jac'><a href="org/apache/juneau/microservice/ResourceGroup.html" title="class in org.apache.juneau.microservice"><code>org.apache.juneau.microservice.ResourceGroup</code></a>
<br>Specialized subclass when using the Microservice API.
<ul>
- <li class='c'><code>org.apache.juneau.rest.samples.RootResources</code>
+ <li class='jc'><code>org.apache.juneau.rest.samples.RootResources</code>
</ul>
</ul>
</ul>
@@ -3420,15 +3420,16 @@
Note that these router pages can be arbitrarily nested deep.
You can define many levels of router pages for arbitrarily hierarchical REST interfaces.
</p>
- <p class='info'>
- Let's step back and describe what's going on here:<br>
- During servlet initialization of the <l>RootResources</l> object, the toolkit looks for the <l>@RestResource.children()</l> annotation.
- If it finds it, it instantiates instances of each class and recursively performs servlet initialization on them.
- It then associates the child resource with the parent by the name specified by the <l>@RestResource.path()</l> annotation on the child class.
- When a request for the child URL (<l>/helloWorld</l>) is received, the <l>RootResources</l> servlet gets the request and sees that the URL remainder matches one of its child resources.
- It then forwards the request to the child resource for processing.
- The request passed to the child resource is the same as if the child resource had been deployed independently (e.g. path-info, resource-URI, and so forth).
- </p>
+ <ul class='doctree'>
+ <li class='info'>
+ Let's step back and describe what's going on here:<br>
+ During servlet initialization of the <l>RootResources</l> object, the toolkit looks for the <l>@RestResource.children()</l> annotation.
+ If it finds it, it instantiates instances of each class and recursively performs servlet initialization on them.
+ It then associates the child resource with the parent by the name specified by the <l>@RestResource.path()</l> annotation on the child class.
+ When a request for the child URL (<l>/helloWorld</l>) is received, the <l>RootResources</l> servlet gets the request and sees that the URL remainder matches one of its child resources.
+ It then forwards the request to the child resource for processing.
+ The request passed to the child resource is the same as if the child resource had been deployed independently (e.g. path-info, resource-URI, and so forth).
+ </ul>
</div>
<!-- ======================================================================================================== -->
@@ -3470,17 +3471,17 @@
<p>
The class hierarchy for this class is:
</p>
- <ul class='javahierarchy'>
- <li class='a'><a href="org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>org.apache.juneau.rest.RestServlet</code></a>
+ <ul class='doctree'>
+ <li class='jac'><a href="org/apache/juneau/rest/RestServlet.html" title="class in org.apache.juneau.rest"><code>org.apache.juneau.rest.RestServlet</code></a>
<br>Contains all the REST servlet logic.
<ul>
- <li class='a'><a href="org/apache/juneau/rest/RestServletDefault.html" title="class in org.apache.juneau.rest"><code>org.apache.juneau.rest.RestServletDefault</code></a>
+ <li class='jac'><a href="org/apache/juneau/rest/RestServletDefault.html" title="class in org.apache.juneau.rest"><code>org.apache.juneau.rest.RestServletDefault</code></a>
<br>Defines default serializers and parsers, and OPTIONs page logic.
<ul>
- <li class='a'><a href="org/apache/juneau/microservice/Resource.html" title="class in org.apache.juneau.microservice"><code>org.apache.juneau.microservice.Resource</code></a>
+ <li class='jac'><a href="org/apache/juneau/microservice/Resource.html" title="class in org.apache.juneau.microservice"><code>org.apache.juneau.microservice.Resource</code></a>
<br>Specialized subclass when using the Microservice API.
<ul>
- <li class='c'><code>org.apache.juneau.rest.samples.HelloWorldResource</code>
+ <li class='jc'><code>org.apache.juneau.rest.samples.HelloWorldResource</code>
</ul>
</ul>
</ul>
@@ -3640,32 +3641,32 @@
<p>
The class consists of 4 methods:
</p>
- <ul class='javahierarchy'>
- <li class='m'><l>doExample()</l>
+ <ul class='doctree'>
+ <li class='jm'><l>doExample()</l>
<br>The root page.
<br>Performs a simple redirection to the <l>doGetExample1()</l> method using a <a href="org/apache/juneau/rest/Redirect.html" title="class in org.apache.juneau.rest"><code>Redirect</code></a> object.
- <li class='m'><l>example1()</l>
+ <li class='jm'><l>example1()</l>
<br>Shows how to use the following annotations:
<ul>
- <li class='n'><a href="org/apache/juneau/rest/annotation/Path.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Path</code></a>
- <li class='n'><a href="org/apache/juneau/rest/annotation/Query.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Query</code></a>
- <li class='n'><a href="org/apache/juneau/rest/annotation/Header.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Header</code></a>
- <li class='n'><a href="org/apache/juneau/rest/annotation/Method.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Method</code></a>
- <li class='n'><a href="org/apache/juneau/rest/annotation/PathRemainder.html" title="annotation in org.apache.juneau.rest.annotation"><code>@PathRemainder</code></a>
+ <li class='ja'><a href="org/apache/juneau/rest/annotation/Path.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Path</code></a>
+ <li class='ja'><a href="org/apache/juneau/rest/annotation/Query.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Query</code></a>
+ <li class='ja'><a href="org/apache/juneau/rest/annotation/Header.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Header</code></a>
+ <li class='ja'><a href="org/apache/juneau/rest/annotation/Method.html" title="annotation in org.apache.juneau.rest.annotation"><code>@Method</code></a>
+ <li class='ja'><a href="org/apache/juneau/rest/annotation/PathRemainder.html" title="annotation in org.apache.juneau.rest.annotation"><code>@PathRemainder</code></a>
</ul>
Method returns a POJO to be serialized as the output.
- <li class='m'><l>example2()</l>
+ <li class='jm'><l>example2()</l>
<br>Identical to <l>doGetExample1()</l> but shows how to use the <a href="org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> and <a href="org/apache/juneau/rest/RestResponse.html" title="class in org.apache.juneau.rest"><code>RestResponse</code></a> objects:
<ul>
- <li class='m'><a href="org/apache/juneau/rest/RestRequest.html#getPathMatch--"><code>RestRequest.getPathMatch()</code></a>
- <li class='m'><a href="org/apache/juneau/rest/RestRequest.html#getQuery--"><code>RestRequest.getQuery()</code></a>
- <li class='m'><a href="org/apache/juneau/rest/RestRequest.html#getFormData--"><code>RestRequest.getFormData()</code></a>
- <li class='m'><a href="org/apache/juneau/rest/RestRequest.html#getHeaders--"><code>RestRequest.getHeaders()</code></a>
- <li class='m'><a href="org/apache/juneau/rest/RestRequest.html#getMethod--"><code>RestRequest.getMethod()</code></a>
- <li class='m'><a href="org/apache/juneau/rest/RequestPathMatch.html#getRemainder--"><code>RequestPathMatch.getRemainder()</code></a>
+ <li class='jm'><a href="org/apache/juneau/rest/RestRequest.html#getPathMatch--"><code>RestRequest.getPathMatch()</code></a>
+ <li class='jm'><a href="org/apache/juneau/rest/RestRequest.html#getQuery--"><code>RestRequest.getQuery()</code></a>
+ <li class='jm'><a href="org/apache/juneau/rest/RestRequest.html#getFormData--"><code>RestRequest.getFormData()</code></a>
+ <li class='jm'><a href="org/apache/juneau/rest/RestRequest.html#getHeaders--"><code>RestRequest.getHeaders()</code></a>
+ <li class='jm'><a href="org/apache/juneau/rest/RestRequest.html#getMethod--"><code>RestRequest.getMethod()</code></a>
+ <li class='jm'><a href="org/apache/juneau/rest/RequestPathMatch.html#getRemainder--"><code>RequestPathMatch.getRemainder()</code></a>
</ul>
Method sets the POJO to be serialized using the <a href="org/apache/juneau/rest/RestResponse.html#setOutput-java.lang.Object-"><code>RestResponse.setOutput(Object)</code></a> method.
- <li class='m'><l>example3()</l>
+ <li class='jm'><l>example3()</l>
<br>Identical to <l>doGetExample1()</l> but uses automatically resolved parameters based on class type.
<br>Juneau automatically recognizes specific class types such as common header types and automatically
resolves them to objects for you.
@@ -3954,9 +3955,9 @@
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='m'><a href="org/apache/juneau/rest/RestConfig.html#addVars-java.lang.Class...-"><code>RestConfig.addVars(Class[])</code></a> - Servlet and request variables.
- <li class='m'><a href="org/apache/juneau/rest/RestCallHandler.html#getSessionObjects-org.apache.juneau.rest.RestRequest-"><code>RestCallHandler.getSessionObjects(RestRequest)</code></a> - Var resolver session objects.
+ <ul class='doctree'>
+ <li class='jm'><a href="org/apache/juneau/rest/RestConfig.html#addVars-java.lang.Class...-"><code>RestConfig.addVars(Class[])</code></a> - Servlet and request variables.
+ <li class='jm'><a href="org/apache/juneau/rest/RestCallHandler.html#getSessionObjects-org.apache.juneau.rest.RestRequest-"><code>RestCallHandler.getSessionObjects(RestRequest)</code></a> - Var resolver session objects.
</ul>
</div>
@@ -4116,10 +4117,11 @@
<li><l>CreatePerson, CreateAddress</l> - POJOs for creating and updating people and address through the REST interface.
<li><l>AddressBookResource</l> - The REST resource class.
</ul>
- <p class='info'>
+ <ul class='doctree'>
+ <li class='info'>
For the sake of brevity, bean properties are defined as public fields instead of the normal getters/setters.
Also, the examples are not the most efficient design and are not thread safe.
- </p>
+ </ul>
<p>
The <l>package-info.java</l> file is used to define XML and RDF namespaces on beans and properties in this package.
Here you define a default XML and RDF namespaces and URL mappings for namespace shortnames used throughout this package.
@@ -5156,9 +5158,10 @@
<img class='bordered' src='doc-files/Samples.SampleRemoteableServlet.2.png'>
<br><br>
<img class='bordered' src='doc-files/Samples.SampleRemoteableServlet.3.png'>
- <p class='info'>
- As good practice, you'll want to use interfaces to prevent all public methods from being exposed.
- </p>
+ <ul class='doctree'>
+ <li class='info'>
+ As good practice, you'll want to use interfaces to prevent all public methods from being exposed.
+ </ul>
<p>
Proxy interfaces are then retrieved using the <a href="org/apache/juneau/rest/client/RestClient.html#getRemoteableProxy-java.lang.Class-"><code>RestClient.getRemoteableProxy(Class)</code></a> method.
</p>
@@ -5181,13 +5184,13 @@
<jk>new</jk> CreateAddress(<js>"Test street"</js>, <js>"Test city"</js>, <js>"Test state"</js>, 12345, <jk>true</jk>))
);
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/server/remoteable/package-summary.html#TOC'>org.apache.juneau.rest.remoteable</a> - Remoteable API Javadoc
- <li class='a'><a href="org/apache/juneau/rest/remoteable/RemoteableServlet.html" title="class in org.apache.juneau.rest.remoteable"><code>RemoteableServlet</code></a>
- <li class='c'><a href="org/apache/juneau/rest/client/RestClient.html" title="class in org.apache.juneau.rest.client"><code>RestClient</code></a>
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/server/remoteable/package-summary.html#TOC'>org.apache.juneau.rest.remoteable</a> - Remoteable API Javadoc
+ <li class='jac'><a href="org/apache/juneau/rest/remoteable/RemoteableServlet.html" title="class in org.apache.juneau.rest.remoteable"><code>RemoteableServlet</code></a>
+ <li class='jc'><a href="org/apache/juneau/rest/client/RestClient.html" title="class in org.apache.juneau.rest.client"><code>RestClient</code></a>
<ul>
- <li class='m'><a href="org/apache/juneau/rest/client/RestClient.html#getRemoteableProxy-java.lang.Class-"><code>getRemoteableProxy(Class)</code></a>
- <li class='m'><a href="org/apache/juneau/rest/client/RestClient.html#getRemoteableProxy-java.lang.Class-java.lang.Object-"><code>getRemoteableProxy(Class,Object)</code></a>
+ <li class='jm'><a href="org/apache/juneau/rest/client/RestClient.html#getRemoteableProxy-java.lang.Class-"><code>getRemoteableProxy(Class)</code></a>
+ <li class='jm'><a href="org/apache/juneau/rest/client/RestClient.html#getRemoteableProxy-java.lang.Class-java.lang.Object-"><code>getRemoteableProxy(Class,Object)</code></a>
</ul>
</ul>
</div>
@@ -5304,8 +5307,8 @@
Note how the HTML file contains localized variables for the servlet label and description.
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='a'><a href="org/apache/juneau/microservice/resources/DirectoryResource.html" title="class in org.apache.juneau.microservice.resources"><code>DirectoryResource</code></a>
+ <ul class='doctree'>
+ <li class='jac'><a href="org/apache/juneau/microservice/resources/DirectoryResource.html" title="class in org.apache.juneau.microservice.resources"><code>DirectoryResource</code></a>
</ul>
</div>
@@ -5414,8 +5417,8 @@
}
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='p'><a class='doclink' href='org/apache/juneau/dto/atom/package-summary.html#TOC'>org.apache.juneau.dto.atom</a> - ATOM Feed DTO Javadocs.
+ <ul class='doctree'>
+ <li class='jp'><a class='doclink' href='org/apache/juneau/dto/atom/package-summary.html#TOC'>org.apache.juneau.dto.atom</a> - ATOM Feed DTO Javadocs.
</ul>
</div>
@@ -5498,9 +5501,9 @@
<ck>url</ck> = <cv>http://clmdocker02.ratl.swg.usma.apache.org:5000/v1</cv>
</p>
<h6 class='topic'>Additional Information</h6>
- <ul class='javahierarchy'>
- <li class='c'><a href="org/apache/juneau/rest/labels/ResourceDescription.html" title="class in org.apache.juneau.rest.labels"><code>ResourceDescription</code></a>
- <li class='m'><a href="org/apache/juneau/rest/RestContext.html#getConfigFile--"><code>RestContext.getConfigFile()</code></a>
+ <ul class='doctree'>
+ <li class='jc'><a href="org/apache/juneau/rest/labels/ResourceDescription.html" title="class in org.apache.juneau.rest.labels"><code>ResourceDescription</code></a>
+ <li class='jm'><a href="org/apache/juneau/rest/RestContext.html#getConfigFile--"><code>RestContext.getConfigFile()</code></a>
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/abstract_class.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/abstract_class.png b/content/site/apidocs/resources/icons/abstract_class.png
new file mode 100644
index 0000000..f2b833a
Binary files /dev/null and b/content/site/apidocs/resources/icons/abstract_class.png differ
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/annotation.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/annotation.png b/content/site/apidocs/resources/icons/annotation.png
new file mode 100644
index 0000000..41c670c
Binary files /dev/null and b/content/site/apidocs/resources/icons/annotation.png differ
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/class.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/class.png b/content/site/apidocs/resources/icons/class.png
new file mode 100644
index 0000000..eca31b3
Binary files /dev/null and b/content/site/apidocs/resources/icons/class.png differ
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/extlink.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/extlink.png b/content/site/apidocs/resources/icons/extlink.png
new file mode 100644
index 0000000..5e7b6e6
Binary files /dev/null and b/content/site/apidocs/resources/icons/extlink.png differ
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/field.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/field.png b/content/site/apidocs/resources/icons/field.png
new file mode 100644
index 0000000..b5069b2
Binary files /dev/null and b/content/site/apidocs/resources/icons/field.png differ
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/info.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/info.png b/content/site/apidocs/resources/icons/info.png
new file mode 100644
index 0000000..34cc330
Binary files /dev/null and b/content/site/apidocs/resources/icons/info.png differ
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/interface.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/interface.png b/content/site/apidocs/resources/icons/interface.png
new file mode 100644
index 0000000..059d2fe
Binary files /dev/null and b/content/site/apidocs/resources/icons/interface.png differ
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/link.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/link.png b/content/site/apidocs/resources/icons/link.png
new file mode 100644
index 0000000..77d4700
Binary files /dev/null and b/content/site/apidocs/resources/icons/link.png differ
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/method.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/method.png b/content/site/apidocs/resources/icons/method.png
new file mode 100644
index 0000000..72b0277
Binary files /dev/null and b/content/site/apidocs/resources/icons/method.png differ
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/package.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/package.png b/content/site/apidocs/resources/icons/package.png
new file mode 100644
index 0000000..538f2e5
Binary files /dev/null and b/content/site/apidocs/resources/icons/package.png differ
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/severe.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/severe.png b/content/site/apidocs/resources/icons/severe.png
new file mode 100644
index 0000000..d5309c1
Binary files /dev/null and b/content/site/apidocs/resources/icons/severe.png differ
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/sublink.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/sublink.png b/content/site/apidocs/resources/icons/sublink.png
new file mode 100644
index 0000000..08d73d1
Binary files /dev/null and b/content/site/apidocs/resources/icons/sublink.png differ
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1cf7b4bb/content/site/apidocs/resources/icons/warn.png
----------------------------------------------------------------------
diff --git a/content/site/apidocs/resources/icons/warn.png b/content/site/apidocs/resources/icons/warn.png
new file mode 100644
index 0000000..7eca7e6
Binary files /dev/null and b/content/site/apidocs/resources/icons/warn.png differ