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/27 02:38:15 UTC
[01/19] incubator-juneau git commit: Clean up javadocs.
Repository: incubator-juneau
Updated Branches:
refs/heads/master b59ffb4f3 -> 0d913b38f
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServiceProperties.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServiceProperties.java b/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServiceProperties.java
index b37a785..8c92777 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServiceProperties.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServiceProperties.java
@@ -19,16 +19,19 @@ import org.apache.juneau.rest.annotation.*;
/**
* Configurable properties for the {@link RemoteableServlet} class.
* <p>
- * Properties can be set on the {@link RestServlet} class using the {@link RestResource#properties} or {@link RestMethod#properties} annotations.
+ * Properties can be set on the {@link RestServlet} class using the {@link RestResource#properties} or
+ * {@link RestMethod#properties} annotations.
* <p>
* These properties can also be passed in as servlet init parameters.
* <p>
- * These properties are only valid at the class level, not the method level. Setting them on {@link RestMethod#properties()} has no effect.
+ * These properties are only valid at the class level, not the method level.
+ * Setting them on {@link RestMethod#properties()} has no effect.
*/
public final class RemoteableServiceProperties {
/**
- * Only expose interfaces and methods annotated with {@link Remoteable @Remoteable} ({@link Boolean}, default=<jk>false</jk>).
+ * Only expose interfaces and methods annotated with {@link Remoteable @Remoteable} ({@link Boolean},
+ * default=<jk>false</jk>).
* <p>
* When enabled, the {@link RemoteableServlet} class will only work with annotated remoteable interfaces and methods.
* Otherwise, all public methods can be executed through the service.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServlet.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServlet.java b/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServlet.java
index 2d173f5..5df35db 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServlet.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServlet.java
@@ -28,8 +28,8 @@ import org.apache.juneau.rest.annotation.*;
* <p>
* Remoteable services are POJOs whose methods can be invoked remotely through proxy interfaces.
* <p>
- * To implement a remoteable service, developers must simply subclass from this class and implement the {@link #getServiceMap()} method that
- * maps java interfaces to POJO instances.
+ * To implement a remoteable service, developers must simply subclass from this class and implement the
+ * {@link #getServiceMap()} method that maps java interfaces to POJO instances.
*
* See <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.rest.remoteable</a> for details.
*/
@@ -69,7 +69,7 @@ public abstract class RemoteableServlet extends RestServletDefault {
boolean useAll = ! useOnlyAnnotated();
for (Class<?> c : getServiceMap().keySet()) {
if (useAll || getContext().getBeanContext().getClassMeta(c).isRemoteable())
- l.add(new Link(c.getName(), "{0}/{1}", req.getRequestURI(), c.getName())); //$NON-NLS-1$
+ l.add(new Link(c.getName(), "{0}/{1}", req.getRequestURI(), c.getName()));
}
return l;
}
@@ -101,18 +101,18 @@ public abstract class RemoteableServlet extends RestServletDefault {
// Find the parser.
ReaderParser p = req.getBody().getReaderParser();
if (p == null)
- throw new RestException(SC_UNSUPPORTED_MEDIA_TYPE, "Could not find parser for media type ''{0}''", req.getHeaders().getContentType()); //$NON-NLS-1$
+ throw new RestException(SC_UNSUPPORTED_MEDIA_TYPE, "Could not find parser for media type ''{0}''", req.getHeaders().getContentType());
Class<?> c = getInterfaceClass(javaInterface);
// Find the service.
Object service = getServiceMap().get(c);
if (service == null)
- throw new RestException(SC_NOT_FOUND, "Service not found"); //$NON-NLS-1$
+ throw new RestException(SC_NOT_FOUND, "Service not found");
// Find the method.
java.lang.reflect.Method m = getMethods(javaInterface).get(javaMethod);
if (m == null)
- throw new RestException(SC_NOT_FOUND, "Method not found"); //$NON-NLS-1$
+ throw new RestException(SC_NOT_FOUND, "Method not found");
// Parse the args and invoke the method.
Object[] params = p.parseArgs(req.getReader(), m.getGenericParameterTypes());
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/package.html
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/package.html b/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/package.html
index 661ab91..206cf18 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/package.html
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/remoteable/package.html
@@ -73,17 +73,19 @@
<h2 class='topic' onclick='toggle(this)'>1 - Remoteable Services</h2>
<div class='topic'>
<p>
- The Remoteable Service API allows for client side code to use interface proxies for
- calling methods on POJOs on the server side.
+ The Remoteable Service API allows for client side code to use interface proxies for calling methods on POJOs on
+ the server side.
</p>
<p>
- Proxy interfaces are retrieved using the {@link org.apache.juneau.rest.client.RestClient#getRemoteableProxy(Class)} method.
- The remoteable servlet is a specialized subclass of {@link org.apache.juneau.rest.RestServlet} that provides a full-blown
- REST interface for calling remoteable services (e.g. POJOs) remotely.
+ Proxy interfaces are retrieved using the {@link org.apache.juneau.rest.client.RestClient#getRemoteableProxy(Class)}
+ method.
+ The remoteable servlet is a specialized subclass of {@link org.apache.juneau.rest.RestServlet} that provides a
+ full-blown REST interface for calling remoteable services (e.g. POJOs) remotely.
</p>
<p>
The following simplified example shows how a method on a POJO on a server can be called through an interface
- on a client...
+ on a client...
+ </p>
<p class='bcode'>
<jk>public interface</jk> IAddressBook {
Person createPerson(CreatePerson cp) <jk>throws</jk> Exception;
@@ -115,8 +117,10 @@
The requirements for a method to be callable through the remoteable service are:
</p>
<ul class='spaced-list'>
- <li>The method must be public.
- <li>The parameter and return types must be <a href='../../../../../overview-summary.html#Core.PojoCategories'>serializable and parsable</a>.
+ <li>
+ The method must be public.
+ <li>
+ The parameter and return types must be <a href='../../../../../overview-summary.html#Core.PojoCategories'>serializable and parsable</a>.
</ul>
</div>
@@ -125,12 +129,13 @@
<h2 class='topic' onclick='toggle(this)'>2 - Client Side</h2>
<div class='topic'>
<p>
- Remoteable interface proxies are retrieved through the existing {@link org.apache.juneau.rest.client.RestClient} class.
+ Remoteable interface proxies are retrieved through the existing {@link org.apache.juneau.rest.client.RestClient}
+ class.
</p>
<p>
It may seem that the client-side code would need to be complex.
- In reality, it builds upon existing serializing, parsing, and REST capabilities in Juneau resulting
- in very little additional code.
+ In reality, it builds upon existing serializing, parsing, and REST capabilities in Juneau resulting in very
+ little additional code.
The entire code for the <code>RestClient.getRemoteableProxy(Class)</code> method is shown below:
</p>
<p class='bcode'>
@@ -153,10 +158,9 @@
</p>
<p>
Since we build upon the existing <code>RestClient</code> API, we inherit all of it's features.
- For example, convenience methods for setting POJO filters and properties to customize
- the behavior of the serializers and parsers, and the ability to provide your own
- customized Apache <code>HttpClient</code> for handling various scenarios involving
- authentication and internet proxies.
+ For example, convenience methods for setting POJO filters and properties to customize the behavior of the
+ serializers and parsers, and the ability to provide your own customized Apache <code>HttpClient</code> for
+ handling various scenarios involving authentication and Internet proxies.
</p>
</div>
@@ -168,16 +172,16 @@
The server side is only slightly more complex, but boasts useful debugging and discovery capabilities.
</p>
<p>
- The {@link org.apache.juneau.rest.remoteable.RemoteableServlet} class is an implementation of {@link org.apache.juneau.rest.RestServlet}
- that provides a REST interface for invoking calls on POJOs.
- The <code>RemoteableServlet</code> class is abstract and must implement a single method for providing
- the set of POJOs to expose as remote interfaces.
+ The {@link org.apache.juneau.rest.remoteable.RemoteableServlet} class is an implementation of
+ {@link org.apache.juneau.rest.RestServlet} that provides a REST interface for invoking calls on POJOs.
+ The <code>RemoteableServlet</code> class is abstract and must implement a single method for providing the set
+ of POJOs to expose as remote interfaces.
</p>
<p>
- The samples bundle includes a sample implementation of a remotable service that can be used to interact with the
- address book POJO also included in the bundle.
+ The samples bundle includes a sample implementation of a remoteable service that can be used to interact with
+ the address book POJO also included in the bundle.
The method that must be implemented is {@link org.apache.juneau.rest.remoteable.RemoteableServlet#getServiceMap()}
- that simply returns a mapping of Java interfaces (or classes) to POJO instances.
+ that simply returns a mapping of Java interfaces (or classes) to POJO instances.
</p>
<p class='bcode'>
<ja>@RestResource</ja>(
@@ -213,16 +217,16 @@
<p>
Clicking the hyperlinks on each shows you the list of methods that can be invoked on that service.
Note that the <code>IAddressBook</code> link shows that you can only invoke methods defined on that
- interface, whereas the <code>AddressBook</code> link shows ALL public methods defined on that class.
+ interface, whereas the <code>AddressBook</code> link shows ALL public methods defined on that class.
Since <code>AddressBook</code> extends from <code>LinkedList</code>, you may notice familiar collections
- framework methods listed.
+ framework methods listed.
</p>
<img class='bordered' src="doc-files/2.png">
<img class='bordered' src="doc-files/3.png">
<p>
- Let's see how we can interact with this interface through nothing more than REST calls
- to get a better idea on how this works.
- We'll use the same method call as in the introduction.
+ Let's see how we can interact with this interface through nothing more than REST calls to get a better idea on
+ how this works.
+ We'll use the same method call as in the introduction.
First, we need to create the serialized form of the arguments:
</p>
<p class='bcode'>
@@ -264,12 +268,13 @@
Methods are invoked by POSTing the serialized object array to the URI of the interface method.
In this case, we want to POST our JSON to <code>/juneau/sample/remoteable/org.apache.juneau.examples.addressbook.IAddressBook/createPerson(org.apache.juneau.examples.addressbook.CreatePerson)</code>.
Make sure that we specify the <code>Content-Type</code> of the body as <code>text/json</code>.
- We also want the results to be returned as JSON, so we set the <code>Accept</code> header to <code>text/json</code> as well.
+ We also want the results to be returned as JSON, so we set the <code>Accept</code> header to
+ <code>text/json</code> as well.
</p>
<img class='bordered' src="doc-files/4.png">
<p>
- When we execute the POST, we should see the following successful response whose body contains the returned <code>Person</code> bean
- serialized to JSON:
+ When we execute the POST, we should see the following successful response whose body contains the returned
+ <code>Person</code> bean serialized to JSON:
</p>
<img class='bordered' src="doc-files/5.png">
<p>
@@ -280,7 +285,8 @@
Person p = JsonParser.<jsf>DEFAULT</jsf>.parse(response, Person.<jk>class</jk>);
</p>
<p>
- If we alter our servlet to allow overloaded GET requests, we can invoke methods using nothing more than a browser...
+ If we alter our servlet to allow overloaded GET requests, we can invoke methods using nothing more than a
+ browser...
</p>
<p class='bcode'>
<ja>@RestResource</ja>(
@@ -293,15 +299,18 @@
<jk>public class</jk> SampleRemoteableServlet <jk>extends</jk> RemoteableServlet {
</p>
<p>
- For example, here we call the <code>findPerson(<jk>int</jk>)</code> method to retrieve a person and get the returned POJO
- (in this case as HTML since that's what's in the <code>Accept</code> header when calling from a browser):
+ For example, here we call the <code>findPerson(<jk>int</jk>)</code> method to retrieve a person and get the
+ returned POJO (in this case as HTML since that's what's in the <code>Accept</code> header when calling from a
+ browser):
</p>
<img class='bordered' src="doc-files/6.png">
<p>
- When specifying the POST body as a <code>&content</code> parameter, the method arguments should be in UON notation.
+ When specifying the POST body as a <code>&content</code> parameter, the method arguments should be in UON
+ notation.
See {@link org.apache.juneau.uon.UonSerializer} for more information about this encoding.
Usually you can also pass in JSON if you specify <code>&Content-Type=text/json</code> in the URL parameters
- but passing in unencoded JSON in a URL may not work in all browsers. Therefore, UON is preferred.
+ but passing in unencoded JSON in a URL may not work in all browsers.
+ Therefore, UON is preferred.
</p>
</div>
@@ -310,7 +319,8 @@
<h2 class='topic' onclick='toggle(this)'>4 - @Remoteable Annotation</h2>
<div class='topic'>
<p>
- What if you want fine-tuned control over which methods are exposed in an interface instead of just all public methods?
+ What if you want fine-tuned control over which methods are exposed in an interface instead of just all public
+ methods?
For this, the {@link org.apache.juneau.remoteable.Remoteable @Remoteable} annotation is provided.
It can be applied to individual interface methods to only expose those methods through the remoteable servlet.
</p>
@@ -339,7 +349,8 @@
<jk>public class</jk> SampleRemoteableServlet <jk>extends</jk> RemoteableServlet {
</p>
<p>
- The <ja>@Remoteable</ja> annotation can also be applied to the interface class to expose all public methods defined on that interface.
+ The <ja>@Remoteable</ja> annotation can also be applied to the interface class to expose all public methods
+ defined on that interface.
</p>
<p class='bcode'>
<ja>@Remoteable</ja>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java b/juneau-rest/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java
index fad726e..57ecc18 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java
@@ -30,8 +30,8 @@ import org.apache.juneau.serializer.*;
* <p>
* The {@link Serializer} used is based on the <code>Accept</code> header on the request.
* <p>
- * The <code>Content-Type</code> header is set to the mime-type defined on the selected
- * serializer based on the {@link Produces#contentType() @Produces.contentType} annotation.
+ * The <code>Content-Type</code> header is set to the mime-type defined on the selected serializer based on the
+ * {@link Produces#contentType() @Produces.contentType} annotation.
*/
public class DefaultHandler implements ResponseHandler {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java b/juneau-rest/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java
index 78d3948..96ae45f 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java
@@ -22,7 +22,8 @@ import org.apache.juneau.utils.*;
* <p>
* Simply pipes the contents of the {@link InputStream} to {@link RestResponse#getNegotiatedOutputStream()}.
* <p>
- * Sets the <code>Content-Type</code> response header to whatever was set via {@link RestResponse#setContentType(String)}.
+ * Sets the <code>Content-Type</code> response header to whatever was set via
+ * {@link RestResponse#setContentType(String)}.
*/
public final class InputStreamHandler implements ResponseHandler {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java b/juneau-rest/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java
index 4eed2fe..f454fa6 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java
@@ -22,7 +22,8 @@ import org.apache.juneau.rest.*;
/**
* Response handler for {@link Writable} and {@link ReaderResource} objects.
* <p>
- * Uses the {@link Writable#writeTo(Writer)} method to send the contents to the {@link RestResponse#getNegotiatedWriter()} writer.
+ * Uses the {@link Writable#writeTo(Writer)} method to send the contents to the
+ * {@link RestResponse#getNegotiatedWriter()} writer.
*/
public final class StreamableHandler implements ResponseHandler {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/response/WritableHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/response/WritableHandler.java b/juneau-rest/src/main/java/org/apache/juneau/rest/response/WritableHandler.java
index 927fb82..4f1e9e7 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/response/WritableHandler.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/response/WritableHandler.java
@@ -22,7 +22,8 @@ import org.apache.juneau.rest.*;
/**
* Response handler for {@link Writable} and {@link ReaderResource} objects.
* <p>
- * Uses the {@link Writable#writeTo(Writer)} method to send the contents to the {@link RestResponse#getNegotiatedWriter()} writer.
+ * Uses the {@link Writable#writeTo(Writer)} method to send the contents to the
+ * {@link RestResponse#getNegotiatedWriter()} writer.
*/
public final class WritableHandler implements ResponseHandler {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java b/juneau-rest/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java
index 32c8742..bdbf32e 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java
@@ -27,9 +27,11 @@ import org.apache.juneau.utils.ZipFileList.*;
* <p>
* Sets the following headers:
* <ul class='spaced-list'>
- * <li><code>Content-Type</code> - <code>application/zip</code>
- * <li><code>Content-Disposition=attachment;filename=X</code> - Sets X to the file name passed in through
- * the constructor {@link ZipFileList#ZipFileList(String)}.
+ * <li>
+ * <code>Content-Type</code> - <code>application/zip</code>
+ * <li>
+ * <code>Content-Disposition=attachment;filename=X</code> - Sets X to the file name passed in through the
+ * constructor {@link ZipFileList#ZipFileList(String)}.
* </ul>
*/
public class ZipFileListResponseHandler implements ResponseHandler {
@@ -38,8 +40,8 @@ public class ZipFileListResponseHandler implements ResponseHandler {
public boolean handle(RestRequest req, RestResponse res, Object output) throws IOException, RestException {
if (output.getClass() == ZipFileList.class) {
ZipFileList m = (ZipFileList)output;
- res.setContentType("application/zip"); //$NON-NLS-1$
- res.setHeader("Content-Disposition", "attachment;filename=" + m.fileName); //$NON-NLS-1$ //$NON-NLS-2$
+ res.setContentType("application/zip");
+ res.setHeader("Content-Disposition", "attachment;filename=" + m.fileName); //$NON-NLS-2$
OutputStream os = res.getOutputStream();
try {
ZipOutputStream zos = new ZipOutputStream(os);
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/vars/LocalizationVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/LocalizationVar.java b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/LocalizationVar.java
index 341c3cf..c7ecad1 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/LocalizationVar.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/LocalizationVar.java
@@ -23,7 +23,7 @@ import org.apache.juneau.svl.*;
* The format for this var is <js>"$L{key}"</js> or <js>"$L{key,args...}"</js>.
* <p>
* This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver or a
- * session object on the resolver session.
+ * session object on the resolver session.
* <p>
* Values are pulled from the {@link RestRequest#getMessage(String,Object[])} method.
* These in turn are pulled from the resource bundle associated with the servlet class where the request was made.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/vars/RequestVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/RequestVar.java b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/RequestVar.java
index 3764cf8..c6e8e22 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/RequestVar.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/RequestVar.java
@@ -37,7 +37,7 @@ import org.apache.juneau.svl.*;
* </ul>
* <p>
* This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver or a
- * session object on the resolver session.
+ * session object on the resolver session.
* <p>
* Since this is a {@link SimpleVar}, any variables contained in the result will be recursively resolved.
* Likewise, if the arguments contain any variables, those will be resolved before they are passed to this var.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/vars/ServletInitParamVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/ServletInitParamVar.java b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/ServletInitParamVar.java
index b141695..017d69a 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/ServletInitParamVar.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/ServletInitParamVar.java
@@ -21,7 +21,7 @@ import org.apache.juneau.svl.*;
* The format for this var is <js>"$I{key}"</js> or <js>"$I{key,defaultValue}"</js>.
* <p>
* This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver or a
- * session object on the resolver session.
+ * session object on the resolver session.
* <p>
* Values are pulled from the {@link RestServlet#getInitParameter(String)} method.
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/vars/UrlEncodeVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/UrlEncodeVar.java b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/UrlEncodeVar.java
index 6fa7f5f..13cc05b 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/UrlEncodeVar.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/UrlEncodeVar.java
@@ -22,7 +22,8 @@ import org.apache.juneau.svl.*;
* <p>
* The format for this var is <js>"$UE{innerValue}"</js>.
* <p>
- * This variable takes the contents inside the variable and replaces it with a value returned by calling {@link StringUtils#urlEncode(String)}).
+ * This variable takes the contents inside the variable and replaces it with a value returned by calling
+ * {@link StringUtils#urlEncode(String)}).
* <p>
* Since this is a {@link SimpleVar}, any variables contained in the result will be recursively resolved.
* Likewise, if the arguments contain any variables, those will be resolved before they are passed to this var.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/vars/UrlVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/UrlVar.java b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/UrlVar.java
index 065978b..5e3692d 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/UrlVar.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/UrlVar.java
@@ -20,7 +20,8 @@ import org.apache.juneau.svl.*;
/**
* Resolver for resolving URL variables <js>"$U{name}"</js>.
* <p>
- * The advantage of using this variable is that you can resolve URLs with special protocols such as <js>"servlet:/xxx"</js>.
+ * The advantage of using this variable is that you can resolve URLs with special protocols such as
+ * <js>"servlet:/xxx"</js>.
* <p>
* See {@link UriResolver} for the kinds of URIs that can be resolved.
* <ul>
@@ -30,7 +31,7 @@ import org.apache.juneau.svl.*;
* </ul>
* <p>
* Uses the URI resolver returned by {@link RestRequest#getUriResolver(UriResolution, UriRelativity)} with resolution
- * {@link UriResolution#ROOT_RELATIVE} and relativity {@link UriRelativity#RESOURCE}.
+ * {@link UriResolution#ROOT_RELATIVE} and relativity {@link UriRelativity#RESOURCE}.
*
* @see org.apache.juneau.svl
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/vars/WidgetVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/WidgetVar.java b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/WidgetVar.java
index 3c73f8d..96b16d8 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/WidgetVar.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/WidgetVar.java
@@ -38,7 +38,9 @@ public class WidgetVar extends SimpleVar {
*/
public static final String SESSION_req = "req";
- /** The name of this variable. */
+ /**
+ * The name of this variable.
+ */
public static final String NAME = "W";
/**
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/widget/QueryWidget.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/widget/QueryWidget.java b/juneau-rest/src/main/java/org/apache/juneau/rest/widget/QueryWidget.java
index c21aa21..fcfba72 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/widget/QueryWidget.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/widget/QueryWidget.java
@@ -20,7 +20,7 @@ import org.apache.juneau.rest.converters.*;
* Adds a <code>QUERY</code> link to the page that allows you to perform search/view/sort/paging on the page data.
* <p>
* A typical usage of the query widget is to include it as a navigation link as shown in the example below
- * pulled from the <code>PetStoreResource</code> example:
+ * pulled from the <code>PetStoreResource</code> example:
* <p class='bcode'>
* <ja>@RestResource</ja>(
* widgets={
@@ -32,8 +32,8 @@ import org.apache.juneau.rest.converters.*;
* )
* </p>
* <p>
- * In the above example, this adds a <code>QUERY</code> that displays a search popup that can be used for
- * filtering the page results...
+ * In the above example, this adds a <code>QUERY</code> that displays a search popup that can be used for filtering the
+ * page results...
* <p>
* <img class='bordered' src='doc-files/PetStore_Query.png'>
* <p>
@@ -47,7 +47,7 @@ import org.apache.juneau.rest.converters.*;
* The search arguments can be retrieved programmatically using {@link RequestQuery#getSearchArgs()}.
* <p>
* Typically, the search functionality is implemented by applying the predefined {@link Queryable} converter on the
- * method that's returning a 2-dimensional table of POJOs that you wish to filter:
+ * method that's returning a 2-dimensional table of POJOs that you wish to filter:
* <p class='bcode'>
* <ja>@RestMethod</ja>(
* name=<js>"GET"</js>,
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/widget/Widget.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/widget/Widget.java b/juneau-rest/src/main/java/org/apache/juneau/rest/widget/Widget.java
index ec52998..281636a 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/widget/Widget.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/widget/Widget.java
@@ -29,13 +29,15 @@ public abstract class Widget {
/**
* The widget key (i.e. The contents of the <js>"$W{...}"</js> variable).
+ *
* @return The widget key.
- * Must not be <jk>null</jk>.
+ * Must not be <jk>null</jk>.
*/
public abstract String getName();
/**
* Resolves the value for the variable.
+ *
* @param req The HTTP request object.
* @return The resolved value.
* @throws Exception
[10/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/xml/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/package.html b/juneau-core/src/main/java/org/apache/juneau/xml/package.html
index 34cb5bc..70fec82 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/package.html
@@ -96,25 +96,27 @@
<div class='topic'>
<p>
Juneau supports converting arbitrary POJOs to and from XML using ultra-efficient serializers and parsers.
- <br>
- The XML serializer converts POJOs directly to XML without the need for intermediate DOM objects.
- <br>
- Likewise, the XML parser uses a STaX parser and creates POJOs directly without intermediate DOM objects.
+ <br>The XML serializer converts POJOs directly to XML without the need for intermediate DOM objects.
+ <br>Likewise, the XML parser uses a STaX parser and creates POJOs directly without intermediate DOM objects.
</p>
<p>
Unlike frameworks such as JAXB, Juneau does not require POJO classes to be annotated to produce and consume
XML.
- <br>
- For example, it can serialize and parse instances of any of the following POJO types:
+ <br>For example, it can serialize and parse instances of any of the following POJO types:
</p>
<ul class='spaced-list'>
- <li>Java primitive objects (e.g. <code>String</code>, <code>Integer</code>, <code>Boolean</code>,
+ <li>
+ Java primitive objects (e.g. <code>String</code>, <code>Integer</code>, <code>Boolean</code>,
<code>Float</code>).
- <li>Java collections framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything
+ <li>
+ Java collections framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything
on this list.
- <li>Multi-dimensional arrays of any type on this list.
- <li>Java Beans with properties of any type on this list.
- <li>Classes with standard transformations to and from <code>Strings</code> (e.g. classes containing
+ <li>
+ Multi-dimensional arrays of any type on this list.
+ <li>
+ Java Beans with properties of any type on this list.
+ <li>
+ Classes with standard transformations to and from <code>Strings</code> (e.g. classes containing
<code>toString()</code>, <code>fromString()</code>, <code>valueOf()</code>,
<code>constructor(String)</code>).
</ul>
@@ -122,8 +124,7 @@
In addition to the types shown above, Juneau includes the ability to define transforms to transform
non-standard object and property types to serializable forms (e.g. to transform <code>Calendars</code> to and
from <code>ISO8601</code> strings, or <code>byte[]</code> arrays to and from base-64 encoded strings).
- <br>
- These transforms can be associated with serializers/parsers, or can be associated with classes or bean
+ <br>These transforms can be associated with serializers/parsers, or can be associated with classes or bean
properties through type and method annotations.
</p>
<p>
@@ -134,6 +135,7 @@
While annotations are not required to produce or consume XML, several XML annotations are provided for handling
namespaces and fine-tuning the format of the XML produced.
</p>
+
<h6 class='topic'>Prerequisites</h6>
<p>
The Juneau XML serialization and parsing support does not require any external prerequisites.
@@ -147,8 +149,7 @@
<p>
The example shown here is from the Address Book resource located in the <code>juneau-examples-rest</code>
microservice project.
- <br>
- The POJO model consists of a <code>List</code> of <code>Person</code> beans, with each <code>Person</code>
+ <br>The POJO model consists of a <code>List</code> of <code>Person</code> beans, with each <code>Person</code>
containing zero or more <code>Address</code> beans.
</p>
<p>
@@ -183,27 +184,31 @@
<div class='topic'>
<p>
{@link org.apache.juneau.xml.XmlSerializer} is the class used to convert POJOs to XML.
- <br>
- {@link org.apache.juneau.xml.XmlDocSerializer} is a subclass that adds an XML declaration element to the output
- before the POJO is serialized.
+ <br>{@link org.apache.juneau.xml.XmlDocSerializer} is a subclass that adds an XML declaration element to the output
+ before the POJO is serialized.
</p>
<p>
The XML serializer includes many configurable settings.
- <br>
- Static reusable instances of XML serializers are provided with commonly-used settings:
+ <br>Static reusable instances of XML serializers are provided with commonly-used settings:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT}
+ <li>
+ {@link org.apache.juneau.xml.XmlSerializer#DEFAULT}
- All default settings.
- <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_SQ}
+ <li>
+ {@link org.apache.juneau.xml.XmlSerializer#DEFAULT_SQ}
- Use single quotes on attributes. Typically useful for testing since it makes string comparison simpler.
- <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_SQ_READABLE}
+ <li>
+ {@link org.apache.juneau.xml.XmlSerializer#DEFAULT_SQ_READABLE}
- Use single quotes on attributes and add whitespace for readability.
- <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS}
+ <li>
+ {@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS}
- Same as DEFAULT but with namespaces enabled.
- <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS_SQ}
+ <li>
+ {@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS_SQ}
- Same as DEFAULT_SQ but with namespaces enabled.
- <li>{@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS_SQ_READABLE}
+ <li>
+ {@link org.apache.juneau.xml.XmlSerializer#DEFAULT_NS_SQ_READABLE}
- Same as DEFAULT_SQ_READABLE but with namespaces enabled.
</ul>
<p>
@@ -220,13 +225,12 @@
<p>
Refer to the package-level Javadocs for more information about those formats.
</p>
+
<h6 class='topic'>Notes about examples</h6>
<p>
The examples shown in this document will use single-quote, readable settings.
- <br>
- For brevity, the examples will use public fields instead of getters/setters to reduce the size of the examples.
- <br>
- In the real world, you'll typically want to use standard bean getters and setters.
+ <br>For brevity, the examples will use public fields instead of getters/setters to reduce the size of the examples.
+ <br>In the real world, you'll typically want to use standard bean getters and setters.
</p>
<p>
To start off simple, we'll begin with the following simplified bean and build upon it.
@@ -285,11 +289,9 @@
</xt></p>
<p>
The first thing you may notice is how the bean instance is represented by the element <xt><object></xt>.
- <br>
- When objects have no name associated with them, Juneau provides a default generalized name that maps to the
+ <br>When objects have no name associated with them, Juneau provides a default generalized name that maps to the
equivalent JSON data type.
- <br>
- Some cases when objects do not have names:
+ <br>Some cases when objects do not have names:
</p>
<ul>
<li>Root element
@@ -297,11 +299,9 @@
</ul>
<p>
The generalized name reflects the JSON-equivalent data type.
- <br>
- Juneau produces JSON-equivalent XML, meaning any valid JSON document can be losslessly converted into an XML
+ <br>Juneau produces JSON-equivalent XML, meaning any valid JSON document can be losslessly converted into an XML
equivalent.
- <br>
- In fact, all of the Juneau serializers and parsers are built upon this JSON-equivalence.
+ <br>In fact, all of the Juneau serializers and parsers are built upon this JSON-equivalence.
</p>
@@ -313,6 +313,7 @@
The following examples show how different data types are represented in XML.
They mirror how the data structures are represented in JSON.
</p>
+
<h6 class='topic'>Simple types</h6>
<p>
The representation of loose (not a direct bean property value) simple types are shown below:
@@ -349,6 +350,7 @@
<td class='code'><xt><null/></xt></td>
</tr>
</table>
+
<h6 class='topic'>Maps</h6>
<p>
Loose maps and beans use the element <xt><object></xt> for encapsulation.
@@ -658,6 +660,7 @@
</xt></td>
</tr>
</table>
+
<h6 class='topic'>Beans with Map properties</h6>
<table class='styled' style='width:auto'>
<tr>
@@ -717,8 +720,7 @@
<p>
Just because Juneau allows you to serialize ordinary POJOs to XML doesn't mean you are limited to just
JSON-equivalent XML.
- <br>
- Several annotations are provided in the <a class='doclink' href='annotation/package-summary.html#TOC'>
+ <br>Several annotations are provided in the <a class='doclink' href='annotation/package-summary.html#TOC'>
org.apache.juneau.xml.annotation</a> package for customizing the output.
</p>
@@ -736,6 +738,7 @@
<li>To serve as a class identifier so that the bean class can be inferred during parsing if it
cannot automatically be inferred through reflection.
</ol>
+
<h6 class='figure'>Example</h6>
<table class='styled' style='width:auto'>
<tr>
@@ -780,6 +783,7 @@
In the following example, a type attribute is used on property 'b' but not property 'a' since
'b' is of type <code>Object</code> and therefore the bean class cannot be inferred.
</p>
+
<h6 class='figure'>Example</h6>
<table class='styled' style='width:auto'>
<tr>
@@ -841,6 +845,7 @@
<p>
Pay special attention to when <xa>_type</xa> attributes are and are not used.
</p>
+
<h6 class='figure'>Examples</h6>
<table class='styled' style='width:auto'>
<tr>
@@ -1211,6 +1216,7 @@
The {@link org.apache.juneau.xml.annotation.Xml#childName() @Xml.childName()} annotation can be used to
specify the name of XML child elements for bean properties of type collection or array.
</p>
+
<h6 class='figure'>Example</h6>
<table class='styled' style='width:auto'>
<tr>
@@ -1299,17 +1305,15 @@
<p>
The {@link org.apache.juneau.xml.annotation.Xml#format() @Xml.format()} annotation can be used to tweak
the XML format of a POJO.
- <br>
- The value is set to an enum value of type {@link org.apache.juneau.xml.annotation.XmlFormat}.
- <br>
- This annotation can be applied to both classes and bean properties.
+ <br>The value is set to an enum value of type {@link org.apache.juneau.xml.annotation.XmlFormat}.
+ <br>This annotation can be applied to both classes and bean properties.
</p>
<p>
The {@link org.apache.juneau.xml.annotation.XmlFormat#ATTR} format can be applied to bean properties to
serialize them as XML attributes instead of elements.
- <br>
- Note that this only supports properties of simple types (e.g. strings, numbers, booleans).
+ <br>Note that this only supports properties of simple types (e.g. strings, numbers, booleans).
</p>
+
<h6 class='figure'>Example</h6>
<table class='styled' style='width:auto'>
<tr>
@@ -1344,6 +1348,7 @@
The {@link org.apache.juneau.xml.annotation.XmlFormat#ATTRS} format can be applied to bean classes to
force all bean properties to be serialized as XML attributes instead of child elements.
</p>
+
<h6 class='figure'>Example</h6>
<table class='styled' style='width:auto'>
<tr>
@@ -1382,6 +1387,7 @@
to override the {@link org.apache.juneau.xml.annotation.XmlFormat#ATTRS} format applied on the bean
class.
</p>
+
<h6 class='figure'>Example</h6>
<table class='styled' style='width:auto'>
<tr>
@@ -1422,10 +1428,10 @@
The {@link org.apache.juneau.xml.annotation.XmlFormat#ATTRS} format can be applied to a single bean
property of type <code>Map<String,Object></code> to denote arbitrary XML attribute values on the
element.
- <br>
- These can be mixed with other {@link org.apache.juneau.xml.annotation.XmlFormat#ATTR} annotated
+ <br>These can be mixed with other {@link org.apache.juneau.xml.annotation.XmlFormat#ATTR} annotated
properties, but there must not be an overlap in bean property names and map keys.
</p>
+
<h6 class='figure'>Example</h6>
<table class='styled' style='width:auto'>
<tr>
@@ -1469,13 +1475,10 @@
<p>
The {@link org.apache.juneau.xml.annotation.XmlFormat#COLLAPSED} format can be applied to bean properties
of type array/Collection.
- <br>
- This causes the child objects to be serialized directly inside the bean element.
- <br>
- This format must be used in conjunction with {@link org.apache.juneau.xml.annotation.Xml#childName()}
+ <br>This causes the child objects to be serialized directly inside the bean element.
+ <br>This format must be used in conjunction with {@link org.apache.juneau.xml.annotation.Xml#childName()}
to differentiate which collection the values came from if you plan on parsing the output back into beans.
- <br>
- Note that child names must not conflict with other property names.
+ <br>Note that child names must not conflict with other property names.
</p>
<table class='styled' style='width:auto'>
<tr>
@@ -1524,10 +1527,8 @@
<p>
The {@link org.apache.juneau.xml.annotation.XmlFormat#ELEMENTS} format can be applied to a single bean
property of either a simple type or array/Collection.
- <br>
- It allows free-form child elements to be formed.
- <br>
- All other properties on the bean MUST be serialized as attributes.
+ <br>It allows free-form child elements to be formed.
+ <br>All other properties on the bean MUST be serialized as attributes.
</p>
<table class='styled' style='width:auto'>
<tr>
@@ -1593,8 +1594,7 @@
{@link org.apache.juneau.xml.annotation.XmlFormat#ELEMENTS} except elements names on primitive types
(string/number/boolean/null) are stripped from the output.
This format particularly useful when combined with bean dictionaries to produce mixed content.
- <br>
- The bean dictionary isn't used during serialization, but it is needed during parsing to resolve bean
+ <br>The bean dictionary isn't used during serialization, but it is needed during parsing to resolve bean
types.
</p>
<p>
@@ -1940,10 +1940,8 @@
The {@link org.apache.juneau.xml.annotation.XmlFormat#TEXT} format is similar to
{@link org.apache.juneau.xml.annotation.XmlFormat#MIXED} except it's meant for solitary objects that
get serialized as simple child text nodes.
- <br>
- Any object that can be serialize to a <code>String</code> can be used.
- <br>
- The {@link org.apache.juneau.xml.annotation.XmlFormat#TEXT_PWS} is the same except whitespace is
+ <br>Any object that can be serialize to a <code>String</code> can be used.
+ <br>The {@link org.apache.juneau.xml.annotation.XmlFormat#TEXT_PWS} is the same except whitespace is
preserved in the output.
</p>
<table class='styled' style='width:auto'>
@@ -1979,10 +1977,8 @@
The {@link org.apache.juneau.xml.annotation.XmlFormat#XMLTEXT} format is similar to
{@link org.apache.juneau.xml.annotation.XmlFormat#TEXT} except it's meant for strings containing XML
that should be serialized as-is to the document.
- <br>
- Any object that can be serialize to a <code>String</code> can be used.
- <br>
- During parsing, the element content gets parsed with the rest of the document and then re-serialized to
+ <br>Any object that can be serialize to a <code>String</code> can be used.
+ <br>During parsing, the element content gets parsed with the rest of the document and then re-serialized to
XML before being set as the property value.
This process may not be perfect (e.g. double quotes may be replaced by single quotes, etc...).
</p>
@@ -2066,22 +2062,23 @@
</p>
<p>
This isn't too exciting yet since we haven't specified any namespaces yet.
- <br>
- Therefore, everything is defined under the default <code>Juneau</code> namespace.
+ <br>Therefore, everything is defined under the default <code>Juneau</code> namespace.
</p>
<p>
Namespaces can be defined at the following levels:
</p>
<ul class='spaced-list'>
- <li>At the package level by using the {@link org.apache.juneau.xml.annotation.XmlSchema @XmlSchema}
+ <li>
+ At the package level by using the {@link org.apache.juneau.xml.annotation.XmlSchema @XmlSchema}
annotation.
- <li>At the class level by using the {@link org.apache.juneau.xml.annotation.Xml @Xml} annotation.
- <li>At the bean property level by using the {@link org.apache.juneau.xml.annotation.Xml @Xml} annotation.
+ <li>
+ At the class level by using the {@link org.apache.juneau.xml.annotation.Xml @Xml} annotation.
+ <li>
+ At the bean property level by using the {@link org.apache.juneau.xml.annotation.Xml @Xml} annotation.
</ul>
<p>
It's typically best to specify the namespaces used at the package level.
- <br>
- We'll do that here for the package containing our test code.
+ <br>We'll do that here for the package containing our test code.
</p>
<p class='bcode'>
<jc>// XML namespaces used in this package</jc>
@@ -2105,14 +2102,12 @@
Take special note that the <ja>@XmlSchema</ja> is modeled after the equivalent JAXB annotation, but is
defined in the <a class='doclink'
href='annotation/package-summary.html#TOC'>org.apache.juneau.xml.annotation</a> package.
- <br>
- Other XML annotations are also modeled after JAXB.
+ <br>Other XML annotations are also modeled after JAXB.
However, since many of the features of JAXB are already implemented for all serializers and parsers
at a higher level through various general annotations such as {@link org.apache.juneau.annotation.Bean}
and {@link org.apache.juneau.annotation.BeanProperty} it was decided to maintain separate Juneau XML
annotations instead of reusing JAXB annotations.
- <br>
- This may change in some future implementation, but for now it was decided that having separate Juneau XML
+ <br>This may change in some future implementation, but for now it was decided that having separate Juneau XML
annotations was less confusing.
</p>
<p>
@@ -2168,11 +2163,9 @@
<p>
One important property on the XML serializer class is
{@link org.apache.juneau.xml.XmlSerializerContext#XML_autoDetectNamespaces XML_autoDetectNamespaces}.
- <br>
- This property tells the serializer to make a first-pass over the data structure to look for namespaces
+ <br>This property tells the serializer to make a first-pass over the data structure to look for namespaces
defined on classes and bean properties.
- <br>
- In high-performance environments, you may want to consider disabling auto-detection and providing your
+ <br>In high-performance environments, you may want to consider disabling auto-detection and providing your
own explicit list of namespaces to the serializer to avoid this scanning step.
</p>
<p>
@@ -2199,25 +2192,26 @@
<p>
The {@link org.apache.juneau.annotation.Bean @Bean} and {@link org.apache.juneau.annotation.BeanProperty @BeanProperty}
annotations are used to customize the behavior of beans across the entire framework.
- <br>
- In addition to using them to identify the resource URI for the bean shown above, they have various other
+ <br>In addition to using them to identify the resource URI for the bean shown above, they have various other
uses:
</p>
<ul class='spaced-list'>
- <li>Hiding bean properties.
- <li>Specifying the ordering of bean properties.
- <li>Overriding the names of bean properties.
- <li>Associating transforms at both the class and property level (to convert non-serializable POJOs to
+ <li>
+ Hiding bean properties.
+ <li>
+ Specifying the ordering of bean properties.
+ <li>
+ Overriding the names of bean properties.
+ <li>
+ Associating transforms at both the class and property level (to convert non-serializable POJOs to
serializable forms).
</ul>
<p>
For example, we now add a <code>birthDate</code> property, and associate a transform with it to transform
it to an ISO8601 date-time string in GMT time.
- <br>
- By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you want
+ <br>By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you want
them serialized.
- <br>
- Using transforms, we can convert them to standardized string forms.
+ <br>Using transforms, we can convert them to standardized string forms.
</p>
<p class='bcode'>
<ja>@Xml</ja>(prefix=<js>"per"</js>)
@@ -2264,10 +2258,10 @@
<p>
Another useful feature is the {@link org.apache.juneau.annotation.Bean#propertyNamer()} annotation that
allows you to plug in your own logic for determining bean property names.
- <br>
- The {@link org.apache.juneau.PropertyNamerDLC} is an example of an alternate property namer.
+ <br>The {@link org.apache.juneau.PropertyNamerDLC} is an example of an alternate property namer.
It converts bean property names to lowercase-dashed format.
</p>
+
<h6 class='figure'>Example</h6>
<p class='bcode'>
<ja>@Xml</ja>(prefix=<js>"per"</js>)
@@ -2275,6 +2269,7 @@
<jk>public class</jk> Person {
...
</p>
+
<h6 class='figure'>Results</h6>
<p class='bcode'>
<xt><per:person</xt>
@@ -2380,30 +2375,23 @@
<p>
Juneau provides the {@link org.apache.juneau.xml.XmlSchemaSerializer} class for generating XML-Schema
documents that describe the output generated by the {@link org.apache.juneau.xml.XmlSerializer} class.
- <br>
- This class shares the same properties as <code>XmlSerializer</code>.
- <br>
- Since the XML output differs based on settings on the XML serializer class, the XML-Schema serializer
+ <br>This class shares the same properties as <code>XmlSerializer</code>.
+ <br>Since the XML output differs based on settings on the XML serializer class, the XML-Schema serializer
class must have the same property values as the XML serializer class it's describes.
- <br>
- To help facilitate creating an XML Schema serializer with the same properties as the corresponding
+ <br>To help facilitate creating an XML Schema serializer with the same properties as the corresponding
XML serializer, the {@link org.apache.juneau.xml.XmlSerializer#getSchemaSerializer()} method
has been added.
</p>
<p>
XML-Schema requires a separate file for each namespace.
- <br>
- Unfortunately, does not mesh well with the Juneau serializer architecture which serializes to single writers.
- <br>
- To get around this limitation, the schema serializer will produce a single output, but with multiple
+ <br>Unfortunately, does not mesh well with the Juneau serializer architecture which serializes to single writers.
+ <br>To get around this limitation, the schema serializer will produce a single output, but with multiple
schema documents separated by the null character (<js>'\u0000'</js>) to make it simple to split apart.
</p>
<p>
Lets start with an example where everything is in the same namespace.
- <br>
- We'll use the classes from before, but remove the references to namespaces.
- <br>
- Since we have not defined a default namespace, everything is defined under the default Juneau namespace.
+ <br>We'll use the classes from before, but remove the references to namespaces.
+ <br>Since we have not defined a default namespace, everything is defined under the default Juneau namespace.
</p>
<p class='bcode'>
<ja>@Bean</ja>(typeName=<js>"person"</js>)
@@ -2477,6 +2465,7 @@
<jc>// Get the XML Schema corresponding to the XML generated above.</jc>
String xmlSchema = ss.serialize(p);
</p>
+
<h6 class='figure'>XML results</h6>
<p class='bcode'>
<xt><person</xt>
@@ -2499,6 +2488,7 @@
<xt></addresses></xt>
<xt></person></xt>
</p>
+
<h6 class='figure'>XML-Schema results</h6>
<p class='bcode'>
<xt><schema</xt>
@@ -2563,6 +2553,7 @@
...
}
</p>
+
<h6 class='figure'>XML results</h6>
<p class='bcode'>
<xt><per:person</xt>
@@ -2591,6 +2582,7 @@
<p>
The schema consists of 4 documents separated by a <js>'\u0000'</js> character.
</p>
+
<h6 class='figure'>XML-Schema results</h6>
<p class='bcode'>
<xt><schema</xt>
@@ -2719,18 +2711,16 @@
<h3 class='topic' onclick='toggle(this)'>2.7 - Non-tree models and recursion detection</h3>
<div class='topic'>
<p>
- The XML serializer is designed to be used against POJO tree structures. <br>
- It expects that there not be loops in the POJO model (e.g. children with references to parents, etc...).
- <br>
- If you try to serialize models with loops, you will usually cause a <code>StackOverflowError</code> to
+ The XML serializer is designed to be used against POJO tree structures.
+ <br>It expects that there not be loops in the POJO model (e.g. children with references to parents, etc...).
+ <br>If you try to serialize models with loops, you will usually cause a <code>StackOverflowError</code> to
be thrown (if {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_maxDepth} is not reached
first).
</p>
<p>
If you still want to use the XML serializer on such models, Juneau provides the
{@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_detectRecursions} setting.
- <br>
- It tells the serializer to look for instances of an object in the current branch of the tree and skip
+ <br>It tells the serializer to look for instances of an object in the current branch of the tree and skip
serialization when a duplicate is encountered.
</p>
<p>
@@ -2786,8 +2776,7 @@
</p>
<p>
Recursion detection introduces a performance penalty of around 20%.
- <br>
- For this reason the setting is disabled by default.
+ <br>For this reason the setting is disabled by default.
</p>
</div>
@@ -2811,10 +2800,10 @@
<h3 class='topic' onclick='toggle(this)'>2.9 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau serializers, the XML serializer is thread safe and maintains an internal cache of
+ <li>
+ Like all other Juneau serializers, the XML serializer is thread safe and maintains an internal cache of
bean classes encountered.
- <br>
- For performance reasons, it's recommended that serializers be reused whenever possible instead of
+ <br>For performance reasons, it's recommended that serializers be reused whenever possible instead of
always creating new instances.
</ul>
</div>
@@ -2837,8 +2826,7 @@
</ul>
<p>
Let's build upon the previous example and parse the generated XML back into the original bean.
- <br>
- We start with the XML that was generated.
+ <br>We start with the XML that was generated.
</p>
<p class='bcode'>
<jc>// Create a new serializer with readable output.</jc>
@@ -2930,16 +2918,14 @@
<div class='topic'>
<p>
The XML parser is not limited to parsing back into the original bean classes.
- <br>
- If the bean classes are not available on the parsing side, the parser can also be used to parse into a
+ <br>If the bean classes are not available on the parsing side, the parser can also be used to parse into a
generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive objects.
</p>
<p>
You can parse into any <code>Map</code> type (e.g. <code>HashMap</code>, <code>TreeMap</code>), but
using {@link org.apache.juneau.ObjectMap} is recommended since it has many convenience methods
for converting values to various types.
- <br>
- The same is true when parsing collections. You can use any Collection (e.g. <code>HashSet</code>,
+ <br>The same is true when parsing collections. You can use any Collection (e.g. <code>HashSet</code>,
<code>LinkedList</code>) or array (e.g. <code>Object[]</code>, <code>String[]</code>,
<code>String[][]</code>), but using {@link org.apache.juneau.ObjectList} is recommended.
</p>
@@ -2970,10 +2956,10 @@
<h3 class='topic' onclick='toggle(this)'>3.3 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau parsers, the XML parser is thread safe and maintains an internal cache of bean
+ <li>
+ Like all other Juneau parsers, the XML parser is thread safe and maintains an internal cache of bean
classes encountered.
- <br>
- For performance reasons, it's recommended that parser be reused whenever possible instead of always
+ <br>For performance reasons, it's recommended that parser be reused whenever possible instead of always
creating new instances.
</ul>
</div>
[07/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallException.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallException.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallException.java
index 097a6cf..b0a01d9 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallException.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallException.java
@@ -87,7 +87,7 @@ public final class RestCallException extends IOException {
* @param responseMsg The response message.
* @param method The HTTP method (for message purposes).
* @param url The HTTP URL (for message purposes).
- * @param response The reponse from the server.
+ * @param response The response from the server.
*/
public RestCallException(int responseCode, String responseMsg, String method, URI url, String response) {
super(format("HTTP method '%s' call to '%s' caused response code '%s,%s'.%nResponse: %n%s%n", method, url, responseCode, responseMsg, response));
@@ -100,7 +100,8 @@ public final class RestCallException extends IOException {
* Sets the server-side exception details.
*
* @param exceptionName The <code>Exception-Name:</code> header specifying the full name of the exception.
- * @param exceptionMessage The <code>Exception-Message:</code> header specifying the message returned by {@link Throwable#getMessage()}.
+ * @param exceptionMessage
+ * The <code>Exception-Message:</code> header specifying the message returned by {@link Throwable#getMessage()}.
* @param exceptionTrace The stack trace of the exception returned by {@link Throwable#printStackTrace()}.
* @return This object (for method chaining).
*/
@@ -116,6 +117,7 @@ public final class RestCallException extends IOException {
/**
* Tries to reconstruct and re-throw the server-side exception.
+ *
* <p>
* The exception is based on the following HTTP response headers:
* <ul>
@@ -123,8 +125,10 @@ public final class RestCallException extends IOException {
* <li><code>Exception-Message:</code> - The message returned by {@link Throwable#getMessage()}.
* <li><code>Exception-Trace:</code> - The stack trace of the exception returned by {@link Throwable#printStackTrace()}.
* </ul>
+ *
* <p>
* Does nothing if the server-side exception could not be reconstructed.
+ *
* <p>
* Currently only supports <code>Throwables</code> with either a public no-arg constructor
* or a public constructor that takes in a simple string message.
@@ -154,7 +158,7 @@ public final class RestCallException extends IOException {
/**
* Sets the HTTP response object that caused this exception.
*
- * @param httpResponse The HTTP respose object.
+ * @param httpResponse The HTTP response object.
* @return This object (for method chaining).
*/
protected RestCallException setHttpResponse(HttpResponse httpResponse) {
@@ -165,7 +169,9 @@ public final class RestCallException extends IOException {
/**
* Returns the HTTP response object that caused this exception.
*
- * @return The HTTP response object that caused this exception, or <jk>null</jk> if no response was created yet when the exception was thrown.
+ * @return
+ * The HTTP response object that caused this exception, or <jk>null</jk> if no response was created yet when the
+ * exception was thrown.
*/
public HttpResponse getHttpResponse() {
return this.httpResponse;
@@ -200,6 +206,7 @@ public final class RestCallException extends IOException {
/**
* Sets the inner cause for this exception.
+ *
* @param cause The inner cause.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallInterceptor.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallInterceptor.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallInterceptor.java
index ddaf90a..54f36b2 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallInterceptor.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallInterceptor.java
@@ -15,8 +15,9 @@ package org.apache.juneau.rest.client;
import org.apache.http.*;
/**
- * Used to intercept http connection responses to allow modification of that response before processing
- * and for listening for call lifecycle events.
+ * Used to intercept http connection responses to allow modification of that response before processing and for
+ * listening for call lifecycle events.
+ *
* <p>
* Useful if you want to prevent {@link RestCallException RestCallExceptions} from being thrown on error conditions.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java
index a1621ac..4e2adb8 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java
@@ -22,19 +22,21 @@ import org.apache.http.client.methods.*;
import org.apache.http.util.*;
/**
- * Specialized interceptor for logging calls to a log file.
+ * Specialized intercepter for logging calls to a log file.
+ *
* <p>
- * Causes a log entry to be created that shows all the request and response headers and content
- * at the end of the request.
+ * Causes a log entry to be created that shows all the request and response headers and content at the end of the
+ * request.
+ *
* <p>
- * Use the {@link RestClientBuilder#logTo(Level, Logger)} and {@link RestCall#logTo(Level, Logger)}
- * <p>
- * methods to create instances of this class.
+ * Use the {@link RestClientBuilder#logTo(Level, Logger)} and {@link RestCall#logTo(Level, Logger)} methods to create
+ * instances of this class.
*/
public class RestCallLogger extends RestCallInterceptor {
/**
* Default HTTP request logger.
+ * <p>
* Logs outgoing HTTP requests to the <code>org.apache.juneau.rest.client</code> logger at <jsf>WARNING</jsf> level.
*/
public static final RestCallLogger DEFAULT = new RestCallLogger(Level.WARNING, Logger.getLogger("org.apache.juneau.rest.client"));
@@ -68,9 +70,9 @@ public class RestCallLogger extends RestCallInterceptor {
public void onRetry(RestCall restCall, int statusCode, HttpRequest req, HttpResponse res, Exception ex) {
if (log.isLoggable(level)) {
if (ex == null)
- log.log(level, format("Call to {0} returned {1}. Will retry.", req.getRequestLine().getUri(), statusCode)); //$NON-NLS-1$
+ log.log(level, format("Call to {0} returned {1}. Will retry.", req.getRequestLine().getUri(), statusCode));
else
- log.log(level, format("Call to {0} caused exception {1}. Will retry.", req.getRequestLine().getUri(), ex.getLocalizedMessage()), ex); //$NON-NLS-1$
+ log.log(level, format("Call to {0} caused exception {1}. Will retry.", req.getRequestLine().getUri(), ex.getLocalizedMessage()), ex);
}
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
index 5f8d1e9..72f0f0f 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
@@ -42,16 +42,23 @@ import org.apache.juneau.urlencoding.*;
*
* <h6 class='topic'>Features</h6>
* <ul class='spaced-list'>
- * <li>Convert POJOs directly to HTTP request message bodies using {@link Serializer} class.
- * <li>Convert HTTP response message bodies directly to POJOs using {@link Parser} class.
- * <li>Fluent interface.
- * <li>Thread safe.
- * <li>API for interacting with remoteable services.
+ * <li>
+ * Convert POJOs directly to HTTP request message bodies using {@link Serializer} class.
+ * <li>
+ * Convert HTTP response message bodies directly to POJOs using {@link Parser} class.
+ * <li>
+ * Fluent interface.
+ * <li>
+ * Thread safe.
+ * <li>
+ * API for interacting with remoteable services.
* </ul>
*
* <h5 class='section'>Additional information:</h5>
* <ul>
- * <li><a class="doclink" href="package-summary.html#RestClient">org.apache.juneau.rest.client > REST client API</a> for more information and code examples.
+ * <li>
+ * <a class="doclink" href="package-summary.html#RestClient">org.apache.juneau.rest.client > REST client API</a>
+ * for more information and code examples.
* </ul>
*/
@SuppressWarnings("rawtypes")
@@ -76,7 +83,7 @@ public class RestClient extends CoreObject {
final int retries;
final long retryInterval;
final boolean debug;
- final RestCallInterceptor[] interceptors;
+ final RestCallInterceptor[] intercepters;
// This is lazy-created.
private volatile ExecutorService executorService;
@@ -92,7 +99,7 @@ public class RestClient extends CoreObject {
UrlEncodingSerializer urlEncodingSerializer,
PartSerializer partSerializer,
Map<String,String> headers,
- List<RestCallInterceptor> interceptors,
+ List<RestCallInterceptor> intercepters,
String rootUri,
RetryOn retryOn,
int retries,
@@ -117,11 +124,11 @@ public class RestClient extends CoreObject {
this.retryInterval = retryInterval;
this.debug = debug;
- List<RestCallInterceptor> l = new ArrayList<RestCallInterceptor>(interceptors);
+ List<RestCallInterceptor> l = new ArrayList<RestCallInterceptor>(intercepters);
if (debug)
l.add(RestCallLogger.DEFAULT);
- this.interceptors = l.toArray(new RestCallInterceptor[l.size()]);
+ this.intercepters = l.toArray(new RestCallInterceptor[l.size()]);
if (Boolean.getBoolean("org.apache.juneau.rest.client.RestClient.trackLifecycle"))
creationStack = Thread.currentThread().getStackTrace();
@@ -134,6 +141,8 @@ public class RestClient extends CoreObject {
/**
* Calls {@link CloseableHttpClient#close()} on the underlying {@link CloseableHttpClient}.
+ *
+ * <p>
* It's good practice to call this method after the client is no longer used.
*
* @throws IOException
@@ -165,6 +174,8 @@ public class RestClient extends CoreObject {
/**
* Execute the specified request.
+ *
+ * <p>
* Subclasses can override this method to provide specialized handling.
*
* @param req The HTTP request.
@@ -178,9 +189,12 @@ public class RestClient extends CoreObject {
/**
* Perform a <code>GET</code> request against the specified URL.
*
- * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.
- * @return A {@link RestCall} object that can be further tailored before executing the request
- * and getting the response as a parsed object.
+ * @param url
+ * The URL of the remote REST resource.
+ * Can be any of the following: {@link String}, {@link URI}, {@link URL}.
+ * @return
+ * A {@link RestCall} object that can be further tailored before executing the request and getting the response
+ * as a parsed object.
* @throws RestCallException If any authentication errors occurred.
*/
public RestCall doGet(Object url) throws RestCallException {
@@ -190,16 +204,25 @@ public class RestClient extends CoreObject {
/**
* Perform a <code>PUT</code> request against the specified URL.
*
- * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.
- * @param o The object to serialize and transmit to the URL as the body of the request.
- * Can be of the following types:
- * <ul class='spaced-list'>
- * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.
- * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.
- * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.
- * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
- * </ul>
- * @return A {@link RestCall} object that can be further tailored before executing the request
+ * @param url
+ * The URL of the remote REST resource.
+ * Can be any of the following: {@link String}, {@link URI}, {@link URL}.
+ * @param o
+ * The object to serialize and transmit to the URL as the body of the request.
+ * Can be of the following types:
+ * <ul class='spaced-list'>
+ * <li>
+ * {@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.
+ * <li>
+ * {@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.
+ * <li>
+ * {@link Object} - POJO to be converted to text using the {@link Serializer} registered with the
+ * {@link RestClient}.
+ * <li>
+ * {@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
+ * </ul>
+ * @return
+ * A {@link RestCall} object that can be further tailored before executing the request
* and getting the response as a parsed object.
* @throws RestCallException If any authentication errors occurred.
*/
@@ -209,13 +232,17 @@ public class RestClient extends CoreObject {
/**
* Same as {@link #doPut(Object, Object)} but don't specify the input yet.
+ *
* <p>
* You must call either {@link RestCall#input(Object)} or {@link RestCall#formData(String, Object)}
* to set the contents on the result object.
*
- * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.
- * @return A {@link RestCall} object that can be further tailored before executing the request
- * and getting the response as a parsed object.
+ * @param url
+ * The URL of the remote REST resource.
+ * Can be any of the following: {@link String}, {@link URI}, {@link URL}.
+ * @return
+ * A {@link RestCall} object that can be further tailored before executing the request and getting the response
+ * as a parsed object.
* @throws RestCallException
*/
public RestCall doPut(Object url) throws RestCallException {
@@ -225,17 +252,25 @@ public class RestClient extends CoreObject {
/**
* Perform a <code>POST</code> request against the specified URL.
*
- * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.
- * @param o The object to serialize and transmit to the URL as the body of the request.
- * Can be of the following types:
- * <ul class='spaced-list'>
- * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.
- * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.
- * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.
- * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
- * </ul>
- * @return A {@link RestCall} object that can be further tailored before executing the request
- * and getting the response as a parsed object.
+ * @param url
+ * The URL of the remote REST resource.
+ * Can be any of the following: {@link String}, {@link URI}, {@link URL}.
+ * @param o
+ * The object to serialize and transmit to the URL as the body of the request.
+ * Can be of the following types:
+ * <ul class='spaced-list'>
+ * <li>
+ * {@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.
+ * <li>
+ * {@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.
+ * <li>
+ * {@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.
+ * <li>
+ * {@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
+ * </ul>
+ * @return
+ * A {@link RestCall} object that can be further tailored before executing the request and getting the response
+ * as a parsed object.
* @throws RestCallException If any authentication errors occurred.
*/
public RestCall doPost(Object url, Object o) throws RestCallException {
@@ -244,13 +279,17 @@ public class RestClient extends CoreObject {
/**
* Same as {@link #doPost(Object, Object)} but don't specify the input yet.
+ *
* <p>
- * You must call either {@link RestCall#input(Object)} or {@link RestCall#formData(String, Object)}
- * to set the contents on the result object.
+ * You must call either {@link RestCall#input(Object)} or {@link RestCall#formData(String, Object)} to set the
+ * contents on the result object.
*
- * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.
- * @return A {@link RestCall} object that can be further tailored before executing the request
- * and getting the response as a parsed object.
+ * @param url
+ * The URL of the remote REST resource.
+ * Can be any of the following: {@link String}, {@link URI}, {@link URL}.
+ * @return
+ * A {@link RestCall} object that can be further tailored before executing the request and getting the response
+ * as a parsed object.
* @throws RestCallException
*/
public RestCall doPost(Object url) throws RestCallException {
@@ -260,9 +299,12 @@ public class RestClient extends CoreObject {
/**
* Perform a <code>DELETE</code> request against the specified URL.
*
- * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.
- * @return A {@link RestCall} object that can be further tailored before executing the request
- * and getting the response as a parsed object.
+ * @param url
+ * The URL of the remote REST resource.
+ * Can be any of the following: {@link String}, {@link URI}, {@link URL}.
+ * @return
+ * A {@link RestCall} object that can be further tailored before executing the request and getting the response
+ * as a parsed object.
* @throws RestCallException If any authentication errors occurred.
*/
public RestCall doDelete(Object url) throws RestCallException {
@@ -272,9 +314,12 @@ public class RestClient extends CoreObject {
/**
* Perform an <code>OPTIONS</code> request against the specified URL.
*
- * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.
- * @return A {@link RestCall} object that can be further tailored before executing the request
- * and getting the response as a parsed object.
+ * @param url
+ * The URL of the remote REST resource.
+ * Can be any of the following: {@link String}, {@link URI}, {@link URL}.
+ * @return
+ * A {@link RestCall} object that can be further tailored before executing the request and getting the response
+ * as a parsed object.
* @throws RestCallException If any authentication errors occurred.
*/
public RestCall doOptions(Object url) throws RestCallException {
@@ -282,13 +327,18 @@ public class RestClient extends CoreObject {
}
/**
- * Perform a <code>POST</code> request with a content type of <code>application/x-www-form-urlencoded</code> against the specified URL.
+ * Perform a <code>POST</code> request with a content type of <code>application/x-www-form-urlencoded</code>
+ * against the specified URL.
*
- * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.
- * @param o The object to serialize and transmit to the URL as the body of the request, serialized as a form post
+ * @param url
+ * The URL of the remote REST resource.
+ * Can be any of the following: {@link String}, {@link URI}, {@link URL}.
+ * @param o
+ * The object to serialize and transmit to the URL as the body of the request, serialized as a form post
* using the {@link UrlEncodingSerializer#DEFAULT} serializer.
- * @return A {@link RestCall} object that can be further tailored before executing the request
- * and getting the response as a parsed object.
+ * @return
+ * A {@link RestCall} object that can be further tailored before executing the request and getting the response
+ * as a parsed object.
* @throws RestCallException If any authentication errors occurred.
*/
public RestCall doFormPost(Object url, Object o) throws RestCallException {
@@ -298,22 +348,28 @@ public class RestClient extends CoreObject {
/**
* Performs a REST call where the entire call is specified in a simple string.
+ *
* <p>
* This method is useful for performing callbacks when the target of a callback is passed in
* on an initial request, for example to signal when a long-running process has completed.
+ *
* <p>
* The call string can be any of the following formats:
* <ul class='spaced-list'>
- * <li><js>"[method] [url]"</js> - e.g. <js>"GET http://localhost/callback"</js>
- * <li><js>"[method] [url] [payload]"</js> - e.g. <js>"POST http://localhost/callback some text payload"</js>
- * <li><js>"[method] [headers] [url] [payload]"</js> - e.g. <js>"POST {'Content-Type':'text/json'} http://localhost/callback {'some':'json'}"</js>
+ * <li>
+ * <js>"[method] [url]"</js> - e.g. <js>"GET http://localhost/callback"</js>
+ * <li>
+ * <js>"[method] [url] [payload]"</js> - e.g. <js>"POST http://localhost/callback some text payload"</js>
+ * <li>
+ * <js>"[method] [headers] [url] [payload]"</js> - e.g. <js>"POST {'Content-Type':'text/json'} http://localhost/callback {'some':'json'}"</js>
* </ul>
* <p>
* The payload will always be sent using a simple {@link StringEntity}.
*
* @param callString The call string.
- * @return A {@link RestCall} object that can be further tailored before executing the request
- * and getting the response as a parsed object.
+ * @return
+ * A {@link RestCall} object that can be further tailored before executing the request and getting the response
+ * as a parsed object.
* @throws RestCallException
*/
public RestCall doCallback(String callString) throws RestCallException {
@@ -367,19 +423,29 @@ public class RestClient extends CoreObject {
* Perform a generic REST call.
*
* @param method The HTTP method.
- * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.
- * @param content The HTTP body content.
- * Can be of the following types:
- * <ul class='spaced-list'>
- * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.
- * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.
- * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.
- * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
- * <li>{@link NameValuePairs} - Converted to a URL-encoded FORM post.
- * </ul>
- * This parameter is IGNORED if {@link HttpMethod#hasContent()} is <jk>false</jk>.
- * @return A {@link RestCall} object that can be further tailored before executing the request
- * and getting the response as a parsed object.
+ * @param url
+ * The URL of the remote REST resource.
+ * Can be any of the following: {@link String}, {@link URI}, {@link URL}.
+ * @param content
+ * The HTTP body content.
+ * Can be of the following types:
+ * <ul class='spaced-list'>
+ * <li>
+ * {@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.
+ * <li>
+ * {@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.
+ * <li>
+ * {@link Object} - POJO to be converted to text using the {@link Serializer} registered with the
+ * {@link RestClient}.
+ * <li>
+ * {@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
+ * <li>
+ * {@link NameValuePairs} - Converted to a URL-encoded FORM post.
+ * </ul>
+ * This parameter is IGNORED if {@link HttpMethod#hasContent()} is <jk>false</jk>.
+ * @return
+ * A {@link RestCall} object that can be further tailored before executing the request and getting the response
+ * as a parsed object.
* @throws RestCallException If any authentication errors occurred.
*/
public RestCall doCall(HttpMethod method, Object url, Object content) throws RestCallException {
@@ -393,10 +459,13 @@ public class RestClient extends CoreObject {
* Perform a generic REST call.
*
* @param method The method name (e.g. <js>"GET"</js>, <js>"OPTIONS"</js>).
- * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.
+ * @param url
+ * The URL of the remote REST resource.
+ * Can be any of the following: {@link String}, {@link URI}, {@link URL}.
* @param hasContent Boolean flag indicating if the specified request has content associated with it.
- * @return A {@link RestCall} object that can be further tailored before executing the request
- * and getting the response as a parsed object.
+ * @return
+ * A {@link RestCall} object that can be further tailored before executing the request and getting the response
+ * as a parsed object.
* @throws RestCallException If any authentication errors occurred.
*/
public RestCall doCall(String method, Object url, boolean hasContent) throws RestCallException {
@@ -445,6 +514,7 @@ public class RestClient extends CoreObject {
/**
* Create a new proxy interface against a REST interface.
+ *
* <p>
* The URL to the REST interface is based on the following values:
* <ul>
@@ -452,6 +522,7 @@ public class RestClient extends CoreObject {
* <li>The {@link RestClientBuilder#rootUrl(Object) rootUrl} on the client (<code>root-url</code>).
* <li>The fully-qualified class name of the interface (<code>class-name</code>).
* </ul>
+ *
* <p>
* The URL calculation is as follows:
* <ul>
@@ -459,8 +530,10 @@ public class RestClient extends CoreObject {
* <li><code>root-url/remoteable-path</code> - If remoteable path is relative and root-url has been specified.
* <li><code>root-url/class-name</code> - If remoteable path is not specified.
* </ul>
+ *
* <p>
* If the information is not available to resolve to an absolute URL, a {@link RemoteableMetadataException} is thrown.
+ *
* <p>
* Examples:
* <p class='bcode'>
@@ -491,11 +564,14 @@ public class RestClient extends CoreObject {
* .build()
* .getRemoteableProxy(MyInterface3.<jk>class</jk>);
* </p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>If you plan on using your proxy in a multi-threaded environment, you'll want to use an underlying
- * pooling client connection manager. The easiest way to do this is to use the {@link RestClientBuilder#pooled()}
- * method. If you don't do this, you may end up seeing "Connection still allocated" exceptions.
+ * <li>
+ * If you plan on using your proxy in a multi-threaded environment, you'll want to use an underlying
+ * pooling client connection manager.
+ * The easiest way to do this is to use the {@link RestClientBuilder#pooled()} method.
+ * If you don't do this, you may end up seeing "Connection still allocated" exceptions.
* </ul>
*
* @param interfaceClass The interface to create a proxy for.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
index 529a068..66a0f65 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
@@ -69,7 +69,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
private Map<String,String> headers = new TreeMap<String,String>(String.CASE_INSENSITIVE_ORDER);
- private List<RestCallInterceptor> interceptors = new ArrayList<RestCallInterceptor>();
+ private List<RestCallInterceptor> intercepters = new ArrayList<RestCallInterceptor>();
private String rootUrl;
private SSLOpts sslOpts;
@@ -90,6 +90,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Constructor, default settings.
+ *
* <p>
* Shortcut for calling <code><jk>new</jk> RestClientBuilder().serializer(s).parser(p);</code>
*
@@ -104,6 +105,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Constructor, default settings.
+ *
* <p>
* Shortcut for calling <code><jk>new</jk> RestClientBuilder().serializer(s).parser(p);</code>
*
@@ -118,6 +120,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public RestClientBuilder(PropertyStore propertyStore) {
@@ -153,7 +156,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
pf = partSerializerClass.newInstance();
}
- return new RestClient(propertyStore, httpClient, keepHttpClientOpen, s, p, us, pf, headers, interceptors, rootUrl, retryOn, retries, retryInterval, debug, executorService, executorServiceShutdownOnClose);
+ return new RestClient(propertyStore, httpClient, keepHttpClientOpen, s, p, us, pf, headers, intercepters, rootUrl, retryOn, retries, retryInterval, debug, executorService, executorServiceShutdownOnClose);
} catch (Exception e) {
throw new RuntimeException(e);
}
@@ -161,15 +164,18 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Creates an instance of an {@link HttpClient} to be used to handle all HTTP communications with the target server.
+ *
* <p>
* This HTTP client is used when the HTTP client is not specified through one of the constructors or the
- * {@link #httpClient(CloseableHttpClient, boolean)} method.
+ * {@link #httpClient(CloseableHttpClient, boolean)} method.
+ *
* <p>
- * Subclasses can override this method to provide specially-configured HTTP clients to handle
- * stuff such as SSL/TLS certificate handling, authentication, etc.
+ * Subclasses can override this method to provide specially-configured HTTP clients to handle stuff such as
+ * SSL/TLS certificate handling, authentication, etc.
+ *
* <p>
- * The default implementation returns an instance of {@link HttpClient} using the client builder
- * returned by {@link #createHttpClientBuilder()}.
+ * The default implementation returns an instance of {@link HttpClient} using the client builder returned by
+ * {@link #createHttpClientBuilder()}.
*
* @return The HTTP client to use.
* @throws Exception
@@ -182,10 +188,11 @@ public class RestClientBuilder extends CoreObjectBuilder {
}
/**
- * Creates an instance of an {@link HttpClientBuilder} to be used to create
- * the {@link HttpClient}.
+ * Creates an instance of an {@link HttpClientBuilder} to be used to create the {@link HttpClient}.
+ *
* <p>
* Subclasses can override this method to provide their own client builder.
+ *
* <p>
* The predefined method returns an {@link HttpClientBuilder} with the following settings:
* <ul>
@@ -203,8 +210,10 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Creates the {@link HttpClientConnectionManager} returned by {@link #createConnectionManager()}.
+ *
* <p>
* Subclasses can override this method to provide their own connection manager.
+ *
* <p>
* The default implementation returns an instance of a {@link PoolingHttpClientConnectionManager}.
*
@@ -245,13 +254,16 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Set a root URL for this client.
+ *
* <p>
* When set, URL strings passed in through the various rest call methods (e.g. {@link RestClient#doGet(Object)}
- * will be prefixed with the specified root.
+ * will be prefixed with the specified root.
* This root URL is ignored on those methods if you pass in a {@link URL}, {@link URI}, or an absolute URL string.
*
- * @param rootUrl The root URL to prefix to relative URL strings. Trailing slashes are trimmed.
- * Usually a <code>String</code> but you can also pass in <code>URI</code> and <code>URL</code> objects as well.
+ * @param rootUrl
+ * The root URL to prefix to relative URL strings.
+ * Trailing slashes are trimmed.
+ * Usually a <code>String</code> but you can also pass in <code>URI</code> and <code>URL</code> objects as well.
* @return This object (for method chaining).
*/
public RestClientBuilder rootUrl(Object rootUrl) {
@@ -265,8 +277,10 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Enable SSL support on this client.
*
- * @param opts The SSL configuration options. See {@link SSLOpts} for details.
- * This method is a no-op if <code>sslConfig</code> is <jk>null</jk>.
+ * @param opts
+ * The SSL configuration options.
+ * See {@link SSLOpts} for details.
+ * This method is a no-op if <code>sslConfig</code> is <jk>null</jk>.
* @return This object (for method chaining).
* @throws KeyStoreException
* @throws NoSuchAlgorithmException
@@ -278,6 +292,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Enable LAX SSL support.
+ *
* <p>
* Certificate chain validation and hostname verification is disabled.
*
@@ -300,25 +315,25 @@ public class RestClientBuilder extends CoreObjectBuilder {
}
/**
- * Adds an interceptor that gets called immediately after a connection is made.
+ * Adds an intercepter that gets called immediately after a connection is made.
*
- * @param interceptor The interceptor.
+ * @param intercepter The intercepter.
* @return This object (for method chaining).
*/
- public RestClientBuilder interceptor(RestCallInterceptor interceptor) {
- interceptors.add(interceptor);
+ public RestClientBuilder intercepter(RestCallInterceptor intercepter) {
+ intercepters.add(intercepter);
return this;
}
/**
- * Adds a {@link RestCallLogger} to the list of interceptors on this class.
+ * Adds a {@link RestCallLogger} to the list of intercepters on this class.
*
- * @param level The log level to log messsages at.
+ * @param level The log level to log messages at.
* @param log The logger to log messages to.
* @return This object (for method chaining).
*/
public RestClientBuilder logTo(Level level, Logger log) {
- interceptor(new RestCallLogger(level, log));
+ intercepter(new RestCallLogger(level, log));
return this;
}
@@ -327,8 +342,9 @@ public class RestClientBuilder extends CoreObjectBuilder {
*
* @param retries The number of retries to attempt.
* @param interval The time in milliseconds between attempts.
- * @param retryOn Optional object used for determining whether a retry should be attempted.
- * If <jk>null</jk>, uses {@link RetryOn#DEFAULT}.
+ * @param retryOn
+ * Optional object used for determining whether a retry should be attempted.
+ * If <jk>null</jk>, uses {@link RetryOn#DEFAULT}.
* @return This object (for method chaining).
*/
public RestClientBuilder retryable(int retries, long interval, RetryOn retryOn) {
@@ -340,7 +356,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* When called, the {@link #createConnectionManager()} method will return a {@link PoolingHttpClientConnectionManager}
- * instead of a {@link BasicHttpClientConnectionManager}.
+ * instead of a {@link BasicHttpClientConnectionManager}.
*
* @return This object (for method chaining).
*/
@@ -361,8 +377,8 @@ public class RestClientBuilder extends CoreObjectBuilder {
}
/**
- * Same as {@link #serializer(Serializer)}, except takes in a serializer class that
- * will be instantiated through a no-arg constructor.
+ * Same as {@link #serializer(Serializer)}, except takes in a serializer class that will be instantiated through a
+ * no-arg constructor.
*
* @param serializerClass The serializer class.
* @return This object (for method chaining).
@@ -384,8 +400,8 @@ public class RestClientBuilder extends CoreObjectBuilder {
}
/**
- * Same as {@link #parser(Parser)}, except takes in a parser class that
- * will be instantiated through a no-arg constructor.
+ * Same as {@link #parser(Parser)}, except takes in a parser class that will be instantiated through a no-arg
+ * constructor.
*
* @param parserClass The parser class.
* @return This object (for method chaining).
@@ -411,7 +427,8 @@ public class RestClientBuilder extends CoreObjectBuilder {
* Sets the part formatter to use for converting POJOs to headers, query parameters, form-data parameters, and
* path variables.
*
- * @param partSerializerClass The part serializer class.
+ * @param partSerializerClass
+ * The part serializer class.
* The class must have a no-arg constructor.
* @return This object (for method chaining).
*/
@@ -453,6 +470,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Defines the executor service to use when calling future methods on the {@link RestCall} class.
+ *
* <p>
* This executor service is used to create {@link Future} objects on the following methods:
* <ul>
@@ -461,6 +479,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
* <li>{@link RestCall#getResponseFuture(Type,Type...)}
* <li>{@link RestCall#getResponseAsString()}
* </ul>
+ *
* <p>
* The default executor service is a single-threaded {@link ThreadPoolExecutor} with a 30 second timeout
* and a queue size of 10.
@@ -494,8 +513,10 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Accept</code> request header.
+ *
* <p>
- * This overrides the media type specified on the parser, but is overridden by calling <code>header(<js>"Accept"</js>, value);</code>
+ * This overrides the media type specified on the parser, but is overridden by calling
+ * <code>header(<js>"Accept"</js>, value);</code>
*
* @param value The new header value.
* @return This object (for method chaining).
@@ -506,6 +527,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Accept-Charset</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Accept-Charset"</js>, value);</code>
*
@@ -518,6 +540,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Accept-Encoding</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Accept-Encoding"</js>, value);</code>
*
@@ -530,6 +553,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Accept-Language</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Accept-Language"</js>, value);</code>
*
@@ -542,6 +566,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Authorization</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Authorization"</js>, value);</code>
*
@@ -554,6 +579,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Cache-Control</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Cache-Control"</js>, value);</code>
*
@@ -566,6 +592,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Connection</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Connection"</js>, value);</code>
*
@@ -578,6 +605,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Content-Length</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Content-Length"</js>, value);</code>
*
@@ -590,8 +618,10 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Content-Type</code> request header.
+ *
* <p>
- * This overrides the media type specified on the serializer, but is overridden by calling <code>header(<js>"Content-Type"</js>, value);</code>
+ * This overrides the media type specified on the serializer, but is overridden by calling
+ * <code>header(<js>"Content-Type"</js>, value);</code>
*
* @param value The new header value.
* @return This object (for method chaining).
@@ -602,6 +632,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Date</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Date"</js>, value);</code>
*
@@ -614,6 +645,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Expect</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Expect"</js>, value);</code>
*
@@ -626,6 +658,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Forwarded</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Forwarded"</js>, value);</code>
*
@@ -638,6 +671,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>From</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"From"</js>, value);</code>
*
@@ -650,6 +684,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Host</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Host"</js>, value);</code>
*
@@ -662,6 +697,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>If-Match</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-Match"</js>, value);</code>
*
@@ -674,6 +710,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>If-Modified-Since</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-Modified-Since"</js>, value);</code>
*
@@ -686,6 +723,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>If-None-Match</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-None-Match"</js>, value);</code>
*
@@ -698,6 +736,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>If-Range</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-Range"</js>, value);</code>
*
@@ -710,6 +749,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>If-Unmodified-Since</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-Unmodified-Since"</js>, value);</code>
*
@@ -722,6 +762,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Max-Forwards</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Max-Forwards"</js>, value);</code>
*
@@ -734,6 +775,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Origin</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Origin"</js>, value);</code>
*
@@ -746,6 +788,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Pragma</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Pragma"</js>, value);</code>
*
@@ -758,6 +801,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Proxy-Authorization</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Proxy-Authorization"</js>, value);</code>
*
@@ -770,6 +814,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Range</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Range"</js>, value);</code>
*
@@ -782,6 +827,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Referer</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Referer"</js>, value);</code>
*
@@ -794,6 +840,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>TE</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"TE"</js>, value);</code>
*
@@ -806,6 +853,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>User-Agent</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"User-Agent"</js>, value);</code>
*
@@ -818,6 +866,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Upgrade</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Upgrade"</js>, value);</code>
*
@@ -830,6 +879,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Via</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Via"</js>, value);</code>
*
@@ -842,6 +892,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the value for the <code>Warning</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Warning"</js>, value);</code>
*
@@ -1116,10 +1167,11 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* When called, <code>No-Trace: true</code> is added to requests.
+ *
* <p>
* This gives the opportunity for the servlet to not log errors on invalid requests.
- * This is useful for testing purposes when you don't want your log file to show lots
- * of errors that are simply the results of testing.
+ * This is useful for testing purposes when you don't want your log file to show lots of errors that are simply the
+ * results of testing.
*
* @return This object (for method chaining).
*/
@@ -1129,10 +1181,10 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Sets the {@link UonSerializerContext#UON_paramFormat} property on the URL-encoding serializers in this group.
+ *
* <p>
- * This overrides the behavior of the URL-encoding serializer to quote and escape characters
- * in query names and values that may be confused for UON notation (e.g. <js>"'(foo=123)'"</js>, <js>"'@(1,2,3)'"</js>).
- * <p>
+ * This overrides the behavior of the URL-encoding serializer to quote and escape characters in query names and
+ * values that may be confused for UON notation (e.g. <js>"'(foo=123)'"</js>, <js>"'@(1,2,3)'"</js>).
*
* @param value The new value for this property.
* @return This object (for method chaining).
@@ -1145,11 +1197,14 @@ public class RestClientBuilder extends CoreObjectBuilder {
/**
* Shortcut for calling <code>paramFormat(<js>"PLAINTEXT"</js>)</code>.
+ *
* <p>
- * The default behavior is to serialize part values (query parameters, form data, headers, path variables) in UON notation.
+ * The default behavior is to serialize part values (query parameters, form data, headers, path variables) in UON
+ * notation.
* Calling this method forces plain-text to be used instead.
+ *
* <p>
- * Specifially, UON notation has the following effects:
+ * Specifically, UON notation has the following effects:
* <ul>
* <li>Boolean strings (<js>"true"</js>/<js>"false"</js>) and numeric values (<js>"123"</js>) will be
* quoted (<js>"'true'"</js>, <js>"'false'"</js>, <js>"'123'"</js>.
@@ -1158,7 +1213,7 @@ public class RestClientBuilder extends CoreObjectBuilder {
* <js>"'(foo=bar~'baz~')'"</js>.
* </ul>
* <p>
- * The downside to using plain text part serialization is that you cannot serialize arbitrary POJOs.
+ * The down-side to using plain text part serialization is that you cannot serialize arbitrary POJOs.
*
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java
index 9e460ab..8767730 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java
@@ -31,6 +31,7 @@ public final class RestRequestEntity extends BasicHttpEntity {
/**
* Constructor.
+ *
* @param input The POJO to serialize. Can also be a {@link Reader} or {@link InputStream}.
* @param serializer The serializer to use to serialize this response.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java
index 6d225b0..31e56af 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java
@@ -16,10 +16,10 @@ import org.apache.http.*;
/**
* Used to determine whether a request should be retried based on the HTTP response code.
+ *
* <p>
- * Subclasses should override either the {@link #onCode(int)} method (if you only care about
- * the HTTP status code) or {@link #onResponse(HttpResponse)} (if you want full access to
- * the HTTP response object.
+ * Subclasses should override either the {@link #onCode(int)} method (if you only care about the HTTP status code)
+ * or {@link #onResponse(HttpResponse)} (if you want full access to the HTTP response object.
*/
public abstract class RetryOn {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java
index 35ce572..0dc9676 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java
@@ -41,8 +41,9 @@ public class SSLOpts {
/**
* Constructor.
*
- * @param protocols A comma-delimited list of supported SSL protocols.
- * If <jk>null</jk>, uses the value returned by {@link #getDefaultProtocols()}.
+ * @param protocols
+ * A comma-delimited list of supported SSL protocols.
+ * If <jk>null</jk>, uses the value returned by {@link #getDefaultProtocols()}.
* @param certValidate Certificate validation setting.
* @param hostVerify Host verification setting.
*/
@@ -54,14 +55,15 @@ public class SSLOpts {
}
/**
- * Returns the default list of SSL protocols to support when the <code>protocols</code>
- * parameter on the constructor is <jk>null</jk>.
+ * Returns the default list of SSL protocols to support when the <code>protocols</code> parameter on the constructor
+ * is <jk>null</jk>.
+ *
* <p>
- * The default value is <jk>"SSL_TLS,TLS,SSL"</js> unless overridden by one of the following
- * system properties:
+ * The default value is <jk>"SSL_TLS,TLS,SSL"</js> unless overridden by one of the following system properties:
* <ul>
* <li><js>"transport.client.protocol"</js>
* </ul>
+ *
* <p>
* Subclasses can override this method to provide their own logic for determining default supported protocols.
*
@@ -146,6 +148,7 @@ public class SSLOpts {
/**
* Certificate validation options.
+ *
* <p>
* Used as enum for {@link SSLOpts#getCertValidate()} property.
*/
@@ -165,6 +168,7 @@ public class SSLOpts {
/**
* Certificate host verification options.
+ *
* <p>
* Used as enum for {@link SSLOpts#getHostVerify()} property.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java
index 2da901f..d4a0671 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java
@@ -43,7 +43,7 @@ public final class SimpleX509TrustManager implements X509TrustManager {
return;
}
}
- throw new IllegalStateException("Couldn't find JRE's X509TrustManager"); //$NON-NLS-1$
+ throw new IllegalStateException("Couldn't find JRE's X509TrustManager");
}
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/package.html
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/package.html b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/package.html
index 5e5fe02..3881f3d 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/package.html
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/package.html
@@ -88,29 +88,38 @@
Juneau provides an HTTP client API that makes it extremely simple to connect to remote REST interfaces and
seemlessly send and receive serialized POJOs in requests and responses.
</p>
+
<h6 class='notes'>Features:</h6>
<ul class='notes'>
- <li>Converts POJOs directly to HTTP request message bodies using {@link org.apache.juneau.serializer.Serializer} classes.
- <li>Converts HTTP response message bodies directly to POJOs using {@link org.apache.juneau.parser.Parser} classes.
- <li>Exposes the full functionality of the Apache HttpClient API by exposing all methods defined on the
+ <li>
+ Converts POJOs directly to HTTP request message bodies using {@link org.apache.juneau.serializer.Serializer}
+ classes.
+ <li>
+ Converts HTTP response message bodies directly to POJOs using {@link org.apache.juneau.parser.Parser}
+ classes.
+ <li>
+ Exposes the full functionality of the Apache HttpClient API by exposing all methods defined on the
{@link org.apache.http.impl.client.HttpClientBuilder} class.
- <li>Provides various convenience methods for setting up common SSL and authentication methods.
- <li>Provides a fluent interface that allows you to make complex REST calls in a single line of code.
+ <li>
+ Provides various convenience methods for setting up common SSL and authentication methods.
+ <li>
+ Provides a fluent interface that allows you to make complex REST calls in a single line of code.
</ul>
<p>
The client API is designed to work as a thin layer on top of the proven Apache HttpClient API.
By leveraging the HttpClient library, details such as SSL certificate negotiation, proxies, encoding, etc...
- are all handled in Apache code.
+ are all handled in Apache code.
</p>
<p>
The Juneau client API prereq's Apache HttpClient 4.1.2+.
- At a mimimum, the following jars are required:
+ At a minimum, the following jars are required:
</p>
<ul>
<li><code>httpclient-4.5.jar</code>
<li><code>httpcore-4.4.1.jar</code>
<li><code>httpmime-4.5.jar</code>
</ul>
+
<h6 class='topic'>Example:</h6>
<p class='bcode'>
<jc>// Examples below use the Juneau Address Book resource example</jc>
@@ -204,8 +213,10 @@
<h6 class='notes'>Notes:</h6>
<ul class='notes'>
- <li><p>The {@link org.apache.juneau.rest.client.RestClient} class exposes all the builder methods on the Apache HttpClient {@link org.apache.http.impl.client.HttpClientBuilder} class.
- Use these methods to provide any customized HTTP client behavior..</p>
+ <li>
+ The {@link org.apache.juneau.rest.client.RestClient} class exposes all the builder methods on the Apache
+ HttpClient {@link org.apache.http.impl.client.HttpClientBuilder} class.
+ Use these methods to provide any customized HTTP client behavior.
</ul>
<!-- ======================================================================================================== -->
@@ -213,13 +224,15 @@
<h3 class='topic' onclick='toggle(this)'>1.1 - SSL Support</h3>
<div class='topic'>
<p>
- The simplest way to enable SSL support in the client is to use the {@link org.apache.juneau.rest.client.RestClientBuilder#enableSSL(SSLOpts)} method
- and one of the predefined {@link org.apache.juneau.rest.client.SSLOpts} instances:
+ The simplest way to enable SSL support in the client is to use the
+ {@link org.apache.juneau.rest.client.RestClientBuilder#enableSSL(SSLOpts)} method and one of the predefined
+ {@link org.apache.juneau.rest.client.SSLOpts} instances:
</p>
<ul>
<li>{@link org.apache.juneau.rest.client.SSLOpts#DEFAULT} - Normal certificate and hostname validation.
<li>{@link org.apache.juneau.rest.client.SSLOpts#LAX} - Allows for self-signed certificates.
</ul>
+
<h6 class='topic'>Example:</h6>
<p class='bcode'>
<jc>// Create a client that ignores self-signed or otherwise invalid certificates.</jc>
@@ -244,22 +257,27 @@
ctx.init(<jk>null</jk>, <jk>new</jk> TrustManager[] { tm }, <jk>null</jk>);
SSLConnectionSocketFactory sf = <jk>new</jk> SSLConnectionSocketFactory(ctx, hv);
builder.setSSLSocketFactory(sf);
- Registry<ConnectionSocketFactory> r = RegistryBuilder.<ConnectionSocketFactory><jsm>.create</jsm>().register(<js>"https"</js>, sf).build();
+ Registry<ConnectionSocketFactory> r = RegistryBuilder.<ConnectionSocketFactory><jsm>.create</jsm>()
+ .register(<js>"https"</js>, sf).build();
builder.setConnectionManager(<jk>new</jk> PoolingHttpClientConnectionManager(r));
}
</p>
<p>
- More complex SSL support can be enabled through the various {@link org.apache.http.impl.client.HttpClientBuilder} methods defined on the class.
+ More complex SSL support can be enabled through the various {@link org.apache.http.impl.client.HttpClientBuilder}
+ methods defined on the class.
</p>
<!-- ======================================================================================================== -->
<a id="SSLOpts"></a>
<h4 class='topic' onclick='toggle(this)'>1.1.1 - SSLOpts Bean</h4>
<div class='topic'>
- <p>
- The {@link org.apache.juneau.rest.client.SSLOpts} class itself is a bean that can be created by the parsers.
- For example, SSL options can be specified in a config file and retrieved as a bean using the {@link org.apache.juneau.ini.ConfigFile} class.
- </p>
+ <p>
+ The {@link org.apache.juneau.rest.client.SSLOpts} class itself is a bean that can be created by the
+ parsers.
+ For example, SSL options can be specified in a config file and retrieved as a bean using the
+ {@link org.apache.juneau.ini.ConfigFile} class.
+ </p>
+
<h6 class='figure'>Contents of <code>MyConfig.cfg</code></h6>
<p class='bcode'>
<jc>#================================================================================
@@ -269,6 +287,7 @@
url = https://myremotehost:9443
ssl = {certValidate:'LAX',hostVerify:'LAX'}
</p>
+
<h6 class='figure'>Code that reads an <code>SSLOpts</code> bean from the config file</h6>
<p class='bcode'>
<jc>// Read config file and set SSL options based on what's in that file.</jc>
@@ -289,20 +308,21 @@
<h4 class='topic' onclick='toggle(this)'>1.2.1 - BASIC Authentication</h4>
<div class='topic'>
<p>
- The {@link org.apache.juneau.rest.client.RestClientBuilder#basicAuth(String,int,String,String)} method can be used to quickly enable
- BASIC authentication support.
+ The {@link org.apache.juneau.rest.client.RestClientBuilder#basicAuth(String,int,String,String)} method
+ can be used to quickly enable BASIC authentication support.
</p>
+
<h6 class='topic'>Example:</h6>
<p class='bcode'>
<jc>// Create a client that performs BASIC authentication using the specified user/pw.</jc>
RestClient restClient = <jk>new</jk> RestClientBuilder()
.basicAuth(<jsf>HOST</jsf>, <jsf>PORT</jsf>, <jsf>USER</jsf>, <jsf>PW</jsf>)
.build();
- </p>
- <p>
- This is functionally equivalent to the following:
- </p>
- <p class='bcode'>
+ </p>
+ <p>
+ This is functionally equivalent to the following:
+ </p>
+ <p class='bcode'>
RestClientBuilder builder = <jk>new</jk> RestClientBuilder();
AuthScope scope = <jk>new</jk> AuthScope(<jsf>HOST</jsf>, <jsf>PORT</jsf>);
Credentials up = <jk>new</jk> UsernamePasswordCredentials(<jsf>USER</jsf>, <jsf>PW</jsf>);
@@ -317,15 +337,16 @@
<h4 class='topic' onclick='toggle(this)'>1.2.2 - FORM-based Authentication</h4>
<div class='topic'>
<p>
- The {@link org.apache.juneau.rest.client.RestClientBuilder} class does not itself provide FORM-based authentication since there
- is no standard way of providing such support.
+ The {@link org.apache.juneau.rest.client.RestClientBuilder} class does not itself provide FORM-based
+ authentication since there is no standard way of providing such support.
Typically, to perform FORM-based or other types of authentication, you'll want to create your own
- subclass of {@link org.apache.juneau.rest.client.RestClientBuilder} and override the {@link org.apache.juneau.rest.client.RestClientBuilder#createHttpClient()}
- method to provide an authenticated client.
+ subclass of {@link org.apache.juneau.rest.client.RestClientBuilder} and override the
+ {@link org.apache.juneau.rest.client.RestClientBuilder#createHttpClient()} method to provide an
+ authenticated client.
</p>
<p>
- The following example shows how the <code>JazzRestClient</code> class provides
- FORM-based authentication support.
+ The following example shows how the <code>JazzRestClient</code> class provides FORM-based
+ authentication support.
</p>
<p class='bcode'>
<jd>/**
@@ -405,8 +426,8 @@
<h4 class='topic' onclick='toggle(this)'>1.2.3 - OIDC Authentication</h4>
<div class='topic'>
<p>
- The following example shows how the <code>JazzRestClient</code> class provides
- OIDC authentication support.
+ The following example shows how the <code>JazzRestClient</code> class provides OIDC authentication
+ support.
</p>
<p class='bcode'>
<jd>/**
@@ -443,13 +464,15 @@
<jk>return</jk>;
<jk>if</jk> (code != <jsf>SC_UNAUTHORIZED</jsf>)
- <jk>throw new</jk> RestCallException(<js>"Unexpected response during OIDC authentication: "</js> + response.getStatusLine());
+ <jk>throw new</jk> RestCallException(<js>"Unexpected response during OIDC authentication: "</js>
+ + response.getStatusLine());
<jc>// x-jsa-authorization-redirect</jc>
String redirectUri = getHeader(response, <js>"X-JSA-AUTHORIZATION-REDIRECT"</js>);
<jk>if</jk> (redirectUri == <jk>null</jk>)
- <jk>throw new</jk> RestCallException(<js>"Expected a redirect URI during OIDC authentication: "</js> + response.getStatusLine());
+ <jk>throw new</jk> RestCallException(<js>"Expected a redirect URI during OIDC authentication: "</js>
+ + response.getStatusLine());
<jc>// Handle Bearer Challenge</jc>
HttpGet method = <jk>new</jk> HttpGet(redirectUri + <js>"&prompt=none"</js>);
@@ -460,12 +483,14 @@
code = response.getStatusLine().getStatusCode();
<jk>if</jk> (code != <jsf>SC_OK</jsf>)
- <jk>throw new</jk> RestCallException(<js>"Unexpected response during OIDC authentication phase 2: "</js> + response.getStatusLine());
+ <jk>throw new</jk> RestCallException(<js>"Unexpected response during OIDC authentication phase 2: "</js>
+ + response.getStatusLine());
String loginRequired = getHeader(response, <js>"X-JSA-LOGIN-REQUIRED"</js>);
<jk>if</jk> (! <js>"true"</js>.equals(loginRequired))
- <jk>throw new</jk> RestCallException(<js>"X-JSA-LOGIN-REQUIRED header not found on response during OIDC authentication phase 2: "</js> + response.getStatusLine());
+ <jk>throw new</jk> RestCallException(<js>"X-JSA-LOGIN-REQUIRED header not found on response during OIDC authentication phase 2: "</js>
+ + response.getStatusLine());
method = <jk>new</jk> HttpGet(redirectUri + <js>"&prompt=none"</js>);
@@ -475,7 +500,8 @@
code = response.getStatusLine().getStatusCode();
<jk>if</jk> (code != <jsf>SC_OK</jsf>)
- <jk>throw new</jk> RestCallException(<js>"Unexpected response during OIDC authentication phase 3: "</js> + response.getStatusLine());
+ <jk>throw new</jk> RestCallException(<js>"Unexpected response during OIDC authentication phase 3: "</js>
+ + response.getStatusLine());
<jc>// Handle JAS Challenge</jc>
method = <jk>new</jk> HttpGet(redirectUri);
@@ -486,15 +512,18 @@
code = response.getStatusLine().getStatusCode();
<jk>if</jk> (code != <jsf>SC_OK</jsf>)
- <jk>throw new</jk> RestCallException(<js>"Unexpected response during OIDC authentication phase 4: "</js> + response.getStatusLine());
+ <jk>throw new</jk> RestCallException(<js>"Unexpected response during OIDC authentication phase 4: "</js>
+ + response.getStatusLine());
<jf>cookie</jf> = getHeader(response, <js>"Set-Cookie"</js>);
Header[] defaultHeaders = <jk>new</jk> Header[] {
<jk>new</jk> BasicHeader(<js>"User-Agent"</js>, <js>"Jazz Native Client"</js>),
- <jk>new</jk> BasicHeader(<js>"X-com-ibm-team-configuration-versions"</js>, <js>"com.ibm.team.rtc=6.0.0,com.ibm.team.jazz.foundation=6.0"</js>),
+ <jk>new</jk> BasicHeader(<js>"X-com-ibm-team-configuration-versions"</js>,
+ <js>"com.ibm.team.rtc=6.0.0,com.ibm.team.jazz.foundation=6.0"</js>),
<jk>new</jk> BasicHeader(<js>"Accept"</js>, <js>"text/json"</js>),
- <jk>new</jk> BasicHeader(<js>"Authorization"</js>, <js>"Basic "</js> + StringUtils.<jsm>base64EncodeToString</jsm>(<jf>user</jf> + <js>":"</js> + <jf>pw</jf>)),
+ <jk>new</jk> BasicHeader(<js>"Authorization"</js>, <js>"Basic "</js>
+ + StringUtils.<jsm>base64EncodeToString</jsm>(<jf>user</jf> + <js>":"</js> + <jf>pw</jf>)),
<jk>new</jk> BasicHeader(<js>"Cookie"</js>, cookie)
};
@@ -507,11 +536,13 @@
<jk>private void</jk> addDefaultOidcHeaders(HttpRequestBase method) {
method.addHeader(<js>"User-Agent"</js>, <js>"Jazz Native Client"</js>);
- method.addHeader(<js>"X-com-ibm-team-configuration-versions"</js>, <js>"com.ibm.team.rtc=6.0.0,com.ibm.team.jazz.foundation=6.0"</js>);
+ method.addHeader(<js>"X-com-ibm-team-configuration-versions"</js>,
+ <js>"com.ibm.team.rtc=6.0.0,com.ibm.team.jazz.foundation=6.0"</js>);
method.addHeader(<js>"Accept"</js>, <js>"text/json"</js>);
<jk>if</jk> (<jf>cookie</jf> != <jk>null</jk>) {
- method.addHeader(<js>"Authorization"</js>, <js>"Basic "</js> + StringUtils.<jsm>base64EncodeToString</jsm>(<jf>user</jf> + <js>":"</js> + <jf>pw</jf>));
+ method.addHeader(<js>"Authorization"</js>, <js>"Basic "</js>
+ + StringUtils.<jsm>base64EncodeToString</jsm>(<jf>user</jf> + <js>":"</js> + <jf>pw</jf>));
method.addHeader(<js>"Cookie"</js>, cookie);
}
}
@@ -529,16 +560,18 @@
the results through the connection, and then fails after an HTTP 200 has already been sent.
</p>
<p>
- One common solution is to serialize some text at the end to indicate whether the long-running process succeeded (e.g. <js>"FAILED"</js> or <js>"SUCCEEDED"</js>).
+ One common solution is to serialize some text at the end to indicate whether the long-running process
+ succeeded (e.g. <js>"FAILED"</js> or <js>"SUCCEEDED"</js>).
</p>
<p>
- The {@link org.apache.juneau.rest.client.RestClient} class has convenience methods for scanning the response without
- interfering with the other methods used for retrieving output.
+ The {@link org.apache.juneau.rest.client.RestClient} class has convenience methods for scanning the
+ response without interfering with the other methods used for retrieving output.
</p>
<p>
- The following example shows how the {@link org.apache.juneau.rest.client.RestCall#successPattern(String)} method can be used
- to look for a SUCCESS message in the output:
+ The following example shows how the {@link org.apache.juneau.rest.client.RestCall#successPattern(String)}
+ method can be used to look for a SUCCESS message in the output:
</p>
+
<h6 class='topic'>Example:</h6>
<p class='bcode'>
<jc>// Throw a RestCallException if SUCCESS is not found in the output.</jc>
@@ -550,6 +583,7 @@
The {@link org.apache.juneau.rest.client.RestCall#failurePattern(String)} method does the opposite.
It throws an exception if a failure message is detected.
</p>
+
<h6 class='topic'>Example:</h6>
<p class='bcode'>
<jc>// Throw a RestCallException if FAILURE or ERROR is found in the output.</jc>
@@ -558,14 +592,16 @@
.run();
</p>
<p>
- These convenience methods are specialized methods that use the {@link org.apache.juneau.rest.client.RestCall#responsePattern(ResponsePattern)}
- method which uses regular expression matching against the response body.
+ These convenience methods are specialized methods that use the
+ {@link org.apache.juneau.rest.client.RestCall#responsePattern(ResponsePattern)} method which uses regular
+ expression matching against the response body.
This method can be used to search for arbitrary patterns in the response body.
</p>
<p>
- The following example shows how to use a response pattern finder to find and capture patterns for <js>"x=number"</js> and <js>"y=string"</js>
- from a response body.
+ The following example shows how to use a response pattern finder to find and capture patterns for
+ <js>"x=number"</js> and <js>"y=string"</js> from a response body.
</p>
+
<h6 class='topic'>Example:</h6>
<p class='bcode'>
<jk>final</jk> List<Number> xList = <jk>new</jk> ArrayList<Number>();
@@ -600,9 +636,11 @@
</p>
<p>
Using response patterns does not affect the functionality of any of the other methods
- used to retrieve the response such as {@link org.apache.juneau.rest.client.RestCall#getResponseAsString()} or {@link org.apache.juneau.rest.client.RestCall#getResponse(Class)}.<br>
+ used to retrieve the response such as {@link org.apache.juneau.rest.client.RestCall#getResponseAsString()}
+ or {@link org.apache.juneau.rest.client.RestCall#getResponse(Class)}.<br>
HOWEVER, if you want to retrieve the entire text of the response from inside the match methods,
- use {@link org.apache.juneau.rest.client.RestCall#getCapturedResponse()} since this method will not absorb the response for those other methods.
+ use {@link org.apache.juneau.rest.client.RestCall#getCapturedResponse()} since this method will not absorb
+ the response for those other methods.
</p>
</div>
@@ -611,15 +649,17 @@
<h3 class='topic' onclick='toggle(this)'>1.4 - Piping Response Output</h3>
<div class='topic'>
<p>
- The {@link org.apache.juneau.rest.client.RestCall} class provides various convenience <code>pipeTo()</code> methods
- to pipe output to output streams and writers.
+ The {@link org.apache.juneau.rest.client.RestCall} class provides various convenience <code>pipeTo()</code>
+ methods to pipe output to output streams and writers.
</p>
<p>
- If you want to pipe output without any intermediate buffering, you can use the {@link org.apache.juneau.rest.client.RestCall#byLines()} method.
+ If you want to pipe output without any intermediate buffering, you can use the
+ {@link org.apache.juneau.rest.client.RestCall#byLines()} method.
This will cause the output to be piped and flushed after every line.
This can be useful if you want to display the results in real-time from a long running process producing
- output on a REST call.
+ output on a REST call.
</p>
+
<h6 class='topic'>Example:</h6>
<p class='bcode'>
<jc>// Pipe output from REST call to System.out in real-time.</jc>
@@ -636,9 +676,10 @@
made from the client.
</p>
<p>
- Under-the-covers, this is simply a shortcut for adding the {@link org.apache.juneau.rest.client.RestCallLogger#DEFAULT} interceptor
- to the client. This causes the following output to be generated by the Java <code>org.apache.juneau.rest.client</code> logger at <jsf>WARNING</jsf>
- level:
+ Under-the-covers, this is simply a shortcut for adding the {@link org.apache.juneau.rest.client.RestCallLogger#DEFAULT}
+ intercepter to the client.
+ This causes the following output to be generated by the Java <code>org.apache.juneau.rest.client</code>
+ logger at <jsf>WARNING</jsf> level:
</p>
<p class='bcode'>
=== HTTP Call (outgoing) =======================================================
@@ -663,7 +704,8 @@
=== END ========================================================================
</p>
<p>
- This setting also causes a <code>Debug: true</code> header value to trigger logging of the request on the server side as well.
+ This setting also causes a <code>Debug: true</code> header value to trigger logging of the request on the
+ server side as well.
</p>
<p class='bcode'>
=== HTTP Request (incoming) ====================================================
@@ -689,10 +731,11 @@
<h3 class='topic' onclick='toggle(this)'>1.6 - Logging</h3>
<div class='topic'>
<p>
- Use the {@link org.apache.juneau.rest.client.RestClientBuilder#logTo(Level,Logger)} and {@link org.apache.juneau.rest.client.RestCall#logTo(Level,Logger)} methods
- to log HTTP calls.
+ Use the {@link org.apache.juneau.rest.client.RestClientBuilder#logTo(Level,Logger)} and
+ {@link org.apache.juneau.rest.client.RestCall#logTo(Level,Logger)} methods to log HTTP calls.
These methods will cause the HTTP request and response headers and body to be logged to the specified logger.
</p>
+
<h6 class='topic'>Example:</h6>
<p class='bcode'>
<jc>// Log the HTTP request/response to the specified logger.</jc>
@@ -702,8 +745,8 @@
The method call is ignored if the logger level is below the specified level.
</p>
<p>
- Customized logging can be handled by subclassing the {@link org.apache.juneau.rest.client.RestCallLogger} class and using the
- {@link org.apache.juneau.rest.client.RestCall#interceptor(RestCallInterceptor)} method.
+ Customized logging can be handled by sub-classing the {@link org.apache.juneau.rest.client.RestCallLogger}
+ class and using the {@link org.apache.juneau.rest.client.RestCall#intercepter(RestCallInterceptor)} method.
</p>
</div>
@@ -712,16 +755,17 @@
<h3 class='topic' onclick='toggle(this)'>1.7 - Interceptors</h3>
<div class='topic'>
<p>
- The {@link org.apache.juneau.rest.client.RestClientBuilder#interceptor(RestCallInterceptor)} and {@link org.apache.juneau.rest.client.RestCall#interceptor(RestCallInterceptor)} methods
- can be used to intercept responses during specific connection lifecycle events.
+ The {@link org.apache.juneau.rest.client.RestClientBuilder#intercepter(RestCallInterceptor)} and
+ {@link org.apache.juneau.rest.client.RestCall#intercepter(RestCallInterceptor)} methods can be used to
+ intercept responses during specific connection lifecycle events.
</p>
<p>
- The {@link org.apache.juneau.rest.client.RestCallLogger} class is an example of an interceptor that uses the various lifecycle methods
- to log HTTP requests.
+ The {@link org.apache.juneau.rest.client.RestCallLogger} class is an example of an intercepter that uses
+ the various lifecycle methods to log HTTP requests.
</p>
<p class='bcode'>
<jd>/**
- * Specialized interceptor for logging calls to a log file.
+ * Specialized intercepter for logging calls to a log file.
*/</jd>
<jk>public class</jk> RestCallLogger <jk>extends</jk> RestCallInterceptor {
@@ -812,21 +856,23 @@
<!-- ======================================================================================================== -->
<a id="Remoteable"></a>
- <h3 class='topic' onclick='toggle(this)'>1.8 - Remotable Proxies</h3>
+ <h3 class='topic' onclick='toggle(this)'>1.8 - Remoteable Proxies</h3>
<div class='topic'>
<p>
Juneau provides the capability of calling methods on POJOs on a server through client-side proxy interfaces.
It offers a number of advantages over other similar remote proxy interfaces, such as being much simpler to
- use and allowing much more flexibility.
+ use and allowing much more flexibility.
</p>
<p>
- Proxy interfaces are retrieved using the {@link org.apache.juneau.rest.client.RestClient#getRemoteableProxy(Class)} method.
- The remoteable servlet is a specialized subclass of {@link org.apache.juneau.rest.RestServlet} that provides a full-blown
- REST interface for calling interfaces remotely.
+ Proxy interfaces are retrieved using the {@link org.apache.juneau.rest.client.RestClient#getRemoteableProxy(Class)}
+ method.
+ The remoteable servlet is a specialized subclass of {@link org.apache.juneau.rest.RestServlet} that
+ provides a full-blown REST interface for calling interfaces remotely.
</p>
<p>
In this example, we have the following interface defined that we want to call from the client side against
- a POJO on the server side (i.e. a Remoteable Service)...
+ a POJO on the server side (i.e. a Remoteable Service)...
+ </p>
<p class='bcode'>
<jk>public interface</jk> IAddressBook {
Person createPerson(CreatePerson cp) <jk>throws</jk> Exception;
@@ -855,18 +901,21 @@
The requirements for a method to be callable through a remoteable service are:
</p>
<ul class='spaced-list'>
- <li>The method must be public.
- <li>The parameter and return types must be <a href='../../../../overview-summary.html#Core.PojoCategories'>serializable and parsable</a>.
+ <li>
+ The method must be public.
+ <li>
+ The parameter and return types must be <a href='../../../../overview-summary.html#Core.PojoCategories'>serializable and parsable</a>.
</ul>
<p>
One significant feature is that the remoteable services servlet is a full-blown REST interface.
- Therefore, in cases where the interface classes are not available on the client side,
- the same method calls can be made through pure REST calls.
- This can also aid significantly in debugging since calls to the remoteable service
- can be called directly from a browser with no code involved.
+ Therefore, in cases where the interface classes are not available on the client side, the same method calls
+ can be made through pure REST calls.
+ This can also aid significantly in debugging since calls to the remoteable service can be called directly
+ from a browser with no code involved.
</p>
<p>
- See <a class='doclink' href='../remoteable/package-summary.html#TOC'>org.apache.juneau.rest.remoteable</a> for more information.
+ See <a class='doclink' href='../remoteable/package-summary.html#TOC'>org.apache.juneau.rest.remoteable</a>
+ for more information.
</p>
</div>
@@ -875,8 +924,8 @@
<h3 class='topic' onclick='toggle(this)'>1.9 - Other Useful Methods</h3>
<div class='topic'>
<p>
- The {@link org.apache.juneau.rest.client.RestClientBuilder#rootUrl(Object)} method can be used to specify a root URL on
- all requests so that you don't have to use absolute paths on individual calls.
+ The {@link org.apache.juneau.rest.client.RestClientBuilder#rootUrl(Object)} method can be used to specify a
+ root URL on all requests so that you don't have to use absolute paths on individual calls.
</p>
<p class='bcode'>
<jc>// Create a rest client with a root URL</jc>
@@ -884,8 +933,8 @@
String r = rc.doGet(<js>"/baz"</js>).getResponseAsString(); <jc>// Gets "http://localhost:9080/foobar/baz"</jc>
</p>
<p>
- The {@link org.apache.juneau.rest.client.RestClientBuilder#property(String,Object)} method can be used to set serializer
- and parser properties.
+ The {@link org.apache.juneau.rest.client.RestClientBuilder#property(String,Object)} method can be used to
+ set serializer and parser properties.
For example, if you're parsing a response into POJOs and you want to ignore fields that aren't on the
POJOs, you can use the {@link org.apache.juneau.BeanContext#BEAN_ignoreUnknownBeanProperties} property.
</p>
@@ -898,10 +947,10 @@
MyPojo myPojo = rc.doGet(<jsf>URL</jsf>).getResponse(MyPojo.<jk>class</jk>);
</p>
<p>
- The {@link org.apache.juneau.rest.client.RestCall#retryable(int,long,RetryOn)} method can be used to automatically
- retry requests on failures.
- This can be particularly useful if you're attempting to connect to a REST resource that may be in
- the process of still initializing.
+ The {@link org.apache.juneau.rest.client.RestCall#retryable(int,long,RetryOn)} method can be used to
+ automatically retry requests on failures.
+ This can be particularly useful if you're attempting to connect to a REST resource that may be in the
+ process of still initializing.
</p>
<p class='bcode'>
<jc>// Create a rest call that retries every 10 seconds for up to 30 minutes as long as a connection fails
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/package.html
----------------------------------------------------------------------
diff --git a/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/package.html b/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/package.html
index 43c3b15..926cbdf 100644
--- a/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/package.html
+++ b/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/package.html
@@ -81,26 +81,35 @@
What you can do with the Juneau JAX-RS provider classes:
</p>
<ul class='spaced-list'>
- <li>Use existing Juneau serializers and parsers for converting streams to POJOs and vis-versa.
- <li>Use annotations to specify filters and properties using the {@link org.apache.juneau.rest.annotation.RestMethod}
+ <li>
+ Use existing Juneau serializers and parsers for converting streams to POJOs and vis-versa.
+ <li>
+ Use annotations to specify filters and properties using the {@link org.apache.juneau.rest.annotation.RestMethod}
and {@link org.apache.juneau.rest.jaxrs.JuneauProvider} annotations.
</ul>
<p>
What you can't do with the Juneau JAX-RS provider classes:
</p>
<ul class='spaced-list'>
- <li>Specify or override serializers/parsers at the Java class and method levels.
+ <li>
+ Specify or override serializers/parsers at the Java class and method levels.
<br>JAX-RS does not provide the capability to use different providers for the same media types
- at the class or method levels.
- <li>Specify or override filters and properties at the Java class level.
- <li>Default stylesheets for the {@link org.apache.juneau.html.HtmlDocSerializer} class.
+ at the class or method levels.
+ <li>
+ Specify or override filters and properties at the Java class level.
+ <li>
+ Default stylesheets for the {@link org.apache.juneau.html.HtmlDocSerializer} class.
<br>It will produce HTML, but it won't contain any styles applied.
<br>However, it's possible to specify your own stylesheet using the {@link org.apache.juneau.html.HtmlDocSerializerContext#HTMLDOC_cssUrl} property.
- <li>The ability to specify HTTP method, headers, and content using GET parameters.
+ <li>
+ The ability to specify HTTP method, headers, and content using GET parameters.
<br>These make debugging REST interfaces using only a browser possible.
- <li>Class or method level encoding.
- <li>Class or method level guards.
- <li>Class or method level converters.
+ <li>
+ Class or method level encoding.
+ <li>
+ Class or method level guards.
+ <li>
+ Class or method level converters.
</ul>
<h6 class='topic'>Juneau JAX-RS Provider API</h6>
@@ -108,12 +117,15 @@
The Juneau JAX-RS provider API consists of the following classes:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.rest.jaxrs.BaseProvider} - The base provider class that implements the JAX-RS
+ <li>
+ {@link org.apache.juneau.rest.jaxrs.BaseProvider} - The base provider class that implements the JAX-RS
<code>MessageBodyReader</code> and <code>MessageBodyWriter</code> interfaces.
- <li>{@link org.apache.juneau.rest.jaxrs.JuneauProvider} - Annotation that is applied to subclasses of <code>BaseProvider</code>
+ <li>
+ {@link org.apache.juneau.rest.jaxrs.JuneauProvider} - Annotation that is applied to subclasses of <code>BaseProvider</code>
to specify the serializers/parsers associated with a provider, and optionally filters and properties to
apply to those serializers and parsers.
- <li>{@link org.apache.juneau.rest.jaxrs.DefaultProvider} - A default provider that provides the same level
+ <li>
+ {@link org.apache.juneau.rest.jaxrs.DefaultProvider} - A default provider that provides the same level
of media type support as the {@link org.apache.juneau.rest.RestServletDefault} class.
</ul>
<p>
[03/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestResource.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
index 3c53010..c7f49a0 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
@@ -35,9 +35,11 @@ import org.apache.juneau.xml.*;
/**
* Used to denote that a class is a REST resource and to associate metadata on it.
* <p>
- * Usually used on a subclass of {@link RestServlet}, but can be used to annotate any class that you want to expose as a REST resource.
+ * Usually used on a subclass of {@link RestServlet}, but can be used to annotate any class that you want to expose as
+ * a REST resource.
*
- * Refer to <a class='doclink' href='../package-summary.html#TOC'>org.apache.juneau.rest</a> doc for information on using this class.
+ * Refer to <a class='doclink' href='../package-summary.html#TOC'>org.apache.juneau.rest</a> doc for information on
+ * using this class.
*/
@Documented
@Target(TYPE)
@@ -54,26 +56,25 @@ public @interface RestResource {
* <li>{@link RestContext#getMessages()}
* </ul>
* <p>
- * Refer to the {@link MessageBundle} class for a description of the message key formats
- * used in the properties file.
+ * Refer to the {@link MessageBundle} class for a description of the message key formats used in the properties file.
* <p>
- * The value can be a relative path like <js>"nls/Messages"</js>, indicating to look for the
- * resource bundle <js>"com.foo.sample.nls.Messages"</js> if the resource class
- * is in <js>"com.foo.sample"</js>, or it can be an absolute path, like <js>"com.foo.sample.nls.Messages"</js>
+ * The value can be a relative path like <js>"nls/Messages"</js>, indicating to look for the resource bundle
+ * <js>"com.foo.sample.nls.Messages"</js> if the resource class is in <js>"com.foo.sample"</js>, or it can be an
+ * absolute path, like <js>"com.foo.sample.nls.Messages"</js>
*/
String messages() default "";
/**
* Class-level guards.
* <p>
- * Associates one or more {@link RestGuard RestGuards} with all REST methods defined
- * in this class.
+ * Associates one or more {@link RestGuard RestGuards} with all REST methods defined in this class.
* These guards get called immediately before execution of any REST method in this class.
* <p>
- * Typically, guards will be used for permissions checking on the user making the request,
- * but it can also be used for other purposes like pre-call validation of a request.
+ * Typically, guards will be used for permissions checking on the user making the request, but it can also be used
+ * for other purposes like pre-call validation of a request.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#addGuards(Class...)}/{@link RestConfig#addGuards(RestGuard...)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#addGuards(Class...)}/
+ * {@link RestConfig#addGuards(RestGuard...)} methods.
*/
Class<? extends RestGuard>[] guards() default {};
@@ -81,14 +82,16 @@ public @interface RestResource {
* Class-level converters.
* <p>
* Associates one or more {@link RestConverter converters} with a resource class.
- * These converters get called immediately after execution of the REST method in the same
- * order specified in the annotation.
+ * These converters get called immediately after execution of the REST method in the same order specified in the
+ * annotation.
* <p>
* Can be used for performing post-processing on the response object before serialization.
* <p>
- * Default converter implementations are provided in the <a class='doclink' href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package.
+ * Default converter implementations are provided in the <a class='doclink'
+ * href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#addConverters(Class...)}/{@link RestConfig#addConverters(RestConverter...)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#addConverters(Class...)}/
+ * {@link RestConfig#addConverters(RestConverter...)} methods.
*/
Class<? extends RestConverter>[] converters() default {};
@@ -103,8 +106,8 @@ public @interface RestResource {
* </ul>
* <p>
* If the specified class is an instance of {@link BeanFilterBuilder}, then a filter built from that builder is added.
- * Any other classes are wrapped in a {@link InterfaceBeanFilterBuilder} to indicate that subclasses should
- * be treated as the specified class type.
+ * Any other classes are wrapped in a {@link InterfaceBeanFilterBuilder} to indicate that subclasses should be
+ * treated as the specified class type.
* <p>
* The programmatic equivalent to this annotation is the {@link RestConfig#addBeanFilters(Class...)} method.
*/
@@ -185,10 +188,12 @@ public @interface RestResource {
* <p>
* Property values will be converted to the appropriate type.
* <p>
- * In some cases, properties can be overridden at runtime through the {@link RestResponse#setProperty(String, Object)} method
- * or through a {@link Properties @Properties} annotated method parameter.
+ * In some cases, properties can be overridden at runtime through the
+ * {@link RestResponse#setProperty(String, Object)} method or through a {@link Properties @Properties} annotated
+ * method parameter.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setProperty(String, Object)}/{@link RestConfig#setProperties(java.util.Map)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#setProperty(String, Object)}/
+ * {@link RestConfig#setProperties(java.util.Map)} methods.
*/
Property[] properties() default {};
@@ -204,7 +209,8 @@ public @interface RestResource {
* <p>
* This annotation can only be used on {@link Serializer} classes that have no-arg constructors.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#addSerializers(Class...)}/{@link RestConfig#addSerializers(Serializer...)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#addSerializers(Class...)}/
+ * {@link RestConfig#addSerializers(Serializer...)} methods.
*/
Class<? extends Serializer>[] serializers() default {};
@@ -213,18 +219,19 @@ public @interface RestResource {
* <p>
* This annotation can only be used on {@link Parser} classes that have no-arg constructors.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#addParsers(Class...)}/{@link RestConfig#addParsers(Parser...)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#addParsers(Class...)}/
+ * {@link RestConfig#addParsers(Parser...)} methods.
*/
Class<? extends Parser>[] parsers() default {};
/**
- * Specifies a list of {@link ResponseHandler} classes that know how to convert POJOs returned
- * by REST methods or set via {@link RestResponse#setOutput(Object)} into appropriate
- * HTTP responses.
+ * Specifies a list of {@link ResponseHandler} classes that know how to convert POJOs returned by REST methods or
+ * set via {@link RestResponse#setOutput(Object)} into appropriate HTTP responses.
* <p>
* See {@link ResponseHandler} for details.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#addResponseHandlers(Class...)}/{@link RestConfig#addResponseHandlers(ResponseHandler...)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#addResponseHandlers(Class...)}/
+ * {@link RestConfig#addResponseHandlers(ResponseHandler...)} methods.
*/
Class<? extends ResponseHandler>[] responseHandlers() default {};
@@ -244,7 +251,8 @@ public @interface RestResource {
* }
* </p>
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#addEncoders(Class...)}/{@link RestConfig#addEncoders(Encoder...)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#addEncoders(Class...)}/
+ * {@link RestConfig#addEncoders(Encoder...)} methods.
*/
Class<? extends Encoder>[] encoders() default {};
@@ -255,8 +263,8 @@ public @interface RestResource {
* <p>
* Affects values returned by {@link RestRequest#getHeader(String)} when the header is not present on the request.
* <p>
- * The most useful reason for this annotation is to provide a default <code>Accept</code> header when one is not specified
- * so that a particular default {@link Serializer} is picked.
+ * The most useful reason for this annotation is to provide a default <code>Accept</code> header when one is not
+ * specified so that a particular default {@link Serializer} is picked.
* <p>
* Only one header value can be specified per entry (i.e. it's not a delimited list of header entries).
*
@@ -269,7 +277,8 @@ public @interface RestResource {
* }
* </p>
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#addDefaultRequestHeader(String, Object)}/{@link RestConfig#addDefaultRequestHeaders(String...)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#addDefaultRequestHeader(String, Object)}/
+ * {@link RestConfig#addDefaultRequestHeaders(String...)} methods.
*/
String[] defaultRequestHeaders() default {};
@@ -278,7 +287,8 @@ public @interface RestResource {
* <p>
* Strings are of the format <js>"Header-Name: header-value"</js>.
* <p>
- * This is equivalent to calling {@link RestResponse#setHeader(String, String)} programmatically in each of the Java methods.
+ * This is equivalent to calling {@link RestResponse#setHeader(String, String)} programmatically in each of the Java
+ * methods.
* <p>
* The header value will not be set if the header value has already been specified (hence the 'default' in the name).
* <p>
@@ -293,49 +303,53 @@ public @interface RestResource {
* }
* </p>
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#addDefaultResponseHeader(String, Object)}/{@link RestConfig#addDefaultResponseHeaders(String...)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#addDefaultResponseHeader(String, Object)}/
+ * {@link RestConfig#addDefaultResponseHeaders(String...)} methods.
*/
String[] defaultResponseHeaders() default {};
/**
* Defines children of this resource.
* <p>
- * A REST child resource is simply another servlet that is initialized as part of the parent
- * resource and has a servlet path directly under the parent servlet path.
- * The main advantage to defining servlets as REST children is that you do not need
- * to define them in the <code>web.xml</code> file of the web application.
- * This can cut down on the number of entries that show up in the <code>web.xml</code> file
- * if you are defining large numbers of servlets.
+ * A REST child resource is simply another servlet that is initialized as part of the parent resource and has a
+ * servlet path directly under the parent servlet path.
+ * The main advantage to defining servlets as REST children is that you do not need to define them in the
+ * <code>web.xml</code> file of the web application.
+ * This can cut down on the number of entries that show up in the <code>web.xml</code> file if you are defining
+ * large numbers of servlets.
* <p>
- * Child resources must specify a value for {@link #path()} that identifies the subpath of the
- * child resource relative to the parent path.
+ * Child resources must specify a value for {@link #path()} that identifies the subpath of the child resource
+ * relative to the parent path.
* <p>
- * It should be noted that servlets can be nested arbitrarily deep using this technique (i.e. children can also have children).
+ * It should be noted that servlets can be nested arbitrarily deep using this technique (i.e. children can also have
+ * children).
*
* <dl>
* <dt>Servlet initialization:</dt>
* <dd>
* <p>
- * A child resource will be initialized immediately after the parent servlet is initialized. The child resource
- * receives the same servlet config as the parent resource. This allows configuration information such as
- * servlet initialization parameters to filter to child resources.
+ * A child resource will be initialized immediately after the parent servlet is initialized.
+ * The child resource receives the same servlet config as the parent resource.
+ * This allows configuration information such as servlet initialization parameters to filter to child
+ * resources.
* </p>
* </dd>
* <dt>Runtime behavior:</dt>
* <dd>
* <p>
- * As a rule, methods defined on the <code>HttpServletRequest</code> object will behave as if
- * the child servlet were deployed as a top-level resource under the child's servlet path.
+ * As a rule, methods defined on the <code>HttpServletRequest</code> object will behave as if the child
+ * servlet were deployed as a top-level resource under the child's servlet path.
* For example, the <code>getServletPath()</code> and <code>getPathInfo()</code> methods on the
- * <code>HttpServletRequest</code> object will behave as if the child resource were deployed
- * using the child's servlet path.
- * Therefore, the runtime behavior should be equivalent to deploying the child servlet in
- * the <code>web.xml</code> file of the web application.
+ * <code>HttpServletRequest</code> object will behave as if the child resource were deployed using the
+ * child's servlet path.
+ * Therefore, the runtime behavior should be equivalent to deploying the child servlet in the
+ * <code>web.xml</code> file of the web application.
* </p>
* </dd>
* </dl>
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#addChildResource(String, Object)}/{@link RestConfig#addChildResources(Class...)}/{@link RestConfig#addChildResources(Object...)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#addChildResource(String, Object)}/
+ * {@link RestConfig#addChildResources(Class...)}/{@link RestConfig#addChildResources(Object...)} methods.
*/
Class<?>[] children() default {};
@@ -343,7 +357,8 @@ public @interface RestResource {
* Identifies the URL subpath relative to the parent resource.
* <p>
* Typically, this annotation is only applicable to resources defined as children through the {@link #children()}
- * annotation. However, it may be used in other ways (e.g. defining paths for top-level resources in microservices).
+ * annotation.
+ * However, it may be used in other ways (e.g. defining paths for top-level resources in microservices).
* <p>
* This annotation is ignored on top-level servlets (i.e. servlets defined in <code>web.xml</code> files).
* Therefore, implementers can optionally specify a path value for documentation purposes.
@@ -359,7 +374,7 @@ public @interface RestResource {
* This value can be retrieved programmatically through the {@link RestRequest#getServletTitle()} method.
* <p>
* The default value pulls the label from the <code>label</code> entry in the servlet resource bundle.
- * (e.g. <js>"title = foo"</js> or <js>"MyServlet.title = foo"</js>).
+ * (e.g. <js>"title = foo"</js> or <js>"MyServlet.title = foo"</js>).
* <p>
* This field can contain variables (e.g. "$L{my.localized.variable}").
* <p>
@@ -372,11 +387,12 @@ public @interface RestResource {
/**
* Optional servlet description.
* <p>
- * It is used to populate the Swagger description field and as a default value for the {@link HtmlDoc#description()} value.
+ * It is used to populate the Swagger description field and as a default value for the {@link HtmlDoc#description()}
+ * value.
* This value can be retrieved programmatically through the {@link RestRequest#getServletDescription()} method.
* <p>
* The default value pulls the description from the <code>description</code> entry in the servlet resource bundle.
- * (e.g. <js>"description = foo"</js> or <js>"MyServlet.description = foo"</js>).
+ * (e.g. <js>"description = foo"</js> or <js>"MyServlet.description = foo"</js>).
* <p>
* This field can contain variables (e.g. "$L{my.localized.variable}").
* <p>
@@ -401,24 +417,27 @@ public @interface RestResource {
* The stylesheet to use for HTML views.
* <p>
* The name is a path to a stylesheet located in either the classpath or working directory.
- * The resulting stylesheet becomes available through the servlet via the URL <js>"[servletpath]/style.css"</js>.
+ * The resulting stylesheet becomes available through the servlet via the URL <js>"[servlet-path]/style.css"</js>.
* <p>
* The default set of styles located in the <code>org.apache.juneau.rest.styles</code> package are:
* <ul class='spaced-list'>
- * <li><js>"styles/juneau.css"</js> - Theme based on Jazz look-and-feel.
- * <li><js>"styles/devops.css"</js> - Theme based on IBM DevOps look-and-feel.
+ * <li>
+ * <js>"styles/juneau.css"</js> - Theme based on Jazz look-and-feel.
+ * <li>
+ * <js>"styles/devops.css"</js> - Theme based on IBM DevOps look-and-feel.
* </ul>
* <p>
- * The classpath search starts with the child servlet class and proceeds up the class hierarchy
- * chain. Since the {@link RestServlet} class is in the <code>org.apache.juneau.rest</code> package
- * and the predefined styles are in the <code>org.apache.juneau.rest.styles</code> package, the paths to
- * the predefined styles are prefixed with <js>"styles/"</js>.
+ * The classpath search starts with the child servlet class and proceeds up the class hierarchy chain.
+ * Since the {@link RestServlet} class is in the <code>org.apache.juneau.rest</code> package and the predefined
+ * styles are in the <code>org.apache.juneau.rest.styles</code> package, the paths to the predefined styles are
+ * prefixed with <js>"styles/"</js>.
* <p>
- * If the stylesheet cannot be found on the classpath, an attempt to look in the working directory
- * for it will be made. This allows for stylesheets to be placed on the file system in the working
- * directory.
+ * If the stylesheet cannot be found on the classpath, an attempt to look in the working directory for it will be
+ * made.
+ * This allows for stylesheets to be placed on the file system in the working directory.
* <p>
- * If the file cannot be located, the request to <js>"[servletpath]/style.css"</js> will return {@link HttpServletResponse#SC_NOT_FOUND}.
+ * If the file cannot be located, the request to <js>"[servlet-path]/style.css"</js> will return
+ * {@link HttpServletResponse#SC_NOT_FOUND}.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -431,11 +450,13 @@ public @interface RestResource {
* }
* </p>
* <p>
- * In this example, the servlet will attempt to find the <code>mycss.css</code> file in the following ordered locations:
+ * In this example, the servlet will attempt to find the <code>mycss.css</code> file in the following ordered
+ * locations:
* </p>
* <ol>
* <li><code>com.foo.mypackage.mystyles</code> package.
- * <li><code>org.apache.juneau.rest.mystyles</code> package (since <code>RestServletDefault</code> is in <code>org.apache.juneau.rest</code>).
+ * <li><code>org.apache.juneau.rest.mystyles</code> package (since <code>RestServletDefault</code> is in
+ * <code>org.apache.juneau.rest</code>).
* <li><code>[working-dir]/mystyles</code> directory.
* </ol>
* <p>
@@ -443,18 +464,20 @@ public @interface RestResource {
* When multiple stylesheets are specified, their contents will be concatenated and return in the order specified
* in the list.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#addStyleSheet(Object...)}/{@link RestConfig#addStyleSheet(Class, String)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#addStyleSheet(Object...)}/
+ * {@link RestConfig#addStyleSheet(Class, String)} methods.
*/
String stylesheet() default "";
/**
* The favicon to use for HTML views.
* <p>
- * The name is a path to an icon file located in either the classpath or working directory in a similar way
- * to how the {@link #stylesheet()} stylesheet is resolved.
- * The resulting favicon becomes available in the servlet via the URL <js>"[servletpath]/favicon.ico"</js>.
+ * The name is a path to an icon file located in either the classpath or working directory in a similar way to how
+ * the {@link #stylesheet()} stylesheet is resolved.
+ * The resulting favicon becomes available in the servlet via the URL <js>"[servlet-path]/favicon.ico"</js>.
* <p>
- * If the file cannot be located, the request to <js>"[servletpath]/favicon.ico"</js> will return {@link HttpServletResponse#SC_NOT_FOUND}.
+ * If the file cannot be located, the request to <js>"[servlet-path]/favicon.ico"</js> will return
+ * {@link HttpServletResponse#SC_NOT_FOUND}.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -467,15 +490,18 @@ public @interface RestResource {
* }
* </p>
* <p>
- * In this example, the servlet will attempt to find the <code>myicon.ico</code> file in the following ordered locations:
+ * In this example, the servlet will attempt to find the <code>myicon.ico</code> file in the following ordered
+ * locations:
* </p>
* <ol>
* <li><code>com.foo.mypackage.mydocs</code> package.
- * <li><code>org.apache.juneau.rest.mydocs</code> package (since <code>RestServletDefault</code> is in <code>org.apache.juneau.rest</code>).
+ * <li><code>org.apache.juneau.rest.mydocs</code> package (since <code>RestServletDefault</code> is in
+ * <code>org.apache.juneau.rest</code>).
* <li><code>[working-dir]/mydocs</code> directory.
* </ol>
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setFavIcon(Object)}/{@link RestConfig#setFavIcon(Class, String)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#setFavIcon(Object)}/
+ * {@link RestConfig#setFavIcon(Class, String)} methods.
*/
String favicon() default "";
@@ -500,12 +526,13 @@ public @interface RestResource {
* }
* </p>
* <p>
- * In this example, given a GET request to <code>/myresource/htdocs/foobar.html</code>, the servlet will attempt to find the <code>foobar.html</code> file
- * in the following ordered locations:
+ * In this example, given a GET request to <code>/myresource/htdocs/foobar.html</code>, the servlet will attempt to
+ * find the <code>foobar.html</code> file in the following ordered locations:
* </p>
* <ol>
* <li><code>com.foo.mypackage.docs</code> package.
- * <li><code>org.apache.juneau.rest.docs</code> package (since <code>RestServletDefault</code> is in <code>org.apache.juneau.rest</code>).
+ * <li><code>org.apache.juneau.rest.docs</code> package (since <code>RestServletDefault</code> is in
+ * <code>org.apache.juneau.rest</code>).
* <li><code>[working-dir]/docs</code> directory.
* </ol>
* <p>
@@ -516,8 +543,8 @@ public @interface RestResource {
/**
* Specifies the HTTP header name used to identify the client version.
* <p>
- * The client version is used to support backwards compatibility for breaking REST interface
- * changes. Used in conjunction with {@link RestMethod#clientVersion()} annotation.
+ * The client version is used to support backwards compatibility for breaking REST interface changes.
+ * Used in conjunction with {@link RestMethod#clientVersion()} annotation.
* <p>
* If not specified, uses <js>"X-Client-Version"</js>.
* <p>
@@ -533,9 +560,8 @@ public @interface RestResource {
* <li><code><jk>public</jk> T(RestConfig)</code>
* <li><code><jk>public</jk> T()</code>
* </ul>
- * The former constructor can be used to get access to the {@link RestConfig} object to get access to the
- * config file and initialization information or make programmatic modifications to the resource before
- * full initialization.
+ * The former constructor can be used to get access to the {@link RestConfig} object to get access to the config
+ * file and initialization information or make programmatic modifications to the resource before full initialization.
* <p>
* Non-<code>RestServlet</code> classes can also add the following two methods to get access to the
* {@link RestConfig} and {@link RestContext} objects:
@@ -546,7 +572,8 @@ public @interface RestResource {
* <p>
* Subclasses can be used to provide customized resolution of REST resource class instances.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setResourceResolver(Class)}/{@link RestConfig#setResourceResolver(RestResourceResolver)} methods.
+ * The programmatic equivalent to this annotation are the {@link RestConfig#setResourceResolver(Class)}/
+ * {@link RestConfig#setResourceResolver(RestResourceResolver)} methods.
*/
Class<? extends RestResourceResolver> resourceResolver() default RestResourceResolver.class;
@@ -556,7 +583,8 @@ public @interface RestResource {
* The default logger performs basic error logging to the Java logger.
* Subclasses can be used to customize logging behavior on the resource.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setLogger(Class)}/{@link RestConfig#setLogger(RestLogger)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setLogger(Class)}/{@link RestConfig#setLogger(RestLogger)} methods.
*/
Class<? extends RestLogger> logger() default RestLogger.Normal.class;
@@ -566,7 +594,8 @@ public @interface RestResource {
* This class handles the basic lifecycle of an HTTP REST call.
* Subclasses can be used to customize how these HTTP calls are handled.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setCallHandler(Class)}/{@link RestConfig#setCallHandler(RestCallHandler)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setCallHandler(Class)}/{@link RestConfig#setCallHandler(RestCallHandler)} methods.
*/
Class<? extends RestCallHandler> callHandler() default RestCallHandler.class;
@@ -575,7 +604,8 @@ public @interface RestResource {
* <p>
* Subclasses can be used to customize the documentation on a resource.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setInfoProvider(Class)}/{@link RestConfig#setInfoProvider(RestInfoProvider)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setInfoProvider(Class)}/{@link RestConfig#setInfoProvider(RestInfoProvider)} methods.
*/
Class<? extends RestInfoProvider> infoProvider() default RestInfoProvider.class;
@@ -591,7 +621,7 @@ public @interface RestResource {
/**
* Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly
- * generate arbitrary replacement text.
+ * generate arbitrary replacement text.
* <p>
* Widgets are inherited from parent to child, but can be overridden by reusing the widget name.
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Introspectable.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Introspectable.java b/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Introspectable.java
index 6414db0..e6d10f9 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Introspectable.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Introspectable.java
@@ -20,20 +20,25 @@ import org.apache.juneau.rest.*;
import org.apache.juneau.utils.*;
/**
- * Converter for enablement of {@link PojoIntrospector} support on response objects returned by a <code>@RestMethod</code> method.
+ * Converter for enablement of {@link PojoIntrospector} support on response objects returned by a
+ * <code>@RestMethod</code> method.
* <p>
- * When enabled, public methods can be called on objects returned through the {@link RestResponse#setOutput(Object)} method.
+ * When enabled, public methods can be called on objects returned through the {@link RestResponse#setOutput(Object)}
+ * method.
* <p>
- * Note that opening up public methods for calling through a REST interface can be dangerous, and should
- * be done with caution.
+ * Note that opening up public methods for calling through a REST interface can be dangerous, and should be done with
+ * caution.
* <p>
* Java methods are invoked by passing in the following URL parameters:
* <ul class='spaced-list'>
- * <li><code>&invokeMethod</code> - The Java method name, optionally with arguments if necessary to differentiate between methods.
- * <li><code>&invokeArgs</code> - The arguments as a JSON array.
+ * <li>
+ * <code>&invokeMethod</code> - The Java method name, optionally with arguments if necessary to
+ * differentiate between methods.
+ * <li>
+ * <code>&invokeArgs</code> - The arguments as a JSON array.
* </ul>
* <p>
- * See {@link PojoIntrospector} for additional information on introspecting POJO methods.
+ * See {@link PojoIntrospector} for additional information on introspection of POJO methods.
*/
public final class Introspectable implements RestConverter {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Queryable.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Queryable.java b/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Queryable.java
index a6ce725..2f4cd95 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Queryable.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Queryable.java
@@ -17,32 +17,39 @@ import org.apache.juneau.rest.*;
import org.apache.juneau.utils.*;
/**
- * Converter for enablement of {@link PojoQuery} support on response objects returned by a <code>@RestMethod</code> method.
+ * Converter for enabling of {@link PojoQuery} support on response objects returned by a <code>@RestMethod</code> method.
* <p>
* When enabled, objects in a POJO tree can be filtered using the functionality described in the {@link PojoQuery}
- * class.
+ * class.
* <p>
- * The following HTTP request parameters are available for tabular data (e.g. {@code Collections} of {@code Maps}, arrays of beans, etc...):
+ * The following HTTP request parameters are available for tabular data (e.g. {@code Collections} of {@code Maps},
+ * arrays of beans, etc...):
* <ul class='spaced-list'>
- * <li><code>&s=</code> Search arguments.
- * <br>Comma-delimited list of key/value pairs representing column names and search tokens.
- * <br>Example: <js>"&s=name=Bill*,birthDate>2000"</js>
- * <li><code>&v=</code> Visible columns.
- * <br>Comma-delimited list of column names to display.
- * <br>Example: <js>"&v=name,birthDate"</js>
- * <li><code>&o=</code> Sort commands.
- * <br>Comma-delimited list of columns to sort by.
- * <br>Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order.
- * <br>The default is ascending order.
- * <br>Example: <js>"&o=name,birthDate-"</js>
- * <li><code>&i=</code> Case-insensitive parameter.
- * <br>Boolean flag for case-insensitive matching on the search parameters.
- * <li><code>&p=</code> - Position parameter.
- * <br>Only return rows starting at the specified index position (zero-indexed).
- * <br>Default is {@code 0}.
- * <li><code>&l=</code> Limit parameter.
- * <br>Only return the specified number of rows.
- * <br>Default is {@code 0} (meaning return all rows).
+ * <li>
+ * <code>&s=</code> Search arguments.
+ * <br>Comma-delimited list of key/value pairs representing column names and search tokens.
+ * <br>Example: <js>"&s=name=Bill*,birthDate>2000"</js>
+ * <li>
+ * <code>&v=</code> Visible columns.
+ * <br>Comma-delimited list of column names to display.
+ * <br>Example: <js>"&v=name,birthDate"</js>
+ * <li>
+ * <code>&o=</code> Sort commands.
+ * <br>Comma-delimited list of columns to sort by.
+ * <br>Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order.
+ * <br>The default is ascending order.
+ * <br>Example: <js>"&o=name,birthDate-"</js>
+ * <li>
+ * <code>&i=</code> Case-insensitive parameter.
+ * <br>Boolean flag for case-insensitive matching on the search parameters.
+ * <li>
+ * <code>&p=</code> - Position parameter.
+ * <br>Only return rows starting at the specified index position (zero-indexed).
+ * <br>Default is {@code 0}.
+ * <li>
+ * <code>&l=</code> Limit parameter.
+ * <br>Only return the specified number of rows.
+ * <br>Default is {@code 0} (meaning return all rows).
* </ul>
*
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Traversable.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Traversable.java b/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Traversable.java
index 734a804..c8ff5be 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Traversable.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Traversable.java
@@ -20,9 +20,10 @@ import org.apache.juneau.serializer.*;
import org.apache.juneau.utils.*;
/**
- * Converter for enablement of {@link PojoRest} support on response objects returned by a <code>@RestMethod</code> method.
+ * Converter for enabling of {@link PojoRest} support on response objects returned by a <code>@RestMethod</code> method.
* <p>
- * When enabled, objects in a POJO tree returned by the REST method can be addressed through additional URL path information.
+ * When enabled, objects in a POJO tree returned by the REST method can be addressed through additional URL path
+ * information.
*
* <p class='bcode'>
* <jc>// Resource method on resource "http://localhost:8080/sample/addressBook"</jc>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaDefault.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaDefault.java b/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaDefault.java
index a2099d3..cd10aa0 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaDefault.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaDefault.java
@@ -43,17 +43,26 @@ import org.apache.juneau.xml.*;
* <th>Serializer</th>
* </tr>
* <tr>
- * <td class='code'>application/json<br>text/json</td>
+ * <td class='code'>
+ * application/json
+ * <br>text/json
+ * </td>
* <td class='code'>application/json</td>
* <td>{@link JsonSerializer}</td>
* </tr>
* <tr>
- * <td class='code'>application/json+simple<br>text/json+simple</td>
+ * <td class='code'>
+ * application/json+simple
+ * <br>text/json+simple
+ * </td>
* <td class='code'>application/json</td>
* <td>{@link org.apache.juneau.json.JsonSerializer.Simple}</td>
* </tr>
* <tr>
- * <td class='code'>application/json+schema<br>text/json+schema</td>
+ * <td class='code'>
+ * application/json+schema
+ * <br>text/json+schema
+ * </td>
* <td class='code'>application/json</td>
* <td>{@link JsonSchemaSerializer}</td>
* </tr>
@@ -142,15 +151,24 @@ import org.apache.juneau.xml.*;
* <th>Parser</th>
* </tr>
* <tr>
- * <td class='code'>application/json<br>text/json</td>
+ * <td class='code'>
+ * application/json
+ * <br>text/json
+ * </td>
* <td>{@link JsonParser}</td>
* </tr>
* <tr>
- * <td class='code'>text/xml<br>application/xml</td>
+ * <td class='code'>
+ * text/xml
+ * <br>application/xml
+ * </td>
* <td>{@link XmlParser}</td>
* </tr>
* <tr>
- * <td class='code'>text/html<br>text/html+stripped</td>
+ * <td class='code'>
+ * text/html
+ * <br>text/html+stripped
+ * </td>
* <td>{@link HtmlParser}</td>
* </tr>
* <tr>
@@ -183,8 +201,9 @@ import org.apache.juneau.xml.*;
* </tr>
* </table>
* <p>
- * Note that the list of serializers and parsers can be appended to using the {@link RestResource#serializers() @RestResource.serializers()}
- * and {@link RestResource#parsers() @RestResource.parsers()} annotations on subclasses.
+ * Note that the list of serializers and parsers can be appended to using the
+ * {@link RestResource#serializers() @RestResource.serializers()} and
+ * {@link RestResource#parsers() @RestResource.parsers()} annotations on subclasses.
*/
@RestResource(
serializers={
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/jena/package.html
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/jena/package.html b/juneau-rest/src/main/java/org/apache/juneau/rest/jena/package.html
index 3fe0832..e94767c 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/jena/package.html
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/jena/package.html
@@ -41,7 +41,5 @@
<p>
Contains predefined instances of REST API classes with Jena support included.
</p>
-
-
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java
index 9375fc9..fd48db5 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java
@@ -18,8 +18,8 @@ import org.apache.juneau.annotation.*;
/**
* Simple serializable bean description.
* <p>
- * Given a particular class type, this serializes the class into
- * the fully-qualified class name and the properties associated with the class.
+ * Given a particular class type, this serializes the class into the fully-qualified class name and the properties
+ * associated with the class.
* <p>
* Useful for rendering simple information about a bean during REST OPTIONS requests.
*/
@@ -34,6 +34,7 @@ public final class BeanDescription {
/**
* Constructor
+ *
* @param c The bean class type.
*/
public BeanDescription(Class<?> c) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java
index 69efb27..97b2eac 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java
@@ -19,8 +19,7 @@ import org.apache.juneau.rest.*;
/**
* A POJO structure that describes the list of child resources associated with a resource.
* <p>
- * Typically used in top-level GET methods of router resources to render a list of
- * available child resources.
+ * Typically used in top-level GET methods of router resources to render a list of available child resources.
*/
public class ChildResourceDescriptions extends LinkedList<ResourceDescription> {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/labels/NameDescription.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/NameDescription.java b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/NameDescription.java
index 8a6af9d..48d9378 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/NameDescription.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/NameDescription.java
@@ -30,6 +30,7 @@ public class NameDescription {
/**
* Constructor.
+ *
* @param name A name.
* @param description A description.
*/
@@ -40,6 +41,7 @@ public class NameDescription {
/**
* Returns the name field on this label.
+ *
* @return The name.
*/
public Object getName() {
@@ -48,6 +50,7 @@ public class NameDescription {
/**
* Sets the name field on this label to a new value.
+ *
* @param name The new name.
*/
public void setName(Object name) {
@@ -56,6 +59,7 @@ public class NameDescription {
/**
* Returns the description field on this label.
+ *
* @return The description.
*/
public Object getDescription() {
@@ -64,6 +68,7 @@ public class NameDescription {
/**
* Sets the description field on this label to a new value.
+ *
* @param description The new description.
*/
public void setDescription(Object description) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/matchers/MultipartFormDataMatcher.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/matchers/MultipartFormDataMatcher.java b/juneau-rest/src/main/java/org/apache/juneau/rest/matchers/MultipartFormDataMatcher.java
index b7ffdfa..0d5be4c 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/matchers/MultipartFormDataMatcher.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/matchers/MultipartFormDataMatcher.java
@@ -22,6 +22,6 @@ public class MultipartFormDataMatcher extends RestMatcher {
@Override /* RestMatcher */
public boolean matches(RestRequest req) {
String contentType = req.getContentType();
- return contentType != null && contentType.startsWith("multipart/form-data"); //$NON-NLS-1$
+ return contentType != null && contentType.startsWith("multipart/form-data");
}
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/matchers/UrlEncodedFormMatcher.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/matchers/UrlEncodedFormMatcher.java b/juneau-rest/src/main/java/org/apache/juneau/rest/matchers/UrlEncodedFormMatcher.java
index d0ed660..e8c0815 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/matchers/UrlEncodedFormMatcher.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/matchers/UrlEncodedFormMatcher.java
@@ -22,6 +22,6 @@ public class UrlEncodedFormMatcher extends RestMatcher {
@Override /* RestMatcher */
public boolean matches(RestRequest req) {
String contentType = req.getContentType();
- return contentType != null && contentType.equals("application/x-www-form-urlencoded"); //$NON-NLS-1$
+ return contentType != null && contentType.equals("application/x-www-form-urlencoded");
}
}
[18/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/BeanContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanContext.java b/juneau-core/src/main/java/org/apache/juneau/BeanContext.java
index 5696b49..6a80dd7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanContext.java
@@ -32,23 +32,31 @@ import org.apache.juneau.transform.*;
/**
* Core class of the Juneau architecture.
+ *
* <p>
* This class servers multiple purposes:
* <ul class='spaced-list'>
- * <li>Provides the ability to wrap beans inside {@link Map} interfaces.
- * <li>Serves as a repository for metadata on POJOs, such as associated {@link BeanFilter beanFilters},
+ * <li>
+ * Provides the ability to wrap beans inside {@link Map} interfaces.
+ * <li>
+ * Serves as a repository for metadata on POJOs, such as associated {@link BeanFilter beanFilters},
* {@link PropertyNamer property namers}, etc... which are used to tailor how POJOs are serialized and parsed.
- * <li>Serves as a common utility class for all {@link Serializer Serializers} and {@link Parser Parsers}
+ * <li>
+ * Serves as a common utility class for all {@link Serializer Serializers} and {@link Parser Parsers}
* for serializing and parsing Java beans.
* </ul>
+ *
* <p>
* All serializer and parser contexts extend from this context.
*
* <h5 class='topic'>Bean Contexts</h5>
+ *
+ * <p>
* Bean contexts are created through the {@link PropertyStore#getContext(Class)} method.
* These context objects are read-only, reusable, and thread-safe.
* The {@link PropertyStore} class will typically cache copies of <code>Context</code> objects based on
* the current settings on the factory.
+ *
* <p>
* Each bean context maintains a cache of {@link ClassMeta} objects that describe information about classes encountered.
* These <code>ClassMeta</code> objects are time-consuming to construct.
@@ -58,6 +66,7 @@ import org.apache.juneau.transform.*;
* Because of this, many of the properties defined on the {@link BeanContext} class cannot be overridden on the session.
*
* <h5 class='topic'>Bean Sessions</h5>
+ *
* <p>
* Whereas <code>BeanContext</code> objects are permanent, unchangeable, cached, and thread-safe,
* {@link BeanSession} objects are ephemeral and not thread-safe.
@@ -65,24 +74,31 @@ import org.apache.juneau.transform.*;
* {@link BeanMap} objects can only be created through the session.
*
* <h5 class='topic'>BeanContext configuration properties</h5>
+ *
+ * <p>
* <code>BeanContexts</code> have several configuration properties that can be used to tweak behavior on how beans are
* handled. These are denoted as the static <jsf>BEAN_*</jsf> fields on this class.
+ *
* <p>
* Some settings (e.g. {@link BeanContext#BEAN_beansRequireDefaultConstructor}) are used to differentiate between bean
* and non-bean classes.
* Attempting to create a bean map around one of these objects will throw a {@link BeanRuntimeException}.
* The purpose for this behavior is so that the serializers can identify these non-bean classes and convert them to
* plain strings using the {@link Object#toString()} method.
+ *
* <p>
* Some settings (e.g. {@link BeanContext#BEAN_beanFieldVisibility}) are used to determine what kinds of properties are
* detected on beans.
+ *
* <p>
* Some settings (e.g. {@link BeanContext#BEAN_beanMapPutReturnsOldValue}) change the runtime behavior of bean maps.
+ *
* <p>
* Settings are specified using the {@link PropertyStore#setProperty(String, Object)} method and related convenience
* methods.
*
* <h5 class='section'>Example:</h5>
+ *
* <p class='bcode'>
* <jc>// Construct a context from scratch.</jc>
* BeanContext beanContext = PropertyStore.<jsm>create</jsm>()
@@ -98,9 +114,11 @@ import org.apache.juneau.transform.*;
* </p>
*
* <h5 class='topic'>Bean Maps</h5>
+ *
* <p>
* {@link BeanMap BeanMaps} are wrappers around Java beans that allow properties to be retrieved and
* set using the common {@link Map#put(Object,Object)} and {@link Map#get(Object)} methods.
+ *
* <p>
* Bean maps are created in two ways...
* <ol>
@@ -111,6 +129,7 @@ import org.apache.juneau.transform.*;
* </ol>
*
* <h5 class='section'>Example:</h5>
+ *
* <p class='bcode'>
* <jc>// A sample bean class</jc>
* <jk>public class</jk> Person {
@@ -136,10 +155,13 @@ import org.apache.juneau.transform.*;
* </p>
*
* <h5 class='topic'>Bean Annotations</h5>
+ *
* <p>
* This package contains annotations that can be applied to class definitions to override what properties are detected
* on a bean.
+ *
* <h5 class='section'>Example:</h5>
+ *
* <p class='bcode'>
* <jc>// Bean class definition where only property 'name' is detected.</jc>
* <ja>@Bean</ja>(properties=<js>"name"</js>)
@@ -149,53 +171,67 @@ import org.apache.juneau.transform.*;
* <jk>public int</jk> getAge();
* <jk>public void</jk> setAge(<jk>int</jk> age);
* }
+ * </p>
+ *
* <p>
* See {@link Bean @Bean} and {@link BeanProperty @BeanProperty} for more information.
*
* <h5 class='topic'>Beans with read-only properties</h5>
+ *
* <p>
* Bean maps can also be defined on top of beans with read-only properties by adding a
* {@link BeanConstructor @BeanConstructor} annotation to one of the constructors on the
* bean class. This will allow read-only properties to be set through constructor arguments.
+ *
* <p>
* When the <code>@BeanConstructor</code> annotation is present, bean instantiation is delayed until the call to
* {@link BeanMap#getBean()}.
* Until then, bean property values are stored in a local cache until <code>getBean()</code> is called.
* Because of this additional caching step, parsing into read-only beans tends to be slower and use more memory than
* parsing into beans with writable properties.
+ *
* <p>
* Attempting to call {@link BeanMap#put(String,Object)} on a read-only property after calling {@link BeanMap#getBean()}
* will result in a {@link BeanRuntimeException} being thrown.
* Multiple calls to {@link BeanMap#getBean()} will return the same bean instance.
+ *
* <p>
* Beans can be defined with a combination of read-only and read-write properties.
+ *
* <p>
* See {@link BeanConstructor @BeanConstructor} for more information.
*
* <h5 class='topic'>BeanFilters and PojoSwaps</h5>
+ *
* <p>
* {@link BeanFilter BeanFilters} and {@link PojoSwap PojoSwaps} are used to tailor how beans and POJOs are handled.
* <ol class='spaced-list'>
- * <li>{@link BeanFilter} - Allows you to tailor handling of bean classes.
+ * <li>
+ * {@link BeanFilter} - Allows you to tailor handling of bean classes.
* This class can be considered a programmatic equivalent to the {@link Bean} annotation when
* annotating classes are not possible (e.g. you don't have access to the source).
* This includes specifying which properties are visible and the ability to programmatically override the
* execution of properties.
- * <li>{@link PojoSwap} - Allows you to swap out non-serializable objects with serializable replacements.
+ * <li>
+ * {@link PojoSwap} - Allows you to swap out non-serializable objects with serializable replacements.
* </ol>
+ *
* <p>
* See <a class='doclink' href='transform/package-summary.html#TOC'>org.apache.juneau.transform</a> for more
* information.
*
* <h5 class='topic'>ClassMetas</h5>
+ *
* <p>
* The {@link ClassMeta} class is a wrapper around {@link Class} object that provides cached information about that
* class (e.g. whether it's a {@link Map} or {@link Collection} or bean).
+ *
* <p>
* As a general rule, it's best to reuse bean contexts (and therefore serializers and parsers too) whenever possible
* since it takes some time to populate the internal {@code ClassMeta} object cache.
* By reusing bean contexts, the class type metadata only needs to be calculated once which significantly improves
* performance.
+ *
* <p>
* See {@link ClassMeta} for more information.
*/
@@ -204,6 +240,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Beans require no-arg constructors.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireDefaultConstructor"</js>
@@ -211,8 +248,10 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, a Java class must implement a default no-arg constructor to be considered a bean.
+ *
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
*/
@@ -220,6 +259,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Beans require {@link Serializable} interface.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSerializable"</js>
@@ -227,8 +267,10 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, a Java class must implement the {@link Serializable} interface to be considered a bean.
+ *
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
*/
@@ -236,6 +278,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Beans require setters for getters.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSettersForGetters"</js>
@@ -243,6 +286,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, only getters that have equivalent setters will be considered as properties on a bean.
* Otherwise, they will be ignored.
@@ -251,6 +295,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Beans require at least one property.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSomeProperties"</js>
@@ -258,8 +303,10 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, then a Java class must contain at least 1 property to be considered a bean.
+ *
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
*/
@@ -268,6 +315,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
* value.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanMapPutReturnsOldValue"</js>
@@ -275,9 +323,11 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
* values.
+ *
* <p>
* Disabled by default because it introduces a slight performance penalty.
*/
@@ -285,6 +335,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Look for bean constructors with the specified minimum visibility.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanConstructorVisibility"</js>
@@ -292,12 +343,12 @@ public class BeanContext extends Context {
* <li><b>Default:</b> {@link Visibility#PUBLIC}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
- * <p>
*/
public static final String BEAN_beanConstructorVisibility = "BeanContext.beanConstructorVisibility";
/**
* <b>Configuration property:</b> Look for bean classes with the specified minimum visibility.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanClassVisibility"</js>
@@ -305,15 +356,17 @@ public class BeanContext extends Context {
* <li><b>Default:</b> {@link Visibility#PUBLIC}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Classes are not considered beans unless they meet the minimum visibility requirements.
- * For example, if the visibility is <code>PUBLIC</code> and the bean class is <jk>protected</jk>, then
- * the class will not be interpreted as a bean class.
+ * For example, if the visibility is <code>PUBLIC</code> and the bean class is <jk>protected</jk>, then the class
+ * will not be interpreted as a bean class.
*/
public static final String BEAN_beanClassVisibility = "BeanContext.beanClassVisibility";
/**
* <b>Configuration property:</b> Look for bean fields with the specified minimum visibility.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFieldVisibility"</js>
@@ -321,10 +374,12 @@ public class BeanContext extends Context {
* <li><b>Default:</b> {@link Visibility#PUBLIC}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Fields are not considered bean properties unless they meet the minimum visibility requirements.
- * For example, if the visibility is <code>PUBLIC</code> and the bean field is <jk>protected</jk>, then
- * the field will not be interpreted as a bean property.
+ * For example, if the visibility is <code>PUBLIC</code> and the bean field is <jk>protected</jk>, then the field
+ * will not be interpreted as a bean property.
+ *
* <p>
* Use {@link Visibility#NONE} to prevent bean fields from being interpreted as bean properties altogether.
*/
@@ -332,6 +387,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Look for bean methods with the specified minimum visibility.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.methodVisibility"</js>
@@ -339,15 +395,17 @@ public class BeanContext extends Context {
* <li><b>Default:</b> {@link Visibility#PUBLIC}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Methods are not considered bean getters/setters unless they meet the minimum visibility requirements.
- * For example, if the visibility is <code>PUBLIC</code> and the bean method is <jk>protected</jk>, then
- * the method will not be interpreted as a bean getter or setter.
+ * For example, if the visibility is <code>PUBLIC</code> and the bean method is <jk>protected</jk>, then the method
+ * will not be interpreted as a bean getter or setter.
*/
public static final String BEAN_methodVisibility = "BeanContext.methodVisibility";
/**
* <b>Configuration property:</b> Use Java {@link Introspector} for determining bean properties.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useJavaBeanIntrospector"</js>
@@ -355,6 +413,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
* Most {@link Bean @Bean} annotations will be ignored.
@@ -363,6 +422,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Use interface proxies.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useInterfaceProxies"</js>
@@ -370,6 +430,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an
* {@link InvocationHandler} if there is no other way of instantiating them.
@@ -378,6 +439,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Ignore unknown properties.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownBeanProperties"</js>
@@ -385,6 +447,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, trying to set a value on a non-existent bean property will silently be ignored.
* Otherwise, a {@code RuntimeException} is thrown.
@@ -393,6 +456,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Ignore unknown properties with null values.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownNullBeanProperties"</js>
@@ -400,6 +464,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, trying to set a <jk>null</jk> value on a non-existent bean property will silently be ignored.
* Otherwise, a {@code RuntimeException} is thrown.
@@ -408,6 +473,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Ignore properties without setters.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignorePropertiesWithoutSetters"</js>
@@ -415,6 +481,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, trying to set a value on a bean property without a setter will silently be ignored.
* Otherwise, a {@code RuntimeException} is thrown.
@@ -423,6 +490,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Ignore invocation errors on getters.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnGetters"</js>
@@ -430,6 +498,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
@@ -438,6 +507,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Ignore invocation errors on setters.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnSetters"</js>
@@ -445,6 +515,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
@@ -453,6 +524,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Sort bean properties in alphabetical order.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.sortProperties"</js>
@@ -460,12 +532,13 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order.
- * Otherwise, the natural order of the bean properties is used which is dependent on the
- * JVM vendor.
+ * Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
* On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.
* On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs).
+ *
* <p>
* This property is disabled by default so that IBM JVM users don't have to use {@link Bean @Bean} annotations
* to force bean properties to be in a particular order and can just alter the order of the fields/methods
@@ -475,6 +548,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Packages whose classes should not be considered beans.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanPackages.set"</js>
@@ -492,10 +566,13 @@ public class BeanContext extends Context {
* </ul>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* When specified, the current list of ignore packages are appended to.
+ *
* <p>
* Any classes within these packages will be serialized to strings using {@link Object#toString()}.
+ *
* <p>
* Note that you can specify prefix patterns to include all subpackages.
*/
@@ -513,6 +590,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Classes to be excluded from consideration as being beans.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanClasses.set"</js>
@@ -520,9 +598,10 @@ public class BeanContext extends Context {
* <li><b>Default:</b> empty set
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
- * Not-bean classes are typically converted to <code>Strings</code> during serialization even if they
- * appear to be bean-like.
+ * Not-bean classes are typically converted to <code>Strings</code> during serialization even if they appear to be
+ * bean-like.
*/
public static final String BEAN_notBeanClasses = "BeanContext.notBeanClasses.set";
@@ -538,6 +617,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Bean filters to apply to beans.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFilters.list"</js>
@@ -545,16 +625,20 @@ public class BeanContext extends Context {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* This is a programmatic equivalent to the {@link Bean @Bean} annotation.
- * It's useful when you want to use the Bean annotation functionality, but you don't have the ability
- * to alter the bean classes.
+ * It's useful when you want to use the Bean annotation functionality, but you don't have the ability to alter the
+ * bean classes.
+ *
* <p>
* There are two category of classes that can be passed in through this method:
* <ul class='spaced-list'>
- * <li>Subclasses of {@link BeanFilterBuilder}.
+ * <li>
+ * Subclasses of {@link BeanFilterBuilder}.
* These must have a public no-arg constructor.
- * <li>Bean interface classes.
+ * <li>
+ * Bean interface classes.
* A shortcut for defining a {@link InterfaceBeanFilterBuilder}.
* Any subclasses of an interface class will only have properties defined on the interface.
* All other bean properties will be ignored.
@@ -574,6 +658,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> POJO swaps to apply to Java objects.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.pojoSwaps.list"</js>
@@ -581,6 +666,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* There are two category of classes that can be passed in through this method:
* <ul>
@@ -602,6 +688,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Implementation classes for interfaces and abstract classes.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.implClasses.map"</js>
@@ -609,10 +696,11 @@ public class BeanContext extends Context {
* <li><b>Default:</b> empty map
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
- * For interfaces and abstract classes this method can be used to specify an implementation
- * class for the interface/abstract class so that instances of the implementation
- * class are used when instantiated (e.g. during a parse).
+ * For interfaces and abstract classes this method can be used to specify an implementation class for the
+ * interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a
+ * parse).
*/
public static final String BEAN_implClasses = "BeanContext.implClasses.map";
@@ -623,6 +711,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Explicitly specify visible bean properties.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.includeProperties"</js>
@@ -630,15 +719,19 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <code>{}</code>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Specifies to only include the specified list of properties for the specified bean classes.
+ *
* <p>
* The keys are either fully-qualified or simple class names, and the values are comma-delimited lists of property
* names.
* The key <js>"*"</js> means all bean classes.
+ *
* <p>
* For example, <code>{Bean1:<js>'foo,bar'</js>}</code> means only serialize the <code>foo</code> and
* <code>bar</code> properties on the specified bean.
+ *
* <p>
* Setting applies to specified class and all subclasses.
*/
@@ -651,6 +744,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Exclude specified properties from beans.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.excludeProperties"</js>
@@ -658,15 +752,19 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <code>{}</code>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Specifies to exclude the specified list of properties for the specified bean class.
+ *
* <p>
* The keys are either fully-qualified or simple class names, and the values are comma-delimited lists of property
* names.
* The key <js>"*"</js> means all bean classes.
+ *
* <p>
* For example, <code>{Bean1:<js>'foo,bar'</js>}</code> means don't serialize the <code>foo</code> and
* <code>bar</code> properties on the specified bean.
+ *
* <p>
* Setting applies to specified class and all subclasses.
*/
@@ -679,6 +777,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Bean lookup dictionary.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanDictionary.list"</js>
@@ -686,6 +785,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* This list can consist of the following class types:
* <ul>
@@ -710,6 +810,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Name to use for the bean type properties used to represent a bean type.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanTypePropertyName"</js>
@@ -717,12 +818,12 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <js>"_type"</js>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
- * <p>
*/
public static final String BEAN_beanTypePropertyName = "BeanContext.beanTypePropertyName";
/**
* <b>Configuration property:</b> Default parser to use when converting <code>Strings</code> to POJOs.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.defaultParser"</js>
@@ -730,6 +831,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> {@link JsonSerializer}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Used in the in the {@link BeanSession#convertToType(Object, Class)} method.
*/
@@ -737,6 +839,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Locale.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.locale"</js>
@@ -744,6 +847,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <code>Locale.getDefault()</code>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Used in the in the {@link BeanSession#convertToType(Object, Class)} method.ß
*/
@@ -751,6 +855,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> TimeZone.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.timeZone"</js>
@@ -758,6 +863,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Used in the in the {@link BeanSession#convertToType(Object, Class)} method.ß
*/
@@ -765,6 +871,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Media type.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.mediaType"</js>
@@ -772,6 +879,7 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Specifies a default media type value for serializer and parser sessions.
*/
@@ -779,6 +887,7 @@ public class BeanContext extends Context {
/**
* <b>Configuration property:</b> Debug mode.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.debug"</js>
@@ -786,17 +895,22 @@ public class BeanContext extends Context {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Enables the following additional information during serialization:
* <ul class='spaced-list'>
- * <li>When bean getters throws exceptions, the exception includes the object stack information
+ * <li>
+ * When bean getters throws exceptions, the exception includes the object stack information
* in order to determine how that method was invoked.
- * <li>Enables {@link SerializerContext#SERIALIZER_detectRecursions}.
+ * <li>
+ * Enables {@link SerializerContext#SERIALIZER_detectRecursions}.
* </ul>
+ *
* <p>
* Enables the following additional information during parsing:
* <ul class='spaced-list'>
- * <li>When bean setters throws exceptions, the exception includes the object stack information
+ * <li>
+ * When bean setters throws exceptions, the exception includes the object stack information
* in order to determine how that method was invoked.
* </ul>
*/
@@ -901,6 +1015,7 @@ public class BeanContext extends Context {
/**
* Constructor.
+ *
* <p>
* Typically only called from {@link PropertyStore#getContext(Class)} or {@link PropertyStore#getBeanContext()}.
*
@@ -1003,15 +1118,18 @@ public class BeanContext extends Context {
/**
* Create a new bean session based on the properties defined on this context.
*
- * @param op The override properties.
- * This map can contain values to override properties defined on this context.
- * Note that only session-overridable settings can be overridden.
- * @param locale The bean session locale.
- * Typically used by {@link PojoSwap PojoSwaps} to provide locale-specific output.
- * If <jk>null</jk>, the system default locale is assumed.
- * @param timeZone The bean session timezone.
- * Typically used by time-sensitive {@link PojoSwap PojoSwaps} to provide timezone-specific output.
- * If <jk>null</jk> the system default timezone is assumed on {@link java.util.Date} objects, or the
+ * @param op
+ * The override properties.
+ * This map can contain values to override properties defined on this context.
+ * Note that only session-overridable settings can be overridden.
+ * @param locale
+ * The bean session locale.
+ * Typically used by {@link PojoSwap PojoSwaps} to provide locale-specific output.
+ * If <jk>null</jk>, the system default locale is assumed.
+ * @param timeZone
+ * The bean session timezone.
+ * Typically used by time-sensitive {@link PojoSwap PojoSwaps} to provide timezone-specific output.
+ * If <jk>null</jk> the system default timezone is assumed on {@link java.util.Date} objects, or the
* locale specified on {@link Calendar} objects are used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
* @return A new session object.
@@ -1022,6 +1140,7 @@ public class BeanContext extends Context {
/**
* Create a new bean session based on the properties defined on this context.
+ *
* <p>
* Use this method for creating sessions if you don't need to override any
* properties or locale/timezone currently set on this context.
@@ -1034,6 +1153,8 @@ public class BeanContext extends Context {
/**
* Returns <jk>true</jk> if the specified bean context shares the same cache as this bean context.
+ *
+ * <p>
* Useful for testing purposes.
*
* @param bc The bean context to compare to.
@@ -1044,8 +1165,8 @@ public class BeanContext extends Context {
}
/**
- * Determines whether the specified class is ignored as a bean class based on the various
- * exclusion parameters specified on this context class.
+ * Determines whether the specified class is ignored as a bean class based on the various exclusion parameters
+ * specified on this context class.
*
* @param c The class type being tested.
* @return <jk>true</jk> if the specified class matches any of the exclusion parameters.
@@ -1099,8 +1220,9 @@ public class BeanContext extends Context {
*
* @param <T> The class type to get the meta-data on.
* @param c The class to get the meta-data on.
- * @return The {@link BeanMeta} for the specified class, or <jk>null</jk> if the class
- * is not a bean per the settings on this context.
+ * @return
+ * The {@link BeanMeta} for the specified class, or <jk>null</jk> if the class is not a bean per the settings on
+ * this context.
*/
public final <T> BeanMeta<T> getBeanMeta(Class<T> c) {
if (c == null)
@@ -1113,8 +1235,9 @@ public class BeanContext extends Context {
*
* @param <T> The class type being wrapped.
* @param type The class to resolve.
- * @return If the class is not an array, returns a cached {@link ClassMeta} object.
- * Otherwise, returns a new {@link ClassMeta} object every time.
+ * @return
+ * If the class is not an array, returns a cached {@link ClassMeta} object.
+ * Otherwise, returns a new {@link ClassMeta} object every time.
*/
public final <T> ClassMeta<T> getClassMeta(Class<T> type) {
return getClassMeta(type, true);
@@ -1125,9 +1248,11 @@ public class BeanContext extends Context {
*
* @param <T> The class type being wrapped.
* @param type The class to resolve.
- * @param waitForInit If <jk>true</jk>, wait for the ClassMeta constructor to finish before returning.
- * @return If the class is not an array, returns a cached {@link ClassMeta} object.
- * Otherwise, returns a new {@link ClassMeta} object every time.
+ * @param waitForInit
+ * If <jk>true</jk>, wait for the ClassMeta constructor to finish before returning.
+ * @return
+ * If the class is not an array, returns a cached {@link ClassMeta} object.
+ * Otherwise, returns a new {@link ClassMeta} object every time.
*/
final <T> ClassMeta<T> getClassMeta(Class<T> type, boolean waitForInit) {
@@ -1159,10 +1284,13 @@ public class BeanContext extends Context {
/**
* Used to resolve <code>ClassMetas</code> of type <code>Collection</code> and <code>Map</code> that have
* <code>ClassMeta</code> values that themselves could be collections or maps.
+ *
* <p>
* <code>Collection</code> meta objects are assumed to be followed by zero or one meta objects indicating the element type.
+ *
* <p>
* <code>Map</code> meta objects are assumed to be followed by zero or two meta objects indicating the key and value types.
+ *
* <p>
* The array can be arbitrarily long to indicate arbitrarily complex data structures.
*
@@ -1182,10 +1310,12 @@ public class BeanContext extends Context {
* A map containing string keys and values of lists containing beans.
* </ul>
*
- * @param type The class to resolve.
+ * @param type
+ * The class to resolve.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
* {@link GenericArrayType}
- * @param args The type arguments of the class if it's a collection or map.
+ * @param args
+ * The type arguments of the class if it's a collection or map.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
* {@link GenericArrayType}
* <br>Ignored if the main type is not a map or collection.
@@ -1388,9 +1518,10 @@ public class BeanContext extends Context {
* @param <T> The class type we're wrapping.
* @param p The property annotation on the type if there is one.
* @param t The type.
- * @param typeVarImpls Contains known resolved type parameters on the specified class so that we can result
- * {@code ParameterizedTypes} and {@code TypeVariables}.
- * Can be <jk>null</jk> if the information is not known.
+ * @param typeVarImpls
+ * Contains known resolved type parameters on the specified class so that we can result
+ * {@code ParameterizedTypes} and {@code TypeVariables}.
+ * Can be <jk>null</jk> if the information is not known.
* @return The new {@code ClassMeta} object wrapped around the {@code Type} object.
*/
protected final <T> ClassMeta<T> resolveClassMeta(BeanProperty p, Type t, Map<Class<?>,Class<?>[]> typeVarImpls) {
@@ -1440,8 +1571,8 @@ public class BeanContext extends Context {
}
/**
- * Returns the {@link PojoSwap} associated with the specified class, or <jk>null</jk> if there is no
- * POJO swap associated with the class.
+ * Returns the {@link PojoSwap} associated with the specified class, or <jk>null</jk> if there is no POJO swap
+ * associated with the class.
*
* @param <T> The class associated with the swap.
* @param c The class associated with the swap.
@@ -1458,6 +1589,7 @@ public class BeanContext extends Context {
/**
* Checks whether a class has a {@link PojoSwap} associated with it in this bean context.
+ *
* @param c The class to check.
* @return <jk>true</jk> if the specified class or one of its subclasses has a {@link PojoSwap} associated with it.
*/
@@ -1476,8 +1608,8 @@ public class BeanContext extends Context {
}
/**
- * Returns the {@link BeanFilter} associated with the specified class, or <jk>null</jk> if there is no
- * bean filter associated with the class.
+ * Returns the {@link BeanFilter} associated with the specified class, or <jk>null</jk> if there is no bean filter
+ * associated with the class.
*
* @param <T> The class associated with the bean filter.
* @param c The class associated with the bean filter.
@@ -1599,12 +1731,13 @@ public class BeanContext extends Context {
/**
* Returns a reusable {@link ClassMeta} representation for the class <code>Object</code>.
+ *
* <p>
- * This <code>ClassMeta</code> is often used to represent "any object type" when an object type
- * is not known.
+ * This <code>ClassMeta</code> is often used to represent "any object type" when an object type is not known.
+ *
* <p>
- * This method is identical to calling <code>getClassMeta(Object.<jk>class</jk>)</code> but uses
- * a cached copy to avoid a hashmap lookup.
+ * This method is identical to calling <code>getClassMeta(Object.<jk>class</jk>)</code> but uses a cached copy to
+ * avoid a hashmap lookup.
*
* @return The {@link ClassMeta} object associated with the <code>Object</code> class.
*/
@@ -1614,11 +1747,13 @@ public class BeanContext extends Context {
/**
* Returns a reusable {@link ClassMeta} representation for the class <code>String</code>.
+ *
* <p>
* This <code>ClassMeta</code> is often used to represent key types in maps.
+ *
* <p>
- * This method is identical to calling <code>getClassMeta(String.<jk>class</jk>)</code> but uses
- * a cached copy to avoid a hashmap lookup.
+ * This method is identical to calling <code>getClassMeta(String.<jk>class</jk>)</code> but uses a cached copy to
+ * avoid a hashmap lookup.
*
* @return The {@link ClassMeta} object associated with the <code>String</code> class.
*/
@@ -1628,11 +1763,13 @@ public class BeanContext extends Context {
/**
* Returns a reusable {@link ClassMeta} representation for the class <code>Class</code>.
+ *
* <p>
* This <code>ClassMeta</code> is often used to represent key types in maps.
+ *
* <p>
- * This method is identical to calling <code>getClassMeta(Class.<jk>class</jk>)</code> but uses
- * a cached copy to avoid a hashmap lookup.
+ * This method is identical to calling <code>getClassMeta(Class.<jk>class</jk>)</code> but uses a cached copy to
+ * avoid a hashmap lookup.
*
* @return The {@link ClassMeta} object associated with the <code>String</code> class.
*/
@@ -1687,4 +1824,4 @@ public class BeanContext extends Context {
.append("excludeProperties", excludeProperties)
);
}
-}
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryList.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryList.java b/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryList.java
index de0c084..6362f38 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryList.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryList.java
@@ -18,6 +18,7 @@ import org.apache.juneau.annotation.*;
/**
* Represents a collection of bean classes that make up a bean dictionary.
+ *
* <p>
* The classes in the list must be one of the following:
* <ul>
@@ -25,6 +26,7 @@ import org.apache.juneau.annotation.*;
* <li>Other subclasses of {@link BeanDictionaryList}.
* <li>Other subclasses of {@link BeanDictionaryMap}.
* </ul>
+ *
* <p>
* Subclasses must implement a public no-arg constructor so that it can be instantiated by the bean context code.
*/
@@ -34,9 +36,10 @@ public class BeanDictionaryList extends ArrayList<Class<?>> {
/**
* Constructor.
*
- * @param c The list of bean classes to add to this dictionary.
- * Classes must either specify a {@link Bean#typeName()} value or be another subclass of
- * <code>BeanDictionaryList</code>.
+ * @param c
+ * The list of bean classes to add to this dictionary.
+ * Classes must either specify a {@link Bean#typeName()} value or be another subclass of
+ * <code>BeanDictionaryList</code>.
*/
public BeanDictionaryList(Class<?>...c) {
append(c);
@@ -45,9 +48,10 @@ public class BeanDictionaryList extends ArrayList<Class<?>> {
/**
* Append one or more bean classes to this bean dictionary.
*
- * @param c The list of bean classes to add to this dictionary.
- * Classes must either specify a {@link Bean#typeName()} value or be another subclass of
- * <code>BeanDictionaryList</code>.
+ * @param c
+ * The list of bean classes to add to this dictionary.
+ * Classes must either specify a {@link Bean#typeName()} value or be another subclass of
+ * <code>BeanDictionaryList</code>.
* @return This object (for method chaining).
*/
protected BeanDictionaryList append(Class<?>...c) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryMap.java b/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryMap.java
index b6bd314..4416909 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanDictionaryMap.java
@@ -19,9 +19,11 @@ import org.apache.juneau.annotation.*;
/**
* Represents a map of dictionary type names to bean classes that make up a bean dictionary.
+ *
* <p>
- * In general, this approach for defining dictionary names for classes is used when it's not possible
- * to use the {@link Bean#typeName()} annotation.
+ * In general, this approach for defining dictionary names for classes is used when it's not possible to use the
+ * {@link Bean#typeName()} annotation.
+ *
* <p>
* Subclasses must implement a public no-arg constructor so that it can be instantiated by the bean context code.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/BeanMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanMap.java b/juneau-core/src/main/java/org/apache/juneau/BeanMap.java
index 5e2279c..fe97e09 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanMap.java
@@ -30,6 +30,7 @@ import org.apache.juneau.xml.annotation.*;
* <p>
* A wrapper that wraps Java bean instances inside of a {@link Map} interface that allows properties on the wrapped
* object can be accessed using the {@link Map#get(Object) get()} and {@link Map#put(Object,Object) put()} methods.
+ *
* <p>
* Use the {@link BeanContext} class to create instances of this class.
*
@@ -38,13 +39,16 @@ import org.apache.juneau.xml.annotation.*;
* The order of the properties returned by the {@link Map#keySet() keySet()} and {@link Map#entrySet() entrySet()}
* methods are as follows:
* <ul class='spaced-list'>
- * <li>If {@link Bean @Bean} annotation is specified on class, then the order is the same as the list of properties
+ * <li>
+ * If {@link Bean @Bean} annotation is specified on class, then the order is the same as the list of properties
* in the annotation.
- * <li>If {@link Bean @Bean} annotation is not specified on the class, then the order is the same as that returned
+ * <li>
+ * If {@link Bean @Bean} annotation is not specified on the class, then the order is the same as that returned
* by the {@link java.beans.BeanInfo} class (i.e. ordered by definition in the class).
* </ul>
- * <br>
- * The order can also be overridden through the use of a {@link BeanFilter}.
+ *
+ * <p>
+ * <br>The order can also be overridden through the use of a {@link BeanFilter}.
*
* <h6 class='topic'>POJO swaps</h6>
* <p>
@@ -107,8 +111,10 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the wrapped bean object.
- * Triggers bean creation if bean has read-only properties set through a constructor
- * defined by the {@link BeanConstructor} annotation.
+ *
+ * <p>
+ * Triggers bean creation if bean has read-only properties set through a constructor defined by the
+ * {@link BeanConstructor} annotation.
*
* @return The inner bean object.
*/
@@ -134,14 +140,14 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the wrapped bean object.
+ *
* <p>
- * If <code>create</code> is <jk>false</jk>, then this method may return <jk>null</jk>
- * if the bean has read-only properties set through a constructor
- * defined by the {@link BeanConstructor} annotation.
+ * If <code>create</code> is <jk>false</jk>, then this method may return <jk>null</jk> if the bean has read-only
+ * properties set through a constructor defined by the {@link BeanConstructor} annotation.
+ *
* <p>
* This method does NOT always return the bean in it's final state.
- * Array properties temporary stored as ArrayLists are not finalized
- * until the {@link #getBean()} method is called.
+ * Array properties temporary stored as ArrayLists are not finalized until the {@link #getBean()} method is called.
*
* @param create If bean hasn't been instantiated yet, then instantiate it.
* @return The inner bean object.
@@ -170,13 +176,14 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Sets a property on the bean.
+ *
* <p>
- * If there is a {@link PojoSwap} associated with this bean property or bean property type class, then
- * you must pass in a transformed value.
+ * If there is a {@link PojoSwap} associated with this bean property or bean property type class, then you must pass
+ * in a transformed value.
* For example, if the bean property type class is a {@link Date} and the bean property has the
- * {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
- * {@link BeanProperty#swap() @BeanProperty.swap()} annotation, the value being passed in must be
- * a String containing an ISO8601 date-time string value.
+ * {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
+ * {@link BeanProperty#swap() @BeanProperty.swap()} annotation, the value being passed in must be
+ * a String containing an ISO8601 date-time string value.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -195,15 +202,17 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
*
* @param property The name of the property to set.
* @param value The value to set the property to.
- * @return If the bean context setting {@code beanMapPutReturnsOldValue} is <jk>true</jk>, then the old value of the
- * property is returned.
- * Otherwise, this method always returns <jk>null</jk>.
- * @throws RuntimeException if any of the following occur.
- * <ul class='spaced-list'>
- * <li>BeanMapEntry does not exist on the underlying object.
- * <li>Security settings prevent access to the underlying object setter method.
- * <li>An exception occurred inside the setter method.
- * </ul>
+ * @return
+ * If the bean context setting {@code beanMapPutReturnsOldValue} is <jk>true</jk>, then the old value of the
+ * property is returned.
+ * Otherwise, this method always returns <jk>null</jk>.
+ * @throws
+ * RuntimeException if any of the following occur.
+ * <ul>
+ * <li>BeanMapEntry does not exist on the underlying object.
+ * <li>Security settings prevent access to the underlying object setter method.
+ * <li>An exception occurred inside the setter method.
+ * </ul>
*/
@Override /* Map */
public Object put(String property, Object value) {
@@ -225,9 +234,10 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Add a value to a collection or array property.
+ *
* <p>
- * As a general rule, adding to arrays is not recommended since the array must be recreate each time
- * this method is called.
+ * As a general rule, adding to arrays is not recommended since the array must be recreate each time this method is
+ * called.
*
* @param property Property name or child-element name (if {@link Xml#childName()} is specified).
* @param value The value to add to the collection or array.
@@ -245,13 +255,14 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Gets a property on the bean.
+ *
* <p>
- * If there is a {@link PojoSwap} associated with this bean property or bean property type class, then
- * this method will return the transformed value.
+ * If there is a {@link PojoSwap} associated with this bean property or bean property type class, then this method
+ * will return the transformed value.
* For example, if the bean property type class is a {@link Date} and the bean property has the
- * {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
- * {@link BeanProperty#swap() @BeanProperty.swap()} annotation, this method will return a String
- * containing an ISO8601 date-time string value.
+ * {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
+ * {@link BeanProperty#swap() @BeanProperty.swap()} annotation, this method will return a String containing an
+ * ISO8601 date-time string value.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -270,7 +281,8 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
* </p>
*
* @param property The name of the property to get.
- * @throws RuntimeException if any of the following occur.
+ * @throws
+ * RuntimeException if any of the following occur.
* <ol>
* <li>BeanMapEntry does not exist on the underlying object.
* <li>Security settings prevent access to the underlying object getter method.
@@ -289,8 +301,8 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
}
/**
- * Same as {@link #get(Object)} except bypasses the POJO filter associated with the bean property or
- * bean filter associated with the bean class.
+ * Same as {@link #get(Object)} except bypasses the POJO filter associated with the bean property or bean filter
+ * associated with the bean class.
*
* @param property The name of the property to get.
* @return The raw property value.
@@ -305,10 +317,11 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Convenience method for setting multiple property values by passing in JSON (or other) text.
+ *
* <p>
- * Typically the input is going to be JSON, although the actual data type
- * depends on the default parser specified by the {@link BeanContext#BEAN_defaultParser} property
- * value on the config that created the context that created this map.
+ * Typically the input is going to be JSON, although the actual data type depends on the default parser specified by
+ * the {@link BeanContext#BEAN_defaultParser} property value on the config that created the context that created
+ * this map.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -340,6 +353,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Convenience method for loading this map with the contents of the specified map.
+ *
* <p>
* Identical to {@link #putAll(Map)} except as a fluent-style method.
*
@@ -354,6 +368,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the names of all properties associated with the bean.
+ *
* <p>
* The returned set is unmodifiable.
*/
@@ -375,13 +390,13 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the specified property on this bean map.
+ *
* <p>
- * Allows you to get and set an individual property on a bean without having a
- * handle to the bean itself by using the {@link BeanMapEntry#getValue()}
- * and {@link BeanMapEntry#setValue(Object)} methods.
+ * Allows you to get and set an individual property on a bean without having a handle to the bean itself by using
+ * the {@link BeanMapEntry#getValue()} and {@link BeanMapEntry#setValue(Object)} methods.
+ *
* <p>
- * This method can also be used to get metadata on a property by
- * calling the {@link BeanMapEntry#getMeta()} method.
+ * This method can also be used to get metadata on a property by calling the {@link BeanMapEntry#getMeta()} method.
*
* @param propertyName The name of the property to look up.
* @return The bean property, or null if the bean has no such property.
@@ -418,14 +433,15 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Invokes all the getters on this bean and return the values as a list of {@link BeanPropertyValue} objects.
+ *
* <p>
* This allows a snapshot of all values to be grabbed from a bean in one call.
*
* @param ignoreNulls
- * Don't return properties whose values are null.
+ * Don't return properties whose values are null.
* @param prependVals
- * Additional bean property values to prepended to this list.
- * Any <jk>null</jk> values in this list will be ignored.
+ * Additional bean property values to prepended to this list.
+ * Any <jk>null</jk> values in this list will be ignored.
* @return The list of all bean property values.
*/
public List<BeanPropertyValue> getValues(final boolean ignoreNulls, BeanPropertyValue...prependVals) {
@@ -461,8 +477,8 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
}
/**
- * Given a string containing variables of the form <code>"{property}"</code>, replaces those variables with
- * property values in this bean.
+ * Given a string containing variables of the form <code>"{property}"</code>, replaces those variables with property
+ * values in this bean.
*
* @param s The string containing variables.
* @return A new string with variables replaced, or the same string if no variables were found.
@@ -473,6 +489,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns a simple collection of properties for this bean map.
+ *
* @return A simple collection of properties for this bean map.
*/
protected Collection<BeanPropertyMeta> getProperties() {
@@ -481,6 +498,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns all the properties associated with the bean.
+ *
* @return A new set.
*/
@Override
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/BeanMapEntry.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanMapEntry.java b/juneau-core/src/main/java/org/apache/juneau/BeanMapEntry.java
index 076bdb6..0818b33 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanMapEntry.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanMapEntry.java
@@ -19,6 +19,7 @@ import org.apache.juneau.transform.*;
/**
* Represents a single entry in a bean map.
+ *
* <p>
* This class can be used to get and set property values on a bean, or to get metadata on a property.
*
@@ -65,13 +66,14 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
/**
* Returns the value of this property.
+ *
* <p>
- * If there is a {@link PojoSwap} associated with this bean property or bean property type class, then
- * this method will return the transformed value.
+ * If there is a {@link PojoSwap} associated with this bean property or bean property type class, then this method
+ * will return the transformed value.
* For example, if the bean property type class is a {@link Date} and the bean property has the
- * {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
- * {@link BeanProperty#swap() @BeanProperty.swap()} annotation, this method will return a String
- * containing an ISO8601 date-time string value.
+ * {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
+ * {@link BeanProperty#swap() @BeanProperty.swap()} annotation, this method will return a String containing an
+ * ISO8601 date-time string value.
*/
@Override /* Map.Entry */
public Object getValue() {
@@ -80,18 +82,21 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
/**
* Sets the value of this property.
+ *
* <p>
* If the property is an array of type {@code X}, then the value can be a {@code Collection<X>} or {@code X[]} or
* {@code Object[]}.
+ *
* <p>
* If the property is a bean type {@code X}, then the value can either be an {@code X} or a {@code Map}.
+ *
* <p>
- * If there is a {@link PojoSwap} associated with this bean property or bean property type class, then
- * you must pass in a transformed value.
+ * If there is a {@link PojoSwap} associated with this bean property or bean property type class, then you must pass
+ * in a transformed value.
* For example, if the bean property type class is a {@link Date} and the bean property has the
- * {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
- * {@link BeanProperty#swap() @BeanProperty.swap()} annotation, the value being passed in must be
- * a String containing an ISO8601 date-time string value.
+ * {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
+ * {@link BeanProperty#swap() @BeanProperty.swap()} annotation, the value being passed in must be a String
+ * containing an ISO8601 date-time string value.
*
* @return The set value after it's been converted.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/BeanMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanMeta.java b/juneau-core/src/main/java/org/apache/juneau/BeanMeta.java
index 136406e..1f14abb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanMeta.java
@@ -40,16 +40,19 @@ import org.apache.juneau.utils.*;
* <p>
* The order of the properties are as follows:
* <ul class='spaced-list'>
- * <li>If {@link Bean @Bean} annotation is specified on class, then the order is the same as the list of properties
+ * <li>
+ * If {@link Bean @Bean} annotation is specified on class, then the order is the same as the list of properties
* in the annotation.
- * <li>If {@link Bean @Bean} annotation is not specified on the class, then the order is based on the following.
+ * <li>
+ * If {@link Bean @Bean} annotation is not specified on the class, then the order is based on the following.
* <ul>
* <li>Public fields (same order as {@code Class.getFields()}).
* <li>Properties returned by {@code BeanInfo.getPropertyDescriptors()}.
* <li>Non-standard getters/setters with {@link BeanProperty @BeanProperty} annotation defined on them.
* </ul>
* </ul>
- * <br>
+ *
+ * <p>
* The order can also be overridden through the use of an {@link BeanFilter}.
*
* @param <T> The class type that this metadata applies to.
@@ -464,15 +467,15 @@ public class BeanMeta<T> {
/**
* Returns the dictionary name for this bean as defined through the {@link Bean#typeName()} annotation.
*
- * @return The dictioanry name for this bean, or <jk>null</jk> if it has no dictionary name defined.
+ * @return The dictionary name for this bean, or <jk>null</jk> if it has no dictionary name defined.
*/
public String getDictionaryName() {
return dictionaryName;
}
/**
- * Returns a mock bean property that resolves to the name <js>"_type"</js> and whose value always resolves
- * to the dictionary name of the bean.
+ * Returns a mock bean property that resolves to the name <js>"_type"</js> and whose value always resolves to the
+ * dictionary name of the bean.
*
* @return The type name property.
*/
@@ -685,8 +688,7 @@ public class BeanMeta<T> {
* Returns metadata about the specified property.
*
* @param name The name of the property on this bean.
- * @return The metadata about the property, or <jk>null</jk> if no such property exists
- * on this bean.
+ * @return The metadata about the property, or <jk>null</jk> if no such property exists on this bean.
*/
public BeanPropertyMeta getPropertyMeta(String name) {
BeanPropertyMeta bpm = properties.get(name);
@@ -725,8 +727,9 @@ public class BeanMeta<T> {
}
/**
- * Recursively determines the classes represented by parameterized types in the class hierarchy of
- * the specified type, and puts the results in the specified map.
+ * Recursively determines the classes represented by parameterized types in the class hierarchy of the specified
+ * type, and puts the results in the specified map.
+ *
* <p>
* For example, given the following classes...
* <p class='bcode'>
@@ -734,16 +737,21 @@ public class BeanMeta<T> {
* public T x;
* }
* public static class BeanB extends BeanA<Integer>} {...}
+ * </p>
* <p>
* ...calling this method on {@code BeanB.class} will load the following data into {@code m} indicating
* that the {@code T} parameter on the BeanA class is implemented with an {@code Integer}:
* <p class='bcode'>
* {BeanA.class:[Integer.class]}
+ * </p>
+ *
* <p>
* TODO: This code doesn't currently properly handle the following situation:
* <p class='bcode'>
* public static class BeanB<T extends Number> extends BeanA<T>;
* public static class BeanC extends BeanB<Integer>;
+ * </p>
+ *
* <p>
* When called on {@code BeanC}, the variable will be detected as a {@code Number}, not an {@code Integer}.
* If anyone can figure out a better way of doing this, please do so!
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/BeanMetaExtended.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanMetaExtended.java b/juneau-core/src/main/java/org/apache/juneau/BeanMetaExtended.java
index 6e169cb..f4c2eab 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanMetaExtended.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanMetaExtended.java
@@ -14,9 +14,10 @@ package org.apache.juneau;
/**
* Defines extended language-specific metadata associated with a bean.
+ *
* <p>
- * Serializers and parsers can implement their own language-specific metadata on a bean and retrieve
- * the metadata using the {@link BeanMeta#getExtendedMeta(Class)} method.
+ * Serializers and parsers can implement their own language-specific metadata on a bean and retrieve the metadata using
+ * the {@link BeanMeta#getExtendedMeta(Class)} method.
*/
public class BeanMetaExtended {
@@ -24,6 +25,7 @@ public class BeanMetaExtended {
/**
* Constructor.
+ *
* @param bm The metadata of the bean we're extending.
* @throws BeanRuntimeException If any error occurred trying to construct the metadata.
*/
@@ -33,6 +35,7 @@ public class BeanMetaExtended {
/**
* Returns the bean metadata that was passed into the constructor.
+ *
* @return The bean metadata that was passed into the constructor.
*/
protected BeanMeta<?> getBeanMeta() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/BeanMetaFiltered.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanMetaFiltered.java b/juneau-core/src/main/java/org/apache/juneau/BeanMetaFiltered.java
index 39f7e68..aae0d4b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanMetaFiltered.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanMetaFiltered.java
@@ -17,8 +17,8 @@ import java.util.*;
import org.apache.juneau.annotation.*;
/**
- * Sames as {@link BeanMeta}, except the list of bean properties are limited
- * by a {@link BeanProperty#properties()} annotation.
+ * Same as {@link BeanMeta}, except the list of bean properties are limited by a {@link BeanProperty#properties()}
+ * annotation.
*
* @param <T> The class type that this metadata applies to.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMeta.java b/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMeta.java
index 1933f82..36164c7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMeta.java
@@ -35,12 +35,14 @@ import org.apache.juneau.utils.*;
/**
* Contains metadata about a bean property.
+ *
* <p>
- * Contains information such as type of property (e.g. field/getter/setter), class type of property value,
- * and whether any transforms are associated with this property.
+ * Contains information such as type of property (e.g. field/getter/setter), class type of property value, and whether
+ * any transforms are associated with this property.
+ *
* <p>
- * Developers will typically not need access to this class. The information provided by it is already
- * exposed through several methods on the {@link BeanMap} API.
+ * Developers will typically not need access to this class. The information provided by it is already exposed through
+ * several methods on the {@link BeanMap} API.
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
public class BeanPropertyMeta {
@@ -330,9 +332,10 @@ public class BeanPropertyMeta {
/**
* Returns the {@link ClassMeta} of the class of this property.
+ *
* <p>
- * If this property or the property type class has a {@link PojoSwap} associated with it, this
- * method returns the transformed class meta.
+ * If this property or the property type class has a {@link PojoSwap} associated with it, this method returns the
+ * transformed class meta.
* This matches the class type that is used by the {@link #get(BeanMap,String)} and
* {@link #set(BeanMap,String,Object)} methods.
*
@@ -344,11 +347,14 @@ public class BeanPropertyMeta {
/**
* Returns the bean dictionary in use for this bean property.
+ *
+ * <p>
* The order of lookup for the dictionary is as follows:
* <ol>
* <li>Dictionary defined via {@link BeanProperty#beanDictionary()}.
* <li>Dictionary defined via {@link BeanContext#BEAN_beanDictionary} context property.
* </ol>
+ *
* @return The bean dictionary in use for this bean property. Never <jk>null</jk>.
*/
public BeanRegistry getBeanRegistry() {
@@ -357,9 +363,10 @@ public class BeanPropertyMeta {
/**
* Returns <jk>true</jk> if this bean property is a URI.
+ *
* <p>
* A bean property can be considered a URI if any of the following are true:
- * <ul class='spaced-list'>
+ * <ul>
* <li>Property class type is {@link URL} or {@link URI}.
* <li>Property class type is annotated with {@link org.apache.juneau.annotation.URI}.
* <li>Property getter, setter, or field is annotated with {@link org.apache.juneau.annotation.URI}.
@@ -373,6 +380,7 @@ public class BeanPropertyMeta {
/**
* Returns <jk>true</jk> if this bean property is named <js>"*"</js>.
+ *
* @return <jk>true</jk> if this bean property is named <js>"*"</js>.
*/
public boolean isDyna() {
@@ -491,8 +499,8 @@ public class BeanPropertyMeta {
}
/**
- * Equivalent to calling {@link BeanMap#put(String, Object)}, but is faster since it avoids
- * looking up the property meta.
+ * Equivalent to calling {@link BeanMap#put(String, Object)}, but is faster since it avoids looking up the property
+ * meta.
*
* @param m The bean map to set the property value on.
* @param pName The property name.
@@ -712,11 +720,15 @@ public class BeanPropertyMeta {
/**
* Returns the {@link Map} object returned by the DynaBean getter.
+ *
* <p>
- * The DynaBean property is the property whose name is <js>"*"</js> and returns a map of "extra" properties on the bean.
+ * The DynaBean property is the property whose name is <js>"*"</js> and returns a map of "extra" properties on the
+ * bean.
*
* @param bean The bean.
- * @return The map returned by the getter, or an empty map if the getter returned <jk>null</jk> or this isn't a DynaBean property.
+ * @return
+ * The map returned by the getter, or an empty map if the getter returned <jk>null</jk> or this isn't a DynaBean
+ * property.
* @throws IllegalArgumentException Thrown by method invocation.
* @throws IllegalAccessException Thrown by method invocation.
* @throws InvocationTargetException Thrown by method invocation.
@@ -734,6 +746,8 @@ public class BeanPropertyMeta {
/**
* Sets an array field on this bean.
+ *
+ * <p>
* Works on both <code>Object</code> and primitive arrays.
*
* @param bean The bean of the field.
@@ -749,8 +763,10 @@ public class BeanPropertyMeta {
/**
* Adds a value to a {@link Collection} or array property.
- * Note that adding values to an array property is inefficient for large
- * arrays since it must copy the array into a larger array on each operation.
+ *
+ * <p>
+ * Note that adding values to an array property is inefficient for large arrays since it must copy the array into a
+ * larger array on each operation.
*
* @param m The bean of the field being set.
* @param pName The property name.
@@ -904,9 +920,10 @@ public class BeanPropertyMeta {
/**
* Returns all instances of the specified annotation in the hierarchy of this bean property.
+ *
* <p>
- * Searches through the class hierarchy (e.g. superclasses, interfaces, packages) for all
- * instances of the specified annotation.
+ * Searches through the class hierarchy (e.g. superclasses, interfaces, packages) for all instances of the
+ * specified annotation.
*
* @param a The class to find annotations for.
* @return A list of annotations ordered in child-to-parent order. Never <jk>null</jk>.
@@ -932,6 +949,7 @@ public class BeanPropertyMeta {
/**
* Returns the specified annotation on the field or methods that define this property.
+ *
* <p>
* This method will search up the parent class/interface hierarchy chain to search for the annotation on
* overridden getters and setters.
@@ -1007,4 +1025,4 @@ public class BeanPropertyMeta {
public String toString() {
return name + ": " + this.rawTypeMeta.getInnerClass().getName() + ", field=["+field+"], getter=["+getter+"], setter=["+setter+"]";
}
-}
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanSession.java b/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
index 54b9fcc..b8ed6ec 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
@@ -188,8 +188,7 @@ public class BeanSession extends Session {
* <tr>
* <td>
* {@code Number} (e.g. {@code Integer}, {@code Short}, {@code Float},...)
- * <br>
- * <code>Number.<jsf>TYPE</jsf></code> (e.g. <code>Integer.<jsf>TYPE</jsf></code>,
+ * <br><code>Number.<jsf>TYPE</jsf></code> (e.g. <code>Integer.<jsf>TYPE</jsf></code>,
* <code>Short.<jsf>TYPE</jsf></code>, <code>Float.<jsf>TYPE</jsf></code>,...)
* </td>
* <td>
@@ -216,8 +215,7 @@ public class BeanSession extends Session {
* </td>
* <td>
* {@code Collection<Object>}
- * <br>
- * {@code Object[]}
+ * <br>{@code Object[]}
* </td>
* <td>
* If {@code Collection} is not constructible, a {@code ObjectList} is created.
@@ -238,10 +236,8 @@ public class BeanSession extends Session {
* </td>
* <td>
* {@code List<List<X>>}
- * <br>
- * {@code List<X[]>}
- * <br>
- * {@code List[]<X>}
+ * <br>{@code List<X[]>}
+ * <br>{@code List[]<X>}
* </td>
* <td> </td>
* </tr>
@@ -277,12 +273,9 @@ public class BeanSession extends Session {
* <tr>
* <td>
* Anything with one of the following methods:
- * <br>
- * <code><jk>public static</jk> T fromString(String)</code>
- * <br>
- * <code><jk>public static</jk> T valueOf(String)</code>
- * <br>
- * <code><jk>public</jk> T(String)</code>
+ * <br><code><jk>public static</jk> T fromString(String)</code>
+ * <br><code><jk>public static</jk> T valueOf(String)</code>
+ * <br><code><jk>public</jk> T(String)</code>
* </td>
* <td>
* <code>String</code>
@@ -791,7 +784,7 @@ public class BeanSession extends Session {
/**
* Creates a new empty bean of the specified type, except used for instantiating inner member classes that must
- * be instantiated within another class instance.
+ * be instantiated within another class instance.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -889,10 +882,12 @@ public class BeanSession extends Session {
* A map containing string keys and values of lists containing beans.
* </ul>
*
- * @param type The class to resolve.
+ * @param type
+ * The class to resolve.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
* {@link GenericArrayType}
- * @param args The type arguments of the class if it's a collection or map.
+ * @param args
+ * The type arguments of the class if it's a collection or map.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
* {@link GenericArrayType}
* <br>Ignored if the main type is not a map or collection.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java b/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
index 2c153de..7e7d640 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
@@ -1478,11 +1478,15 @@ public final class ClassMeta<T> implements Type {
* the underlying constructor is inaccessible.
* @throws IllegalArgumentException If one of the following occurs:
* <ul class='spaced-list'>
- * <li>The number of actual and formal parameters differ.
- * <li>An unwrapping conversion for primitive arguments fails.
- * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
+ * <li>
+ * The number of actual and formal parameters differ.
+ * <li>
+ * An unwrapping conversion for primitive arguments fails.
+ * <li>
+ * A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
* conversion.
- * <li>The constructor pertains to an enum type.
+ * <li>
+ * The constructor pertains to an enum type.
* </ul>
* @throws InstantiationException If the class that declares the underlying constructor represents an abstract class.
* @throws InvocationTargetException If the underlying constructor throws an exception.
@@ -1512,11 +1516,15 @@ public final class ClassMeta<T> implements Type {
* the underlying constructor is inaccessible.
* @throws IllegalArgumentException If one of the following occurs:
* <ul class='spaced-list'>
- * <li>The number of actual and formal parameters differ.
- * <li>An unwrapping conversion for primitive arguments fails.
- * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
+ * <li>
+ * The number of actual and formal parameters differ.
+ * <li>
+ * An unwrapping conversion for primitive arguments fails.
+ * <li>
+ * A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
* conversion.
- * <li>The constructor pertains to an enum type.
+ * <li>
+ * The constructor pertains to an enum type.
* </ul>
* @throws InstantiationException If the class that declares the underlying constructor represents an abstract class.
* @throws InvocationTargetException If the underlying constructor throws an exception.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/CoreObject.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/CoreObject.java b/juneau-core/src/main/java/org/apache/juneau/CoreObject.java
index 774c894..1d6fdce 100644
--- a/juneau-core/src/main/java/org/apache/juneau/CoreObject.java
+++ b/juneau-core/src/main/java/org/apache/juneau/CoreObject.java
@@ -86,7 +86,7 @@ public abstract class CoreObject {
/**
* Returns the universal <code>Object</code> metadata object.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>getBeanContext().object();</code>.
@@ -100,7 +100,7 @@ public abstract class CoreObject {
/**
* Returns the universal <code>String</code> metadata object.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>getBeanContext().string();</code>.
[05/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestContext.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestContext.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestContext.java
index c04c22d..99b3335 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestContext.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestContext.java
@@ -64,7 +64,8 @@ public final class RestContext extends Context {
* <li><b>Default:</b> <jk>true</jk>
* </ul>
* <p>
- * When enabled, headers such as <js>"Accept"</js> and <js>"Content-Type"</js> to be passed in as URL query parameters.
+ * When enabled, headers such as <js>"Accept"</js> and <js>"Content-Type"</js> to be passed in as URL query
+ * parameters.
* For example: <js>"?Accept=text/json&Content-Type=text/json"</js>
* <p>
* Parameter names are case-insensitive.
@@ -84,7 +85,8 @@ public final class RestContext extends Context {
* <li><b>Default:</b> <js>""</js>
* </ul>
* <p>
- * When specified, the HTTP method can be overridden by passing in a <js>"method"</js> URL parameter on a regular GET request.
+ * When specified, the HTTP method can be overridden by passing in a <js>"method"</js> URL parameter on a regular
+ * GET request.
* For example: <js>"?method=OPTIONS"</js>
* <p>
* Format is a comma-delimited list of HTTP method names that can be passed in as a method parameter.
@@ -92,8 +94,9 @@ public final class RestContext extends Context {
* Use "*" to represent all methods.
* For backwards compatibility, "true" also means "*".
* <p>
- * Note that per the <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html">HTTP specification</a>, special care should
- * be taken when allowing non-safe (POST, PUT, DELETE) methods to be invoked through GET requests.
+ * Note that per the <a class="doclink"
+ * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html">HTTP specification</a>, special care should
+ * be taken when allowing non-safe (POST, PUT, DELETE) methods to be invoked through GET requests.
* <p>
* Applicable to servlet class only.
* <p>
@@ -110,7 +113,8 @@ public final class RestContext extends Context {
* <li><b>Default:</b> <jk>true</jk>
* </ul>
* <p>
- * When enabled, the HTTP body content on PUT and POST requests can be passed in as text using the <js>"body"</js> URL parameter.
+ * When enabled, the HTTP body content on PUT and POST requests can be passed in as text using the <js>"body"</js>
+ * URL parameter.
* For example: <js>"?body={name:'John%20Smith',age:45}"</js>
* <p>
* Parameter name is case-insensitive.
@@ -149,7 +153,7 @@ public final class RestContext extends Context {
* </ul>
* <p>
* When enabled, the number of times an exception has occurred will be determined based on stack trace hashsums,
- * made available through the {@link RestException#getOccurrence()} method.
+ * made available through the {@link RestException#getOccurrence()} method.
* <p>
* Applicable to servlet class only.
*/
@@ -181,18 +185,21 @@ public final class RestContext extends Context {
* <p>
* Possible values:
* <ul class='spaced-list'>
- * <li><js>"UON"</js> - URL-Encoded Object Notation.<br>
- * This notation allows for request parameters to contain arbitrarily complex POJOs.
- * <li><js>"PLAIN"</js> - Plain text.<br>
- * This treats request parameters as plain text.<br>
- * Only POJOs directly convertable from <l>Strings</l> can be represented in parameters when using this mode.
+ * <li>
+ * <js>"UON"</js> - URL-Encoded Object Notation.
+ * <br>This notation allows for request parameters to contain arbitrarily complex POJOs.
+ * <li>
+ * <js>"PLAIN"</js> - Plain text.
+ * <br>This treats request parameters as plain text.
+ * <br>Only POJOs directly convertible from <l>Strings</l> can be represented in parameters when using this
+ * mode.
* </ul>
* <p>
* Note that the parameter value <js>"(foo)"</js> is interpreted as <js>"(foo)"</js> when using plain mode, but
- * <js>"foo"</js> when using UON mode.
+ * <js>"foo"</js> when using UON mode.
* <p>
- * The format can also be specified per-parameter using the {@link FormData#format() @FormData.format()} and {@link Query#format() @Query.format()}
- * annotations.
+ * The format can also be specified per-parameter using the {@link FormData#format() @FormData.format()} and
+ * {@link Query#format() @Query.format()} annotations.
* <p>
* Applicable to servlet class and methods.
*/
@@ -206,7 +213,8 @@ public final class RestContext extends Context {
/**
* The request servlet path.
* <p>
- * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and {@link ParserSession#getProperty(String)}.
+ * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and
+ * {@link ParserSession#getProperty(String)}.
* <p>
* Equivalent to the value returned by {@link RestRequest#getServletPath()}
*/
@@ -222,7 +230,8 @@ public final class RestContext extends Context {
/**
* The request URI path info.
* <p>
- * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and {@link ParserSession#getProperty(String)}.
+ * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and
+ * {@link ParserSession#getProperty(String)}.
* <p>
* Equivalent to the value returned by {@link RestRequest#getPathInfo()}
*/
@@ -231,7 +240,8 @@ public final class RestContext extends Context {
/**
* The request URI.
* <p>
- * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and {@link ParserSession#getProperty(String)}.
+ * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and
+ * {@link ParserSession#getProperty(String)}.
* <p>
* Equivalent to the value returned by {@link RestRequest#getRequestURI()}
*/
@@ -240,7 +250,8 @@ public final class RestContext extends Context {
/**
* The request method.
* <p>
- * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and {@link ParserSession#getProperty(String)}.
+ * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and
+ * {@link ParserSession#getProperty(String)}.
* <p>
* Equivalent to the value returned by {@link RestRequest#getMethod()}
*/
@@ -249,7 +260,8 @@ public final class RestContext extends Context {
/**
* The localized servlet title.
* <p>
- * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and {@link ParserSession#getProperty(String)}.
+ * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and
+ * {@link ParserSession#getProperty(String)}.
* <p>
* Equivalent to the value returned by {@link RestRequest#getServletTitle()}
*/
@@ -258,7 +270,8 @@ public final class RestContext extends Context {
/**
* The localized servlet description.
* <p>
- * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and {@link ParserSession#getProperty(String)}.
+ * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and
+ * {@link ParserSession#getProperty(String)}.
* <p>
* Equivalent to the value returned by {@link RestRequest#getServletDescription()}
*/
@@ -267,7 +280,8 @@ public final class RestContext extends Context {
/**
* The localized method summary.
* <p>
- * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and {@link ParserSession#getProperty(String)}.
+ * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and
+ * {@link ParserSession#getProperty(String)}.
* <p>
* Equivalent to the value returned by {@link RestRequest#getMethodSummary()}
*/
@@ -276,7 +290,8 @@ public final class RestContext extends Context {
/**
* The localized method description.
* <p>
- * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and {@link ParserSession#getProperty(String)}.
+ * Automatically added to properties returned by {@link SerializerSession#getProperty(String)} and
+ * {@link ParserSession#getProperty(String)}.
* <p>
* Equivalent to the value returned by {@link RestRequest#getMethodDescription()}
*/
@@ -766,7 +781,7 @@ public final class RestContext extends Context {
* Returns the variable resolver for this servlet.
* <p>
* Variable resolvers are used to replace variables in property values.
- * </p>
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -866,15 +881,14 @@ public final class RestContext extends Context {
}
/**
- * Same as {@link Class#getResourceAsStream(String)} except if it doesn't find the resource
- * on this class, searches up the parent hierarchy chain.
+ * Same as {@link Class#getResourceAsStream(String)} except if it doesn't find the resource on this class, searches
+ * up the parent hierarchy chain.
* <p>
- * If the resource cannot be found in the classpath, then an attempt is made to look in the
- * JVM working directory.
+ * If the resource cannot be found in the classpath, then an attempt is made to look in the JVM working directory.
* <p>
* If the <code>locale</code> is specified, then we look for resources whose name matches that locale.
- * For example, if looking for the resource <js>"MyResource.txt"</js> for the Japanese locale, we will
- * look for files in the following order:
+ * For example, if looking for the resource <js>"MyResource.txt"</js> for the Japanese locale, we will look for
+ * files in the following order:
* <ol>
* <li><js>"MyResource_ja_JP.txt"</js>
* <li><js>"MyResource_ja.txt"</js>
@@ -931,8 +945,8 @@ public final class RestContext extends Context {
}
/**
- * Reads the input stream from {@link #getResource(String, Locale)} and parses it into a POJO
- * using the parser matched by the specified media type.
+ * Reads the input stream from {@link #getResource(String, Locale)} and parses it into a POJO using the parser
+ * matched by the specified media type.
* <p>
* Useful if you want to load predefined POJOs from JSON files in your classpath.
*
@@ -966,8 +980,8 @@ public final class RestContext extends Context {
}
/**
- * Returns the path for this resource as defined by the {@link RestResource#path()} annotation or {@link RestConfig#setPath(String)} method
- * concatenated with those on all parent classes.
+ * Returns the path for this resource as defined by the {@link RestResource#path()} annotation or
+ * {@link RestConfig#setPath(String)} method concatenated with those on all parent classes.
* <p>
* If path is not specified, returns <js>"/"</js>.
* <p>
@@ -1114,7 +1128,8 @@ public final class RestContext extends Context {
/**
* The HTML page no-results message.
* <p>
- * Defined by the {@link HtmlDoc#noResultsMessage()} annotation or {@link RestConfig#setHtmlNoResultsMessage(String)} method.
+ * Defined by the {@link HtmlDoc#noResultsMessage()} annotation or {@link RestConfig#setHtmlNoResultsMessage(String)}
+ * method.
*
* @return The HTML page no-results message.
*/
@@ -1195,7 +1210,7 @@ public final class RestContext extends Context {
/**
* Returns a map of HTTP method names to call routers.
*
- * @return A map with HTTP method names uppercased as the keys, and call routers as the values.
+ * @return A map with HTTP method names upper-cased as the keys, and call routers as the values.
*/
protected Map<String,CallRouter> getCallRouters() {
return callRouters;
@@ -1236,7 +1251,8 @@ public final class RestContext extends Context {
/**
* Returns the parent resource context (if this resource was initialized from a parent).
* <p>
- * From this object, you can get access to the parent resource class itself using {@link #getResource()} or {@link #getRestServlet()}
+ * From this object, you can get access to the parent resource class itself using {@link #getResource()} or
+ * {@link #getRestServlet()}
*
* @return The parent resource context, or <jk>null</jk> if there is no parent context.
*/
@@ -1261,7 +1277,7 @@ public final class RestContext extends Context {
* <li>{@link RestResource#properties() @RestResource.properties()} annotation.
* <li>{@link RestConfig#setProperty(String, Object)}/{@link RestConfig#setProperties(Map)} methods.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>The returned {@code Map} is mutable. Therefore, subclasses are free to override
@@ -1341,6 +1357,7 @@ public final class RestContext extends Context {
/**
* Returns the value of the {@link #REST_renderResponseStackTraces} setting.
+ *
* @return The value of the {@link #REST_renderResponseStackTraces} setting.
*/
protected boolean isRenderResponseStackTraces() {
@@ -1349,6 +1366,7 @@ public final class RestContext extends Context {
/**
* Returns the value of the {@link #REST_allowHeaderParams} setting.
+ *
* @return The value of the {@link #REST_allowHeaderParams} setting.
*/
protected boolean isAllowHeaderParams() {
@@ -1357,6 +1375,7 @@ public final class RestContext extends Context {
/**
* Returns the value of the {@link #REST_allowBodyParam} setting.
+ *
* @return The value of the {@link #REST_allowBodyParam} setting.
*/
protected boolean isAllowBodyParam() {
@@ -1365,6 +1384,7 @@ public final class RestContext extends Context {
/**
* Returns the value of the {@link #REST_defaultCharset} setting.
+ *
* @return The value of the {@link #REST_defaultCharset} setting.
*/
protected String getDefaultCharset() {
@@ -1373,6 +1393,7 @@ public final class RestContext extends Context {
/**
* Returns the value of the {@link #REST_paramFormat} setting.
+ *
* @return The value of the {@link #REST_paramFormat} setting.
*/
protected String getParamFormat() {
@@ -1399,7 +1420,7 @@ public final class RestContext extends Context {
* Returns <jk>true</jk> if the specified <code>Method</code> GET parameter value can be used to override
* the method name in the HTTP header.
*
- * @param m The method name, uppercased.
+ * @param m The method name, upper-cased.
* @return <jk>true</jk> if this resource allows the specified method to be overridden.
*/
protected boolean allowMethodParam(String m) {
@@ -1519,6 +1540,7 @@ public final class RestContext extends Context {
/**
* Returns the URL-encoding parser associated with this resource.
+ *
* @return The URL-encoding parser associated with this resource. Never <jk>null</jk>.
*/
protected UrlEncodingParser getUrlEncodingParser() {
@@ -1527,6 +1549,7 @@ public final class RestContext extends Context {
/**
* Returns the URL-encoding serializer associated with this resource.
+ *
* @return The URL-encoding serializer associated with this resource. Never <jk>null</jk>.
*/
protected UrlEncodingSerializer getUrlEncodingSerializer() {
@@ -1541,7 +1564,8 @@ public final class RestContext extends Context {
* Encoders at the class level are defined via one of the following:
* <ul>
* <li>{@link RestResource#encoders() @RestResource.encoders()} annotation.
- * <li>{@link RestConfig#addEncoders(Class...)}/{@link RestConfig#addEncoders(org.apache.juneau.encoders.Encoder...)} methods.
+ * <li>{@link RestConfig#addEncoders(Class...)}/{@link RestConfig#addEncoders(org.apache.juneau.encoders.Encoder...)}
+ * methods.
* </ul>
*
* @return The encoders associated with this resource. Never <jk>null</jk>.
@@ -1554,7 +1578,8 @@ public final class RestContext extends Context {
* Returns the explicit list of supported accept types for this resource.
* <p>
* By default, this is simply the list of accept types supported by the registered parsers, but
- * can be overridden via the {@link RestConfig#setSupportedAcceptTypes(MediaType...)}/{@link RestConfig#setSupportedAcceptTypes(String...)} methods.
+ * can be overridden via the {@link RestConfig#setSupportedAcceptTypes(MediaType...)}/{@link RestConfig#setSupportedAcceptTypes(String...)}
+ * methods.
*
* @return The supported <code>Accept</code> header values for this resource. Never <jk>null</jk>.
*/
@@ -1565,8 +1590,9 @@ public final class RestContext extends Context {
/**
* Returns the explicit list of supported content types for this resource.
* <p>
- * By default, this is simply the list of content types supported by the registered serializers, but
- * can be overridden via the {@link RestConfig#setSupportedContentTypes(MediaType...)}/{@link RestConfig#setSupportedContentTypes(String...)} methods.
+ * By default, this is simply the list of content types supported by the registered serializers, but can be
+ * overridden via the {@link RestConfig#setSupportedContentTypes(MediaType...)}/{@link RestConfig#setSupportedContentTypes(String...)}
+ * methods.
*
* @return The supported <code>Content-Type</code> header values for this resource. Never <jk>null</jk>.
*/
@@ -1599,7 +1625,8 @@ public final class RestContext extends Context {
* Default response headers are defined via one of the following:
* <ul>
* <li>{@link RestResource#defaultResponseHeaders() @RestResource.defaultResponseHeaders()} annotation.
- * <li>{@link RestConfig#addDefaultResponseHeader(String, Object)}/{@link RestConfig#addDefaultResponseHeaders(String...)} methods.
+ * <li>{@link RestConfig#addDefaultResponseHeader(String, Object)}/{@link RestConfig#addDefaultResponseHeaders(String...)}
+ * methods.
* </ul>
*
* @return The default response headers for this resource. Never <jk>null</jk>.
@@ -1650,7 +1677,8 @@ public final class RestContext extends Context {
* Response handlers are defined via one of the following:
* <ul>
* <li>{@link RestResource#responseHandlers() @RestResource.responseHandlers()} annotation.
- * <li>{@link RestConfig#addResponseHandlers(Class...)}/{@link RestConfig#addResponseHandlers(ResponseHandler...)} methods.
+ * <li>{@link RestConfig#addResponseHandlers(Class...)}/{@link RestConfig#addResponseHandlers(ResponseHandler...)}
+ * methods.
* </ul>
*
* @return The response handlers associated with this resource. Never <jk>null</jk>.
@@ -1748,6 +1776,7 @@ public final class RestContext extends Context {
/**
* Returns <jk>true</jk> if this resource has any child resources associated with it.
+ *
* @return <jk>true</jk> if this resource has any child resources associated with it.
*/
protected boolean hasChildResources() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestConverter.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestConverter.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestConverter.java
index 2d668d3..4f85306 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestConverter.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestConverter.java
@@ -20,10 +20,11 @@ import org.apache.juneau.serializer.*;
/**
* REST method response converter.
* <p>
- * Implements a filter mechanism for REST method calls that allows response objects to be
- * converted to some other POJO after invocation of the REST method.
+ * Implements a filter mechanism for REST method calls that allows response objects to be converted to some other POJO
+ * after invocation of the REST method.
* <p>
* Converters are associated with REST methods through the {@link RestMethod#converters()} annotation.
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> RequestEchoResource <jk>extends</jk> RestServlet {
@@ -42,8 +43,8 @@ import org.apache.juneau.serializer.*;
*
* <h6 class='topic'>How to implement</h6>
* <p>
- * Implementers should simply implement the {@link #convert(RestRequest, Object, ClassMeta)} and
- * return back a 'converted' object.
+ * Implementers should simply implement the {@link #convert(RestRequest, Object, ClassMeta)} and return back a
+ * 'converted' object.
* It's up to the implementer to decide what this means.
* <p>
* Converters must implement a no-args constructor.
@@ -52,9 +53,12 @@ import org.apache.juneau.serializer.*;
* <p>
* The following converters are available by default.
* <ul class='spaced-list'>
- * <li>{@link Traversable} - Allows URL additional path info to address individual elements in a POJO tree.
- * <li>{@link Queryable} - Allows query/view/sort functions to be performed on POJOs.
- * <li>{@link Introspectable} - Allows Java public methods to be invoked on the returned POJOs.
+ * <li>
+ * {@link Traversable} - Allows URL additional path info to address individual elements in a POJO tree.
+ * <li>
+ * {@link Queryable} - Allows query/view/sort functions to be performed on POJOs.
+ * <li>
+ * {@link Introspectable} - Allows Java public methods to be invoked on the returned POJOs.
* </ul>
*/
public interface RestConverter {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestException.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestException.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestException.java
index 05fbd33..a8f4f6f 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestException.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestException.java
@@ -22,9 +22,8 @@ import org.apache.juneau.*;
/**
* Exception thrown to trigger an error HTTP status.
* <p>
- * REST methods on subclasses of {@link RestServlet} can throw
- * this exception to trigger an HTTP status other than the automatically-generated
- * <code>404</code>, <code>405</code>, and <code>500</code> statuses.
+ * REST methods on subclasses of {@link RestServlet} can throw this exception to trigger an HTTP status other than the
+ * automatically-generated <code>404</code>, <code>405</code>, and <code>500</code> statuses.
*/
public class RestException extends FormattedRuntimeException {
@@ -76,6 +75,7 @@ public class RestException extends FormattedRuntimeException {
* <li>{@link RestException}
* <li>{@link InvocationTargetException}
* </ul>
+ *
* @return The root cause of this exception, or <jk>null</jk> if no root cause was found.
*/
public Throwable getRootCause() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestGuard.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestGuard.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestGuard.java
index 7848bb2..f95b916 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestGuard.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestGuard.java
@@ -21,21 +21,22 @@ import org.apache.juneau.rest.annotation.*;
*
* <h5 class='section'>Description:</h5>
* <p>
- * Implements a guard mechanism for REST method calls that allows requests to be
- * rejected before invocation of the REST method.
+ * Implements a guard mechanism for REST method calls that allows requests to be rejected before invocation of the REST
+ * method.
* For example, guards can be used to ensure that only administrators can call certain methods.
* <p>
- * Guards are applied to REST methods declaratively through the {@link RestResource#guards()} or {@link RestMethod#guards()} annotations.
+ * Guards are applied to REST methods declaratively through the {@link RestResource#guards()} or
+ * {@link RestMethod#guards()} annotations.
* <p>
* If multiple guards are specified, ALL guards must pass in order for the request to proceed.
*
* <h6 class='topic'>How to implement</h6>
* <p>
- * Typically, guards will be used for permissions checking on the user making the request,
- * but it can also be used for other purposes like pre-call validation of a request.
+ * Typically, guards will be used for permissions checking on the user making the request, but it can also be used for
+ * other purposes like pre-call validation of a request.
* <p>
* Implementers should simply throw a {@link RestException} from the {@link #guard(RestRequest, RestResponse)}
- * method to abort processing on the current request.
+ * method to abort processing on the current request.
* <p>
* Guards must implement a no-args constructor.
*
@@ -64,14 +65,12 @@ import org.apache.juneau.rest.annotation.*;
public abstract class RestGuard {
/**
- * Checks the current HTTP request and throws a {@link RestException} if the guard
- * does not permit the request.
+ * Checks the current HTTP request and throws a {@link RestException} if the guard does not permit the request.
* <p>
- * By default, throws an <jsf>SC_FORBIDDEN</jsf> exception if {@link #isRequestAllowed(RestRequest)}
- * returns <jk>false</jk>.
+ * By default, throws an <jsf>SC_FORBIDDEN</jsf> exception if {@link #isRequestAllowed(RestRequest)} returns
+ * <jk>false</jk>.
* <p>
- * Subclasses are free to override this method to tailor the behavior of how to handle unauthorized
- * requests.
+ * Subclasses are free to override this method to tailor the behavior of how to handle unauthorized requests.
*
* @param req The servlet request.
* @param res The servlet response.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestInfoProvider.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestInfoProvider.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestInfoProvider.java
index 0254be6..b0aa412 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestInfoProvider.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestInfoProvider.java
@@ -55,6 +55,7 @@ public class RestInfoProvider {
/**
* Constructor.
+ *
* @param context The resource context.
*/
public RestInfoProvider(RestContext context) {
@@ -186,10 +187,10 @@ public class RestInfoProvider {
* </p>
* <ol>
* <li>{@link RestMethod#summary() @RestMethod.summary()} annotation on the method.
- * <li><ck>[ClassName].[javaMethodName].summary</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
- * <li><ck>[javaMethodName].summary</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
+ * <li><ck>[ClassName].[javaMethodName].summary</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
+ * <li><ck>[javaMethodName].summary</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
* </ol>
*
* @param javaMethodName The name of the Java method whose description we're retrieving.
@@ -212,10 +213,10 @@ public class RestInfoProvider {
* </p>
* <ol>
* <li>{@link RestMethod#description() @RestMethod.description()} annotation on the method.
- * <li><ck>[ClassName].[javaMethodName].description</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
- * <li><ck>[javaMethodName].description</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
+ * <li><ck>[ClassName].[javaMethodName].description</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
+ * <li><ck>[javaMethodName].description</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
* </ol>
*
* @param javaMethodName The name of the Java method whose description we're retrieving.
@@ -238,8 +239,9 @@ public class RestInfoProvider {
* <p>
* <ol>
* <li>{@link RestResource#title() @RestResourcel.title()} annotation on this class, and then any parent classes.
- * <li><ck>[ClassName].title</ck> property in resource bundle identified by {@link RestResource#messages() @ResourceBundle.messages()}
- * annotation for this class, then any parent classes.
+ * <li><ck>[ClassName].title</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @ResourceBundle.messages()} annotation for this class, then any parent
+ * classes.
* <li><ck>title</ck> in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
* annotation for this class, then any parent classes.
* <li><ck>/info/title</ck> entry in swagger file.
@@ -268,11 +270,12 @@ public class RestInfoProvider {
* <p>
* The default implementation returns the description from the following locations (whichever matches first):
* <ol>
- * <li>{@link RestResource#description() @RestResource.description()} annotation on this class, and then any parent classes.
- * <li><ck>[ClassName].description</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
- * <li><ck>description</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
+ * <li>{@link RestResource#description() @RestResource.description()} annotation on this class, and then any
+ * parent classes.
+ * <li><ck>[ClassName].description</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
+ * <li><ck>description</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
* <li><ck>/info/description</ck> entry in swagger file.
* </ol>
*
@@ -299,16 +302,18 @@ public class RestInfoProvider {
* <p>
* The default implementation returns the contact information from the following locations (whichever matches first):
* <ol>
- * <li>{@link ResourceSwagger#contact() @ResourceSwagger.contact()} annotation on this class, and then any parent classes.
- * <li><ck>[ClassName].contact</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
- * <li><ck>contact</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
+ * <li>{@link ResourceSwagger#contact() @ResourceSwagger.contact()} annotation on this class, and then any parent
+ * classes.
+ * <li><ck>[ClassName].contact</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
+ * <li><ck>contact</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
* <li><ck>/info/contact</ck> entry in swagger file.
* </ol>
*
* @param req The current request.
- * @return The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.
+ * @return The localized contact information of this REST resource, or <jk>null</jk> if no contact information was
+ * found.
*/
public Contact getContact(RestRequest req) {
VarResolverSession vr = req.getVarResolverSession();
@@ -335,16 +340,18 @@ public class RestInfoProvider {
* <p>
* The default implementation returns the license information from the following locations (whichever matches first):
* <ol>
- * <li>{@link ResourceSwagger#license() @ResourceSwagger.license()} annotation on this class, and then any parent classes.
- * <li><ck>[ClassName].license</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
- * <li><ck>license</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
+ * <li>{@link ResourceSwagger#license() @ResourceSwagger.license()} annotation on this class, and then any parent
+ * classes.
+ * <li><ck>[ClassName].license</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
+ * <li><ck>license</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
* <li><ck>/info/license</ck> entry in swagger file.
* </ol>
*
* @param req The current request.
- * @return The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.
+ * @return The localized contact information of this REST resource, or <jk>null</jk> if no contact information was
+ * found.
*/
public License getLicense(RestRequest req) {
VarResolverSession vr = req.getVarResolverSession();
@@ -369,18 +376,21 @@ public class RestInfoProvider {
* <p>
* Subclasses can override this method to provide their own terms-of-service information.
* <p>
- * The default implementation returns the terms-of-service information from the following locations (whichever matches first):
+ * The default implementation returns the terms-of-service information from the following locations (whichever
+ * matches first):
* <ol>
- * <li>{@link ResourceSwagger#termsOfService() @ResourceSwagger.termsOfService()} annotation on this class, and then any parent classes.
- * <li><ck>[ClassName].termsOfService</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
- * <li><ck>termsOfService</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
+ * <li>{@link ResourceSwagger#termsOfService() @ResourceSwagger.termsOfService()} annotation on this class, and
+ * then any parent classes.
+ * <li><ck>[ClassName].termsOfService</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
+ * <li><ck>termsOfService</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
* <li><ck>/info/termsOfService</ck> entry in swagger file.
* </ol>
*
* @param req The current request.
- * @return The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.
+ * @return The localized contact information of this REST resource, or <jk>null</jk> if no contact information was
+ * found.
*/
public String getTermsOfService(RestRequest req) {
VarResolverSession vr = req.getVarResolverSession();
@@ -402,16 +412,18 @@ public class RestInfoProvider {
* <p>
* The default implementation returns the version information from the following locations (whichever matches first):
* <ol>
- * <li>{@link ResourceSwagger#version() @ResourceSwagger.version()} annotation on this class, and then any parent classes.
- * <li><ck>[ClassName].version</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
- * <li><ck>version</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
+ * <li>{@link ResourceSwagger#version() @ResourceSwagger.version()} annotation on this class, and then any parent
+ * classes.
+ * <li><ck>[ClassName].version</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
+ * <li><ck>version</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
* <li><ck>/info/version</ck> entry in swagger file.
* </ol>
*
* @param req The current request.
- * @return The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.
+ * @return The localized contact information of this REST resource, or <jk>null</jk> if no contact information was
+ * found.
*/
public String getVersion(RestRequest req) {
VarResolverSession vr = req.getVarResolverSession();
@@ -433,16 +445,18 @@ public class RestInfoProvider {
* <p>
* The default implementation returns the version information from the following locations (whichever matches first):
* <ol>
- * <li>{@link ResourceSwagger#version() @ResourceSwagger.version()} annotation on this class, and then any parent classes.
- * <li><ck>[ClassName].version</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
- * <li><ck>version</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
+ * <li>{@link ResourceSwagger#version() @ResourceSwagger.version()} annotation on this class, and then any parent
+ * classes.
+ * <li><ck>[ClassName].version</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
+ * <li><ck>version</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
* <li><ck>/info/version</ck> entry in swagger file.
* </ol>
*
* @param req The current request.
- * @return The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.
+ * @return The localized contact information of this REST resource, or <jk>null</jk> if no contact information was
+ * found.
*/
public List<Tag> getTags(RestRequest req) {
VarResolverSession vr = req.getVarResolverSession();
@@ -469,16 +483,18 @@ public class RestInfoProvider {
* <p>
* The default implementation returns the version information from the following locations (whichever matches first):
* <ol>
- * <li>{@link ResourceSwagger#version() @ResourceSwagger.version()} annotation on this class, and then any parent classes.
- * <li><ck>[ClassName].version</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
- * <li><ck>version</ck> property in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
- * annotation for this class, then any parent classes.
+ * <li>{@link ResourceSwagger#version() @ResourceSwagger.version()} annotation on this class, and then any parent
+ * classes.
+ * <li><ck>[ClassName].version</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
+ * <li><ck>version</ck> property in resource bundle identified by
+ * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
* <li><ck>/info/version</ck> entry in swagger file.
* </ol>
*
* @param req The current request.
- * @return The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.
+ * @return The localized contact information of this REST resource, or <jk>null</jk> if no contact information was
+ * found.
*/
public ExternalDocumentation getExternalDocs(RestRequest req) {
VarResolverSession vr = req.getVarResolverSession();
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestLogger.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestLogger.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestLogger.java
index e9810d6..bc577e8 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestLogger.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestLogger.java
@@ -51,8 +51,8 @@ public abstract class RestLogger {
/**
* Log a message to the logger.
* <p>
- * Subclasses can override this method if they wish to log messages using a library other than
- * Java Logging (e.g. Apache Commons Logging).
+ * Subclasses can override this method if they wish to log messages using a library other than Java Logging
+ * (e.g. Apache Commons Logging).
*
* @param level The log level.
* @param cause The cause.
@@ -75,9 +75,11 @@ public abstract class RestLogger {
}
/**
- * Same as {@link #log(Level, String, Object...)} excepts runs the arguments through {@link JsonSerializer#DEFAULT_LAX_READABLE}.
+ * Same as {@link #log(Level, String, Object...)} excepts runs the arguments through
+ * {@link JsonSerializer#DEFAULT_LAX_READABLE}.
* <p>
- * Serialization of arguments do not occur if message is not logged, so it's safe to use this method from within debug log statements.
+ * Serialization of arguments do not occur if message is not logged, so it's safe to use this method from within
+ * debug log statements.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -150,7 +152,7 @@ public abstract class RestLogger {
* Subclasses can override this method to provide their own logic for determining when exceptions are logged.
* <p>
* The default implementation will return <jk>false</jk> if <js>"noTrace=true"</js> is passed in the query string
- * or <code>No-Trace: true</code> is specified in the header.
+ * or <code>No-Trace: true</code> is specified in the header.
*
* @param req The HTTP request.
* @param res The HTTP response.
@@ -168,8 +170,8 @@ public abstract class RestLogger {
* <p>
* Subclasses can override this method to provide their own logic for determining when stack traces are logged.
* <p>
- * The default implementation will only log a stack trace if {@link RestException#getOccurrence()} returns <code>1</code>
- * and the exception is not one of the following:
+ * The default implementation will only log a stack trace if {@link RestException#getOccurrence()} returns
+ * <code>1</code> and the exception is not one of the following:
* </p>
* <ul>
* <li>{@link HttpServletResponse#SC_UNAUTHORIZED}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestMatcher.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestMatcher.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestMatcher.java
index 236545f..612d9d1 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestMatcher.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestMatcher.java
@@ -17,18 +17,17 @@ import org.apache.juneau.rest.annotation.*;
/**
* Class used for defining method-level matchers using the {@link RestMethod#matchers()} annotation.
* <p>
- * Matchers are used to allow multiple Java methods to handle requests assigned to the same
- * URL path pattern, but differing based on some request attribute, such as a specific header value.
- * For example, matchers can be used to provide two different methods for handling requests
- * from two different client versions.
+ * Matchers are used to allow multiple Java methods to handle requests assigned to the same URL path pattern, but
+ * differing based on some request attribute, such as a specific header value.
+ * For example, matchers can be used to provide two different methods for handling requests from two different client
+ * versions.
* <p>
- * Java methods with matchers associated with them are always attempted before Java methods
- * without matchers.
+ * Java methods with matchers associated with them are always attempted before Java methods without matchers.
* This allows a 'default' method to be defined to handle requests where no matchers match.
* <p>
* When multiple matchers are specified on a method, only one matcher is required to match.
- * This is opposite from the {@link RestMethod#guards()} annotation, where all guards
- * are required to match in order to execute the method.
+ * This is opposite from the {@link RestMethod#guards()} annotation, where all guards are required to match in order to
+ * execute the method.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestMatcherReflecting.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestMatcherReflecting.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestMatcherReflecting.java
index 2a1cc16..5678d1d 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestMatcherReflecting.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestMatcherReflecting.java
@@ -17,9 +17,8 @@ import java.lang.reflect.*;
/**
* Subclass of {@link RestMatcher} that gives access to the servlet/resource and Java method it's applied to.
* <p>
- * Essentially the same as {@link RestMatcher} except has a constructor where the
- * Java method is passed in so that you can access annotations defined on it to tailor
- * the behavior of the matcher.
+ * Essentially the same as {@link RestMatcher} except has a constructor where the Java method is passed in so that you
+ * can access annotations defined on it to tailor the behavior of the matcher.
*/
public abstract class RestMatcherReflecting extends RestMatcher {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestParam.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestParam.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestParam.java
index 4e834b4..840f9f7 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestParam.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestParam.java
@@ -35,7 +35,7 @@ public abstract class RestParam {
*
* @param paramType The Swagger parameter type.
* @param name The parameter name.
- * Can be <jk>null</jk> if parameter doesn't have a name (e.g. the request body).
+ * Can be <jk>null</jk> if parameter doesn't have a name (e.g. the request body).
* @param type The object type to convert the parameter to.
*/
protected RestParam(RestParamType paramType, String name, Type type) {
@@ -56,6 +56,7 @@ public abstract class RestParam {
/**
* Returns the parameter class type that this parameter resolver is meant for.
+ *
* @return The parameter class type, or <jk>null</jk> if the type passed in isn't an instance of {@link Class}.
*/
protected Class<?> forClass() {
@@ -66,6 +67,7 @@ public abstract class RestParam {
/**
* Returns the swagger parameter type for this parameter as shown in the Swagger doc.
+ *
* @return the swagger parameter type for this parameter.
*/
protected RestParamType getParamType() {
@@ -74,6 +76,7 @@ public abstract class RestParam {
/**
* Returns the parameter name for this parameter as shown in the Swagger doc.
+ *
* @return the parameter name for this parameter.
*/
protected String getName() {
@@ -82,6 +85,7 @@ public abstract class RestParam {
/**
* Returns the parameter class type.
+ *
* @return the parameter class type.
*/
public Type getType() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestRequest.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestRequest.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestRequest.java
index e631bbe..9a2f9d2 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestRequest.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestRequest.java
@@ -46,7 +46,7 @@ import org.apache.juneau.utils.*;
* Equivalent to {@link HttpServletRequest} except with some additional convenience methods.
* <p>
* For reference, given the URL <js>"http://localhost:9080/contextRoot/servletPath/foo?bar=baz#qux"</js>, the
- * following methods return the following values....
+ * following methods return the following values....
* <table class='styled'>
* <tr><th>Method</th><th>Value</th></tr>
* <tr><td>{@code getContextPath()}</td><td>{@code /contextRoot}</td></tr>
@@ -58,7 +58,8 @@ import org.apache.juneau.utils.*;
* <tr><td>{@code getServletPath()}</td><td>{@code /servletPath}</td></tr>
* </table>
* <p>
- * Refer to <a class="doclink" href="package-summary.html#TOC">REST Servlet API</a> for information about using this class.
+ * Refer to <a class="doclink" href="package-summary.html#TOC">REST Servlet API</a> for information about using this
+ * class.
*/
@SuppressWarnings("unchecked")
public final class RestRequest extends HttpServletRequestWrapper {
@@ -362,7 +363,8 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Equivalent to {@link #getParameterMap()}, but only looks for query parameters in the URL, not form posts.
* <p>
- * This method can be used to retrieve query parameters without triggering the underlying servlet API to load and parse the request body.
+ * This method can be used to retrieve query parameters without triggering the underlying servlet API to load and
+ * parse the request body.
* <p>
* This object is modifiable.
*
@@ -374,6 +376,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Shortcut for calling <code>getQuery().getString(name)</code>.
+ *
* @param name The query parameter name.
* @return The query parameter value, or <jk>null<jk> if not found.
*/
@@ -414,6 +417,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Shortcut for calling <code>getFormData().getString(name)</code>.
+ *
* @param name The form data parameter name.
* @return The form data parameter value, or <jk>null<jk> if not found.
*/
@@ -452,7 +456,8 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the HTTP body content as a {@link Reader}.
* <p>
- * If {@code allowHeaderParams} init parameter is true, then first looks for {@code &body=xxx} in the URL query string.
+ * If {@code allowHeaderParams} init parameter is true, then first looks for {@code &body=xxx} in the URL query
+ * string.
* <p>
* Automatically handles GZipped input streams.
*/
@@ -467,8 +472,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
* Automatically handles GZipped input streams.
*
* @return The negotiated input stream.
- * @throws IOException If any error occurred while trying to get the input stream or wrap it
- * in the GZIP wrapper.
+ * @throws IOException If any error occurred while trying to get the input stream or wrap it in the GZIP wrapper.
*/
@Override /* ServletRequest */
public ServletInputStream getInputStream() throws IOException {
@@ -487,8 +491,8 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the URI context of the request.
* <p>
- * The URI context contains all the information about the URI of the request, such
- * as the servlet URI, context path, etc...
+ * The URI context contains all the information about the URI of the request, such as the servlet URI, context
+ * path, etc...
*
* @return The URI context of the request.
*/
@@ -505,7 +509,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
}
/**
- * Returns a URI resolver that can be used to convert URIs to absolute or root-relative form..
+ * Returns a URI resolver that can be used to convert URIs to absolute or root-relative form.
*
* @param resolution The URI resolution rule.
* @param relativity The relative URI relativity rule.
@@ -516,7 +520,8 @@ public final class RestRequest extends HttpServletRequestWrapper {
}
/**
- * Shortcut for calling {@link #getUriResolver()} using {@link UriResolution#ROOT_RELATIVE} and {@link UriRelativity#RESOURCE}
+ * Shortcut for calling {@link #getUriResolver()} using {@link UriResolution#ROOT_RELATIVE} and
+ * {@link UriRelativity#RESOURCE}
*
* @return The URI resolver for this request.
*/
@@ -599,7 +604,8 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the method of this request.
* <p>
- * If <code>allowHeaderParams</code> init parameter is <jk>true</jk>, then first looks for <code>&method=xxx</code> in the URL query string.
+ * If <code>allowHeaderParams</code> init parameter is <jk>true</jk>, then first looks for
+ * <code>&method=xxx</code> in the URL query string.
*/
@Override /* ServletRequest */
public String getMethod() {
@@ -630,7 +636,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
* Returns <jk>true</jk> if <code>&plainText=true</code> was specified as a URL parameter.
* <p>
* This indicates that the <code>Content-Type</code> of the output should always be set to <js>"text/plain"</js>
- * to make it easy to render in a browser.
+ * to make it easy to render in a browser.
* <p>
* This feature is useful for debugging.
*
@@ -663,8 +669,8 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the servlet handling the request.
* <p>
- * Can be used to access servlet-init parameters or annotations during requests,
- * such as in calls to {@link RestGuard#guard(RestRequest, RestResponse)}..
+ * Can be used to access servlet-init parameters or annotations during requests, such as in calls to
+ * {@link RestGuard#guard(RestRequest, RestResponse)}..
*
* @return The servlet handling the request.
*/
@@ -675,16 +681,16 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the java method handling the request.
* <p>
- * Can be used to access the method name or method annotations during requests, such
- * as in calls to {@link RestGuard#guard(RestRequest, RestResponse)}.
- * <p>
+ * Can be used to access the method name or method annotations during requests, such as in calls to
+ * {@link RestGuard#guard(RestRequest, RestResponse)}.
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This returns null when evaluating servlet-level guards since the method has not been resolved at that point of execution.
+ * <li>This returns null when evaluating servlet-level guards since the method has not been resolved at that
+ * point of execution.
* </ul>
*
- * @return The Java method handling the request, or <code>null</code> if the method
- * has not yet been resolved.
+ * @return The Java method handling the request, or <code>null</code> if the method has not yet been resolved.
*/
public Method getJavaMethod() {
return javaMethod;
@@ -700,7 +706,8 @@ public final class RestRequest extends HttpServletRequestWrapper {
}
/**
- * Returns the variable resolver session for this request using session objects created by {@link RestCallHandler#getSessionObjects(RestRequest)}.
+ * Returns the variable resolver session for this request using session objects created by
+ * {@link RestCallHandler#getSessionObjects(RestRequest)}.
*
* @return The variable resolver for this request.
*/
@@ -721,11 +728,12 @@ public final class RestRequest extends HttpServletRequestWrapper {
}
/**
- * Returns an instance of a {@link ReaderResource} that represents the contents of a resource text file from the classpath.
+ * Returns an instance of a {@link ReaderResource} that represents the contents of a resource text file from the
+ * classpath.
*
* @param name The name of the resource (i.e. the value normally passed to {@link Class#getResourceAsStream(String)}.
- * @param resolveVars If <jk>true</jk>, any {@link org.apache.juneau.rest.annotation.Parameter} variables will be resolved by the variable resolver returned
- * by {@link #getVarResolverSession()}.
+ * @param resolveVars If <jk>true</jk>, any {@link org.apache.juneau.rest.annotation.Parameter} variables will be
+ * resolved by the variable resolver returned by {@link #getVarResolverSession()}.
* @param mediaType The value to set as the <js>"Content-Type"</js> header for this object.
* @return A new reader resource, or <jk>null</jk> if resource could not be found.
* @throws IOException
@@ -745,8 +753,8 @@ public final class RestRequest extends HttpServletRequestWrapper {
* constructed using {@link RestConfig#addMimeTypes(String...)} to determine the media type.
*
* @param name The name of the resource (i.e. the value normally passed to {@link Class#getResourceAsStream(String)}.
- * @param resolveVars If <jk>true</jk>, any {@link org.apache.juneau.rest.annotation.Parameter} variables will be resolved by the variable resolver returned
- * by {@link #getVarResolverSession()}.
+ * @param resolveVars If <jk>true</jk>, any {@link org.apache.juneau.rest.annotation.Parameter} variables will be
+ * resolved by the variable resolver returned by {@link #getVarResolverSession()}.
* @return A new reader resource, or <jk>null</jk> if resource could not be found.
* @throws IOException
*/
@@ -768,7 +776,8 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the config file associated with the servlet.
*
- * @return The config file associated with the servlet, or <jk>null</jk> if servlet does not have a config file associated with it.
+ * @return The config file associated with the servlet, or <jk>null</jk> if servlet does not have a config file
+ * associated with it.
*/
public ConfigFile getConfigFile() {
if (cf == null)
@@ -780,7 +789,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
* Returns the localized swagger associated with the servlet.
*
* @return The swagger associated with the servlet.
- * Never <jk>null</jk>.
+ * Never <jk>null</jk>.
*/
public Swagger getSwagger() {
if (swagger == null)
@@ -792,7 +801,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
* Returns the widgets used for resolving <js>"$W{...}"</js> string variables.
*
* @return The widgets used for resolving <js>"$W{...}"</js> string variables.
- * Never <jk>null</jk>.
+ * Never <jk>null</jk>.
*/
public Map<String,Widget> getWidgets() {
return widgets;
@@ -801,8 +810,8 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the localized Swagger from the file system.
* <p>
- * Looks for a file called <js>"{ServletClass}_{locale}.json"</js> in the same package
- * as this servlet and returns it as a parsed {@link Swagger} object.
+ * Looks for a file called <js>"{ServletClass}_{locale}.json"</js> in the same package as this servlet and returns
+ * it as a parsed {@link Swagger} object.
* <p>
* Returned objects are cached for later quick-lookup.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestResourceResolver.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestResourceResolver.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestResourceResolver.java
index 057eb3b..ddbdf18 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestResourceResolver.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestResourceResolver.java
@@ -27,7 +27,8 @@ import org.apache.juneau.rest.annotation.*;
* These can be associated with REST resources in one of the following ways:
* <ul>
* <li>{@link RestResource#resourceResolver() @RestResource.resourceResolver()} annotation.
- * <li>{@link RestConfig#setResourceResolver(Class)}/{@link RestConfig#setResourceResolver(RestResourceResolver)} methods.
+ * <li>{@link RestConfig#setResourceResolver(Class)}/{@link RestConfig#setResourceResolver(RestResourceResolver)}
+ * methods.
* </ul>
* <p>
* The default implementation simply instantiates the class using one of the following constructors:
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestResponse.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestResponse.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestResponse.java
index 34b3cc0..e0d2f69 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestResponse.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestResponse.java
@@ -35,11 +35,11 @@ import org.apache.juneau.xml.*;
/**
* Represents an HTTP response for a REST resource.
* <p>
- * Essentially an extended {@link HttpServletResponse} with some special convenience methods
- * that allow you to easily output POJOs as responses.
+ * Essentially an extended {@link HttpServletResponse} with some special convenience methods that allow you to easily
+ * output POJOs as responses.
* <p>
- * Since this class extends {@link HttpServletResponse}, developers are free to use these
- * convenience methods, or revert to using lower level methods like any other servlet response.
+ * Since this class extends {@link HttpServletResponse}, developers are free to use these convenience methods, or
+ * revert to using lower level methods like any other servlet response.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -50,16 +50,17 @@ import org.apache.juneau.xml.*;
* }
* </p>
* <p>
- * Refer to <a class="doclink" href="package-summary.html#TOC">REST Servlet API</a> for information about using this class.
+ * Refer to <a class="doclink" href="package-summary.html#TOC">REST Servlet API</a> for information about using this
+ * class.
*/
public final class RestResponse extends HttpServletResponseWrapper {
private final RestRequest request;
- private Object output; // The POJO being sent to the output.
- private boolean isNullOutput; // The output is null (as opposed to not being set at all)
- private ObjectMap properties; // Response properties
+ private Object output; // The POJO being sent to the output.
+ private boolean isNullOutput; // The output is null (as opposed to not being set at all)
+ private ObjectMap properties; // Response properties
SerializerGroup serializerGroup;
- UrlEncodingSerializer urlEncodingSerializer; // The serializer used to convert arguments passed into Redirect objects.
+ UrlEncodingSerializer urlEncodingSerializer; // The serializer used to convert arguments passed into Redirect objects.
private EncoderGroup encoders;
private ServletOutputStream os;
private PrintWriter w;
@@ -138,7 +139,8 @@ public final class RestResponse extends HttpServletResponseWrapper {
}
/**
- * Returns the codings that are valid for <code>Accept-Encoding</code> and <code>Content-Encoding</code> headers on the request.
+ * Returns the codings that are valid for <code>Accept-Encoding</code> and <code>Content-Encoding</code> headers on
+ * the request.
*
* @return The set of media types registered in the parser group of this request.
* @throws RestServletException
@@ -156,10 +158,12 @@ public final class RestResponse extends HttpServletResponseWrapper {
* <ul>
* <li> {@link InputStream}
* <li> {@link Reader}
- * <li> Any serializable type defined in <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a>
+ * <li> Any serializable type defined in <a class="doclink"
+ * href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a>
* </ul>
* <p>
- * If it's an {@link InputStream} or {@link Reader}, you must also specify the <code>Content-Type</code> using the {@link #setContentType(String)} method.
+ * If it's an {@link InputStream} or {@link Reader}, you must also specify the <code>Content-Type</code> using the
+ * {@link #setContentType(String)} method.
*
* @param output The output to serialize to the connection.
* @return This object (for method chaining).
@@ -200,7 +204,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
}
/**
- * Shortcut method that allows you to use varargs to simplify setting array output.
+ * Shortcut method that allows you to use var-args to simplify setting array output.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -251,9 +255,8 @@ public final class RestResponse extends HttpServletResponseWrapper {
}
/**
- * Equivalent to {@link HttpServletResponse#getOutputStream()}, except
- * wraps the output stream if an {@link Encoder} was found that matched
- * the <code>Accept-Encoding</code> header.
+ * Equivalent to {@link HttpServletResponse#getOutputStream()}, except wraps the output stream if an {@link Encoder}
+ * was found that matched the <code>Accept-Encoding</code> header.
*
* @return A negotiated output stream.
* @throws IOException
@@ -336,8 +339,8 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Convenience method meant to be used when rendering directly to a browser with no buffering.
- * Sets the header <js>"x-content-type-options=nosniff"</js> so that output is rendered
- * immediately on IE and Chrome without any buffering for content-type sniffing.
+ * Sets the header <js>"x-content-type-options=nosniff"</js> so that output is rendered immediately on IE and Chrome
+ * without any buffering for content-type sniffing.
*
* @param contentType The value to set as the <code>Content-Type</code> on the response.
* @return The raw writer.
@@ -350,10 +353,9 @@ public final class RestResponse extends HttpServletResponseWrapper {
}
/**
- * Equivalent to {@link HttpServletResponse#getWriter()}, except
- * wraps the output stream if an {@link Encoder} was found that matched
- * the <code>Accept-Encoding</code> header and sets the <code>Content-Encoding</code>
- * header to the appropriate value.
+ * Equivalent to {@link HttpServletResponse#getWriter()}, except wraps the output stream if an {@link Encoder} was
+ * found that matched the <code>Accept-Encoding</code> header and sets the <code>Content-Encoding</code>
+ * header to the appropriate value.
*
* @return The negotiated writer.
* @throws IOException
@@ -394,8 +396,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
* Redirects to the specified URI.
* <p>
* Relative URIs are always interpreted as relative to the context root.
- * This is similar to how WAS handles redirect requests, and is different from how Tomcat
- * handles redirect requests.
+ * This is similar to how WAS handles redirect requests, and is different from how Tomcat handles redirect requests.
*/
@Override /* ServletResponse */
public void sendRedirect(String uri) throws IOException {
@@ -430,7 +431,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
* The format of this value is plain text.
* <p>
* It gets wrapped in a <code><xt><h3> <xa>class</xa>=<xs>'title'</xs>></xt></code> element and then added
- * to the <code><xt><header></code> section on the page.
+ * to the <code><xt><header></code> section on the page.
* <p>
* If not specified, the page title is pulled from one of the following locations:
* <ol>
@@ -475,7 +476,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
* The format of this value is plain text.
* <p>
* It gets wrapped in a <code><xt><h5> <xa>class</xa>=<xs>'description'</xs>></xt></code> element and then
- * added to the <code><xt><header></code> section on the page.
+ * added to the <code><xt><header></code> section on the page.
* <p>
* If not specified, the page title is pulled from one of the following locations:
* <ol>
@@ -530,7 +531,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
* This is the programmatic equivalent to the {@link HtmlDoc#branding() @HtmlDoc.branding()} annotation.
*
* @param value The HTML page branding.
- * Object will be converted to a string using {@link Object#toString()}.
+ * Object will be converted to a string using {@link Object#toString()}.
* @return This object (for method chaining).
*/
public RestResponse setHtmlBranding(Object value) {
@@ -543,9 +544,10 @@ public final class RestResponse extends HttpServletResponseWrapper {
* The format of this value is HTML.
* <p>
* The page header normally contains the title and description, but this value can be used to override the contents
- * to be whatever you want.
+ * to be whatever you want.
* <p>
- * When a value is specified, the {@link #setHtmlTitle(Object)} and {@link #setHtmlDescription(Object)} values will be ignored.
+ * When a value is specified, the {@link #setHtmlTitle(Object)} and {@link #setHtmlDescription(Object)} values will
+ * be ignored.
* <p>
* A value of <js>"NONE"</js> can be used to force no header.
* <p>
@@ -554,13 +556,13 @@ public final class RestResponse extends HttpServletResponseWrapper {
* This is the programmatic equivalent to the {@link HtmlDoc#header() @HtmlDoc.header()} annotation.
*
* @param value The HTML header section contents.
- * Object will be converted to a string using {@link Object#toString()}.
- * <p>
- * <ul class='doctree'>
- * <li class='info'>
- * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
- * waste string concatenation cycles on non-HTML views.
- * </ul>
+ * Object will be converted to a string using {@link Object#toString()}.
+ * <p>
+ * <ul class='doctree'>
+ * <li class='info'>
+ * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
+ * waste string concatenation cycles on non-HTML views.
+ * </ul>
* @return This object (for method chaining).
*/
public RestResponse setHtmlHeader(Object value) {
@@ -571,7 +573,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
* Sets the links in the HTML nav section.
* <p>
* The format of this value is a lax-JSON map of key/value pairs where the keys are the link text and the values are
- * relative (to the servlet) or absolute URLs.
+ * relative (to the servlet) or absolute URLs.
* <p>
* The page links are positioned immediately under the title and text.
* <p>
@@ -584,13 +586,13 @@ public final class RestResponse extends HttpServletResponseWrapper {
* This is the programmatic equivalent to the {@link HtmlDoc#links() @HtmlDoc.links()} annotation.
*
* @param value The HTML nav section links links.
- * Object will be converted to a string using {@link Object#toString()}.
- * <p>
- * <ul class='doctree'>
- * <li class='info'>
- * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
- * waste string concatenation cycles on non-HTML views.
- * </ul>
+ * Object will be converted to a string using {@link Object#toString()}.
+ * <p>
+ * <ul class='doctree'>
+ * <li class='info'>
+ * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
+ * waste string concatenation cycles on non-HTML views.
+ * </ul>
* @return This object (for method chaining).
*/
public RestResponse setHtmlLinks(Object value) {
@@ -616,13 +618,13 @@ public final class RestResponse extends HttpServletResponseWrapper {
* This is the programmatic equivalent to the {@link HtmlDoc#nav() @HtmlDoc.nav()} annotation.
*
* @param value The HTML nav section contents.
- * Object will be converted to a string using {@link Object#toString()}.
- * <p>
- * <ul class='doctree'>
- * <li class='info'>
- * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
- * waste string concatenation cycles on non-HTML views.
- * </ul>
+ * Object will be converted to a string using {@link Object#toString()}.
+ * <p>
+ * <ul class='doctree'>
+ * <li class='info'>
+ * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
+ * waste string concatenation cycles on non-HTML views.
+ * </ul>
* @return This object (for method chaining).
*/
public RestResponse setHtmlNav(Object value) {
@@ -644,13 +646,13 @@ public final class RestResponse extends HttpServletResponseWrapper {
* This is the programmatic equivalent to the {@link HtmlDoc#aside() @HtmlDoc.aside()} annotation.
*
* @param value The HTML aside section contents.
- * Object will be converted to a string using {@link Object#toString()}.
- * <p>
- * <ul class='doctree'>
- * <li class='info'>
- * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
- * waste string concatenation cycles on non-HTML views.
- * </ul>
+ * Object will be converted to a string using {@link Object#toString()}.
+ * <p>
+ * <ul class='doctree'>
+ * <li class='info'>
+ * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to waste
+ * string concatenation cycles on non-HTML views.
+ * </ul>
* @return This object (for method chaining).
*/
public RestResponse setHtmlAside(Object value) {
@@ -672,13 +674,13 @@ public final class RestResponse extends HttpServletResponseWrapper {
* This is the programmatic equivalent to the {@link HtmlDoc#footer() @HtmlDoc.footer()} annotation.
*
* @param value The HTML footer section contents.
- * Object will be converted to a string using {@link Object#toString()}.
- * <p>
- * <ul class='doctree'>
- * <li class='info'>
- * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
- * waste string concatenation cycles on non-HTML views.
- * </ul>
+ * Object will be converted to a string using {@link Object#toString()}.
+ * <p>
+ * <ul class='doctree'>
+ * <li class='info'>
+ * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
+ * waste string concatenation cycles on non-HTML views.
+ * </ul>
* @return This object (for method chaining).
*/
public RestResponse setHtmlFooter(Object value) {
@@ -698,13 +700,13 @@ public final class RestResponse extends HttpServletResponseWrapper {
* This is the programmatic equivalent to the {@link HtmlDoc#css() @HtmlDoc.css()} annotation.
*
* @param value The HTML CSS style section contents.
- * Object will be converted to a string using {@link Object#toString()}.
- * <p>
- * <ul class='doctree'>
- * <li class='info'>
- * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
- * waste string concatenation cycles on non-HTML views.
- * </ul>
+ * Object will be converted to a string using {@link Object#toString()}.
+ * <p>
+ * <ul class='doctree'>
+ * <li class='info'>
+ * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
+ * waste string concatenation cycles on non-HTML views.
+ * </ul>
* @return This object (for method chaining).
*/
public RestResponse setHtmlCss(Object value) {
@@ -722,18 +724,18 @@ public final class RestResponse extends HttpServletResponseWrapper {
* The format of this value is CSS.
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols defined
- * by {@link UriResolver}.
+ * by {@link UriResolver}.
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#cssUrl() @HtmlDoc.cssUrl()} annotation.
*
* @param value The CSS URL in the HTML CSS style section.
- * Object will be converted to a string using {@link Object#toString()}.
- * <p>
- * <ul class='doctree'>
- * <li class='info'>
- * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
- * waste string concatenation cycles on non-HTML views.
- * </ul>
+ * Object will be converted to a string using {@link Object#toString()}.
+ * <p>
+ * <ul class='doctree'>
+ * <li class='info'>
+ * <b>Tip:</b> Use {@link StringMessage} to generate value with delayed serialization so as not to
+ * waste string concatenation cycles on non-HTML views.
+ * </ul>
* @return This object (for method chaining).
*/
public RestResponse setHtmlCssUrl(Object value) {
@@ -757,7 +759,8 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Specifies the text to display when serializing an empty array or collection.
* <p>
- * This is the programmatic equivalent to the {@link HtmlDoc#noResultsMessage() @HtmlDoc.noResultsMessage()} annotation.
+ * This is the programmatic equivalent to the {@link HtmlDoc#noResultsMessage() @HtmlDoc.noResultsMessage()}
+ * annotation.
*
* @param value The text to display when serializing an empty array or collection.
* @return This object (for method chaining).
@@ -770,9 +773,8 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Specifies the template class to use for rendering the HTML page.
* <p>
- * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide
- * your own custom renderer or subclasses from the basic class to have full control over how the page is
- * rendered.
+ * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom
+ * renderer or subclasses from the basic class to have full control over how the page is rendered.
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.
*
@@ -787,9 +789,8 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Specifies the template class to use for rendering the HTML page.
* <p>
- * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide
- * your own custom renderer or subclasses from the basic class to have full control over how the page is
- * rendered.
+ * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom
+ * renderer or subclasses from the basic class to have full control over how the page is rendered.
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestServlet.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestServlet.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestServlet.java
index 1cd2506..37db4e0 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestServlet.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestServlet.java
@@ -29,7 +29,8 @@ import org.apache.juneau.utils.*;
/**
* Servlet implementation of a REST resource.
* <p>
- * Refer to <a class="doclink" href="package-summary.html#TOC">REST Servlet API</a> for information about using this class.
+ * Refer to <a class="doclink" href="package-summary.html#TOC">REST Servlet API</a> for information about using this
+ * class.
*/
@SuppressWarnings("hiding")
public abstract class RestServlet extends HttpServlet {
@@ -53,7 +54,7 @@ public abstract class RestServlet extends HttpServlet {
super.init(servletConfig);
}
} catch (RestException e) {
- // Thrown RestExceptions are simply caught and rethrown on subsequent calls to service().
+ // Thrown RestExceptions are simply caught and re-thrown on subsequent calls to service().
initException = e;
log(SEVERE, e, "Servlet init error on class ''{0}''", getClass().getName());
} catch (ServletException e) {
@@ -76,17 +77,16 @@ public abstract class RestServlet extends HttpServlet {
/**
* Resource initialization method.
* <p>
- * Identical to {@link Servlet#init(ServletConfig)} except the config object provides
- * access to the external config file, configuration properties, and variable resolver
- * defined for this resource.
+ * Identical to {@link Servlet#init(ServletConfig)} except the config object provides access to the external config
+ * file, configuration properties, and variable resolver defined for this resource.
* <p>
- * Classes can also use {@link HttpServlet#init()} and {@link RestServlet#getServletConfig()}
- * as well to perform initialization.
+ * Classes can also use {@link HttpServlet#init()} and {@link RestServlet#getServletConfig()} as well to perform
+ * initialization.
* <p>
* Note that if you override this method, you must first call <code><jk>super</jk>.init(servletConfig)</code>!
* <p>
- * Resource classes that don't extend from {@link RestServlet} can add this method to their class
- * to get access to the config object.
+ * Resource classes that don't extend from {@link RestServlet} can add this method to their class to get access to
+ * the config object.
*
* @param config The servlet configuration.
* @throws Exception Any exception can be thrown to signal an initialization failure.
@@ -157,11 +157,11 @@ public abstract class RestServlet extends HttpServlet {
/**
* Returns the read-only context object that contains all the configuration information about this resource.
* <p>
- * This object is <jk>null</jk> during the call to {@link #init(RestConfig)} but is populated
- * by the time {@link #init()} is called.
+ * This object is <jk>null</jk> during the call to {@link #init(RestConfig)} but is populated by the time
+ * {@link #init()} is called.
* <p>
- * Resource classes that don't extend from {@link RestServlet} can add the following method to their
- * class to get access to this context object:
+ * Resource classes that don't extend from {@link RestServlet} can add the following method to their class to get
+ * access to this context object:
* <p class='bcode'>
* <jk>public void</jk> init(RestServletContext context) <jk>throws</jk> Exception;
* </p>
@@ -179,8 +179,8 @@ public abstract class RestServlet extends HttpServlet {
* <p>
* The default implementation does nothing.
* <p>
- * Resources that don't extend from {@link RestServlet} can implement an equivalent method by
- * overriding the {@link RestCallHandler#onSuccess(RestRequest, RestResponse, long)} method.
+ * Resources that don't extend from {@link RestServlet} can implement an equivalent method by overriding the
+ * {@link RestCallHandler#onSuccess(RestRequest, RestResponse, long)} method.
*
* @param req The HTTP request.
* @param res The HTTP response.
@@ -191,11 +191,11 @@ public abstract class RestServlet extends HttpServlet {
/**
* Callback method that gets invoked right before the REST Java method is invoked.
* <p>
- * Subclasses can override this method to override request headers or set request-duration properties
- * before the Java method is invoked.
+ * Subclasses can override this method to override request headers or set request-duration properties before the
+ * Java method is invoked.
* <p>
- * Resources that don't extend from {@link RestServlet} can implement an equivalent method by
- * overriding the {@link RestCallHandler#onPreCall(RestRequest)} method.
+ * Resources that don't extend from {@link RestServlet} can implement an equivalent method by overriding the
+ * {@link RestCallHandler#onPreCall(RestRequest)} method.
*
* @param req The HTTP servlet request object.
* @throws RestException If any error occurs.
@@ -203,14 +203,14 @@ public abstract class RestServlet extends HttpServlet {
protected void onPreCall(RestRequest req) throws RestException {}
/**
- * Callback method that gets invoked right after the REST Java method is invoked, but before
- * the serializer is invoked.
+ * Callback method that gets invoked right after the REST Java method is invoked, but before the serializer is
+ * invoked.
* <p>
- * Subclasses can override this method to override request and response headers, or
- * set/override properties used by the serializer.
+ * Subclasses can override this method to override request and response headers, or set/override properties used by
+ * the serializer.
* <p>
- * Resources that don't extend from {@link RestServlet} can implement an equivalent method by
- * overriding the {@link RestCallHandler#onPostCall(RestRequest,RestResponse)} method.
+ * Resources that don't extend from {@link RestServlet} can implement an equivalent method by overriding the
+ * {@link RestCallHandler#onPostCall(RestRequest,RestResponse)} method.
*
* @param req The HTTP servlet request object.
* @param res The HTTP servlet response object.
@@ -263,6 +263,7 @@ public abstract class RestServlet extends HttpServlet {
/**
* Convenience method for calling <code>getContext().getMessages();</code>
+ *
* @return The resource bundle for this resource. Never <jk>null</jk>.
* @see RestContext#getProperties()
*/
@@ -272,6 +273,7 @@ public abstract class RestServlet extends HttpServlet {
/**
* Convenience method for calling <code>getContext().getProperties();</code>
+ *
* @return The resource properties as an {@link ObjectMap}.
* @see RestContext#getProperties()
*/
@@ -281,6 +283,7 @@ public abstract class RestServlet extends HttpServlet {
/**
* Convenience method for calling <code>getContext().getBeanContext();</code>
+ *
* @return The bean context used for parsing path variables and header values.
* @see RestContext#getBeanContext()
*/
[06/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/CallMethod.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/CallMethod.java b/juneau-rest/src/main/java/org/apache/juneau/rest/CallMethod.java
index f645bc4..8022e1d 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/CallMethod.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/CallMethod.java
@@ -192,7 +192,10 @@ class CallMethod implements Comparable<CallMethod> {
htmlCssUrl = hd.cssUrl().isEmpty() ? context.getHtmlCssUrl() : hd.cssUrl();
htmlNoWrap = hd.nowrap() ? hd.nowrap() : context.getHtmlNoWrap();
htmlNoResultsMessage = hd.noResultsMessage().isEmpty() ? context.getHtmlNoResultsMessage() : hd.header();
- htmlTemplate = hd.template() == HtmlDocTemplate.class ? context.getHtmlTemplate() : ClassUtils.newInstance(HtmlDocTemplate.class, hd.template());
+ htmlTemplate =
+ hd.template() == HtmlDocTemplate.class
+ ? context.getHtmlTemplate()
+ : ClassUtils.newInstance(HtmlDocTemplate.class, hd.template());
List<Inherit> si = Arrays.asList(m.serializersInherit());
List<Inherit> pi = Arrays.asList(m.parsersInherit());
@@ -201,7 +204,9 @@ class CallMethod implements Comparable<CallMethod> {
ParserGroupBuilder pgb = null;
UrlEncodingParserBuilder uepb = null;
- if (m.serializers().length > 0 || m.parsers().length > 0 || m.properties().length > 0 || m.flags().length > 0 || m.beanFilters().length > 0 || m.pojoSwaps().length > 0 || m.bpIncludes().length() > 0 || m.bpExcludes().length() > 0) {
+ if (m.serializers().length > 0 || m.parsers().length > 0 || m.properties().length > 0 || m.flags().length > 0
+ || m.beanFilters().length > 0 || m.pojoSwaps().length > 0 || m.bpIncludes().length() > 0
+ || m.bpExcludes().length() > 0) {
sgb = new SerializerGroupBuilder();
pgb = new ParserGroupBuilder();
uepb = new UrlEncodingParserBuilder(urlEncodingParser.createPropertyStore());
@@ -267,13 +272,15 @@ class CallMethod implements Comparable<CallMethod> {
try {
sgb.includeProperties((Map)JsonParser.DEFAULT.parse(m.bpIncludes(), Map.class, String.class, String.class));
} catch (ParseException e) {
- throw new RestServletException("Invalid format for @RestMethod.bpIncludes() on method ''{0}''. Must be a valid JSON object. \nValue: {1}", sig, m.bpIncludes());
+ throw new RestServletException(
+ "Invalid format for @RestMethod.bpIncludes() on method ''{0}''. Must be a valid JSON object. \nValue: {1}", sig, m.bpIncludes());
}
if (! m.bpExcludes().isEmpty())
try {
sgb.excludeProperties((Map)JsonParser.DEFAULT.parse(m.bpExcludes(), Map.class, String.class, String.class));
} catch (ParseException e) {
- throw new RestServletException("Invalid format for @RestMethod.bpExcludes() on method ''{0}''. Must be a valid JSON object. \nValue: {1}", sig, m.bpExcludes());
+ throw new RestServletException(
+ "Invalid format for @RestMethod.bpExcludes() on method ''{0}''. Must be a valid JSON object. \nValue: {1}", sig, m.bpExcludes());
}
sgb.beanFilters(m.beanFilters());
sgb.pojoSwaps(m.pojoSwaps());
@@ -321,7 +328,8 @@ class CallMethod implements Comparable<CallMethod> {
try {
g.append(c);
} catch (Exception e) {
- throw new RestServletException("Exception occurred while trying to instantiate Encoder on method ''{0}'': ''{1}''", sig, c.getSimpleName()).initCause(e);
+ throw new RestServletException(
+ "Exception occurred while trying to instantiate Encoder on method ''{0}'': ''{1}''", sig, c.getSimpleName()).initCause(e);
}
}
encoders = g.build();
@@ -331,7 +339,8 @@ class CallMethod implements Comparable<CallMethod> {
for (String s : m.defaultRequestHeaders()) {
String[] h = RestUtils.parseKeyValuePair(s);
if (h == null)
- throw new RestServletException("Invalid default request header specified on method ''{0}'': ''{1}''. Must be in the format: ''name[:=]value''", sig, s);
+ throw new RestServletException(
+ "Invalid default request header specified on method ''{0}'': ''{1}''. Must be in the format: ''name[:=]value''", sig, s);
defaultRequestHeaders.put(h[0], h[1]);
}
@@ -339,7 +348,8 @@ class CallMethod implements Comparable<CallMethod> {
for (String s : m.defaultQuery()) {
String[] h = RestUtils.parseKeyValuePair(s);
if (h == null)
- throw new RestServletException("Invalid default query parameter specified on method ''{0}'': ''{1}''. Must be in the format: ''name[:=]value''", sig, s);
+ throw new RestServletException(
+ "Invalid default query parameter specified on method ''{0}'': ''{1}''. Must be in the format: ''name[:=]value''", sig, s);
defaultQuery.put(h[0], h[1]);
}
@@ -347,7 +357,8 @@ class CallMethod implements Comparable<CallMethod> {
for (String s : m.defaultFormData()) {
String[] h = RestUtils.parseKeyValuePair(s);
if (h == null)
- throw new RestServletException("Invalid default form data parameter specified on method ''{0}'': ''{1}''. Must be in the format: ''name[:=]value''", sig, s);
+ throw new RestServletException(
+ "Invalid default form data parameter specified on method ''{0}'': ''{1}''. Must be in the format: ''name[:=]value''", sig, s);
defaultFormData.put(h[0], h[1]);
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/CallRouter.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/CallRouter.java b/juneau-rest/src/main/java/org/apache/juneau/rest/CallRouter.java
index bbac14c..acc4de4 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/CallRouter.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/CallRouter.java
@@ -19,11 +19,11 @@ import java.util.*;
import javax.servlet.http.*;
/**
- * Represents a group of CallMethods on a REST resource that handle the same HTTP Method name but
- * with different paths/matchers/guards/etc...
+ * Represents a group of CallMethods on a REST resource that handle the same HTTP Method name but with different
+ * paths/matchers/guards/etc...
* <p>
- * Incoming requests for a particular HTTP method type (e.g. <js>"GET"</js>) are handed off to this class
- * and then dispatched to the appropriate CallMethod.
+ * Incoming requests for a particular HTTP method type (e.g. <js>"GET"</js>) are handed off to this class and then
+ * dispatched to the appropriate CallMethod.
*/
class CallRouter {
private final CallMethod[] callMethods;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/ReaderResource.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/ReaderResource.java b/juneau-rest/src/main/java/org/apache/juneau/rest/ReaderResource.java
index bed46f1..93478c2 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/ReaderResource.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/ReaderResource.java
@@ -25,8 +25,8 @@ import org.apache.juneau.rest.response.*;
import org.apache.juneau.svl.*;
/**
- * Represents the contents of a text file with convenience methods for resolving
- * {@link Parameter} variables and adding HTTP response headers.
+ * Represents the contents of a text file with convenience methods for resolving {@link Parameter} variables and adding
+ * HTTP response headers.
* <p>
* This class is handled special by the {@link WritableHandler} class.
*/
@@ -39,6 +39,7 @@ public class ReaderResource implements Writable {
/**
* Constructor.
+ *
* @param mediaType The HTTP media type.
* @param contents The contents of this resource.
* <br>If multiple contents are specified, the results will be concatenated.
@@ -56,6 +57,7 @@ public class ReaderResource implements Writable {
/**
* Constructor.
+ *
* @param mediaType The resource media type.
* @param headers The HTTP response headers for this streamed resource.
* @param varSession Optional variable resolver for resolving variables in the string.
@@ -110,6 +112,7 @@ public class ReaderResource implements Writable {
/**
* Specifies the resource media type string.
+ *
* @param mediaType The resource media type string.
* @return This object (for method chaining).
*/
@@ -120,6 +123,7 @@ public class ReaderResource implements Writable {
/**
* Specifies the resource media type string.
+ *
* @param mediaType The resource media type string.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/Redirect.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/Redirect.java b/juneau-rest/src/main/java/org/apache/juneau/rest/Redirect.java
index ad81006..1a79d24 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/Redirect.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/Redirect.java
@@ -23,7 +23,7 @@ import org.apache.juneau.urlencoding.*;
* REST methods can return this object as a shortcut for performing <code>HTTP 302</code> redirects.
* <p>
* The following example shows the difference between handling redirects via the {@link RestRequest}/{@link RestResponse},
- * and the simplified approach of using this class.
+ * and the simplified approach of using this class.
* <p class='bcode'>
* <jc>// Redirect to "/contextPath/servletPath/foobar"</jc>
*
@@ -48,8 +48,8 @@ import org.apache.juneau.urlencoding.*;
* }
* </p>
* <p>
- * The arguments are serialized to strings using the servlet's {@link UrlEncodingSerializer},
- * so any filters defined on the serializer or REST method/class will be used when present.
+ * The arguments are serialized to strings using the servlet's {@link UrlEncodingSerializer}, so any filters defined on
+ * the serializer or REST method/class will be used when present.
* The arguments will also be automatically URL-encoded.
* <p>
* Redirecting to the servlet root can be accomplished by simply using the no-arg constructor.
@@ -62,8 +62,8 @@ import org.apache.juneau.urlencoding.*;
* }
* </p>
* <p>
- * This class is handled by {@link org.apache.juneau.rest.response.RedirectHandler}, a built-in default
- * response handler created in {@link RestConfig}.
+ * This class is handled by {@link org.apache.juneau.rest.response.RedirectHandler}, a built-in default response
+ * handler created in {@link RestConfig}.
*/
public final class Redirect {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RequestBody.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestBody.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestBody.java
index 80fe80a..a7fe2e5 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestBody.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestBody.java
@@ -134,7 +134,7 @@ public class RequestBody {
* <p>
* Refer to <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a> for
* a complete definition of supported POJOs.
- * <p>
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into an integer.</jc>
@@ -166,7 +166,7 @@ public class RequestBody {
/**
* Reads the input from the HTTP request as JSON, XML, or HTML and converts the input to a POJO.
- * <p>
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into a linked-list of strings.</jc>
@@ -183,12 +183,12 @@ public class RequestBody {
* </p>
*
* @param type The type of object to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @param <T> The class type to instantiate.
* @return The input parsed to a POJO.
*/
@@ -230,6 +230,7 @@ public class RequestBody {
* string.
* <p>
* Automatically handles GZipped input streams.
+ *
* @return The body contents as a reader.
* @throws IOException
*/
@@ -260,8 +261,7 @@ public class RequestBody {
* Automatically handles GZipped input streams.
*
* @return The negotiated input stream.
- * @throws IOException If any error occurred while trying to get the input stream or wrap it
- * in the GZIP wrapper.
+ * @throws IOException If any error occurred while trying to get the input stream or wrap it in the GZIP wrapper.
*/
public ServletInputStream getInputStream() throws IOException {
@@ -281,8 +281,8 @@ public class RequestBody {
/**
* Returns the parser and media type matching the request <code>Content-Type</code> header.
*
- * @return The parser matching the request <code>Content-Type</code> header, or <jk>null</jk>
- * if no matching parser was found.
+ * @return The parser matching the request <code>Content-Type</code> header, or <jk>null</jk> if no matching parser
+ * was found.
* Includes the matching media type.
*/
public ParserMatch getParserMatch() {
@@ -305,8 +305,8 @@ public class RequestBody {
/**
* Returns the parser matching the request <code>Content-Type</code> header.
*
- * @return The parser matching the request <code>Content-Type</code> header, or <jk>null</jk>
- * if no matching parser was found.
+ * @return The parser matching the request <code>Content-Type</code> header, or <jk>null</jk> if no matching parser
+ * was found.
*/
public Parser getParser() {
ParserMatch pm = getParserMatch();
@@ -316,8 +316,8 @@ public class RequestBody {
/**
* Returns the reader parser matching the request <code>Content-Type</code> header.
*
- * @return The reader parser matching the request <code>Content-Type</code> header, or <jk>null</jk>
- * if no matching reader parser was found, or the matching parser was an input stream parser.
+ * @return The reader parser matching the request <code>Content-Type</code> header, or <jk>null</jk> if no matching
+ * reader parser was found, or the matching parser was an input stream parser.
*/
public ReaderParser getReaderParser() {
Parser p = getParser();
@@ -399,6 +399,7 @@ public class RequestBody {
/**
* Returns the content length of the body.
+ *
* @return The content length of the body in bytes.
*/
public int getContentLength() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RequestFormData.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestFormData.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestFormData.java
index 7de7cdb..4c56c33 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestFormData.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestFormData.java
@@ -77,12 +77,14 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
* Returns a form data parameter value.
* <p>
* Parameter lookup is case-insensitive (consistent with WAS, but differs from Tomcat).
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>Calling this method on URL-Encoded FORM posts causes the body content to be loaded and parsed by the underlying servlet API.
- * <li>This method returns the raw unparsed value, and differs from calling <code>getFormDataParameter(name, String.<jk>class</js>)</code>
- * which will convert the value from UON notation:
+ * <li>Calling this method on URL-Encoded FORM posts causes the body content to be loaded and parsed by the
+ * underlying servlet API.
+ * <li>This method returns the raw unparsed value, and differs from calling
+ * <code>getFormDataParameter(name, String.<jk>class</js>)</code> which will convert the value from UON
+ * notation:
* <ul>
* <li><js>"null"</js> => <jk>null</jk>
* <li><js>"'null'"</js> => <js>"null"</js>
@@ -165,9 +167,9 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
}
/**
- * Returns the specified form data parameter value converted to a POJO using the
- * {@link UrlEncodingParser} registered with this servlet.
- * <p>
+ * Returns the specified form data parameter value converted to a POJO using the {@link UrlEncodingParser}
+ * registered with this servlet.
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into an integer.</jc>
@@ -185,10 +187,11 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
* <jc>// Parse into a map of object keys/values.</jc>
* Map myparam = req.getFormDataParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>);
* </p>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>Calling this method on URL-Encoded FORM posts causes the body content to be loaded and parsed by the underlying servlet API.
+ * <li>Calling this method on URL-Encoded FORM posts causes the body content to be loaded and parsed by the
+ * underlying servlet API.
* </ul>
*
* @param name The parameter name.
@@ -217,7 +220,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Class)} except for use on multi-part parameters
- * (e.g. <js>"key=1&key=2&key=3"</js> instead of <js>"key=(1,2,3)"</js>)
+ * (e.g. <js>"key=1&key=2&key=3"</js> instead of <js>"key=(1,2,3)"</js>)
* <p>
* This method must only be called when parsing into classes of type Collection or array.
*
@@ -231,15 +234,16 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
}
/**
- * Returns the specified form data parameter value converted to a POJO using the
- * {@link UrlEncodingParser} registered with this servlet.
- * <p>
+ * Returns the specified form data parameter value converted to a POJO using the {@link UrlEncodingParser}
+ * registered with this servlet.
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>Calling this method on URL-Encoded FORM posts causes the body content to be loaded and parsed by the underlying servlet API.
+ * <li>Calling this method on URL-Encoded FORM posts causes the body content to be loaded and parsed by the
+ * underlying servlet API.
* <li>Use this method if you want to parse into a parameterized <code>Map</code>/<code>Collection</code> object.
* </ul>
- * <p>
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into a linked-list of strings.</jc>
@@ -257,10 +261,12 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
*
* @param name The parameter name.
* @param type The type of object to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @return The parameter value converted to the specified class type.
* @throws ParseException
*/
@@ -270,16 +276,18 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Type, Type...)} except for use on multi-part parameters
- * (e.g. <js>"key=1&key=2&key=3"</js> instead of <js>"key=(1,2,3)"</js>)
+ * (e.g. <js>"key=1&key=2&key=3"</js> instead of <js>"key=(1,2,3)"</js>)
* <p>
* This method must only be called when parsing into classes of type Collection or array.
*
* @param name The parameter name.
* @param type The type of object to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @return The parameter value converted to the specified class type.
* @throws ParseException
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RequestHeaders.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestHeaders.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestHeaders.java
index 992f954..ff3f3cd 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestHeaders.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestHeaders.java
@@ -99,7 +99,8 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the specified header value, or <jk>null</jk> if the header doesn't exist.
* <p>
- * If {@code allowHeaderParams} init parameter is <jk>true</jk>, then first looks for {@code &HeaderName=x} in the URL query string.
+ * If {@code allowHeaderParams} init parameter is <jk>true</jk>, then first looks for {@code &HeaderName=x} in the
+ * URL query string.
* <p>
* @param name The header name.
* @return The header value, or <jk>null</jk> if it doesn't exist.
@@ -118,7 +119,8 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the specified header value, or a default value if the header doesn't exist.
* <p>
- * If {@code allowHeaderParams} init parameter is <jk>true</jk>, then first looks for {@code &HeaderName=x} in the URL query string.
+ * If {@code allowHeaderParams} init parameter is <jk>true</jk>, then first looks for {@code &HeaderName=x} in the
+ * URL query string.
*
* @param name The HTTP header name.
* @param def The default value to return if the header value isn't found.
@@ -186,9 +188,9 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the specified header value converted to a POJO.
* <p>
- * The type can be any POJO type convertable from a <code>String</code>
- * (See <a class="doclink" href="package-summary.html#PojosConvertableFromString">POJOs Convertable From Strings</a>).
- * <p>
+ * The type can be any POJO type convertible from a <code>String</code>
+ * (See <a class="doclink" href="package-summary.html#PojosConvertableFromString">POJOs Convertible From Strings</a>).
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into an integer.</jc>
@@ -227,9 +229,9 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the specified header value converted to a POJO.
* <p>
- * The type can be any POJO type convertable from a <code>String</code>
- * (See <a class="doclink" href="package-summary.html#PojosConvertableFromString">POJOs Convertable From Strings</a>).
- * <p>
+ * The type can be any POJO type convertible from a <code>String</code>
+ * (See <a class="doclink" href="package-summary.html#PojosConvertableFromString">POJOs Convertible From Strings</a>).
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into a linked-list of strings.</jc>
@@ -238,10 +240,12 @@ public class RequestHeaders extends TreeMap<String,String[]> {
*
* @param name The HTTP header name.
* @param type The type of object to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @param <T> The class type to convert the header value to.
* @return The parameter value converted to the specified class type.
* @throws ParseException If the header could not be converted to the specified type.
@@ -254,6 +258,7 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns a copy of this object, but only with the specified header names copied.
+ *
* @param headers The headers to include in the copy.
* @return A new headers object.
*/
@@ -267,6 +272,7 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Same as {@link #subset(String...)}, but allows you to specify header names as a comma-delimited list.
+ *
* @param headers The headers to include in the copy.
* @return A new headers object.
*/
@@ -285,7 +291,6 @@ public class RequestHeaders extends TreeMap<String,String[]> {
* </p>
*
* @return The parsed <code>Accept</code> header on the request, or <jk>null</jk> if not found.
- *
*/
public Accept getAccept() {
return Accept.forString(getString("Accept"));
@@ -490,7 +495,8 @@ public class RequestHeaders extends TreeMap<String,String[]> {
* Returns the <code>If-Match</code> header on the request.
* <p>
* Only perform the action if the client supplied entity matches the same entity on the server.
- * This is mainly for methods like PUT to only update a resource if it has not been modified since the user last updated it.
+ * This is mainly for methods like PUT to only update a resource if it has not been modified since the user last
+ * updated it.
*
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RequestPathMatch.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestPathMatch.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestPathMatch.java
index 7712a3d..fa75767 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestPathMatch.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestPathMatch.java
@@ -66,9 +66,9 @@ public class RequestPathMatch extends TreeMap<String,String> {
/**
* Returns the specified path parameter converted to a POJO.
* <p>
- * The type can be any POJO type convertable from a <code>String</code> (See <a class="doclink"
- * href="package-summary.html#PojosConvertableFromString">POJOs Convertable From Strings</a>).
- * <p>
+ * The type can be any POJO type convertible from a <code>String</code> (See <a class="doclink"
+ * href="package-summary.html#PojosConvertibleFromString">POJOs Convertible From Strings</a>).
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into an integer.</jc>
@@ -100,10 +100,11 @@ public class RequestPathMatch extends TreeMap<String,String> {
/**
* Returns the specified path parameter converted to a POJO.
* <p>
- * The type can be any POJO type convertable from a <code>String</code> (See <a class="doclink" href="package-summary.html#PojosConvertableFromString">POJOs Convertable From Strings</a>).
+ * The type can be any POJO type convertible from a <code>String</code> (See <a class="doclink"
+ * href="package-summary.html#PojosConvertibleFromString">POJOs Convertible From Strings</a>).
* <p>
* Use this method if you want to parse into a parameterized <code>Map</code>/<code>Collection</code> object.
- * <p>
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into a linked-list of strings.</jc>
@@ -121,10 +122,12 @@ public class RequestPathMatch extends TreeMap<String,String> {
*
* @param name The attribute name.
* @param type The type of object to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @param <T> The class type to convert the attribute value to.
* @return The attribute value converted to the specified class type.
* @throws ParseException
@@ -205,7 +208,7 @@ public class RequestPathMatch extends TreeMap<String,String> {
/**
* Same as {@link #getRemainder()} but doesn't decode characters.
*
- * @return The undecoded path remainder.
+ * @return The un-decoded path remainder.
*/
public String getRemainderUndecoded() {
return remainder;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RequestQuery.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestQuery.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestQuery.java
index 104e4b9..c4d9a7c 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestQuery.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestQuery.java
@@ -79,9 +79,11 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Returns a query parameter value.
* <p>
- * Same as {@link HttpServletRequest#getParameter(String)} except only looks in the URL string, not parameters from URL-Encoded FORM posts.
+ * Same as {@link HttpServletRequest#getParameter(String)} except only looks in the URL string, not parameters from
+ * URL-Encoded FORM posts.
* <p>
- * This method can be used to retrieve a parameter without triggering the underlying servlet API to load and parse the request body.
+ * This method can be used to retrieve a parameter without triggering the underlying servlet API to load and parse
+ * the request body.
* <p>
* If multiple query parameters have the same name, this returns only the first instance.
*
@@ -103,11 +105,13 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
}
/**
- * Same as {@link #getString(String)} but returns the specified default value if the query parameter was not specified.
+ * Same as {@link #getString(String)} but returns the specified default value if the query parameter was not
+ * specified.
*
* @param name The URL parameter name.
* @param def The default value.
- * @return The parameter value, or the default value if parameter not specified or has no value (e.g. <js>"&foo"</js>.
+ * @return The parameter value, or the default value if parameter not specified or has no value
+ * (e.g. <js>"&foo"</js>.
*/
public String getString(String name, String def) {
String s = getString(name);
@@ -118,7 +122,8 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
* Same as {@link #getString(String)} but converts the value to an integer.
*
* @param name The URL parameter name.
- * @return The parameter value, or <code>0</code> if parameter not specified or has no value (e.g. <js>"&foo"</js>.
+ * @return The parameter value, or <code>0</code> if parameter not specified or has no value
+ * (e.g. <js>"&foo"</js>.
*/
public int getInt(String name) {
return getInt(name, 0);
@@ -129,7 +134,8 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
*
* @param name The URL parameter name.
* @param def The default value.
- * @return The parameter value, or the default value if parameter not specified or has no value (e.g. <js>"&foo"</js>.
+ * @return The parameter value, or the default value if parameter not specified or has no value
+ * (e.g. <js>"&foo"</js>.
*/
public int getInt(String name, int def) {
String s = getString(name);
@@ -140,7 +146,8 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
* Same as {@link #getString(String)} but converts the value to a boolean.
*
* @param name The URL parameter name.
- * @return The parameter value, or <jk>false</jk> if parameter not specified or has no value (e.g. <js>"&foo"</js>.
+ * @return The parameter value, or <jk>false</jk> if parameter not specified or has no value
+ * (e.g. <js>"&foo"</js>.
*/
public boolean getBoolean(String name) {
return getBoolean(name, false);
@@ -151,7 +158,8 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
*
* @param name The URL parameter name.
* @param def The default value.
- * @return The parameter value, or the default value if parameter not specified or has no value (e.g. <js>"&foo"</js>.
+ * @return The parameter value, or the default value if parameter not specified or has no value
+ * (e.g. <js>"&foo"</js>.
*/
public boolean getBoolean(String name, boolean def) {
String s = getString(name);
@@ -161,8 +169,9 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Returns the specified query parameter value converted to a POJO.
* <p>
- * This method can be used to retrieve a parameter without triggering the underlying servlet API to load and parse the request body.
- * <p>
+ * This method can be used to retrieve a parameter without triggering the underlying servlet API to load and parse
+ * the request body.
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into an integer.</jc>
@@ -208,10 +217,11 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Returns the specified query parameter value converted to a POJO.
* <p>
- * This method can be used to retrieve a parameter without triggering the underlying servlet API to load and parse the request body.
+ * This method can be used to retrieve a parameter without triggering the underlying servlet API to load and parse
+ * the request body.
* <p>
* Use this method if you want to parse into a parameterized <code>Map</code>/<code>Collection</code> object.
- * <p>
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into a linked-list of strings.</jc>
@@ -229,10 +239,12 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
*
* @param name The parameter name.
* @param type The type of object to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @param <T> The class type to convert the parameter value to.
* @return The parameter value converted to the specified class type.
* @throws ParseException
@@ -246,10 +258,12 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
*
* @param name The parameter name.
* @param type The type of object to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @param def The default value if the parameter was not specified or is <jk>null</jk>.
* @param <T> The class type to convert the parameter value to.
* @return The parameter value converted to the specified class type.
@@ -283,10 +297,12 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
*
* @param name The query parameter name.
* @param type The type of object to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @param <T> The class type to convert the parameter value to.
* @return The query parameter value converted to the specified class type.
* @throws ParseException
@@ -313,26 +329,32 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
* <p>
* The query arguments are as follows:
* <ul>
- * <li><js>"&s="</js> - A comma-delimited list of column-name/search-token pairs.
+ * <li>
+ * <js>"&s="</js> - A comma-delimited list of column-name/search-token pairs.
* <br>Example: <js>"&s=column1=foo*,column2=*bar"</js>
- * <li><js>"&v="</js> - A comma-delimited list column names to view.
+ * <li>
+ * <js>"&v="</js> - A comma-delimited list column names to view.
* <br>Example: <js>"&v=column1,column2"</js>
- * <li><js>"&o="</js> - A comma-delimited list column names to sort by.
+ * <li>
+ * <js>"&o="</js> - A comma-delimited list column names to sort by.
* <br>Column names can be suffixed with <js>'-'</js> to indicate descending order.
* <br>Example: <js>"&o=column1,column2-"</js>
- * <li><js>"&p="</js> - The zero-index row number of the first row to display.
+ * <li>
+ * <js>"&p="</js> - The zero-index row number of the first row to display.
* <br>Example: <js>"&p=100"</js>
- * <li><js>"&l="</js> - The number of rows to return.
+ * <li>
+ * <js>"&l="</js> - The number of rows to return.
* <br><code>0</code> implies return all rows.
* <br>Example: <js>"&l=100"</js>
- * <li><js>"&i="</js> - The case-insensitive search flag.
+ * <li>
+ * <js>"&i="</js> - The case-insensitive search flag.
* <br>Example: <js>"&i=true"</js>
* </ul>
* <p>
* Whitespace is trimmed in the parameters.
*
* @return A new {@link SearchArgs} object initialized with the special search query arguments.
- * <jk>null</jk> if no search arguments were found.
+ * <jk>null</jk> if no search arguments were found.
*/
public SearchArgs getSearchArgs() {
if (hasAny("s","v","o","p","l","i")) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/ResponseHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/ResponseHandler.java b/juneau-rest/src/main/java/org/apache/juneau/rest/ResponseHandler.java
index da7c3e9..43dbc4f 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/ResponseHandler.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/ResponseHandler.java
@@ -23,32 +23,41 @@ import org.apache.juneau.rest.response.*;
/**
* Defines the interface for handlers that convert POJOs to appropriate HTTP responses.
* <p>
- * The {@link RestServlet} API uses the concept of registered response handlers for
- * converting objects returned by REST methods or set through {@link RestResponse#setOutput(Object)}
- * into appropriate HTTP responses.
+ * The {@link RestServlet} API uses the concept of registered response handlers for converting objects returned by REST
+ * methods or set through {@link RestResponse#setOutput(Object)} into appropriate HTTP responses.
* <p>
* Response handlers can be associated with {@link RestServlet RestServlets} through the following ways:
* <ul class='spaced-list'>
- * <li>Through the {@link RestResource#responseHandlers @RestResource.responseHandlers} annotation.
- * <li>By calling the {@link RestConfig#addResponseHandlers(Class...)} and augmenting or creating your
+ * <li>
+ * Through the {@link RestResource#responseHandlers @RestResource.responseHandlers} annotation.
+ * <li>
+ * By calling the {@link RestConfig#addResponseHandlers(Class...)} and augmenting or creating your
* own list of handlers.
* </ul>
* <p>
* By default, {@link RestServlet RestServlets} are registered with the following response handlers:
* <ul class='spaced-list'>
- * <li>{@link DefaultHandler} - Serializes POJOs using the Juneau serializer API.
- * <li>{@link ReaderHandler} - Pipes the output of {@link Reader Readers} to the response writer ({@link RestResponse#getWriter()}).
- * <li>{@link InputStreamHandler} - Pipes the output of {@link InputStream InputStreams} to the response output stream ({@link RestResponse#getOutputStream()}).
- * <li>{@link RedirectHandler} - Handles {@link Redirect} objects.
- * <li>{@link WritableHandler} - Handles {@link Writable} objects.
- * <li>{@link StreamableHandler} - Handles {@link Streamable} objects.
+ * <li>
+ * {@link DefaultHandler} - Serializes POJOs using the Juneau serializer API.
+ * <li>
+ * {@link ReaderHandler} - Pipes the output of {@link Reader Readers} to the response writer
+ * ({@link RestResponse#getWriter()}).
+ * <li>
+ * {@link InputStreamHandler} - Pipes the output of {@link InputStream InputStreams} to the response output
+ * stream ({@link RestResponse#getOutputStream()}).
+ * <li>
+ * {@link RedirectHandler} - Handles {@link Redirect} objects.
+ * <li>
+ * {@link WritableHandler} - Handles {@link Writable} objects.
+ * <li>
+ * {@link StreamableHandler} - Handles {@link Streamable} objects.
* </ul>
* <p>
* Response handlers can be used to process POJOs that cannot normally be handled through Juneau serializers, or
- * because it's simply easier to define response handlers for special cases.
+ * because it's simply easier to define response handlers for special cases.
* <p>
- * The following example shows how to create a response handler to handle special <code>Foo</code> objects outside the normal
- * Juneau architecture.
+ * The following example shows how to create a response handler to handle special <code>Foo</code> objects outside the
+ * normal Juneau architecture.
* <p class='bcode'>
* <ja>@RestResource</ja>(
* path=<js>"/example"</js>,
@@ -87,8 +96,10 @@ public interface ResponseHandler {
* @param res The HTTP servlet response;
* @param output The POJO returned by the REST method that now needs to be sent to the response.
* @return true If this handler handled the response.
- * @throws IOException If low-level exception occurred on output stream. Results in a {@link HttpServletResponse#SC_INTERNAL_SERVER_ERROR} error.
- * @throws RestException If some other exception occurred. Can be used to provide an appropriate HTTP response code and message.
+ * @throws IOException If low-level exception occurred on output stream.
+ * Results in a {@link HttpServletResponse#SC_INTERNAL_SERVER_ERROR} error.
+ * @throws RestException If some other exception occurred.
+ * Can be used to provide an appropriate HTTP response code and message.
*/
boolean handle(RestRequest req, RestResponse res, Object output) throws IOException, RestException;
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestCallHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestCallHandler.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestCallHandler.java
index d60c489..663b184 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestCallHandler.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestCallHandler.java
@@ -47,6 +47,7 @@ public class RestCallHandler {
/**
* Constructor.
+ *
* @param context The resource context.
*/
public RestCallHandler(RestContext context) {
@@ -71,7 +72,7 @@ public class RestCallHandler {
/**
* Creates a {@link RestResponse} object based on the specified incoming {@link HttpServletResponse} object
- * and the request returned by {@link #createRequest(HttpServletRequest)}.
+ * and the request returned by {@link #createRequest(HttpServletRequest)}.
* <p>
* Subclasses may choose to override this method to provide a specialized response object.
*
@@ -188,14 +189,15 @@ public class RestCallHandler {
}
/**
- * The main method for serializing POJOs passed in through the {@link RestResponse#setOutput(Object)} method or returned by
- * the Java method.
+ * The main method for serializing POJOs passed in through the {@link RestResponse#setOutput(Object)} method or
+ * returned by the Java method.
* <p>
- * Subclasses may override this method if they wish to modify the way the output is rendered or support
- * other output formats.
+ * Subclasses may override this method if they wish to modify the way the output is rendered or support other output
+ * formats.
* <p>
* The default implementation simply iterates through the response handlers on this resource
- * looking for the first one whose {@link ResponseHandler#handle(RestRequest, RestResponse, Object)} method returns <jk>true</jk>.
+ * looking for the first one whose {@link ResponseHandler#handle(RestRequest, RestResponse, Object)} method returns
+ * <jk>true</jk>.
*
* @param req The HTTP request.
* @param res The HTTP response.
@@ -239,7 +241,8 @@ public class RestCallHandler {
/**
* Method for handling response errors.
* <p>
- * The default implementation logs the error and calls {@link #renderError(HttpServletRequest,HttpServletResponse,RestException)}.
+ * The default implementation logs the error and calls
+ * {@link #renderError(HttpServletRequest,HttpServletResponse,RestException)}.
* <p>
* Subclasses can override this method to provide their own custom error response handling.
*
@@ -257,8 +260,8 @@ public class RestCallHandler {
/**
* Method for rendering response errors.
* <p>
- * The default implementation renders a plain text English message, optionally with a stack trace
- * if {@link RestContext#REST_renderResponseStackTraces} is enabled.
+ * The default implementation renders a plain text English message, optionally with a stack trace if
+ * {@link RestContext#REST_renderResponseStackTraces} is enabled.
* <p>
* Subclasses can override this method to provide their own custom error response handling.
*
@@ -316,8 +319,8 @@ public class RestCallHandler {
/**
* Callback method that gets invoked right before the REST Java method is invoked.
* <p>
- * Subclasses can override this method to override request headers or set request-duration properties
- * before the Java method is invoked.
+ * Subclasses can override this method to override request headers or set request-duration properties before the
+ * Java method is invoked.
*
* @param req The HTTP servlet request object.
* @throws RestException If any error occurs.
@@ -328,11 +331,11 @@ public class RestCallHandler {
}
/**
- * Callback method that gets invoked right after the REST Java method is invoked, but before
- * the serializer is invoked.
+ * Callback method that gets invoked right after the REST Java method is invoked, but before the serializer is
+ * invoked.
* <p>
- * Subclasses can override this method to override request and response headers, or
- * set/override properties used by the serializer.
+ * Subclasses can override this method to override request and response headers, or set/override properties used by
+ * the serializer.
*
* @param req The HTTP servlet request object.
* @param res The HTTP servlet response object.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestConfig.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestConfig.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestConfig.java
index df84f52..0e99c03 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestConfig.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestConfig.java
@@ -278,7 +278,7 @@ public class RestConfig implements ServletConfig {
* used to resolve string variables of the form <js>"$X{...}"</js>.
* <p>
* By default, this config includes the following variables:
- * <ul class='spaced-list'>
+ * <ul>
* <li>{@link SystemPropertiesVar}
* <li>{@link EnvVariablesVar}
* <li>{@link ConfigFileVar}
@@ -308,11 +308,12 @@ public class RestConfig implements ServletConfig {
/**
* Adds a var context object to this config.
* <p>
- * Var context objects are read-only objects associated with the variable resolver for
- * vars that require external information.
+ * Var context objects are read-only objects associated with the variable resolver for vars that require external
+ * information.
* <p>
- * For example, the {@link ConfigFileVar} needs access to this resource's {@link ConfigFile} through the {@link ConfigFileVar#SESSION_config}
- * object that can be specified as either a session object (temporary) or context object (permanent).
+ * For example, the {@link ConfigFileVar} needs access to this resource's {@link ConfigFile} through the
+ * {@link ConfigFileVar#SESSION_config} object that can be specified as either a session object (temporary) or
+ * context object (permanent).
* In this case, we call the following code to add it to the context map:
* <p class='bcode'>
* config.addVarContextObject(<jsf>SESSION_config</jsf>, configFile);
@@ -330,7 +331,8 @@ public class RestConfig implements ServletConfig {
/**
* Overwrites the default config file with a custom config file.
* <p>
- * By default, the config file is determined using the {@link RestResource#config() @RestResource.config()} annotation.
+ * By default, the config file is determined using the {@link RestResource#config() @RestResource.config()}
+ * annotation.
* This method allows you to programmatically override it with your own custom config file.
*
* @param configFile The new config file.
@@ -373,9 +375,11 @@ public class RestConfig implements ServletConfig {
/**
* Adds class-level bean filters to this resource.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#beanFilters() @RestResource.beanFilters()} annotation.
+ * This is the programmatic equivalent to the {@link RestResource#beanFilters() @RestResource.beanFilters()}
+ * annotation.
* <p>
- * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.
+ * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
+ * annotation.
*
* @param beanFilters The bean filters to add to this config.
* @return This object (for method chaining).
@@ -390,7 +394,8 @@ public class RestConfig implements ServletConfig {
* <p>
* This is the programmatic equivalent to the {@link RestResource#pojoSwaps() @RestResource.pojoSwaps()} annotation.
* <p>
- * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.
+ * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
+ * annotation.
*
* @param pojoSwaps The pojo swaps to add to this config.
* @return This object (for method chaining).
@@ -403,7 +408,8 @@ public class RestConfig implements ServletConfig {
/**
* Specifies the serializer listener class to use for listening to non-fatal serialization errors.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#serializerListener() @RestResource.serializerListener()} annotation.
+ * This is the programmatic equivalent to the
+ * {@link RestResource#serializerListener() @RestResource.serializerListener()} annotation.
*
* @param listener The listener to add to this config.
* @return This object (for method chaining).
@@ -417,7 +423,8 @@ public class RestConfig implements ServletConfig {
/**
* Specifies the parser listener class to use for listening to non-fatal parse errors.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#parserListener() @RestResource.parserListener()} annotation.
+ * This is the programmatic equivalent to the
+ * {@link RestResource#parserListener() @RestResource.parserListener()} annotation.
*
* @param listener The listener to add to this config.
* @return This object (for method chaining).
@@ -431,7 +438,8 @@ public class RestConfig implements ServletConfig {
/**
* Adds class-level parameter resolvers to this resource.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#paramResolvers() @RestResource.paramResolvers()} annotation.
+ * This is the programmatic equivalent to the
+ * {@link RestResource#paramResolvers() @RestResource.paramResolvers()} annotation.
*
* @param paramResolvers The parameter resolvers to add to this config.
* @return This object (for method chaining).
@@ -444,9 +452,11 @@ public class RestConfig implements ServletConfig {
/**
* Adds class-level serializers to this resource.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#serializers() @RestResource.serializers()} annotation.
+ * This is the programmatic equivalent to the {@link RestResource#serializers() @RestResource.serializers()}
+ * annotation.
* <p>
- * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.
+ * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
+ * annotation.
*
* @param serializers The serializer classes to add to this config.
* @return This object (for method chaining).
@@ -460,12 +470,14 @@ public class RestConfig implements ServletConfig {
* Adds class-level serializers to this resource.
* <p>
* Same as {@link #addSerializers(Class...)} except allows you to pass in serializer instances.
- * The actual serializer ends up being the result of this operation using the bean filters, pojo swaps, and properties on this config:
+ * The actual serializer ends up being the result of this operation using the bean filters, pojo swaps, and
+ * properties on this config:
* <p class='bcode'>
* serializer = serializer.builder().beanFilters(beanFilters).pojoSwaps(pojoSwaps).properties(properties).build();
* </p>
* <p>
- * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.
+ * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
+ * annotation.
*
* @param serializers The serializers to add to this config.
* @return This object (for method chaining).
@@ -480,7 +492,8 @@ public class RestConfig implements ServletConfig {
* <p>
* This is the programmatic equivalent to the {@link RestResource#parsers() @RestResource.parsers()} annotation.
* <p>
- * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.
+ * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
+ * annotation.
*
* @param parsers The parser classes to add to this config.
* @return This object (for method chaining).
@@ -494,12 +507,14 @@ public class RestConfig implements ServletConfig {
* Adds class-level parsers to this resource.
* <p>
* Same as {@link #addParsers(Class...)} except allows you to pass in parser instances.
- * The actual parser ends up being the result of this operation using the bean filters, pojo swaps, and properties on this config:
+ * The actual parser ends up being the result of this operation using the bean filters, pojo swaps, and properties
+ * on this config:
* <p class='bcode'>
* parser = parser.builder().beanFilters(beanFilters).pojoSwaps(pojoSwaps).properties(properties).build();
* </p>
* <p>
- * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.
+ * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
+ * annotation.
*
* @param parsers The parsers to add to this config.
* @return This object (for method chaining).
@@ -514,7 +529,8 @@ public class RestConfig implements ServletConfig {
* <p>
* This is the programmatic equivalent to the {@link RestResource#encoders() @RestResource.encoders()} annotation.
* <p>
- * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.
+ * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
+ * annotation.
* <p>
* By default, only the {@link IdentityEncoder} is included in this list.
*
@@ -542,12 +558,14 @@ public class RestConfig implements ServletConfig {
/**
* Adds class-level converters to this resource.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#converters() @RestResource.converters()} annotation.
+ * This is the programmatic equivalent to the {@link RestResource#converters() @RestResource.converters()}
+ * annotation.
* <p>
- * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.
+ * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
+ * annotation.
* <p>
* By default, this config includes the following converters:
- * <ul class='spaced-list'>
+ * <ul>
* <li>{@link StreamableHandler}
* <li>{@link WritableHandler}
* <li>{@link ReaderHandler}
@@ -582,7 +600,8 @@ public class RestConfig implements ServletConfig {
* <p>
* This is the programmatic equivalent to the {@link RestResource#guards() @RestResource.guards()} annotation.
* <p>
- * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.
+ * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
+ * annotation.
*
* @param guards The guard classes to add to this config.
* @return This object (for method chaining).
@@ -617,7 +636,7 @@ public class RestConfig implements ServletConfig {
* Refer to {@link MimetypesFileTypeMap#addMimeTypes(String)} for an explanation of the format.
* <p>
* By default, this config includes the following mime-type definitions:
- * <ul class='spaced-list'>
+ * <ul>
* <li><js>"text/css css CSS"</js>
* <li><js>"text/html html htm HTML"</js>
* <li><js>"text/plain txt text TXT"</js>
@@ -641,9 +660,11 @@ public class RestConfig implements ServletConfig {
* Adds class-level default HTTP request headers to this resource.
* <p>
* Default request headers are default values for when HTTP requests do not specify a header value.
- * For example, you can specify a default value for <code>Accept</code> if a request does not specify that header value.
+ * For example, you can specify a default value for <code>Accept</code> if a request does not specify that header
+ * value.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#defaultRequestHeaders() @RestResource.defaultRequestHeaders()} annotation.
+ * This is the programmatic equivalent to the
+ * {@link RestResource#defaultRequestHeaders() @RestResource.defaultRequestHeaders()} annotation.
*
* @param name The HTTP header name.
* @param value The HTTP header value.
@@ -658,9 +679,11 @@ public class RestConfig implements ServletConfig {
* Adds class-level default HTTP request headers to this resource.
* <p>
* Default request headers are default values for when HTTP requests do not specify a header value.
- * For example, you can specify a default value for <code>Accept</code> if a request does not specify that header value.
+ * For example, you can specify a default value for <code>Accept</code> if a request does not specify that header
+ * value.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#defaultRequestHeaders() @RestResource.defaultRequestHeaders()} annotation.
+ * This is the programmatic equivalent to the
+ * {@link RestResource#defaultRequestHeaders() @RestResource.defaultRequestHeaders()} annotation.
*
* @param headers HTTP headers of the form <js>"Name: Value"</js>.
* @return This object (for method chaining).
@@ -680,11 +703,13 @@ public class RestConfig implements ServletConfig {
* Adds class-level default HTTP response headers to this resource.
* <p>
* Default response headers are headers that will be appended to all responses if those headers have not already been
- * set on the response object.
+ * set on the response object.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#defaultResponseHeaders() @RestResource.defaultResponseHeaders()} annotation.
+ * This is the programmatic equivalent to the
+ * {@link RestResource#defaultResponseHeaders() @RestResource.defaultResponseHeaders()} annotation.
* <p>
- * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the annotation.
+ * Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
+ * annotation.
*
* @param name The HTTP header name.
* @param value The HTTP header value.
@@ -699,9 +724,10 @@ public class RestConfig implements ServletConfig {
* Adds class-level default HTTP response headers to this resource.
* <p>
* Default response headers are headers that will be appended to all responses if those headers have not already been
- * set on the response object.
+ * set on the response object.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#defaultResponseHeaders() @RestResource.defaultResponseHeaders()} annotation.
+ * This is the programmatic equivalent to the
+ * {@link RestResource#defaultResponseHeaders() @RestResource.defaultResponseHeaders()} annotation.
*
* @param headers HTTP headers of the form <js>"Name: Value"</js>.
* @return This object (for method chaining).
@@ -723,7 +749,7 @@ public class RestConfig implements ServletConfig {
* Response handlers are responsible for converting various POJOs returned by REST methods into actual HTTP responses.
* <p>
* By default, this config includes the following response handlers:
- * <ul class='spaced-list'>
+ * <ul>
* <li>{@link StreamableHandler}
* <li>{@link WritableHandler}
* <li>{@link ReaderHandler}
@@ -732,7 +758,8 @@ public class RestConfig implements ServletConfig {
* <li>{@link DefaultHandler}
* </ul>
* <p>
- * This is the programmatic equivalent to the {@link RestResource#responseHandlers() @RestResource.responseHandlers()} annotation.
+ * This is the programmatic equivalent to the
+ * {@link RestResource#responseHandlers() @RestResource.responseHandlers()} annotation.
*
* @param responseHandlers The response handlers to add to this config.
* @return This object (for method chaining).
@@ -880,7 +907,8 @@ public class RestConfig implements ServletConfig {
* <li>{@link CharSequence}
* <li><code><jk>byte</jk>[]</code>
* </ul>
- * The contents of all these stylesheets will be aggregated into a single page in the order they are specified in this list.
+ * The contents of all these stylesheets will be aggregated into a single page in the order they are specified in
+ * this list.
*
* @param styleSheets The new list of style sheets that make up the <code>styles.css</code> page.
* @return This object (for method chaining).
@@ -983,12 +1011,14 @@ public class RestConfig implements ServletConfig {
* <p>
* Use this method to specify resources located in the classpath to be served up as static files.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#staticFiles() @RestResource.staticFiles()} annotation.
+ * This is the programmatic equivalent to the {@link RestResource#staticFiles() @RestResource.staticFiles()}
+ * annotation.
*
* @param resourceClass The resource class used to resolve the resource streams.
* @param staticFilesString A JSON string denoting a map of child URLs to classpath subdirectories.
* For example, if this string is <js>"{htdocs:'docs'}"</js> with class <code>com.foo.MyResource</code>,
- * then URLs of the form <js>"/resource-path/htdocs/..."</js> will resolve to files located in the <code>com.foo.docs</code> package.
+ * then URLs of the form <js>"/resource-path/htdocs/..."</js> will resolve to files located in the
+ * <code>com.foo.docs</code> package.
* @return This object (for method chaining).
*/
public RestConfig addStaticFiles(Class<?> resourceClass, String staticFilesString) {
@@ -1001,10 +1031,12 @@ public class RestConfig implements ServletConfig {
/**
* Overrides the default REST resource resolver.
* <p>
- * The resource resolver is used to resolve instances from {@link Class} objects defined in the {@link RestResource#children()} annotation.
+ * The resource resolver is used to resolve instances from {@link Class} objects defined in the
+ * {@link RestResource#children()} annotation.
* The default value is the base class {@link RestResourceResolver}.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#resourceResolver() @RestResource.resourceResolver()} annotation.
+ * This is the programmatic equivalent to the
+ * {@link RestResource#resourceResolver() @RestResource.resourceResolver()} annotation.
*
* @param resourceResolver The new resource resolver.
* @return This object (for method chaining).
@@ -1045,7 +1077,8 @@ public class RestConfig implements ServletConfig {
/**
* Sets name of the header used to denote the client version on HTTP requests.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#clientVersionHeader() @RestResource.clientVersionHeader()} annotation.
+ * This is the programmatic equivalent to the
+ * {@link RestResource#clientVersionHeader() @RestResource.clientVersionHeader()} annotation.
*
* @param clientVersionHeader The name of the HTTP header that denotes the client version.
* @return This object (for method chaining).
@@ -1061,7 +1094,7 @@ public class RestConfig implements ServletConfig {
* The format of this value is plain text.
* <p>
* It gets wrapped in a <code><xt><h3> <xa>class</xa>=<xs>'title'</xs>></xt></code> element and then added
- * to the <code><xt><header></code> section on the page.
+ * to the <code><xt><header></code> section on the page.
* <p>
* If not specified, the page title is pulled from one of the following locations:
* <ol>
@@ -1100,7 +1133,7 @@ public class RestConfig implements ServletConfig {
* The format of this value is plain text.
* <p>
* It gets wrapped in a <code><xt><h5> <xa>class</xa>=<xs>'description'</xs>></xt></code> element and then
- * added to the <code><xt><header></code> section on the page.
+ * added to the <code><xt><header></code> section on the page.
* <p>
* If not specified, the page title is pulled from one of the following locations:
* <ol>
@@ -1162,9 +1195,10 @@ public class RestConfig implements ServletConfig {
* The format of this value is HTML.
* <p>
* The page header normally contains the title and description, but this value can be used to override the contents
- * to be whatever you want.
+ * to be whatever you want.
* <p>
- * When a value is specified, the {@link #setHtmlTitle(String)} and {@link #setHtmlDescription(String)} values will be ignored.
+ * When a value is specified, the {@link #setHtmlTitle(String)} and {@link #setHtmlDescription(String)} values will
+ * be ignored.
* <p>
* A value of <js>"NONE"</js> can be used to force no header.
* <p>
@@ -1184,7 +1218,7 @@ public class RestConfig implements ServletConfig {
* Sets the links in the HTML nav section.
* <p>
* The format of this value is a lax-JSON map of key/value pairs where the keys are the link text and the values are
- * relative (to the servlet) or absolute URLs.
+ * relative (to the servlet) or absolute URLs.
* <p>
* The page links are positioned immediately under the title and text.
* <p>
@@ -1300,7 +1334,7 @@ public class RestConfig implements ServletConfig {
* The format of this value is CSS.
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols defined
- * by {@link UriResolver}.
+ * by {@link UriResolver}.
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#cssUrl() @HtmlDoc.cssUrl()} annotation.
*
@@ -1328,7 +1362,8 @@ public class RestConfig implements ServletConfig {
/**
* Specifies the text to display when serializing an empty array or collection.
* <p>
- * This is the programmatic equivalent to the {@link HtmlDoc#noResultsMessage() @HtmlDoc.noResultsMessage()} annotation.
+ * This is the programmatic equivalent to the {@link HtmlDoc#noResultsMessage() @HtmlDoc.noResultsMessage()}
+ * annotation.
*
* @param value The text to display when serializing an empty array or collection.
* @return This object (for method chaining).
@@ -1358,9 +1393,8 @@ public class RestConfig implements ServletConfig {
/**
* Specifies the template class to use for rendering the HTML page.
* <p>
- * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide
- * your own custom renderer or subclasses from the basic class to have full control over how the page is
- * rendered.
+ * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom
+ * renderer or subclasses from the basic class to have full control over how the page is rendered.
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.
*
@@ -1374,7 +1408,7 @@ public class RestConfig implements ServletConfig {
/**
* Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly
- * generate arbitrary replacement text.
+ * generate arbitrary replacement text.
* <p>
* Widgets are inherited from parent to child, but can be overridden by reusing the widget name.
*
@@ -1419,7 +1453,8 @@ public class RestConfig implements ServletConfig {
* The call handler is the object that handles execution of REST HTTP calls.
* Subclasses can be created that customize the behavior of how REST calls are handled.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#callHandler() @RestResource.callHandler()} annotation.
+ * This is the programmatic equivalent to the {@link RestResource#callHandler() @RestResource.callHandler()}
+ * annotation.
*
* @param restHandler The new call handler for this resource.
* @return This object (for method chaining).
@@ -1435,7 +1470,8 @@ public class RestConfig implements ServletConfig {
* The call handler is the object that handles execution of REST HTTP calls.
* Subclasses can be created that customize the behavior of how REST calls are handled.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#callHandler() @RestResource.callHandler()} annotation.
+ * This is the programmatic equivalent to the {@link RestResource#callHandler() @RestResource.callHandler()}
+ * annotation.
*
* @param restHandler The new call handler for this resource.
* @return This object (for method chaining).
@@ -1451,7 +1487,8 @@ public class RestConfig implements ServletConfig {
* The info provider provides all the various information about a resource such as the Swagger documentation.
* Subclasses can be created that customize the information.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#infoProvider() @RestResource.infoProvider()} annotation.
+ * This is the programmatic equivalent to the {@link RestResource#infoProvider() @RestResource.infoProvider()}
+ * annotation.
*
* @param infoProvider The new info provider for this resource.
* @return This object (for method chaining).
@@ -1467,7 +1504,8 @@ public class RestConfig implements ServletConfig {
* The info provider provides all the various information about a resource such as the Swagger documentation.
* Subclasses can be created that customize the information.
* <p>
- * This is the programmatic equivalent to the {@link RestResource#infoProvider() @RestResource.infoProvider()} annotation.
+ * This is the programmatic equivalent to the {@link RestResource#infoProvider() @RestResource.infoProvider()}
+ * annotation.
*
* @param infoProvider The new info provider for this resource.
* @return This object (for method chaining).
@@ -1479,6 +1517,7 @@ public class RestConfig implements ServletConfig {
/**
* Creates a new {@link PropertyStore} object initialized with the properties defined in this config.
+ *
* @return A new property store.
*/
protected PropertyStore createPropertyStore() {
@@ -1493,7 +1532,8 @@ public class RestConfig implements ServletConfig {
/**
* Returns the external configuration file for this resource.
* <p>
- * The configuration file location is determined via the {@link RestResource#config() @RestResource.config()} annotation on the resource.
+ * The configuration file location is determined via the {@link RestResource#config() @RestResource.config()}
+ * annotation on the resource.
* <p>
* The config file can be programmatically overridden by adding the following method to your resource:
* <p class='bcode'>
@@ -1539,7 +1579,8 @@ public class RestConfig implements ServletConfig {
* <li>{@link SwitchVar}
* </ul>
* <p>
- * Note that the variables supported here are only a subset of those returned by {@link RestRequest#getVarResolverSession()}.
+ * Note that the variables supported here are only a subset of those returned by
+ * {@link RestRequest#getVarResolverSession()}.
*
* @return The variable resolver for this resource. Never <jk>null</jk>.
*/
[04/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletDefault.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletDefault.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletDefault.java
index fe3450c..d5348e9 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletDefault.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletDefault.java
@@ -92,11 +92,6 @@ import org.apache.juneau.xml.*;
* <td class='code'>text/plain</td>
* <td>{@link PlainTextSerializer}</td>
* </tr>
- * <tr>
- * <td class='code'>application/x-java-serialized-object</td>
- * <td class='code'>application/x-java-serialized-object</td>
- * <td>{@link JsoSerializer}</td>
- * </tr>
* </table>
* <p>
* Supports the following request <code>Content-Type</code> header values:
@@ -132,25 +127,33 @@ import org.apache.juneau.xml.*;
* </tr>
* </table>
* <p>
- * It should be noted that we do NOT add {@link JsoParser} to the list of parsers since this could
- * cause security issues. Use caution when using this particular parser as it could inadvertantly cause
- * code execution security holes.
+ * It should be noted that we do NOT add {@link JsoParser} to the list of parsers since this could cause security
+ * issues.
+ * Use caution when using this particular parser as it could inadvertently cause code execution security holes.
* <p>
- * The list of serializers and parsers can be appended to using the {@link RestResource#serializers() @RestResource.serializers()}
- * and {@link RestResource#parsers() @RestResource.parsers()} annotations on subclasses.
+ * The list of serializers and parsers can be appended to using the
+ * {@link RestResource#serializers() @RestResource.serializers()} and
+ * {@link RestResource#parsers() @RestResource.parsers()} annotations on subclasses.
* <p>
- * This subclass also provides a default OPTIONS page by implementing a {@link #getOptions(RestRequest)} that returns a POJO consisting
- * of beans describing the class.
+ * This subclass also provides a default OPTIONS page by implementing a {@link #getOptions(RestRequest)} that returns a
+ * POJO consisting of beans describing the class.
* <img class='bordered' src='doc-files/OptionsPage.png'>
* <p>
* The OPTIONS page can be modified or augmented by overriding this method and providing your own data.
*
* <h6 class='topic'>Other Notes</h6>
* <ul class='spaced-list'>
- * <li>Provides a default HTML stylesheet by setting {@link RestResource#stylesheet() @RestResource.stylesheet()} to <js>"styles/juneau.css"</js>.
- * <li>Provides a default favicon by setting {@link RestResource#favicon() @RestResource.favicon()} to <js>"juneau.ico"</js>.
- * <li>Provides a default classpath entry "htdocs" by setting {@link RestResource#staticFiles() @RestResource.staticFiles()} to <js>"{htdocs:'htdocs'}"</js>.
- * This allows files inside the <code>[servletPackage].htdocs</code> package to be served up under the URL <code>/servletPath/htdocs</code>.
+ * <li>
+ * Provides a default HTML stylesheet by setting {@link RestResource#stylesheet() @RestResource.stylesheet()}
+ * to <js>"styles/juneau.css"</js>.
+ * <li>
+ * Provides a default favicon by setting {@link RestResource#favicon() @RestResource.favicon()} to
+ * <js>"juneau.ico"</js>.
+ * <li>
+ * Provides a default classpath entry "htdocs" by setting
+ * {@link RestResource#staticFiles() @RestResource.staticFiles()} to <js>"{htdocs:'htdocs'}"</js>.
+ * This allows files inside the <code>[servletPackage].htdocs</code> package to be served up under the URL
+ * <code>/servletPath/htdocs</code>.
* </ul>
*/
@RestResource(
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/RestUtils.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestUtils.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestUtils.java
index f39a2ff..0d3dddb 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestUtils.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestUtils.java
@@ -76,7 +76,7 @@ public final class RestUtils {
* Identical to {@link HttpServletRequest#getPathInfo()} but doesn't decode encoded characters.
*
* @param req The HTTP request
- * @return The undecoded path info.
+ * @return The un-decoded path info.
*/
public static String getPathInfoUndecoded(HttpServletRequest req) {
String requestURI = req.getRequestURI();
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/StreamResource.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/StreamResource.java b/juneau-rest/src/main/java/org/apache/juneau/rest/StreamResource.java
index 525055d..ebfa1be 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/StreamResource.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/StreamResource.java
@@ -25,8 +25,8 @@ import org.apache.juneau.rest.response.*;
/**
* Represents the contents of a byte stream file with convenience methods for adding HTTP response headers.
* <p>
- * The purpose of this class is to maintain an in-memory reusable byte array of a streamed resource for
- * the fastest possible streaming.
+ * The purpose of this class is to maintain an in-memory reusable byte array of a streamed resource for the fastest
+ * possible streaming.
* Therefore, this object is designed to be reused and thread-safe.
* <p>
* This class is handled special by the {@link StreamableHandler} class.
@@ -40,6 +40,7 @@ public class StreamResource implements Streamable {
/**
* Constructor.
+ *
* @param mediaType The resource media type.
* @param contents The resource contents.
* <br>If multiple contents are specified, the results will be concatenated.
@@ -59,6 +60,7 @@ public class StreamResource implements Streamable {
/**
* Constructor.
+ *
* @param mediaType The resource media type.
* @param headers The HTTP response headers for this streamed resource.
* @param contents The resource contents.
@@ -113,6 +115,7 @@ public class StreamResource implements Streamable {
/**
* Specifies the resource media type string.
+ *
* @param mediaType The resource media type string.
* @return This object (for method chaining).
*/
@@ -123,6 +126,7 @@ public class StreamResource implements Streamable {
/**
* Specifies the resource media type string.
+ *
* @param mediaType The resource media type string.
* @return This object (for method chaining).
*/
@@ -190,6 +194,7 @@ public class StreamResource implements Streamable {
/**
* Get the HTTP response headers.
+ *
* @return The HTTP response headers. An unmodifiable map. Never <jk>null</jk>.
*/
public Map<String,String> getHeaders() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/UrlPathPattern.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/UrlPathPattern.java b/juneau-rest/src/main/java/org/apache/juneau/rest/UrlPathPattern.java
index 1d97933..41bc08d 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/UrlPathPattern.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/UrlPathPattern.java
@@ -77,9 +77,8 @@ public final class UrlPathPattern implements Comparable<UrlPathPattern> {
* Returns a non-<jk>null</jk> value if the specified path matches this pattern.
*
* @param path The path to match against.
- * @return An array of values matched against <js>"{var}"</js> variable in the pattern,
- * or an empty array if the pattern matched but no vars were present, or <jk>null</jk>
- * if the specified path didn't match the pattern.
+ * @return An array of values matched against <js>"{var}"</js> variable in the pattern, or an empty array if the
+ * pattern matched but no vars were present, or <jk>null</jk> if the specified path didn't match the pattern.
*/
protected String[] match(String path) {
@@ -172,6 +171,7 @@ public final class UrlPathPattern implements Comparable<UrlPathPattern> {
/**
* Bean property getter: <property>vars</property>.
+ *
* @return The value of the <property>vars</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String[] getVars() {
@@ -180,6 +180,7 @@ public final class UrlPathPattern implements Comparable<UrlPathPattern> {
/**
* Bean property getter: <property>patternString</property>.
+ *
* @return The value of the <property>patternString</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getPatternString() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Body.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Body.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Body.java
index 8641e60..2022bf6 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Body.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Body.java
@@ -19,8 +19,8 @@ import java.io.*;
import java.lang.annotation.*;
/**
- * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method
- * to identify it as the HTTP request body converted to a POJO.
+ * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method to identify it as the HTTP
+ * request body converted to a POJO.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/FormData.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/FormData.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/FormData.java
index 56187b0..1cfa491 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/FormData.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/FormData.java
@@ -20,8 +20,8 @@ import java.lang.annotation.*;
import org.apache.juneau.rest.*;
/**
- * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method
- * to identify it as a form post entry converted to a POJO.
+ * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method to identify it as a form post
+ * entry converted to a POJO.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -47,11 +47,11 @@ import org.apache.juneau.rest.*;
* <h6 class='topic'>Important note concerning FORM posts</h6>
* <p>
* This annotation should not be combined with the {@link Body @Body} annotation or {@link RestRequest#getBody()} method
- * for <code>application/x-www-form-urlencoded POST</code> posts, since it will trigger the underlying servlet
- * API to parse the body content as key-value pairs resulting in empty content.
+ * for <code>application/x-www-form-urlencoded POST</code> posts, since it will trigger the underlying servlet
+ * API to parse the body content as key-value pairs resulting in empty content.
* <p>
- * The {@link Query @Query} annotation can be used to retrieve a URL parameter
- * in the URL string without triggering the servlet to drain the body content.
+ * The {@link Query @Query} annotation can be used to retrieve a URL parameter in the URL string without triggering the
+ * servlet to drain the body content.
*/
@Documented
@Target(PARAMETER)
@@ -88,12 +88,16 @@ public @interface FormData {
* <p>
* Possible values:
* <ul class='spaced-list'>
- * <li><js>"UON"</js> - URL-Encoded Object Notation.<br>
- * This notation allows for request parameters to contain arbitrarily complex POJOs.
- * <li><js>"PLAIN"</js> - Plain text.<br>
- * This treats request parameters as plain text.<br>
- * Only POJOs directly convertable from <l>Strings</l> can be represented in parameters when using this mode.
- * <li><js>"INHERIT"</js> (default) - Inherit from the {@link RestContext#REST_paramFormat} property on the servlet method or class.
+ * <li>
+ * <js>"UON"</js> - URL-Encoded Object Notation.
+ * <br>This notation allows for request parameters to contain arbitrarily complex POJOs.
+ * <li>
+ * <js>"PLAIN"</js> - Plain text.
+ * <br>This treats request parameters as plain text.
+ * <br>Only POJOs directly convertible from <l>Strings</l> can be represented in parameters when using this mode.
+ * <li>
+ * <js>"INHERIT"</js> (default) - Inherit from the {@link RestContext#REST_paramFormat} property on the
+ * servlet method or class.
* </ul>
* <p>
* Note that the parameter value <js>"(foo)"</js> is interpreted as <js>"(foo)"</js> when using plain mode, but
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java
index a68030a..150c2fb 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java
@@ -20,8 +20,8 @@ import java.lang.annotation.*;
import org.apache.juneau.rest.*;
/**
- * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method
- * to identify whether or not the request has the specified multipart form POST parameter.
+ * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method to identify whether or not
+ * the request has the specified multipart form POST parameter.
* <p>
* Note that this can be used to detect the existence of a parameter when it's not set to a particular value.
*
@@ -75,11 +75,11 @@ import org.apache.juneau.rest.*;
* <h6 class='topic'>Important note concerning FORM posts</h6>
* <p>
* This annotation should not be combined with the {@link Body @Body} annotation or {@link RestRequest#getBody()} method
- * for <code>application/x-www-form-urlencoded POST</code> posts, since it will trigger the underlying servlet API to parse the body
- * content as key-value pairs, resulting in empty content.
+ * for <code>application/x-www-form-urlencoded POST</code> posts, since it will trigger the underlying servlet API to
+ * parse the body content as key-value pairs, resulting in empty content.
* <p>
- * The {@link HasQuery @HasQuery} annotation can be used to check for the existing of a URL parameter
- * in the URL string without triggering the servlet to drain the body content.
+ * The {@link HasQuery @HasQuery} annotation can be used to check for the existing of a URL parameter in the URL string
+ * without triggering the servlet to drain the body content.
*/
@Documented
@Target(PARAMETER)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java
index f1bf5ee..d874a95 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java
@@ -20,13 +20,13 @@ import java.lang.annotation.*;
import org.apache.juneau.rest.*;
/**
- * Identical to {@link HasFormData @HasFormData}, but only checks the existing of the parameter in the
- * URL string, not URL-encoded form posts.
+ * Identical to {@link HasFormData @HasFormData}, but only checks the existing of the parameter in the URL string, not
+ * URL-encoded form posts.
* <p>
* Unlike {@link HasFormData @HasFormData}, using this annotation does not result in the servlet reading the contents
- * of URL-encoded form posts.
- * Therefore, this annotation can be used in conjunction with the {@link Body @Body} annotation
- * or {@link RestRequest#getBody()} method for <code>application/x-www-form-urlencoded POST</code> calls.
+ * of URL-encoded form posts.
+ * Therefore, this annotation can be used in conjunction with the {@link Body @Body} annotation or
+ * {@link RestRequest#getBody()} method for <code>application/x-www-form-urlencoded POST</code> calls.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Header.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Header.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Header.java
index 8f98d50..6f0ee4f 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Header.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Header.java
@@ -18,8 +18,8 @@ import static java.lang.annotation.RetentionPolicy.*;
import java.lang.annotation.*;
/**
- * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method
- * to identify it as a HTTP request header converted to a POJO.
+ * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method to identify it as a HTTP
+ * request header converted to a POJO.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HtmlDoc.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HtmlDoc.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HtmlDoc.java
index 5402a3a..ec2fe87 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HtmlDoc.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HtmlDoc.java
@@ -19,11 +19,11 @@ import org.apache.juneau.rest.*;
/**
* Contains all the configurable annotations for the {@link HtmlDocSerializer}.
* <p>
- * Used with {@link RestResource#htmldoc()} and {@link RestMethod#htmldoc()} to customize the HTML view of
- * serialized POJOs.
+ * Used with {@link RestResource#htmldoc()} and {@link RestMethod#htmldoc()} to customize the HTML view of serialized
+ * POJOs.
* <p>
* All annotations specified here have no effect on any serializers other than {@link HtmlDocSerializer} and is
- * provided as a shorthand method of for specifying configuration properties.
+ * provided as a shorthand method of for specifying configuration properties.
* <p>
* For example, the following two methods for defining the HTML document title are considered equivalent:
* <p class='bcode'>
@@ -41,7 +41,7 @@ import org.apache.juneau.rest.*;
* </p>
* <p>
* The purpose of these annotation is to populate the HTML document view which by default consists of the following
- * structure:
+ * structure:
* <p class='bcode'>
* <xt><html>
* <head>
@@ -79,7 +79,7 @@ public @interface HtmlDoc {
* The format of this value is HTML (phrasing content only).
* <p>
* It gets wrapped in a <code><xt><h3> <xa>class</xa>=<xs>'title'</xs>></xt></code> element and then added
- * to the <code><xt><header></code> section on the page.
+ * to the <code><xt><header></code> section on the page.
* <p>
* If not specified, the page title is pulled from one of the following locations:
* <ol>
@@ -105,7 +105,8 @@ public @interface HtmlDoc {
* This annotation is ignored when the {@link #header()} annotation is specified.
* </ul>
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setHtmlTitle(String)}/{@link RestResponse#setHtmlTitle(Object)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setHtmlTitle(String)}/{@link RestResponse#setHtmlTitle(Object)} methods.
*/
String title() default "";
@@ -115,7 +116,7 @@ public @interface HtmlDoc {
* The format of this value is HTML (phrasing content only).
* <p>
* It gets wrapped in a <code><xt><h5> <xa>class</xa>=<xs>'description'</xs>></xt></code> element and then
- * added to the <code><xt><header></code> section on the page.
+ * added to the <code><xt><header></code> section on the page.
* <p>
* If not specified, the page title is pulled from one of the following locations:
* <ol>
@@ -143,7 +144,8 @@ public @interface HtmlDoc {
* This annotation is ignored when the {@link #header()} annotation is specified.
* </ul>
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setHtmlDescription(String)}/{@link RestResponse#setHtmlDescription(Object)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setHtmlDescription(String)}/{@link RestResponse#setHtmlDescription(Object)} methods.
*/
String description() default "";
@@ -158,7 +160,8 @@ public @interface HtmlDoc {
* <p>
* A value of <js>"NONE"</js> can be used to force no value.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setHtmlBranding(String)}/{@link RestResponse#setHtmlBranding(Object)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setHtmlBranding(String)}/{@link RestResponse#setHtmlBranding(Object)} methods.
*/
String branding() default "";
@@ -168,8 +171,8 @@ public @interface HtmlDoc {
* The format of this value is HTML.
* <p>
* The page header normally contains the title and description, but this value can be used to override the contents
- * to be whatever you want.
- * <p>
+ * to be whatever you want.
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -185,7 +188,8 @@ public @interface HtmlDoc {
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setHtmlHeader(String)}/{@link RestResponse#setHtmlHeader(Object)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setHtmlHeader(String)}/{@link RestResponse#setHtmlHeader(Object)} methods.
*/
String header() default "";
@@ -193,10 +197,10 @@ public @interface HtmlDoc {
* Sets the links in the HTML nav section.
* <p>
* The format of this value is a lax-JSON map of key/value pairs where the keys are the link text and the values are
- * relative (to the servlet) or absolute URLs.
+ * relative (to the servlet) or absolute URLs.
* <p>
* The page links are positioned immediately under the title and text.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -212,7 +216,8 @@ public @interface HtmlDoc {
* <p>
* This field can also use URIs of any support type in {@link UriResolver}.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setHtmlLinks(String)}/{@link RestResponse#setHtmlLinks(Object)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setHtmlLinks(String)}/{@link RestResponse#setHtmlLinks(Object)} methods.
*/
String links() default "";
@@ -224,7 +229,7 @@ public @interface HtmlDoc {
* The nav section of the page contains the links.
* <p>
* The format of this value is HTML.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -240,7 +245,8 @@ public @interface HtmlDoc {
* <p>
* A value of <js>"NONE"</js> can be used to force no value.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setHtmlNav(String)}/{@link RestResponse#setHtmlNav(Object)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setHtmlNav(String)}/{@link RestResponse#setHtmlNav(Object)} methods.
*/
String nav() default "";
@@ -250,7 +256,7 @@ public @interface HtmlDoc {
* The format of this value is HTML.
* <p>
* The aside section typically floats on the right side of the page.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -264,7 +270,8 @@ public @interface HtmlDoc {
* <p>
* A value of <js>"NONE"</js> can be used to force no value.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setHtmlAside(String)}/{@link RestResponse#setHtmlAside(Object)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setHtmlAside(String)}/{@link RestResponse#setHtmlAside(Object)} methods.
*/
String aside() default "";
@@ -274,7 +281,7 @@ public @interface HtmlDoc {
* The format of this value is HTML.
* <p>
* The footer section typically floats on the bottom of the page.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -288,7 +295,8 @@ public @interface HtmlDoc {
* <p>
* A value of <js>"NONE"</js> can be used to force no value.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setHtmlFooter(String)}/{@link RestResponse#setHtmlFooter(Object)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setHtmlFooter(String)}/{@link RestResponse#setHtmlFooter(Object)} methods.
*/
String footer() default "";
@@ -296,7 +304,7 @@ public @interface HtmlDoc {
* Sets the HTML CSS style section contents.
* <p>
* The format of this value is CSS.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -310,7 +318,8 @@ public @interface HtmlDoc {
* <p>
* A value of <js>"NONE"</js> can be used to force no value.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setHtmlCss(String)}/{@link RestResponse#setHtmlCss(Object)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setHtmlCss(String)}/{@link RestResponse#setHtmlCss(Object)} methods.
*/
String css() default "";
@@ -322,7 +331,7 @@ public @interface HtmlDoc {
* Specifies the URL to the stylesheet to add as a link in the style tag in the header.
* <p>
* The format of this value is CSS.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -333,9 +342,10 @@ public @interface HtmlDoc {
* </p>
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols defined
- * by {@link UriResolver}.
+ * by {@link UriResolver}.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setHtmlCssUrl(String)}/{@link RestResponse#setHtmlCssUrl(Object)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setHtmlCssUrl(String)}/{@link RestResponse#setHtmlCssUrl(Object)} methods.
*/
String cssUrl() default "servlet:/style.css";
@@ -354,11 +364,11 @@ public @interface HtmlDoc {
/**
* Specifies the template class to use for rendering the HTML page.
* <p>
- * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide
- * your own custom renderer or subclasses from the basic class to have full control over how the page is
- * rendered.
+ * By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom
+ * renderer or subclasses from the basic class to have full control over how the page is rendered.
* <p>
- * The programmatic equivalent to this annotation are the {@link RestConfig#setHtmlTemplate(Class)}/{@link RestResponse#setHtmlTemplate(Class)} methods.
+ * The programmatic equivalent to this annotation are the
+ * {@link RestConfig#setHtmlTemplate(Class)}/{@link RestResponse#setHtmlTemplate(Class)} methods.
*/
Class<? extends HtmlDocTemplate> template() default HtmlDocTemplate.class;
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Inherit.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Inherit.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Inherit.java
index 7d49865..0a1f546 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Inherit.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Inherit.java
@@ -14,7 +14,7 @@ package org.apache.juneau.rest.annotation;
/**
* Inheritance values for the {@link RestMethod#serializersInherit()} and {@link RestMethod#parsersInherit()}
- * annotations.
+ * annotations.
*/
public enum Inherit {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Messages.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Messages.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Messages.java
index 4cf84f3..30e014a 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Messages.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Messages.java
@@ -21,8 +21,8 @@ import java.util.*;
import org.apache.juneau.utils.*;
/**
- * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method
- * to identify it as the resource bundle for the request locale.
+ * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method to identify it as the
+ * resource bundle for the request locale.
* <p>
* Parameter type must be either {@link ResourceBundle} or {@link MessageBundle}.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Method.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Method.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Method.java
index aab6843..327a70c 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Method.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Method.java
@@ -18,8 +18,8 @@ import static java.lang.annotation.RetentionPolicy.*;
import java.lang.annotation.*;
/**
- * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method
- * to identify it as the HTTP method.
+ * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method to identify it as the HTTP
+ * method.
* <p>
* Typically used for HTTP method handlers of type <js>"*"</js> (i.e. handle all requests).
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java
index c7cb743..b63fd8b 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java
@@ -30,8 +30,10 @@ public @interface MethodSwagger {
* }
* </p>
* <p>
- * The default value pulls the description from the <code>(className.?)[javaMethodName].externalDocs</code> entry in the servlet resource bundle.
- * (e.g. <js>"MyClass.myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js> or <js>"myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js>).
+ * The default value pulls the description from the <code>(className.?)[javaMethodName].externalDocs</code> entry in
+ * the servlet resource bundle.
+ * (e.g. <js>"MyClass.myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js> or
+ * <js>"myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js>).
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -56,8 +58,9 @@ public @interface MethodSwagger {
* A comma-delimited list of tags for API documentation control.
* Tags can be used for logical grouping of operations by resources or any other qualifier.
* <p>
- * The default value pulls the description from the <code>(className.?)[javaMethodName].tags</code> entry in the servlet resource bundle.
- * (e.g. <js>"MyClass.myMethod.tags = foo,bar"</js> or <js>"myMethod.tags = foo,bar"</js>).
+ * The default value pulls the description from the <code>(className.?)[javaMethodName].tags</code> entry in the
+ * servlet resource bundle.
+ * (e.g. <js>"MyClass.myMethod.tags = foo,bar"</js> or <js>"myMethod.tags = foo,bar"</js>).
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -79,8 +82,9 @@ public @interface MethodSwagger {
* <p>
* Used to populate the Swagger deprecated field.
* <p>
- * The default value pulls the description from the <code>(className.?)[javaMethodName].deprecated</code> entry in the servlet resource bundle.
- * (e.g. <js>"MyClass.myMethod.deprecated = true"</js> or <js>"myMethod.deprecated = foo,bar"</js>).
+ * The default value pulls the description from the <code>(className.?)[javaMethodName].deprecated</code> entry in
+ * the servlet resource bundle.
+ * (e.g. <js>"MyClass.myMethod.deprecated = true"</js> or <js>"myMethod.deprecated = foo,bar"</js>).
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -100,8 +104,8 @@ public @interface MethodSwagger {
/**
* Optional parameter descriptions.
* <p>
- * This annotation is provided for documentation purposes and is used to populate the method <js>"parameters"</js> column
- * on the Swagger page.
+ * This annotation is provided for documentation purposes and is used to populate the method <js>"parameters"</js>
+ * column on the Swagger page.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -118,8 +122,8 @@ public @interface MethodSwagger {
* )
* )
* </p>
- * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in this case
- * the strings are internationalized.
+ * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in
+ * this case the strings are internationalized.
* <p class='bcode'>
* <jk>MyClass.myMethod.description</jk> = <js>This is my method.</js>
* <jk>MyClass.myMethod.req.path.a.description</jk> = <js>The 'a' attribute</js>
@@ -127,8 +131,8 @@ public @interface MethodSwagger {
* <jk>MyClass.myMethod.req.body.description</jk> = <js>The HTTP content</js>
* <jk>MyClass.myMethod.req.header.d.description</jk> = <js>The 'D' header</js>
* <p>
- * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support English),
- * and use resource bundles if you need to support localization.
+ * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support
+ * English), and use resource bundles if you need to support localization.
* <p>
* These annotations can contain variables (e.g. "$L{my.localized.variable}").
* <p>
@@ -139,8 +143,8 @@ public @interface MethodSwagger {
/**
* Optional output description.
* <p>
- * This annotation is provided for documentation purposes and is used to populate the method <js>"responses"</js> column
- * on the Swagger page.
+ * This annotation is provided for documentation purposes and is used to populate the method <js>"responses"</js>
+ * column on the Swagger page.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -160,18 +164,17 @@ public @interface MethodSwagger {
* )
* )
* </p>
- * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in this case
- * the strings are internationalized.
+ * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in
+ * this case the strings are internationalized.
* <p class='bcode'>
* <jk>MyClass.myMethod.res.200.description</jk> = <js>OK</js>
* <jk>MyClass.myMethod.res.302.description</jk> = <js>Thing wasn't found here</js>
* <jk>MyClass.myMethod.res.302.header.Location.description</jk> = <js>The place to find the thing</js>
* <p>
- * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support English),
- * and use resource bundles if you need to support localization.
+ * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support
+ * English), and use resource bundles if you need to support localization.
* <p>
* These annotations can contain variables (e.g. "$L{my.localized.variable}").
*/
Response[] responses() default {};
-
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Parameter.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
index a5d10c8..3c1d935 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
@@ -19,7 +19,7 @@ import java.lang.annotation.*;
/**
* Annotation used in conjunction with {@link MethodSwagger#parameters()} to identify content and header descriptions
- * on specific method requests.
+ * on specific method requests.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -60,9 +60,11 @@ public @interface Parameter {
* The name of the parameter (e.g. <js>"Content-Range"</js>).
* <p>
* Parameter names are case sensitive.
- * If <code>in</code> is <js>"path"</js>, the name field MUST correspond to the associated path segment from the <code>path</code> field in
- * the <a class="doclink" href="http://swagger.io/specification/#pathsObject">Paths Object</a>.
- * See <a class="doclink" href="http://swagger.io/specification/#pathTemplating">Path Templating</a> for further information.
+ * If <code>in</code> is <js>"path"</js>, the name field MUST correspond to the associated path segment from the
+ * <code>path</code> field in the <a class="doclink"
+ * href="http://swagger.io/specification/#pathsObject">Paths Object</a>.
+ * See <a class="doclink" href="http://swagger.io/specification/#pathTemplating">Path Templating</a> for further
+ * information.
* For all other cases, the name corresponds to the parameter name used based on the <code>in</code> property.
*/
String name() default "";
@@ -72,10 +74,12 @@ public @interface Parameter {
* <p>
* A brief description of the parameter.
* This could contain examples of use.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
* <p>
* The default value pulls the description from the <code>description</code> entry in the servlet resource bundle.
- * (e.g. <js>"myMethod.res.[code].[category].[name] = foo"</js> or <js>"MyServlet.myMethod.res.[code].[category].[name] = foo"</js>).
+ * (e.g. <js>"myMethod.res.[code].[category].[name] = foo"</js> or
+ * <js>"MyServlet.myMethod.res.[code].[category].[name] = foo"</js>).
*/
String description() default "";
@@ -92,7 +96,8 @@ public @interface Parameter {
* <p>
* Only applicable for <code>in</code> of type <js>"body"</js>.
* <p>
- * The schema is a JSON object specified <a class="doclink" href="http://swagger.io/specification/#schemaObject">here</a>.
+ * The schema is a JSON object specified <a class="doclink"
+ * href="http://swagger.io/specification/#schemaObject">here</a>.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -112,22 +117,26 @@ public @interface Parameter {
/**
* The type of the parameter.
* <p>
- * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, <js>"array"</js> or <js>"file"</js>.
- * If type is <js>"file"</js>, the consumes MUST be either <js>"multipart/form-data"</js>, <js>"application/x-www-form-urlencoded"</js> or both and the parameter MUST be in <js>"formData"</js>.
+ * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>,
+ * <js>"array"</js> or <js>"file"</js>.
+ * If type is <js>"file"</js>, the consumes MUST be either <js>"multipart/form-data"</js>,
+ * <js>"application/x-www-form-urlencoded"</js> or both and the parameter MUST be in <js>"formData"</js>.
*/
String type() default "string";
/**
* The extending format for the previously mentioned <code>type</code>.
* <p>
- * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
+ * details.
*/
String format() default "";
/**
* Sets the ability to pass empty-valued parameters.
* <p>
- * This is valid only for either <code>query</code> or <code>formData</code> parameters and allows you to send a parameter with a name only or an empty value.
+ * This is valid only for either <code>query</code> or <code>formData</code> parameters and allows you to send a
+ * parameter with a name only or an empty value.
* Default value is <jk>false</jk>.
*/
boolean allowEmptyValue() default false;
@@ -164,7 +173,8 @@ public @interface Parameter {
* <li><js>"ssv"</js> - space separated values <js>"foo bar"</js>.
* <li><js>"tsv"</js> - tab separated values <js>"foo\tbar"</js>.
* <li><js>"pipes"</js> - pipe separated values <js>"foo|bar"</js>.
- * <li><js>"multi"</js> - corresponds to multiple parameter instances instead of multiple values for a single instance <js>"foo=bar&foo=baz"</js>.
+ * <li><js>"multi"</js> - corresponds to multiple parameter instances instead of multiple values for a single
+ * instance <js>"foo=bar&foo=baz"</js>.
* This is valid only for parameters <code>in</code> <js>"query"</js> or <js>"formData"</js>.
* </ul>
* Default value is <js>"csv"</js>.
@@ -174,9 +184,11 @@ public @interface Parameter {
/**
* Declares the value of the parameter that the server will use if none is provided.
* <p>
- * For example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request.
+ * For example a "count" to control the number of results per page might default to 100 if not supplied by the
+ * client in the request.
* (Note: "default" has no meaning for required parameters.)
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor101</a>.
* Unlike JSON Schema this value MUST conform to the defined <code>type</code> for this parameter.
*/
String _default() default "";
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Path.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Path.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Path.java
index 5385109..9a09497 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Path.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Path.java
@@ -18,8 +18,8 @@ import static java.lang.annotation.RetentionPolicy.*;
import java.lang.annotation.*;
/**
- * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method
- * to identify it as a variable in a URL path pattern converted to a POJO.
+ * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method to identify it as a variable
+ * in a URL path pattern converted to a POJO.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -30,9 +30,9 @@ import java.lang.annotation.*;
* }
* </p>
* <p>
- * The <ja>@Path</ja> annotation is optional if the parameters are specified immediately
- * following the <code>RestRequest</code> and <code>RestResponse</code> parameters,
- * and are specified in the same order as the variables in the URL path pattern.
+ * The <ja>@Path</ja> annotation is optional if the parameters are specified immediately following the
+ * <code>RestRequest</code> and <code>RestResponse</code> parameters, and are specified in the same order as the
+ * variables in the URL path pattern.
* The following example is equivalent to the previous example.
* </p>
* <p class='bcode'>
@@ -43,11 +43,10 @@ import java.lang.annotation.*;
* }
* </p>
* <p>
- * If the order of parameters is not the default order shown above, the
- * attribute names must be specified (since parameter names are lost during compilation).
- * The following example is equivalent to the previous example, except
- * the parameter order has been switched, requiring the use of the <ja>@Path</ja>
- * annotations.
+ * If the order of parameters is not the default order shown above, the attribute names must be specified (since
+ * parameter names are lost during compilation).
+ * The following example is equivalent to the previous example, except the parameter order has been switched, requiring
+ * the use of the <ja>@Path</ja> annotations.
* <p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/myurl/{foo}/{bar}/{baz}/*"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java
index 95f7f51..4287407 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java
@@ -18,8 +18,8 @@ import static java.lang.annotation.RetentionPolicy.*;
import java.lang.annotation.*;
/**
- * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method
- * to identify it as the URL parameter remainder after a path pattern match.
+ * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method to identify it as the URL
+ * parameter remainder after a path pattern match.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Properties.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Properties.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Properties.java
index a41a24c..b1ab9e0 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Properties.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Properties.java
@@ -20,8 +20,8 @@ import java.lang.annotation.*;
import org.apache.juneau.*;
/**
- * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method
- * to identify the request-duration properties object for the current request.
+ * Annotation that can be applied to a parameter of a {@link RestMethod} annotated method to identify the
+ * request-duration properties object for the current request.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -42,7 +42,7 @@ import org.apache.juneau.*;
* }
* </p>
* <p>
- * ...or this...
+ * ...or this...
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"GET"</js>)
* <jk>public Person</jk> doGetPerson(RestResponse res) {
@@ -52,10 +52,10 @@ import org.apache.juneau.*;
* </p>
* <p>
* The parameter type can be one of the following:
- * <ul>
- * <li>{@link ObjectMap}
- * <li><code>Map<String,Object></code>
- * </ul>
+ * <ul>
+ * <li>{@link ObjectMap}
+ * <li><code>Map<String,Object></code>
+ * </ul>
*/
@Documented
@Target(PARAMETER)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Property.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Property.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Property.java
index 7e59b41..e48228a 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Property.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Property.java
@@ -40,8 +40,8 @@ import org.apache.juneau.xml.*;
* <li>{@link XmlParserContext}
* </ul>
* <p>
- * Property values types that are not <code>Strings</code> will automatically be converted to the
- * correct type (e.g. <code>Boolean</code>, etc...).
+ * Property values types that are not <code>Strings</code> will automatically be converted to the correct type
+ * (e.g. <code>Boolean</code>, etc...).
* <p>
* See {@link RestResource#properties} for more information.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Query.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Query.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Query.java
index cf952a6..298b312 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Query.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Query.java
@@ -20,13 +20,13 @@ import java.lang.annotation.*;
import org.apache.juneau.rest.*;
/**
- * Identical to {@link FormData @FormData}, but only retrieves the parameter from the
- * URL string, not URL-encoded form posts.
+ * Identical to {@link FormData @FormData}, but only retrieves the parameter from the URL string, not URL-encoded form
+ * posts.
* <p>
- * Unlike {@link FormData @FormData}, using this annotation does not result in the servlet reading the contents
- * of URL-encoded form posts.
- * Therefore, this annotation can be used in conjunction with the {@link Body @Body} annotation
- * or {@link RestRequest#getBody()} method for <code>application/x-www-form-urlencoded POST</code> calls.
+ * Unlike {@link FormData @FormData}, using this annotation does not result in the servlet reading the contents of
+ * URL-encoded form posts.
+ * Therefore, this annotation can be used in conjunction with the {@link Body @Body} annotation or
+ * {@link RestRequest#getBody()} method for <code>application/x-www-form-urlencoded POST</code> calls.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -70,10 +70,10 @@ public @interface Query {
/**
* Specify <jk>true</jk> if using multi-part parameters to represent collections and arrays.
* <p>
- * Normally, we expect single parameters to be specified in UON notation for representing
- * collections of values (e.g. <js>"&key=(1,2,3)"</js>.
+ * Normally, we expect single parameters to be specified in UON notation for representing collections of values
+ * (e.g. <js>"&key=(1,2,3)"</js>.
* This annotation allows the use of multi-part parameters to represent collections
- * (e.g. <js>"&key=1&key=2&key=3"</js>.
+ * (e.g. <js>"&key=1&key=2&key=3"</js>.
* <p>
* This setting should only be applied to Java parameters of type array or Collection.
*/
@@ -84,16 +84,20 @@ public @interface Query {
* <p>
* Possible values:
* <ul class='spaced-list'>
- * <li><js>"UON"</js> - URL-Encoded Object Notation.<br>
- * This notation allows for request parameters to contain arbitrarily complex POJOs.
- * <li><js>"PLAIN"</js> - Plain text.<br>
- * This treats request parameters as plain text.<br>
- * Only POJOs directly convertable from <l>Strings</l> can be represented in parameters when using this mode.
- * <li><js>"INHERIT"</js> (default) - Inherit from the {@link RestContext#REST_paramFormat} property on the servlet method or class.
+ * <li>
+ * <js>"UON"</js> - URL-Encoded Object Notation.
+ * <br>This notation allows for request parameters to contain arbitrarily complex POJOs.
+ * <li>
+ * <js>"PLAIN"</js> - Plain text.
+ * <br>This treats request parameters as plain text.
+ * <br>Only POJOs directly convertible from <l>Strings</l> can be represented in parameters when using this mode.
+ * <li>
+ * <js>"INHERIT"</js> (default) - Inherit from the {@link RestContext#REST_paramFormat} property on the
+ * servlet method or class.
* </ul>
* <p>
* Note that the parameter value <js>"(foo)"</js> is interpreted as <js>"(foo)"</js> when using plain mode, but
- * <js>"foo"</js> when using UON mode.
+ * <js>"foo"</js> when using UON mode.
*/
String format() default "INHERIT";
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java
index 0ce1eca..05f6b69 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java
@@ -24,13 +24,14 @@ public @interface ResourceSwagger {
* It is used to populate the Swagger terms-of-service field.
* <p>
* The default value pulls the description from the <code>termsOfService</code> entry in the servlet resource bundle.
- * (e.g. <js>"termsOfService = foo"</js> or <js>"MyServlet.termsOfService = foo"</js>).
+ * (e.g. <js>"termsOfService = foo"</js> or <js>"MyServlet.termsOfService = foo"</js>).
* <p>
* This field can contain variables (e.g. "$L{my.localized.variable}").
* <p>
* Corresponds to the swagger field <code>/info/termsOfService</code>.
* <p>
- * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTermsOfService(RestRequest)} method.
+ * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTermsOfService(RestRequest)}
+ * method.
*/
String termsOfService() default "";
@@ -49,7 +50,8 @@ public @interface ResourceSwagger {
* </p>
* <p>
* The default value pulls the description from the <code>contact</code> entry in the servlet resource bundle.
- * (e.g. <js>"contact = {name:'John Smith',email:'john.smith@foo.bar'}"</js> or <js>"MyServlet.contact = {name:'John Smith',email:'john.smith@foo.bar'}"</js>).
+ * (e.g. <js>"contact = {name:'John Smith',email:'john.smith@foo.bar'}"</js> or
+ * <js>"MyServlet.contact = {name:'John Smith',email:'john.smith@foo.bar'}"</js>).
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -82,7 +84,8 @@ public @interface ResourceSwagger {
* </p>
* <p>
* The default value pulls the description from the <code>license</code> entry in the servlet resource bundle.
- * (e.g. <js>"license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js> or <js>"MyServlet.license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>).
+ * (e.g. <js>"license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js> or
+ * <js>"MyServlet.license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>).
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -107,7 +110,7 @@ public @interface ResourceSwagger {
* It is used to populate the Swagger version field and to display on HTML pages.
* <p>
* The default value pulls the description from the <code>version</code> entry in the servlet resource bundle.
- * (e.g. <js>"version = 2.0"</js> or <js>"MyServlet.version = 2.0"</js>).
+ * (e.g. <js>"version = 2.0"</js> or <js>"MyServlet.version = 2.0"</js>).
* <p>
* This field can contain variables (e.g. "$L{my.localized.variable}").
* <p>
@@ -137,7 +140,8 @@ public @interface ResourceSwagger {
* </p>
* <p>
* The default value pulls the description from the <code>tags</code> entry in the servlet resource bundle.
- * (e.g. <js>"tags = [{name:'Foo',description:'Foobar'}]"</js> or <js>"MyServlet.tags = [{name:'Foo',description:'Foobar'}]"</js>).
+ * (e.g. <js>"tags = [{name:'Foo',description:'Foobar'}]"</js> or
+ * <js>"MyServlet.tags = [{name:'Foo',description:'Foobar'}]"</js>).
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -170,7 +174,8 @@ public @interface ResourceSwagger {
* </p>
* <p>
* The default value pulls the description from the <code>externalDocs</code> entry in the servlet resource bundle.
- * (e.g. <js>"externalDocs = {url:'http://juneau.apache.org'}"</js> or <js>"MyServlet.externalDocs = {url:'http://juneau.apache.org'}"</js>).
+ * (e.g. <js>"externalDocs = {url:'http://juneau.apache.org'}"</js> or
+ * <js>"MyServlet.externalDocs = {url:'http://juneau.apache.org'}"</js>).
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -185,9 +190,8 @@ public @interface ResourceSwagger {
* <p>
* Corresponds to the swagger field <code>/tags</code>.
* <p>
- * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getExternalDocs(RestRequest)} method.
+ * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getExternalDocs(RestRequest)}
+ * method.
*/
String externalDocs() default "";
-
-
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Response.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Response.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Response.java
index 1c1bd39..68c2634 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Response.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Response.java
@@ -52,7 +52,8 @@ public @interface Response {
* Optional description.
* <p>
* The default value pulls the description from the <code>description</code> entry in the servlet resource bundle.
- * (e.g. <js>"myMethod.res.[code].description = foo"</js> or <js>"MyServlet.myMethod.res.[code].description = foo"</js>).
+ * (e.g. <js>"myMethod.res.[code].description = foo"</js> or
+ * <js>"MyServlet.myMethod.res.[code].description = foo"</js>).
* <p>
* This field can contain variables (e.g. "$L{my.localized.variable}").
* <p>
@@ -65,7 +66,8 @@ public @interface Response {
* <p>
* It can be a primitive, an array or an object.
* If this field does not exist, it means no content is returned as part of the response.
- * As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>, its root type value may also be <js>"file"</js>.
+ * As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>,
+ * its root type value may also be <js>"file"</js>.
* This SHOULD be accompanied by a relevant produces mime-type.
*
* <h5 class='section'>Example:</h5>
@@ -85,7 +87,8 @@ public @interface Response {
* Optional response headers.
* <p>
* Response variables can also be defined in the servlet resource bundle.
- * (e.g. <js>"myMethod.res.[code].[category].[name] = foo"</js> or <js>"MyServlet.myMethod.res.[code].[category].[name] = foo"</js>).
+ * (e.g. <js>"myMethod.res.[code].[category].[name] = foo"</js> or
+ * <js>"MyServlet.myMethod.res.[code].[category].[name] = foo"</js>).
*/
Parameter[] headers() default {};
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
index 97624d3..003dece 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
@@ -45,22 +45,33 @@ public @interface RestMethod {
* <p>
* Besides the standard HTTP method names, the following can also be specified:
* <ul>
- * <li><js>"*"</js> - Denotes any method.
+ * <li>
+ * <js>"*"</js>
+ * - Denotes any method.
* <br>Use this if you want to capture any HTTP methods in a single Java method.
- * <br>The {@link Method @Method} annotation and/or {@link RestRequest#getMethod()} method can be used
- * to distinguish the actual HTTP method name.
- * <li><js>""</js> - Auto-detect.
+ * <br>The {@link Method @Method} annotation and/or {@link RestRequest#getMethod()} method can be used to
+ * distinguish the actual HTTP method name.
+ * <li>
+ * <js>""</js>
+ * - Auto-detect.
* <br>The method name is determined based on the Java method name.
- * <br>For example, if the method is <code>doPost(...)</code>, then the method name is automatically detected as <js>"POST"</js>.
+ * <br>For example, if the method is <code>doPost(...)</code>, then the method name is automatically detected
+ * as <js>"POST"</js>.
* <br>Otherwise, defaults to <js>"GET"</js>.
- * <li><js>"PROXY"</js> - Remote-proxy interface.
- * <br>This denotes a Java method that returns an object (usually an interface, often annotated with the {@link Remoteable @Remoteable} annotation)
- * to be used as a remote proxy using <code>RestClient.getRemoteableProxy(Class<T> interfaceClass, String url)</code>.
+ * <li>
+ * <js>"PROXY"</js>
+ * - Remote-proxy interface.
+ * <br>This denotes a Java method that returns an object (usually an interface, often annotated with the
+ * {@link Remoteable @Remoteable} annotation) to be used as a remote proxy using
+ * <code>RestClient.getRemoteableProxy(Class<T> interfaceClass, String url)</code>.
* <br>This allows you to construct client-side interface proxies using REST as a transport medium.
- * <br>Conceptually, this is simply a fancy <code>POST</code> against the url <js>"/{path}/{javaMethodName}"</js> where the arguments
- * are marshalled from the client to the server as an HTTP body containing an array of objects,
- * passed to the method as arguments, and then the resulting object is marshalled back to the client.
- * <li>Anything else - Overloaded non-HTTP-standard names that are passed in through a <code>&method=methodName</code> URL parameter.
+ * <br>Conceptually, this is simply a fancy <code>POST</code> against the url <js>"/{path}/{javaMethodName}"</js>
+ * where the arguments are marshalled from the client to the server as an HTTP body containing an array of
+ * objects, passed to the method as arguments, and then the resulting object is marshalled back to the client.
+ * <li>
+ * Anything else
+ * - Overloaded non-HTTP-standard names that are passed in through a <code>&method=methodName</code> URL
+ * parameter.
* </ul>
*/
String name() default "";
@@ -68,9 +79,10 @@ public @interface RestMethod {
/**
* Optional path pattern for the specified method.
* <p>
- * Appending <js>"/*"</js> to the end of the path pattern will make it match any remainder too.<br>
- * Not appending <js>"/*"</js> to the end of the pattern will cause a 404 (Not found) error to occur
- * if the exact pattern is not found.
+ * Appending <js>"/*"</js> to the end of the path pattern will make it match any remainder too.
+ * <br>
+ * Not appending <js>"/*"</js> to the end of the pattern will cause a 404 (Not found) error to occur if the exact
+ * pattern is not found.
* <p>
* The path can contain variables that get resolved to {@link Path @Path} parameters:
* <p class='bcode'>
@@ -90,8 +102,7 @@ public @interface RestMethod {
* <p>
* To force path patterns to be checked before other path patterns, use a higher priority number.
* <p>
- * By default, it's <code>0</code>, which means it will use an internal heuristic to
- * determine a best match.
+ * By default, it's <code>0</code>, which means it will use an internal heuristic to determine a best match.
*/
int priority() default 0;
@@ -101,8 +112,8 @@ public @interface RestMethod {
* Associates one or more {@link RestGuard RestGuards} with a method call.
* These guards get called immediately before execution of the REST method.
* <p>
- * Typically, guards will be used for permissions checking on the user making the request,
- * but it can also be used for other purposes like pre-call validation of a request.
+ * Typically, guards will be used for permissions checking on the user making the request, but it can also be used
+ * for other purposes like pre-call validation of a request.
*/
Class<? extends RestGuard>[] guards() default {};
@@ -110,12 +121,13 @@ public @interface RestMethod {
* Method response converters.
* <p>
* Associates one or more {@link RestConverter RestConverters} with a method call.
- * These converters get called immediately after execution of the REST method in the same
- * order specified in the annotation.
+ * These converters get called immediately after execution of the REST method in the same order specified in the
+ * annotation.
* <p>
* Can be used for performing post-processing on the response object before serialization.
* <p>
- * Default converters are available in the <a class='doclink' href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package.
+ * Default converters are available in the <a class='doclink'
+ * href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package.
*/
Class<? extends RestConverter>[] converters() default {};
@@ -124,8 +136,8 @@ public @interface RestMethod {
* <p>
* Associates one more more {@link RestMatcher RestMatchers} with this method.
* <p>
- * Matchers are used to allow multiple Java methods to handle requests assigned to the same
- * URL path pattern, but differing based on some request attribute, such as a specific header value.
+ * Matchers are used to allow multiple Java methods to handle requests assigned to the same URL path pattern, but
+ * differing based on some request attribute, such as a specific header value.
* <p>
* See {@link RestMatcher} for details.
*/
@@ -134,9 +146,11 @@ public @interface RestMethod {
/**
* Overrides the list of serializers assigned at the method level.
* <p>
- * Use this annotation when the list of serializers assigned to a method differs from the list of serializers assigned at the servlet level.
+ * Use this annotation when the list of serializers assigned to a method differs from the list of serializers
+ * assigned at the servlet level.
* <p>
- * To append to the list of serializers assigned at the servlet level, use <code>serializersInherit=<jsf>SERIALIZERS</jsf></code>.
+ * To append to the list of serializers assigned at the servlet level, use
+ * <code>serializersInherit=<jsf>SERIALIZERS</jsf></code>.
*
* <p class='bcode'>
* <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {
@@ -156,7 +170,8 @@ public @interface RestMethod {
Class<? extends Serializer>[] serializers() default {};
/**
- * Used in conjunction with {@link #serializers()} to identify what class-level settings are inherited by the method serializer group.
+ * Used in conjunction with {@link #serializers()} to identify what class-level settings are inherited by the method
+ * serializer group.
* <p>
* Possible values:
* <ul>
@@ -180,9 +195,11 @@ public @interface RestMethod {
/**
* Overrides the list of parsers assigned at the method level.
* <p>
- * Use this annotation when the list of parsers assigned to a method differs from the list of parsers assigned at the servlet level.
+ * Use this annotation when the list of parsers assigned to a method differs from the list of parsers assigned at
+ * the servlet level.
* <p>
- * To append to the list of serializers assigned at the servlet level, use <code>serializersInherit=<jsf>SERIALIZERS</jsf></code>.
+ * To append to the list of serializers assigned at the servlet level, use
+ * <code>serializersInherit=<jsf>SERIALIZERS</jsf></code>.
*
* <p class='bcode'>
* <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {
@@ -202,7 +219,8 @@ public @interface RestMethod {
Class<? extends Parser>[] parsers() default {};
/**
- * Used in conjunction with {@link #parsers()} to identify what class-level settings are inherited by the method parser group.
+ * Used in conjunction with {@link #parsers()} to identify what class-level settings are inherited by the method
+ * parser group.
* <p>
* Possible values:
* <ul>
@@ -225,7 +243,8 @@ public @interface RestMethod {
/**
* Appends to the list of {@link Encoder encoders} specified on the servlet.
* <p>
- * Use this annotation when the list of encoders assigned to a method differs from the list of encoders assigned at the servlet level.
+ * Use this annotation when the list of encoders assigned to a method differs from the list of encoders assigned at
+ * the servlet level.
* <p>
* These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.
*
@@ -243,7 +262,8 @@ public @interface RestMethod {
* }
* </p>
* <p>
- * If you want to OVERRIDE the set of encoders specified by the servlet, combine this annotation with <code><ja>@RestMethod</ja>(inheritEncoders=<jk>false</jk>)</code>.
+ * If you want to OVERRIDE the set of encoders specified by the servlet, combine this annotation with
+ * <code><ja>@RestMethod</ja>(inheritEncoders=<jk>false</jk>)</code>.
*/
Class<? extends Encoder>[] encoders() default {};
@@ -255,7 +275,8 @@ public @interface RestMethod {
/**
* Same as {@link RestResource#properties()}, except defines property values by default when this method is called.
* <p>
- * This is equivalent to simply calling <code>res.addProperties()</code> in the Java method, but is provided for convenience.
+ * This is equivalent to simply calling <code>res.addProperties()</code> in the Java method, but is provided for
+ * convenience.
*/
Property[] properties() default {};
@@ -280,10 +301,10 @@ public @interface RestMethod {
* Shortcut for specifying the {@link BeanContext#BEAN_includeProperties} property on all serializers.
* <p>
* The typical use case is when you're rendering summary and details views of the same bean in a resource and
- * you want to expose or hide specific properties depending on the level of detail you want.
+ * you want to expose or hide specific properties depending on the level of detail you want.
* <p>
* In the example below, our 'summary' view is a list of beans where we only want to show the ID property,
- * and our detail view is a single bean where we want to expose different fields:
+ * and our detail view is a single bean where we want to expose different fields:
* <p class='bcode'>
* <jc>// Our bean</jc>
* <jk>public class</jk> MyBean {
@@ -306,9 +327,12 @@ public @interface RestMethod {
* </p>
* <p>
* The format of this value is a lax JSON object.
- * <br>Keys can be fully-qualified or short class names or <js>"*"</js> to represent all classes.
- * <br>Values are comma-delimited lists of bean property names.
- * <br>Properties apply to specified class and all subclasses.
+ * <br>
+ * Keys can be fully-qualified or short class names or <js>"*"</js> to represent all classes.
+ * <br>
+ * Values are comma-delimited lists of bean property names.
+ * <br>
+ * Properties apply to specified class and all subclasses.
*/
String bpIncludes() default "";
@@ -316,7 +340,7 @@ public @interface RestMethod {
* Shortcut for specifying the {@link BeanContext#BEAN_excludeProperties} property on all serializers.
* <p>
* Same as {@link #bpIncludes()} except you specify a list of bean property names that you want to exclude from
- * serialization.
+ * serialization.
* <p>
* In the example below, our 'summary' view is a list of beans where we want to exclude some properties:
* <p class='bcode'>
@@ -341,9 +365,12 @@ public @interface RestMethod {
* </p>
* <p>
* The format of this value is a lax JSON object.
- * <br>Keys can be fully-qualified or short class names or <js>"*"</js> to represent all classes.
- * <br>Values are comma-delimited lists of bean property names.
- * <br>Properties apply to specified class and all subclasses.
+ * <br>
+ * Keys can be fully-qualified or short class names or <js>"*"</js> to represent all classes.
+ * <br>
+ * Values are comma-delimited lists of bean property names.
+ * <br>
+ * Properties apply to specified class and all subclasses.
*/
String bpExcludes() default "";
@@ -354,8 +381,8 @@ public @interface RestMethod {
* <p>
* Affects values returned by {@link RestRequest#getHeader(String)} when the header is not present on the request.
* <p>
- * The most useful reason for this annotation is to provide a default <code>Accept</code> header when one is not specified
- * so that a particular default {@link Serializer} is picked.
+ * The most useful reason for this annotation is to provide a default <code>Accept</code> header when one is not
+ * specified so that a particular default {@link Serializer} is picked.
* <p>
* Only one header value can be specified per entry (i.e. it's not a delimited list of header entries).
* <p>
@@ -400,7 +427,8 @@ public @interface RestMethod {
* <p>
* Strings are of the format <js>"name=value"</js>.
* <p>
- * Affects values returned by {@link RestRequest#getFormData(String)} when the parameter is not present on the request.
+ * Affects values returned by {@link RestRequest#getFormData(String)} when the parameter is not present on the
+ * request.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -420,13 +448,16 @@ public @interface RestMethod {
* <p>
* This summary is used in the following locations:
* <ul class='spaced-list'>
- * <li>The value returned by {@link RestRequest#getMethodSummary()}.
- * <li>The <js>"$R{methodSummary}"</js> variable.
- * <li>The summary of the method in the Swagger page.
+ * <li>
+ * The value returned by {@link RestRequest#getMethodSummary()}.
+ * <li>
+ * The <js>"$R{methodSummary}"</js> variable.
+ * <li>
+ * The summary of the method in the Swagger page.
* </ul>
* <p>
- * The default value pulls the description from the <code>(className.?)[javaMethodName].summary</code> entry in the servlet resource bundle.
- * (e.g. <js>"MyClass.myMethod.summary = foo"</js> or <js>"myMethod.summary = foo"</js>).
+ * The default value pulls the description from the <code>(className.?)[javaMethodName].summary</code> entry in the
+ * servlet resource bundle. (e.g. <js>"MyClass.myMethod.summary = foo"</js> or <js>"myMethod.summary = foo"</js>).
* <p>
* This field value can contain variables (e.g. "$L{my.localized.variable}").
* <p>
@@ -439,13 +470,17 @@ public @interface RestMethod {
* <p>
* This description is used in the following locations:
* <ul class='spaced-list'>
- * <li>The value returned by {@link RestRequest#getMethodDescription()}.
- * <li>The <js>"$R{methodDescription}"</js> variable.
- * <li>The description of the method in the Swagger page.
+ * <li>
+ * The value returned by {@link RestRequest#getMethodDescription()}.
+ * <li>
+ * The <js>"$R{methodDescription}"</js> variable.
+ * <li>
+ * The description of the method in the Swagger page.
* </ul>
* <p>
- * The default value pulls the description from the <code>(className.?)[javaMethodName].description</code> entry in the servlet resource bundle.
- * (e.g. <js>"MyClass.myMethod.description = foo"</js> or <js>"myMethod.description = foo"</js>).
+ * The default value pulls the description from the <code>(className.?)[javaMethodName].description</code> entry in
+ * the servlet resource bundle. (e.g. <js>"MyClass.myMethod.description = foo"</js> or
+ * <js>"myMethod.description = foo"</js>).
* <p>
* This field value can contain variables (e.g. "$L{my.localized.variable}").
* <p>
@@ -456,11 +491,11 @@ public @interface RestMethod {
/**
* Specifies whether this method can be called based on the client version.
* <p>
- * The client version is identified via the HTTP request header identified by {@link RestResource#clientVersionHeader()} which
- * by default is <js>"X-Client-Version"</js>.
+ * The client version is identified via the HTTP request header identified by
+ * {@link RestResource#clientVersionHeader()} which by default is <js>"X-Client-Version"</js>.
* <p>
- * This is a specialized kind of {@link RestMatcher} that allows you to invoke different Java methods for the same method/path based
- * on the client version.
+ * This is a specialized kind of {@link RestMatcher} that allows you to invoke different Java methods for the same
+ * method/path based on the client version.
* <p>
* The format of the client version range is similar to that of OSGi versions.
* <p>
@@ -486,7 +521,8 @@ public @interface RestMethod {
* }
* </p>
* <p>
- * It's common to combine the client version with transforms that will convert new POJOs into older POJOs for backwards compatibility.
+ * It's common to combine the client version with transforms that will convert new POJOs into older POJOs for
+ * backwards compatibility.
* <p class='bcode'>
* <jc>// Call this method if X-Client-Version is at least 2.0.</jc>
* <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/foobar"</js>, clientVersion=<js>"2.0"</js>)
@@ -500,7 +536,8 @@ public @interface RestMethod {
* <jk>return</jk> newMethod()
* }
* <p>
- * Note that in the previous example, we're returning the exact same POJO, but using a transform to convert it into an older form.
+ * Note that in the previous example, we're returning the exact same POJO, but using a transform to convert it into
+ * an older form.
* The old method could also just return back a completely different object.
* The range can be any of the following:
* <ul>
@@ -513,7 +550,7 @@ public @interface RestMethod {
/**
* Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly
- * generate arbitrary replacement text.
+ * generate arbitrary replacement text.
* <p>
* Widgets are inherited from parent to child, but can be overridden by reusing the widget name.
*/
[15/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java
index 5cdd84f..415fc6e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-meter-element"><meter></a>
* element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="meter")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Nav.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Nav.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Nav.java
index 1d9ac5b..007f1d0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Nav.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Nav.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-nav-element"><nav></a>
* element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="nav")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java
index 37097d0..ac749df 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/scripting-1.html#the-noscript-element"><noscript></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="noscript")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java
index a63a076..13e1f74 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/embedded-content-0.html#the-object-element"><object></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="object")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java
index 8e1be54..8b5cd31 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-ol-element"><ol></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="ol")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
index a93e065..d7c3726 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/forms.html#the-optgroup-element"><optgroup></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="optgroup")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java
index 237b55e..1b6da65 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/forms.html#the-option-element"><option></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="option")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java
index 5d99cc8..0038a3f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/forms.html#the-output-element"><output></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="output")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java
index f53dc21..aa32a4e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-p-element"><p></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="p")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java
index 4444e7c..efb6aa6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/embedded-content-0.html#the-param-element"><param></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="param")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java
index f40c248..54d2744 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java
@@ -22,15 +22,17 @@ import org.apache.juneau.xml.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-pre-element"><pre></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="pre")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java
index 17ff965..c71cb06 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/forms.html#the-progress-element"><progress></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="progress")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java
index 7e3727f..37e2ed2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-q-element"><q></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="q")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java
index fc3c9e5..b06de35 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rb-element"><rb></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="rb")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java
index 71173ce..6ed9907 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rp-element"><rp></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="rp")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java
index 303869a..ce57eb3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rt-element"><rt></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="rt")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java
index 5093666..0b0cf9e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rtc-element"><rtc></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="rtc")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java
index aeebe73..8c58efd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-ruby-element"><ruby></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="ruby")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java
index d1a4036..46ad3a2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-s-element"><s></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="s")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java
index 484fa50..79bdbd7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-samp-element"><samp></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="samp")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java
index 952ae54..05d7fec 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java
@@ -21,15 +21,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/scripting-1.html#the-script-element"><script></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="script")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java
index 081575c..32c3f75 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/sections.html#the-section-element"><section></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="section")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java
index 0acb95b..03263c8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/forms.html#the-select-element"><select></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="select")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java
index 0fe437f..daaefa3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-small-element"><small></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="small")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java
index 5026b2c..f57954a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java
@@ -21,15 +21,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/embedded-content-0.html#the-source-element"><source></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="source")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java
index 80e9cc6..6111c85 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-span-element"><span></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="span")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java
index 2ebd20e..65258d2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-strong-element"><strong></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="strong")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java
index bfe9f1e..5ac39cd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/document-metadata.html#the-style-element"><style></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="style")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java
index 972527e..c1382ed 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-sub-and-sup-elements"><sub></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="sub")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java
index d81a57f..27f41d4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-sub-and-sup-elements"><sup></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="sup")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java
index acacb61..608a552 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/tabular-data.html#the-table-element"><table></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="table")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java
index 37e5f1b..e80fa54 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/tabular-data.html#the-tbody-element"><tbody></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="tbody")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java
index 2a9f9f0..b19ea39 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/tabular-data.html#the-td-element"><td></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="td")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java
index 7855e89..d587dda 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/scripting-1.html#the-template-element"><template></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="template")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java
index 18223e2..d74900f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/forms.html#the-textarea-element"><textarea></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="textarea")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
index 0cc8488..0bdeb53 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/tabular-data.html#the-tfoot-element"><tfoot></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="tfoot")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java
index 4e3ee7c..31057e0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/tabular-data.html#the-th-element"><th></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="th")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java
index 5c945be..b4ea5f5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/tabular-data.html#the-thead-element"><thead></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="thead")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java
index 52cfa51..4cc57a2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-time-element"><time></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="time")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java
index 72e4093..f1013c2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/document-metadata.html#the-title-element"><title></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="title")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java
index a31636f..e788410 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/tabular-data.html#the-tr-element"><tr></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="tr")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java
index fabb327..49e7980 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java
@@ -21,15 +21,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/embedded-content-0.html#the-track-element"><track></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="track")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java
index b66c872..e86a679 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-u-element"><u></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="u")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java
index 9a86da5..c33d143 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-ul-element"><ul></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="ul")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java
index 049c220..bd25361 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-var-element"><var></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="var")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java
index 93b9802..33137e1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java
@@ -21,15 +21,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/embedded-content-0.html#the-video-element"><video></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="video")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java
index 8a6612d..5e81f94 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-wbr-element"><wbr></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="wbr")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/package.html b/juneau-core/src/main/java/org/apache/juneau/dto/html5/package.html
index 2529d7f..19cd4b5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/package.html
@@ -72,8 +72,7 @@
<p>
Juneau supports generation and consumption of HTML5 documents and fragments through the use of DTOs (Data
Transfer Objects).
- <br>
- It uses existing support for serializing and parsing POJOs to and from HTML to define these HTML objects.
+ <br>It uses existing support for serializing and parsing POJOs to and from HTML to define these HTML objects.
</p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
index 26a8d4e..f46950a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
@@ -27,13 +27,17 @@ package org.apache.juneau.dto.jsonschema;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>
- * JSON-Schema</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * </li>
* </ul>
*/
public enum JsonType {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
index 3cd6569..4a1faed 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
@@ -16,17 +16,20 @@ import java.util.*;
/**
* Represents a list of {@link JsonType} objects.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink'
- * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * </li>
* </ul>
*/
public final class JsonTypeArray extends LinkedList<JsonType> {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
index 1f33d4c..811ca40 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
@@ -26,17 +26,20 @@ import org.apache.juneau.transform.*;
/**
* Represents a top-level schema object bean in the JSON-Schema core specification.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink'
- * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * </li>
* </ul>
*/
@SuppressWarnings("hiding")
@@ -290,8 +293,10 @@ public class Schema {
/**
* Used during parsing to convert the <property>type</property> property to the correct class type.
* <ul class='spaced-list'>
- * <li>If parsing a JSON-array, converts to a {@link JsonTypeArray}.
- * <li>If parsing a JSON-object, converts to a {@link JsonType}.
+ * <li>
+ * If parsing a JSON-array, converts to a {@link JsonTypeArray}.
+ * <li>
+ * If parsing a JSON-object, converts to a {@link JsonType}.
* </ul>
* Serialization method is a no-op.
*/
@@ -560,8 +565,10 @@ public class Schema {
/**
* Used during parsing to convert the <property>items</property> property to the correct class type.
* <ul class='spaced-list'>
- * <li>If parsing a JSON-array, converts to a {@link SchemaArray}.
- * <li>If parsing a JSON-object, converts to a {@link Schema}.
+ * <li>
+ * If parsing a JSON-array, converts to a {@link SchemaArray}.
+ * <li>
+ * If parsing a JSON-object, converts to a {@link Schema}.
* </ul>
* Serialization method is a no-op.
*/
@@ -868,8 +875,10 @@ public class Schema {
/**
* Used during parsing to convert the <property>additionalItems</property> property to the correct class type.
* <ul class='spaced-list'>
- * <li>If parsing a JSON-array, converts to a {@link SchemaArray}.
- * <li>If parsing a JSON-boolean, converts to a {@link Boolean}.
+ * <li>
+ * If parsing a JSON-array, converts to a {@link SchemaArray}.
+ * <li>
+ * If parsing a JSON-boolean, converts to a {@link Boolean}.
* </ul>
* Serialization method is a no-op.
*/
@@ -1125,8 +1134,10 @@ public class Schema {
/**
* Used during parsing to convert the <property>additionalProperties</property> property to the correct class type.
* <ul class='spaced-list'>
- * <li>If parsing a JSON-object, converts to a {@link Schema}.
- * <li>If parsing a JSON-boolean, converts to a {@link Boolean}.
+ * <li>
+ * If parsing a JSON-object, converts to a {@link Schema}.
+ * <li>
+ * If parsing a JSON-boolean, converts to a {@link Boolean}.
* </ul>
* Serialization method is a no-op.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java
index 8153307..dc48116 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java
@@ -16,17 +16,20 @@ import java.util.*;
/**
* Represents a list of {@link Schema} objects.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink'
- * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * </li>
* </ul>
*/
public class SchemaArray extends LinkedList<Schema> {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
index 1c9c38d..9338a5c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
@@ -25,19 +25,25 @@ import org.apache.juneau.json.*;
* <p>
* Subclasses must implement one of the following methods to load schemas from external sources:
* <ul class='spaced-list'>
- * <li>{@link #getReader(URI)} - If schemas should be loaded from readers and automatically parsed.
- * <li>{@link #load(URI)} - If you want control over construction of {@link Schema} objects.
+ * <li>
+ * {@link #getReader(URI)} - If schemas should be loaded from readers and automatically parsed.
+ * <li>
+ * {@link #load(URI)} - If you want control over construction of {@link Schema} objects.
* </ul>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink'
- * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * </li>
* </ul>
*/
public abstract class SchemaMap extends ConcurrentHashMap<URI,Schema> {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java
index 4a84cbd..c0f1dc7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java
@@ -14,17 +14,20 @@ package org.apache.juneau.dto.jsonschema;
/**
* Represents a JSON property in the JSON-Schema core specification.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink'
- * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * </li>
* </ul>
*/
public class SchemaProperty extends Schema {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
index b1c6d53..1abd7a6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
@@ -27,13 +27,17 @@ package org.apache.juneau.dto.jsonschema;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink'
- * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * </li>
* </ul>
*/
public class SchemaPropertySimpleArray extends SchemaProperty {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
index cc02fe8..57ed39e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
@@ -27,13 +27,17 @@ import org.apache.juneau.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink'
- * href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a>
+ * </li>
* </ul>
*/
public class SchemaRef extends Schema {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html
index 17f1d36..464b388 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html
@@ -73,8 +73,7 @@
<p>
Juneau supports serializing and parsing of JSON-Schema documents through the use of beans defined in the
<code>org.apache.juneau.dto.jsonschema</code> package.
- <br>
- These beans are used with the existing {@link org.apache.juneau.json.JsonSerializer} and
+ <br>These beans are used with the existing {@link org.apache.juneau.json.JsonSerializer} and
{@link org.apache.juneau.json.JsonParser} classes to produce and consume JSON-Schema documents.
</p>
<p>
@@ -247,15 +246,22 @@
The bean classes that make up the model are as follows:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.dto.jsonschema.Schema} - Top level schema object.
- <li>{@link org.apache.juneau.dto.jsonschema.SchemaProperty} - A subclass of <code>Schema</code> for
+ <li>
+ {@link org.apache.juneau.dto.jsonschema.Schema} - Top level schema object.
+ <li>
+ {@link org.apache.juneau.dto.jsonschema.SchemaProperty} - A subclass of <code>Schema</code> for
representing properties.
- <li>{@link org.apache.juneau.dto.jsonschema.SchemaPropertySimpleArray} - A convenience subclass of
+ <li>
+ {@link org.apache.juneau.dto.jsonschema.SchemaPropertySimpleArray} - A convenience subclass of
<code>SchemaProperty</code> for representing properties of simple array types.
- <li>{@link org.apache.juneau.dto.jsonschema.SchemaRef} - Represents a URI reference to another schema.
- <li>{@link org.apache.juneau.dto.jsonschema.SchemaArray} - An array of <code>Schema</code> objects.
- <li>{@link org.apache.juneau.dto.jsonschema.JsonType} - An enum of possible JSON data types.
- <li>{@link org.apache.juneau.dto.jsonschema.JsonTypeArray} - An array of <code>JsonType</code> objects.
+ <li>
+ {@link org.apache.juneau.dto.jsonschema.SchemaRef} - Represents a URI reference to another schema.
+ <li>
+ {@link org.apache.juneau.dto.jsonschema.SchemaArray} - An array of <code>Schema</code> objects.
+ <li>
+ {@link org.apache.juneau.dto.jsonschema.JsonType} - An enum of possible JSON data types.
+ <li>
+ {@link org.apache.juneau.dto.jsonschema.JsonTypeArray} - An array of <code>JsonType</code> objects.
</ul>
</div>
@@ -474,6 +480,7 @@
When you point your browser to this resource, the default content type is HTML (since that's what the
browser asks for by default).
</p>
+
<h6 class='figure'>HTML</h6>
<img class='bordered' src="doc-files/Example_Html.png">
<p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
index 85f8c04..2948d01 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
@@ -34,12 +34,17 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="name,url,email")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
index eb84844..24f556c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
@@ -33,12 +33,17 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="description,url")
[12/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/parser/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/package.html b/juneau-core/src/main/java/org/apache/juneau/parser/package.html
index f60953c..142ac00 100644
--- a/juneau-core/src/main/java/org/apache/juneau/parser/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/parser/package.html
@@ -71,8 +71,7 @@
<div class='topic'>
<p>
The parser API is designed to be easily extensible by developers.
- <br>
- If you are writing your own parser, you will typically subclass directly from either
+ <br>If you are writing your own parser, you will typically subclass directly from either
{@link org.apache.juneau.parser.ReaderParser} or {@link org.apache.juneau.parser.InputStreamParser}.
</p>
@@ -89,10 +88,14 @@
<p>
The <code>ParserGroup</code> class provides the following features:
<ul class='spaced-list'>
- <li>Finds parsers based on HTTP <code>Content-Type</code> header values.
- <li>Sets common properties on all parsers in a single method call.
- <li>Locks all parsers in a single method call.
- <li>Clones existing groups and all parsers within the group in a single method call.
+ <li>
+ Finds parsers based on HTTP <code>Content-Type</code> header values.
+ <li>
+ Sets common properties on all parsers in a single method call.
+ <li>
+ Locks all parsers in a single method call.
+ <li>
+ Clones existing groups and all parsers within the group in a single method call.
</ul>
<p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/Body.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/Body.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/Body.java
index c896bf4..5dd7b25 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/Body.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/Body.java
@@ -23,7 +23,7 @@ import org.apache.juneau.serializer.*;
/**
* Annotation applied to Java method arguments of interface proxies to denote that they are the HTTP body of the
* request.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
@@ -36,17 +36,22 @@ import org.apache.juneau.serializer.*;
* <p>
* The argument can be any of the following types:
* <ul class='spaced-list'>
- * <li>Any serializable POJO - Converted to text using the {@link Serializer} registered with the
+ * <li>
+ * Any serializable POJO - Converted to text using the {@link Serializer} registered with the
* <code>RestClient</code>.
- * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.
- * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.
- * <li><code>HttpEntity</code> - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
- * <li><code>NameValuePairs</code> - Converted to a URL-encoded FORM post.
+ * <li>
+ * {@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.
+ * <li>
+ * {@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.
+ * <li>
+ * <code>HttpEntity</code> - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
+ * <li>
+ * <code>NameValuePairs</code> - Converted to a URL-encoded FORM post.
* </ul>
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
* {@link RequestBean @RequestBean}:
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
@@ -64,9 +69,10 @@ import org.apache.juneau.serializer.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
@Documented
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/FormData.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/FormData.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/FormData.java
index 1468d12..7f7f6e3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/FormData.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/FormData.java
@@ -23,7 +23,7 @@ import org.apache.juneau.urlencoding.*;
/**
* Annotation applied to Java method arguments of interface proxies to denote that they are FORM post parameters on the
* request.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
@@ -65,7 +65,7 @@ import org.apache.juneau.urlencoding.*;
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
* {@link RequestBean @RequestBean}:
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
@@ -127,9 +127,10 @@ import org.apache.juneau.urlencoding.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
@Documented
@@ -148,8 +149,10 @@ public @interface FormData {
* <p>
* A blank value (the default) has the following behavior:
* <ul class='spaced-list'>
- * <li>If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean,
+ * <li>
+ * If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean,
* then it's the equivalent to <js>"*"</js> which will cause the value to be serialized as name/value pairs.
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <jc>// When used on a remote method parameter</jc>
@@ -169,8 +172,10 @@ public @interface FormData {
* Map<String,Object> getFoo();
* }
* </p>
- * <br>
- * <li>If used on a request bean method, uses the bean property name.
+ * </li>
+ * <li>
+ * If used on a request bean method, uses the bean property name.
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <jk>public interface</jk> MyRequestBean {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java
index 1beafaa..36849d2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java
@@ -25,9 +25,10 @@ import org.apache.juneau.urlencoding.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
@Documented
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/Header.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/Header.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/Header.java
index 5d2ebee..e7c4f18 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/Header.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/Header.java
@@ -23,7 +23,7 @@ import org.apache.juneau.urlencoding.*;
/**
* Annotation applied to Java method arguments of interface proxies to denote that they are serialized as an HTTP
* header value.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
@@ -54,7 +54,7 @@ import org.apache.juneau.urlencoding.*;
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
* {@link RequestBean @RequestBean}:
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
@@ -100,8 +100,7 @@ import org.apache.juneau.urlencoding.*;
* <p>
* The {@link #name()} and {@link #value()} elements are synonyms for specifying the header name.
* Only one should be used.
- * <br>
- * The following annotations are fully equivalent:
+ * <br>The following annotations are fully equivalent:
* <p>
* <p class='bcode'>
* <ja>@Header</ja>(name=<js>"Foo"</js>)
@@ -111,9 +110,10 @@ import org.apache.juneau.urlencoding.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
@Documented
@@ -132,8 +132,10 @@ public @interface Header {
* <p>
* A blank value (the default) has the following behavior:
* <ul class='spaced-list'>
- * <li>If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean,
+ * <li>
+ * If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean,
* then it's the equivalent to <js>"*"</js> which will cause the value to be serialized as name/value pairs.
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <jc>// When used on a remote method parameter</jc>
@@ -153,8 +155,10 @@ public @interface Header {
* Map<String,Object> getFoo();
* }
* </p>
- * <br>
- * <li>If used on a request bean method, uses the bean property name.
+ * </li>
+ * <li>
+ * If used on a request bean method, uses the bean property name.
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <jk>public interface</jk> MyRequestBean {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java
index 071c076..b039ff0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java
@@ -25,9 +25,10 @@ import org.apache.juneau.urlencoding.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
@Documented
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/Path.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/Path.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/Path.java
index 8144c0b..bb8c08c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/Path.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/Path.java
@@ -22,7 +22,7 @@ import org.apache.juneau.urlencoding.*;
/**
* Annotation applied to Java method arguments of interface proxies to denote that they are path variables on the request.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
@@ -52,7 +52,7 @@ import org.apache.juneau.urlencoding.*;
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
* {@link RequestBean @RequestBean}:
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
@@ -98,8 +98,7 @@ import org.apache.juneau.urlencoding.*;
* <p>
* The {@link #name()} and {@link #value()} elements are synonyms for specifying the path variable name.
* Only one should be used.
- * <br>
- * The following annotations are fully equivalent:
+ * <br>The following annotations are fully equivalent:
* <p>
* <p class='bcode'>
* <ja>@Path</ja>(name=<js>"foo"</js>)
@@ -109,9 +108,10 @@ import org.apache.juneau.urlencoding.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
@Documented
@@ -130,8 +130,10 @@ public @interface Path {
* <p>
* A blank value (the default) has the following behavior:
* <ul class='spaced-list'>
- * <li>If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean,
+ * <li>
+ * If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean,
* then it's the equivalent to <js>"*"</js> which will cause the value to be treated as name/value pairs.
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <jc>// When used on a remote method parameter</jc>
@@ -151,8 +153,10 @@ public @interface Path {
* Map<String,Object> getPathVars();
* }
* </p>
- * <br>
- * <li>If used on a request bean method, uses the bean property name.
+ * </li>
+ * <li>
+ * If used on a request bean method, uses the bean property name.
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <jk>public interface</jk> MyRequestBean {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/Query.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/Query.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/Query.java
index 97dbfbb..a43f4e5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/Query.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/Query.java
@@ -23,7 +23,7 @@ import org.apache.juneau.urlencoding.*;
/**
* Annotation applied to Java method arguments of interface proxies to denote that they are QUERY parameters on the
* request.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
@@ -64,7 +64,7 @@ import org.apache.juneau.urlencoding.*;
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
* {@link RequestBean @RequestBean}:
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
@@ -115,9 +115,7 @@ import org.apache.juneau.urlencoding.*;
* <p>
* The {@link #name()} and {@link #value()} elements are synonyms for specifying the parameter name.
* Only one should be used.
- * <br>
- * The following annotations are fully equivalent:
- * <p>
+ * <br>The following annotations are fully equivalent:
* <p class='bcode'>
* <ja>@Query</ja>(name=<js>"foo"</js>)
*
@@ -126,9 +124,10 @@ import org.apache.juneau.urlencoding.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
@Documented
@@ -147,8 +146,10 @@ public @interface Query {
* <p>
* A blank value (the default) has the following behavior:
* <ul class='spaced-list'>
- * <li>If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean,
+ * <li>
+ * If the data type is <code>NameValuePairs</code>, <code>Map</code>, or a bean,
* then it's the equivalent to <js>"*"</js> which will cause the value to be serialized as name/value pairs.
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <jc>// When used on a remote method parameter</jc>
@@ -168,8 +169,10 @@ public @interface Query {
* Map<String,Object> getFoo();
* }
* </p>
- * <br>
- * <li>If used on a request bean method, uses the bean property name.
+ * </li>
+ * <li>
+ * If used on a request bean method, uses the bean property name.
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <jk>public interface</jk> MyRequestBean {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java
index cec1aea..be70654 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java
@@ -25,9 +25,10 @@ import org.apache.juneau.urlencoding.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
@Documented
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java
index 911f4f7..fd9f8e2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java
@@ -35,9 +35,10 @@ import java.lang.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
@Documented
@@ -74,7 +75,8 @@ public @interface RemoteMethod {
* <p>
* Possible values:
* <ul>
- * <li>{@link ReturnValue#BODY} (default) - The body of the HTTP response converted to a POJO.
+ * <li>
+ * {@link ReturnValue#BODY} (default) - The body of the HTTP response converted to a POJO.
* <br>The return type on the Java method can be any of the following:
* <ul>
* <li><jk>void</jk> - Don't parse any response. Note that the method will still throw an exception if an
@@ -86,7 +88,8 @@ public @interface RemoteMethod {
* <li>{@link Reader} - Returns access to the raw reader of the response.
* <li>{@link InputStream} - Returns access to the raw input stream of the response.
* </ul>
- * <li>{@link ReturnValue#HTTP_STATUS} - The HTTP status code on the response.
+ * <li>
+ * {@link ReturnValue#HTTP_STATUS} - The HTTP status code on the response.
* <br>The return type on the Java method can be any of the following:
* <ul>
* <li><jk>int</jk>/<code>Integer</code> - The HTTP response code.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java
index 00f58dd..394c6ba 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java
@@ -22,9 +22,10 @@ import org.apache.juneau.urlencoding.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
public class RemoteMethodArg {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/Remoteable.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/Remoteable.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/Remoteable.java
index 788a04e..73e8b8c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/Remoteable.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/Remoteable.java
@@ -19,13 +19,13 @@ import java.lang.annotation.*;
/**
* Identifies a remote proxy interface against a REST interface.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
@Documented
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java
index 461cc1d..5931ff8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java
@@ -27,9 +27,10 @@ import java.util.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
public class RemoteableMeta {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java
index 3c71cf9..0495438 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java
@@ -26,9 +26,10 @@ import java.util.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
public class RemoteableMethodMeta {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/remoteable/RequestBean.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/remoteable/RequestBean.java b/juneau-core/src/main/java/org/apache/juneau/remoteable/RequestBean.java
index 5c46a90..605f8b1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/remoteable/RequestBean.java
+++ b/juneau-core/src/main/java/org/apache/juneau/remoteable/RequestBean.java
@@ -22,7 +22,7 @@ import org.apache.juneau.urlencoding.*;
/**
* Annotation applied to Java method arguments of interface proxies to denote a bean with remoteable annotations.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
@@ -83,9 +83,10 @@ import org.apache.juneau.urlencoding.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface
- * proxies against 3rd-party REST interfaces</a>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ * <li class='link'>
+ * <a class='doclink' href='../../../../overview-summary.html#Remoteable.3rdParty'>Interface proxies against 3rd-party REST interfaces</a>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.remoteable</a>
* </ul>
*/
@Documented
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java
index 489a01c..a699b2b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java
@@ -64,7 +64,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* Abort serialization if specified depth is reached in the POJO tree.
* If this depth is exceeded, an exception is thrown.
* This prevents stack overflows from occurring when trying to serialize models with recursive references.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_maxDepth</jsf>, value)</code>.
@@ -90,7 +90,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* <p>
* The initial indentation level at the root.
* Useful when constructing document fragments that need to be indented at a certain level.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_initialDepth</jsf>, value)</code>.
@@ -124,7 +124,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* For example, if a model contains the links A->B->C->A, then the JSON generated will look like
* the following when <jsf>SERIALIZER_ignoreRecursions</jsf> is <jk>true</jk>...
* <code>{A:{B:{C:null}}}</code>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_detectRecursions</jsf>, value)</code>.
@@ -152,10 +152,9 @@ public class SerializerBuilder extends CoreObjectBuilder {
* Used in conjunction with {@link SerializerContext#SERIALIZER_detectRecursions}.
* Setting is ignored if <jsf>SERIALIZER_detectRecursions</jsf> is <jk>false</jk>.
* <p>
- * If <jk>true</jk>, when we encounter the same object when serializing a tree,
- * we set the value to <jk>null</jk>.
+ * If <jk>true</jk>, when we encounter the same object when serializing a tree, we set the value to <jk>null</jk>.
* Otherwise, an exception is thrown.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_ignoreRecursions</jsf>, value)</code>.
@@ -181,7 +180,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* </ul>
* <p>
* If <jk>true</jk>, newlines and indentation and spaces are added to the output to improve readability.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_useWhitespace</jsf>, value)</code>.
@@ -215,7 +214,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* </ul>
* <p>
* Specifies the maximum indentation level in the serialized document.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_maxIndent</jsf>, value)</code>.
@@ -244,7 +243,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* This is used to recreate the correct objects during parsing if the object types cannot be inferred.
* For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined from
* the value type.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_addBeanTypeProperties</jsf>, value)</code>.
@@ -270,7 +269,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* </ul>
* <p>
* This is the character used for quoting attributes and values.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_quoteChar</jsf>, value)</code>.
@@ -304,7 +303,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* </ul>
* <p>
* If <jk>true</jk>, null bean values will not be serialized to the output.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_trimNullProperties</jsf>, value)</code>.
@@ -333,7 +332,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* </ul>
* <p>
* If <jk>true</jk>, empty list values will not be serialized to the output.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_trimEmptyCollections</jsf>, value)</code>.
@@ -363,7 +362,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* </ul>
* <p>
* If <jk>true</jk>, empty map values will not be serialized to the output.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_trimEmptyMaps</jsf>, value)</code>.
@@ -392,7 +391,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* </ul>
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being serialized.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_trimStrings</jsf>, value)</code>.
@@ -417,12 +416,12 @@ public class SerializerBuilder extends CoreObjectBuilder {
* </ul>
* <p>
* Bean used for resolution of URIs to absolute or root-relative form.
- * <p>
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <js>"{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}"</js>
* </p>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_uriContext</jsf>, value)</code>.
@@ -462,7 +461,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* <li>{@link UriResolution#NONE}
* - Don't do any URL resolution.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_uriResolution</jsf>, value)</code>.
@@ -500,7 +499,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* <li>{@link UriRelativity#PATH_INFO}
* - Relative URIs should be considered relative to the request URI.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_uriRelativity</jsf>, value)</code>.
@@ -523,7 +522,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_sortCollections</jsf>, value)</code>.
@@ -547,6 +546,7 @@ public class SerializerBuilder extends CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_sortMaps</jsf>, value)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerContext.java
index f316fac..0afd2b4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerContext.java
@@ -70,7 +70,7 @@ public class SerializerContext extends BeanContext {
* For example, if a model contains the links A->B->C->A, then the JSON generated will look like
* the following when <jsf>SERIALIZER_ignoreRecursions</jsf> is <jk>true</jk>...
* <code>{A:{B:{C:null}}}</code>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Checking for recursion can cause a small performance penalty.
@@ -177,7 +177,8 @@ public class SerializerContext extends BeanContext {
* <p>
* Note that enabling this setting has the following effects on parsing:
* <ul class='spaced-list'>
- * <li>Map entries with <jk>null</jk> values will be lost.
+ * <li>
+ * Map entries with <jk>null</jk> values will be lost.
* </ul>
*/
public static final String SERIALIZER_trimNullProperties = "Serializer.trimNullProperties";
@@ -196,8 +197,10 @@ public class SerializerContext extends BeanContext {
* <p>
* Note that enabling this setting has the following effects on parsing:
* <ul class='spaced-list'>
- * <li>Map entries with empty list values will be lost.
- * <li>Bean properties with empty list values will not be set.
+ * <li>
+ * Map entries with empty list values will be lost.
+ * <li>
+ * Bean properties with empty list values will not be set.
* </ul>
*/
public static final String SERIALIZER_trimEmptyCollections = "Serializer.trimEmptyLists";
@@ -216,7 +219,8 @@ public class SerializerContext extends BeanContext {
* <p>
* Note that enabling this setting has the following effects on parsing:
* <ul class='spaced-list'>
- * <li>Bean properties with empty map values will not be set.
+ * <li>
+ * Bean properties with empty map values will not be set.
* </ul>
*/
public static final String SERIALIZER_trimEmptyMaps = "Serializer.trimEmptyMaps";
@@ -246,7 +250,7 @@ public class SerializerContext extends BeanContext {
* </ul>
* <p>
* Bean used for resolution of URIs to absolute or root-relative form.
- * <p>
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <js>"{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}"</js>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroup.java b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroup.java
index 0c1cf0e..2a6d3bb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerGroup.java
@@ -25,10 +25,14 @@ import org.apache.juneau.http.*;
* <p>
* Provides the following features:
* <ul class='spaced-list'>
- * <li>Finds serializers based on HTTP <code>Accept</code> header values.
- * <li>Sets common properties on all serializers in a single method call.
- * <li>Locks all serializers in a single method call.
- * <li>Clones existing groups and all serializers within the group in a single method call.
+ * <li>
+ * Finds serializers based on HTTP <code>Accept</code> header values.
+ * <li>
+ * Sets common properties on all serializers in a single method call.
+ * <li>
+ * Locks all serializers in a single method call.
+ * <li>
+ * Clones existing groups and all serializers within the group in a single method call.
* </ul>
*
* <h6 class='topic'>Match ordering</h6>
@@ -116,8 +120,7 @@ public final class SerializerGroup {
* <p>
* The general idea behind having the serializer resolution be a two-step process is so that the matched media type
* can be passed in to the {@link WriterSerializer#doSerialize(SerializerSession, Object)} method.
- * <br>
- * For example...
+ * <br>For example...
* <p class='bcode'>
* String acceptHeaderValue = request.getHeader(<js>"Accept"</js>);
* String matchingMediaType = group.findMatch(acceptHeaderValue);
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerSession.java
index 80aa351..f75d3c2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/serializer/SerializerSession.java
@@ -31,10 +31,14 @@ import org.apache.juneau.transform.*;
* <p>
* Used by serializers for the following purposes:
* <ul class='spaced-list'>
- * <li>Keeping track of how deep it is in a model for indentation purposes.
- * <li>Ensuring infinite loops don't occur by setting a limit on how deep to traverse a model.
- * <li>Ensuring infinite loops don't occur from loops in the model (when detectRecursions is enabled.
- * <li>Allowing serializer properties to be overridden on method calls.
+ * <li>
+ * Keeping track of how deep it is in a model for indentation purposes.
+ * <li>
+ * Ensuring infinite loops don't occur by setting a limit on how deep to traverse a model.
+ * <li>
+ * Ensuring infinite loops don't occur from loops in the model (when detectRecursions is enabled.
+ * <li>
+ * Allowing serializer properties to be overridden on method calls.
* </ul>
* <p>
* This class is NOT thread safe. It is meant to be discarded after one-time use.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/serializer/WriterSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/WriterSerializer.java b/juneau-core/src/main/java/org/apache/juneau/serializer/WriterSerializer.java
index 699eb74..bb0491f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/serializer/WriterSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/serializer/WriterSerializer.java
@@ -29,8 +29,10 @@ import org.apache.juneau.utils.*;
* This class is typically the parent class of all character-based serializers.
* It has 2 abstract methods to implement...
* <ul class='spaced-list'>
- * <li>{@link #createSession(Object, ObjectMap, Method, Locale, TimeZone, MediaType, UriContext)}
- * <li>{@link #doSerialize(SerializerSession, Object)}
+ * <li>
+ * {@link #createSession(Object, ObjectMap, Method, Locale, TimeZone, MediaType, UriContext)}
+ * <li>
+ * {@link #doSerialize(SerializerSession, Object)}
* </ul>
*
* <h6 class='topic'>@Produces annotation</h6>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/serializer/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/serializer/package.html b/juneau-core/src/main/java/org/apache/juneau/serializer/package.html
index fc85f8b..ac50911 100644
--- a/juneau-core/src/main/java/org/apache/juneau/serializer/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/serializer/package.html
@@ -71,8 +71,7 @@
<div class='topic'>
<p>
The serialization API is designed to be easily extensible by developers.
- <br>
- If you are writing your own serializer, you will typically subclass directly from either
+ <br>If you are writing your own serializer, you will typically subclass directly from either
{@link org.apache.juneau.serializer.WriterSerializer} or
{@link org.apache.juneau.serializer.OutputStreamSerializer}.
</p>
@@ -89,11 +88,16 @@
<h6 class='topic'>Features</h6>
<p>
The <code>SerializerGroup</code> class provides the following features:
+ </p>
<ul class='spaced-list'>
- <li>Finds serializers based on HTTP <code>Accept</code> header values.
- <li>Sets common properties on all serializers in a single method call.
- <li>Locks all serializers in a single method call.
- <li>Clones existing groups and all serializers within the group in a single method call.
+ <li>
+ Finds serializers based on HTTP <code>Accept</code> header values.
+ <li>
+ Sets common properties on all serializers in a single method call.
+ <li>
+ Locks all serializers in a single method call.
+ <li>
+ Clones existing groups and all serializers within the group in a single method call.
</ul>
<p>
@@ -110,8 +114,7 @@
<p>
Defining a new serializer is quite simple if you subclass directly from
{@link org.apache.juneau.serializer.WriterSerializer} or {@link org.apache.juneau.serializer.OutputStreamSerializer}.
- <br>
- In each case, you simply need to implement a single method and specify a
+ <br>In each case, you simply need to implement a single method and specify a
{@link org.apache.juneau.annotation.Produces} annotation.
</p>
<p>
@@ -133,8 +136,7 @@
<p>
Serializer that take advantage of the entire {@link org.apache.juneau.CoreObject} interface to be able to
serialize arbitrary beans and POJOs is considerably more complex and outside the scope of this document.
- <br>
- If developing such a serializer, the best course of action would be to replicate what occurs in the
+ <br>If developing such a serializer, the best course of action would be to replicate what occurs in the
{@link org.apache.juneau.json.JsonSerializer} class.
</p>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java
index f4dfb85..74dd512 100644
--- a/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java
@@ -60,7 +60,7 @@ public class SoapXmlSerializerBuilder extends XmlSerializerBuilder {
* <li><b>Data type:</b> <code>String</code>
* <li><b>Default:</b> <js>"http://www.w3.org/2003/05/soap-envelope"</js>
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>SOAPXML_SOAPAction</jsf>, value)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerContext.java
index 6d33b92..0746c19 100644
--- a/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/soap/SoapXmlSerializerContext.java
@@ -29,13 +29,15 @@ package org.apache.juneau.soap;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
* - Properties associated with handling beans on serializers and parsers.
- * <ul>
- * <li class='jc'><a class="doclink"
- * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
- * - Configurable properties common to all serializers.
- * </ul>
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
+ * </ul>
+ * </li>
* </ul>
*/
public final class SoapXmlSerializerContext {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/svl/VarResolver.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/VarResolver.java b/juneau-core/src/main/java/org/apache/juneau/svl/VarResolver.java
index aa9cceb..f4d8cc9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/VarResolver.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/VarResolver.java
@@ -23,8 +23,7 @@ import org.apache.juneau.svl.vars.*;
* Utility class for resolving variables of the form <js>"$X{key}"</js> in strings.
* <p>
* Variables are of the form <code>$X{key}</code>, where <code>X</code> can consist of zero or more ASCII characters.
- * <br>
- * The variable key can contain anything, even nested variables that get recursively resolved.
+ * <br>The variable key can contain anything, even nested variables that get recursively resolved.
* <p>
* Variables are defined through the {@link VarResolverBuilder#vars(Class[])} method.
* <p>
@@ -83,7 +82,7 @@ import org.apache.juneau.svl.vars.*;
* <p>
* Var resolvers can be cloned by using the {@link #builder()} method.
* Cloning a resolver will copy it's {@link Var} class names and context objects.
- * <p>
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a resolver that copies the default resolver and adds $C and $ARG vars.</jc>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/svl/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/package.html b/juneau-core/src/main/java/org/apache/juneau/svl/package.html
index e282e01..de1b9ac 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/package.html
@@ -132,54 +132,72 @@
</p>
<p>
The following shows the class hierarchy of the {@link org.apache.juneau.svl.Var} class and all current
- predefined implementations.
+ predefined implementations.
</p>
<ul class='doctree'>
- <li class='jac'>{@link org.apache.juneau.svl.Var} - Superclass of all vars.
+ <li class='jac'>
+ {@link org.apache.juneau.svl.Var}
+ - Superclass of all vars.
<ul>
- <li class='jac'>{@link org.apache.juneau.svl.SimpleVar} - Superclass of all vars that return strings.
+ <li class='jac'>
+ {@link org.apache.juneau.svl.SimpleVar}
+ - Superclass of all vars that return strings.
<ul>
- <li class='jac'>{@link org.apache.juneau.svl.DefaultingVar}
+ <li class='jac'>
+ {@link org.apache.juneau.svl.DefaultingVar}
- Variables that define a default value if the resolve method returns null.
<ul>
- <li class='jac'>{@link org.apache.juneau.svl.MapVar}
+ <li class='jac'>
+ {@link org.apache.juneau.svl.MapVar}
- Variables that pull values from maps.
<ul>
- <li class='jc'>{@link org.apache.juneau.svl.vars.SystemPropertiesVar}
+ <li class='jc'>
+ {@link org.apache.juneau.svl.vars.SystemPropertiesVar}
- Resolves system properties.
</ul>
</li>
- <li class='jc'>{@link org.apache.juneau.svl.vars.ArgsVar}
+ <li class='jc'>
+ {@link org.apache.juneau.svl.vars.ArgsVar}
- Resolves variables from an {@link org.apache.juneau.utils.Args} object.
- <li class='jc'>{@link org.apache.juneau.svl.vars.ConfigFileVar}
+ <li class='jc'>
+ {@link org.apache.juneau.svl.vars.ConfigFileVar}
- Resolves variables from a {@link org.apache.juneau.ini.ConfigFile} object.
- <li class='jc'>{@link org.apache.juneau.svl.vars.EnvVariablesVar}
+ <li class='jc'>
+ {@link org.apache.juneau.svl.vars.EnvVariablesVar}
- Resolves environment variables.
- <li class='jc'>{@link org.apache.juneau.svl.vars.ManifestFileVar}
+ <li class='jc'>
+ {@link org.apache.juneau.svl.vars.ManifestFileVar}
- Resolves variables from a {@link org.apache.juneau.utils.ManifestFile} object.
- <li class='jc'>{@link org.apache.juneau.rest.vars.ServletInitParamVar}
+ <li class='jc'>
+ {@link org.apache.juneau.rest.vars.ServletInitParamVar}
- Resolves servlet initialization parameters.
</ul>
</li>
- <li class='jac'>{@link org.apache.juneau.svl.MultipartVar}
+ <li class='jac'>
+ {@link org.apache.juneau.svl.MultipartVar}
- Variables that consist of 2 or more comma-delimited arguments.
<ul>
- <li class='jc'>{@link org.apache.juneau.rest.vars.LocalizationVar}
+ <li class='jc'>
+ {@link org.apache.juneau.rest.vars.LocalizationVar}
- Resolves localized strings for an HTTP request.
</ul>
</li>
- <li class='jc'>{@link org.apache.juneau.rest.vars.RequestVar}
+ <li class='jc'>
+ {@link org.apache.juneau.rest.vars.RequestVar}
- Resolves specialized HTTP request values.
- <li class='jc'>{@link org.apache.juneau.rest.vars.UrlEncodeVar}
+ <li class='jc'>
+ {@link org.apache.juneau.rest.vars.UrlEncodeVar}
- URL-encodes the value inside the variable.
</ul>
</li>
- <li class='jac'>{@link org.apache.juneau.svl.StreamedVar}
+ <li class='jac'>
+ {@link org.apache.juneau.svl.StreamedVar}
- Superclass of all vars that stream their value to writers.
<ul>
- <li class='jc'>{@link org.apache.juneau.rest.vars.SerializedRequestAttrVar}
- - Resolves HTTP request attribute values passed through a
- {@link org.apache.juneau.serializer.Serializer}.
+ <li class='jc'>
+ {@link org.apache.juneau.rest.vars.SerializedRequestAttrVar}
+ - Resolves HTTP request attribute values passed through a
+ {@link org.apache.juneau.serializer.Serializer}.
</ul>
</li>
</ul>
@@ -196,9 +214,11 @@
Two methods are provided for resolving variables:
</p>
<ul class='doctree'>
- <li class='jm'>{@link org.apache.juneau.svl.VarResolver#resolve(String)}
+ <li class='jm'>
+ {@link org.apache.juneau.svl.VarResolver#resolve(String)}
- Resolves variables and returns the results as a simple string.
- <li class='jm'>{@link org.apache.juneau.svl.VarResolver#resolveTo(String,Writer)}
+ <li class='jm'>
+ {@link org.apache.juneau.svl.VarResolver#resolveTo(String,Writer)}
- Resolves variables and sends results to a writer.
</ul>
<p>
@@ -248,6 +268,7 @@
method.
Cloning a resolver will copy it's {@link org.apache.juneau.svl.Var} class names and context objects.
</p>
+
<h6 class='topic'>Example:</h6>
<p class='bcode'>
<jc>// Create a resolver that copies the default resolver and adds $C and $ARG vars.</jc>
@@ -261,16 +282,18 @@
<h3 class='topic' onclick='toggle(this)'>1.3 - Other Notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>The escape character <js>'\'</js> can be used when necessary to escape the following characters:
+ <li>
+ The escape character <js>'\'</js> can be used when necessary to escape the following characters:
<code>$ , { }</code>
- <li><b>WARNING:</b> It is possible to cause {@link java.lang.StackOverflowError StackOverflowErrors} if
+ <li>
+ <b>WARNING:</b> It is possible to cause {@link java.lang.StackOverflowError StackOverflowErrors} if
your nested variables result in a recursive loop (e.g. the environment variable
<code>'MYPROPERTY'</code> has the value <code>'$E{MYPROPERTY}'</code>).
So don't do that!
- <li>As a general rule, this class tries to be as efficient as possible by not creating new strings when not
+ <li>
+ As a general rule, this class tries to be as efficient as possible by not creating new strings when not
needed.
- <br>
- For example, calling the resolve method on a string that doesn't contain variables (e.g.
+ <br>For example, calling the resolve method on a string that doesn't contain variables (e.g.
<code>resolver.resolve(<js>"foobar"</js>)</code>) will simply be a no-op and return the same string.
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/svl/vars/IfVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/svl/vars/IfVar.java b/juneau-core/src/main/java/org/apache/juneau/svl/vars/IfVar.java
index 922fb99..b5600b5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/svl/vars/IfVar.java
+++ b/juneau-core/src/main/java/org/apache/juneau/svl/vars/IfVar.java
@@ -26,11 +26,9 @@ import org.apache.juneau.svl.*;
* </ul>
* <p>
* The boolean argument is any string.
- * <br>
- * The following values are interpreted as <jk>true</jk>: <js>"true"</js>,<js>"TRUE"</js>,<js>"t"</js>,
+ * <br>The following values are interpreted as <jk>true</jk>: <js>"true"</js>,<js>"TRUE"</js>,<js>"t"</js>,
* <js>"T"</js>,<js>"1"</js>.
- * <br>
- * All else are interpreted as <jk>false</jk>
+ * <br>All else are interpreted as <jk>false</jk>
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/transform/PojoSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transform/PojoSwap.java b/juneau-core/src/main/java/org/apache/juneau/transform/PojoSwap.java
index e6384fe..14e89ee 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transform/PojoSwap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/transform/PojoSwap.java
@@ -36,8 +36,7 @@ import org.apache.juneau.serializer.*;
* <p>
* <code>PojoSwaps</code> are associated with instances of {@link BeanContext BeanContexts} by passing the swap
* class to the {@link CoreObjectBuilder#pojoSwaps(Class...)} method.
- * <br>
- * When associated with a bean context, fields of the specified type will automatically be converted when the
+ * <br>When associated with a bean context, fields of the specified type will automatically be converted when the
* {@link BeanMap#get(Object)} or {@link BeanMap#put(String, Object)} methods are called.
* <p>
* <code>PojoSwaps</code> have two parameters:
@@ -45,11 +44,9 @@ import org.apache.juneau.serializer.*;
* <li>{@code <T>} - The normal representation of an object.
* <li>{@code <S>} - The swapped representation of an object.
* </ol>
- * <br>
- * {@link Serializer Serializers} use swaps to convert objects of type T into objects of type S, and on calls to
+ * <br>{@link Serializer Serializers} use swaps to convert objects of type T into objects of type S, and on calls to
* {@link BeanMap#get(Object)}.
- * <br>
- * {@link Parser Parsers} use swaps to convert objects of type S into objects of type T, and on calls to
+ * <br>{@link Parser Parsers} use swaps to convert objects of type S into objects of type T, and on calls to
* {@link BeanMap#put(String,Object)}.
*
* <h6 class='topic'>Subtypes</h6>
@@ -74,13 +71,20 @@ import org.apache.juneau.serializer.*;
* JSON (or language-specific equivalent).
* The list of valid transformed types are as follows...
* <ul class='spaced-list'>
- * <li>{@link String}
- * <li>{@link Number}
- * <li>{@link Boolean}
- * <li>{@link Collection} containing anything on this list.
- * <li>{@link Map} containing anything on this list.
- * <li>A java bean with properties of anything on this list.
- * <li>An array of anything on this list.
+ * <li>
+ * {@link String}
+ * <li>
+ * {@link Number}
+ * <li>
+ * {@link Boolean}
+ * <li>
+ * {@link Collection} containing anything on this list.
+ * <li>
+ * {@link Map} containing anything on this list.
+ * <li>
+ * A java bean with properties of anything on this list.
+ * <li>
+ * An array of anything on this list.
* </ul>
*
* <h6 class='topic'>Normal Class Type {@code <T>}</h6>
@@ -143,13 +147,20 @@ public abstract class PojoSwap<T,S> {
* <p>
* The object must be converted into one of the following serializable types:
* <ul class='spaced-list'>
- * <li>{@link String}
- * <li>{@link Number}
- * <li>{@link Boolean}
- * <li>{@link Collection} containing anything on this list.
- * <li>{@link Map} containing anything on this list.
- * <li>A java bean with properties of anything on this list.
- * <li>An array of anything on this list.
+ * <li>
+ * {@link String}
+ * <li>
+ * {@link Number}
+ * <li>
+ * {@link Boolean}
+ * <li>
+ * {@link Collection} containing anything on this list.
+ * <li>
+ * {@link Map} containing anything on this list.
+ * <li>
+ * A java bean with properties of anything on this list.
+ * <li>
+ * An array of anything on this list.
* </ul>
*
* @param session The bean session to use to get the class meta.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/transform/SurrogateSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transform/SurrogateSwap.java b/juneau-core/src/main/java/org/apache/juneau/transform/SurrogateSwap.java
index a547340..69f3dfe 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transform/SurrogateSwap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/transform/SurrogateSwap.java
@@ -49,14 +49,17 @@ import org.apache.juneau.serializer.*;
* <p>
* Surrogate classes must conform to the following:
* <ul class='spaced-list'>
- * <li>It must have a one or more public constructors that take in a single parameter whose type is the normal types.
+ * <li>
+ * It must have a one or more public constructors that take in a single parameter whose type is the normal types.
* (It is possible to define a class as a surrogate for multiple class types by using multiple constructors with
* different parameter types).
- * <li>It optionally can have a public static method that takes in a single parameter whose type is the transformed
+ * <li>
+ * It optionally can have a public static method that takes in a single parameter whose type is the transformed
* type and returns an instance of the normal type.
* This is called the un-transform method.
* The method can be called anything.
- * <li>If an un-transform method is present, the class must also contain a no-arg constructor (so that the
+ * <li>
+ * If an un-transform method is present, the class must also contain a no-arg constructor (so that the
* transformed class can be instantiated by the parser before being converted into the normal class by the
* un-transform method).
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/transform/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transform/package.html b/juneau-core/src/main/java/org/apache/juneau/transform/package.html
index a51c2e8..124bc10 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transform/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/transform/package.html
@@ -79,8 +79,10 @@
These classes are:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.transform.BeanFilter} - Transforms that alter the way beans are handled.
- <li>{@link org.apache.juneau.transform.PojoSwap} - Transforms that swap non-serializable POJOs with
+ <li>
+ {@link org.apache.juneau.transform.BeanFilter} - Transforms that alter the way beans are handled.
+ <li>
+ {@link org.apache.juneau.transform.PojoSwap} - Transforms that swap non-serializable POJOs with
serializable POJOs during serialization (and optionally vis-versa during parsing).
<ol>
<li>{@link org.apache.juneau.transform.StringSwap} - Convenience subclass for swaps that convert
@@ -94,14 +96,22 @@
Transforms are added to serializers and parsers in a variety of ways:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.serializer.SerializerBuilder#beanFilters(Class[])} / {@link org.apache.juneau.serializer.SerializerBuilder#pojoSwaps(Class[])} - On serializers.
- <li>{@link org.apache.juneau.serializer.SerializerGroupBuilder#beanFilters(Class[])} / {@link org.apache.juneau.serializer.SerializerGroupBuilder#pojoSwaps(Class[])} - On groups of serializers.
- <li>{@link org.apache.juneau.parser.ParserBuilder#beanFilters(Class[])} / {@link org.apache.juneau.parser.ParserBuilder#pojoSwaps(Class[])} - On parsers.
- <li>{@link org.apache.juneau.parser.ParserGroupBuilder#beanFilters(Class[])} / {@link org.apache.juneau.parser.ParserGroupBuilder#pojoSwaps(Class[])} - On groups of parsers.
- <li>{@link org.apache.juneau.rest.client.RestClientBuilder#beanFilters(Class[])} / {@link org.apache.juneau.rest.client.RestClientBuilder#pojoSwaps(Class[])} - On the serializer and parser registered on a REST client.
- <li>{@link org.apache.juneau.rest.annotation.RestResource#beanFilters() @RestResource.beanFilters()} / {@link org.apache.juneau.rest.annotation.RestResource#pojoSwaps() @RestResource.pojoSwaps()}- On all serializers and parsers defined on a REST servlet.
- <li>{@link org.apache.juneau.rest.annotation.RestMethod#beanFilters() @RestMethod.beanFilters()} / {@link org.apache.juneau.rest.annotation.RestMethod#pojoSwaps() @RestMethod.pojoSwaps()} - On all serializers and parsers defined on a method in a REST servlet.
- <li>{@link org.apache.juneau.rest.jaxrs.JuneauProvider#beanFilters() @JuneauProvider.beanFilters()} / {@link org.apache.juneau.rest.jaxrs.JuneauProvider#pojoSwaps() @JuneauProvider.pojoSwaps()} - On all serializers and parsers defined on a JAX-RS provider.
+ <li>
+ {@link org.apache.juneau.serializer.SerializerBuilder#beanFilters(Class[])} / {@link org.apache.juneau.serializer.SerializerBuilder#pojoSwaps(Class[])} - On serializers.
+ <li>
+ {@link org.apache.juneau.serializer.SerializerGroupBuilder#beanFilters(Class[])} / {@link org.apache.juneau.serializer.SerializerGroupBuilder#pojoSwaps(Class[])} - On groups of serializers.
+ <li>
+ {@link org.apache.juneau.parser.ParserBuilder#beanFilters(Class[])} / {@link org.apache.juneau.parser.ParserBuilder#pojoSwaps(Class[])} - On parsers.
+ <li>
+ {@link org.apache.juneau.parser.ParserGroupBuilder#beanFilters(Class[])} / {@link org.apache.juneau.parser.ParserGroupBuilder#pojoSwaps(Class[])} - On groups of parsers.
+ <li>
+ {@link org.apache.juneau.rest.client.RestClientBuilder#beanFilters(Class[])} / {@link org.apache.juneau.rest.client.RestClientBuilder#pojoSwaps(Class[])} - On the serializer and parser registered on a REST client.
+ <li>
+ {@link org.apache.juneau.rest.annotation.RestResource#beanFilters() @RestResource.beanFilters()} / {@link org.apache.juneau.rest.annotation.RestResource#pojoSwaps() @RestResource.pojoSwaps()}- On all serializers and parsers defined on a REST servlet.
+ <li>
+ {@link org.apache.juneau.rest.annotation.RestMethod#beanFilters() @RestMethod.beanFilters()} / {@link org.apache.juneau.rest.annotation.RestMethod#pojoSwaps() @RestMethod.pojoSwaps()} - On all serializers and parsers defined on a method in a REST servlet.
+ <li>
+ {@link org.apache.juneau.rest.jaxrs.JuneauProvider#beanFilters() @JuneauProvider.beanFilters()} / {@link org.apache.juneau.rest.jaxrs.JuneauProvider#pojoSwaps() @JuneauProvider.pojoSwaps()} - On all serializers and parsers defined on a JAX-RS provider.
</ul>
<p>
Swaps can also be associated with classes through the {@link org.apache.juneau.annotation.Pojo#swap @Pojo.swap()} annotation.
@@ -116,10 +126,14 @@
They can be used for the following purposes:
</p>
<ul class='spaced-list'>
- <li>Include or exclude which properties are exposed in beans, or the order those properties are serialized.
- <li>Define property-namers for customizing bean property names.
- <li>Define bean subtypes.
- <li>Define bean interface classes.
+ <li>
+ Include or exclude which properties are exposed in beans, or the order those properties are serialized.
+ <li>
+ Define property-namers for customizing bean property names.
+ <li>
+ Define bean subtypes.
+ <li>
+ Define bean interface classes.
</ul>
<p>
It should be noted that the {@link org.apache.juneau.annotation.Bean @Bean} annotation provides equivalent
@@ -127,8 +141,7 @@
However, the <code>BeanFilter</code> class allows you to provide the same features when you do not have
access to the source code.
<p>
- <h5 class='topic'>Examples</h5>
-
+
<h6 class='topic'>Explicitly specify which properties are visible on a bean class</h6>
<p class='bcode'>
<jc>// Define bean filter that orders properties by "age" then "name"</jc>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java
index 498a8b7..805fbd7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/transforms/CalendarSwap.java
@@ -30,7 +30,7 @@ import org.apache.juneau.transform.*;
* <h6 class='topic'>Behavior-specific subclasses</h6>
* <p>
* The following direct subclasses are provided for convenience to the following formats:
- * <ul class='spaced-list'>
+ * <ul>
* <li>{@link ToString} - To {@link String Strings} using the {@code Date.toString()} method.
* <li>{@link ISO8601DT} - To ISO8601 date-time strings.
* <li>{@link ISO8601DTZ} - Same as {@link ISO8601DT}, except always serializes in GMT.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java
index 94b27b1..1bb74bb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/transforms/DateSwap.java
@@ -30,7 +30,7 @@ import org.apache.juneau.transform.*;
* <h6 class='topic'>Behavior-specific subclasses</h6>
* <p>
* The following direct subclasses are provided for convenience to the following formats:
- * <ul class='spaced-list'>
+ * <ul>
* <li>{@link ToString} - To {@link String Strings} using the {@code Date.toString()} method.
* <li>{@link ISO8601DT} - To ISO8601 date-time strings.
* <li>{@link ISO8601DTZ} - Same as {@link ISO8601DT}, except always serializes in GMT.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java b/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java
index b8e9011..73f31e4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/transforms/ReaderSwap.java
@@ -39,7 +39,7 @@ import org.apache.juneau.xml.*;
* <h6 class='topic'>Behavior-specific subclasses</h6>
* <p>
* The following direct subclasses are provided for convenience:
- * <ul class='spaced-list'>
+ * <ul>
* <li>{@link Json} - Parses JSON text.
* <li>{@link Xml} - Parses XML text.
* <li>{@link Html} - Parses HTML text.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java
index 2dcf520..b3ee739 100644
--- a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserBuilder.java
@@ -64,7 +64,7 @@ public class UonParserBuilder extends ParserBuilder {
* <p>
* Specify <jk>true</jk> if URI encoded characters should be decoded, <jk>false</jk> if they've already been
* decoded before being passed to this parser.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>UON_decodeChars</jsf>, value)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java
index 49764ee..7cf666b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonParserContext.java
@@ -26,12 +26,15 @@ import org.apache.juneau.urlencoding.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
* - Properties associated with handling beans on serializers and parsers.
- * <ul>
- * <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
- * - Configurable properties common to all parsers.
- * </ul>
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
+ * - Configurable properties common to all parsers.
+ * </ul>
+ * </li>
* </ul>
*/
public class UonParserContext extends ParserContext {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java
index 3eb3c03..c516626 100644
--- a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java
@@ -67,7 +67,7 @@ public class UonSerializerBuilder extends SerializerBuilder {
* If <jk>true</jk>, non-valid URI characters will be converted to <js>"%xx"</js> sequences.
* Set to <jk>false</jk> if parameter value is being passed to some other code that will already perform
* URL-encoding of non-valid URI characters.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>UON_encodeChars</jsf>, value)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java
index 685408f..15ca313 100644
--- a/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonSerializerContext.java
@@ -26,13 +26,15 @@ import org.apache.juneau.urlencoding.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
* - Properties associated with handling beans on serializers and parsers.
- * <ul>
- * <li class='jc'><a class="doclink"
- * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
- * - Configurable properties common to all serializers.
- * </ul>
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
+ * </ul>
+ * </li>
* </ul>
*/
public class UonSerializerContext extends SerializerContext {
@@ -89,21 +91,19 @@ public class UonSerializerContext extends SerializerContext {
* Specifies the format to use for URL GET parameter keys and values.
* <p>
* The possible values are:
- * <ul>
- * <li><js>"UON"</js> (default) - Use UON notation for values.
- * <br>
- * String values such as <js>"(foo='bar')"</js> will end up being quoted and escaped to <js>"'(foo=bar~'baz~')'"</js>.
- * <br>
- * Boolean strings (<js>"true"</js>/<js>"false"</js>) and numeric values (<js>"123"</js>) will also end up
+ * <ul class='spaced-list'>
+ * <li>
+ * <js>"UON"</js> (default) - Use UON notation for values.
+ * <br>String values such as <js>"(foo='bar')"</js> will end up being quoted and escaped to <js>"'(foo=bar~'baz~')'"</js>.
+ * <br>Boolean strings (<js>"true"</js>/<js>"false"</js>) and numeric values (<js>"123"</js>) will also end up
* quoted (<js>"'true'"</js>, <js>"'false'"</js>, <js>"'123'"</js>.
- * <li><js>"PLAINTEXT"</js> (default) - Serialize as plain text.
- * <br>
- * Strings will never be quoted or escaped.
- * <br>
- * Note that this can cause errors during parsing if you're using the URL-encoding parser to parse
+ * <li>
+ * <js>"PLAINTEXT"</js> (default) - Serialize as plain text.
+ * <br>Strings will never be quoted or escaped.
+ * <br>Note that this can cause errors during parsing if you're using the URL-encoding parser to parse
* the results since UON constructs won't be differentiable.
- * <br>
- * However, this is not an issue if you're simply creating queries or form posts against 3rd-party interfaces.
+ * <br>However, this is not an issue if you're simply creating queries or form posts against 3rd-party
+ * interfaces.
* </ul>
*/
public static final String UON_paramFormat = "UonSerializer.paramFormat";
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/uon/UonWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/UonWriter.java b/juneau-core/src/main/java/org/apache/juneau/uon/UonWriter.java
index b107af3..0476fa0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/uon/UonWriter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/uon/UonWriter.java
@@ -20,7 +20,7 @@ import org.apache.juneau.serializer.*;
/**
* Specialized writer for serializing UON-encoded text.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This class is not intended for external use.
[13/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java b/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java
index 1c4405d..56a9041 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java
@@ -56,8 +56,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Location.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Location.java b/juneau-core/src/main/java/org/apache/juneau/http/Location.java
index 5d37c25..fdf3c7a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Location.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Location.java
@@ -45,8 +45,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java b/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java
index 2660354..c94a2cd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java
@@ -47,8 +47,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java b/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java
index 408c073..148054a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java
@@ -26,8 +26,10 @@ import org.apache.juneau.json.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
@@ -81,7 +83,7 @@ public class MediaType implements Comparable<MediaType> {
* </ul>
*
* @param s The media type string. Will be lowercased.
- * <br>Returns <jk>null</jk> if input is null.
+ * Returns <jk>null</jk> if input is null.
* @return A cached media type object.
*/
public static MediaType forString(String s) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java b/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java
index 9ebf720..dd48a70 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java
@@ -24,8 +24,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java b/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java
index 26c8ce2..85d9408 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java
@@ -53,8 +53,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java b/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java
index 13594cd..dc60d54 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java
@@ -40,8 +40,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java b/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java
index 2b7287d..b944aa0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java
@@ -42,8 +42,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Range.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Range.java b/juneau-core/src/main/java/org/apache/juneau/http/Range.java
index 1c7cb9b..00248db 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Range.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Range.java
@@ -118,8 +118,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Referer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Referer.java b/juneau-core/src/main/java/org/apache/juneau/http/Referer.java
index e5757a5..3230a0a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Referer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Referer.java
@@ -47,8 +47,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java b/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java
index 747c814..60c76a0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java
@@ -49,8 +49,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Server.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Server.java b/juneau-core/src/main/java/org/apache/juneau/http/Server.java
index d484976..0325cf9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Server.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Server.java
@@ -47,8 +47,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java b/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java
index e41213e..2510511 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java
@@ -29,8 +29,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/TE.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/TE.java b/juneau-core/src/main/java/org/apache/juneau/http/TE.java
index 7ed9855..c9de654 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/TE.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/TE.java
@@ -75,8 +75,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java b/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java
index da276f2..237fbce 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java
@@ -47,8 +47,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java b/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java
index dcbb896..6440a83 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java
@@ -46,8 +46,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java b/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java
index 0ccd015..6895e31 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java
@@ -66,8 +66,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java b/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java
index e8e4827..3b2db5b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java
@@ -42,8 +42,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Vary.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Vary.java b/juneau-core/src/main/java/org/apache/juneau/http/Vary.java
index fc4bc41..aff07a2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Vary.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Vary.java
@@ -61,8 +61,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Via.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Via.java b/juneau-core/src/main/java/org/apache/juneau/http/Via.java
index 35e6131..575a813 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Via.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Via.java
@@ -97,8 +97,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Warning.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Warning.java b/juneau-core/src/main/java/org/apache/juneau/http/Warning.java
index ae37a66..ec081ed 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Warning.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Warning.java
@@ -105,8 +105,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java b/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
index 08bfee7..7dad3a0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
@@ -38,8 +38,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java
index 18efcf9..d6d5ad2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java
@@ -134,9 +134,12 @@ public abstract class ConfigFile implements Map<String,Section> {
* <p>
* The lines can be any of the following....
* <ul class='spaced-list'>
- * <li><js>"# comment"</js> - A comment line.
- * <li><js>"key=val"</js> - A key/value pair (equivalent to calling {@link #put(String,Object)}.
- * <li><js>" foobar "</js> - Anything else (interpreted as a comment).
+ * <li>
+ * <js>"# comment"</js> - A comment line.
+ * <li>
+ * <js>"key=val"</js> - A key/value pair (equivalent to calling {@link #put(String,Object)}.
+ * <li>
+ * <js>" foobar "</js> - Anything else (interpreted as a comment).
* </ul>
* <p>
* If the section does not exist, it will automatically be created.
@@ -157,8 +160,10 @@ public abstract class ConfigFile implements Map<String,Section> {
* <p>
* Header comments can be of the following formats...
* <ul class='spaced-list'>
- * <li><js>"# comment"</js> - A comment line.
- * <li><js>"comment"</js> - Anything else (will automatically be prefixed with <js>"# "</js>).
+ * <li>
+ * <js>"# comment"</js> - A comment line.
+ * <li>
+ * <js>"comment"</js> - Anything else (will automatically be prefixed with <js>"# "</js>).
* </ul>
* <p>
* If the section does not exist, it will automatically be created.
@@ -264,8 +269,10 @@ public abstract class ConfigFile implements Map<String,Section> {
* <p>
* The key can be in one of the following formats...
* <ul class='spaced-list'>
- * <li><js>"key"</js> - A value in the default section (i.e. defined above any <code>[section]</code> header).
- * <li><js>"section/key"</js> - A value from the specified section.
+ * <li>
+ * <js>"key"</js> - A value in the default section (i.e. defined above any <code>[section]</code> header).
+ * <li>
+ * <js>"section/key"</js> - A value from the specified section.
* </ul>
* <p>
* The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).
@@ -299,7 +306,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* types.
* <p>
* The array can be arbitrarily long to indicate arbitrarily complex data structures.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Use the {@link #getObject(String, Class)} method instead if you don't need a parameterized map/collection.
@@ -348,6 +355,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* Same as {@link #getObject(String, Type, Type...)} except optimized for a non-parameterized class.
* <p>
* This is the preferred parse method for simple types since you don't need to cast the results.
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* ConfigFile cf = <jk>new</jk> ConfigFileBuilder().build(<js>"MyConfig.cfg"</js>);
@@ -566,8 +574,10 @@ public abstract class ConfigFile implements Map<String,Section> {
* <p>
* The key can be in one of the following formats...
* <ul class='spaced-list'>
- * <li><js>"key"</js> - A value in the default section (i.e. defined above any <code>[section]</code> header).
- * <li><js>"section/key"</js> - A value from the specified section.
+ * <li>
+ * <js>"key"</js> - A value in the default section (i.e. defined above any <code>[section]</code> header).
+ * <li>
+ * <js>"section/key"</js> - A value from the specified section.
* </ul>
*
* @param key The key. See {@link #getString(String)} for a description of the key.
@@ -619,8 +629,10 @@ public abstract class ConfigFile implements Map<String,Section> {
*
* <h5 class='section'>Example:</h5>
* <ul class='spaced-list'>
- * <li><code><js>"100K"</js> => 1024000</code>
- * <li><code><js>"100M"</js> => 104857600</code>
+ * <li>
+ * <code><js>"100K"</js> => 1024000</code>
+ * <li>
+ * <code><js>"100M"</js> => 104857600</code>
* </ul>
*
* @param key The key. See {@link #getString(String)} for a description of the key.
@@ -694,11 +706,15 @@ public abstract class ConfigFile implements Map<String,Section> {
* <p>
* The format of the entry depends on the data type of the value.
* <ul class='spaced-list'>
- * <li>Simple types (<code>String</code>, <code>Number</code>, <code>Boolean</code>, primitives)
+ * <li>
+ * Simple types (<code>String</code>, <code>Number</code>, <code>Boolean</code>, primitives)
* are serialized as plain strings.
- * <li>Arrays and collections of simple types are serialized as comma-delimited lists of plain strings.
- * <li>Other types (e.g. beans) are serialized using the serializer registered with this config file.
- * <li>Arrays and collections of other types are serialized as comma-delimited lists of serialized strings of
+ * <li>
+ * Arrays and collections of simple types are serialized as comma-delimited lists of plain strings.
+ * <li>
+ * Other types (e.g. beans) are serialized using the serializer registered with this config file.
+ * <li
+ * >Arrays and collections of other types are serialized as comma-delimited lists of serialized strings of
* each entry.
* </ul>
*
@@ -823,7 +839,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* Converts this config file section to the specified bean instance.
* <p>
* Key/value pairs in the config file section get copied as bean property values to the specified bean class.
- * <p>
+ *
* <h6 class='figure'>Example config file</h6>
* <p class='bcode'>
* <cs>[MyAddress]</cs>
@@ -880,7 +896,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Wraps a config file section inside a Java interface so that values in the section can be read and
* write using getters and setters.
- * <p>
+ *
* <h6 class='figure'>Example config file</h6>
* <p class='bcode'>
* <cs>[MySection]</cs>
@@ -1111,9 +1127,12 @@ public abstract class ConfigFile implements Map<String,Section> {
*
* The default {@link VarResolver} is registered with the following {@link Var StringVars}:
* <ul class='spaced-list'>
- * <li><code>$S{key}</code>,<code>$S{key,default}</code> - System properties.
- * <li><code>$E{key}</code>,<code>$E{key,default}</code> - Environment variables.
- * <li><code>$C{key}</code>,<code>$C{key,default}</code> - Values in this configuration file.
+ * <li>
+ * <code>$S{key}</code>,<code>$S{key,default}</code> - System properties.
+ * <li>
+ * <code>$E{key}</code>,<code>$E{key,default}</code> - Environment variables.
+ * <li>
+ * <code>$C{key}</code>,<code>$C{key,default}</code> - Values in this configuration file.
* </ul>
*
* @return A new config file that resolves string variables.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java
index 499dc37..39baf64 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java
@@ -224,22 +224,21 @@ public class ConfigFileBuilder {
* <p>
* Arguments can be any of the following...
* <ul class='spaced-list'>
- * <li>No arguments
- * <br>
- * Prints usage message.
- * <li><code>createBatchEnvFile -configfile <configFile> -envfile <batchFile> [-verbose]</code>
- * <br>
- * Creates a batch file that will set each config file entry as an environment variable.
- * <br>
- * Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>)
- * will be converted to underscores.
- * <li><code>createShellEnvFile -configFile <configFile> -envFile <configFile> [-verbose]</code>
+ * <li>
+ * No arguments
+ * <br>Prints usage message.
+ * <li>
+ * <code>createBatchEnvFile -configfile <configFile> -envfile <batchFile> [-verbose]</code>
+ * <br>Creates a batch file that will set each config file entry as an environment variable.
+ * <br>Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>)
+ * will be converted to underscores.
+ * <li>
+ * <code>createShellEnvFile -configFile <configFile> -envFile <configFile> [-verbose]</code>
* Creates a shell script that will set each config file entry as an environment variable.
- * <br>
- * Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>)
+ * <br>Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>)
* will be converted to underscores.
- * <br>
- * <li><code>setVals -configFile <configFile> -vals [var1=val1 [var2=val2...]] [-verbose]</code>
+ * <li>
+ * <code>setVals -configFile <configFile> -vals [var1=val1 [var2=val2...]] [-verbose]</code>
* Sets values in config files.
* </ul>
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/ini/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/package.html b/juneau-core/src/main/java/org/apache/juneau/ini/package.html
index 290c43b..aeda8c4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/package.html
@@ -228,9 +228,11 @@
Resolving config files can be retrieved through the following methods:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.ini.ConfigFile#getResolving()} - Returns a config file that resolves a default
+ <li>
+ {@link org.apache.juneau.ini.ConfigFile#getResolving()} - Returns a config file that resolves a default
set of variables.
- <li>{@link org.apache.juneau.ini.ConfigFile#getResolving(VarResolver)} - Returns a config file that resolves
+ <li>
+ {@link org.apache.juneau.ini.ConfigFile#getResolving(VarResolver)} - Returns a config file that resolves
a custom set of variables.
</ul>
<p>
@@ -238,11 +240,14 @@
the following variables:
</p>
<ul class='spaced-list'>
- <li><code>$S{key}</code>, <code>$S{key,default}</code> - System properties.
- <li><code>$E{key}</code>, <code>$E{key,default}</code> - Environment variables.
- <li><code>$C{key}</code>, <code>$C{key,default}</code> - Values in this configuration file.
+ <li>
+ <code>$S{key}</code>, <code>$S{key,default}</code> - System properties.
+ <li>
+ <code>$E{key}</code>, <code>$E{key,default}</code> - Environment variables.
+ <li>
+ <code>$C{key}</code>, <code>$C{key,default}</code> - Values in this configuration file.
</ul>
- <p>
+
<h6 class='topic'>Examples:</h6>
<p class='bcode'>
<cc>#--------------------------</cc>
@@ -256,8 +261,7 @@
<p>
Support for variables is extensible. You can add support for your own variables by implementing custom
{@link org.apache.juneau.svl.VarResolver VarResolvers}.
- <br>
- For example, the microservice <code>Resource</code> class provides access to config files that
+ <br>For example, the microservice <code>Resource</code> class provides access to config files that
can contain any of the following variables:
</p>
<ul>
@@ -282,8 +286,7 @@
<p>
If a config file contains sensitive information such as passwords, those values can be
marked for encoding by appending <js>'*'</js> to the end of the key name.
- <br>
- If a marked and unencoded value is detected in the file during load, it will be encoded and saved immediately.
+ <br>If a marked and unencoded value is detected in the file during load, it will be encoded and saved immediately.
</p>
<p>
For example, the following password is marked for encoding....
@@ -305,8 +308,7 @@
</p>
<p>
The default encoder is {@link org.apache.juneau.ini.XorEncoder} which is a simple XOR+Base64 encoder.
- <br>
- If desired, custom encoder can be used by implementing the {@link org.apache.juneau.ini.Encoder}
+ <br>If desired, custom encoder can be used by implementing the {@link org.apache.juneau.ini.Encoder}
interface and creating your own <code>ConfigFileBuilder</code> using the
{@link org.apache.juneau.ini.ConfigFileBuilder#encoder(Encoder)} method.
</p>
@@ -326,10 +328,14 @@
Subclasses are provided for listening for different kinds of events:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.ini.ConfigFileListener} - Config file is saved, loaded, or modified.
- <li>{@link org.apache.juneau.ini.SectionListener} - One or more entries in a section are modified.
- <li>{@link org.apache.juneau.ini.EntryListener} - An individual entry is modified.
+ <li>
+ {@link org.apache.juneau.ini.ConfigFileListener} - Config file is saved, loaded, or modified.
+ <li>
+ {@link org.apache.juneau.ini.SectionListener} - One or more entries in a section are modified.
+ <li>
+ {@link org.apache.juneau.ini.EntryListener} - An individual entry is modified.
</ul>
+
<h6 class="topic">Example:</h6>
<p class='bcode'>
<jc>// Get our config file using the default config manager</jc>
@@ -355,8 +361,7 @@
The {@link org.apache.juneau.ini.ConfigFileBuilder} class contains a
{@link org.apache.juneau.ini.ConfigFileBuilder#main(String[])} method that can be used to work with config
files through a command-line prompt.
- <br>
- This is invoked as a normal Java command:
+ <br>This is invoked as a normal Java command:
</p>
<p class='bcode'>
java -jar juneau.jar org.apache.juneau.ini.ConfigFileBuilder [args]
@@ -365,21 +370,21 @@
Arguments can be any of the following...
</p>
<ul class='spaced-list'>
- <li>No arguments
- <br>
- Prints usage message.
- <li><code>createBatchEnvFile -configfile <configFile> -envfile <batchFile> [-verbose]</code>
- <br>
- Creates a batch file that will set each config file entry as an environment variable.
- <br>
- Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>)
+ <li>
+ No arguments
+ <br>Prints usage message.
+ <li>
+ <code>createBatchEnvFile -configfile <configFile> -envfile <batchFile> [-verbose]</code>
+ <br>Creates a batch file that will set each config file entry as an environment variable.
+ <br>Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>)
will be converted to underscores.
- <li><code>createShellEnvFile -configFile <configFile> -envFile <configFile> [-verbose]</code>
+ <li>
+ <code>createShellEnvFile -configFile <configFile> -envFile <configFile> [-verbose]</code>
Creates a shell script that will set each config file entry as an environment variable.
- <br>
- Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>)
- will be converted to underscores.
- <li><code>setVals -configFile <configFile> -vals [var1=val1 [var2=val2...]] [-verbose]</code>
+ <br>Characters in the keys that are not valid as environment variable names (e.g. <js>'/'</js> and <js>'.'</js>)
+ will be converted to underscores.
+ <li>
+ <code>setVals -configFile <configFile> -vals [var1=val1 [var2=val2...]] [-verbose]</code>
Sets values in config files.
</ul>
<p>
@@ -402,11 +407,9 @@
<p>
The <code>org.apache.juneau.microservice.resources.ConfigResource</code> is a predefined REST interface that
allows access to the config file used by a microservice.
- <br>
- The <code>juneau-examples-rest</code> project is a microservice that includes this resource
+ <br>The <code>juneau-examples-rest</code> project is a microservice that includes this resource
at <code>http://localhost:10000/sample/config</code>.
- <br>
- The sample microservice uses the following config file <code>juneau-examples.cfg</code>:
+ <br>The sample microservice uses the following config file <code>juneau-examples.cfg</code>:
</p>
<p class='bcode'>
<cc>#================================================================================
@@ -618,13 +621,10 @@
<p>
In the previous example, an edit page was shown that allows you to edit config files through
a REST interface.
- <br>
- Note that if only a single entry is modified in the config file, we only want to trigger
+ <br>Note that if only a single entry is modified in the config file, we only want to trigger
listeners for that change, not trigger all listeners.
- <br>
- This is where the {@link org.apache.juneau.ini.ConfigFile#merge(ConfigFile)} method comes into play.
- <br>
- This method will copy the contents of one config file over to another config file, but only
+ <br>This is where the {@link org.apache.juneau.ini.ConfigFile#merge(ConfigFile)} method comes into play.
+ <br>This method will copy the contents of one config file over to another config file, but only
trigger listeners when the values are different.
</p>
<p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/internal/IdentityList.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/IdentityList.java b/juneau-core/src/main/java/org/apache/juneau/internal/IdentityList.java
index b3db4ba..7ddf361 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/IdentityList.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/IdentityList.java
@@ -17,10 +17,12 @@ import java.util.*;
/**
* Combination of a {@link LinkedList} and <code>IdentitySet</code>.
* <ul class='spaced-list'>
- * <li>Duplicate objects (by identity) will be skipped during insertion.
- * <li>Order of insertion maintained.
+ * <li>
+ * Duplicate objects (by identity) will be skipped during insertion.
+ * <li>
+ * Order of insertion maintained.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This class is NOT thread safe, and is intended for use on small lists.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/internal/KeywordSet.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/KeywordSet.java b/juneau-core/src/main/java/org/apache/juneau/internal/KeywordSet.java
index fda08a5..831efbc 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/KeywordSet.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/KeywordSet.java
@@ -19,8 +19,10 @@ import static org.apache.juneau.internal.ThrowableUtils.*;
* <p>
* Keywords must be:
* <ul class='spaced-list'>
- * <li>2 or more characters in length.
- * <li>Lowercase ASCII.
+ * <li>
+ * 2 or more characters in length.
+ * <li>
+ * Lowercase ASCII.
* </ul>
*/
public final class KeywordSet {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java
index e777a2c..14d5345 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java
@@ -60,7 +60,7 @@ public final class StringUtils {
* Parses a number from the specified reader stream.
*
* @param r The reader to parse the string from.
- * @param type The number type to created. <br>
+ * @param type The number type to created.
* Can be any of the following:
* <ul>
* <li> Integer
@@ -107,7 +107,7 @@ public final class StringUtils {
* Parses a number from the specified string.
*
* @param s The string to parse the number from.
- * @param type The number type to created. <br>
+ * @param type The number type to created.
* Can be any of the following:
* <ul>
* <li> Integer
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java
index c86e207..e18a513 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java
@@ -41,42 +41,61 @@ import org.apache.juneau.transform.*;
* This parser handles all valid JSON syntax.
* In addition, when strict mode is disable, the parser also handles the following:
* <ul class='spaced-list'>
- * <li> Javascript comments (both {@code /*} and {@code //}) are ignored.
- * <li> Both single and double quoted strings.
- * <li> Automatically joins concatenated strings (e.g. <code><js>"aaa"</js> + <js>'bbb'</js></code>).
- * <li> Unquoted attributes.
+ * <li>
+ * Javascript comments (both {@code /*} and {@code //}) are ignored.
+ * <li>
+ * Both single and double quoted strings.
+ * <li>
+ * Automatically joins concatenated strings (e.g. <code><js>"aaa"</js> + <js>'bbb'</js></code>).
+ * <li>
+ * Unquoted attributes.
* </ul>
* Also handles negative, decimal, hexadecimal, octal, and double numbers, including exponential notation.
* <p>
* This parser handles the following input, and automatically returns the corresponding Java class.
* <ul class='spaced-list'>
- * <li> JSON objects (<js>"{...}"</js>) are converted to {@link ObjectMap ObjectMaps}. <br>
+ * <li>
+ * JSON objects (<js>"{...}"</js>) are converted to {@link ObjectMap ObjectMaps}.
* <b>Note:</b> If a <code><xa>_type</xa>=<xs>'xxx'</xs></code> attribute is specified on the object, then an
* attempt is made to convert the object to an instance of the specified Java bean class.
* See the <code>beanTypeName</code> setting on the {@link PropertyStore} for more information about parsing
* beans from JSON.
- * <li> JSON arrays (<js>"[...]"</js>) are converted to {@link ObjectList ObjectLists}.
- * <li> JSON string literals (<js>"'xyz'"</js>) are converted to {@link String Strings}.
- * <li> JSON numbers (<js>"123"</js>, including octal/hexadecimal/exponential notation) are converted to
+ * <li>
+ * JSON arrays (<js>"[...]"</js>) are converted to {@link ObjectList ObjectLists}.
+ * <li>
+ * JSON string literals (<js>"'xyz'"</js>) are converted to {@link String Strings}.
+ * <li>
+ * JSON numbers (<js>"123"</js>, including octal/hexadecimal/exponential notation) are converted to
* {@link Integer Integers}, {@link Long Longs}, {@link Float Floats}, or {@link Double Doubles} depending on
* whether the number is decimal, and the size of the number.
- * <li> JSON booleans (<js>"false"</js>) are converted to {@link Boolean Booleans}.
- * <li> JSON nulls (<js>"null"</js>) are converted to <jk>null</jk>.
- * <li> Input consisting of only whitespace or JSON comments are converted to <jk>null</jk>.
+ * <li>
+ * JSON booleans (<js>"false"</js>) are converted to {@link Boolean Booleans}.
+ * <li>
+ * JSON nulls (<js>"null"</js>) are converted to <jk>null</jk>.
+ * <li>
+ * Input consisting of only whitespace or JSON comments are converted to <jk>null</jk>.
* </ul>
* <p>
* Input can be any of the following:
* <ul class='spaced-list'>
- * <li> <js>"{...}"</js> - Converted to a {@link ObjectMap} or an instance of a Java bean if a <xa>_type</xa>
+ * <li>
+ * <js>"{...}"</js> - Converted to a {@link ObjectMap} or an instance of a Java bean if a <xa>_type</xa>
* attribute is present.
- * <li> <js>"[...]"</js> - Converted to a {@link ObjectList}.
- * <li> <js>"123..."</js> - Converted to a {@link Number} (either {@link Integer}, {@link Long}, {@link Float},
+ * <li>
+ * <js>"[...]"</js> - Converted to a {@link ObjectList}.
+ * <li>
+ * <js>"123..."</js> - Converted to a {@link Number} (either {@link Integer}, {@link Long}, {@link Float},
* or {@link Double}).
- * <li> <js>"true"</js>/<js>"false"</js> - Converted to a {@link Boolean}.
- * <li> <js>"null"</js> - Returns <jk>null</jk>.
- * <li> <js>"'xxx'"</js> - Converted to a {@link String}.
- * <li> <js>"\"xxx\""</js> - Converted to a {@link String}.
- * <li> <js>"'xxx' + \"yyy\""</js> - Converted to a concatenated {@link String}.
+ * <li>
+ * <js>"true"</js>/<js>"false"</js> - Converted to a {@link Boolean}.
+ * <li>
+ * <js>"null"</js> - Returns <jk>null</jk>.
+ * <li>
+ * <js>"'xxx'"</js> - Converted to a {@link String}.
+ * <li>
+ * <js>"\"xxx\""</js> - Converted to a {@link String}.
+ * <li>
+ * <js>"'xxx' + \"yyy\""</js> - Converted to a concatenated {@link String}.
* </ul>
* <p>
* TIP: If you know you're parsing a JSON object or array, it can be easier to parse it using the
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/JsonParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonParserContext.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonParserContext.java
index 949b64e..a498f9e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/JsonParserContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonParserContext.java
@@ -25,12 +25,15 @@ import org.apache.juneau.parser.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <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='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> -
- * Configurable properties common to all parsers.
- * </ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * - Properties associated with handling beans on serializers and parsers.
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
+ * - Configurable properties common to all parsers.
+ * </ul>
+ * </li>
* </ul>
*/
public final class JsonParserContext extends ParserContext {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java
index 031017d..e97e64f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java
@@ -36,15 +36,23 @@ import org.apache.juneau.transform.*;
* <p>
* The conversion is as follows...
* <ul class='spaced-list'>
- * <li>Maps (e.g. {@link HashMap HashMaps}, {@link TreeMap TreeMaps}) are converted to JSON objects.
- * <li>Collections (e.g. {@link HashSet HashSets}, {@link LinkedList LinkedLists}) and Java arrays are converted to
+ * <li>
+ * Maps (e.g. {@link HashMap HashMaps}, {@link TreeMap TreeMaps}) are converted to JSON objects.
+ * <li>
+ * Collections (e.g. {@link HashSet HashSets}, {@link LinkedList LinkedLists}) and Java arrays are converted to
* JSON arrays.
- * <li>{@link String Strings} are converted to JSON strings.
- * <li>{@link Number Numbers} (e.g. {@link Integer}, {@link Long}, {@link Double}) are converted to JSON numbers.
- * <li>{@link Boolean Booleans} are converted to JSON booleans.
- * <li>{@code nulls} are converted to JSON nulls.
- * <li>{@code arrays} are converted to JSON arrays.
- * <li>{@code beans} are converted to JSON objects.
+ * <li>
+ * {@link String Strings} are converted to JSON strings.
+ * <li>
+ * {@link Number Numbers} (e.g. {@link Integer}, {@link Long}, {@link Double}) are converted to JSON numbers.
+ * <li>
+ * {@link Boolean Booleans} are converted to JSON booleans.
+ * <li>
+ * {@code nulls} are converted to JSON nulls.
+ * <li>
+ * {@code arrays} are converted to JSON arrays.
+ * <li>
+ * {@code beans} are converted to JSON objects.
* </ul>
* <p>
* The types above are considered "JSON-primitive" object types. Any non-JSON-primitive object types are transformed
@@ -69,8 +77,10 @@ import org.apache.juneau.transform.*;
* <p>
* The following direct subclasses are provided for convenience:
* <ul class='spaced-list'>
- * <li>{@link Simple} - Default serializer, single quotes, simple mode.
- * <li>{@link SimpleReadable} - Default serializer, single quotes, simple mode, with whitespace.
+ * <li>
+ * {@link Simple} - Default serializer, single quotes, simple mode.
+ * <li>
+ * {@link SimpleReadable} - Default serializer, single quotes, simple mode, with whitespace.
* </ul>
*
* <h5 class='section'>Example:</h5>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
index a7539fe1..a75e895 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
@@ -63,7 +63,7 @@ public class JsonSerializerBuilder extends SerializerBuilder {
* <p>
* If <jk>true</jk>, JSON attribute names will only be quoted when necessary.
* Otherwise, they are always quoted.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>JSON_simpleMode</jsf>, value)</code>.
@@ -100,7 +100,7 @@ public class JsonSerializerBuilder extends SerializerBuilder {
* The JSON specification allows for either format.
* However, if you're embedding JSON in an HTML script tag, this setting prevents confusion when trying to
* serialize <xt><\/script></xt>.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>JSON_escapeSolidus</jsf>, value)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerContext.java
index 354fab0..f15f6ce 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerContext.java
@@ -25,13 +25,15 @@ import org.apache.juneau.serializer.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
* - Properties associated with handling beans on serializers and parsers.
- * <ul>
- * <li class='jc'><a class="doclink"
- * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
* - Configurable properties common to all serializers.
- * </ul>
+ * </ul>
+ * </li>
* </ul>
*/
public final class JsonSerializerContext extends SerializerContext {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java
index 620ccf1..466017a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java
@@ -20,7 +20,7 @@ import org.apache.juneau.serializer.*;
/**
* Specialized writer for serializing JSON.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This class is not intended for external use.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java b/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java
index 3a361ce..451d236 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java
+++ b/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java
@@ -24,7 +24,8 @@ import java.lang.annotation.*;
* <p>
* Can be used for the following:
* <ul class='spaced-list'>
- * <li>Wrap bean instances inside wrapper object (e.g. <code>{'wrapperAttr':bean}</code>).
+ * <li>
+ * Wrap bean instances inside wrapper object (e.g. <code>{'wrapperAttr':bean}</code>).
* </ul>
*/
@Documented
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/json/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/json/package.html b/juneau-core/src/main/java/org/apache/juneau/json/package.html
index b06dc5b..59f6db2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/json/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/json/package.html
@@ -84,31 +84,36 @@
<div class='topic'>
<p>
Juneau supports converting arbitrary POJOs to and from JSON using ultra-efficient serializers and parsers.
- <br>
- The JSON serializer converts POJOs directly to JSON without the need for intermediate DOM objects using a
+ <br>The JSON serializer converts POJOs directly to JSON without the need for intermediate DOM objects using a
highly-efficient state machine.
- <br>
- Likewise, the JSON parser creates POJOs directly from JSON without the need for intermediate DOM objects.
+ <br>Likewise, the JSON parser creates POJOs directly from JSON without the need for intermediate DOM objects.
</p>
<p>
Juneau can serialize and parse instances of any of the following POJO types:
</p>
<ul class='spaced-list'>
- <li>Java primitives and primitive objects (e.g. <code>String</code>, <code>Integer</code>, <code>Boolean</code>,
+ <li>
+ Java primitives and primitive objects (e.g. <code>String</code>, <code>Integer</code>, <code>Boolean</code>,
<code>Float</code>).
- <li>Java Collections Framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything on
+ <li>
+ Java Collections Framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything on
this list.
- <li>Multi-dimensional arrays of any type on this list.
- <li>Java Beans with properties of any type on this list.
- <li>Classes with standard transformations to and from <code>Strings</code> (e.g. classes containing
+ <li>
+ Multi-dimensional arrays of any type on this list.
+ <li>
+ Java Beans with properties of any type on this list.
+ <li>
+ Classes with standard transformations to and from <code>Strings</code> (e.g. classes containing
<code>toString()</code>, <code>fromString()</code>, <code>valueOf()</code>, <code>constructor(String)</code>).
- <li>Non-serializable classes and properties with associated <code>PojoSwaps</code> that convert them to
+ <li>
+ Non-serializable classes and properties with associated <code>PojoSwaps</code> that convert them to
serializable forms.
</ul>
<p>
Refer to <a href='../../../../overview-summary.html#Core.PojoCategories' class='doclink'>POJO Categories</a>
for a complete definition of supported POJOs.
</p>
+
<h6 class='topic'>Prerequisites</h6>
<p>
The Juneau JSON serialization and parsing support does not require any external prerequisites.
@@ -122,8 +127,7 @@
<p>
The example shown here is from the Address Book resource located in the
<code>org.apache.juneau.sample.war</code> application.
- <br>
- The POJO model consists of a <code>List</code> of <code>Person</code> beans, with each <code>Person</code>
+ <br>The POJO model consists of a <code>List</code> of <code>Person</code> beans, with each <code>Person</code>
containing zero or more <code>Address</code> beans.
</p>
<p>
@@ -153,10 +157,14 @@
The JSON data type produced depends on the Java object type being serialized.
</p>
<ul class='spaced-list'>
- <li>Primitives and primitive objects are converted to JSON primitives.
- <li>Beans and Maps are converted to JSON objects.
- <li>Collections and arrays are converted to JSON arrays.
- <li>Anything else is converted to JSON strings.
+ <li>
+ Primitives and primitive objects are converted to JSON primitives.
+ <li>
+ Beans and Maps are converted to JSON objects.
+ <li>
+ Collections and arrays are converted to JSON arrays.
+ <li>
+ Anything else is converted to JSON strings.
</ul>
<h6 class='topic'>Examples:</h6>
@@ -206,13 +214,15 @@
In addition, swaps can be used to convert non-serializable POJOs into serializable forms, such as converting
<code>Calendar</code> object to ISO8601 strings, or <code><jk>byte</jk>[]</code> arrays to Base-64
encoded strings.
- <br>
- These swaps can be associated at various levels:
+ <br>These swaps can be associated at various levels:
</p>
<ul class='spaced-list'>
- <li>On serializer and parser instances to handle all objects of the class type globally.
- <li>On classes through the <code><ja>@Bean</ja></code> annotation.
- <li>On bean properties through the <code><ja>@BeanProperty</ja></code> annotations.
+ <li>
+ On serializer and parser instances to handle all objects of the class type globally.
+ <li>
+ On classes through the <code><ja>@Bean</ja></code> annotation.
+ <li>
+ On bean properties through the <code><ja>@BeanProperty</ja></code> annotations.
</ul>
<p>
For more information about transforms, refer to <a class='doclink'
@@ -227,27 +237,27 @@
<div class='topic'>
<p>
{@link org.apache.juneau.json.JsonSerializer} is the class used to convert POJOs to JSON.
- <br>
- {@link org.apache.juneau.json.JsonSchemaSerializer} is the class used to generate JSON-Schema from POJOs.
+ <br>{@link org.apache.juneau.json.JsonSchemaSerializer} is the class used to generate JSON-Schema from POJOs.
</p>
<p>
The JSON serializer includes several configurable settings.
- <br>
- Static reusable instances of Json serializers are provided with commonly-used settings:
+ <br>Static reusable instances of Json serializers are provided with commonly-used settings:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.json.JsonSerializer#DEFAULT} - All default settings
- <li>{@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX} - Single quotes, only quote attributes when
+ <li>
+ {@link org.apache.juneau.json.JsonSerializer#DEFAULT} - All default settings
+ <li>
+ {@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX} - Single quotes, only quote attributes when
necessary.
- <li>{@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX_READABLE} - Readable output.
+ <li>
+ {@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX_READABLE} - Readable output.
</ul>
+
<h6 class='topic'>Notes about examples</h6>
<p>
The examples shown in this document will use single-quote, readable settings.
- <br>
- For brevity, the examples will use public fields instead of getters/setters to reduce the size of the examples.
- <br>
- In the real world, you'll typically want to use standard bean getters and setters.
+ <br>For brevity, the examples will use public fields instead of getters/setters to reduce the size of the examples.
+ <br>In the real world, you'll typically want to use standard bean getters and setters.
</p>
<p>
To start off simple, we'll begin with the following simplified bean and build upon it.
@@ -307,26 +317,26 @@
The {@link org.apache.juneau.annotation.Bean @Bean} and
{@link org.apache.juneau.annotation.BeanProperty @BeanProperty} annotations are used to customize the
behavior of beans across the entire framework.
- <br>
- They have various uses:
+ <br>They have various uses:
</p>
<ul class='spaced-list'>
- <li>Hiding bean properties.
- <li>Specifying the ordering of bean properties.
- <li>Overriding the names of bean properties.
- <li>Associating swaps at both the class and property level (to convert non-serializable POJOs to
+ <li>
+ Hiding bean properties.
+ <li>
+ Specifying the ordering of bean properties.
+ <li>
+ Overriding the names of bean properties.
+ <li>
+ Associating swaps at both the class and property level (to convert non-serializable POJOs to
serializable forms).
</ul>
<p>
For example, we now add a <code>birthDate</code> property, and associate a swap with it to transform it to
an ISO8601 date-time string in GMT time.
- <br>
- We'll also add a couple of <code>URI</code> properties.
- <br>
- By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you want
- them serialized.
- <br>
- Using swaps, we can convert them to standardized string forms.
+ <br>We'll also add a couple of <code>URI</code> properties.
+ <br>By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you
+ want them serialized.
+ <br>Using swaps, we can convert them to standardized string forms.
</p>
<p class='bcode'>
<jk>public class</jk> Person {
@@ -376,16 +386,17 @@
<p>
Another useful feature is the {@link org.apache.juneau.annotation.Bean#propertyNamer()} annotation that
allows you to plug in your own logic for determining bean property names.
- <br>
- The {@link org.apache.juneau.PropertyNamerDLC} is an example of an alternate property namer.
+ <br>The {@link org.apache.juneau.PropertyNamerDLC} is an example of an alternate property namer.
It converts bean property names to lowercase-dashed format.
</p>
+
<h6 class='topic'>Example:</h6>
<p class='bcode'>
<ja>@Bean</ja>(propertyNamer=PropertyNamerDLC.<jk>class</jk>)
<jk>public class</jk> Person {
...
</p>
+
<h6 class='figure'>Results</h6>
<p class='bcode'>
{
@@ -484,10 +495,8 @@
<p>
Juneau provides the {@link org.apache.juneau.json.JsonSchemaSerializer} class for generating JSON-Schema
documents that describe the output generated by the {@link org.apache.juneau.json.JsonSerializer} class.
- <br>
- This class shares the same properties as <code>JsonSerializer</code>.
- <br>
- For convenience the {@link org.apache.juneau.json.JsonSerializer#getSchemaSerializer()} method has been
+ <br>This class shares the same properties as <code>JsonSerializer</code>.
+ <br>For convenience the {@link org.apache.juneau.json.JsonSerializer#getSchemaSerializer()} method has been
added for creating instances of schema serializers from the regular serializer instance.
</p>
<p>
@@ -555,6 +564,7 @@
<jc>// Get the JSON Schema corresponding to the JSON generated above.</jc>
String jsonSchema = s.serialize(p);
</p>
+
<h6 class='figure'>Results</h6>
<p class='bcode'>
{
@@ -635,18 +645,15 @@
<div class='topic'>
<p>
The JSON serializer is designed to be used against POJO tree structures.
- <br>
- It expects that there not be loops in the POJO model (e.g. children with references to parents, etc...).
- <br>
- If you try to serialize models with loops, you will usually cause a <code>StackOverflowError</code> to
+ <br>It expects that there not be loops in the POJO model (e.g. children with references to parents, etc...).
+ <br>If you try to serialize models with loops, you will usually cause a <code>StackOverflowError</code> to
be thrown (if {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_maxDepth} is not reached
first).
</p>
<p>
If you still want to use the JSON serializer on such models, Juneau provides the
{@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_detectRecursions} setting.
- <br>
- It tells the serializer to look for instances of an object in the current branch of the tree and skip
+ <br>It tells the serializer to look for instances of an object in the current branch of the tree and skip
serialization when a duplicate is encountered.
</p>
<p>
@@ -697,8 +704,7 @@
</p>
<p>
Recursion detection introduces a performance penalty of around 20%.
- <br>
- For this reason the setting is disabled by default.
+ <br>For this reason the setting is disabled by default.
</p>
</div>
@@ -711,8 +717,10 @@
See the following classes for all configurable properties that can be used on this serializer:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.BeanContext} - Bean context properties.
- <li>{@link org.apache.juneau.json.JsonSerializerContext} - Serializer context properties.
+ <li>
+ {@link org.apache.juneau.BeanContext} - Bean context properties.
+ <li>
+ {@link org.apache.juneau.json.JsonSerializerContext} - Serializer context properties.
</ul>
</div>
@@ -722,10 +730,10 @@
<h3 class='topic' onclick='toggle(this)'>2.6 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau serializers, the JSON serializer is thread safe and maintains an internal cache
+ <li>
+ Like all other Juneau serializers, the JSON serializer is thread safe and maintains an internal cache
of bean classes encountered.
- <br>
- For performance reasons, it's recommended that serializers be reused whenever possible instead of
+ <br>For performance reasons, it's recommended that serializers be reused whenever possible instead of
always creating new instances.
</ul>
</div>
@@ -743,11 +751,16 @@
The JSON parser supports ALL valid JSON, including:
</p>
<ul class='spaced-list'>
- <li>Javascript comments.
- <li>Single or double quoted values.
- <li>Quoted (strict) or unquoted (non-strict) attributes.
- <li>JSON fragments (such as string, numeric, or boolean primitive values).
- <li>Concatenated strings.
+ <li>
+ Javascript comments.
+ <li>
+ Single or double quoted values.
+ <li>
+ Quoted (strict) or unquoted (non-strict) attributes.
+ <li>
+ JSON fragments (such as string, numeric, or boolean primitive values).
+ <li>
+ Concatenated strings.
</ul>
<p>
A static reusable instance of <code>JsonParser</code> is also provided for convenience:
@@ -757,8 +770,7 @@
</ul>
<p>
Let's build upon the previous example and parse the generated JSON back into the original bean.
- <br>
- We start with the JSON that was generated.
+ <br>We start with the JSON that was generated.
</p>
<p class='bcode'>
<jc>// Use serializer with readable output, simple mode.</jc>
@@ -847,8 +859,7 @@
<div class='topic'>
<p>
The JSON parser is not limited to parsing back into the original bean classes.
- <br>
- If the bean classes are not available on the parsing side, the parser can also be used to
+ <br>If the bean classes are not available on the parsing side, the parser can also be used to
parse into a generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive
objects.
</p>
@@ -856,8 +867,7 @@
You can parse into any <code>Map</code> type (e.g. <code>HashMap</code>, <code>TreeMap</code>), but
using {@link org.apache.juneau.ObjectMap} is recommended since it has many convenience methods
for converting values to various types.
- <br>
- The same is true when parsing collections. You can use any Collection (e.g. <code>HashSet</code>,
+ <br>The same is true when parsing collections. You can use any Collection (e.g. <code>HashSet</code>,
<code>LinkedList</code>) or array (e.g. <code>Object[]</code>, <code>String[]</code>,
<code>String[][]</code>), but using {@link org.apache.juneau.ObjectList} is recommended.
</p>
@@ -902,8 +912,7 @@
</p>
<p>
What we end up with is the exact same output.
- <br>
- Even the numbers and booleans are preserved because they are parsed into <code>Number</code> and
+ <br>Even the numbers and booleans are preserved because they are parsed into <code>Number</code> and
<code>Boolean</code> objects when parsing into generic models.
</p>
<p class='bcode'>
@@ -955,8 +964,7 @@
<p>
As a general rule, parsing into beans is often more efficient than parsing into generic models.
- <br>
- And working with beans is often less error prone than working with generic models.
+ <br>And working with beans is often less error prone than working with generic models.
</p>
</div>
@@ -969,8 +977,10 @@
See the following classes for all configurable properties that can be used on this parser:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.BeanContext} - Bean context properties.
- <li>{@link org.apache.juneau.json.JsonParserContext} - Serializer context properties.
+ <li>
+ {@link org.apache.juneau.BeanContext} - Bean context properties.
+ <li>
+ {@link org.apache.juneau.json.JsonParserContext} - Serializer context properties.
</ul>
</div>
@@ -980,10 +990,10 @@
<h3 class='topic' onclick='toggle(this)'>3.3 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau parsers, the JSON parser is thread safe and maintains an internal cache of bean
+ <li>
+ Like all other Juneau parsers, the JSON parser is thread safe and maintains an internal cache of bean
classes encountered.
- <br>
- For performance reasons, it's recommended that parser be reused whenever possible instead of always
+ <br>For performance reasons, it's recommended that parser be reused whenever possible instead of always
creating new instances.
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java
index 13e52ad..2411636 100644
--- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java
+++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java
@@ -19,7 +19,7 @@ import java.io.*;
/**
* Specialized input stream for parsing MessagePack streams.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This class is not intended for external use.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java
index 778a9f7..1760da6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java
+++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java
@@ -20,7 +20,7 @@ import java.util.concurrent.atomic.*;
/**
* Specialized output stream for serializing MessagePack streams.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This class is not intended for external use.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserContext.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserContext.java
index aa83954..e221779 100644
--- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParserContext.java
@@ -25,12 +25,15 @@ import org.apache.juneau.parser.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
* - Properties associated with handling beans on serializers and parsers.
- * <ul>
- * <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
* - Configurable properties common to all parsers.
- * </ul>
+ * </ul>
+ * </li>
* </ul>
*/
public final class MsgPackParserContext extends ParserContext {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerContext.java
index 93348da..f0c6bb0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerContext.java
@@ -25,13 +25,15 @@ import org.apache.juneau.serializer.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
* - Properties associated with handling beans on serializers and parsers.
- * <ul>
- * <li class='jc'><a class="doclink"
- * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
- * - Configurable properties common to all serializers.
- * </ul>
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
+ * </ul>
+ * </li>
* </ul>
*/
public final class MsgPackSerializerContext extends SerializerContext {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/parser/Parser.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/Parser.java b/juneau-core/src/main/java/org/apache/juneau/parser/Parser.java
index f646040..22a4a5b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/parser/Parser.java
+++ b/juneau-core/src/main/java/org/apache/juneau/parser/Parser.java
@@ -110,13 +110,14 @@ import org.apache.juneau.utils.*;
* <tr><th>JSON type</th><th>Class type</th></tr>
* <tr><td>object</td><td>{@link ObjectMap}</td></tr>
* <tr><td>array</td><td>{@link ObjectList}</td></tr>
- * <tr><td>number</td><td>{@link Number} <br>(depending on length and format, could be {@link Integer},
+ * <tr><td>number</td><td>{@link Number}<br>(depending on length and format, could be {@link Integer},
* {@link Double}, {@link Float}, etc...)</td></tr>
* <tr><td>boolean</td><td>{@link Boolean}</td></tr>
* <tr><td>string</td><td>{@link String}</td></tr>
* </table>
*
- * <a id='SupportedTypes'></a><h6 class='topic'>Supported types</h6>
+ * <a id='SupportedTypes'></a>
+ * <h6 class='topic'>Supported types</h6>
* <p>
* Several of the methods below take {@link Type} parameters to identify the type of object to create.
* Any of the following types can be passed in to these methods...
@@ -255,7 +256,7 @@ public abstract class Parser extends CoreObject {
* <code>Map</code> classes are assumed to be followed by zero or two meta objects indicating the key and value types.
* <p>
* The array can be arbitrarily long to indicate arbitrarily complex data structures.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Use the {@link #parse(Object, Class)} method instead if you don't need a parameterized map/collection.
@@ -306,6 +307,7 @@ public abstract class Parser extends CoreObject {
* Same as {@link #parse(Object, Type, Type...)} except optimized for a non-parameterized class.
* <p>
* This is the preferred parse method for simple types since you don't need to cast the results.
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* ReaderParser p = JsonParser.<jsf>DEFAULT</jsf>;
@@ -405,7 +407,8 @@ public abstract class Parser extends CoreObject {
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
- * <li>The various character-based constructors in {@link ObjectMap} (e.g.
+ * <li>
+ * The various character-based constructors in {@link ObjectMap} (e.g.
* {@link ObjectMap#ObjectMap(CharSequence,Parser)}).
* </ul>
*
@@ -454,7 +457,8 @@ public abstract class Parser extends CoreObject {
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
- * <li>The various character-based constructors in {@link ObjectList} (e.g.
+ * <li>
+ * The various character-based constructors in {@link ObjectList} (e.g.
* {@link ObjectList#ObjectList(CharSequence,Parser)}.
* </ul>
*
@@ -506,7 +510,8 @@ public abstract class Parser extends CoreObject {
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
- * <li>Used to parse argument strings in the {@link PojoIntrospector#invokeMethod(Method, Reader)} method.
+ * <li>
+ * Used to parse argument strings in the {@link PojoIntrospector#invokeMethod(Method, Reader)} method.
* </ul>
*
* @param input The input. Subclasses can support different input types.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/parser/ParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/ParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/parser/ParserBuilder.java
index 9a8ee52..0f61126 100644
--- a/juneau-core/src/main/java/org/apache/juneau/parser/ParserBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/parser/ParserBuilder.java
@@ -63,7 +63,7 @@ public class ParserBuilder extends CoreObjectBuilder {
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>PARSER_trimStrings</jsf>, value)</code>.
@@ -115,7 +115,7 @@ public class ParserBuilder extends CoreObjectBuilder {
* </td>
* </tr>
* </table>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>PARSER_strict</jsf>,value)</code>.
@@ -151,7 +151,7 @@ public class ParserBuilder extends CoreObjectBuilder {
* The character set to use for converting <code>InputStreams</code> and byte arrays to readers.
* <p>
* Used when passing in input streams and byte arrays to {@link Parser#parse(Object, Class)}.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>PARSER_inputStreamCharset</jsf>, value)</code>.
@@ -180,7 +180,7 @@ public class ParserBuilder extends CoreObjectBuilder {
* Used when passing in files to {@link Parser#parse(Object, Class)}.
* <p>
* <js>"default"</js> can be used to indicate the JVM default file system charset.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>PARSER_fileCharset</jsf>,value)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroup.java b/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroup.java
index 65dcb94..f429b6f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/parser/ParserGroup.java
@@ -25,10 +25,14 @@ import org.apache.juneau.http.*;
* <p>
* Provides the following features:
* <ul class='spaced-list'>
- * <li>Finds parsers based on HTTP <code>Content-Type</code> header values.
- * <li>Sets common properties on all parsers in a single method call.
- * <li>Locks all parsers in a single method call.
- * <li>Clones existing groups and all parsers within the group in a single method call.
+ * <li>
+ * Finds parsers based on HTTP <code>Content-Type</code> header values.
+ * <li>
+ * Sets common properties on all parsers in a single method call.
+ * <li>
+ * Locks all parsers in a single method call.
+ * <li>
+ * Clones existing groups and all parsers within the group in a single method call.
* </ul>
*
* <h6 class='topic'>Match ordering</h6>
[08/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/TempDirResource.java
----------------------------------------------------------------------
diff --git a/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/TempDirResource.java b/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/TempDirResource.java
index 672fd69..9116112 100644
--- a/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/TempDirResource.java
+++ b/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/TempDirResource.java
@@ -73,7 +73,7 @@ public class TempDirResource extends DirectoryResource {
FileItemIterator iter = upload.getItemIterator(req);
while (iter.hasNext()) {
FileItemStream item = iter.next();
- if (item.getFieldName().equals("contents")) { //$NON-NLS-1$
+ if (item.getFieldName().equals("contents")) {
File f = new File(getRootDir(), item.getName());
IOPipe.create(item.openStream(), new FileOutputStream(f)).closeOut().run();
}
@@ -86,7 +86,7 @@ public class TempDirResource extends DirectoryResource {
@Override /* RestMatcher */
public boolean matches(RestRequest req) {
String contentType = req.getContentType();
- return contentType != null && contentType.startsWith("multipart/form-data"); //$NON-NLS-1$
+ return contentType != null && contentType.startsWith("multipart/form-data");
}
}
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java
index b65aa34..4aabb8f 100755
--- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java
+++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java
@@ -44,9 +44,12 @@ import org.apache.juneau.utils.*;
* This class defines the following method for accessing configuration for your microservice:
* <p>
* <ul class='spaced-list'>
- * <li>{@link #getArgs()} - The command-line arguments passed to the jar file.
- * <li>{@link #getConfig()} - An external INI-style configuration file.
- * <li>{@link #getManifest()} - The manifest file for the main jar file.
+ * <li>
+ * {@link #getArgs()} - The command-line arguments passed to the jar file.
+ * <li>
+ * {@link #getConfig()} - An external INI-style configuration file.
+ * <li>
+ * {@link #getManifest()} - The manifest file for the main jar file.
* </ul>
*
* <h6 class='topic'>Entry point Method</h6>
@@ -65,9 +68,12 @@ import org.apache.juneau.utils.*;
* Subclasses must implement the following lifecycle methods:
* <p>
* <ul class='spaced-list'>
- * <li>{@link #start()} - Gets executed during startup.
- * <li>{@link #stop()} - Gets executed when 'exit' is typed in the console or an external shutdown signal is received.
- * <li>{@link #kill()} - Can be used to forcibly shut down the service. Doesn't get called during normal operation.
+ * <li>
+ * {@link #start()} - Gets executed during startup.
+ * <li>
+ * {@link #stop()} - Gets executed when 'exit' is typed in the console or an external shutdown signal is received.
+ * <li>
+ * {@link #kill()} - Can be used to forcibly shut down the service. Doesn't get called during normal operation.
* </ul>
*
* <h6 class='topic'>Lifecycle Listener Methods</h6>
@@ -75,10 +81,14 @@ import org.apache.juneau.utils.*;
* Subclasses can optionally implement the following event listener methods:
* <p>
* <ul class='spaced-list'>
- * <li>{@link #onStart()} - Gets executed before {@link #start()}.
- * <li>{@link #onStop()} - Gets executed before {@link #stop()}.
- * <li>{@link #onConfigSave(ConfigFile)} - Gets executed after a config file has been saved.
- * <li>{@link #onConfigChange(ConfigFile, Set)} - Gets executed after a config file has been modified.
+ * <li>
+ * {@link #onStart()} - Gets executed before {@link #start()}.
+ * <li>
+ * {@link #onStop()} - Gets executed before {@link #stop()}.
+ * <li>
+ * {@link #onConfigSave(ConfigFile)} - Gets executed after a config file has been saved.
+ * <li>
+ * {@link #onConfigChange(ConfigFile, Set)} - Gets executed after a config file has been modified.
* </ul>
*
* <h6 class='topic'>Other Methods</h6>
@@ -86,7 +96,8 @@ import org.apache.juneau.utils.*;
* Subclasses can optionally override the following methods to provide customized behavior:
* <p>
* <ul class='spaced-list'>
- * <li>{@link #createVarResolver()} - Creates the {@link VarResolver} used to resolve variables in the config file
+ * <li>
+ * {@link #createVarResolver()} - Creates the {@link VarResolver} used to resolve variables in the config file
* returned by {@link #getConfig()}.
* </ul>
*/
@@ -285,9 +296,12 @@ public abstract class Microservice {
* <p>
* The config file location is determined in the following order:
* <ol class='spaced-list'>
- * <li>The first argument passed to the microservice jar.
- * <li>The <code>Main-ConfigFile</code> entry in the microservice jar manifest file.
- * <li>The name of the microservice jar with a <js>".cfg"</js> suffix (e.g.
+ * <li>
+ * The first argument passed to the microservice jar.
+ * <li>
+ * The <code>Main-ConfigFile</code> entry in the microservice jar manifest file.
+ * <li>
+ * The name of the microservice jar with a <js>".cfg"</js> suffix (e.g.
* <js>"mymicroservice.jar"</js>-><js>"mymicroservice.cfg"</js>).
* </ol>
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-microservice/src/main/java/org/apache/juneau/microservice/Resource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/Resource.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/Resource.java
index 38b5c69..2c6283c 100755
--- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/Resource.java
+++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/Resource.java
@@ -22,15 +22,17 @@ import org.apache.juneau.svl.vars.*;
* In additional to the functionality of the {@link RestServletDefault} group,
* augments the {@link RestContext#getVarResolver()} method with the following additional variable types:
* <ul class='spaced-list'>
- * <li><code class='snippet'>$ARG{...}</code> - Command line arguments pulled from {@link Microservice#getArgs()}.
- * <br>
- * <h6 class='figure'>Example:</h6>
+ * <li>
+ * <code class='snippet'>$ARG{...}</code> - Command line arguments pulled from {@link Microservice#getArgs()}.
+ *
+ * <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* String firstArg = request.getVarResolver().resolve(<js>"$ARG{0}"</js>); <jc>// First argument.</jc>
* String namedArg = request.getVarResolver().resolve(<js>"$ARG{myarg}"</js>); <jc>// Named argument (e.g. "myarg=foo"). </jc>
* </p>
- * <li><code class='snippet'>$MF{...}</code> - Manifest file entries pulled from {@link Microservice#getManifest()}.
- * <br>
+ * <li>
+ * <code class='snippet'>$MF{...}</code> - Manifest file entries pulled from {@link Microservice#getManifest()}.
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* String mainClass = request.getVarResolver().resolve(<js>"$MF{Main-Class}"</js>); <jc>// Main class. </jc>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-microservice/src/main/java/org/apache/juneau/microservice/ResourceGroup.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/ResourceGroup.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/ResourceGroup.java
index 8728c00..793ab6e 100755
--- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/ResourceGroup.java
+++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/ResourceGroup.java
@@ -22,16 +22,18 @@ import org.apache.juneau.svl.vars.*;
* In additional to the functionality of the {@link RestServletGroupDefault} group,
* augments the {@link RestContext#getVarResolver()} method with the following additional variable types:
* <ul class='spaced-list'>
- * <li><jk>$ARG{...}</jk> - Command line arguments.
- * <br>
- * Resolves values from {@link Microservice#getArgs()}.
- * <br>
+ * <li>
+ * <jk>$ARG{...}</jk> - Command line arguments.
+ * <br>Resolves values from {@link Microservice#getArgs()}.
+ *
* <h6>Example:</h6>
* <p class='bcode'>
* String firstArg = request.getVarResolver().resolve(<js>"$ARG{0}"</js>); <jc>// First argument.</jc>
* String namedArg = request.getVarResolver().resolve(<js>"$ARG{myarg}"</js>); <jc>// Named argument (e.g. "myarg=foo"). </jc>
* </p>
- * <li><jk>$MF{...}</jk> - Manifest file entries.
+ * <li>
+ * <jk>$MF{...}</jk> - Manifest file entries.
+ *
* <h6>Example:</h6>
* <p class='bcode'>
* String mainClass = request.getVarResolver().resolve(<js>"$MF{Main-Class}"</js>); <jc>// Main class. </jc>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java
index 6765849..6fbdd72 100755
--- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java
+++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java
@@ -46,13 +46,11 @@ import org.eclipse.jetty.util.ssl.*;
* <p>
* The Jetty server is created by the {@link #createServer()} method and started with the {@link #startServer()} method.
* These methods can be overridden to provided customized behavior.
- * <p>
*
* <h6 class='topic'>Defining REST Resources</h6>
* <p>
* Top-level REST resources are defined by the {@link #getResourceMap()} method.
* This method can be overridden to provide a customized list of REST resources.
- * <p>
*
* <h6 class='topic'>Logging</h6>
* <p>
@@ -62,13 +60,20 @@ import org.eclipse.jetty.util.ssl.*;
* <h6 class='topic'>Lifecycle Listener Methods</h6>
* Subclasses can optionally implement the following event listener methods:
* <ul class='spaced-list'>
- * <li>{@link #onStart()} - Gets executed before {@link #start()}.
- * <li>{@link #onStop()} - Gets executed before {@link #stop()}.
- * <li>{@link #onCreateServer()} - Gets executed before {@link #createServer()}.
- * <li>{@link #onStartServer()} - Gets executed before {@link #startServer()}.
- * <li>{@link #onPostStartServer()} - Gets executed after {@link #startServer()}.
- * <li>{@link #onStopServer()} - Gets executed before {@link #stop()}.
- * <li>{@link #onPostStopServer()} - Gets executed after {@link #stop()}.
+ * <li>
+ * {@link #onStart()} - Gets executed before {@link #start()}.
+ * <li>
+ * {@link #onStop()} - Gets executed before {@link #stop()}.
+ * <li>
+ * {@link #onCreateServer()} - Gets executed before {@link #createServer()}.
+ * <li>
+ * {@link #onStartServer()} - Gets executed before {@link #startServer()}.
+ * <li>
+ * {@link #onPostStartServer()} - Gets executed after {@link #startServer()}.
+ * <li>
+ * {@link #onStopServer()} - Gets executed before {@link #stop()}.
+ * <li>
+ * {@link #onPostStopServer()} - Gets executed after {@link #stop()}.
* </ul>
*/
public class RestMicroservice extends Microservice {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-microservice/src/main/java/org/apache/juneau/microservice/package.html
----------------------------------------------------------------------
diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/package.html b/juneau-microservice/src/main/java/org/apache/juneau/microservice/package.html
index 02b427a..7b00fca 100755
--- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/package.html
+++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/package.html
@@ -96,14 +96,20 @@
Features include:
</p>
<ul class='spaced-list'>
- <li>An out-of-the-box zipped Eclipse project to get started quickly.
- <li>Packaged as a simple executable jar and configuration file.
- <li>All the power of the Juneau Cloud Tools for defining REST servlets and clients with the ability to
+ <li>
+ An out-of-the-box zipped Eclipse project to get started quickly.
+ <li>
+ Packaged as a simple executable jar and configuration file.
+ <li>
+ All the power of the Juneau Cloud Tools for defining REST servlets and clients with the ability to
serialize and parse POJOs as HTML, JSON, XML, RDF, URL-Encoding, and others.
- <li>An extensible API that allows you to hook into various lifecycle events.
- <li>Simple-to-use APIs for accessing manifest file entries, command-line arguments, and external configuration
+ <li>
+ An extensible API that allows you to hook into various lifecycle events.
+ <li>
+ Simple-to-use APIs for accessing manifest file entries, command-line arguments, and external configuration
file properties.
- <li>Predefined REST resources for configuring microservice and accessing log files.
+ <li>
+ Predefined REST resources for configuring microservice and accessing log files.
</ul>
</div>
@@ -124,15 +130,19 @@
Follow these instructions to create a new template project in Eclipse.
</p>
<ol class='spaced-list'>
- <li>Download the latest microservice-project zip file (e.g. <l>microservice-project-5.2.zip</l>).
- <li>In your Eclipse workspace, go to <b>File->Import->General->Existing Projects into Workspace</b>
+ <li>
+ Download the latest microservice-project zip file (e.g. <l>microservice-project-5.2.zip</l>).
+ <li>
+ In your Eclipse workspace, go to <b>File->Import->General->Existing Projects into Workspace</b>
and click <b>Next</b>.
<br><br>
<img class='bordered' src="doc-files/instructions1.png">
- <li>Select the zip file and click <b>Finish</b>.
+ <li>
+ Select the zip file and click <b>Finish</b>.
<br><br>
<img class='bordered' src="doc-files/instructions2.png">
- <li>In your workspace, you should now see the following project:
+ <li>
+ In your workspace, you should now see the following project:
<br><br>
<img class='bordered' src="doc-files/instructions3.png">
</ol>
@@ -140,8 +150,9 @@
The important elements in this project are:
</p>
<ul class='spaced-list'>
- <li><l>META-INF/MANIFEST.MF</l> - The manifest file. <br>
- This defines the entry point, classpath, top-level REST resources, and location of external
+ <li>
+ <l>META-INF/MANIFEST.MF</l> - The manifest file.
+ <br>This defines the entry point, classpath, top-level REST resources, and location of external
configuration file.
<br><br>
<p class='bcode'>
@@ -161,12 +172,12 @@
lib/juneau-all-5.2.jar
lib/org.apache.commons.fileupload_1.3.1.jar
</p>
- <li><l>RestMicroservice.java</l> - The application class.
- <br>
- This is a specialized microservice in Juneau for exposing REST servlets.
- <li><l>RootResources.java</l> - The top-level REST resource.
- <br>
- This class routes HTTP requests to child resources:
+ <li>
+ <l>RestMicroservice.java</l> - The application class.
+ <br>This is a specialized microservice in Juneau for exposing REST servlets.
+ <li>
+ <l>RootResources.java</l> - The top-level REST resource.
+ <br>This class routes HTTP requests to child resources:
<br><br>
<p class='bcode'>
<jd>/**
@@ -189,10 +200,11 @@
<jc>// No actual code!</jc>
}
</p>
- <li><l>microservice.cfg</l> - The external configuration file. <br>
- A deceivingly simple yet powerful INI-style configuration file:
+ <li>
+ <l>microservice.cfg</l> - The external configuration file.
+ <br>A deceivingly simple yet powerful INI-style configuration file:
<br><br>
- <p class='bcode'>
+ <p class='bcode'>
<cc>#================================================================================
# Basic configuration file for SaaS microservices
# Subprojects can use this as a starting point.
@@ -322,15 +334,15 @@
Other manifest file entries are also provided:
</p>
<ul class='spaced-list'>
- <li><mk>Rest-Port</mk> - The HTTP port to use. Default is <l>10000</l>.
- <li><mk>Rest-ContextPath</mk> - The servlet context path. Default is <l>"/"</l>.
- <li><mk>Rest-AuthType</mk> - Authentication support.
- <br>
- Possible values are <l>"NONE"</l> and <l>"BASIC"</l>.
- <br>
- Default is <l>"NONE"</l>.
- <br>
- Used with the following additional settings:
+ <li>
+ <mk>Rest-Port</mk> - The HTTP port to use. Default is <l>10000</l>.
+ <li>
+ <mk>Rest-ContextPath</mk> - The servlet context path. Default is <l>"/"</l>.
+ <li>
+ <mk>Rest-AuthType</mk> - Authentication support.
+ <br>Possible values are <l>"NONE"</l> and <l>"BASIC"</l>.
+ <br>Default is <l>"NONE"</l>.
+ <br>Used with the following additional settings:
<ul>
<li><mk>Rest-LoginUser</mk>
<li><mk>Rest-LoginPassword</mk>
@@ -541,12 +553,17 @@
capabilities, including:
</p>
<ul class='spaced-list'>
- <li>The ability to use variables to reference environment variables, system properties, other config file
+ <li>
+ The ability to use variables to reference environment variables, system properties, other config file
entries, and a host of other types.
- <li>The ability to store and retrieve POJOs as JSON.
- <li>APIs for updating, modifying, and saving configuration files without losing comments or formatting.
- <li>Extensive listener APIs.
+ <li>
+ The ability to store and retrieve POJOs as JSON.
+ <li>
+ APIs for updating, modifying, and saving configuration files without losing comments or formatting.
+ <li>
+ Extensive listener APIs.
</ul>
+
<h6 class='topic'>Examples:</h6>
<p class='bcode'>
<cc>#--------------------------</cc>
@@ -614,9 +631,11 @@
String myArg = cf.getString(<js>"MySection/myArg"</js>);
String firstArg = cf.getString(<js>"MySection/firstArg"</js>);
</p>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a href='../core/ini/package-summary.html#TOC'><l>org.apache.juneau.ini</l></a>
+ <li class='jp'>
+ <a href='../core/ini/package-summary.html#TOC'><l>org.apache.juneau.ini</l></a>
- Juneau Configuration API Javadocs.
</ul>
@@ -628,10 +647,10 @@
There are 3 primary ways of getting access to the config file.
</p>
<ul class='doctree'>
- <li class='jm'>{@link org.apache.juneau.microservice.Microservice#getConfig()}
+ <li class='jm'>
+ {@link org.apache.juneau.microservice.Microservice#getConfig()}
- A static method that can be used to access the config file from anywhere in your application.
- <br>
- When using this method, any of the following variables can be resolved:
+ <br>When using this method, any of the following variables can be resolved:
<ul>
<li><l>$S{key}, $S{key,default}</l> - System properties.
<li><l>$E{key}, $E{key,default}</l> - Environment variables.
@@ -642,13 +661,14 @@
Additional user-defined variables can be defined by overriding the
{@link org.apache.juneau.microservice.Microservice#createVarResolver()} method
and using the {@link org.apache.juneau.rest.RestConfig#addVars(Class...)} method.
- <li class='jm'>{@link org.apache.juneau.rest.RestContext#getConfigFile()}
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestContext#getConfigFile()}
- An instance method to access it from inside a REST servlet.
- <br>
- The following variables are available in addition to the variables defined above:
+ <br>The following variables are available in addition to the variables defined above:
<ul>
<li><l>$I{key}, $I{key,default}</l> - Servlet initialization parameters.
</ul>
+
<h6 class='figure'>Example usage:</h6>
<p class='bcode'>
<cc>#-------------------------------</cc>
@@ -675,10 +695,10 @@
{@link org.apache.juneau.microservice.Resource#init(RestConfig)} method
and using the {@link org.apache.juneau.rest.RestConfig#addVars(Class...)} method.
</p>
- <li class='jm'>{@link org.apache.juneau.rest.RestRequest#getConfigFile()}
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestRequest#getConfigFile()}
- An instance method to access it from inside a REST method.
- <br>
- The following variables are available in addition to the variables defined above:
+ <br>The following variables are available in addition to the variables defined above:
<ul>
<li><l>$L{key}, $L{key,args}</l> - Localized variables pulled from
{@link org.apache.juneau.rest.RestRequest#getMessage(String, Object...)}.
@@ -705,6 +725,7 @@
<li><l>$SA{key,mediaType}</l> - Object returned by {@link org.apache.juneau.rest.RestRequest#getAttribute(String)} converted to a string using the serializer registered to handle the specified media type.
<li><l>$UE{...}</l> - URL-Encode the specified value.
</ul>
+
<h6 class='figure'>Example usage:</h6>
<p class='bcode'>
<cc>#-----------------------------</cc>
@@ -753,16 +774,24 @@
Here's what happens when an HTTP call is made to <l>GET /hello/localized/Bob</l>:
</p>
<ol class='spaced-list'>
- <li>The HTTP call matches the <l>/hello</l> path on the <l>MyHelloResource</l> class.
- <li>The HTTP call matches the <l>/localized/{person}</l> path on the <l>sayLocalizedHello()</l> method.
- <li>The request attribute <l>person</l> gets assigned the value <l>"Bob"</l>.
- <li>The call to <l>req.getConfig().getString("MyHelloResource/localizedGreeting")</l>
+ <li>
+ The HTTP call matches the <l>/hello</l> path on the <l>MyHelloResource</l> class.
+ <li>
+ The HTTP call matches the <l>/localized/{person}</l> path on the <l>sayLocalizedHello()</l> method.
+ <li>
+ The request attribute <l>person</l> gets assigned the value <l>"Bob"</l>.
+ <li>
+ The call to <l>req.getConfig().getString("MyHelloResource/localizedGreeting")</l>
finds the value <l>"$L{HelloMessage,$R{path.person}}"</l>.
- <li>The arguments in the <l>$L{}</l> variable get resolved, resulting in <l>"$L{HelloMessage,Bob}"</l>.
- <li>The <l>$L{}</l> variable gets resolved to the message <l>"Hello {0}!"</l> in the localized properties
+ <li>
+ The arguments in the <l>$L{}</l> variable get resolved, resulting in <l>"$L{HelloMessage,Bob}"</l>.
+ <li>
+ The <l>$L{}</l> variable gets resolved to the message <l>"Hello {0}!"</l> in the localized properties
file of the servlet based on the <l>Accept-Language</l> header on the request.
- <li>The arguments get replaced in the message resulting in <l>"Hello Bob!"</l>.
- <li>The resulting message <l>"Hello Bob!"</l> is returned as a POJO to be serialized to whatever content
+ <li>
+ The arguments get replaced in the message resulting in <l>"Hello Bob!"</l>.
+ <li>
+ The resulting message <l>"Hello Bob!"</l> is returned as a POJO to be serialized to whatever content
type was specified on the <l>Accept</l> header on the request.
</ol>
<p>
@@ -805,17 +834,17 @@
}
</p>
<ul class='spaced-list'>
- <li>The </l>label</l> and <l>description</l> annotations define the titles on the page.
- <br>
- These can be globalized using <l>$L{...}</l> variables, or by defining specially-named properties in the
+ <li>
+ The </l>label</l> and <l>description</l> annotations define the titles on the page.
+ <br>These can be globalized using <l>$L{...}</l> variables, or by defining specially-named properties in the
properties file for the resource.
- <li>In this case, the <l>path</l> annotation defines the context root of your application since it was
+ <li>
+ In this case, the <l>path</l> annotation defines the context root of your application since it was
not specified in the manifest or config file.
- <br>
- Therefore, this resource is mapped to <l>http://localhost:10000</l>.
- <li>The <l>children</l> annotation make up the list of child resources.
- <br>
- These child resources can be anything that extends from <l>Servlet</l>, although usually
+ <br>Therefore, this resource is mapped to <l>http://localhost:10000</l>.
+ <li>
+ The <l>children</l> annotation make up the list of child resources.
+ <br>These child resources can be anything that extends from <l>Servlet</l>, although usually
they will be subclasses of {@link org.apache.juneau.microservice.Resource} or other resource groups.
</ul>
<p>
@@ -848,9 +877,11 @@
classes are powerful servlets designed specifically for creating REST APIs using nothing more than serialized
and parsed POJOs.
</p>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a href='../server/package-summary.html#TOC'><l>org.apache.juneau.rest</l></a>
+ <li class='jp'>
+ <a href='../server/package-summary.html#TOC'><l>org.apache.juneau.rest</l></a>
- Juneau Server API Javadocs.
</ul>
</div>
@@ -868,14 +899,17 @@
The class hierarchy is:
</p>
<ul class='doctree'>
- <li class='jac'>{@link org.apache.juneau.microservice.Microservice}
+ <li class='jac'>
+ {@link org.apache.juneau.microservice.Microservice}
- Abstract class that defines simple start/stop methods and access to the manifest file, config file, and
arguments.
<ul>
- <li class='jc'>{@link org.apache.juneau.microservice.RestMicroservice}
+ <li class='jc'>
+ {@link org.apache.juneau.microservice.RestMicroservice}
- Specialized microservice for starting up REST interfaces using Jetty and specifying REST servlets
through the manifest file or config file.
</ul>
+ </li>
</ul>
<p>
Refer to the Javadocs for these class for more information.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
index 060a7e6..99ea01c 100755
--- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
+++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
@@ -39,16 +39,21 @@ import org.apache.juneau.utils.*;
* The root directory is specified in one of two ways:
* </p>
* <ul class='spaced-list'>
- * <li>Specifying the location via a <l>DirectoryResource.rootDir</l> property.
- * <li>Overriding the {@link #getRootDir()} method.
+ * <li>
+ * Specifying the location via a <l>DirectoryResource.rootDir</l> property.
+ * <li>
+ * Overriding the {@link #getRootDir()} method.
* </ul>
* <p>
* Read/write access control is handled through the following properties:
* </p>
* <ul class='spaced-list'>
- * <li><l>DirectoryResource.allowViews</l> - If <jk>true</jk>, allows view and download access to files.
- * <li><l>DirectoryResource.allowPuts</l> - If <jk>true</jk>, allows files to be created or overwritten.
- * <li><l>DirectoryResource.allowDeletes</l> - If <jk>true</jk>, allows files to be deleted.
+ * <li>
+ * <l>DirectoryResource.allowViews</l> - If <jk>true</jk>, allows view and download access to files.
+ * <li>
+ * <l>DirectoryResource.allowPuts</l> - If <jk>true</jk>, allows files to be created or overwritten.
+ * <li>
+ * <l>DirectoryResource.allowDeletes</l> - If <jk>true</jk>, allows files to be deleted.
* </ul>
* <p>
* Access can also be controlled by overriding the {@link #checkAccess(RestRequest)} method.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java
index 8731183..ad547fb 100644
--- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java
+++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java
@@ -27,9 +27,13 @@ import java.util.regex.*;
* <p>
* Uses three simple parameter for configuring log entry formats:
* <ul class='spaced-list'>
- * <li><code>dateFormat</code> - A {@link SimpleDateFormat} string describing the format for dates.
- * <li><code>format</code> - A string with <code>{...}</code> replacement variables representing predefined fields.
- * <li><code>useStackTraceHashes</code> - A setting that causes duplicate stack traces to be replaced with 8-character hash strings.
+ * <li>
+ * <code>dateFormat</code> - A {@link SimpleDateFormat} string describing the format for dates.
+ * <li>
+ * <code>format</code> - A string with <code>{...}</code> replacement variables representing predefined fields.
+ * <li>
+ * <code>useStackTraceHashes</code> - A setting that causes duplicate stack traces to be replaced with 8-character
+ * hash strings.
* </ul>
* <p>
* This class converts the format strings into a regular expression that can be used to parse the resulting log file.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogParser.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogParser.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogParser.java
index e271c1c..3aca085 100644
--- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogParser.java
+++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogParser.java
@@ -122,7 +122,7 @@ public class LogParser implements Iterable<LogParser.Entry>, Iterator<LogParser.
public void writeTo(Writer w) throws IOException {
try {
if (! hasNext())
- w.append("[EMPTY]"); //$NON-NLS-1$
+ w.append("[EMPTY]");
else for (LogParser.Entry le : this)
le.append(w);
} finally {
@@ -187,10 +187,10 @@ public class LogParser implements Iterable<LogParser.Entry>, Iterator<LogParser.
}
public Writer appendHtml(Writer w) throws IOException {
- w.append(toHtml(line)).append("<br>"); //$NON-NLS-1$
+ w.append(toHtml(line)).append("<br>");
if (additionalText != null)
for (String t : additionalText)
- w.append(toHtml(t)).append("<br>"); //$NON-NLS-1$
+ w.append(toHtml(t)).append("<br>");
return w;
}
@@ -221,7 +221,7 @@ public class LogParser implements Iterable<LogParser.Entry>, Iterator<LogParser.
private static String toHtml(String s) {
if (s.indexOf('<') != -1)
- return s.replaceAll("<", "<"); //$NON-NLS-1$//$NON-NLS-2$
+ return s.replaceAll("<", "<");//$NON-NLS-2$
return s;
}
}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
index 3bee423..32976f5 100755
--- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
+++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
@@ -251,7 +251,7 @@ public class LogsResource extends Resource {
if (f.isDirectory())
throw new RestException(SC_METHOD_NOT_ALLOWED, "Download not available on directories");
- res.setContentType("application/octet-stream"); //$NON-NLS-1$
+ res.setContentType("application/octet-stream");
res.setContentLength((int)f.length());
return new FileInputStream(f);
}
@@ -281,7 +281,7 @@ public class LogsResource extends Resource {
if (! f.delete())
throw new RestException(SC_FORBIDDEN, "Could not delete file.");
- return new Redirect(path + "/.."); //$NON-NLS-1$
+ return new Redirect(path + "/..");
}
private static BufferedReader getReader(File f) throws IOException {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-releng/eclipse-preferences/user-dictionary.txt
----------------------------------------------------------------------
diff --git a/juneau-releng/eclipse-preferences/user-dictionary.txt b/juneau-releng/eclipse-preferences/user-dictionary.txt
index b24928d..03e4024 100644
--- a/juneau-releng/eclipse-preferences/user-dictionary.txt
+++ b/juneau-releng/eclipse-preferences/user-dictionary.txt
@@ -419,3 +419,58 @@ doctype
iri
api
juneaubp
+deserialize
+lifecycle
+myentry
+myarg
+auth
+username
+codec
+lib
+io
+httpclient
+httpcore
+httpmime
+globalized
+sorta
+writeable
+tomcat
+myheader
+streamable
+htm
+txt
+png
+stylesheets
+favicon
+subdirectories
+nowrap
+hashsums
+stacktrace
+msg
+qs
+filesystem
+nosniff
+chrome
+admin
+apache
+mystyles
+mydocs
+myresource
+tooltips
+testcases
+interceptors
+seemlessly
+pl
+pw
+rc
+localhost
+retryable
+hostname
+hv
+tm
+ctx
+sf
+ssl
+intercepters
+cert
+gigabytes
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java
index 07801b8..17e945f 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java
@@ -16,10 +16,11 @@ import org.apache.http.impl.client.*;
/**
* Redirect strategy that allows for redirects on any request type, not just <code>GET</code> or <code>HEAD</code>.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This class is similar to <code>org.apache.http.impl.client.LaxRedirectStrategy</code>
+ * <li>
+ * This class is similar to <code>org.apache.http.impl.client.LaxRedirectStrategy</code>
* in Apache HttpClient 4.2, but also allows for redirects on <code>PUTs</code> and <code>DELETEs</code>.
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java
index 25908de..4a9a98b 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java
@@ -22,8 +22,8 @@ import org.apache.juneau.serializer.*;
import org.apache.juneau.urlencoding.*;
/**
- * Convenience class for constructing instances of <code>List<NameValuePair></code>
- * for the {@link UrlEncodedFormEntity} class.
+ * Convenience class for constructing instances of <code>List<NameValuePair></code> for the
+ * {@link UrlEncodedFormEntity} class.
* <p>
* Instances of this method can be passed directly to the {@link RestClient#doPost(Object, Object)} method or
* {@link RestCall#input(Object)} methods to perform URL-encoded form posts.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java
index ce49c5e..a0e1ae0 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java
@@ -21,8 +21,8 @@ import java.util.regex.*;
* Response patterns are applied to REST calls through the {@link RestCall#responsePattern(ResponsePattern)} method.
*
* <h5 class='section'>Example:</h5>
- * This example shows how to use a response pattern finder to find and capture patterns for <js>"x=number"</js> and <js>"y=string"</js>
- * from a response body.
+ * This example shows how to use a response pattern finder to find and capture patterns for <js>"x=number"</js> and
+ * <js>"y=string"</js> from a response body.
* <p>
* <p class='bcode'>
* <jk>final</jk> List<Number> xList = <jk>new</jk> ArrayList<Number>();
@@ -55,26 +55,22 @@ import java.util.regex.*;
* )
* .run();
* </p>
- * <p>
+ *
* <h5 class='notes'>Important Notes:</h5>
* <ol class='notes'>
- * <li><p>
+ * <li>
* Using response patterns does not affect the functionality of any of the other methods
- * used to retrieve the response such as {@link RestCall#getResponseAsString()} or {@link RestCall#getResponse(Class)}.<br>
- * HOWEVER, if you want to retrieve the entire text of the response from inside the match methods,
- * use {@link RestCall#getCapturedResponse()} since this method will not absorb the response for those other methods.
- * </p>
- * <li><p>
+ * used to retrieve the response such as {@link RestCall#getResponseAsString()} or {@link RestCall#getResponse(Class)}.
+ * <br>HOWEVER, if you want to retrieve the entire text of the response from inside the match methods, use
+ * {@link RestCall#getCapturedResponse()} since this method will not absorb the response for those other methods.
+ * <li>
* Response pattern methods are NOT executed if a REST exception occurs during the request.
- * </p>
- * <li><p>
- * The {@link RestCall#successPattern(String)} and {@link RestCall#failurePattern(String)} methods use instances of
- * this class to throw {@link RestCallException RestCallExceptions} when success patterns are not found or failure patterns
- * are found.
- * </p>
- * <li><p>
+ * <li>
+ * The {@link RestCall#successPattern(String)} and {@link RestCall#failurePattern(String)} methods use instances
+ * of this class to throw {@link RestCallException RestCallExceptions} when success patterns are not found or
+ * failure patterns are found.
+ * <li>
* {@link ResponsePattern} objects are reusable and thread-safe.
- * </p>
* </ol>
*/
public abstract class ResponsePattern {
@@ -115,8 +111,8 @@ public abstract class ResponsePattern {
}
/**
- * Instances can override this method to handle when a regular expression pattern matches
- * on the output.
+ * Instances can override this method to handle when a regular expression pattern matches on the output.
+ *
* <p>
* This method is called once for every pattern match that occurs in the response text.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
----------------------------------------------------------------------
diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
index 7f70117..231218e 100644
--- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
+++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
@@ -45,22 +45,28 @@ import org.apache.juneau.utils.*;
/**
* Represents a connection to a remote REST resource.
+ *
* <p>
* Instances of this class are created by the various {@code doX()} methods on the {@link RestClient} class.
- * <p>
- * This class uses only Java standard APIs. Requests can be built up using a fluent interface with method chaining, like so...
*
+ * <p>
+ * This class uses only Java standard APIs. Requests can be built up using a fluent interface with method chaining,
+ * like so...
* <p class='bcode'>
* RestClient client = <jk>new</jk> RestClient();
* RestCall c = client.doPost(<jsf>URL</jsf>).setInput(o).setHeader(x,y);
* MyBean b = c.getResponse(MyBean.<jk>class</jk>);
* </p>
+ *
* <p>
- * The actual connection and request/response transaction occurs when calling one of the <code>getResponseXXX()</code> methods.
+ * The actual connection and request/response transaction occurs when calling one of the <code>getResponseXXX()</code>
+ * methods.
*
* <h5 class='section'>Additional information:</h5>
* <ul>
- * <li><a class="doclink" href="package-summary.html#RestClient">org.apache.juneau.rest.client > REST client API</a> for more information and code examples.
+ * <li>
+ * <a class="doclink" href="package-summary.html#RestClient">org.apache.juneau.rest.client > REST client
+ * API</a> for more information and code examples.
* </ul>
*/
@SuppressWarnings({ "hiding", "unchecked" })
@@ -69,7 +75,7 @@ public final class RestCall {
private final RestClient client; // The client that created this call.
private final HttpRequestBase request; // The request.
private HttpResponse response; // The response.
- private List<RestCallInterceptor> interceptors = new ArrayList<RestCallInterceptor>(); // Used for intercepting and altering requests.
+ private List<RestCallInterceptor> intercepters = new ArrayList<RestCallInterceptor>(); // Used for intercepting and altering requests.
private boolean isConnected = false; // connect() has been called.
private boolean allowRedirectsOnPosts;
@@ -103,8 +109,8 @@ public final class RestCall {
protected RestCall(RestClient client, HttpRequestBase request, URI uri) throws RestCallException {
this.client = client;
this.request = request;
- for (RestCallInterceptor i : this.client.interceptors)
- interceptor(i);
+ for (RestCallInterceptor i : this.client.intercepters)
+ intercepter(i);
this.retryOn = client.retryOn;
this.retries = client.retries;
this.retryInterval = client.retryInterval;
@@ -115,6 +121,7 @@ public final class RestCall {
/**
* Sets the URI for this call.
+ *
* <p>
* Can be any of the following types:
* <ul>
@@ -123,10 +130,13 @@ public final class RestCall {
* <li>{@link URIBuilder}
* <li>Anything else converted to a string using {@link Object#toString()}.
* </ul>
+ *
+ * <p>
* Relative URL strings will be interpreted as relative to the root URL defined on the client.
*
- * @param uri The URI to use for this call.
- * This overrides the URI passed in from the client.
+ * @param uri
+ * The URI to use for this call.
+ * This overrides the URI passed in from the client.
* @return This object (for method chaining).
* @throws RestCallException
*/
@@ -176,13 +186,16 @@ public final class RestCall {
/**
* Adds a query parameter to the URI query.
*
- * @param name The parameter name.
+ * @param name
+ * The parameter name.
* Can be null/blank/* if the value is a {@link Map}, {@link String}, {@link NameValuePairs}, or bean.
- * @param value The parameter value converted to a string using UON notation.
+ * @param value
+ * The parameter value converted to a string using UON notation.
* Can also be {@link Map}, {@link String}, {@link NameValuePairs}, or bean if the name is null/blank/*.
* If a {@link String} and the name is null/blank/*, then calls {@link URIBuilder#setCustomQuery(String)}.
* @param skipIfEmpty Don't add the pair if the value is empty.
- * @param partSerializer The part serializer to use to convert the value to a string.
+ * @param partSerializer
+ * The part serializer to use to convert the value to a string.
* If <jk>null</jk>, then the URL-encoding serializer defined on the client is used.
* @return This object (for method chaining).
* @throws RestCallException
@@ -242,6 +255,7 @@ public final class RestCall {
/**
* Adds a query parameter to the URI query if the parameter value is not <jk>null</jk> or an empty string.
+ *
* <p>
* NE = "not empty"
*
@@ -256,6 +270,7 @@ public final class RestCall {
/**
* Adds query parameters to the URI for any parameters that aren't null/empty.
+ *
* <p>
* NE = "not empty"
*
@@ -281,12 +296,15 @@ public final class RestCall {
/**
* Adds a form data pair to this request to perform a URL-encoded form post.
*
- * @param name The parameter name.
+ * @param name
+ * The parameter name.
* Can be null/blank/* if the value is a {@link Map}, {@link NameValuePairs}, or bean.
- * @param value The parameter value converted to a string using UON notation.
+ * @param value
+ * The parameter value converted to a string using UON notation.
* Can also be {@link Map}, {@link NameValuePairs}, or bean if the name is null/blank/*.
* @param skipIfEmpty Don't add the pair if the value is empty.
- * @param partSerializer The part serializer to use to convert the value to a string.
+ * @param partSerializer
+ * The part serializer to use to convert the value to a string.
* If <jk>null</jk>, then the URL-encoding serializer defined on the client is used.
* @return This object (for method chaining).
* @throws RestCallException
@@ -325,10 +343,12 @@ public final class RestCall {
/**
* Adds a form data pair to this request to perform a URL-encoded form post.
*
- * @param name The parameter name.
- * Can be null/blank if the value is a {@link Map} or {@link NameValuePairs}.
- * @param value The parameter value converted to a string using UON notation.
- * Can also be a {@link Map} or {@link NameValuePairs}.
+ * @param name
+ * The parameter name.
+ * Can be null/blank if the value is a {@link Map} or {@link NameValuePairs}.
+ * @param value
+ * The parameter value converted to a string using UON notation.
+ * Can also be a {@link Map} or {@link NameValuePairs}.
* @return This object (for method chaining).
* @throws RestCallException If name was null/blank and value wasn't a {@link Map} or {@link NameValuePairs}.
*/
@@ -360,6 +380,7 @@ public final class RestCall {
/**
* Adds a form data pair to the request if the parameter value is not <jk>null</jk> or an empty string.
+ *
* <p>
* NE = "not empty"
*
@@ -374,6 +395,7 @@ public final class RestCall {
/**
* Adds form data parameters to the request for any parameters that aren't null/empty.
+ *
* <p>
* NE = "not empty"
*
@@ -390,7 +412,8 @@ public final class RestCall {
*
* @param name The path variable name.
* @param value The replacement value.
- * @param partSerializer The part serializer to use to convert the value to a string.
+ * @param partSerializer
+ * The part serializer to use to convert the value to a string.
* If <jk>null</jk>, then the URL-encoding serializer defined on the client is used.
* @return This object (for method chaining).
* @throws RestCallException If variable could not be found in path.
@@ -457,15 +480,22 @@ public final class RestCall {
/**
* Sets the input for this REST call.
*
- * @param input The input to be sent to the REST resource (only valid for PUT and POST) requests. <br>
- * Can be of the following types:
- * <ul class='spaced-list'>
- * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.
- * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.
- * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.
- * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
- * <li>{@link NameValuePairs} - Converted to a URL-encoded FORM post.
- * </ul>
+ * @param input
+ * The input to be sent to the REST resource (only valid for PUT and POST) requests. <br>
+ * Can be of the following types:
+ * <ul class='spaced-list'>
+ * <li>
+ * {@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.
+ * <li>
+ * {@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.
+ * <li>
+ * {@link Object} - POJO to be converted to text using the {@link Serializer} registered with the
+ * {@link RestClient}.
+ * <li>
+ * {@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
+ * <li>
+ * {@link NameValuePairs} - Converted to a URL-encoded FORM post.
+ * </ul>
* @return This object (for method chaining).
* @throws RestCallException If a retry was attempted, but the entity was not repeatable.
*/
@@ -478,6 +508,7 @@ public final class RestCall {
/**
* Specifies the serializer to use on this call.
+ *
* <p>
* Overrides the serializer specified on the {@link RestClient}.
*
@@ -491,6 +522,7 @@ public final class RestCall {
/**
* Specifies the parser to use on this call.
+ *
* <p>
* Overrides the parser specified on the {@link RestClient}.
*
@@ -510,11 +542,13 @@ public final class RestCall {
/**
* Sets a header on the request.
*
- * @param name The header name.
- * The name can be null/empty if the value is a {@link Map}.
+ * @param name
+ * The header name.
+ * The name can be null/empty if the value is a {@link Map}.
* @param value The header value.
* @param skipIfEmpty Don't add the header if the name is null/empty.
- * @param partSerializer The part serializer to use to convert the value to a string.
+ * @param partSerializer
+ * The part serializer to use to convert the value to a string.
* If <jk>null</jk>, then the URL-encoding serializer defined on the client is used.
* @return This object (for method chaining).
* @throws RestCallException
@@ -543,8 +577,9 @@ public final class RestCall {
/**
* Sets a header on the request.
*
- * @param name The header name.
- * The name can be null/empty if the value is a {@link Map}.
+ * @param name
+ * The header name.
+ * The name can be null/empty if the value is a {@link Map}.
* @param value The header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -566,11 +601,13 @@ public final class RestCall {
/**
* Sets a header on the request if the value is not null/empty.
+ *
* <p>
* NE = "not empty"
*
- * @param name The header name.
- * The name can be null/empty if the value is a {@link Map}.
+ * @param name
+ * The header name.
+ * The name can be null/empty if the value is a {@link Map}.
* @param value The header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -581,6 +618,7 @@ public final class RestCall {
/**
* Sets headers on the request if the values are not null/empty.
+ *
* <p>
* NE = "not empty"
*
@@ -594,8 +632,10 @@ public final class RestCall {
/**
* Sets the value for the <code>Accept</code> request header.
+ *
* <p>
- * This overrides the media type specified on the parser, but is overridden by calling <code>header(<js>"Accept"</js>, value);</code>
+ * This overrides the media type specified on the parser, but is overridden by calling
+ * <code>header(<js>"Accept"</js>, value);</code>
*
* @param value The new header value.
* @return This object (for method chaining).
@@ -607,6 +647,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Accept-Charset</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Accept-Charset"</js>, value);</code>
*
@@ -620,6 +661,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Accept-Encoding</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Accept-Encoding"</js>, value);</code>
*
@@ -633,6 +675,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Accept-Language</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Accept-Language"</js>, value);</code>
*
@@ -646,6 +689,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Authorization</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Authorization"</js>, value);</code>
*
@@ -659,6 +703,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Cache-Control</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Cache-Control"</js>, value);</code>
*
@@ -672,6 +717,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Connection</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Connection"</js>, value);</code>
*
@@ -685,6 +731,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Content-Length</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Content-Length"</js>, value);</code>
*
@@ -698,8 +745,10 @@ public final class RestCall {
/**
* Sets the value for the <code>Content-Type</code> request header.
+ *
* <p>
- * This overrides the media type specified on the serializer, but is overridden by calling <code>header(<js>"Content-Type"</js>, value);</code>
+ * This overrides the media type specified on the serializer, but is overridden by calling
+ * <code>header(<js>"Content-Type"</js>, value);</code>
*
* @param value The new header value.
* @return This object (for method chaining).
@@ -711,6 +760,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Date</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Date"</js>, value);</code>
*
@@ -724,6 +774,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Expect</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Expect"</js>, value);</code>
*
@@ -737,6 +788,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Forwarded</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Forwarded"</js>, value);</code>
*
@@ -750,6 +802,7 @@ public final class RestCall {
/**
* Sets the value for the <code>From</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"From"</js>, value);</code>
*
@@ -763,6 +816,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Host</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Host"</js>, value);</code>
*
@@ -776,6 +830,7 @@ public final class RestCall {
/**
* Sets the value for the <code>If-Match</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-Match"</js>, value);</code>
*
@@ -789,6 +844,7 @@ public final class RestCall {
/**
* Sets the value for the <code>If-Modified-Since</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-Modified-Since"</js>, value);</code>
*
@@ -802,6 +858,7 @@ public final class RestCall {
/**
* Sets the value for the <code>If-None-Match</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-None-Match"</js>, value);</code>
*
@@ -815,6 +872,7 @@ public final class RestCall {
/**
* Sets the value for the <code>If-Range</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-Range"</js>, value);</code>
*
@@ -828,6 +886,7 @@ public final class RestCall {
/**
* Sets the value for the <code>If-Unmodified-Since</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-Unmodified-Since"</js>, value);</code>
*
@@ -841,6 +900,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Max-Forwards</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Max-Forwards"</js>, value);</code>
*
@@ -854,6 +914,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Origin</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Origin"</js>, value);</code>
*
@@ -867,6 +928,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Pragma</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Pragma"</js>, value);</code>
*
@@ -880,6 +942,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Proxy-Authorization</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Proxy-Authorization"</js>, value);</code>
*
@@ -893,6 +956,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Range</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Range"</js>, value);</code>
*
@@ -906,6 +970,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Referer</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Referer"</js>, value);</code>
*
@@ -919,6 +984,7 @@ public final class RestCall {
/**
* Sets the value for the <code>TE</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"TE"</js>, value);</code>
*
@@ -932,6 +998,7 @@ public final class RestCall {
/**
* Sets the value for the <code>User-Agent</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"User-Agent"</js>, value);</code>
*
@@ -945,6 +1012,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Upgrade</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Upgrade"</js>, value);</code>
*
@@ -958,6 +1026,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Via</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Via"</js>, value);</code>
*
@@ -971,6 +1040,7 @@ public final class RestCall {
/**
* Sets the value for the <code>Warning</code> request header.
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Warning"</js>, value);</code>
*
@@ -998,8 +1068,9 @@ public final class RestCall {
*
* @param retries The number of retries to attempt.
* @param interval The time in milliseconds between attempts.
- * @param retryOn Optional object used for determining whether a retry should be attempted.
- * If <jk>null</jk>, uses {@link RetryOn#DEFAULT}.
+ * @param retryOn
+ * Optional object used for determining whether a retry should be attempted.
+ * If <jk>null</jk>, uses {@link RetryOn#DEFAULT}.
* @return This object (for method chaining).
* @throws RestCallException If current entity is not repeatable.
*/
@@ -1019,14 +1090,13 @@ public final class RestCall {
}
/**
- * For this call, allow automatic redirects when a 302 or 307 occurs when
- * performing a POST.
+ * For this call, allow automatic redirects when a 302 or 307 occurs when performing a POST.
+ *
* <p>
- * Note that this can be inefficient since the POST body needs to be serialized
- * twice.
- * The preferred approach if possible is to use the {@link LaxRedirectStrategy} strategy
- * on the underlying HTTP client. However, this method is provided if you don't
- * have access to the underlying client.
+ * Note that this can be inefficient since the POST body needs to be serialized twice.
+ * The preferred approach if possible is to use the {@link LaxRedirectStrategy} strategy on the underlying HTTP
+ * client.
+ * However, this method is provided if you don't have access to the underlying client.
*
* @param b Redirect flag.
* @return This object (for method chaining).
@@ -1048,21 +1118,23 @@ public final class RestCall {
}
/**
- * Add an interceptor for this call only.
+ * Add an intercepter for this call only.
*
- * @param interceptor The interceptor to add to this call.
+ * @param intercepter The intercepter to add to this call.
* @return This object (for method chaining).
*/
- public RestCall interceptor(RestCallInterceptor interceptor) {
- interceptors.add(interceptor);
- interceptor.onInit(this);
+ public RestCall intercepter(RestCallInterceptor intercepter) {
+ intercepters.add(intercepter);
+ intercepter.onInit(this);
return this;
}
/**
* Pipes the request output to the specified writer when {@link #run()} is called.
+ *
* <p>
* The writer is not closed.
+ *
* <p>
* This method can be called multiple times to pipe to multiple writers.
*
@@ -1075,6 +1147,7 @@ public final class RestCall {
/**
* Pipe output from response to the specified writer when {@link #run()} is called.
+ *
* <p>
* This method can be called multiple times to pipe to multiple writers.
*
@@ -1087,8 +1160,9 @@ public final class RestCall {
}
/**
- * Pipe output from response to the specified writer when {@link #run()} is called and associate
- * that writer with an ID so it can be retrieved through {@link #getWriter(String)}.
+ * Pipe output from response to the specified writer when {@link #run()} is called and associate that writer with an
+ * ID so it can be retrieved through {@link #getWriter(String)}.
+ *
* <p>
* This method can be called multiple times to pipe to multiple writers.
*
@@ -1124,8 +1198,10 @@ public final class RestCall {
/**
* Pipes the request output to the specified output stream when {@link #run()} is called.
+ *
* <p>
* The output stream is not closed.
+ *
* <p>
* This method can be called multiple times to pipe to multiple output streams.
*
@@ -1138,6 +1214,7 @@ public final class RestCall {
/**
* Pipe output from response to the specified output stream when {@link #run()} is called.
+ *
* <p>
* This method can be called multiple times to pipe to multiple output stream.
*
@@ -1152,6 +1229,7 @@ public final class RestCall {
/**
* Pipe output from response to the specified output stream when {@link #run()} is called and associate
* that output stream with an ID so it can be retrieved through {@link #getOutputStream(String)}.
+ *
* <p>
* This method can be called multiple times to pipe to multiple output stream.
*
@@ -1177,6 +1255,7 @@ public final class RestCall {
/**
* Prevent {@link RestCallException RestCallExceptions} from being thrown when HTTP status 400+ is encountered.
+ *
* @return This object (for method chaining).
*/
public RestCall ignoreErrors() {
@@ -1186,6 +1265,7 @@ public final class RestCall {
/**
* Stores the response text so that it can later be captured using {@link #getCapturedResponse()}.
+ *
* <p>
* This method should only be called once. Multiple calls to this method are ignored.
*
@@ -1202,11 +1282,13 @@ public final class RestCall {
/**
* Look for the specified regular expression pattern in the response output.
+ *
* <p>
* Causes a {@link RestCallException} to be thrown if the specified pattern is found in the output.
+ *
* <p>
* This method uses {@link #getCapturedResponse()} to read the response text and so does not affect the other output
- * methods such as {@link #getResponseAsString()}.
+ * methods such as {@link #getResponseAsString()}.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -1233,11 +1315,13 @@ public final class RestCall {
/**
* Look for the specified regular expression pattern in the response output.
+ *
* <p>
* Causes a {@link RestCallException} to be thrown if the specified pattern is not found in the output.
+ *
* <p>
* This method uses {@link #getCapturedResponse()} to read the response text and so does not affect the other output
- * methods such as {@link #getResponseAsString()}.
+ * methods such as {@link #getResponseAsString()}.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -1264,18 +1348,20 @@ public final class RestCall {
/**
* Adds a response pattern finder to look for regular expression matches in the response output.
+ *
* <p>
* This method can be called multiple times to add multiple response pattern finders.
+ *
* <p>
- * {@link ResponsePattern ResponsePatterns} use the {@link #getCapturedResponse()} to read the response text and so does not affect the other output
- * methods such as {@link #getResponseAsString()}.
+ * {@link ResponsePattern ResponsePatterns} use the {@link #getCapturedResponse()} to read the response text and so
+ * does not affect the other output methods such as {@link #getResponseAsString()}.
*
* @param responsePattern The response pattern finder.
* @return This object (for method chaining).
*/
public RestCall responsePattern(final ResponsePattern responsePattern) {
captureResponse();
- interceptor(
+ intercepter(
new RestCallInterceptor() {
@Override
public void onClose(RestCall restCall) throws RestCallException {
@@ -1288,6 +1374,7 @@ public final class RestCall {
/**
* Set configuration settings on this request.
+ *
* <p>
* Use {@link RequestConfig#custom()} to create configuration parameters for the request.
*
@@ -1311,9 +1398,10 @@ public final class RestCall {
/**
* Method used to execute an HTTP response where you're only interested in the HTTP response code.
+ *
* <p>
- * The response entity is discarded unless one of the pipe methods have been specified to pipe the
- * output to an output stream or writer.
+ * The response entity is discarded unless one of the pipe methods have been specified to pipe the output to an
+ * output stream or writer.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -1355,7 +1443,8 @@ public final class RestCall {
*
* @return The HTTP status code.
* @throws RestCallException If the executor service was not defined.
- * @see RestClientBuilder#executorService(ExecutorService, boolean) for defining the executor service for creating {@link Future Futures}.
+ * @see RestClientBuilder#executorService(ExecutorService, boolean) for defining the executor service for creating
+ * {@link Future Futures}.
*/
public Future<Integer> runFuture() throws RestCallException {
return client.getExecutorService(true).submit(
@@ -1370,12 +1459,14 @@ public final class RestCall {
/**
* Connects to the REST resource.
+ *
* <p>
* If this is a <code>PUT</code> or <code>POST</code>, also sends the input to the remote resource.<br>
+ *
* <p>
* Typically, you would only call this method if you're not interested in retrieving the body of the HTTP response.
* Otherwise, you're better off just calling one of the {@link #getReader()}/{@link #getResponse(Class)}/{@link #pipeTo(Writer)}
- * methods directly which automatically call this method already.
+ * methods directly which automatically call this method already.
*
* @return This object (for method chaining).
* @throws RestCallException If an exception or <code>400+</code> HTTP status code occurred during the connection attempt.
@@ -1430,7 +1521,7 @@ public final class RestCall {
if (! retryOn.onResponse(response))
retries = 0;
if (retries > 0) {
- for (RestCallInterceptor rci : interceptors)
+ for (RestCallInterceptor rci : intercepters)
rci.onRetry(this, sc, request, response, ex);
request.reset();
long w = retryInterval;
@@ -1441,13 +1532,13 @@ public final class RestCall {
throw ex;
}
}
- for (RestCallInterceptor rci : interceptors)
+ for (RestCallInterceptor rci : intercepters)
rci.onConnect(this, sc, request, response);
if (response == null)
throw new RestCallException("HttpClient returned a null response");
StatusLine sl = response.getStatusLine();
String method = request.getMethod();
- sc = sl.getStatusCode(); // Read it again in case it was changed by one of the interceptors.
+ sc = sl.getStatusCode(); // Read it again in case it was changed by one of the intercepters.
if (sc >= 400 && ! ignoreErrors)
throw new RestCallException(sc, sl.getReasonPhrase(), method, request.getURI(), getResponseAsString())
.setServerException(response.getFirstHeader("Exception-Name"), response.getFirstHeader("Exception-Message"), response.getFirstHeader("Exception-Trace"))
@@ -1491,16 +1582,22 @@ public final class RestCall {
}
/**
- * Connects to the remote resource (if <code>connect()</code> hasn't already been called) and returns the HTTP response message body as a reader.
+ * Connects to the remote resource (if <code>connect()</code> hasn't already been called) and returns the HTTP
+ * response message body as a reader.
+ *
* <p>
- * If an {@link Encoder} has been registered with the {@link RestClient}, then the underlying input stream
- * will be wrapped in the encoded stream (e.g. a <code>GZIPInputStream</code>).
+ * If an {@link Encoder} has been registered with the {@link RestClient}, then the underlying input stream will be
+ * wrapped in the encoded stream (e.g. a <code>GZIPInputStream</code>).
+ *
* <p>
* If present, automatically handles the <code>charset</code> value in the <code>Content-Type</code> response header.
+ *
* <p>
* <b>IMPORTANT:</b> It is your responsibility to close this reader once you have finished with it.
*
- * @return The HTTP response message body reader. <jk>null</jk> if response was successful but didn't contain a body (e.g. HTTP 204).
+ * @return
+ * The HTTP response message body reader.
+ * <jk>null</jk> if response was successful but didn't contain a body (e.g. HTTP 204).
* @throws IOException If an exception occurred while streaming was already occurring.
*/
public Reader getReader() throws IOException {
@@ -1534,12 +1631,14 @@ public final class RestCall {
/**
* Returns the response text as a string if {@link #captureResponse()} was called on this object.
+ *
* <p>
- * Note that while similar to {@link #getResponseAsString()}, this method can be called multiple times
- * to retrieve the response text multiple times.
+ * Note that while similar to {@link #getResponseAsString()}, this method can be called multiple times to retrieve
+ * the response text multiple times.
+ *
* <p>
- * Note that this method returns <jk>null</jk> if you have not called one of the methods that cause
- * the response to be processed. (e.g. {@link #run()}, {@link #getResponse()}, {@link #getResponseAsString()}.
+ * Note that this method returns <jk>null</jk> if you have not called one of the methods that cause the response to
+ * be processed. (e.g. {@link #run()}, {@link #getResponse()}, {@link #getResponseAsString()}.
*
* @return The captured response, or <jk>null</jk> if {@link #captureResponse()} has not been called.
* @throws IllegalStateException If trying to call this method before the response is consumed.
@@ -1594,14 +1693,19 @@ public final class RestCall {
}
/**
- * Connects to the remote resource (if <code>connect()</code> hasn't already been called) and returns the HTTP response message body as an input stream.
+ * Connects to the remote resource (if <code>connect()</code> hasn't already been called) and returns the HTTP
+ * response message body as an input stream.
+ *
* <p>
- * If an {@link Encoder} has been registered with the {@link RestClient}, then the underlying input stream
- * will be wrapped in the encoded stream (e.g. a <code>GZIPInputStream</code>).
+ * If an {@link Encoder} has been registered with the {@link RestClient}, then the underlying input stream will be
+ * wrapped in the encoded stream (e.g. a <code>GZIPInputStream</code>).
+ *
* <p>
* <b>IMPORTANT:</b> It is your responsibility to close this reader once you have finished with it.
*
- * @return The HTTP response message body input stream. <jk>null</jk> if response was successful but didn't contain a body (e.g. HTTP 204).
+ * @return
+ * The HTTP response message body input stream. <jk>null</jk> if response was successful but didn't contain
+ * a body (e.g. HTTP 204).
* @throws IOException If an exception occurred while streaming was already occurring.
* @throws IllegalStateException If an attempt is made to read the response more than once.
*/
@@ -1625,7 +1729,8 @@ public final class RestCall {
}
/**
- * Connects to the remote resource (if {@code connect()} hasn't already been called) and returns the HTTP response message body as plain text.
+ * Connects to the remote resource (if {@code connect()} hasn't already been called) and returns the HTTP response
+ * message body as plain text.
*
* @return The response as a string.
* @throws RestCallException If an exception or non-200 response code occurred during the connection attempt.
@@ -1649,7 +1754,9 @@ public final class RestCall {
*
* @return The response as a string.
* @throws RestCallException If the executor service was not defined.
- * @see RestClientBuilder#executorService(ExecutorService, boolean) for defining the executor service for creating {@link Future Futures}.
+ * @see
+ * RestClientBuilder#executorService(ExecutorService, boolean) for defining the executor service for creating
+ * {@link Future Futures}.
*/
public Future<String> getResponseAsStringFuture() throws RestCallException {
return client.getExecutorService(true).submit(
@@ -1664,8 +1771,10 @@ public final class RestCall {
/**
* Same as {@link #getResponse(Type, Type...)} except optimized for a non-parameterized class.
+ *
* <p>
* This is the preferred parse method for simple types since you don't need to cast the results.
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into a string.</jc>
@@ -1683,10 +1792,11 @@ public final class RestCall {
* <jc>// Parse into a map of object keys/values.</jc>
* Map m = restClient.doGet(url).getResponse(TreeMap.<jk>class</jk>);
* </p>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>You can also specify any of the following types:
+ * <li>
+ * You can also specify any of the following types:
* <ul>
* <li>{@link HttpResponse} - Returns the raw <code>HttpResponse</code> returned by the inner <code>HttpClient</code>.
* <li>{@link Reader} - Returns access to the raw reader of the response.
@@ -1694,11 +1804,13 @@ public final class RestCall {
* </ul>
* </ul>
*
- * @param <T> The class type of the object being created.
- * See {@link #getResponse(Type, Type...)} for details.
+ * @param <T>
+ * The class type of the object being created.
+ * See {@link #getResponse(Type, Type...)} for details.
* @param type The object type to create.
* @return The parsed object.
- * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.
+ * @throws ParseException
+ * If the input contains a syntax error or is malformed, or is not valid for the specified type.
* @throws IOException If a connection error occurred.
*/
public <T> T getResponse(Class<T> type) throws IOException, ParseException {
@@ -1711,12 +1823,15 @@ public final class RestCall {
/**
* Same as {@link #getResponse(Class)} but allows you to run the call asynchronously.
*
- * @param <T> The class type of the object being created.
- * See {@link #getResponse(Type, Type...)} for details.
+ * @param <T>
+ * The class type of the object being created.
+ * See {@link #getResponse(Type, Type...)} for details.
* @param type The object type to create.
* @return The parsed object.
* @throws RestCallException If the executor service was not defined.
- * @see RestClientBuilder#executorService(ExecutorService, boolean) for defining the executor service for creating {@link Future Futures}.
+ * @see
+ * RestClientBuilder#executorService(ExecutorService, boolean) for defining the executor service for creating
+ * {@link Future Futures}.
*/
public <T> Future<T> getResponseFuture(final Class<T> type) throws RestCallException {
return client.getExecutorService(true).submit(
@@ -1731,6 +1846,8 @@ public final class RestCall {
/**
* Parses HTTP body into the specified object type.
+ *
+ * <p>
* The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).
*
* <h5 class='section'>Examples:</h5>
@@ -1750,17 +1867,22 @@ public final class RestCall {
* <jc>// Parse into a map containing string keys and values of lists containing beans.</jc>
* Map m = restClient.doGet(url).getResponse(TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);
* </p>
+ *
* <p>
* <code>Collection</code> classes are assumed to be followed by zero or one objects indicating the element type.
+ *
* <p>
* <code>Map</code> classes are assumed to be followed by zero or two meta objects indicating the key and value types.
+ *
* <p>
* The array can be arbitrarily long to indicate arbitrarily complex data structures.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>Use the {@link #getResponse(Class)} method instead if you don't need a parameterized map/collection.
- * <li>You can also specify any of the following types:
+ * <li>
+ * Use the {@link #getResponse(Class)} method instead if you don't need a parameterized map/collection.
+ * <li>
+ * You can also specify any of the following types:
* <ul>
* <li>{@link HttpResponse} - Returns the raw <code>HttpResponse</code> returned by the inner <code>HttpClient</code>.
* <li>{@link Reader} - Returns access to the raw reader of the response.
@@ -1769,13 +1891,16 @@ public final class RestCall {
* </ul>
*
* @param <T> The class type of the object to create.
- * @param type The object type to create.
+ * @param type
+ * The object type to create.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * @param args The type arguments of the class if it's a collection or map.
+ * @param args
+ * The type arguments of the class if it's a collection or map.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
* <br>Ignored if the main type is not a map or collection.
* @return The parsed object.
- * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.
+ * @throws ParseException
+ * If the input contains a syntax error or is malformed, or is not valid for the specified type.
* @throws IOException If a connection error occurred.
* @see BeanSession#getClassMeta(Class) for argument syntax for maps and collections.
*/
@@ -1789,16 +1914,23 @@ public final class RestCall {
/**
* Same as {@link #getResponse(Class)} but allows you to run the call asynchronously.
*
- * @param <T> The class type of the object being created.
- * See {@link #getResponse(Type, Type...)} for details.
- * @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
- * @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}
+ * @param <T>
+ * The class type of the object being created.
+ * See {@link #getResponse(Type, Type...)} for details.
+ * @param type
+ * The object type to create.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * @param args
+ * The type arguments of the class if it's a collection or map.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
* <br>Ignored if the main type is not a map or collection.
* @return The parsed object.
* @throws RestCallException If the executor service was not defined.
- * @see RestClientBuilder#executorService(ExecutorService, boolean) for defining the executor service for creating {@link Future Futures}.
+ * @see
+ * RestClientBuilder#executorService(ExecutorService, boolean) for defining the executor service for creating
+ * {@link Future Futures}.
*/
public <T> Future<T> getResponseFuture(final Type type, final Type...args) throws RestCallException {
return client.getExecutorService(true).submit(
@@ -1813,13 +1945,15 @@ public final class RestCall {
/**
* Parses the output from the connection into the specified type and then wraps that in a {@link PojoRest}.
+ *
* <p>
* Useful if you want to quickly retrieve a single value from inside of a larger JSON document.
*
* @param innerType The class type of the POJO being wrapped.
- * @return The parsed output wapped in a {@link PojoRest}.
+ * @return The parsed output wrapped in a {@link PojoRest}.
* @throws IOException If a connection error occurred.
- * @throws ParseException If the input contains a syntax error or is malformed for the <code>Content-Type</code> header.
+ * @throws ParseException
+ * If the input contains a syntax error or is malformed for the <code>Content-Type</code> header.
*/
public PojoRest getResponsePojoRest(Class<?> innerType) throws IOException, ParseException {
return new PojoRest(getResponse(innerType));
@@ -1827,12 +1961,14 @@ public final class RestCall {
/**
* Converts the output from the connection into an {@link ObjectMap} and then wraps that in a {@link PojoRest}.
+ *
* <p>
* Useful if you want to quickly retrieve a single value from inside of a larger JSON document.
*
- * @return The parsed output wapped in a {@link PojoRest}.
+ * @return The parsed output wrapped in a {@link PojoRest}.
* @throws IOException If a connection error occurred.
- * @throws ParseException If the input contains a syntax error or is malformed for the <code>Content-Type</code> header.
+ * @throws ParseException
+ * If the input contains a syntax error or is malformed for the <code>Content-Type</code> header.
*/
public PojoRest getResponsePojoRest() throws IOException, ParseException {
return getResponsePojoRest(ObjectMap.class);
@@ -1885,6 +2021,8 @@ public final class RestCall {
/**
* Returns access to the {@link HttpResponse} returned by {@link HttpClient#execute(HttpUriRequest)}.
+ *
+ * <p>
* Returns <jk>null</jk> if {@link #connect()} has not yet been called.
*
* @return The HTTP response object.
@@ -1924,20 +2062,20 @@ public final class RestCall {
EntityUtils.consumeQuietly(response.getEntity());
isClosed = true;
if (! isFailed)
- for (RestCallInterceptor r : interceptors)
+ for (RestCallInterceptor r : intercepters)
r.onClose(this);
return this;
}
/**
- * Adds a {@link RestCallLogger} to the list of interceptors on this class.
+ * Adds a {@link RestCallLogger} to the list of intercepters on this class.
*
* @param level The log level to log events at.
* @param log The logger.
* @return This object (for method chaining).
*/
public RestCall logTo(Level level, Logger log) {
- interceptor(new RestCallLogger(level, log));
+ intercepter(new RestCallLogger(level, log));
return this;
}
[11/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/uon/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/uon/package.html b/juneau-core/src/main/java/org/apache/juneau/uon/package.html
index 3a3c76e..2d75ac9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/uon/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/uon/package.html
@@ -84,11 +84,9 @@
<p>
Juneau supports converting arbitrary POJOs to and from URL-encoded strings using ultra-efficient serializers
and parsers.
- <br>
- The serializer converts POJOs directly to URL-encoded strings without the need for intermediate DOM objects
+ <br>The serializer converts POJOs directly to URL-encoded strings without the need for intermediate DOM objects
using a highly-efficient state machine.
- <br>
- Likewise, the parser creates POJOs directly from URL-encoded strings without the need for intermediate DOM
+ <br>Likewise, the parser creates POJOs directly from URL-encoded strings without the need for intermediate DOM
objects.
</p>
<p>
@@ -99,22 +97,29 @@
Juneau can serialize and parse instances of any of the following POJO types:
</p>
<ul class='spaced-list'>
- <li>Java primitives and primitive objects (e.g. <code>String</code>, <code>Integer</code>, <code>Boolean</code>,
+ <li>
+ Java primitives and primitive objects (e.g. <code>String</code>, <code>Integer</code>, <code>Boolean</code>,
<code>Float</code>).
- <li>Java Collections Framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything
+ <li>
+ Java Collections Framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything
on this list.
- <li>Multi-dimensional arrays of any type on this list.
- <li>Java Beans with properties of any type on this list.
- <li>Classes with standard transformations to and from <code>Strings</code> (e.g. classes containing
+ <li>
+ Multi-dimensional arrays of any type on this list.
+ <li>
+ Java Beans with properties of any type on this list.
+ <li>
+ Classes with standard transformations to and from <code>Strings</code> (e.g. classes containing
<code>toString()</code>, <code>fromString()</code>, <code>valueOf()</code>,
<code>constructor(String)</code>).
- <li>Non-serializable classes and properties with associated <code>PojoSwaps</code> that convert them to
+ <li>
+ Non-serializable classes and properties with associated <code>PojoSwaps</code> that convert them to
serializable forms.
</ul>
<p>
Refer to <a href='../../../../overview-summary.html#Core.PojoCategories' class='doclink'>POJO Categories</a>
for a complete definition of supported POJOs.
</p>
+
<h6 class='topic'>Prerequisites</h6>
<p>
The Juneau URL-encoding serialization and parsing support does not require any external prerequisites.
@@ -128,8 +133,7 @@
<p>
The example shown here is from the Address Book resource located in the
<code>org.apache.juneau.sample.war</code> application.
- <br>
- The POJO model consists of a <code>List</code> of <code>Person</code> beans, with each <code>Person</code>
+ <br>The POJO model consists of a <code>List</code> of <code>Person</code> beans, with each <code>Person</code>
containing zero or more <code>Address</code> beans.
</p>
<p>
@@ -207,14 +211,17 @@
Juneau supports two kinds of serialization:
</p>
<ul class='spaced-list'>
- <li>Construction of full URL query parameter strings (e.g. <code>&key=value</code> pairs) from beans
+ <li>
+ Construction of full URL query parameter strings (e.g. <code>&key=value</code> pairs) from beans
and maps.
- <li>Construction of URL query parameter value strings (e.g. just the <code>value</code> portion of
+ <li>
+ Construction of URL query parameter value strings (e.g. just the <code>value</code> portion of
<code>&key=value</code> pairs) from any POJO.
</ul>
<p>
Top-level beans and maps can serialized as key/value pairs as shown below:
</p>
+
<h6 class='figure'>Example: A bean with 2 string properties, 'foo' and 'baz', serialized to a query string</h6>
<p class='bcode'>
http://localhost/sample?<ua>foo</ua>=<us>bar</us>&<ua>baz</ua>=<us>bing</us>
@@ -224,6 +231,7 @@
<js>"(...)"</js> construct to denote an object mapping, and uses a comma as the parameter delimiter instead
of <js>"&"</js>.
</p>
+
<h6 class='figure'>Example: A bean serialized as a query parameter value.</h6>
<p class='bcode'>
http://localhost/sample?<ua>a1</ua>=(<ua>foo</ua>=<us>bar</us>,<ua>baz</ua>=<us>bing</us>)
@@ -289,14 +297,14 @@
<code>PojoSwaps</code> can be used to convert non-serializable POJOs into serializable forms, such as
converting <code>Calendar</code> object to ISO8601 strings, or <code><uk>byte</uk>[]</code> arrays to
Base-64 encoded strings.
- <br>
- These transforms can be associated at various levels:
+ <br>These transforms can be associated at various levels:
</p>
- <ul class='spaced-list'>
+ <ul>
<li>On serializer and parser instances to handle all objects of the class type globally.
<li>On classes through the <code><ja>@Bean</ja></code> annotation.
<li>On bean properties through the <code><ja>@BeanProperty</ja></code> annotations.
</ul>
+
<h6 class='figure'>Example: A serialized Calendar object using <code>CalendarSwap.RFC2822DTZ</code> transform.</h6>
<p class='bcode'>
http://localhost/sample?<ua>a1=<us>'Sun,+03+Mar+1901+09:05:06+GMT'</us>
@@ -316,8 +324,7 @@
<p>
{@link org.apache.juneau.urlencoding.UrlEncodingSerializer} and {@link org.apache.juneau.uon.UonSerializer}
classes are used to convert POJOs to URL-encoded strings.
- <br>
- The <code>UonSerializer</code> class converts parameter values to UON notation.
+ <br>The <code>UonSerializer</code> class converts parameter values to UON notation.
The <code>UrlEncodingSerializer</code> class converts a POJO to key/value URL-Encoded pairs using
<code>UonSerializer</code> to serialize the values.
If you're trying to construct complete URL-Encoded entities, use <code>UrlEncodingSerializer</code>.
@@ -325,37 +332,43 @@
</p>
<p>
The serializers include several configurable settings.
- <br>
- Static reusable instances of serializers are provided with commonly-used settings:
+ <br>Static reusable instances of serializers are provided with commonly-used settings:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT} - All default settings, strict mode.
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT_READABLE} - Use whitespace and
+ <li>
+ {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT} - All default settings, strict mode.
+ <li>
+ {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT_READABLE} - Use whitespace and
indentation for readability.
- <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT} - All default settings, strict mode.
- <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT_READABLE} - Use whitespace and indentation for
+ <li>
+ {@link org.apache.juneau.uon.UonSerializer#DEFAULT} - All default settings, strict mode.
+ <li>
+ {@link org.apache.juneau.uon.UonSerializer#DEFAULT_READABLE} - Use whitespace and indentation for
readability.
- <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT_ENCODING} - Same as DEFAULT, but use URL-Encoding on
+ <li>
+ {@link org.apache.juneau.uon.UonSerializer#DEFAULT_ENCODING} - Same as DEFAULT, but use URL-Encoding on
special characters.
</ul>
<p>
The general guidelines on which serializer to use is:
</p>
<ul class='spaced-list'>
- <li>Use encoding serializers when you're using the results to construct a URI yourself, and therefore
+ <li>
+ Use encoding serializers when you're using the results to construct a URI yourself, and therefore
need invalid URI characters to be encoded.
- <li>Use un-encoding serializers when you're creating parameter values and passing them off to some other
+ <li>
+ Use un-encoding serializers when you're creating parameter values and passing them off to some other
utility class that will itself encode invalid URI characters.
- <li>Use the readable serializer for debugging purposes.
+ <li>
+ Use the readable serializer for debugging purposes.
</ul>
<h6 class='topic'>Notes about examples</h6>
<p>
The examples shown in this document will use default strict settings.
- <br>
- For brevity, the examples will use public fields instead of getters/setters to reduce the size of the examples.
- <br>
- In the real world, you'll typically want to use standard bean getters and setters.
+ <br>For brevity, the examples will use public fields instead of getters/setters to reduce the size of the
+ examples.
+ <br>In the real world, you'll typically want to use standard bean getters and setters.
</p>
<p>
To start off simple, we'll begin with the following simplified bean and build upon it.
@@ -425,10 +438,9 @@
<p>
The {@link org.apache.juneau.annotation.Bean @Bean} and {@link org.apache.juneau.annotation.BeanProperty @BeanProperty}
annotations are used to customize the behavior of beans across the entire framework.
- <br>
- They have various uses:
+ <br>They have various uses:
</p>
- <ul class='spaced-list'>
+ <ul>
<li>Hiding bean properties.
<li>Specifying the ordering of bean properties.
<li>Overriding the names of bean properties.
@@ -437,14 +449,11 @@
</ul>
<p>
For example, we now add a <code>birthDate</code> property, and associate a transform with it to transform
- it to an ISO8601 date-time string in GMT time.
- <br>
- We'll also add a couple of <code>URI</code> properties.
- <br>
- By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you want
- them serialized.
- <br>
- Using transforms, we can convert them to standardized string forms.
+ it to an ISO8601 date-time string in GMT time.
+ <br>We'll also add a couple of <code>URI</code> properties.
+ <br>By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you
+ want them serialized.
+ <br>Using transforms, we can convert them to standardized string forms.
</p>
<p class='bcode'>
<jk>public class</jk> Person {
@@ -497,16 +506,17 @@
<p>
Another useful feature is the {@link org.apache.juneau.annotation.Bean#propertyNamer()} annotation that
allows you to plug in your own logic for determining bean property names.
- <br>
- The {@link org.apache.juneau.PropertyNamerDLC} is an example of an alternate property namer.
+ <br>The {@link org.apache.juneau.PropertyNamerDLC} is an example of an alternate property namer.
It converts bean property names to lowercase-dashed format.
</p>
+
<h6 class='figure'>Example:</h6>
<p class='bcode'>
<ja>@Bean</ja>(propertyNamer=PropertyNamerDLC.<jk>class</jk>)
<jk>public class</jk> Person {
...
</p>
+
<h6 class='figure'>Results</h6>
<p class='bcode'>
(<ua>id</ua>=<un>1</us>,<ua>name</ua>=<us>'John+Smith'</us>,<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>,
@@ -625,18 +635,16 @@
<h3 class='topic' onclick='toggle(this)'>2.3 - Non-tree models and recursion detection</h3>
<div class='topic'>
<p>
- The URL-encoding serializer is designed to be used against POJO tree structures. <br>
+ The URL-encoding serializer is designed to be used against POJO tree structures.
It expects that there not be loops in the POJO model (e.g. children with references to parents, etc...).
- <br>
- If you try to serialize models with loops, you will usually cause a <code>StackOverflowError</code> to
+ <br>If you try to serialize models with loops, you will usually cause a <code>StackOverflowError</code> to
be thrown (if {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_maxDepth} is not reached
first).
</p>
<p>
If you still want to use the URL-encoding serializer on such models, Juneau provides the
{@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_detectRecursions} setting.
- <br>
- It tells the serializer to look for instances of an object in the current branch of the tree and skip
+ <br>It tells the serializer to look for instances of an object in the current branch of the tree and skip
serialization when a duplicate is encountered.
</p>
<p>
@@ -700,9 +708,12 @@
See the following classes for all configurable properties that can be used on this serializer:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.BeanContext} - Bean context properties.
- <li>{@link org.apache.juneau.uon.UonSerializerContext} - UON serializer context properties.
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializerContext} - URL-Encoding serializer context
+ <li>
+ {@link org.apache.juneau.BeanContext} - Bean context properties.
+ <li>
+ {@link org.apache.juneau.uon.UonSerializerContext} - UON serializer context properties.
+ <li>
+ {@link org.apache.juneau.urlencoding.UrlEncodingSerializerContext} - URL-Encoding serializer context
properties.
</ul>
</div>
@@ -713,10 +724,10 @@
<h3 class='topic' onclick='toggle(this)'>2.5 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau serializers, the URL-encoding serializers are thread safe and maintain an
+ <li>
+ Like all other Juneau serializers, the URL-encoding serializers are thread safe and maintain an
internal cache of bean classes encountered.
- <br>
- For performance reasons, it's recommended that serializers be reused whenever possible instead of
+ <br>For performance reasons, it's recommended that serializers be reused whenever possible instead of
always creating new instances.
</ul>
</div>
@@ -730,8 +741,7 @@
<p>
{@link org.apache.juneau.urlencoding.UrlEncodingParser} and {@link org.apache.juneau.uon.UonParser} classes are
used to convert URL-encoded strings back into POJOs.
- <br>
- The <code>UonParser</code> class converts UON-encoded parameter values to POJOs.
+ <br>The <code>UonParser</code> class converts UON-encoded parameter values to POJOs.
The <code>UrlEncodingParser</code> class converts entire URL-Encoded strings to POJOs using
<code>UonSerializer</code> to serialize individual values.
If you're trying to parse an entire URL-Encoded string, use <code>UrlEncodingParser</code>.
@@ -742,26 +752,30 @@
The following static reusable instances of <code>UrlEncodingParser</code> are provided for convenience:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingParser#DEFAULT}
+ <li>
+ {@link org.apache.juneau.urlencoding.UrlEncodingParser#DEFAULT}
- Default parser for entire URL-encoded strings, decode <code>%xx</code> sequences.
- <li>{@link org.apache.juneau.uon.UonParser#DEFAULT}
+ <li>
+ {@link org.apache.juneau.uon.UonParser#DEFAULT}
- Default parser for URL-encoded parameter values, don't decode <code>%xx</code> sequences.
- <li>{@link org.apache.juneau.uon.UonParser#DEFAULT_DECODING}
+ <li>
+ {@link org.apache.juneau.uon.UonParser#DEFAULT_DECODING}
- Default parser for URL-encoded parameter values, decode <code>%xx</code> sequences.
</ul>
<p>
The general guidelines on which parser to use is:
</p>
<ul class='spaced-list'>
- <li>Use the <code>DEFAULT</code> parser for parameter values that have already had <code>%xx</code> sequences
+ <li>
+ Use the <code>DEFAULT</code> parser for parameter values that have already had <code>%xx</code> sequences
decoded, such as when using <code>HttpServletRequest.getQueryParameter(name)</code>.
- <li>Use the <code>DEFAULT_ENCODED</code> parser if the input has not already had <code>%xx</code> sequences
+ <li>
+ Use the <code>DEFAULT_ENCODED</code> parser if the input has not already had <code>%xx</code> sequences
decoded.
</ul>
<p>
Let's build upon the previous example and parse the generated URL-encoded string back into the original bean.
- <br>
- We start with the URL-encoded string that was generated.
+ <br>We start with the URL-encoded string that was generated.
</p>
<p class='bcode'>
<jc>// Use serializer with readable output.</jc>
@@ -850,16 +864,14 @@
<div class='topic'>
<p>
The URL-encoding parser is not limited to parsing back into the original bean classes.
- <br>
- If the bean classes are not available on the parsing side, the parser can also be used to parse into a
+ <br>If the bean classes are not available on the parsing side, the parser can also be used to parse into a
generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive objects.
</p>
<p>
You can parse into any <code>Map</code> type (e.g. <code>HashMap</code>, <code>TreeMap</code>), but
using {@link org.apache.juneau.ObjectMap} is recommended since it has many convenience methods
for converting values to various types.
- <br>
- The same is true when parsing collections.
+ <br>The same is true when parsing collections.
You can use any Collection (e.g. <code>HashSet</code>, <code>LinkedList</code>)
or array (e.g. <code>Object[]</code>, <code>String[]</code>, <code>String[][]</code>), but using
{@link org.apache.juneau.ObjectList} is recommended.
@@ -904,8 +916,7 @@
</p>
<p>
What we end up with is the exact same output.
- <br>
- Even the numbers and booleans are preserved because they are parsed into <code>Number</code> and
+ <br>Even the numbers and booleans are preserved because they are parsed into <code>Number</code> and
<code>Boolean</code> objects when parsing into generic models.
</p>
<p class='bcode'>
@@ -957,8 +968,7 @@
<p>
As a general rule, parsing into beans is often more efficient than parsing into generic models.
- <br>
- And working with beans is often less error prone than working with generic models.
+ <br>And working with beans is often less error prone than working with generic models.
</p>
</div>
@@ -971,9 +981,12 @@
See the following classes for all configurable properties that can be used on this parser:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.BeanContext} - Bean context properties.
- <li>{@link org.apache.juneau.uon.UonParserContext} - UON parser context properties.
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingParserContext} - URL-Encoding parser context properties.
+ <li>
+ {@link org.apache.juneau.BeanContext} - Bean context properties.
+ <li>
+ {@link org.apache.juneau.uon.UonParserContext} - UON parser context properties.
+ <li>
+ {@link org.apache.juneau.urlencoding.UrlEncodingParserContext} - URL-Encoding parser context properties.
</ul>
</div>
@@ -983,10 +996,10 @@
<h3 class='topic' onclick='toggle(this)'>3.3 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau parsers, the URL-encoding parsers are thread safe and maintain an internal cache
+ <li>
+ Like all other Juneau parsers, the URL-encoding parsers are thread safe and maintain an internal cache
of bean classes encountered.
- <br>
- For performance reasons, it's recommended that parser be reused whenever possible instead of always
+ <br>For performance reasons, it's recommended that parser be reused whenever possible instead of always
creating new instances.
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingContext.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingContext.java
index abd3bb9..a419e48 100644
--- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingContext.java
@@ -41,7 +41,7 @@ public final class UrlEncodingContext implements Cloneable {
* </p>
* <p>
* This option only applies to beans.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>If parsing multi-part parameters, it's highly recommended to use <code>Collections</code> or <code>Lists</code>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java
index 731ea51..4e96bb4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java
@@ -79,14 +79,14 @@ public class UrlEncodingParserBuilder extends UonParserBuilder {
* </p>
* <p>
* This option only applies to beans.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>If parsing multi-part parameters, it's highly recommended to use Collections or Lists
* as bean property types instead of arrays since arrays have to be recreated from scratch every time a value
* is added to it.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>URLENC_expandedParams</jsf>, value)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java
index 0af49c0..abaf23f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java
@@ -77,14 +77,14 @@ public class UrlEncodingSerializerBuilder extends UonSerializerBuilder {
* </p>
* <p>
* This option only applies to beans.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>If parsing multi-part parameters, it's highly recommended to use Collections or Lists
* as bean property types instead of arrays since arrays have to be recreated from scratch every time a value
* is added to it.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>URLENC_expandedParams</jsf>, value)</code>.
@@ -112,14 +112,16 @@ public class UrlEncodingSerializerBuilder extends UonSerializerBuilder {
* Specifies the format to use for URL GET parameter keys and values.
* <p>
* The possible values are:
- * <ul>
- * <li><js>"UON"</js> (default) - Use UON notation for values.
+ * <ul class='spaced-list'>
+ * <li>
+ * <js>"UON"</js> (default) - Use UON notation for values.
* <br>String values such as <js>"(foo='bar')"</js> will end up being quoted and escaped to <js>"'(foo=bar~'baz~')'"</js>.
* <br>Similarly, boolean and numeric values will also end up quoted.
- * <li><js>"PLAINTEXT"</js> (default) - Serialize as plain text.
+ * <li>
+ * <js>"PLAINTEXT"</js> (default) - Serialize as plain text.
* <br>Strings will never be quoted or escaped.
* <br>Note that this can cause errors during parsing if you're using the URL-encoding parser to parse
- * the results since UON constructs won't be differentiatable.
+ * the results since UON constructs won't be differentiable.
* <br>However, this is not an issue if you're simply creating queries or form posts against 3rd-party interfaces.
* </ul>
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/urlencoding/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/urlencoding/package.html b/juneau-core/src/main/java/org/apache/juneau/urlencoding/package.html
index a2e8c15..e880ec0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/urlencoding/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/urlencoding/package.html
@@ -84,11 +84,9 @@
<p>
Juneau supports converting arbitrary POJOs to and from URL-encoded strings using ultra-efficient serializers
and parsers.
- <br>
- The serializer converts POJOs directly to URL-encoded strings without the need for intermediate DOM objects
+ <br>The serializer converts POJOs directly to URL-encoded strings without the need for intermediate DOM objects
using a highly-efficient state machine.
- <br>
- Likewise, the parser creates POJOs directly from URL-encoded strings without the need for intermediate DOM
+ <br>Likewise, the parser creates POJOs directly from URL-encoded strings without the need for intermediate DOM
objects.
</p>
<p>
@@ -99,21 +97,28 @@
Juneau can serialize and parse instances of any of the following POJO types:
</p>
<ul class='spaced-list'>
- <li>Java primitives and primitive objects (e.g. <code>String</code>, <code>Integer</code>, <code>Boolean</code>,
+ <li>
+ Java primitives and primitive objects (e.g. <code>String</code>, <code>Integer</code>, <code>Boolean</code>,
<code>Float</code>).
- <li>Java Collections Framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything
+ <li>
+ Java Collections Framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything
on this list.
- <li>Multi-dimensional arrays of any type on this list.
- <li>Java Beans with properties of any type on this list.
- <li>Classes with standard transformations to and from <code>Strings</code> (e.g. classes containing
+ <li>
+ Multi-dimensional arrays of any type on this list.
+ <li>
+ Java Beans with properties of any type on this list.
+ <li>
+ Classes with standard transformations to and from <code>Strings</code> (e.g. classes containing
<code>toString()</code>, <code>fromString()</code>, <code>valueOf()</code>, <code>constructor(String)</code>).
- <li>Non-serializable classes and properties with associated <code>PojoSwaps</code> that convert them to
+ <li>
+ Non-serializable classes and properties with associated <code>PojoSwaps</code> that convert them to
serializable forms.
</ul>
<p>
Refer to <a href='../../../../overview-summary.html#Core.PojoCategories' class='doclink'>POJO Categories</a>
for a complete definition of supported POJOs.
</p>
+
<h6 class='topic'>Prerequisites</h6>
<p>
The Juneau URL-encoding serialization and parsing support does not require any external prerequisites.
@@ -127,8 +132,7 @@
<p>
The example shown here is from the Address Book resource located in the
<code>org.apache.juneau.sample.war</code> application
- <br>
- The POJO model consists of a <code>List</code> of <code>Person</code> beans, with each <code>Person</code>
+ <br>The POJO model consists of a <code>List</code> of <code>Person</code> beans, with each <code>Person</code>
containing zero or more <code>Address</code> beans.
</p>
<p>
@@ -206,14 +210,17 @@
Juneau supports two kinds of serialization:
</p>
<ul class='spaced-list'>
- <li>Construction of full URL query parameter strings (e.g. <code>&key=value</code> pairs) from beans
+ <li>
+ Construction of full URL query parameter strings (e.g. <code>&key=value</code> pairs) from beans
and maps.
- <li>Construction of URL query parameter value strings (e.g. just the <code>value</code> portion of
+ <li>
+ Construction of URL query parameter value strings (e.g. just the <code>value</code> portion of
<code>&key=value</code> pairs) from any POJO.
</ul>
<p>
Top-level beans and maps can serialized as key/value pairs as shown below:
</p>
+
<h6 class='figure'>Example: A bean with 2 string properties, 'foo' and 'baz', serialized to a query string</h6>
<p class='bcode'>
http://localhost/sample?<ua>foo</ua>=<us>bar</us>&<ua>baz</ua>=<us>bing</us>
@@ -223,6 +230,7 @@
<js>"(...)"</js> construct to denote an object mapping, and uses a comma as the parameter delimiter
instead of <js>"&"</js>.
</p>
+
<h6 class='figure'>Example: A bean serialized as a query parameter value.</h6>
<p class='bcode'>
http://localhost/sample?<ua>a1</ua>=(<ua>foo</ua>=<us>bar</us>,<ua>baz</ua>=<us>bing</us>)
@@ -288,14 +296,14 @@
<code>PojoSwaps</code> can be used to convert non-serializable POJOs into serializable forms, such as
converting <code>Calendar</code> object to ISO8601 strings, or <code><uk>byte</uk>[]</code> arrays to
Base-64 encoded strings.
- <br>
- These transforms can be associated at various levels:
+ <br>These transforms can be associated at various levels:
</p>
- <ul class='spaced-list'>
+ <ul>
<li>On serializer and parser instances to handle all objects of the class type globally.
<li>On classes through the <code><ja>@Bean</ja></code> annotation.
<li>On bean properties through the <code><ja>@BeanProperty</ja></code> annotations.
</ul>
+
<h6 class='figure'>Example: A serialized Calendar object using <code>CalendarSwap.RFC2822DTZ</code> transform.</h6>
<p class='bcode'>
http://localhost/sample?<ua>a1=<us>'Sun,+03+Mar+1901+09:05:06+GMT'</us>
@@ -315,8 +323,7 @@
<p>
{@link org.apache.juneau.urlencoding.UrlEncodingSerializer} and {@link org.apache.juneau.uon.UonSerializer}
classes are used to convert POJOs to URL-encoded strings.
- <br>
- The <code>UonSerializer</code> class converts parameter values to UON notation.
+ <br>The <code>UonSerializer</code> class converts parameter values to UON notation.
The <code>UrlEncodingSerializer</code> class converts a POJO to key/value URL-Encoded pairs using
<code>UonSerializer</code> to serialize the values.
If you're trying to construct complete URL-Encoded entities, use <code>UrlEncodingSerializer</code>.
@@ -324,39 +331,44 @@
</p>
<p>
The serializers include several configurable settings.
- <br>
- Static reusable instances of serializers are provided with commonly-used settings:
+ <br>Static reusable instances of serializers are provided with commonly-used settings:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT}
+ <li>
+ {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT}
- All default settings, strict mode.
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT_READABLE}
+ <li>
+ {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#DEFAULT_READABLE}
- Use whitespace and indentation for readability.
- <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT}
+ <li>
+ {@link org.apache.juneau.uon.UonSerializer#DEFAULT}
- All default settings, strict mode.
- <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT_READABLE}
+ <li>
+ {@link org.apache.juneau.uon.UonSerializer#DEFAULT_READABLE}
- Use whitespace and indentation for readability.
- <li>{@link org.apache.juneau.uon.UonSerializer#DEFAULT_ENCODING}
+ <li>
+ {@link org.apache.juneau.uon.UonSerializer#DEFAULT_ENCODING}
- Same as DEFAULT, but use URL-Encoding on special characters.
</ul>
<p>
The general guidelines on which serializer to use is:
</p>
<ul class='spaced-list'>
- <li>Use encoding serializers when you're using the results to construct a URI yourself, and therefore
+ <li>
+ Use encoding serializers when you're using the results to construct a URI yourself, and therefore
need invalid URI characters to be encoded.
- <li>Use un-encoding serializers when you're creating parameter values and passing them off to some other
+ <li>
+ Use un-encoding serializers when you're creating parameter values and passing them off to some other
utility class that will itself encode invalid URI characters.
- <li>Use the readable serializer for debugging purposes.
+ <li>
+ Use the readable serializer for debugging purposes.
</ul>
<h6 class='topic'>Notes about examples</h6>
<p>
The examples shown in this document will use default strict settings.
- <br>
- For brevity, the examples will use public fields instead of getters/setters to reduce the size of the examples.
- <br>
- In the real world, you'll typically want to use standard bean getters and setters.
+ <br>For brevity, the examples will use public fields instead of getters/setters to reduce the size of the examples.
+ <br>In the real world, you'll typically want to use standard bean getters and setters.
</p>
<p>
To start off simple, we'll begin with the following simplified bean and build upon it.
@@ -426,10 +438,9 @@
<p>
The {@link org.apache.juneau.annotation.Bean @Bean} and {@link org.apache.juneau.annotation.BeanProperty @BeanProperty}
annotations are used to customize the behavior of beans across the entire framework.
- <br>
- They have various uses:
+ <br>They have various uses:
</p>
- <ul class='spaced-list'>
+ <ul>
<li>Hiding bean properties.
<li>Specifying the ordering of bean properties.
<li>Overriding the names of bean properties.
@@ -439,13 +450,10 @@
<p>
For example, we now add a <code>birthDate</code> property, and associate a transform with it to transform
it to an ISO8601 date-time string in GMT time.
- <br>
- We'll also add a couple of <code>URI</code> properties.
- <br>
- By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you want
+ <br>We'll also add a couple of <code>URI</code> properties.
+ <br>By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you want
them serialized.
- <br>
- Using transforms, we can convert them to standardized string forms.
+ <br>Using transforms, we can convert them to standardized string forms.
</p>
<p class='bcode'>
<jk>public class</jk> Person {
@@ -499,16 +507,17 @@
<p>
Another useful feature is the {@link org.apache.juneau.annotation.Bean#propertyNamer()} annotation that
allows you to plug in your own logic for determining bean property names.
- <br>
- The {@link org.apache.juneau.PropertyNamerDLC} is an example of an alternate property namer.
+ <br>The {@link org.apache.juneau.PropertyNamerDLC} is an example of an alternate property namer.
It converts bean property names to lowercase-dashed format.
</p>
+
<h6 class='figure'>Example:</h6>
<p class='bcode'>
<ja>@Bean</ja>(propertyNamer=PropertyNamerDLC.<jk>class</jk>)
<jk>public class</jk> Person {
...
</p>
+
<h6 class='figure'>Results</h6>
<p class='bcode'>
(<ua>id</ua>=<un>1</us>,<ua>name</ua>=<us>'John+Smith'</us>,<ua>uri</ua>=<us>http://sample/addressBook/person/1</us>,
@@ -627,17 +636,15 @@
<h3 class='topic' onclick='toggle(this)'>2.3 - Non-tree models and recursion detection</h3>
<div class='topic'>
<p>
- The URL-encoding serializer is designed to be used against POJO tree structures. <br>
- It expects that there not be loops in the POJO model (e.g. children with references to parents, etc...).
- <br>
- If you try to serialize models with loops, you will usually cause a <code>StackOverflowError</code> to
+ The URL-encoding serializer is designed to be used against POJO tree structures.
+ <br>It expects that there not be loops in the POJO model (e.g. children with references to parents, etc...).
+ <br>If you try to serialize models with loops, you will usually cause a <code>StackOverflowError</code> to
be thrown (if {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_maxDepth} is not reached first).
</p>
<p>
If you still want to use the URL-encoding serializer on such models, Juneau provides the
{@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_detectRecursions} setting.
- <br>
- It tells the serializer to look for instances of an object in the current branch of the tree and
+ <br>It tells the serializer to look for instances of an object in the current branch of the tree and
skip serialization when a duplicate is encountered.
</p>
<p>
@@ -688,8 +695,7 @@
</p>
<p>
Recursion detection introduces a performance penalty of around 20%.
- <br>
- For this reason the setting is disabled by default.
+ <br>For this reason the setting is disabled by default.
</p>
</div>
@@ -702,11 +708,14 @@
See the following classes for all configurable properties that can be used on this serializer:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.BeanContext}
+ <li>
+ {@link org.apache.juneau.BeanContext}
- Bean context properties.
- <li>{@link org.apache.juneau.uon.UonSerializerContext}
+ <li>
+ {@link org.apache.juneau.uon.UonSerializerContext}
- UON serializer context properties.
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingSerializerContext}
+ <li>
+ {@link org.apache.juneau.urlencoding.UrlEncodingSerializerContext}
- URL-Encoding serializer context properties.
</ul>
</div>
@@ -717,10 +726,10 @@
<h3 class='topic' onclick='toggle(this)'>2.5 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau serializers, the URL-encoding serializers are thread safe and maintain an internal
+ <li>
+ Like all other Juneau serializers, the URL-encoding serializers are thread safe and maintain an internal
cache of bean classes encountered.
- <br>
- For performance reasons, it's recommended that serializers be reused whenever possible instead of
+ <br>For performance reasons, it's recommended that serializers be reused whenever possible instead of
always creating new instances.
</ul>
</div>
@@ -734,8 +743,7 @@
<p>
{@link org.apache.juneau.urlencoding.UrlEncodingParser} and {@link org.apache.juneau.uon.UonParser} classes
are used to convert URL-encoded strings back into POJOs.
- <br>
- The <code>UonParser</code> class converts UON-encoded parameter values to POJOs.
+ <br>The <code>UonParser</code> class converts UON-encoded parameter values to POJOs.
The <code>UrlEncodingParser</code> class converts entire URL-Encoded strings to POJOs using
<code>UonSerializer</code> to serialize individual values.
If you're trying to parse an entire URL-Encoded string, use <code>UrlEncodingParser</code>.
@@ -746,26 +754,30 @@
The following static reusable instances of <code>UrlEncodingParser</code> are provided for convenience:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingParser#DEFAULT}
+ <li>
+ {@link org.apache.juneau.urlencoding.UrlEncodingParser#DEFAULT}
- Default parser for entire URL-encoded strings, decode <code>%xx</code> sequences.
- <li>{@link org.apache.juneau.uon.UonParser#DEFAULT}
+ <li>
+ {@link org.apache.juneau.uon.UonParser#DEFAULT}
- Default parser for URL-encoded parameter values, don't decode <code>%xx</code> sequences.
- <li>{@link org.apache.juneau.uon.UonParser#DEFAULT_DECODING}
+ <li>
+ {@link org.apache.juneau.uon.UonParser#DEFAULT_DECODING}
- Default parser for URL-encoded parameter values, decode <code>%xx</code> sequences.
</ul>
<p>
The general guidelines on which parser to use is:
</p>
<ul class='spaced-list'>
- <li>Use the <code>DEFAULT</code> parser for parameter values that have already had <code>%xx</code> sequences
+ <li>
+ Use the <code>DEFAULT</code> parser for parameter values that have already had <code>%xx</code> sequences
decoded, such as when using <code>HttpServletRequest.getQueryParameter(name)</code>.
- <li>Use the <code>DEFAULT_ENCODED</code> parser if the input has not already had <code>%xx</code> sequences
+ <li>
+ Use the <code>DEFAULT_ENCODED</code> parser if the input has not already had <code>%xx</code> sequences
decoded.
</ul>
<p>
Let's build upon the previous example and parse the generated URL-encoded string back into the original bean.
- <br>
- We start with the URL-encoded string that was generated.
+ <br>We start with the URL-encoded string that was generated.
</p>
<p class='bcode'>
<jc>// Use serializer with readable output.</jc>
@@ -854,16 +866,14 @@
<div class='topic'>
<p>
The URL-encoding parser is not limited to parsing back into the original bean classes.
- <br>
- If the bean classes are not available on the parsing side, the parser can also be used to parse into a
+ <br>If the bean classes are not available on the parsing side, the parser can also be used to parse into a
generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive objects.
</p>
<p>
You can parse into any <code>Map</code> type (e.g. <code>HashMap</code>, <code>TreeMap</code>), but
using {@link org.apache.juneau.ObjectMap} is recommended since it has many convenience methods
for converting values to various types.
- <br>
- The same is true when parsing collections. You can use any Collection (e.g. <code>HashSet</code>,
+ <br>The same is true when parsing collections. You can use any Collection (e.g. <code>HashSet</code>,
<code>LinkedList</code>) or array (e.g. <code>Object[]</code>, <code>String[]</code>,
<code>String[][]</code>), but using {@link org.apache.juneau.ObjectList} is recommended.
</p>
@@ -908,8 +918,7 @@
</p>
<p>
What we end up with is the exact same output.
- <br>
- Even the numbers and booleans are preserved because they are parsed into <code>Number</code> and
+ <br>Even the numbers and booleans are preserved because they are parsed into <code>Number</code> and
<code>Boolean</code> objects when parsing into generic models.
</p>
<p class='bcode'>
@@ -961,8 +970,7 @@
<p>
As a general rule, parsing into beans is often more efficient than parsing into generic models.
- <br>
- And working with beans is often less error prone than working with generic models.
+ <br>And working with beans is often less error prone than working with generic models.
</p>
</div>
@@ -975,9 +983,12 @@
See the following classes for all configurable properties that can be used on this parser:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.BeanContext} - Bean context properties.
- <li>{@link org.apache.juneau.uon.UonParserContext} - UON parser context properties.
- <li>{@link org.apache.juneau.urlencoding.UrlEncodingParserContext} - URL-Encoding parser context properties.
+ <li>
+ {@link org.apache.juneau.BeanContext} - Bean context properties.
+ <li>
+ {@link org.apache.juneau.uon.UonParserContext} - UON parser context properties.
+ <li>
+ {@link org.apache.juneau.urlencoding.UrlEncodingParserContext} - URL-Encoding parser context properties.
</ul>
</div>
@@ -987,10 +998,10 @@
<h3 class='topic' onclick='toggle(this)'>3.3 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau parsers, the URL-encoding parsers are thread safe and maintain an internal cache
+ <li>
+ Like all other Juneau parsers, the URL-encoding parsers are thread safe and maintain an internal cache
of bean classes encountered.
- <br>
- For performance reasons, it's recommended that parser be reused whenever possible instead of always
+ <br>For performance reasons, it's recommended that parser be reused whenever possible instead of always
creating new instances.
</ul>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/utils/Args.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/Args.java b/juneau-core/src/main/java/org/apache/juneau/utils/Args.java
index 72a1f0a..240d609 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/Args.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/Args.java
@@ -28,7 +28,7 @@ import org.apache.juneau.*;
* The format of a main argument is a token that does not start with <js>'-'</js>.
* <p>
* The format of an optional argument is <js>"-argName [zero or more tokens]"</js>.
- * <p>
+ *
* <h6 class='topic'>Command-line examples</h6>
* <ul>
* <li><code>java com.sample.MyClass mainArg1</code>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java b/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java
index 4812adb..0df8d33 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/MessageBundle.java
@@ -25,18 +25,24 @@ import org.apache.juneau.annotation.*;
/**
* Wraps a {@link ResourceBundle} to provide some useful additional functionality.
* <ul class='spaced-list'>
- * <li>Instead of throwing {@link MissingResourceException}, the {@link #getString(String)} method
+ * <li>
+ * Instead of throwing {@link MissingResourceException}, the {@link #getString(String)} method
* will return <js>"{!!key}"</js> if the bundle was not found, and <js>"{!key}"</js> if bundle
* was found but the key is not in the bundle.
- * <li>A client locale can be set as a {@link ThreadLocal} object using the static {@link #setClientLocale(Locale)}
+ * <li>
+ * A client locale can be set as a {@link ThreadLocal} object using the static {@link #setClientLocale(Locale)}
* so that client localized messages can be retrieved using the {@link #getClientString(String, Object...)}
* method on all instances of this class.
- * <li>Resource bundles on parent classes can be added to the search path for this class by using the
+ * <li>
+ * Resource bundles on parent classes can be added to the search path for this class by using the
* {@link #addSearchPath(Class, String)} method.
* This allows messages to be retrieved from the resource bundles of parent classes.
- * <li>Locale-specific bundles can be retrieved by using the {@link #getBundle(Locale)} method.
- * <li>The {@link #getString(Locale, String, Object...)} method can be used to retrieve locale-specific messages.
- * <li>Messages in the resource bundle can optionally be prefixed with the simple class name.
+ * <li>
+ * Locale-specific bundles can be retrieved by using the {@link #getBundle(Locale)} method.
+ * <li>
+ * The {@link #getString(Locale, String, Object...)} method can be used to retrieve locale-specific messages.
+ * <li>
+ * Messages in the resource bundle can optionally be prefixed with the simple class name.
* For example, if the class is <code>MyClass</code> and the properties file contains <js>"MyClass.myMessage"</js>,
* the message can be retrieved using <code>getString(<js>"myMessage"</js>)</code>.
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java b/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java
index 912dc18..26879ca 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/ObjectUtils.java
@@ -44,8 +44,7 @@ import org.apache.juneau.transform.*;
* <tr>
* <td>
* {@code Number} (e.g. {@code Integer}, {@code Short}, {@code Float},...)
- * <br>
- * <code>Number.<jsf>TYPE</jsf></code> (e.g. <code>Integer.<jsf>TYPE</jsf></code>,
+ * <br><code>Number.<jsf>TYPE</jsf></code> (e.g. <code>Integer.<jsf>TYPE</jsf></code>,
* <code>Short.<jsf>TYPE</jsf></code>, <code>Float.<jsf>TYPE</jsf></code>,...)
* </td>
* <td>
@@ -68,12 +67,11 @@ import org.apache.juneau.transform.*;
* </tr>
* <tr>
* <td>
- * {@code Collection} (e.g. {@code List}, {@code LinkedList}, {@code HashSet}, {@code ObjectList})
+ * {@code Collection} (e.g. {@code List}, {@code LinkedList}, {@code HashSet}, {@code ObjectList})
* </td>
* <td>
* {@code Collection<Object>}
- * <br>
- * {@code Object[]}
+ * <br>{@code Object[]}
* </td>
* <td>
* If {@code Collection} is not constructible, a {@code ObjectList} is created.
@@ -82,7 +80,6 @@ import org.apache.juneau.transform.*;
* <tr>
* <td>
* {@code X[]} (array of any type X)
- * <br>
* </td>
* <td>
* {@code List<X>}
@@ -95,10 +92,8 @@ import org.apache.juneau.transform.*;
* </td>
* <td>
* {@code List<List<X>>}
- * <br>
- * {@code List<X[]>}
- * <br>
- * {@code List[]<X>}
+ * <br>{@code List<X[]>}
+ * <br>{@code List[]<X>}
* </td>
* <td> </td>
* </tr>
@@ -134,12 +129,9 @@ import org.apache.juneau.transform.*;
* <tr>
* <td>
* Anything with one of the following methods:
- * <br>
- * <code><jk>public static</jk> T fromString(String)</code>
- * <br>
- * <code><jk>public static</jk> T valueOf(String)</code>
- * <br>
- * <code><jk>public</jk> T(String)</code>
+ * <br><code><jk>public static</jk> T fromString(String)</code>
+ * <br><code><jk>public static</jk> T valueOf(String)</code>
+ * <br><code><jk>public</jk> T(String)</code>
* </td>
* <td>
* <code>String</code>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java b/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
index 7eea934..3c4a32c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
@@ -69,11 +69,15 @@ public final class PojoIntrospector {
* the underlying constructor is inaccessible.
* @throws IllegalArgumentException If one of the following occurs:
* <ul class='spaced-list'>
- * <li>The number of actual and formal parameters differ.
- * <li>An unwrapping conversion for primitive arguments fails.
- * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
+ * <li>
+ * The number of actual and formal parameters differ.
+ * <li>
+ * An unwrapping conversion for primitive arguments fails.
+ * <li>
+ * A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
* conversion.
- * <li>The constructor pertains to an enum type.
+ * <li>
+ * The constructor pertains to an enum type.
* </ul>
* @throws InvocationTargetException If the underlying constructor throws an exception.
* @throws ParseException If the input contains a syntax error or is malformed.
@@ -100,10 +104,15 @@ public final class PojoIntrospector {
* the underlying constructor is inaccessible.
* @throws IllegalArgumentException If one of the following occurs:
* <ul class='spaced-list'>
- * <li>The number of actual and formal parameters differ.
- * <li>An unwrapping conversion for primitive arguments fails.
- * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion.
- * <li>The constructor pertains to an enum type.
+ * <li>
+ * The number of actual and formal parameters differ.
+ * <li>
+ * An unwrapping conversion for primitive arguments fails.
+ * <li>
+ * A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
+ * conversion.
+ * <li>
+ * The constructor pertains to an enum type.
* </ul>
* @throws InvocationTargetException If the underlying constructor throws an exception.
* @throws ParseException If the input contains a syntax error or is malformed.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java b/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java
index aa51b3a..9b83677 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/PojoQuery.java
@@ -54,24 +54,30 @@ import org.apache.juneau.internal.*;
* <p>
* From this table, you can perform the following functions:
* <ul class='spaced-list'>
- * <li>Search - Return only rows where a search pattern matches.
- * <li>View - Return only the specified subset of columns in the specified order.
- * <li>Sort - Sort the table by one or more columns.
- * <li>Position/limit - Only return a subset of rows.
+ * <li>
+ * Search - Return only rows where a search pattern matches.
+ * <li>
+ * View - Return only the specified subset of columns in the specified order.
+ * <li>
+ * Sort - Sort the table by one or more columns.
+ * <li>
+ * Position/limit - Only return a subset of rows.
* </ul>
*
* <h5 class='topic'>Search</h5>
* <p>
* The search capabilities allow you to filter based on query patterns against strings, dates, and numbers.
* Queries take the form of a Map with column names as keys, and search patterns as values.
- * <br>
- * Multiple search patterns are ANDed (i.e. all patterns must match for the row to be returned).
+ * <br>Multiple search patterns are ANDed (i.e. all patterns must match for the row to be returned).
*
* <h5 class='section'>Example:</h5>
* <ul class='spaced-list'>
- * <li><tt>{myInt:'123'}</tt> - Return only rows where the <tt>myInt</tt> column is 123.
- * <li><tt>{myString:'foobar'}</tt> - Return only rows where the <tt>myString</tt> column is 'foobar'.
- * <li><tt>{myDate:'2001'}</tt> - Return only rows where the <tt>myDate</tt> column have dates in the year 2001.
+ * <li>
+ * <tt>{myInt:'123'}</tt> - Return only rows where the <tt>myInt</tt> column is 123.
+ * <li>
+ * <tt>{myString:'foobar'}</tt> - Return only rows where the <tt>myString</tt> column is 'foobar'.
+ * <li>
+ * <tt>{myDate:'2001'}</tt> - Return only rows where the <tt>myDate</tt> column have dates in the year 2001.
* </ul>
*
* <h5 class='topic'>String Patterns</h5>
@@ -92,9 +98,12 @@ import org.apache.juneau.internal.*;
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
- * <li>Whitespace is ignored around search patterns.
- * <li>Prepend <tt>+</tt> to tokens that must match. (e.g. <tt>+foo* +*bar</tt>)
- * <li>Prepend <tt>-</tt> to tokens that must not match. (e.g. <tt>+foo* -*bar</tt>)
+ * <li>
+ * Whitespace is ignored around search patterns.
+ * <li>
+ * Prepend <tt>+</tt> to tokens that must match. (e.g. <tt>+foo* +*bar</tt>)
+ * <li>
+ * Prepend <tt>-</tt> to tokens that must not match. (e.g. <tt>+foo* -*bar</tt>)
* </ul>
*
* <h5 class='topic'>Numeric Patterns</h5>
@@ -115,8 +124,10 @@ import org.apache.juneau.internal.*;
*
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
- * <li>Whitespace is ignored in search patterns.
- * <li>Negative numbers are supported.
+ * <li>
+ * Whitespace is ignored in search patterns.
+ * <li>
+ * Negative numbers are supported.
* </ul>
*
* <h5 class='topic'>Date Patterns</h5>
@@ -153,8 +164,7 @@ import org.apache.juneau.internal.*;
* <h5 class='topic'>View</h5>
* <p>
* The view capability allows you to return only the specified subset of columns in the specified order.
- * <br>
- * The view parameter is a list of either <tt>Strings</tt> or <tt>Maps</tt>.
+ * <br>The view parameter is a list of either <tt>Strings</tt> or <tt>Maps</tt>.
*
* <h6 class='topic'>Example view parameters:</h6>
* <ul>
@@ -165,8 +175,7 @@ import org.apache.juneau.internal.*;
* <h5 class='topic'>Sort</h5>
* <p>
* The sort capability allows you to sort values by the specified rows.
- * <br>
- * The sort parameter is a list of strings with an optional <js>'+'</js> or <js>'-'</js> suffix representing
+ * <br>The sort parameter is a list of strings with an optional <js>'+'</js> or <js>'-'</js> suffix representing
* ascending and descending order accordingly.
*
* <h6 class='topic'>Example sort parameters:</h6>
@@ -663,10 +672,8 @@ public final class PojoQuery {
/**
* Returns <jk>true</jk> if the specified date matches the pattern passed in through the constructor.
- * <br>
- * The Object can be of type {@link Date} or {@link Calendar}.
- * <br>
- * Always returns <jk>false</jk> on <jk>null</jk> input.
+ * <br>The Object can be of type {@link Date} or {@link Calendar}.
+ * <br>Always returns <jk>false</jk> on <jk>null</jk> input.
*/
@Override /* IMatcher */
public boolean matches(Object in) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java b/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java
index f2397b7..d4c4f94 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/PojoRest.java
@@ -25,23 +25,27 @@ import org.apache.juneau.parser.*;
/**
* Provides the ability to perform standard REST operations (GET, PUT, POST, DELETE) against nodes in a POJO model.
* Nodes in the POJO model are addressed using URLs.
+ *
* <p>
* A POJO model is defined as a tree model where nodes consist of consisting of the following:
* <ul class='spaced-list'>
- * <li>{@link Map Maps} and Java beans representing JSON objects.
- * <li>{@link Collection Collections} and arrays representing JSON arrays.
- * <li>Java beans.
+ * <li>
+ * {@link Map Maps} and Java beans representing JSON objects.
+ * <li>
+ * {@link Collection Collections} and arrays representing JSON arrays.
+ * <li>
+ * Java beans.
* </ul>
+ *
* <p>
* Leaves of the tree can be any type of object.
+ *
* <p>
* Use {@link #get(String) get()} to retrieve an element from a JSON tree.
- * <br>
- * Use {@link #put(String,Object) put()} to create (or overwrite) an element in a JSON tree.
- * <br>
- * Use {@link #post(String,Object) post()} to add an element to a list in a JSON tree.
- * <br>
- * Use {@link #delete(String) delete()} to remove an element from a JSON tree.
+ * <br>Use {@link #put(String,Object) put()} to create (or overwrite) an element in a JSON tree.
+ * <br>Use {@link #post(String,Object) post()} to add an element to a list in a JSON tree.
+ * <br>Use {@link #delete(String) delete()} to remove an element from a JSON tree.
+ *
* <p>
* Leading slashes in URLs are ignored.
* So <js>"/xxx/yyy/zzz"</js> and <js>"xxx/yyy/zzz"</js> are considered identical.
@@ -105,11 +109,12 @@ import org.apache.juneau.parser.*;
* + <js>"}"</js>
* );
* johnSmith.put(<js>"additionalInfo/medicalInfo"</js>, medicalInfo);
+ * </p>
+ *
* <p>
* In the special case of collections/arrays of maps/beans, a special XPath-like selector notation can be used in lieu
* of index numbers on GET requests to return a map/bean with a specified attribute value.
- * <br>
- * The syntax is {@code @attr=val}, where attr is the attribute name on the child map, and val is the matching value.
+ * <br>The syntax is {@code @attr=val}, where attr is the attribute name on the child map, and val is the matching value.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -459,9 +464,12 @@ public final class PojoRest {
* <p>
* Can be any of the following formats:
* <ul class='spaced-list'>
- * <li>Method name only. e.g. <js>"myMethod"</js>.
- * <li>Method name with class names. e.g. <js>"myMethod(String,int)"</js>.
- * <li>Method name with fully-qualified class names. e.g. <js>"myMethod(java.util.String,int)"</js>.
+ * <li>
+ * Method name only. e.g. <js>"myMethod"</js>.
+ * <li>
+ * Method name with class names. e.g. <js>"myMethod(String,int)"</js>.
+ * <li>
+ * Method name with fully-qualified class names. e.g. <js>"myMethod(java.util.String,int)"</js>.
* </ul>
* <p>
* As a rule, use the simplest format needed to uniquely resolve a method.
@@ -473,11 +481,15 @@ public final class PojoRest {
* the underlying constructor is inaccessible.
* @throws IllegalArgumentException If one of the following occurs:
* <ul class='spaced-list'>
- * <li>The number of actual and formal parameters differ.
- * <li>An unwrapping conversion for primitive arguments fails.
- * <li>A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
+ * <li>
+ * The number of actual and formal parameters differ.
+ * <li>
+ * An unwrapping conversion for primitive arguments fails.
+ * <li>
+ * A parameter value cannot be converted to the corresponding formal parameter type by a method invocation
* conversion.
- * <li>The constructor pertains to an enum type.
+ * <li>
+ * The constructor pertains to an enum type.
* </ul>
* @throws InvocationTargetException If the underlying constructor throws an exception.
* @throws ParseException If the input contains a syntax error or is malformed.
@@ -538,11 +550,11 @@ public final class PojoRest {
* If the list does not already exist, it will be created.
* <p>
* This method expands the POJO model as necessary to create the new element.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>You can only post to three types of nodes:
- * <ul class='spaced-list'>
+ * <ul>
* <li>{@link List Lists}
* <li>{@link Map Maps} containing integers as keys (i.e sparse arrays)
* <li>arrays
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java b/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java
index 8e7569b..7de95ff 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/PojoRestException.java
@@ -24,11 +24,14 @@ import org.apache.juneau.*;
* <p>
* The status code is an HTTP-equivalent code. It will be one of the following:
* <ul class='spaced-list'>
- * <li>{@link HttpURLConnection#HTTP_BAD_REQUEST HTTP_BAD_REQUEST}
+ * <li>
+ * {@link HttpURLConnection#HTTP_BAD_REQUEST HTTP_BAD_REQUEST}
* - Attempting to do something impossible.
- * <li>{@link HttpURLConnection#HTTP_NOT_FOUND HTTP_NOT_FOUND}
+ * <li>
+ * {@link HttpURLConnection#HTTP_NOT_FOUND HTTP_NOT_FOUND}
* - Attempting to access a non-existent node in the tree.
- * <li>{@link HttpURLConnection#HTTP_FORBIDDEN HTTP_FORBIDDEN}
+ * <li>
+ * {@link HttpURLConnection#HTTP_FORBIDDEN HTTP_FORBIDDEN}
* - Attempting to overwrite the root object.
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/utils/SearchArgs.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/utils/SearchArgs.java b/juneau-core/src/main/java/org/apache/juneau/utils/SearchArgs.java
index e8371da..3fd9100 100644
--- a/juneau-core/src/main/java/org/apache/juneau/utils/SearchArgs.java
+++ b/juneau-core/src/main/java/org/apache/juneau/utils/SearchArgs.java
@@ -142,18 +142,22 @@ public class SearchArgs {
/**
* Specifies the sort arguments.
+ *
* <p>
* The sort argument is a simple comma-delimited list of column names.
* <br>Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order.
* <br>No suffix implies ascending order.
+ *
* <p>
* For example:
* <p class='bcode'>
* <jc>// Order by column1 ascending, then column2 descending.</jc>
* builder.sort(<js>"column1, column2-"</js>);
* </p>
+ *
* <p>
* Note that the order of the order arguments is important.
+ *
* <p>
* Whitespace is trimmed from column names.
*
@@ -169,9 +173,11 @@ public class SearchArgs {
/**
* Specifies the sort arguments.
+ *
* <p>
- * <br>Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order.
+ * Column names can be suffixed with <js>'+'</js> or <js>'-'</js> to indicate ascending or descending order.
* <br>No suffix implies ascending order.
+ *
* <p>
* Note that the order of the sort is important.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java b/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java
index 31f9cc7..396cbb3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/NamespaceFactory.java
@@ -54,7 +54,7 @@ public final class NamespaceFactory {
* Converts the specified object into a {@link Namespace} object.
* <p>
* Can be any of following types:
- * <ul class='spaced-list'>
+ * <ul>
* <li>A {@link Namespace} object
* <li>A JSON string containing a single key/value pair indicating the name/URI mapping.
* <li>A <code>Map</code> containing a single key/value pair indicating the name/URI mapping.
@@ -86,7 +86,7 @@ public final class NamespaceFactory {
* Converts the specified object into an array of {@link Namespace} object.
* <p>
* Can be any of following types:
- * <ul class='spaced-list'>
+ * <ul>
* <li>A {@link Namespace} array
* <li>A JSON string with key/value pairs indicating name/URI pairs.
* <li>A <code>Map</code> with key/value pairs indicating name/URI pairs.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
index 8e1a348..d6b287d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
@@ -69,7 +69,7 @@ public class XmlParserBuilder extends ParserBuilder {
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>XML_validating</jsf>, value)</code>.
@@ -94,7 +94,7 @@ public class XmlParserBuilder extends ParserBuilder {
* </ul>
* <p>
* Associates an {@link XMLReporter} with this parser.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Reporters are not copied to new parsers during a clone.
@@ -102,7 +102,7 @@ public class XmlParserBuilder extends ParserBuilder {
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>XML_reporter</jsf>, value)</code>.
@@ -130,7 +130,7 @@ public class XmlParserBuilder extends ParserBuilder {
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>XML_resolver</jsf>, value)</code>.
@@ -158,7 +158,7 @@ public class XmlParserBuilder extends ParserBuilder {
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>XML_eventAllocator</jsf>, value)</code>.
@@ -198,7 +198,7 @@ public class XmlParserBuilder extends ParserBuilder {
* <td><code>{ root: { a:<js>'foobar'</js> }}</code></td>
* </tr>
* </table>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>XML_preserveRootElement</jsf>, value)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java
index d7f36fc..fdeea43 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlParserContext.java
@@ -28,12 +28,15 @@ import org.apache.juneau.parser.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
* - Properties associated with handling beans on serializers and parsers.
- * <ul>
- * <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
- * - Configurable properties common to all parsers.
- * </ul>
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
+ * - Configurable properties common to all parsers.
+ * </ul>
+ * </li>
* </ul>
*/
public class XmlParserContext extends ParserContext {
@@ -64,7 +67,7 @@ public class XmlParserContext extends ParserContext {
* </ul>
* <p>
* Associates an {@link XMLReporter} with this parser.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Reporters are not copied to new parsers during a clone.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java
index 4c9d0a6..8d75f98 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializer.java
@@ -119,7 +119,7 @@ import org.apache.juneau.xml.annotation.*;
* <h6 class='topic'>Behavior-specific subclasses</h6>
* <p>
* The following direct subclasses are provided for convenience:
- * <ul class='spaced-list'>
+ * <ul>
* <li>{@link Sq} - Default serializer, single quotes.
* <li>{@link SqReadable} - Default serializer, single quotes, whitespace added.
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java
index 6592980..af35156 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java
@@ -62,7 +62,7 @@ public class XmlSerializerBuilder extends SerializerBuilder {
* </ul>
* <p>
* If not enabled, XML output will not contain any namespaces regardless of any other settings.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>XML_enableNamespaces</jsf>, value)</code>.
@@ -105,14 +105,14 @@ public class XmlSerializerBuilder extends SerializerBuilder {
* the root element is serialized.
* <p>
* This setting is ignored if {@link XmlSerializerContext#XML_enableNamespaces} is not enabled.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Auto-detection of namespaces can be costly performance-wise.
* In high-performance environments, it's recommended that namespace detection be disabled, and that
* namespaces be manually defined through the {@link XmlSerializerContext#XML_namespaces} property.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>XML_autoDetectNamespaces</jsf>, value)</code>.
@@ -140,7 +140,7 @@ public class XmlSerializerBuilder extends SerializerBuilder {
* Use this setting to add {@code xmlns:x} attributes to the root element for the default and all mapped namespaces.
* <p>
* This setting is ignored if {@link XmlSerializerContext#XML_enableNamespaces} is not enabled.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>XML_addNamespaceUrisToRoot</jsf>, value)</code>.
@@ -166,7 +166,7 @@ public class XmlSerializerBuilder extends SerializerBuilder {
* </ul>
* <p>
* Specifies the default namespace URI for this document.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>XML_defaultNamespace</jsf>, value)</code>.
@@ -193,7 +193,7 @@ public class XmlSerializerBuilder extends SerializerBuilder {
* <p>
* Specifies the namespace for the <code>XMLSchema</code> namespace, used by the schema generated by the
* {@link XmlSchemaSerializer} class.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>XML_xsNamespace</jsf>, value)</code>.
@@ -219,7 +219,7 @@ public class XmlSerializerBuilder extends SerializerBuilder {
* </ul>
* <p>
* The default list of namespaces associated with this serializer.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>XML_namespaces</jsf>, values)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerContext.java
index cd11328..450ad36 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlSerializerContext.java
@@ -25,13 +25,15 @@ import org.apache.juneau.serializer.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
* - Properties associated with handling beans on serializers and parsers.
- * <ul>
- * <li class='jc'><a class="doclink"
- * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
- * - Configurable properties common to all serializers.
- * </ul>
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
+ * </ul>
+ * </li>
* </ul>
*/
public class XmlSerializerContext extends SerializerContext {
@@ -69,7 +71,7 @@ public class XmlSerializerContext extends SerializerContext {
* the root element is serialized.
* <p>
* This setting is ignored if {@link #XML_enableNamespaces} is not enabled.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Auto-detection of namespaces can be costly performance-wise.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java
index 43d0835..2b1160e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlUtils.java
@@ -164,18 +164,18 @@ public final class XmlUtils {
/**
* Encodes the specified element text and sends the results to the specified writer.
+ *
* <p>
* Encodes any invalid XML text characters to <code>_x####_</code> sequences and sends the response to the specified
* writer.
- * <br>
- * Encodes <js>'&'</js>, <js>'<'</js>, and <js>'>'</js> as XML entities.
- * <br>
- * Encodes invalid XML text characters to <code>_x####_</code> sequences.
+ * <br>Encodes <js>'&'</js>, <js>'<'</js>, and <js>'>'</js> as XML entities.
+ * <br>Encodes invalid XML text characters to <code>_x####_</code> sequences.
*
* @param w The writer to send the output to.
* @param o The object being encoded.
* @param trim Trim the text before serializing it.
- * @param preserveWhitespace Specifies whether we're in preserve-whitespace mode.
+ * @param preserveWhitespace
+ * Specifies whether we're in preserve-whitespace mode.
* (e.g. {@link XmlFormat#MIXED_PWS} or {@link XmlFormat#TEXT_PWS}.
* If <jk>true</jk>, leading and trailing whitespace characters will be encoded.
* @return The same writer passed in.
@@ -300,13 +300,12 @@ public final class XmlUtils {
/**
* Encodes the specified attribute value and sends the results to the specified writer.
+ *
* <p>
* Encodes any invalid XML text characters to <code>_x####_</code> sequences and sends the response to the specified
* writer.
- * <br>
- * Encodes <js>'&'</js>, <js>'<'</js>, <js>'>'</js>, <js>'"'</js>, and <js>'\''</js> as XML entities.
- * <br>
- * Encodes invalid XML text characters to <code>_x####_</code> sequences.
+ * <br>Encodes <js>'&'</js>, <js>'<'</js>, <js>'>'</js>, <js>'"'</js>, and <js>'\''</js> as XML entities.
+ * <br>Encodes invalid XML text characters to <code>_x####_</code> sequences.
*
* @param w The writer to send the output to.
* @param o The object being encoded.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/xml/XmlWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/XmlWriter.java b/juneau-core/src/main/java/org/apache/juneau/xml/XmlWriter.java
index cb00878..93d6248 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/XmlWriter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/XmlWriter.java
@@ -21,7 +21,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Specialized writer for serializing XML.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This class is not intended for external use.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java
index 97e2d92..596151d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java
+++ b/juneau-core/src/main/java/org/apache/juneau/xml/annotation/Xml.java
@@ -23,7 +23,7 @@ import java.lang.annotation.*;
* Can be applied to Java packages, types, fields, and methods.
* <p>
* Can be used for the following:
- * <ul class='spaced-list'>
+ * <ul>
* <li>Override the child element name on the XML representation of collection or array properties.
* <li>Specify the XML namespace on a package, class, or method.
* <li>Override the XML format on a POJO.
@@ -75,9 +75,11 @@ public @interface Xml {
/**
* Sets the XML prefix of this property or class.
* <ul class='spaced-list'>
- * <li>When applied to a {@link ElementType#TYPE}, namespace is applied to all properties in the class, and all
+ * <li>
+ * When applied to a {@link ElementType#TYPE}, namespace is applied to all properties in the class, and all
* subclasses of the class.
- * <li>When applied to bean properties on {@link ElementType#METHOD} and {@link ElementType#FIELD}, applies
+ * <li>
+ * When applied to bean properties on {@link ElementType#METHOD} and {@link ElementType#FIELD}, applies
* to the bean property.
* </ul>
* <p>
[19/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
Clean up javadocs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-juneau/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-juneau/commit/0d913b38
Tree: http://git-wip-us.apache.org/repos/asf/incubator-juneau/tree/0d913b38
Diff: http://git-wip-us.apache.org/repos/asf/incubator-juneau/diff/0d913b38
Branch: refs/heads/master
Commit: 0d913b38fb2cbb2d3e04faf7883e0ac8c046e05e
Parents: b59ffb4
Author: JamesBognar <ja...@apache.org>
Authored: Mon Jun 26 22:38:04 2017 -0400
Committer: JamesBognar <ja...@apache.org>
Committed: Mon Jun 26 22:38:04 2017 -0400
----------------------------------------------------------------------
.../apache/juneau/jena/RdfCommonContext.java | 100 +-
.../java/org/apache/juneau/jena/RdfParser.java | 12 +-
.../apache/juneau/jena/RdfParserBuilder.java | 55 +-
.../apache/juneau/jena/RdfParserContext.java | 19 +-
.../juneau/jena/RdfSerializerBuilder.java | 61 +-
.../juneau/jena/RdfSerializerContext.java | 19 +-
.../org/apache/juneau/jena/annotation/Rdf.java | 5 +-
.../java/org/apache/juneau/jena/package.html | 182 ++-
.../apache/juneau/transforms/DateSwapTest.java | 4 +-
.../java/org/apache/juneau/BeanContext.java | 263 +++-
.../org/apache/juneau/BeanDictionaryList.java | 16 +-
.../org/apache/juneau/BeanDictionaryMap.java | 6 +-
.../main/java/org/apache/juneau/BeanMap.java | 114 +-
.../java/org/apache/juneau/BeanMapEntry.java | 25 +-
.../main/java/org/apache/juneau/BeanMeta.java | 28 +-
.../org/apache/juneau/BeanMetaExtended.java | 7 +-
.../org/apache/juneau/BeanMetaFiltered.java | 4 +-
.../org/apache/juneau/BeanPropertyMeta.java | 50 +-
.../java/org/apache/juneau/BeanSession.java | 29 +-
.../main/java/org/apache/juneau/ClassMeta.java | 24 +-
.../main/java/org/apache/juneau/CoreObject.java | 4 +-
.../org/apache/juneau/CoreObjectBuilder.java | 121 +-
.../java/org/apache/juneau/PropertyStore.java | 176 ++-
.../java/org/apache/juneau/annotation/Bean.java | 11 +-
.../juneau/annotation/BeanConstructor.java | 3 +-
.../apache/juneau/annotation/BeanProperty.java | 31 +-
.../apache/juneau/annotation/NameProperty.java | 5 +-
.../juneau/annotation/ParentProperty.java | 1 +
.../org/apache/juneau/annotation/Produces.java | 6 +-
.../org/apache/juneau/csv/CsvParserContext.java | 6 +-
.../apache/juneau/csv/CsvSerializerContext.java | 6 +-
.../apache/juneau/doc-files/AddressBook.html | 3 +-
.../main/java/org/apache/juneau/dto/Link.java | 3 +-
.../org/apache/juneau/dto/atom/AtomBuilder.java | 15 +-
.../org/apache/juneau/dto/atom/Category.java | 17 +-
.../java/org/apache/juneau/dto/atom/Common.java | 17 +-
.../org/apache/juneau/dto/atom/CommonEntry.java | 16 +-
.../org/apache/juneau/dto/atom/Content.java | 16 +-
.../java/org/apache/juneau/dto/atom/Entry.java | 17 +-
.../java/org/apache/juneau/dto/atom/Feed.java | 17 +-
.../org/apache/juneau/dto/atom/Generator.java | 17 +-
.../java/org/apache/juneau/dto/atom/Icon.java | 17 +-
.../java/org/apache/juneau/dto/atom/Id.java | 17 +-
.../java/org/apache/juneau/dto/atom/Link.java | 17 +-
.../java/org/apache/juneau/dto/atom/Logo.java | 23 +-
.../java/org/apache/juneau/dto/atom/Person.java | 17 +-
.../java/org/apache/juneau/dto/atom/Source.java | 17 +-
.../java/org/apache/juneau/dto/atom/Text.java | 17 +-
.../java/org/apache/juneau/dto/atom/Utils.java | 15 +-
.../org/apache/juneau/dto/atom/package.html | 6 +-
.../org/apache/juneau/dto/cognos/package.html | 6 +
.../java/org/apache/juneau/dto/html5/A.java | 11 +-
.../java/org/apache/juneau/dto/html5/Abbr.java | 12 +-
.../org/apache/juneau/dto/html5/Address.java | 12 +-
.../java/org/apache/juneau/dto/html5/Area.java | 12 +-
.../org/apache/juneau/dto/html5/Article.java | 12 +-
.../java/org/apache/juneau/dto/html5/Aside.java | 12 +-
.../java/org/apache/juneau/dto/html5/Audio.java | 12 +-
.../java/org/apache/juneau/dto/html5/B.java | 12 +-
.../java/org/apache/juneau/dto/html5/Base.java | 12 +-
.../java/org/apache/juneau/dto/html5/Bdi.java | 12 +-
.../java/org/apache/juneau/dto/html5/Bdo.java | 12 +-
.../org/apache/juneau/dto/html5/Blockquote.java | 12 +-
.../java/org/apache/juneau/dto/html5/Body.java | 12 +-
.../java/org/apache/juneau/dto/html5/Br.java | 12 +-
.../org/apache/juneau/dto/html5/Button.java | 12 +-
.../org/apache/juneau/dto/html5/Canvas.java | 12 +-
.../org/apache/juneau/dto/html5/Caption.java | 12 +-
.../java/org/apache/juneau/dto/html5/Cite.java | 12 +-
.../java/org/apache/juneau/dto/html5/Code.java | 12 +-
.../java/org/apache/juneau/dto/html5/Col.java | 12 +-
.../org/apache/juneau/dto/html5/Colgroup.java | 12 +-
.../java/org/apache/juneau/dto/html5/Data.java | 12 +-
.../org/apache/juneau/dto/html5/Datalist.java | 12 +-
.../java/org/apache/juneau/dto/html5/Dd.java | 12 +-
.../java/org/apache/juneau/dto/html5/Del.java | 12 +-
.../java/org/apache/juneau/dto/html5/Dfn.java | 12 +-
.../java/org/apache/juneau/dto/html5/Div.java | 12 +-
.../java/org/apache/juneau/dto/html5/Dl.java | 12 +-
.../java/org/apache/juneau/dto/html5/Dt.java | 12 +-
.../java/org/apache/juneau/dto/html5/Em.java | 12 +-
.../java/org/apache/juneau/dto/html5/Embed.java | 12 +-
.../org/apache/juneau/dto/html5/Fieldset.java | 14 +-
.../org/apache/juneau/dto/html5/Figcaption.java | 12 +-
.../org/apache/juneau/dto/html5/Figure.java | 12 +-
.../org/apache/juneau/dto/html5/Footer.java | 15 +-
.../java/org/apache/juneau/dto/html5/Form.java | 12 +-
.../java/org/apache/juneau/dto/html5/H1.java | 12 +-
.../java/org/apache/juneau/dto/html5/H2.java | 12 +-
.../java/org/apache/juneau/dto/html5/H3.java | 12 +-
.../java/org/apache/juneau/dto/html5/H4.java | 12 +-
.../java/org/apache/juneau/dto/html5/H5.java | 12 +-
.../java/org/apache/juneau/dto/html5/H6.java | 12 +-
.../java/org/apache/juneau/dto/html5/Head.java | 12 +-
.../org/apache/juneau/dto/html5/Header.java | 12 +-
.../java/org/apache/juneau/dto/html5/Hr.java | 12 +-
.../java/org/apache/juneau/dto/html5/Html.java | 12 +-
.../juneau/dto/html5/HtmlBeanDictionary.java | 12 +-
.../apache/juneau/dto/html5/HtmlBuilder.java | 11 +-
.../apache/juneau/dto/html5/HtmlElement.java | 11 +-
.../juneau/dto/html5/HtmlElementContainer.java | 11 +-
.../juneau/dto/html5/HtmlElementMixed.java | 11 +-
.../juneau/dto/html5/HtmlElementRawText.java | 11 +-
.../juneau/dto/html5/HtmlElementText.java | 11 +-
.../juneau/dto/html5/HtmlElementVoid.java | 11 +-
.../java/org/apache/juneau/dto/html5/I.java | 12 +-
.../org/apache/juneau/dto/html5/Iframe.java | 12 +-
.../java/org/apache/juneau/dto/html5/Img.java | 11 +-
.../java/org/apache/juneau/dto/html5/Input.java | 12 +-
.../java/org/apache/juneau/dto/html5/Ins.java | 12 +-
.../java/org/apache/juneau/dto/html5/Kbd.java | 12 +-
.../org/apache/juneau/dto/html5/Keygen.java | 12 +-
.../java/org/apache/juneau/dto/html5/Label.java | 12 +-
.../org/apache/juneau/dto/html5/Legend.java | 14 +-
.../java/org/apache/juneau/dto/html5/Li.java | 12 +-
.../java/org/apache/juneau/dto/html5/Link.java | 12 +-
.../java/org/apache/juneau/dto/html5/Main.java | 12 +-
.../java/org/apache/juneau/dto/html5/Map.java | 12 +-
.../java/org/apache/juneau/dto/html5/Mark.java | 12 +-
.../java/org/apache/juneau/dto/html5/Meta.java | 12 +-
.../java/org/apache/juneau/dto/html5/Meter.java | 12 +-
.../java/org/apache/juneau/dto/html5/Nav.java | 12 +-
.../org/apache/juneau/dto/html5/Noscript.java | 12 +-
.../org/apache/juneau/dto/html5/Object2.java | 12 +-
.../java/org/apache/juneau/dto/html5/Ol.java | 12 +-
.../org/apache/juneau/dto/html5/Optgroup.java | 12 +-
.../org/apache/juneau/dto/html5/Option.java | 12 +-
.../org/apache/juneau/dto/html5/Output.java | 12 +-
.../java/org/apache/juneau/dto/html5/P.java | 12 +-
.../java/org/apache/juneau/dto/html5/Param.java | 12 +-
.../java/org/apache/juneau/dto/html5/Pre.java | 12 +-
.../org/apache/juneau/dto/html5/Progress.java | 12 +-
.../java/org/apache/juneau/dto/html5/Q.java | 12 +-
.../java/org/apache/juneau/dto/html5/Rb.java | 12 +-
.../java/org/apache/juneau/dto/html5/Rp.java | 12 +-
.../java/org/apache/juneau/dto/html5/Rt.java | 12 +-
.../java/org/apache/juneau/dto/html5/Rtc.java | 12 +-
.../java/org/apache/juneau/dto/html5/Ruby.java | 12 +-
.../java/org/apache/juneau/dto/html5/S.java | 12 +-
.../java/org/apache/juneau/dto/html5/Samp.java | 12 +-
.../org/apache/juneau/dto/html5/Script.java | 12 +-
.../org/apache/juneau/dto/html5/Section.java | 12 +-
.../org/apache/juneau/dto/html5/Select.java | 12 +-
.../java/org/apache/juneau/dto/html5/Small.java | 12 +-
.../org/apache/juneau/dto/html5/Source.java | 12 +-
.../java/org/apache/juneau/dto/html5/Span.java | 12 +-
.../org/apache/juneau/dto/html5/Strong.java | 12 +-
.../java/org/apache/juneau/dto/html5/Style.java | 12 +-
.../java/org/apache/juneau/dto/html5/Sub.java | 12 +-
.../java/org/apache/juneau/dto/html5/Sup.java | 12 +-
.../java/org/apache/juneau/dto/html5/Table.java | 12 +-
.../java/org/apache/juneau/dto/html5/Tbody.java | 12 +-
.../java/org/apache/juneau/dto/html5/Td.java | 12 +-
.../org/apache/juneau/dto/html5/Template.java | 12 +-
.../org/apache/juneau/dto/html5/Textarea.java | 12 +-
.../java/org/apache/juneau/dto/html5/Tfoot.java | 12 +-
.../java/org/apache/juneau/dto/html5/Th.java | 12 +-
.../java/org/apache/juneau/dto/html5/Thead.java | 12 +-
.../java/org/apache/juneau/dto/html5/Time.java | 12 +-
.../java/org/apache/juneau/dto/html5/Title.java | 12 +-
.../java/org/apache/juneau/dto/html5/Tr.java | 12 +-
.../java/org/apache/juneau/dto/html5/Track.java | 12 +-
.../java/org/apache/juneau/dto/html5/U.java | 12 +-
.../java/org/apache/juneau/dto/html5/Ul.java | 12 +-
.../java/org/apache/juneau/dto/html5/Var.java | 12 +-
.../java/org/apache/juneau/dto/html5/Video.java | 12 +-
.../java/org/apache/juneau/dto/html5/Wbr.java | 12 +-
.../org/apache/juneau/dto/html5/package.html | 3 +-
.../apache/juneau/dto/jsonschema/JsonType.java | 16 +-
.../juneau/dto/jsonschema/JsonTypeArray.java | 17 +-
.../apache/juneau/dto/jsonschema/Schema.java | 41 +-
.../juneau/dto/jsonschema/SchemaArray.java | 17 +-
.../apache/juneau/dto/jsonschema/SchemaMap.java | 22 +-
.../juneau/dto/jsonschema/SchemaProperty.java | 17 +-
.../jsonschema/SchemaPropertySimpleArray.java | 16 +-
.../apache/juneau/dto/jsonschema/SchemaRef.java | 16 +-
.../apache/juneau/dto/jsonschema/package.html | 25 +-
.../org/apache/juneau/dto/swagger/Contact.java | 15 +-
.../dto/swagger/ExternalDocumentation.java | 15 +-
.../apache/juneau/dto/swagger/HeaderInfo.java | 15 +-
.../org/apache/juneau/dto/swagger/Info.java | 15 +-
.../org/apache/juneau/dto/swagger/Items.java | 15 +-
.../org/apache/juneau/dto/swagger/License.java | 15 +-
.../apache/juneau/dto/swagger/Operation.java | 15 +-
.../juneau/dto/swagger/ParameterInfo.java | 15 +-
.../apache/juneau/dto/swagger/ResponseInfo.java | 15 +-
.../apache/juneau/dto/swagger/SchemaInfo.java | 15 +-
.../juneau/dto/swagger/SecurityScheme.java | 15 +-
.../org/apache/juneau/dto/swagger/Swagger.java | 15 +-
.../juneau/dto/swagger/SwaggerBuilder.java | 27 +-
.../juneau/dto/swagger/SwaggerElement.java | 15 +-
.../java/org/apache/juneau/dto/swagger/Tag.java | 15 +-
.../java/org/apache/juneau/dto/swagger/Xml.java | 15 +-
.../org/apache/juneau/dto/swagger/package.html | 3 +-
.../juneau/html/HtmlDocSerializerContext.java | 28 +-
.../apache/juneau/html/HtmlParserContext.java | 15 +-
.../org/apache/juneau/html/HtmlSerializer.java | 21 +-
.../juneau/html/HtmlSerializerBuilder.java | 25 +-
.../juneau/html/HtmlSerializerContext.java | 30 +-
.../java/org/apache/juneau/html/package.html | 3 +
.../java/org/apache/juneau/http/Accept.java | 12 +-
.../org/apache/juneau/http/AcceptCharset.java | 6 +-
.../org/apache/juneau/http/AcceptEncoding.java | 6 +-
.../org/apache/juneau/http/AcceptLanguage.java | 6 +-
.../org/apache/juneau/http/AcceptRanges.java | 6 +-
.../main/java/org/apache/juneau/http/Age.java | 6 +-
.../main/java/org/apache/juneau/http/Allow.java | 6 +-
.../org/apache/juneau/http/Authorization.java | 6 +-
.../org/apache/juneau/http/CacheControl.java | 6 +-
.../java/org/apache/juneau/http/Connection.java | 6 +-
.../java/org/apache/juneau/http/Constants.java | 6 +-
.../org/apache/juneau/http/ContentEncoding.java | 6 +-
.../apache/juneau/http/ContentEncodingEnum.java | 6 +-
.../org/apache/juneau/http/ContentLanguage.java | 6 +-
.../org/apache/juneau/http/ContentLength.java | 6 +-
.../org/apache/juneau/http/ContentLocation.java | 6 +-
.../org/apache/juneau/http/ContentRange.java | 6 +-
.../org/apache/juneau/http/ContentType.java | 14 +-
.../main/java/org/apache/juneau/http/Date.java | 6 +-
.../main/java/org/apache/juneau/http/ETag.java | 6 +-
.../org/apache/juneau/http/EntityValidator.java | 6 +-
.../java/org/apache/juneau/http/Expect.java | 6 +-
.../java/org/apache/juneau/http/Expires.java | 6 +-
.../main/java/org/apache/juneau/http/From.java | 6 +-
.../java/org/apache/juneau/http/HeaderDate.java | 6 +-
.../juneau/http/HeaderEntityValidator.java | 6 +-
.../juneau/http/HeaderEntityValidatorArray.java | 6 +-
.../java/org/apache/juneau/http/HeaderEnum.java | 9 +-
.../org/apache/juneau/http/HeaderInteger.java | 6 +-
.../apache/juneau/http/HeaderRangeArray.java | 6 +-
.../org/apache/juneau/http/HeaderString.java | 6 +-
.../apache/juneau/http/HeaderStringArray.java | 6 +-
.../java/org/apache/juneau/http/HeaderUri.java | 6 +-
.../main/java/org/apache/juneau/http/Host.java | 6 +-
.../java/org/apache/juneau/http/HttpMethod.java | 6 +-
.../java/org/apache/juneau/http/IfMatch.java | 6 +-
.../org/apache/juneau/http/IfModifiedSince.java | 6 +-
.../org/apache/juneau/http/IfNoneMatch.java | 6 +-
.../java/org/apache/juneau/http/IfRange.java | 6 +-
.../apache/juneau/http/IfUnmodifiedSince.java | 6 +-
.../org/apache/juneau/http/LastModified.java | 6 +-
.../java/org/apache/juneau/http/Location.java | 6 +-
.../org/apache/juneau/http/MaxForwards.java | 6 +-
.../java/org/apache/juneau/http/MediaType.java | 8 +-
.../org/apache/juneau/http/MediaTypeRange.java | 6 +-
.../java/org/apache/juneau/http/Pragma.java | 6 +-
.../apache/juneau/http/ProxyAuthenticate.java | 6 +-
.../apache/juneau/http/ProxyAuthorization.java | 6 +-
.../main/java/org/apache/juneau/http/Range.java | 6 +-
.../java/org/apache/juneau/http/Referer.java | 6 +-
.../java/org/apache/juneau/http/RetryAfter.java | 6 +-
.../java/org/apache/juneau/http/Server.java | 6 +-
.../org/apache/juneau/http/StringRange.java | 6 +-
.../main/java/org/apache/juneau/http/TE.java | 6 +-
.../java/org/apache/juneau/http/Trailer.java | 6 +-
.../apache/juneau/http/TransferEncoding.java | 6 +-
.../java/org/apache/juneau/http/Upgrade.java | 6 +-
.../java/org/apache/juneau/http/UserAgent.java | 6 +-
.../main/java/org/apache/juneau/http/Vary.java | 6 +-
.../main/java/org/apache/juneau/http/Via.java | 6 +-
.../java/org/apache/juneau/http/Warning.java | 6 +-
.../org/apache/juneau/http/WwwAuthenticate.java | 6 +-
.../java/org/apache/juneau/ini/ConfigFile.java | 61 +-
.../apache/juneau/ini/ConfigFileBuilder.java | 27 +-
.../java/org/apache/juneau/ini/package.html | 80 +-
.../apache/juneau/internal/IdentityList.java | 8 +-
.../org/apache/juneau/internal/KeywordSet.java | 6 +-
.../org/apache/juneau/internal/StringUtils.java | 4 +-
.../java/org/apache/juneau/json/JsonParser.java | 57 +-
.../apache/juneau/json/JsonParserContext.java | 15 +-
.../org/apache/juneau/json/JsonSerializer.java | 30 +-
.../juneau/json/JsonSerializerBuilder.java | 4 +-
.../juneau/json/JsonSerializerContext.java | 12 +-
.../java/org/apache/juneau/json/JsonWriter.java | 2 +-
.../org/apache/juneau/json/annotation/Json.java | 3 +-
.../java/org/apache/juneau/json/package.html | 178 +--
.../juneau/msgpack/MsgPackInputStream.java | 2 +-
.../juneau/msgpack/MsgPackOutputStream.java | 2 +-
.../juneau/msgpack/MsgPackParserContext.java | 11 +-
.../msgpack/MsgPackSerializerContext.java | 14 +-
.../java/org/apache/juneau/parser/Parser.java | 17 +-
.../org/apache/juneau/parser/ParserBuilder.java | 8 +-
.../org/apache/juneau/parser/ParserGroup.java | 12 +-
.../java/org/apache/juneau/parser/package.html | 15 +-
.../java/org/apache/juneau/remoteable/Body.java | 26 +-
.../org/apache/juneau/remoteable/FormData.java | 21 +-
.../apache/juneau/remoteable/FormDataIfNE.java | 7 +-
.../org/apache/juneau/remoteable/Header.java | 24 +-
.../apache/juneau/remoteable/HeaderIfNE.java | 7 +-
.../java/org/apache/juneau/remoteable/Path.java | 24 +-
.../org/apache/juneau/remoteable/Query.java | 25 +-
.../org/apache/juneau/remoteable/QueryIfNE.java | 7 +-
.../apache/juneau/remoteable/RemoteMethod.java | 13 +-
.../juneau/remoteable/RemoteMethodArg.java | 7 +-
.../apache/juneau/remoteable/Remoteable.java | 8 +-
.../juneau/remoteable/RemoteableMeta.java | 7 +-
.../juneau/remoteable/RemoteableMethodMeta.java | 7 +-
.../apache/juneau/remoteable/RequestBean.java | 9 +-
.../juneau/serializer/SerializerBuilder.java | 38 +-
.../juneau/serializer/SerializerContext.java | 16 +-
.../juneau/serializer/SerializerGroup.java | 15 +-
.../juneau/serializer/SerializerSession.java | 12 +-
.../juneau/serializer/WriterSerializer.java | 6 +-
.../org/apache/juneau/serializer/package.html | 22 +-
.../juneau/soap/SoapXmlSerializerBuilder.java | 2 +-
.../juneau/soap/SoapXmlSerializerContext.java | 14 +-
.../java/org/apache/juneau/svl/VarResolver.java | 5 +-
.../java/org/apache/juneau/svl/package.html | 75 +-
.../java/org/apache/juneau/svl/vars/IfVar.java | 6 +-
.../org/apache/juneau/transform/PojoSwap.java | 51 +-
.../apache/juneau/transform/SurrogateSwap.java | 9 +-
.../org/apache/juneau/transform/package.html | 45 +-
.../apache/juneau/transforms/CalendarSwap.java | 2 +-
.../org/apache/juneau/transforms/DateSwap.java | 2 +-
.../apache/juneau/transforms/ReaderSwap.java | 2 +-
.../org/apache/juneau/uon/UonParserBuilder.java | 2 +-
.../org/apache/juneau/uon/UonParserContext.java | 13 +-
.../apache/juneau/uon/UonSerializerBuilder.java | 2 +-
.../apache/juneau/uon/UonSerializerContext.java | 38 +-
.../java/org/apache/juneau/uon/UonWriter.java | 2 +-
.../java/org/apache/juneau/uon/package.html | 173 +--
.../juneau/urlencoding/UrlEncodingContext.java | 2 +-
.../urlencoding/UrlEncodingParserBuilder.java | 4 +-
.../UrlEncodingSerializerBuilder.java | 14 +-
.../org/apache/juneau/urlencoding/package.html | 173 +--
.../main/java/org/apache/juneau/utils/Args.java | 2 +-
.../org/apache/juneau/utils/MessageBundle.java | 18 +-
.../org/apache/juneau/utils/ObjectUtils.java | 24 +-
.../apache/juneau/utils/PojoIntrospector.java | 25 +-
.../java/org/apache/juneau/utils/PojoQuery.java | 51 +-
.../java/org/apache/juneau/utils/PojoRest.java | 52 +-
.../apache/juneau/utils/PojoRestException.java | 9 +-
.../org/apache/juneau/utils/SearchArgs.java | 8 +-
.../org/apache/juneau/xml/NamespaceFactory.java | 4 +-
.../org/apache/juneau/xml/XmlParserBuilder.java | 12 +-
.../org/apache/juneau/xml/XmlParserContext.java | 15 +-
.../org/apache/juneau/xml/XmlSerializer.java | 2 +-
.../apache/juneau/xml/XmlSerializerBuilder.java | 14 +-
.../apache/juneau/xml/XmlSerializerContext.java | 16 +-
.../java/org/apache/juneau/xml/XmlUtils.java | 17 +-
.../java/org/apache/juneau/xml/XmlWriter.java | 2 +-
.../org/apache/juneau/xml/annotation/Xml.java | 8 +-
.../java/org/apache/juneau/xml/package.html | 244 ++--
juneau-core/src/main/javadoc/overview.html | 1269 ++++++++++-------
.../juneau/examples/rest/TempDirResource.java | 4 +-
.../juneau/microservice/Microservice.java | 42 +-
.../apache/juneau/microservice/Resource.java | 12 +-
.../juneau/microservice/ResourceGroup.java | 12 +-
.../juneau/microservice/RestMicroservice.java | 23 +-
.../org/apache/juneau/microservice/package.html | 162 ++-
.../resources/DirectoryResource.java | 15 +-
.../resources/LogEntryFormatter.java | 10 +-
.../microservice/resources/LogParser.java | 8 +-
.../microservice/resources/LogsResource.java | 4 +-
.../eclipse-preferences/user-dictionary.txt | 55 +
.../juneau/rest/client/AllowAllRedirects.java | 5 +-
.../juneau/rest/client/NameValuePairs.java | 4 +-
.../juneau/rest/client/ResponsePattern.java | 34 +-
.../org/apache/juneau/rest/client/RestCall.java | 354 +++--
.../juneau/rest/client/RestCallException.java | 15 +-
.../juneau/rest/client/RestCallInterceptor.java | 5 +-
.../juneau/rest/client/RestCallLogger.java | 18 +-
.../apache/juneau/rest/client/RestClient.java | 230 ++--
.../juneau/rest/client/RestClientBuilder.java | 133 +-
.../juneau/rest/client/RestRequestEntity.java | 1 +
.../org/apache/juneau/rest/client/RetryOn.java | 6 +-
.../org/apache/juneau/rest/client/SSLOpts.java | 16 +-
.../rest/client/SimpleX509TrustManager.java | 2 +-
.../org/apache/juneau/rest/client/package.html | 231 ++--
.../org/apache/juneau/rest/jaxrs/package.html | 38 +-
.../java/org/apache/juneau/rest/CallMethod.java | 27 +-
.../java/org/apache/juneau/rest/CallRouter.java | 8 +-
.../org/apache/juneau/rest/ReaderResource.java | 8 +-
.../java/org/apache/juneau/rest/Redirect.java | 10 +-
.../org/apache/juneau/rest/RequestBody.java | 31 +-
.../org/apache/juneau/rest/RequestFormData.java | 52 +-
.../org/apache/juneau/rest/RequestHeaders.java | 32 +-
.../apache/juneau/rest/RequestPathMatch.java | 21 +-
.../org/apache/juneau/rest/RequestQuery.java | 78 +-
.../org/apache/juneau/rest/ResponseHandler.java | 43 +-
.../org/apache/juneau/rest/RestCallHandler.java | 33 +-
.../java/org/apache/juneau/rest/RestConfig.java | 159 ++-
.../org/apache/juneau/rest/RestContext.java | 117 +-
.../org/apache/juneau/rest/RestConverter.java | 18 +-
.../org/apache/juneau/rest/RestException.java | 6 +-
.../java/org/apache/juneau/rest/RestGuard.java | 23 +-
.../apache/juneau/rest/RestInfoProvider.java | 120 +-
.../java/org/apache/juneau/rest/RestLogger.java | 16 +-
.../org/apache/juneau/rest/RestMatcher.java | 15 +-
.../juneau/rest/RestMatcherReflecting.java | 5 +-
.../java/org/apache/juneau/rest/RestParam.java | 6 +-
.../org/apache/juneau/rest/RestRequest.java | 71 +-
.../juneau/rest/RestResourceResolver.java | 3 +-
.../org/apache/juneau/rest/RestResponse.java | 175 +--
.../org/apache/juneau/rest/RestServlet.java | 53 +-
.../apache/juneau/rest/RestServletDefault.java | 35 +-
.../java/org/apache/juneau/rest/RestUtils.java | 2 +-
.../org/apache/juneau/rest/StreamResource.java | 9 +-
.../org/apache/juneau/rest/UrlPathPattern.java | 7 +-
.../org/apache/juneau/rest/annotation/Body.java | 4 +-
.../apache/juneau/rest/annotation/FormData.java | 28 +-
.../juneau/rest/annotation/HasFormData.java | 12 +-
.../apache/juneau/rest/annotation/HasQuery.java | 10 +-
.../apache/juneau/rest/annotation/Header.java | 4 +-
.../apache/juneau/rest/annotation/HtmlDoc.java | 70 +-
.../apache/juneau/rest/annotation/Inherit.java | 2 +-
.../apache/juneau/rest/annotation/Messages.java | 4 +-
.../apache/juneau/rest/annotation/Method.java | 4 +-
.../juneau/rest/annotation/MethodSwagger.java | 41 +-
.../juneau/rest/annotation/Parameter.java | 40 +-
.../org/apache/juneau/rest/annotation/Path.java | 19 +-
.../juneau/rest/annotation/PathRemainder.java | 4 +-
.../juneau/rest/annotation/Properties.java | 14 +-
.../apache/juneau/rest/annotation/Property.java | 4 +-
.../apache/juneau/rest/annotation/Query.java | 36 +-
.../juneau/rest/annotation/ResourceSwagger.java | 24 +-
.../apache/juneau/rest/annotation/Response.java | 9 +-
.../juneau/rest/annotation/RestMethod.java | 161 ++-
.../juneau/rest/annotation/RestResource.java | 210 +--
.../juneau/rest/converters/Introspectable.java | 19 +-
.../juneau/rest/converters/Queryable.java | 51 +-
.../juneau/rest/converters/Traversable.java | 5 +-
.../rest/jena/RestServletJenaDefault.java | 35 +-
.../org/apache/juneau/rest/jena/package.html | 2 -
.../juneau/rest/labels/BeanDescription.java | 5 +-
.../rest/labels/ChildResourceDescriptions.java | 3 +-
.../juneau/rest/labels/NameDescription.java | 5 +
.../rest/matchers/MultipartFormDataMatcher.java | 2 +-
.../rest/matchers/UrlEncodedFormMatcher.java | 2 +-
.../java/org/apache/juneau/rest/package.html | 1291 +++++++++++-------
.../remoteable/RemoteableServiceProperties.java | 9 +-
.../rest/remoteable/RemoteableServlet.java | 12 +-
.../apache/juneau/rest/remoteable/package.html | 85 +-
.../juneau/rest/response/DefaultHandler.java | 4 +-
.../rest/response/InputStreamHandler.java | 3 +-
.../juneau/rest/response/StreamableHandler.java | 3 +-
.../juneau/rest/response/WritableHandler.java | 3 +-
.../response/ZipFileListResponseHandler.java | 12 +-
.../juneau/rest/vars/LocalizationVar.java | 2 +-
.../org/apache/juneau/rest/vars/RequestVar.java | 2 +-
.../juneau/rest/vars/ServletInitParamVar.java | 2 +-
.../apache/juneau/rest/vars/UrlEncodeVar.java | 3 +-
.../org/apache/juneau/rest/vars/UrlVar.java | 5 +-
.../org/apache/juneau/rest/vars/WidgetVar.java | 4 +-
.../apache/juneau/rest/widget/QueryWidget.java | 8 +-
.../org/apache/juneau/rest/widget/Widget.java | 4 +-
446 files changed, 7376 insertions(+), 4855 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfCommonContext.java
----------------------------------------------------------------------
diff --git a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfCommonContext.java b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfCommonContext.java
index 2405235..eeadd03 100644
--- a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfCommonContext.java
+++ b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfCommonContext.java
@@ -48,22 +48,30 @@ public interface RdfCommonContext {
* <p>
* Can be any of the following:
* <ul class='spaced-list'>
- * <li><js>"RDF/XML"</js>
- * <li><js>"RDF/XML-ABBREV"</js>
- * <li><js>"N-TRIPLE"</js>
- * <li><js>"N3"</js> - General name for the N3 writer.
+ * <li>
+ * <js>"RDF/XML"</js>
+ * <li>
+ * <js>"RDF/XML-ABBREV"</js>
+ * <li>
+ * <js>"N-TRIPLE"</js>
+ * <li>
+ * <js>"N3"</js> - General name for the N3 writer.
* Will make a decision on exactly which writer to use (pretty writer, plain writer or simple writer) when
* created.
* Default is the pretty writer but can be overridden with system property
* <code>com.hp.hpl.jena.n3.N3JenaWriter.writer</code>.
- * <li><js>"N3-PP"</js> - Name of the N3 pretty writer.
+ * <li>
+ * <js>"N3-PP"</js> - Name of the N3 pretty writer.
* The pretty writer uses a frame-like layout, with prefixing, clustering like properties and embedding
* one-referenced bNodes.
- * <li><js>"N3-PLAIN"</js> - Name of the N3 plain writer.
+ * <li>
+ * <js>"N3-PLAIN"</js> - Name of the N3 plain writer.
* The plain writer writes records by subject.
- * <li><js>"N3-TRIPLES"</js> - Name of the N3 triples writer.
+ * <li>
+ * <js>"N3-TRIPLES"</js> - Name of the N3 triples writer.
* This writer writes one line per statement, like N-Triples, but does N3-style prefixing.
- * <li><js>"TURTLE"</js> - Turtle writer.
+ * <li>
+ * <js>"TURTLE"</js> - Turtle writer.
* http://www.dajobe.org/2004/01/turtle/
* </ul>
*/
@@ -118,11 +126,14 @@ public interface RdfCommonContext {
* <p>
* Possible values:
* <ul class='spaced-list'>
- * <li><js>"lax"</js> - The rules for RDF URI references only, which does permit spaces although the use of spaces
+ * <li>
+ * <js>"lax"</js> - The rules for RDF URI references only, which does permit spaces although the use of spaces
* is not good practice.
- * <li><js>"strict"</js> - Sets the IRI engine with rules for valid IRIs, XLink and RDF; it does not permit spaces
+ * <li>
+ * <js>"strict"</js> - Sets the IRI engine with rules for valid IRIs, XLink and RDF; it does not permit spaces
* in IRIs.
- * <li><js>"iri"</js> - Sets the IRI engine to IRI
+ * <li>
+ * <js>"iri"</js> - Sets the IRI engine to IRI
* (<a class="doclink" href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>,
* <a class="doclink" href="http://www.ietf.org/rfc/rfc3987.txt">RFC 3987</a>).
* </ul>
@@ -153,10 +164,14 @@ public interface RdfCommonContext {
* <p>
* See also:
* <ul class='spaced-list'>
- * <li><a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPOptions.html#setDefaultErrorMode()">ARPOptions.setDefaultErrorMode()</a>
- * <li><a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPOptions.html#setLaxErrorMode()">ARPOptions.setLaxErrorMode()</a>
- * <li><a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPOptions.html#setStrictErrorMode()">ARPOptions.setStrictErrorMode()</a>
- * <li><a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPOptions.html#setStrictErrorMode(int)">ARPOptions.setStrictErrorMode(int)</a>
+ * <li>
+ * <a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPOptions.html#setDefaultErrorMode()">ARPOptions.setDefaultErrorMode()</a>
+ * <li>
+ * <a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPOptions.html#setLaxErrorMode()">ARPOptions.setLaxErrorMode()</a>
+ * <li>
+ * <a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPOptions.html#setStrictErrorMode()">ARPOptions.setStrictErrorMode()</a>
+ * <li>
+ * <a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPOptions.html#setStrictErrorMode(int)">ARPOptions.setStrictErrorMode(int)</a>
* </ul>
*/
public static final String RDF_arp_errorMode = "Rdf.jena.rdfXml.error-mode";
@@ -174,7 +189,8 @@ public interface RdfCommonContext {
* <p>
* See also:
* <ul class='spaced-list'>
- * <li><a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPOptions.html#setEmbedding(boolean)">ARPOptions.setEmbedding(boolean)</a>
+ * <li>
+ * <a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPOptions.html#setEmbedding(boolean)">ARPOptions.setEmbedding(boolean)</a>
* </ul>
*/
public static final String RDF_arp_embedding = "Rdf.jena.rdfXml.embedding";
@@ -199,8 +215,10 @@ public interface RdfCommonContext {
* <p>
* See also:
* <ul class='spaced-list'>
- * <li><a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPErrorNumbers.html">ARPErrorNumbers</a>
- * <li><a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPOptions.html#setErrorMode(int,%20int)">ARPOptions.setErrorMode(int, int)</a>
+ * <li>
+ * <a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPErrorNumbers.html">ARPErrorNumbers</a>
+ * <li>
+ * <a class="doclink" href="http://jena.sourceforge.net/javadoc/com/hp/hpl/jena/rdf/arp/ARPOptions.html#setErrorMode(int,%20int)">ARPOptions.setErrorMode(int, int)</a>
* </ul>
*/
public static final String RDF_arp_err_ = "Rdf.jena.rdfXml.ERR_";
@@ -282,12 +300,18 @@ public interface RdfCommonContext {
* <p>
* A comma separate list of options:
* <ul class='spaced-list'>
- * <li><js>"same-document"</js> - Same-document references (e.g. <js>""</js> or <js>"#foo"</js>)
- * <li><js>"network"</js> - Network paths (e.g. <js>"//example.org/foo"</js> omitting the URI scheme)
- * <li><js>"absolute"</js> - Absolute paths (e.g. <js>"/foo"</js> omitting the scheme and authority)
- * <li><js>"relative"</js> - Relative path not beginning in <js>"../"</js>
- * <li><js>"parent"</js> - Relative path beginning in <js>"../"</js>
- * <li><js>"grandparent"</js> - Relative path beginning in <js>"../../"</js>
+ * <li>
+ * <js>"same-document"</js> - Same-document references (e.g. <js>""</js> or <js>"#foo"</js>)
+ * <li>
+ * <js>"network"</js> - Network paths (e.g. <js>"//example.org/foo"</js> omitting the URI scheme)
+ * <li>
+ * <js>"absolute"</js> - Absolute paths (e.g. <js>"/foo"</js> omitting the scheme and authority)
+ * <li>
+ * <js>"relative"</js> - Relative path not beginning in <js>"../"</js>
+ * <li>
+ * <js>"parent"</js> - Relative path beginning in <js>"../"</js>
+ * <li>
+ * <js>"grandparent"</js> - Relative path beginning in <js>"../../"</js>
* </ul>
* <p>
* The default value is <js>"same-document, absolute, relative, parent"</js>.
@@ -307,9 +331,12 @@ public interface RdfCommonContext {
* <p>
* Possible values:
* <ul class='spaced-list'>
- * <li><js>"true"</js> - Add XML Declaration to the output.
- * <li><js>"false"</js> - Don't add XML Declaration to the output.
- * <li><js>"default"</js> - Only add an XML Declaration when asked to write to an <code>OutputStreamWriter</code>
+ * <li>
+ * <js>"true"</js> - Add XML Declaration to the output.
+ * <li>
+ * <js>"false"</js> - Don't add XML Declaration to the output.
+ * <li>
+ * <js>"default"</js> - Only add an XML Declaration when asked to write to an <code>OutputStreamWriter</code>
* that uses some encoding other than <code>UTF-8</code> or <code>UTF-16</code>.
* In this case the encoding is shown in the XML declaration.
* </ul>
@@ -515,13 +542,18 @@ public interface RdfCommonContext {
* <p>
* Possible values:
* <ul class='spaced-list'>
- * <li><js>"DEFAULT"</js> - Default format. The default is an RDF Sequence container.
- * <li><js>"SEQ"</js> - RDF Sequence container.
- * <li><js>"BAG"</js> - RDF Bag container.
- * <li><js>"LIST"</js> - RDF List container.
- * <li><js>"MULTI_VALUED"</js> - Multi-valued properties.
- * </ul>
- * <p>
+ * <li>
+ * <js>"DEFAULT"</js> - Default format. The default is an RDF Sequence container.
+ * <li>
+ * <js>"SEQ"</js> - RDF Sequence container.
+ * <li>
+ * <js>"BAG"</js> - RDF Bag container.
+ * <li>
+ * <js>"LIST"</js> - RDF List container.
+ * <li>
+ * <js>"MULTI_VALUED"</js> - Multi-valued properties.
+ * </ul>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>If you use <js>"BAG"</js> or <js>"MULTI_VALUED"</js>, the order of the elements in the collection will get
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java
----------------------------------------------------------------------
diff --git a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java
index 33f74c1..fe4f0ab 100644
--- a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java
+++ b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java
@@ -40,10 +40,14 @@ import com.hp.hpl.jena.util.iterator.*;
* <p>
* The following direct subclasses are provided for language-specific parsers:
* <ul class='spaced-list'>
- * <li>{@link RdfParser.Xml} - RDF/XML and RDF/XML-ABBREV.
- * <li>{@link RdfParser.NTriple} - N-TRIPLE.
- * <li>{@link RdfParser.Turtle} - TURTLE.
- * <li>{@link RdfParser.N3} - N3.
+ * <li>
+ * {@link RdfParser.Xml} - RDF/XML and RDF/XML-ABBREV.
+ * <li>
+ * {@link RdfParser.NTriple} - N-TRIPLE.
+ * <li>
+ * {@link RdfParser.Turtle} - TURTLE.
+ * <li>
+ * {@link RdfParser.N3} - N3.
* </ul>
*
* <h5 class='section'>Additional information:</h5>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java
index 8003b0d..252fbd0 100644
--- a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java
+++ b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java
@@ -66,7 +66,7 @@ public class RdfParserBuilder extends ParserBuilder {
* </ul>
* <p>
* If <jk>true</jk>, whitespace in text elements will be automatically trimmed.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_trimWhitespace</jsf>, value)</code>.
@@ -91,25 +91,33 @@ public class RdfParserBuilder extends ParserBuilder {
* <p>
* Can be any of the following:
* <ul class='spaced-list'>
- * <li><js>"RDF/XML"</js>
- * <li><js>"RDF/XML-ABBREV"</js>
- * <li><js>"N-TRIPLE"</js>
- * <li><js>"N3"</js> - General name for the N3 writer.
+ * <li>
+ * <js>"RDF/XML"</js>
+ * <li>
+ * <js>"RDF/XML-ABBREV"</js>
+ * <li>
+ * <js>"N-TRIPLE"</js>
+ * <li>
+ * <js>"N3"</js> - General name for the N3 writer.
* Will make a decision on exactly which writer to use (pretty writer, plain writer or simple writer) when
* created.
* Default is the pretty writer but can be overridden with system property
* <code>com.hp.hpl.jena.n3.N3JenaWriter.writer</code>.
- * <li><js>"N3-PP"</js> - Name of the N3 pretty writer.
+ * <li>
+ * <js>"N3-PP"</js> - Name of the N3 pretty writer.
* The pretty writer uses a frame-like layout, with prefixing, clustering like properties and embedding
* one-referenced bNodes.
- * <li><js>"N3-PLAIN"</js> - Name of the N3 plain writer.
+ * <li>
+ * <js>"N3-PLAIN"</js> - Name of the N3 plain writer.
* The plain writer writes records by subject.
- * <li><js>"N3-TRIPLES"</js> - Name of the N3 triples writer.
+ * <li>
+ * <js>"N3-TRIPLES"</js> - Name of the N3 triples writer.
* This writer writes one line per statement, like N-Triples, but does N3-style prefixing.
- * <li><js>"TURTLE"</js> - Turtle writer.
+ * <li>
+ * <js>"TURTLE"</js> - Turtle writer.
* http://www.dajobe.org/2004/01/turtle/
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_language</jsf>, value)</code>.
@@ -176,7 +184,7 @@ public class RdfParserBuilder extends ParserBuilder {
* <li><b>Data type:</b> {@link Namespace}
* <li><b>Default:</b> <code>{j:<js>'http://www.apache.org/juneau/'</js>}</code>
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_juneauNs</jsf>, value)</code>.
@@ -198,7 +206,7 @@ public class RdfParserBuilder extends ParserBuilder {
* <li><b>Data type:</b> {@link Namespace}
* <li><b>Default:</b> <code>{j:<js>'http://www.apache.org/juneaubp/'</js>}</code>
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_juneauBpNs</jsf>, value)</code>.
@@ -223,7 +231,7 @@ public class RdfParserBuilder extends ParserBuilder {
* <p>
* When specified, namespaces defined using {@link XmlNs} and {@link Xml} will be inherited by the RDF parsers.
* Otherwise, namespaces will be defined using {@link RdfNs} and {@link Rdf}.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_useXmlNamespaces</jsf>, value)</code>.
@@ -248,19 +256,24 @@ public class RdfParserBuilder extends ParserBuilder {
* <p>
* Possible values:
* <ul class='spaced-list'>
- * <li><js>"DEFAULT"</js> - Default format. The default is an RDF Sequence container.
- * <li><js>"SEQ"</js> - RDF Sequence container.
- * <li><js>"BAG"</js> - RDF Bag container.
- * <li><js>"LIST"</js> - RDF List container.
- * <li><js>"MULTI_VALUED"</js> - Multi-valued properties.
+ * <li>
+ * <js>"DEFAULT"</js> - Default format. The default is an RDF Sequence container.
+ * <li>
+ * <js>"SEQ"</js> - RDF Sequence container.
+ * <li>
+ * <js>"BAG"</js> - RDF Bag container.
+ * <li>
+ * <js>"LIST"</js> - RDF List container.
+ * <li>
+ * <js>"MULTI_VALUED"</js> - Multi-valued properties.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>If you use <js>"BAG"</js> or <js>"MULTI_VALUED"</js>, the order of the elements in the collection will get
* lost.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_collectionFormat</jsf>, value)</code>.
@@ -315,7 +328,7 @@ public class RdfParserBuilder extends ParserBuilder {
* <jc>// Parse back into a bean array</jc>
* b = p.parse(rdfXml, MyBean[].<jk>class</jk>);
* </p>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_looseCollections</jsf>, value)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParserContext.java b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParserContext.java
index fb083da..cadfa62 100644
--- a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParserContext.java
+++ b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfParserContext.java
@@ -28,16 +28,21 @@ import org.apache.juneau.xml.*;
*
* <h6 class='topic' id='ConfigProperties'>Configurable properties inherited by the RDF parsers</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
* - Properties associated with handling beans on serializers and parsers.
- * <ul>
- * <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
- * - Configurable properties common to all parsers.
* <ul>
- * <li class='jic'><a class="doclink" href="RdfCommonContext.html#ConfigProperties">RdfCommonContext</a>
- * - Configurable properties common to the RDF serializers and parsers.
+ * <li class='jc'>
+ * <a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
+ * - Configurable properties common to all parsers.
+ * <ul>
+ * <li class='jic'>
+ * <a class="doclink" href="RdfCommonContext.html#ConfigProperties">RdfCommonContext</a>
+ * - Configurable properties common to the RDF serializers and parsers.
+ * </ul>
+ * </li>
* </ul>
- * </ul>
+ * </li>
* </ul>
*/
public final class RdfParserContext extends ParserContext implements RdfCommonContext {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java
index 85484e7..879466b 100644
--- a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java
+++ b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java
@@ -66,25 +66,33 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* <p>
* Can be any of the following:
* <ul class='spaced-list'>
- * <li><js>"RDF/XML"</js>
- * <li><js>"RDF/XML-ABBREV"</js>
- * <li><js>"N-TRIPLE"</js>
- * <li><js>"N3"</js> - General name for the N3 writer.
+ * <li>
+ * <js>"RDF/XML"</js>
+ * <li>
+ * <js>"RDF/XML-ABBREV"</js>
+ * <li>
+ * <js>"N-TRIPLE"</js>
+ * <li>
+ * <js>"N3"</js> - General name for the N3 writer.
* Will make a decision on exactly which writer to use (pretty writer, plain writer or simple writer) when
* created.
* Default is the pretty writer but can be overridden with system property
* <code>com.hp.hpl.jena.n3.N3JenaWriter.writer</code>.
- * <li><js>"N3-PP"</js> - Name of the N3 pretty writer.
+ * <li>
+ * <js>"N3-PP"</js> - Name of the N3 pretty writer.
* The pretty writer uses a frame-like layout, with prefixing, clustering like properties and embedding
* one-referenced bNodes.
- * <li><js>"N3-PLAIN"</js> - Name of the N3 plain writer.
+ * <li>
+ * <js>"N3-PLAIN"</js> - Name of the N3 plain writer.
* The plain writer writes records by subject.
- * <li><js>"N3-TRIPLES"</js> - Name of the N3 triples writer.
+ * <li>
+ * <js>"N3-TRIPLES"</js> - Name of the N3 triples writer.
* This writer writes one line per statement, like N-Triples, but does N3-style prefixing.
- * <li><js>"TURTLE"</js> - Turtle writer.
+ * <li>
+ * <js>"TURTLE"</js> - Turtle writer.
* http://www.dajobe.org/2004/01/turtle/
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_language</jsf>, value)</code>.
@@ -152,7 +160,7 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* <li><b>Data type:</b> {@link Namespace}
* <li><b>Default:</b> <code>{j:<js>'http://www.apache.org/juneau/'</js>}</code>
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_juneauNs</jsf>, value)</code>.
@@ -175,7 +183,7 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* <li><b>Data type:</b> {@link Namespace}
* <li><b>Default:</b> <code>{j:<js>'http://www.apache.org/juneaubp/'</js>}</code>
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_juneauBpNs</jsf>, value)</code>.
@@ -201,7 +209,7 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* <p>
* When specified, namespaces defined using {@link XmlNs} and {@link Xml} will be inherited by the RDF serializers.
* Otherwise, namespaces will be defined using {@link RdfNs} and {@link Rdf}.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_useXmlNamespaces</jsf>, value)</code>.
@@ -225,7 +233,7 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_addLiteralTypes</jsf>, value)</code>.
@@ -256,7 +264,7 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* <p>
* If disabled, the parser has to search through the model to find any resources without incoming predicates to
* identify root notes, which can introduce a considerable performance degradation.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_addRootProperty</jsf>, value)</code>.
@@ -285,7 +293,7 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* <p>
* If enabled, then the data structure will first be crawled looking for namespaces that will be encountered before
* the root element is serialized.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_autoDetectNamespaces</jsf>, value)</code>.
@@ -311,7 +319,7 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* </ul>
* <p>
* The default list of namespaces associated with this serializer.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_namespaces</jsf>, values)</code>.
@@ -337,19 +345,24 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* <p>
* Possible values:
* <ul class='spaced-list'>
- * <li><js>"DEFAULT"</js> - Default format. The default is an RDF Sequence container.
- * <li><js>"SEQ"</js> - RDF Sequence container.
- * <li><js>"BAG"</js> - RDF Bag container.
- * <li><js>"LIST"</js> - RDF List container.
- * <li><js>"MULTI_VALUED"</js> - Multi-valued properties.
+ * <li>
+ * <js>"DEFAULT"</js> - Default format. The default is an RDF Sequence container.
+ * <li>
+ * <js>"SEQ"</js> - RDF Sequence container.
+ * <li>
+ * <js>"BAG"</js> - RDF Bag container.
+ * <li>
+ * <js>"LIST"</js> - RDF List container.
+ * <li>
+ * <js>"MULTI_VALUED"</js> - Multi-valued properties.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>If you use <js>"BAG"</js> or <js>"MULTI_VALUED"</js>, the order of the elements in the collection will get
* lost.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_collectionFormat</jsf>, value)</code>.
@@ -404,7 +417,7 @@ public class RdfSerializerBuilder extends SerializerBuilder {
* <jc>// Parse back into a bean array</jc>
* b = p.parse(rdfXml, MyBean[].<jk>class</jk>);
* </p>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>RDF_looseCollections</jsf>, value)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerContext.java b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerContext.java
index 1c3e794..fb47c8f 100644
--- a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerContext.java
+++ b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerContext.java
@@ -28,16 +28,21 @@ import org.apache.juneau.xml.*;
*
* <h6 class='topic' id='ConfigProperties'>Configurable properties inherited by the RDF serializers</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
* - Properties associated with handling beans on serializers and parsers.
- * <ul>
- * <li class='jc'><a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
- * - Configurable properties common to all serializers.
* <ul>
- * <li class='jc'><a class="doclink" href="RdfCommonContext.html#ConfigProperties">RdfCommonContext</a>
- * - Configurable properties common to the RDF serializers and parsers.
+ * <li class='jc'>
+ * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="RdfCommonContext.html#ConfigProperties">RdfCommonContext</a>
+ * - Configurable properties common to the RDF serializers and parsers.
+ * </ul>
+ * </li>
* </ul>
- * </ul>
+ * </li>
* </ul>
*/
public final class RdfSerializerContext extends SerializerContext implements RdfCommonContext {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core-rdf/src/main/java/org/apache/juneau/jena/annotation/Rdf.java
----------------------------------------------------------------------
diff --git a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/annotation/Rdf.java b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/annotation/Rdf.java
index e916bdb..f4821a5 100644
--- a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/annotation/Rdf.java
+++ b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/annotation/Rdf.java
@@ -25,7 +25,7 @@ import org.apache.juneau.jena.*;
* Can be applied to Java packages, types, fields, and methods.
* <p>
* Can be used for the following:
- * <ul class='spaced-list'>
+ * <ul>
* <li>Override the default behavior of how collections and arrays are serialized.
* </ul>
*/
@@ -62,7 +62,8 @@ public @interface Rdf {
* <p>
* Has the following effects on the following serializers:
* <ul class='spaced-list'>
- * <li>{@link RdfSerializer} - Will be rendered as the value of the <js>"rdf:about"</js> attribute
+ * <li>
+ * {@link RdfSerializer} - Will be rendered as the value of the <js>"rdf:about"</js> attribute
* for the bean.
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core-rdf/src/main/java/org/apache/juneau/jena/package.html
----------------------------------------------------------------------
diff --git a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/package.html b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/package.html
index 522be72..34ef9e7 100644
--- a/juneau-core-rdf/src/main/java/org/apache/juneau/jena/package.html
+++ b/juneau-core-rdf/src/main/java/org/apache/juneau/jena/package.html
@@ -100,32 +100,36 @@
Juneau can serialize and parse instances of any of the following POJO types:
</p>
<ul class='spaced-list'>
- <li>Java primitive objects (e.g. <code>String</code>, <code>Integer</code>, <code>Boolean</code>,
+ <li>
+ Java primitive objects (e.g. <code>String</code>, <code>Integer</code>, <code>Boolean</code>,
<code>Float</code>).
- <li>Java collections framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything on
+ <li>
+ Java collections framework objects (e.g. <code>HashSet</code>, <code>TreeMap</code>) containing anything on
this list.
- <li>Multi-dimensional arrays of any type on this list.
- <li>Java Beans with properties of any type on this list.
- <li>Classes with standard transformations to and from <code>Strings</code> (e.g. classes containing
+ <li>
+ Multi-dimensional arrays of any type on this list.
+ <li>
+ Java Beans with properties of any type on this list.
+ <li>
+ Classes with standard transformations to and from <code>Strings</code> (e.g. classes containing
<code>toString()</code>, <code>fromString()</code>, <code>valueOf()</code>, <code>constructor(String)</code>).
</ul>
<p>
In addition to the types shown above, Juneau includes the ability to define 'swaps' to transform non-standard
object and property types to serializable forms (e.g. to transform <code>Calendars</code> to and from
<code>ISO8601</code> strings, or <code>byte[]</code> arrays to and from base-64 encoded strings).
- <br>
- These can be associated with serializers/parsers, or can be associated with classes or bean properties through
+ <br>These can be associated with serializers/parsers, or can be associated with classes or bean properties through
type and method annotations.
</p>
<p>
Refer to <a href='../../../../overview-summary.html#Core.PojoCategories' class='doclink'>POJO Categories</a>
for a complete definition of supported POJOs.
</p>
+
<h6 class='topic'>Prerequisites</h6>
<p>
Juneau uses the Jena library for these formats.
- <br>
- The predefined serializers and parsers convert POJOs to and from RDF models and then uses Jena to convert
+ <br>The predefined serializers and parsers convert POJOs to and from RDF models and then uses Jena to convert
them to and from the various RDF languages.
</p>
<p>
@@ -186,8 +190,7 @@
<div class='topic'>
<p>
The {@link org.apache.juneau.jena.RdfSerializer} class is the top-level class for all Jena-based serializers.
- <br>
- Language-specific serializers are defined as inner subclasses of the <code>RdfSerializer</code> class:
+ <br>Language-specific serializers are defined as inner subclasses of the <code>RdfSerializer</code> class:
</p>
<ul>
<li>{@link org.apache.juneau.jena.RdfSerializer.Xml}
@@ -212,8 +215,7 @@
</p>
<p>
For brevity, the examples will use public fields instead of getters/setters to reduce the size of the examples.
- <br>
- In the real world, you'll typically want to use standard bean getters and setters.
+ <br>In the real world, you'll typically want to use standard bean getters and setters.
</p>
<p>
To start off simple, we'll begin with the following simplified bean and build it up.
@@ -272,10 +274,8 @@
</p>
<p>
Notice that we've taken an arbitrary POJO and converted it to RDF.
- <br>
- The Juneau serializers and parsers are designed to work with arbitrary POJOs without requiring any annotations.
- <br>
- That being said, several annotations are provided to customize how POJOs are handled to produce usable RDF.
+ <br>The Juneau serializers and parsers are designed to work with arbitrary POJOs without requiring any annotations.
+ <br>That being said, several annotations are provided to customize how POJOs are handled to produce usable RDF.
</p>
<!-- ======================================================================================================== -->
@@ -284,8 +284,7 @@
<div class='topic'>
<p>
You'll notice in the previous example that Juneau namespaces are used to represent bean property names.
- <br>
- These are used by default when namespaces are not explicitly specified.
+ <br>These are used by default when namespaces are not explicitly specified.
</p>
<p>
The <code>juneau</code> namespace is used for generic names for objects that don't have namespaces
@@ -297,11 +296,9 @@
</p>
<p>
The easiest way to specify namespaces is through annotations.
- <br>
- In this example, we're going to associate the prefix <code>'per'</code> to our bean class and all properties
+ <br>In this example, we're going to associate the prefix <code>'per'</code> to our bean class and all properties
of this class.
- <br>
- We do this by adding the following annotation to our class:
+ <br>We do this by adding the following annotation to our class:
</p>
<p class='bcode'>
<ja>@Rdf</ja>(prefix=<js>"per"</js>)
@@ -347,10 +344,8 @@
<p>
Namespace auto-detection ({@link org.apache.juneau.xml.XmlSerializerContext#XML_autoDetectNamespaces}) is
enabled on serializers by default.
- <br>
- This causes the serializer to make a first-pass over the data structure to look for namespaces.
- <br>
- In high-performance environments, you may want to consider disabling auto-detection and providing an
+ <br>This causes the serializer to make a first-pass over the data structure to look for namespaces.
+ <br>In high-performance environments, you may want to consider disabling auto-detection and providing an
explicit list of namespaces to the serializer to avoid this scanning step.
</p>
<p class='bcode'>
@@ -375,16 +370,13 @@
<p>
Bean properties of type <code>java.net.URI</code> or <code>java.net.URL</code> have special meaning to the
RDF serializer.
- <br>
- They are interpreted as resource identifiers.
+ <br>They are interpreted as resource identifiers.
</p>
<p>
In the following code, we're adding 2 new properties.
- <br>
- The first property is annotated with <ja>@BeanProperty</ja> to identify that this property is the resource
+ <br>The first property is annotated with <ja>@BeanProperty</ja> to identify that this property is the resource
identifier for this bean.
- <br>
- The second un-annotated property is interpreted as a reference to another resource.
+ <br>The second un-annotated property is interpreted as a reference to another resource.
</p>
<p class='bcode'>
<jk>public class</jk> Person {
@@ -485,25 +477,26 @@
<p>
The {@link org.apache.juneau.annotation.Bean} and {@link org.apache.juneau.annotation.BeanProperty}
annotations are used to customize the behavior of beans across the entire framework.
- <br>
- In addition to using them to identify the resource URI for the bean shown above, they have various other
+ <br>In addition to using them to identify the resource URI for the bean shown above, they have various other
uses:
</p>
<ul class='spaced-list'>
- <li>Hiding bean properties.
- <li>Specifying the ordering of bean properties.
- <li>Overriding the names of bean properties.
- <li>Associating transforms at both the class and property level (to convert non-serializable POJOs to
+ <li>
+ Hiding bean properties.
+ <li>
+ Specifying the ordering of bean properties.
+ <li>
+ Overriding the names of bean properties.
+ <li>
+ Associating transforms at both the class and property level (to convert non-serializable POJOs to
serializable forms).
</ul>
<p>
For example, we now add a <code>birthDate</code> property, and associate a swap with it to transform
it to an ISO8601 date-time string in GMT time.
- <br>
- By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you want
+ <br>By default, <code>Calendars</code> are treated as beans by the framework, which is usually not how you want
them serialized.
- <br>
- Using swaps, we can convert them to standardized string forms.
+ <br>Using swaps, we can convert them to standardized string forms.
</p>
<p class='bcode'>
<jk>public class</jk> Person {
@@ -556,8 +549,7 @@
<div class='topic'>
<p>
Collections and arrays are converted to RDF sequences.
- <br>
- In our example, let's add a list-of-beans property to our sample class:
+ <br>In our example, let's add a list-of-beans property to our sample class:
</p>
<p class='bcode'>
<jk>public class</jk> Person {
@@ -652,27 +644,22 @@
<div class='topic'>
<p>
For all RDF languages, the POJO objects get broken down into simple triplets.
- <br>
- Unfortunately, for tree-structured data like the POJOs shown above, this causes the root node of the tree
+ <br>Unfortunately, for tree-structured data like the POJOs shown above, this causes the root node of the tree
to become lost.
- <br>
- There is no easy way to identify that <code>person/1</code> is the root node in our tree once in triplet
+ <br>There is no easy way to identify that <code>person/1</code> is the root node in our tree once in triplet
form, and in some cases it's impossible.
</p>
<p>
By default, the {@link org.apache.juneau.jena.RdfParser} class handles this by scanning all the nodes and
identifying the nodes without incoming references.
- <br>
- However, this is inefficient, especially for large models.
- <br>
- And in cases where the root node is referenced by another node in the model by URL, it's not possible to
+ <br>However, this is inefficient, especially for large models.
+ <br>And in cases where the root node is referenced by another node in the model by URL, it's not possible to
locate the root at all.
</p>
<p>
To resolve this issue, the property {@link org.apache.juneau.jena.RdfSerializerContext#RDF_addRootProperty}
was introduced.
- <br>
- When enabled, this adds a special <code>root</code> attribute to the root node to make it easy to locate
+ <br>When enabled, this adds a special <code>root</code> attribute to the root node to make it easy to locate
by the parser.
</p>
<p>
@@ -784,24 +771,20 @@
<div class='topic'>
<p>
The RDF serializer is designed to be used against tree structures.
- <br>
- It expects that there not be loops in the POJO model (e.g. children with references to parents, etc...).
- <br>
- If you try to serialize models with loops, you will usually cause a <code>StackOverflowError</code> to
+ <br>It expects that there not be loops in the POJO model (e.g. children with references to parents, etc...).
+ <br>If you try to serialize models with loops, you will usually cause a <code>StackOverflowError</code> to
be thrown (if {@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_maxDepth} is not reached
first).
</p>
<p>
If you still want to use the XML serializer on such models, Juneau provides the
{@link org.apache.juneau.serializer.SerializerContext#SERIALIZER_detectRecursions} setting.
- <br>
- It tells the serializer to look for instances of an object in the current branch of the tree and skip
+ <br>It tells the serializer to look for instances of an object in the current branch of the tree and skip
serialization when a duplicate is encountered.
</p>
<p>
Recursion detection introduces a performance penalty of around 20%.
- <br>
- For this reason the setting is disabled by default.
+ <br>For this reason the setting is disabled by default.
</p>
</div>
@@ -814,8 +797,10 @@
See the following classes for all configurable properties that can be used on this serializer:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.BeanContext} - Bean context properties.
- <li>{@link org.apache.juneau.jena.RdfSerializerContext} - Serializer context properties.
+ <li>
+ {@link org.apache.juneau.BeanContext} - Bean context properties.
+ <li>
+ {@link org.apache.juneau.jena.RdfSerializerContext} - Serializer context properties.
</ul>
</div>
@@ -825,10 +810,11 @@
<h3 class='topic' onclick='toggle(this)'>2.9 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau serializers, the RDF serializer is thread safe and maintains an internal cache of
- bean classes encountered.
- For performance reasons, it's recommended that serializers be reused whenever possible instead of always
- creating new instances.
+ <li>
+ Like all other Juneau serializers, the RDF serializer is thread safe and maintains an internal cache of
+ bean classes encountered.
+ For performance reasons, it's recommended that serializers be reused whenever possible instead of always
+ creating new instances.
</ul>
</div>
</div>
@@ -840,8 +826,7 @@
<div class='topic'>
<p>
The {@link org.apache.juneau.jena.RdfParser} class is the top-level class for all Jena-based parsers.
- <br>
- Language-specific parsers are defined as inner subclasses of the <code>RdfParser</code> class:
+ <br>Language-specific parsers are defined as inner subclasses of the <code>RdfParser</code> class:
</p>
<ul>
<li>{@link org.apache.juneau.jena.RdfParser.Xml}
@@ -929,16 +914,14 @@
<div class='topic'>
<p>
The RDF parser is not limited to parsing back into the original bean classes.
- <br>
- If the bean classes are not available on the parsing side, the parser can also be used to parse into a
+ <br>If the bean classes are not available on the parsing side, the parser can also be used to parse into a
generic model consisting of <code>Maps</code>, <code>Collections</code>, and primitive objects.
</p>
<p>
You can parse into any <code>Map</code> type (e.g. <code>HashMap</code>, <code>TreeMap</code>), but
using {@link org.apache.juneau.ObjectMap} is recommended since it has many convenience methods
for converting values to various types.
- <br>
- The same is true when parsing collections. You can use any Collection (e.g. <code>HashSet</code>,
+ <br>The same is true when parsing collections. You can use any Collection (e.g. <code>HashSet</code>,
<code>LinkedList</code>) or array (e.g. <code>Object[]</code>, <code>String[]</code>,
<code>String[][]</code>), but using {@link org.apache.juneau.ObjectList} is recommended.
</p>
@@ -975,32 +958,27 @@
<p>
However, there are caveats when parsing into generic models due to the nature of RDF.
- <br>
- Watch out for the following:
+ <br>Watch out for the following:
</p>
<ul class='spaced-list'>
- <li>The ordering of entries are going to be inconsistent.
- <br><br>
- <li>Bean URIs are always going to be denoted with the key <js>"uri"</js>.
- <br>
- Therefore, you cannot have a bean with a URI property and a separate property named <js>"uri"</js>.
- <br>
- The latter will overwrite the former.
- <br>
- This isn't a problem when parsing into beans instead of generic POJO models.
- <li>All values are strings.
- <br>
- This normally isn't a problem when using <code>ObjectMap</code> and <code>ObjectList</code> since
+ <li>
+ The ordering of entries are going to be inconsistent.
+ <li>
+ Bean URIs are always going to be denoted with the key <js>"uri"</js>.
+ <br>Therefore, you cannot have a bean with a URI property and a separate property named <js>"uri"</js>.
+ <br>The latter will overwrite the former.
+ <br>This isn't a problem when parsing into beans instead of generic POJO models.
+ <li>
+ All values are strings.
+ <br>This normally isn't a problem when using <code>ObjectMap</code> and <code>ObjectList</code> since
various methods are provided for converting to the correct type anyway.
- <li>The results may not be what is expected if there are lots of URL reference loops in the RDF model.
- <br>
- As nodes are processed from the root node down through the child nodes, the parser keeps
+ <li>
+ The results may not be what is expected if there are lots of URL reference loops in the RDF model.
+ <br>As nodes are processed from the root node down through the child nodes, the parser keeps
track of previously processed parent URIs and handles them accordingly.
- <br>
- If it finds that the URI has previously been processed, it handles it as a normal URI string and doesn't
+ <br>If it finds that the URI has previously been processed, it handles it as a normal URI string and doesn't
process further.
- <br>
- However, depending on how complex the reference loops are, the parsed data may end up having the
+ <br>However, depending on how complex the reference loops are, the parsed data may end up having the
same data in it, but structured differently from the original POJO.
</ul>
<p>
@@ -1036,8 +1014,7 @@
</p>
<p>
As a general rule, parsing into beans is often more efficient than parsing into generic models.
- <br>
- And working with beans is often less error prone than working with generic models.
+ <br>And working with beans is often less error prone than working with generic models.
</p>
</div>
@@ -1050,8 +1027,10 @@
See the following classes for all configurable properties that can be used on this parser:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.BeanContext} - Bean context properties.
- <li>{@link org.apache.juneau.jena.RdfParserContext} - Parser context properties.
+ <li>
+ {@link org.apache.juneau.BeanContext} - Bean context properties.
+ <li>
+ {@link org.apache.juneau.jena.RdfParserContext} - Parser context properties.
</ul>
</div>
@@ -1060,7 +1039,8 @@
<h3 class='topic' onclick='toggle(this)'>3.3 - Other notes</h3>
<div class='topic'>
<ul class='spaced-list'>
- <li>Like all other Juneau parsers, the RDF parser is thread safe and maintains an internal cache of bean
+ <li>
+ Like all other Juneau parsers, the RDF parser is thread safe and maintains an internal cache of bean
classes encountered.
For performance reasons, it's recommended that parser be reused whenever possible instead of always
creating new instances.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core-test/src/test/java/org/apache/juneau/transforms/DateSwapTest.java
----------------------------------------------------------------------
diff --git a/juneau-core-test/src/test/java/org/apache/juneau/transforms/DateSwapTest.java b/juneau-core-test/src/test/java/org/apache/juneau/transforms/DateSwapTest.java
index 40225ec..482047a 100755
--- a/juneau-core-test/src/test/java/org/apache/juneau/transforms/DateSwapTest.java
+++ b/juneau-core-test/src/test/java/org/apache/juneau/transforms/DateSwapTest.java
@@ -48,10 +48,10 @@ public class DateSwapTest {
final DateSwap.ISO8601DT dateSwap = new DateSwap.ISO8601DT();
// this works
- final String sValue = data.getString("birthday"); //$NON-NLS-1$
+ final String sValue = data.getString("birthday");
dateSwap.unswap(null, sValue, data.getBeanSession().getClassMeta(Date.class));
// this does not work
- data.get(dateSwap, "birthday"); //$NON-NLS-1$
+ data.get(dateSwap, "birthday");
}
public static class A {
[14/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
index 5ae1939..c6b31c2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
@@ -32,12 +32,17 @@ import org.apache.juneau.json.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="description,type,format,items,collectionFormat,default,maximum,exclusiveMaximum,minimum,exclusiveMinimum,maxLength,minLength,pattern,maxItems,minItems,uniqueItems,enum,multipleOf")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
index 98476f5..4af69c8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
@@ -39,12 +39,17 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="title,description,termsOfService,contact,license,version")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
index 538c3c7..20140fb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
@@ -32,12 +32,17 @@ import org.apache.juneau.json.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="type,format,items,collectionFormat,default,maximum,exclusiveMaximum,minimum,exclusiveMinimum,maxLength,minLength,pattern,maxItems,minItems,uniqueItems,enum,multipleOf")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
index 9fcc469..eb28691 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
@@ -33,12 +33,17 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="name,url")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
index f9d65b6..a3901d9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
@@ -80,12 +80,17 @@ import org.apache.juneau.http.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="operationId,summary,description,tags,externalDocs,consumes,produces,parameters,responses,schemes,deprecated,security")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
index d7c6260..7bc56ac 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
@@ -63,12 +63,17 @@ import org.apache.juneau.json.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="in,name,type,description,required,schema,format,allowEmptyValue,items,collectionFormat,default,maximum,exclusiveMaximum,minimum,exclusiveMinimum,maxLength,minLength,pattern,maxItems,minItems,uniqueItems,enum,multipleOf")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
index 4bc5236..ebfefda 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
@@ -34,12 +34,17 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="description,schema,headers,examples")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
index 460a051..1a4c53b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
@@ -28,12 +28,17 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="format,title,description,default,multipleOf,maximum,exclusiveMaximum,minimum,exclusiveMinimum,maxLength,minLength,pattern,maxItems,minItems,uniqueItems,maxProperties,minProperties,required,enum,type,items,allOf,properties,additionalProperties,discriminator,readOnly,xml,externalDocs,example")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
index f41e194..325990b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
@@ -53,12 +53,17 @@ import org.apache.juneau.json.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="type,description,name,in,flow,authorizationUrl,tokenUrl,scopes")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
index bbb8d05..5046967 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
@@ -23,12 +23,17 @@ import org.apache.juneau.utils.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="swagger,info,tags,externalDocs,basePath,schemes,consumes,produces,paths,definitions,parameters,responses,securityDefinitions,security")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
index 20d5fff..89f251f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
@@ -21,12 +21,17 @@ import org.apache.juneau.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
public class SwaggerBuilder {
@@ -55,10 +60,11 @@ public class SwaggerBuilder {
* and {@link Contact#email(String)}, attributes.
*
* @param name The {@link Contact#name(String)} attribute.
- * @param url The {@link Contact#url(Object)} attribute.
- * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
- * <br>Strings must be valid URIs.
- * <br>URIs defined by {@link UriResolver} can be used for values.
+ * @param url
+ * The {@link Contact#url(Object)} attribute.
+ * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
+ * <br>Strings must be valid URIs.
+ * <br>URIs defined by {@link UriResolver} can be used for values.
* @param email The {@link Contact#email(String)} attribute.
* @return The new element.
*/
@@ -79,7 +85,8 @@ public class SwaggerBuilder {
* Creates an {@link ExternalDocumentation} element with the specified {@link ExternalDocumentation#url(Object)}
* attribute.
*
- * @param url The {@link ExternalDocumentation#url(Object)} attribute.
+ * @param url
+ * The {@link ExternalDocumentation#url(Object)} attribute.
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* <br>Strings must be valid URIs.
* <br>URIs defined by {@link UriResolver} can be used for values.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
index a768d59..ed41bdd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
@@ -17,12 +17,17 @@ package org.apache.juneau.dto.swagger;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
public class SwaggerElement {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
index 3c2d504..6215ae0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
@@ -30,12 +30,17 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="name,description,externalDocs")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
index 15701e7..247ecda 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
@@ -22,12 +22,17 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
+ * </li>
* </ul>
*/
@Bean(properties="name,namespace,prefix,attribute,wrapped")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/swagger/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/package.html b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/package.html
index bde6318..8966843 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/package.html
@@ -71,8 +71,7 @@
<p>
Juneau supports generation and consumption of Swagger 2.0 documents and fragments through the use of DTOs
(Data Transfer Objects).
- <br>
- It uses existing support for serializing and parsing POJOs to and from JSON to define these objects.
+ <br>It uses existing support for serializing and parsing POJOs to and from JSON to define these objects.
</p>
<!-- ======================================================================================================== -->
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
index 40537ab..0f46b1e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
@@ -55,18 +55,21 @@ import org.apache.juneau.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
* - Properties associated with handling beans on serializers and parsers.
- * <ul>
- * <li class='jc'><a class="doclink"
- * href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
- * - Configurable properties common to all serializers.
* <ul>
- * <li class='jc'><a class="doclink"
- * href="../html/HtmlSerializerContext.html#ConfigProperties">HtmlSerializerContext</a>
- * - Configurable properties on the HTML serializer.
+ * <li class='jc'>
+ * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../html/HtmlSerializerContext.html#ConfigProperties">HtmlSerializerContext</a>
+ * - Configurable properties on the HTML serializer.
+ * </ul>
+ * </li>
* </ul>
- * </ul>
+ * </li>
* </ul>
*/
public final class HtmlDocSerializerContext extends HtmlSerializerContext {
@@ -82,7 +85,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* </ul>
* <p>
* Specifies the text for the title that shows up in the header section of the page generated by the basic template.
- * <p>
*
* <h5 class='section'>Example:</h5>
* <p>
@@ -142,7 +144,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <p>
* Specifies the text for the subtitle that shows up in the header section of the page generated by the basic
* template.
- * <p>
*
* <h5 class='section'>Example:</h5>
* <p>
@@ -220,7 +221,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <p>
* Allows you to override the contents of the header section on the HTML page.
* The header section normally contains the title and description at the top of the page.
- * <p>
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -310,7 +310,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <p>
* Allows you to override the contents of the nav section on the HTML page.
* The nav section normally contains the page links at the top of the page.
- * <p>
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -342,7 +341,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* the page.
* <p>
* By default, the aside section is empty.
- * <p>
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -370,7 +368,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* Allows you to specify the contents of the footer section on the HTML page.
* <p>
* By default, the footer section is empty.
- * <p>
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -396,7 +393,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* </ul>
* <p>
* Allows you to specify the string message used when trying to serialize an empty array or empty list.
- * <p>
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java
index e27737a..5541aba 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java
@@ -25,12 +25,15 @@ import org.apache.juneau.xml.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <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='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> -
- * Configurable properties common to all parsers.
- * </ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * - Properties associated with handling beans on serializers and parsers.
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a>
+ * - Configurable properties common to all parsers.
+ * </ul>
+ * </li>
* </ul>
*/
public final class HtmlParserContext extends XmlParserContext {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java
index 77e93a9..022fdab 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java
@@ -41,12 +41,16 @@ import org.apache.juneau.xml.annotation.*;
* <p>
* The conversion is as follows...
* <ul class='spaced-list'>
- * <li>{@link Map Maps} (e.g. {@link HashMap}, {@link TreeMap}) and beans are converted to HTML tables with
+ * <li>
+ * {@link Map Maps} (e.g. {@link HashMap}, {@link TreeMap}) and beans are converted to HTML tables with
* 'key' and 'value' columns.
- * <li>{@link Collection Collections} (e.g. {@link HashSet}, {@link LinkedList}) and Java arrays are converted
+ * <li>
+ * {@link Collection Collections} (e.g. {@link HashSet}, {@link LinkedList}) and Java arrays are converted
* to HTML ordered lists.
- * <li>{@code Collections} of {@code Maps} and beans are converted to HTML tables with keys as headers.
- * <li>Everything else is converted to text.
+ * <li>
+ * {@code Collections} of {@code Maps} and beans are converted to HTML tables with keys as headers.
+ * <li>
+ * Everything else is converted to text.
* </ul>
* <p>
* This serializer provides several serialization options. Typically, one of the predefined <jsf>DEFAULT</jsf>
@@ -59,15 +63,18 @@ import org.apache.juneau.xml.annotation.*;
* <p>
* This class has the following properties associated with it:
* <ul class='spaced-list'>
- * <li>{@link HtmlSerializerContext}
+ * <li>
+ * {@link HtmlSerializerContext}
* </ul>
*
* <h6 class='topic'>Behavior-specific subclasses</h6>
* <p>
* The following direct subclasses are provided for convenience:
* <ul class='spaced-list'>
- * <li>{@link Sq} - Default serializer, single quotes.
- * <li>{@link SqReadable} - Default serializer, single quotes, whitespace added.
+ * <li>
+ * {@link Sq} - Default serializer, single quotes.
+ * <li>
+ * {@link SqReadable} - Default serializer, single quotes, whitespace added.
* </ul>
*
* <h5 class='section'>Example:</h5>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
index 3a3c620..c6cb528 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
@@ -67,15 +67,20 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
* <p>
* Possible values:
* <ul class='spaced-list'>
- * <li>{@link HtmlSerializerContext#TO_STRING} / <js>"toString"</js> - Set to whatever is returned by
+ * <li>
+ * {@link HtmlSerializerContext#TO_STRING} / <js>"toString"</js> - Set to whatever is returned by
* {@link #toString()} on the object.
- * <li>{@link HtmlSerializerContext#URI} / <js>"uri"</js> - Set to the URI value.
- * <li>{@link HtmlSerializerContext#LAST_TOKEN} / <js>"lastToken"</js> - Set to the last token of the URI value.
- * <li>{@link HtmlSerializerContext#PROPERTY_NAME} / <js>"propertyName"</js> - Set to the bean property name.
- * <li>{@link HtmlSerializerContext#URI_ANCHOR} / <js>"uriAnchor"</js> - Set to the anchor of the URL.
+ * <li>
+ * {@link HtmlSerializerContext#URI} / <js>"uri"</js> - Set to the URI value.
+ * <li>
+ * {@link HtmlSerializerContext#LAST_TOKEN} / <js>"lastToken"</js> - Set to the last token of the URI value.
+ * <li>
+ * {@link HtmlSerializerContext#PROPERTY_NAME} / <js>"propertyName"</js> - Set to the bean property name.
+ * <li>
+ * {@link HtmlSerializerContext#URI_ANCHOR} / <js>"uriAnchor"</js> - Set to the anchor of the URL.
* (e.g. <js>"http://localhost:9080/foobar#anchorTextHere"</js>)
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>HTML_uriAnchorText</jsf>, value)</code>.
@@ -102,7 +107,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
* <p>
* If a string looks like a URL (e.g. starts with <js>"http://"</js> or <js>"https://"</js>, then treat it like a URL
* and make it into a hyperlink based on the rules specified by {@link HtmlSerializerContext#HTML_uriAnchorText}.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>HTML_detectLinksInStrings</jsf>, value)</code>.
@@ -130,7 +135,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
* If the URL has a label parameter (e.g. <js>"?label=foobar"</js>), then use that as the anchor text of the link.
* <p>
* The parameter name can be changed via the {@link HtmlSerializerContext#HTML_labelParameter} property.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>HTML_lookForLabelParameters</jsf>, value)</code>.
@@ -155,7 +160,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
* <li><b>Default:</b> <js>"label"</js>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>HTML_labelParameter</jsf>, value)</code>.
@@ -179,7 +184,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>HTML_addKeyValueTableHeaders</jsf>, value)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
index 11a43c0..f66b94f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
@@ -26,12 +26,15 @@ import org.apache.juneau.xml.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <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='jc'><a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">
- * SerializerContext</a> - Configurable properties common to all serializers.
- * </ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * - Properties associated with handling beans on serializers and parsers.
+ * <ul>
+ * <li class='jc'>
+ * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * - Configurable properties common to all serializers.
+ * </ul>
+ * </li>
* </ul>
*/
public class HtmlSerializerContext extends XmlSerializerContext {
@@ -51,12 +54,17 @@ public class HtmlSerializerContext extends XmlSerializerContext {
* <p>
* Possible values:
* <ul class='spaced-list'>
- * <li>{@link #TO_STRING} / <js>"toString"</js> - Set to whatever is returned by {@link #toString()} on the
+ * <li>
+ * {@link #TO_STRING} / <js>"toString"</js> - Set to whatever is returned by {@link #toString()} on the
* object.
- * <li>{@link #URI} / <js>"uri"</js> - Set to the URI value.
- * <li>{@link #LAST_TOKEN} / <js>"lastToken"</js> - Set to the last token of the URI value.
- * <li>{@link #PROPERTY_NAME} / <js>"propertyName"</js> - Set to the bean property name.
- * <li>{@link #URI_ANCHOR} / <js>"uriAnchor"</js> - Set to the anchor of the URL.
+ * <li>
+ * {@link #URI} / <js>"uri"</js> - Set to the URI value.
+ * <li>
+ * {@link #LAST_TOKEN} / <js>"lastToken"</js> - Set to the last token of the URI value.
+ * <li>
+ * {@link #PROPERTY_NAME} / <js>"propertyName"</js> - Set to the bean property name.
+ * <li>
+ * {@link #URI_ANCHOR} / <js>"uriAnchor"</js> - Set to the anchor of the URL.
* (e.g. <js>"http://localhost:9080/foobar#anchorTextHere"</js>)
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/html/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/package.html b/juneau-core/src/main/java/org/apache/juneau/html/package.html
index 83e97fa..7d36182 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/html/package.html
@@ -74,6 +74,7 @@
The following examples show how different data types are represented in HTML.
They mirror how the data structures are represented in JSON.
</p>
+
<h6 class='topic'>Simple types</h6>
<p>
The representation for simple types mirror those produced by the XML serializer.
@@ -112,6 +113,7 @@
<td class='code'><xt><null/></xt></td>
</tr>
</table>
+
<h6 class='topic'>Maps</h6>
<p>
Maps and beans are represented as tables.
@@ -492,6 +494,7 @@
</xt></td>
</tr>
</table>
+
<h6 class='topic'>Beans with Map properties</h6>
<table class='styled' style='width:auto'>
<tr>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Accept.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Accept.java b/juneau-core/src/main/java/org/apache/juneau/http/Accept.java
index cdf7fa7..48d6373 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Accept.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Accept.java
@@ -127,8 +127,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
@@ -176,12 +178,10 @@ public final class Accept {
* <p>
* Note that fuzzy matching is allowed on the media types where the <code>Accept</code> header may
* contain additional subtype parts.
- * <br>
- * For example, given identical q-values and an <code>Accept</code> value of <js>"text/json+activity"</js>,
+ * <br>For example, given identical q-values and an <code>Accept</code> value of <js>"text/json+activity"</js>,
* the media type <js>"text/json"</js> will match if <js>"text/json+activity"</js> or <js>"text/activity+json"</js>
* isn't found.
- * <br>
- * The purpose for this is to allow serializers to match when artifacts such as <code>id</code> properties are
+ * <br>The purpose for this is to allow serializers to match when artifacts such as <code>id</code> properties are
* present in the header.
* <p>
* See <a class='doclink' href='https://www.w3.org/TR/activitypub/#retrieving-objects'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java b/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java
index 5a88ba5..295aceb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java
@@ -60,8 +60,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java b/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java
index fa6f918..c9e7fef 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java
@@ -80,8 +80,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java b/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java
index 3e6805d..0eb3454 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java
@@ -87,8 +87,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java b/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java
index 6bd4051..0ce6df4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java
@@ -51,8 +51,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Age.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Age.java b/juneau-core/src/main/java/org/apache/juneau/http/Age.java
index a452e5b..b1b1ce9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Age.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Age.java
@@ -46,8 +46,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Allow.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Allow.java b/juneau-core/src/main/java/org/apache/juneau/http/Allow.java
index 0776437..7baa277 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Allow.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Allow.java
@@ -54,8 +54,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java b/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java
index 10919c6..f4fc56b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java
@@ -60,8 +60,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java b/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java
index eec8b0a..7fee28b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java
@@ -84,8 +84,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Connection.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Connection.java b/juneau-core/src/main/java/org/apache/juneau/http/Connection.java
index d49bd96..aed6e82 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Connection.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Connection.java
@@ -63,8 +63,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Constants.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Constants.java b/juneau-core/src/main/java/org/apache/juneau/http/Constants.java
index fdb5f3a..2547b48 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Constants.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Constants.java
@@ -17,8 +17,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java
index 05b5e02..04ebf3e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java
@@ -56,8 +56,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
index 111cd50..9e7e820 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
@@ -17,8 +17,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java
index db8974a..09cb94b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java
@@ -60,8 +60,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java
index a06cc5e..94ca051 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java
@@ -49,8 +49,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java
index 5325bb0..cf71009 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java
@@ -54,8 +54,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java
index 19bc129..78811e2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java
@@ -108,8 +108,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java
index af0c33a..7c1ec7d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java
@@ -42,8 +42,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
@@ -76,13 +78,11 @@ public class ContentType extends MediaType {
* <p>
* Note that fuzzy matching is allowed on the media types where the <code>Content-Types</code> header may
* contain additional subtype parts.
- * <br>
- * For example, given a <code>Content-Type</code> value of <js>"text/json+activity"</js>,
+ * <br>For example, given a <code>Content-Type</code> value of <js>"text/json+activity"</js>,
* the media type <js>"text/json"</js> will match if <js>"text/json+activity"</js> or <js>"text/activity+json"</js>
* isn't found.
- * <br>
- * The purpose for this is to allow parsers to match when artifacts such as <code>id</code> properties are present
- * in the header.
+ * <br>The purpose for this is to allow parsers to match when artifacts such as <code>id</code> properties are
+ * present in the header.
*
* @param mediaTypes The media types to match against.
* @return The index into the array of the best match, or <code>-1</code> if no suitable matches could be found.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Date.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Date.java b/juneau-core/src/main/java/org/apache/juneau/http/Date.java
index a021a37..310836b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Date.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Date.java
@@ -65,8 +65,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/ETag.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ETag.java b/juneau-core/src/main/java/org/apache/juneau/http/ETag.java
index d9c2dbb..0fe1d44 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ETag.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ETag.java
@@ -40,8 +40,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java b/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java
index fe10c90..65865c9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java
@@ -23,8 +23,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Expect.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Expect.java b/juneau-core/src/main/java/org/apache/juneau/http/Expect.java
index c212c2c..0a69862 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Expect.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Expect.java
@@ -55,8 +55,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Expires.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Expires.java b/juneau-core/src/main/java/org/apache/juneau/http/Expires.java
index acf5b62..80e26bd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Expires.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Expires.java
@@ -62,8 +62,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/From.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/From.java b/juneau-core/src/main/java/org/apache/juneau/http/From.java
index ecd2c69..14d5609 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/From.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/From.java
@@ -54,8 +54,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java
index 84ca1f0..a1b7b92 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java
@@ -24,8 +24,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
index 230765c..d0faf41 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
@@ -22,8 +22,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
index e5e7a0b..4ba2259 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
@@ -26,8 +26,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java
index a206c03..230aa61 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java
@@ -19,14 +19,17 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Accept-Ranges: bytes
* </p>
- * @param <E> The enum type.
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
+ *
+ * @param <E> The enum type.
*/
public class HeaderEnum<E extends Enum<E>> {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java
index 7cd167e..4a628f3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java
@@ -22,8 +22,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
index e7c6978..6401574 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
@@ -26,8 +26,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java
index 2efc800..5195550 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java
@@ -24,8 +24,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java
index 7897aab..6ba933e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java
@@ -24,8 +24,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java
index df46496..c4c976d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java
@@ -26,8 +26,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/Host.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Host.java b/juneau-core/src/main/java/org/apache/juneau/http/Host.java
index 3290732..d60c6a1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Host.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Host.java
@@ -57,8 +57,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java b/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java
index 21f8845..76876ae 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java
@@ -19,8 +19,10 @@ import java.util.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java b/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java
index 667586c..e8a09c6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java
@@ -72,8 +72,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java b/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java
index 3dd007c..30adcfe 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java
@@ -74,8 +74,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java b/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java
index 4cbf3bd..1494f9b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java
@@ -77,8 +77,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java b/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java
index b22942d..6fe2995 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java
@@ -54,8 +54,10 @@ import org.apache.juneau.internal.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java b/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
index 30c6d8c..a5d83a3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
@@ -48,8 +48,10 @@ package org.apache.juneau.http;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
- * <li class='extlink'><a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.http</a>
+ * <li class='extlink'>
+ * <a class='doclink' href='https://www.w3.org/Protocols/rfc2616/rfc2616.html'>
* Hypertext Transfer Protocol -- HTTP/1.1</a>
* </ul>
*/
[09/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/javadoc/overview.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/javadoc/overview.html b/juneau-core/src/main/javadoc/overview.html
index 8537719..30be514 100644
--- a/juneau-core/src/main/javadoc/overview.html
+++ b/juneau-core/src/main/javadoc/overview.html
@@ -56,12 +56,18 @@
}
</script>
<ul class='spaced-list'>
- <li>A toolkit for marshalling POJOs to a wide variety of content types using a common framework.
- <li>A REST server API for creating self-documenting REST interfaces using POJOs.
- <li>A REST client API for interacting with REST interfaces using POJOs.
- <li>A remote proxy API built on top of REST.
- <li>A sophisticated INI config file API.
- <li>A REST microservice API that combines all the features above for creating lightweight stand-alone REST
+ <li>
+ A toolkit for marshalling POJOs to a wide variety of content types using a common framework.
+ <li>
+ A REST server API for creating self-documenting REST interfaces using POJOs.
+ <li>
+ A REST client API for interacting with REST interfaces using POJOs.
+ <li>
+ A remote proxy API built on top of REST.
+ <li>
+ A sophisticated INI config file API.
+ <li>
+ A REST microservice API that combines all the features above for creating lightweight stand-alone REST
interfaces that start up in milliseconds.
</ul>
@@ -173,6 +179,7 @@
<p>
In 2016, the code was donated to the Apache Foundation under the project <l>Apache Juneau</l>.
</p>
+
<h5 class='toc'>Features</h5>
<ol class='toc'>
<li>
@@ -246,34 +253,39 @@
Juneau requires Java 6+. The majority of the code has no other dependencies except for the following packages:
</p>
<ul class='doctree'>
- <li class='jp'> <a class='doclink'
- href='org/apache/juneau/jena/package-summary.html#TOC'>org.apache.juneau.jena</a>
+ <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>
+ <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>
+ <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:
</p>
<ul class='spaced-list'>
- <li><l>org.apache.juneau.core.jar</l> - Serializers, parsers, INI file support.
- <li><l>org.apache.juneau.rest.jar</l> - REST servlet support.
- <li><l>org.apache.juneau.rest.client.jar</l> - REST client support.
- <li><l>org.apache.juneau.microservice.jar</l> - Microservice support.
+ <li>
+ <l>org.apache.juneau.core.jar</l> - Serializers, parsers, INI file support.
+ <li>
+ <l>org.apache.juneau.rest.jar</l> - REST servlet support.
+ <li>
+ <l>org.apache.juneau.rest.client.jar</l> - REST client support.
+ <li>
+ <l>org.apache.juneau.microservice.jar</l> - Microservice support.
</ul>
<p>
The following zip files are also provided:
</p>
<ul class='spaced-list'>
- <li><l>microservice-project.zip</l> - Contains a template Eclipse project for quickly creating REST resources
+ <li>
+ <l>microservice-project.zip</l> - Contains a template Eclipse project for quickly creating REST resources
as executable jars.
- <li><l>microservice-samples-project.zip</l> - Contains sample code demonstrating various aspects of Juneau.
- <br>
- These are discussed in detail in the <a class='doclink' href="#Samples">Samples</a> section.
+ <li>
+ <l>microservice-samples-project.zip</l> - Contains sample code demonstrating various aspects of Juneau.
+ <br>These are discussed in detail in the <a class='doclink' href="#Samples">Samples</a> section.
</ul>
<ul class='doctree'>
@@ -373,15 +385,14 @@
<p>
Default serialization support is provided for Java primitives, <code>Maps</code>, <code>Collections</code>,
beans, and arrays.
- <br>
- Extensible support for other data types such as <code>Calendars</code>, <code>Dates</code>,
+ <br>Extensible support for other data types such as <code>Calendars</code>, <code>Dates</code>,
<code>Iterators</code> is available through the use of POJO swaps (described later).
</p>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink'
- href='org/apache/juneau/serializer/package-summary.html#TOC'>org.apache.juneau.serializer</a>
+ <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>
@@ -456,19 +467,18 @@
</p>
<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 fragments 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.
+ 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 fragments 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.
</ul>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink'
- href='org/apache/juneau/parser/package-summary.html#TOC'>org.apache.juneau.parser</a>
+ <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>
@@ -508,10 +518,13 @@
to provide annotated REST servlets that automatically negotiate the HTTP media types and allow the developer
to work with requests and responses as POJOs.
</p>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jc'>{@link org.apache.juneau.serializer.SerializerGroup}
- <li class='jc'>{@link org.apache.juneau.parser.ParserGroup}
+ <li class='jc'>
+ {@link org.apache.juneau.serializer.SerializerGroup}
+ <li class='jc'>
+ {@link org.apache.juneau.parser.ParserGroup}
</ul>
</div>
@@ -531,14 +544,20 @@
These classes extend directly from the following JCF classes:
</p>
<ul class='doctree'>
- <li class='jc'> {@link java.util.LinkedHashMap java.util.LinkedHashMap}
- <ul>
- <li class='jc'> {@link org.apache.juneau.ObjectMap org.apache.juneau.ObjectMap}
- </ul>
- <li class='jc'> {@link java.util.LinkedList java.util.LinkedList}
- <ul>
- <li class='jc'> {@link org.apache.juneau.ObjectMap org.apache.juneau.ObjectList}
- </ul>
+ <li class='jc'>
+ {@link java.util.LinkedHashMap java.util.LinkedHashMap}
+ <ul>
+ <li class='jc'>
+ {@link org.apache.juneau.ObjectMap org.apache.juneau.ObjectMap}
+ </ul>
+ </li>
+ <li class='jc'>
+ {@link java.util.LinkedList java.util.LinkedList}
+ <ul>
+ <li class='jc'>
+ {@link org.apache.juneau.ObjectMap org.apache.juneau.ObjectList}
+ </ul>
+ </li>
</ul>
<p>
The <l>ObjectMap</l> and <l>ObjectList</l> classes are very similar to the <l>JSONObject</l> and
@@ -550,9 +569,11 @@
These object can be serialized in one of two ways:
</p>
<ol class='spaced-list'>
- <li>Using the provided {@link org.apache.juneau.ObjectMap#serializeTo(java.io.Writer)} or
+ <li>
+ Using the provided {@link org.apache.juneau.ObjectMap#serializeTo(java.io.Writer)} or
{@link org.apache.juneau.ObjectList#serializeTo(java.io.Writer)} methods.
- <li>Passing them to one of the {@link org.apache.juneau.serializer.Serializer} serialize methods.
+ <li>
+ Passing them to one of the {@link org.apache.juneau.serializer.Serializer} serialize methods.
</ol>
<p>
Any valid JSON can be parsed into an unstructured model consisting of generic
@@ -579,10 +600,13 @@
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='doctree'>
- <li class='jc'>{@link org.apache.juneau.ObjectMap}
- <li class='jc'>{@link org.apache.juneau.ObjectList}
+ <li class='jc'>
+ {@link org.apache.juneau.ObjectMap}
+ <li class='jc'>
+ {@link org.apache.juneau.ObjectList}
</ul>
</div>
@@ -592,30 +616,38 @@
<div class='topic'>
<p>
Serializers and parsers have a wide variety of configurable properties.
- <br>
- For example, the following code shows how to configure a JSON serializer:
+ <br>For example, the following code shows how to configure a JSON serializer:
</p>
<p class='bcode'>
JsonSerializer s = <jk>new</jk> JsonSerializerBuilder().simple().ws().sq().build();
</p>
<p>
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:
+ <br>For example, JSON has the following predefined reusable serializers and parsers:
</p>
<ul class='doctree'>
- <li class='jc'>{@link org.apache.juneau.json.JsonSerializer}
- <ul>
- <li class='jf'>{@link org.apache.juneau.json.JsonSerializer#DEFAULT DEFAULT}
- <li class='jf'>{@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX DEFAULT_LAX}
- <li class='jf'>{@link org.apache.juneau.json.JsonSerializer#DEFAULT_READABLE DEFAULT_READABLE}
- <li class='jf'>{@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX_READABLE DEFAULT_LAX_READABLE}
- </ul>
- <li class='jc'>{@link org.apache.juneau.json.JsonParser}
- <ul>
- <li class='jf'>{@link org.apache.juneau.json.JsonParser#DEFAULT DEFAULT}
- <li class='jf'>{@link org.apache.juneau.json.JsonParser#DEFAULT_STRICT DEFAULT_STRICT}
- </ul>
+ <li class='jc'>
+ {@link org.apache.juneau.json.JsonSerializer}
+ <ul>
+ <li class='jf'>
+ {@link org.apache.juneau.json.JsonSerializer#DEFAULT DEFAULT}
+ <li class='jf'>
+ {@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX DEFAULT_LAX}
+ <li class='jf'>
+ {@link org.apache.juneau.json.JsonSerializer#DEFAULT_READABLE DEFAULT_READABLE}
+ <li class='jf'>
+ {@link org.apache.juneau.json.JsonSerializer#DEFAULT_LAX_READABLE DEFAULT_LAX_READABLE}
+ </ul>
+ </li>
+ <li class='jc'>
+ {@link org.apache.juneau.json.JsonParser}
+ <ul>
+ <li class='jf'>
+ {@link org.apache.juneau.json.JsonParser#DEFAULT DEFAULT}
+ <li class='jf'>
+ {@link org.apache.juneau.json.JsonParser#DEFAULT_STRICT DEFAULT_STRICT}
+ </ul>
+ </li>
</ul>
<p>
These can be used directly, as follows:
@@ -644,38 +676,84 @@
The following is a list of all configurable properties across all serializers and parsers.
</p>
<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='jc'><a class='doclink' href='org/apache/juneau/serializer/SerializerContext.html#ConfigProperties'>SerializerContext</a> - Configurable properties common to all serializers.
- <ul>
- <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='jc'><a class='doclink' href='org/apache/juneau/html/HtmlDocSerializerContext.html#ConfigProperties'>HtmlDocSerializerContext</a> - Configurable properties on the HTML document serializer.
- </ul>
- <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='jc'><a class='doclink' href='org/apache/juneau/jena/RdfSerializerContext.html#ConfigProperties'>RdfSerializerContext</a> - Configurable properties on the RDF serializers.
- </ul>
- <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='jc'><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/BeanContext.html#ConfigProperties'>BeanContext</a>
+ - Properties associated with handling beans on serializers and parsers.
<ul>
- <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='jc'><a class='doclink' href='org/apache/juneau/jena/RdfParserContext.html#ConfigProperties'>RdfParserContext</a> - Configurable properties on the RDF parsers.
- </ul>
- <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.
+ <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='jc'>
+ <a class='doclink' href='org/apache/juneau/html/HtmlSerializerContext.html#ConfigProperties'>HtmlSerializerContext</a>
+ - Configurable properties on the HTML serializer.
+ <ul>
+ <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>
+ <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='jc'>
+ <a class='doclink' href='org/apache/juneau/jena/RdfSerializerContext.html#ConfigProperties'>RdfSerializerContext</a>
+ - Configurable properties on the RDF serializers.
+ </ul>
+ </li>
+ <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>
+ <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='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='jc'><a class='doclink' href='org/apache/juneau/jena/RdfParserContext.html#ConfigProperties'>RdfParserContext</a>
+ - Configurable properties on the RDF parsers.
+ </ul>
+ </li>
+ <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>
+ </li>
</ul>
- </ul>
- <li class='jc'><a class='doclink' href='org/apache/juneau/server/RestContext.html#ConfigProperties'>RestContext</a> - Configurable properties on the REST servlet.
+ </li>
+ <li class='jc'>
+ <a class='doclink' href='org/apache/juneau/server/RestContext.html#ConfigProperties'>RestContext</a>
+ - Configurable properties on the REST servlet.
+ </li>
</ul>
</div>
@@ -689,30 +767,40 @@
These classes are:
</p>
<ul class='doctree'>
- <li class='jc'>{@link org.apache.juneau.transform.PojoSwap}
+ <li class='jc'>
+ {@link org.apache.juneau.transform.PojoSwap}
- Tailor how specific non-bean classes are handled by the framework.
- <li class='jc'>{@link org.apache.juneau.transform.BeanFilter}
+ <li class='jc'>
+ {@link org.apache.juneau.transform.BeanFilter}
- 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='doctree'>
- <li class='ja'>{@link org.apache.juneau.annotation.Pojo @Pojo}
+ <li class='ja'>
+ {@link org.apache.juneau.annotation.Pojo @Pojo}
- Used to tailor how non-bean POJOs get interpreted by the framework.
- <li class='ja'>{@link org.apache.juneau.annotation.Bean @Bean}
+ <li class='ja'>
+ {@link org.apache.juneau.annotation.Bean @Bean}
- Used to tailor how beans get interpreted by the framework.
- <li class='ja'>{@link org.apache.juneau.annotation.BeanConstructor @BeanConstructor}
+ <li class='ja'>
+ {@link org.apache.juneau.annotation.BeanConstructor @BeanConstructor}
- Maps constructor arguments to property names on beans with read-only properties.
- <li class='ja'>{@link org.apache.juneau.annotation.BeanIgnore @BeanIgnore}
+ <li class='ja'>
+ {@link org.apache.juneau.annotation.BeanIgnore @BeanIgnore}
- Ignore classes, fields, and methods from being interpreted as bean or bean components.
- <li class='ja'>{@link org.apache.juneau.annotation.BeanProperty @BeanProperty}
+ <li class='ja'>
+ {@link org.apache.juneau.annotation.BeanProperty @BeanProperty}
- Used to tailor how bean properties get interpreted by the framework.
- <li class='ja'>{@link org.apache.juneau.annotation.NameProperty @NameProperty}
+ <li class='ja'>
+ {@link org.apache.juneau.annotation.NameProperty @NameProperty}
- Identifies a setter as a method for setting the name of a POJO as it's known by its parent object.
- <li class='ja'>{@link org.apache.juneau.annotation.ParentProperty @ParentProperty}
+ <li class='ja'>
+ {@link org.apache.juneau.annotation.ParentProperty @ParentProperty}
- Identifies a setter as a method for adding a parent reference to a child object.
- <li class='ja'>{@link org.apache.juneau.annotation.URI @URI}
+ <li class='ja'>
+ {@link org.apache.juneau.annotation.URI @URI}
- Used to identify a class or bean property as a URI.
</ul>
@@ -784,17 +872,25 @@
Several <code>PojoSwaps</code> are already provided for common Java objects:
</p>
<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='jc'>{@link org.apache.juneau.transforms.ByteArrayBase64Swap}
- <li class='jac'>{@link org.apache.juneau.transforms.CalendarSwap}
- <li class='jac'>{@link org.apache.juneau.transforms.DateSwap}
- <li class='jc'>{@link org.apache.juneau.transforms.EnumerationSwap}
- <li class='jc'>{@link org.apache.juneau.transforms.IteratorSwap}
- <li class='jc'>{@link org.apache.juneau.transforms.ReaderSwap}
- <li class='jc'>{@link org.apache.juneau.transforms.XMLGregorianCalendarSwap}
- </ul>
+ <li class='jp'>
+ <a class='doclink' href='org/apache/juneau/transforms/package-summary.html#TOC'>org.apache.juneau.transforms</a>
+ <ul>
+ <li class='jc'>
+ {@link org.apache.juneau.transforms.ByteArrayBase64Swap}
+ <li class='jac'>
+ {@link org.apache.juneau.transforms.CalendarSwap}
+ <li class='jac'>
+ {@link org.apache.juneau.transforms.DateSwap}
+ <li class='jc'>
+ {@link org.apache.juneau.transforms.EnumerationSwap}
+ <li class='jc'>
+ {@link org.apache.juneau.transforms.IteratorSwap}
+ <li class='jc'>
+ {@link org.apache.juneau.transforms.ReaderSwap}
+ <li class='jc'>
+ {@link org.apache.juneau.transforms.XMLGregorianCalendarSwap}
+ </ul>
+ </li>
</ul>
<p>
In particular, the {@link org.apache.juneau.transforms.CalendarSwap} and
@@ -803,8 +899,8 @@
</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'
+ 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>
@@ -821,10 +917,10 @@
Objects serialized as <code>Strings</code> can be parsed back into their original objects by
implementing one of the following methods on the class:
</p>
- <ul>
- <li><code><jk>public static</jk> T fromString(String)</code> method.
- <br>
- Any of the following method names also work:
+ <ul class='spaced-list'>
+ <li>
+ <code><jk>public static</jk> T fromString(String)</code> method.
+ <br>Any of the following method names also work:
<ul>
<li><code>valueOf(String)</code>
<li><code>parse(String)</code>
@@ -832,7 +928,8 @@
<li><code>forName(String)</code>
<li><code>forString(String)</code>
</ul>
- <li><code><jk>public</jk> T(String)</code> constructor.
+ <li>
+ <code><jk>public</jk> T(String)</code> constructor.
</ul>
<p>
Note that these methods cover conversion from several built-in Java types, meaning the parsers can
@@ -1030,8 +1127,8 @@
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink'
- href='org/apache/juneau/transform/package-summary.html#TOC'>org.apache.juneau.transform</a>
+ <li class='jp'>
+ <a class='doclink' href='org/apache/juneau/transform/package-summary.html#TOC'>org.apache.juneau.transform</a>
</ul>
</div>
@@ -1281,9 +1378,9 @@
<tr class='light bb'>
<td style='text-align:center'>2a</td>
<td>
- <b>With standard keys/values</b><br>
- Map keys are group [1, 4a, 5a] objects.<br>
- Map, Collection, and array values are group [1, 2, 3ac, 4a, 5a] objects.
+ <b>With standard keys/values</b>
+ <br>Map keys are group [1, 4a, 5a] objects.
+ <br>Map, Collection, and array values are group [1, 2, 3ac, 4a, 5a] objects.
</td>
<td>
<ul class='normal'>
@@ -1299,9 +1396,9 @@
<tr class='light bb'>
<td style='text-align:center'>2b</td>
<td>
- <b>With non-standard keys/values</b><br>
- Map keys are group [2, 3, 4b, 5b, 6] objects.<br>
- Map, Collection, and array values are group [3b, 4b, 5b, 6] objects.
+ <b>With non-standard keys/values</b>
+ <br>Map keys are group [2, 3, 4b, 5b, 6] objects.
+ <br>Map, Collection, and array values are group [3b, 4b, 5b, 6] objects.
</td>
<td>
<ul class='normal'>
@@ -1322,10 +1419,10 @@
<tr class='light bb'>
<td style='text-align:center'>3a</td>
<td>
- <b>With standard properties</b><br>
- These are beans that have no-arg constructors and one or more properties defined by public getter
- and setter methods or public fields.<br>
- Property values are group [1, 2, 3ac, 4a, 5a] objects.
+ <b>With standard properties</b>
+ <br>These are beans that have no-arg constructors and one or more properties defined by public getter
+ and setter methods or public fields.
+ <br>Property values are group [1, 2, 3ac, 4a, 5a] objects.
</td>
<td> </td>
<td style='background-color:lightgreen;text-align:center'><b>yes</b></td>
@@ -1334,10 +1431,10 @@
<tr class='light bb'>
<td style='text-align:center'>3b</td>
<td>
- <b>With non-standard properties or not true beans</b><br>
- These include true beans that have no-arg constructors and one or more properties defined by getter
- and setter methods or properties, but property types include group [3b, 4b, 5b, 6] objects.<br>
- This also includes classes that look like beans but aren't true beans.
+ <b>With non-standard properties or not true beans</b>
+ <br>These include true beans that have no-arg constructors and one or more properties defined by getter
+ and setter methods or properties, but property types include group [3b, 4b, 5b, 6] objects.
+ <br>This also includes classes that look like beans but aren't true beans.
For example, classes that have getters but not setters, or classes without no-arg constructors.
</td>
<td> </td>
@@ -1347,9 +1444,9 @@
<tr class='light bb'>
<td style='text-align:center'>3c</td>
<td>
- <b>Virtual beans</b><br>
- These are unimplemented bean interfaces with properties of type [1, 2, 3ac, 4a, 5a] objects.<br>
- Parsers will automatically create interface proxies on top of BeanMap instances.
+ <b>Virtual beans</b>
+ <br>These are unimplemented bean interfaces with properties of type [1, 2, 3ac, 4a, 5a] objects.
+ <br>Parsers will automatically create interface proxies on top of BeanMap instances.
</td>
<td> </td>
<td style='background-color:lightgreen;text-align:center'><b>yes</b></td>
@@ -1358,8 +1455,8 @@
<tr class='dark bb' style='background-color:lightyellow'>
<td style='text-align:center'>4</td>
<td>
- <b>Swapped objects</b><br>
- These are objects that are not directly serializable, but have
+ <b>Swapped objects</b>
+ <br>These are objects that are not directly serializable, but have
{@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated with them.
The purpose of a POJO swap is to convert an object to another object that is easier to serialize
and parse.
@@ -1374,8 +1471,8 @@
<tr class='light bb'>
<td style='text-align:center'>4a</td>
<td>
- <b>2-way swapped to group [1, 2a, 3ac] objects</b><br>
- For example, a swap that converts a {@code Date} to a {@code String}.
+ <b>2-way swapped to group [1, 2a, 3ac] objects</b>
+ <br>For example, a swap that converts a {@code Date} to a {@code String}.
</td>
<td>
<ul class='normal'>
@@ -1389,8 +1486,8 @@
<tr class='light bb'>
<td style='text-align:center'>4b</td>
<td>
- <b>1-way swapped to group [1, 2, 3] objects</b><br>
- For example, a swap that converts an {@code Iterator} to a {@code List}.
+ <b>1-way swapped to group [1, 2, 3] objects</b>
+ <br>For example, a swap that converts an {@code Iterator} to a {@code List}.
This would be one way, since you cannot reconstruct an {@code Iterator}.
</td>
<td>
@@ -1466,8 +1563,7 @@
<td style='text-align:center'>6</td>
<td>
<b>All other objects</b>
- <br>
- Anything that doesn't fall into one of the groups above are simply converted to {@code Strings}
+ <br>Anything that doesn't fall into one of the groups above are simply converted to {@code Strings}
using the {@code toString()} method.
</td>
<td> </td>
@@ -1518,10 +1614,11 @@
SVL is a large topic on it's own.
It is used extensively in the ConfigFile, REST and Microservice APIs.
</p>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink'
- href='org/apache/juneau/svl/package-summary.html#TOC'>org.apache.juneau.svl</a>
+ <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>
@@ -1630,11 +1727,15 @@
capabilities, including:
</p>
<ul class='spaced-list'>
- <li>The ability to use variables to reference environment variables, system properties, other config file
+ <li>
+ The ability to use variables to reference environment variables, system properties, other config file
entries, and a host of other types.
- <li>APIs for updating, modifying, and saving configuration files without losing comments or formatting.
- <li>Extensive listener APIs.
+ <li>
+ APIs for updating, modifying, and saving configuration files without losing comments or formatting.
+ <li>
+ Extensive listener APIs.
</ul>
+
<h6 class='topic'>Example:</h6>
<p class='bcode'>
<cc>#--------------------------</cc>
@@ -1765,10 +1866,12 @@
ci.setBean(<jk>new</jk> MyBean());
cf.save();
</p>
+
<h6 class='topic'>Additional Information</h6>
<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.
+ <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>
@@ -1780,19 +1883,42 @@
Extensive javadocs exist for individual language support.
Refer to these docs for language-specific information.
</p>
+
<h6 class='topic'>Additional Information</h6>
<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.
+ <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>
@@ -1808,23 +1934,33 @@
<p>
The following charts describe equivalent features between the two libraries:
</p>
+
<h6 class='topic'>Annotations</h6>
<table class='styled'>
<tr><th>Jackson</th><th>Juneau</th></tr>
<tr>
- <td><ja>@JsonGetter</ja><br><ja>@JsonSetter</ja></td>
+ <td>
+ <ja>@JsonGetter</ja>
+ <br><ja>@JsonSetter</ja>
+ </td>
<td>
{@link org.apache.juneau.annotation.BeanProperty @BeanProperty}
</td>
</tr>
<tr>
- <td><ja>@JsonAnyGetter</ja><br><ja>@JsonAnySetter</ja></td>
+ <td>
+ <ja>@JsonAnyGetter</ja>
+ <br><ja>@JsonAnySetter</ja>
+ </td>
<td>
{@link org.apache.juneau.annotation.BeanProperty#name() @BeanProperty(name="*")}
</td>
</tr>
<tr>
- <td><ja>@JsonIgnore</ja><br><ja>@JsonIgnoreType</ja></td>
+ <td>
+ <ja>@JsonIgnore</ja>
+ <br><ja>@JsonIgnoreType</ja>
+ </td>
<td>
{@link org.apache.juneau.annotation.BeanIgnore @BeanIgnore}
</td>
@@ -1839,16 +1975,16 @@
<td><code><ja>@JsonAutoDetect</ja>(fieldVisibility=...)</code></td>
<td>
No equivalent annotation, but can be controlled via:
- <br>
- {@link org.apache.juneau.BeanContext#BEAN_beanFieldVisibility}
- <br>
- {@link org.apache.juneau.BeanContext#BEAN_methodVisibility}
- <br>
- Future annotation support planned.
+ <br>{@link org.apache.juneau.BeanContext#BEAN_beanFieldVisibility}
+ <br>{@link org.apache.juneau.BeanContext#BEAN_methodVisibility}
+ <br>Future annotation support planned.
</td>
</tr>
<tr>
- <td><ja>@JsonCreator</ja><br><ja>@JsonProperty</ja></td>
+ <td>
+ <ja>@JsonCreator</ja>
+ <br><ja>@JsonProperty</ja>
+ </td>
<td>
{@link org.apache.juneau.annotation.BeanConstructor @BeanConstructor}
</td>
@@ -1857,48 +1993,45 @@
<td><ja>@JacksonInject</ja></td>
<td>
No equivalent.
- <br>
- Future support planned.
+ <br>Future support planned.
</td>
</tr>
<tr>
- <td><ja>@JsonSerialize</ja><br><ja>@JsonDeserialize</ja></td>
+ <td>
+ <ja>@JsonSerialize</ja>
+ <br><ja>@JsonDeserialize</ja>
+ </td>
<td>
Juneau uses swaps to convert non-serializable object to serializable forms:
- <br>
- {@link org.apache.juneau.annotation.BeanProperty#swap() @BeanProperty(swap=...)}
- <br>
- {@link org.apache.juneau.annotation.Pojo#swap() @Pojo(swap=...)}
+ <br>{@link org.apache.juneau.annotation.BeanProperty#swap() @BeanProperty(swap=...)}
+ <br>{@link org.apache.juneau.annotation.Pojo#swap() @Pojo(swap=...)}
</td>
</tr>
<tr>
<td><ja>@JsonInclude</ja></td>
<td>
No equivalent annotation, but can be controlled via various settings:
- <br>
- {@link org.apache.juneau.BeanContext}
- <br>
- {@link org.apache.juneau.serializer.SerializerContext}
- <br>
- Future annotation support planned.
+ <br>{@link org.apache.juneau.BeanContext}
+ <br>{@link org.apache.juneau.serializer.SerializerContext}
+ <br>Future annotation support planned.
</td>
</tr>
<tr>
<td><ja>@JsonPropertyOrder</ja></td>
<td>
{@link org.apache.juneau.annotation.Bean#properties @Bean(properties="...")}
- <br>
- {@link org.apache.juneau.annotation.Bean#sort @Bean(sort=x)}
- <br>
+ <br>{@link org.apache.juneau.annotation.Bean#sort @Bean(sort=x)}
</td>
</tr>
<tr>
- <td><ja>@JsonValue</ja><br><ja>@JsonRawValue</ja></td>
+ <td>
+ <ja>@JsonValue</ja>
+ <br><ja>@JsonRawValue</ja>
+ </td>
<td>
No equivalents.
- <br>
- Future support unlikely since these are JSON-centric.
+ <br>Future support unlikely since these are JSON-centric.
</td>
</tr>
</table>
@@ -2026,8 +2159,9 @@
<h6 class='topic'>Additional Information</h6>
<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.
+ <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>
@@ -2037,8 +2171,7 @@
<div class='topic'>
<p>
The Juneau ATOM feed DTOs are simply beans with fluent-style setters.
- <br>
- The following code shows a feed being created programmatically using the
+ <br>The following code shows a feed being created programmatically using the
{@link org.apache.juneau.dto.atom.AtomBuilder} class.
</p>
<p class='bcode'>
@@ -2152,8 +2285,9 @@
<h6 class='topic'>Additional Information</h6>
<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.
+ <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>
@@ -2569,28 +2703,40 @@
The framework allows you to override header values through GET parameters, so that you can specify the
<l>ACCEPT</l> header to see each type.
Adding <l>&plainText=true</l> forces the response <l>Content-Type</l> to be <l>text/plain.</l>
+
<h6 class='figure'>HTML</h6>
<img class='bordered' src="doc-files/Server.Html.png">
<p>
Also, localization can be tested by passing in an <l>Accept-Language</l> header.
+ </p>
+
<h6 class='figure'>HTML/French</h6>
<img class='bordered' src="doc-files/Server.Html.french.png">
+
<h6 class='figure'>JSON</h6>
<img class='bordered' src="doc-files/Server.Json.png">
+
<h6 class='figure'>XML</h6>
<img class='bordered' src="doc-files/Server.Xml.png">
+
<h6 class='figure'>Simple XML</h6>
<img class='bordered' src="doc-files/Server.SimpleXml.png">
+
<h6 class='figure'>URL-Encoding</h6>
<img class='bordered' src="doc-files/Server.UrlEncoding.png">
+
<h6 class='figure'>UON</h6>
<img class='bordered' src="doc-files/Server.Uon.png">
+
<h6 class='figure'>RDF/XML</h6>
<img class='bordered' src="doc-files/Server.RdfXml.png">
+
<h6 class='figure'>RDF/N3</h6>
<img class='bordered' src="doc-files/Server.N3.png">
+
<h6 class='figure'>RDF/N-Tuple</h6>
<img class='bordered' src="doc-files/Server.NTuple.png">
+
<h6 class='figure'>RDF/Turtle</h6>
<img class='bordered' src="doc-files/Server.Turtle.png">
@@ -2598,10 +2744,11 @@
The Server API is an exhaustive topic on its own.
Refer to the additional information for an in-depth examination of the API.
</p>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink'
- href='org/apache/juneau/server/package-summary.html#TOC'>org.apache.juneau.rest</a>
+ <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>
@@ -2643,10 +2790,11 @@
The Client API is also an exhaustive topic on its own.
Refer to the additional information for an in-depth examination of the API.
</p>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink'
- href='org/apache/juneau/client/package-summary.html#TOC'>org.apache.juneau.rest.client</a>
+ <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>
@@ -2730,8 +2878,10 @@
There are two ways to expose remoteable proxies on the server side:
</p>
<ol class='spaced-list'>
- <li>Extending from <code>RemoteableServlet</code>.
- <li>Using a <code><ja>@RestMethod</ja>(name=<js>"PROXY"</js>)</code> annotation on a Java method.
+ <li>
+ Extending from <code>RemoteableServlet</code>.
+ <li>
+ Using a <code><ja>@RestMethod</ja>(name=<js>"PROXY"</js>)</code> annotation on a Java method.
</ol>
<p>
The <code>RemoteableServlet</code> class is a simple specialized servlet with an abstract
@@ -2774,45 +2924,43 @@
</p>
<p>
In either case, the proxy communications layer is pure REST.
- <br>
- Therefore, in cases where the interface classes are not available on the client side, the same method calls can
+ <br>Therefore, in cases where the interface classes are not available on the client side, the same method calls can
be made through pure REST calls.
- <br>
- This can also aid significantly in debugging, since calls to the remoteable service can be made directly from
+ <br>This can also aid significantly in debugging, since calls to the remoteable service can be made directly from
a browser with no coding involved.
</p>
<p>
The parameters and return types of the Java methods can be any of the supported serializable and parsable types
in <a class='doclink' href='#Core.PojoCategories'>POJO Categories</a>.
- <br>
- This ends up being WAY more flexible than other proxy interfaces since Juneau can handle so may POJO types
+ <br>This ends up being WAY more flexible than other proxy interfaces since Juneau can handle so may POJO types
out-of-the-box.
- <br>
- Most of the time you don't even need to modify your existing Java implementation code.
+ <br>Most of the time you don't even need to modify your existing Java implementation code.
</p>
<p>
The RemoteableServlet class itself shows how sophisticated REST interfaces can be built on the Juneau
RestServlet API using very little code.
- <br>
- The RemoteableServlet class itself consists of only 53 lines of code, yet is a sophisticated discoverable and
+ <br>The RemoteableServlet class itself consists of only 53 lines of code, yet is a sophisticated discoverable and
self-documenting REST interface.
- <br>
- And since the remote proxy API is built on top of REST, it can be debugged using just a browser.
+ <br>And since the remote proxy API is built on top of REST, it can be debugged using just a browser.
</p>
<p>
The requirements for a method to be callable through a remoteable service are:
</p>
<ul class='spaced-list'>
- <li>The method must be public.
- <li>The parameter and return types must be <a href='#Core.PojoCategories'>serializable and parsable</a>.
+ <li>
+ The method must be public.
+ <li>
+ The parameter and return types must be <a href='#Core.PojoCategories'>serializable and parsable</a>.
Parameterized types are supported.
- <li>Methods can throw <code>Throwables</code> with public no-arg or single-arg-string constructors which will
+ <li>
+ Methods can throw <code>Throwables</code> with public no-arg or single-arg-string constructors which will
be automatically recreated on the client side.
</ul>
+
<h6 class='topic'>Additional Information</h6>
<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>
+ <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>
@@ -2846,26 +2994,26 @@
The Java method arguments can be annotated with any of the following:
</p>
<ul class='spaced-list'>
- <li>{@link org.apache.juneau.remoteable.Query @Query} - A URL query parameter.
+ <li>
+ {@link org.apache.juneau.remoteable.Query @Query} - A URL query parameter.
<br>The argument can be any of the following types:
<ul>
<li>Any serializable POJO
- Converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
<li><code>Map<String,Object></code>
- Individual name-value pairs.
- <br>
- Values are converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
+ <br>Values are converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
<li><code>String</code>
- Treated as a query string.
</ul>
- <li>{@link org.apache.juneau.remoteable.QueryIfNE @QueryIfNE}
+ <li>
+ {@link org.apache.juneau.remoteable.QueryIfNE @QueryIfNE}
- Same as <ja>@Query</ja> except skips the value if it's null/empty.
- <li>{@link org.apache.juneau.remoteable.FormData @FormData}
+ <li>
+ {@link org.apache.juneau.remoteable.FormData @FormData}
- A form-data parameter.
- <br>
- Note that this is only available if the HTTP method is <code>POST</code>.
- <br>
- The argument can be any of the following types:
+ <br>Note that this is only available if the HTTP method is <code>POST</code>.
+ <br>The argument can be any of the following types:
<ul>
<li>Any serializable POJO
- Converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
@@ -2873,26 +3021,27 @@
- Individual name-value pairs.
<li><code>Map<String,Object></code>
- Individual name-value pairs.
- <br>
- Values are converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
+ <br>Values are converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
</ul>
- <li>{@link org.apache.juneau.remoteable.FormDataIfNE @FormDataIfNE}
+ <li>
+ {@link org.apache.juneau.remoteable.FormDataIfNE @FormDataIfNE}
- Same as <ja>@FormData</ja> except skips the value if it's null/empty.
- <li>{@link org.apache.juneau.remoteable.Header @Header}
+ <li>
+ {@link org.apache.juneau.remoteable.Header @Header}
- A request header.
- <br>
- The argument can be any of the following types:
+ <br>The argument can be any of the following types:
<ul>
<li>Any serializable POJO
- Converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
<li><code>Map<String,Object></code>
- Individual name-value pairs.
- <br>
- Values are converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
+ <br>Values are converted to text using {@link org.apache.juneau.urlencoding.UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.
</ul>
- <li>{@link org.apache.juneau.remoteable.HeaderIfNE @HeaderIfNE}
+ <li>
+ {@link org.apache.juneau.remoteable.HeaderIfNE @HeaderIfNE}
- Same as <ja>@Header</ja> except skips the value if it's null/empty.
- <li>{@link org.apache.juneau.remoteable.Body @Body}
+ <li>
+ {@link org.apache.juneau.remoteable.Body @Body}
- The HTTP request body.
<br>The argument can be any of the following types:
<ul>
@@ -2913,28 +3062,31 @@
The return type of the Java method can be any of the following:
</p>
<ul class='spaced-list'>
- <li><jk>void</jk>
+ <li>
+ <jk>void</jk>
- Don't parse any response.
- <br>
- Note that the method will still throw a runtime exception if an error HTTP status is returned.
- <li>Any parsable POJO
+ <br>Note that the method will still throw a runtime exception if an error HTTP status is returned.
+ <li>
+ Any parsable POJO
- The body of the response will be converted to the POJO using the parser defined on the
<code>RestClient</code>.
- <li><code>HttpResponse</code>
+ <li>
+ <code>HttpResponse</code>
- Returns the raw <code>HttpResponse</code> returned by the inner <code>HttpClient</code>.
- <li>{@link java.io.Reader}
+ <li>
+ {@link java.io.Reader}
- Returns access to the raw reader of the response.
- <br>
- Note that if you don't want your response parsed as a POJO, you'll want to get the response reader
+ <br>Note that if you don't want your response parsed as a POJO, you'll want to get the response reader
directly.
- <li>{@link java.io.InputStream}
+ <li>
+ {@link java.io.InputStream}
- Returns access to the raw input stream of the response.
</ul>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink'
- href='org/apache/juneau/remoteable/package-summary.html#TOC'>org.apache.juneau.remoteable</a>
+ <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>
@@ -2964,10 +3116,11 @@
Microservices combine all the functionality of the core, server, and client APIs to provide truly powerful
and easy-to-use REST interfaces with minimal overhead.
</p>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jp'><a class='doclink'
- href='org/apache/juneau/microservice/package-summary.html#TOC'>org.apache.juneau.microservice</a>
+ <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>
@@ -2993,16 +3146,20 @@
Follow these instructions to create the Samples project in Eclipse:
</p>
<ol class='spaced-list'>
- <li>Download the latest microservice-samples-project .zip file (e.g.
+ <li>
+ Download the latest microservice-samples-project .zip file (e.g.
<l>microservice-samples-project-5.2.zip</l>).
- <li>In your Eclipse workspace, go to <b>File->Import->General->Existing Projects into Workspace</b>
+ <li>
+ In your Eclipse workspace, go to <b>File->Import->General->Existing Projects into Workspace</b>
and click <b>Next</b>.
<br><br>
<img class='bordered' src="doc-files/Samples.Installing.1.png">
- <li>Select the .zip file and click <b>Finish</b>.
+ <li>
+ Select the .zip file and click <b>Finish</b>.
<br><br>
<img class='bordered' src="doc-files/Samples.Installing.2.png">
- <li>In your workspace, you can now see the following project:
+ <li>
+ In your workspace, you can now see the following project:
<br><br>
<img class='bordered' src="doc-files/Samples.Installing.3.png">
</ol>
@@ -3010,8 +3167,9 @@
The important elements in this project are:
</p>
<ul class='spaced-list'>
- <li><l>META-INF/MANIFEST.MF</l> - The manifest file. <br>
- This defines the entry point, classpath, top-level REST resources, and location of external
+ <li>
+ <l>META-INF/MANIFEST.MF</l> - The manifest file.
+ <br>This defines the entry point, classpath, top-level REST resources, and location of external
configuration file.
<br><br>
<p class='bcode'>
@@ -3037,22 +3195,21 @@
lib/slf4j-api-1.6.4.jar
lib/slf4j-log4j12-1.6.4.jar</mv>
</p>
- <li><l>RestMicroservice.java</l>
+ <li>
+ <l>RestMicroservice.java</l>
- The application class.
- <br>
- This is a specialized microservice in Juneau for exposing REST servlets.
- <br>
- Allows REST servlets to be registered in the manifest or configuration file.
- <li><l>RootResources.java</l>
+ <br>This is a specialized microservice in Juneau for exposing REST servlets.
+ <br>Allows REST servlets to be registered in the manifest or configuration file.
+ <li>
+ <l>RootResources.java</l>
- The top-level REST resource.
- <br>
- This class serves as a "router" page to child resources:
- <li><l>examples.cfg</l>
+ <br>This class serves as a "router" page to child resources:
+ <li>
+ <l>examples.cfg</l>
- The external configuration file.
+ <br>A deceptively simple yet powerful INI-style configuration file:
<br>
- A deceptively simple yet powerful INI-style configuration file:
- <br>
- <p class='bcode'>
+ <p class='bcode'>
<cc>#================================================================================
# Basic configuration file for SaaS microservices
# Subprojects can use this as a starting point.
@@ -3122,7 +3279,8 @@
</p>
<img class='bordered' src='doc-files/Samples.Building.2.png'>
<ul class='doctree'>
- <li class='warn'>If you get an error message saying <code class='snippet'>java.net.BindException: Address
+ <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>
@@ -3159,28 +3317,34 @@
lib/slf4j-api-1.6.4.jar
lib/slf4j-log4j12-1.6.4.jar</mv>
</p>
+
<h6 class='topic'>Notes</h6>
<ul class='spaced-list'>
- <li>The <mk>Main-Class</mk> entry is just the standard manifest entry describing the entry point for the
+ <li>
+ The <mk>Main-Class</mk> entry is just the standard manifest entry describing the entry point for the
executable jar.
The <l>org.apache.juneau.microservice.RestMicroservice</l> class is the standard microservice class for
REST microservices.
Other kinds of microservices can be created by extending the
{@link org.apache.juneau.microservice.Microservice} class.
- <li>The <mk>Rest-Resources</mk> entry is a comma-delimited list of REST resources.
+ <li>
+ The <mk>Rest-Resources</mk> entry is a comma-delimited list of REST resources.
These are classes that subclass from {@link org.apache.juneau.rest.RestServlet}.
This is a specialized entry used by <l>org.apache.juneau.microservice.RestMicroservice</l>.
In this case, you're pointing to a resource defined in our project,
<l>org.apache.juneau.examples.rest.RootResources</l>, which serves as a "grouping" page for several
other REST resources.
- <li>The <mk>Main-ConfigFile</mk> entry points to the location of an external configuration file for our
+ <li>
+ The <mk>Main-ConfigFile</mk> entry points to the location of an external configuration file for our
microservice.
- <li>The <mk>Class-Path</mk> entry again is just the standard manifest file entry.
+ <li>
+ The <mk>Class-Path</mk> entry again is just the standard manifest file entry.
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>
<ul class='doctree'>
- <li class='warn'>If you modify the manifest file and get <l>NoClassDefFoundErrors</l>, ensure that the
+ <li class='warn'>
+ If you modify the manifest file and get <l>NoClassDefFoundErrors</l>, ensure that the
classpath entries contain trailing spaces.
</ul>
</div>
@@ -3197,23 +3361,32 @@
The class hierarchy for this class is:
</p>
<ul class='doctree'>
- <li class='jac'>{@link org.apache.juneau.rest.RestServlet org.apache.juneau.rest.RestServlet}
+ <li class='jac'>
+ {@link org.apache.juneau.rest.RestServlet org.apache.juneau.rest.RestServlet}
<br>Contains all the REST servlet logic.
- <ul>
- <li class='jac'>{@link org.apache.juneau.rest.RestServletDefault org.apache.juneau.rest.RestServletDefault}
- <br>Defines default serializers and parsers, and OPTIONs page logic.
<ul>
- <li class='jac'>{@link org.apache.juneau.rest.RestServletGroupDefault org.apache.juneau.rest.RestServletGroupDefault}
- <br>Specialized subclass for grouping other resources
- <ul>
- <li class='jac'>{@link org.apache.juneau.microservice.ResourceGroup org.apache.juneau.microservice.ResourceGroup}
- <br>Specialized subclass when using the Microservice API.
+ <li class='jac'>
+ {@link org.apache.juneau.rest.RestServletDefault org.apache.juneau.rest.RestServletDefault}
+ <br>Defines default serializers and parsers, and OPTIONs page logic.
<ul>
- <li class='jc'><code>org.apache.juneau.rest.samples.RootResources</code>
+ <li class='jac'>
+ {@link org.apache.juneau.rest.RestServletGroupDefault org.apache.juneau.rest.RestServletGroupDefault}
+ <br>Specialized subclass for grouping other resources
+ <ul>
+ <li class='jac'>
+ {@link org.apache.juneau.microservice.ResourceGroup org.apache.juneau.microservice.ResourceGroup}
+ <br>Specialized subclass when using the Microservice API.
+ <ul>
+ <li class='jc'>
+ <code>org.apache.juneau.rest.samples.RootResources</code>
+ </ul>
+ </li>
+ </ul>
+ </li>
</ul>
- </ul>
+ </li>
</ul>
- </ul>
+ </li>
</ul>
<p>
Pointing a browser to the resource shows the following:
@@ -3237,6 +3410,7 @@
<p>
The <l>RootResources</l> class consists entirely of annotations:
</p>
+
<h6 class='figure'>RootResources.java</h6>
<p class='bcode'>
<jd>/**
@@ -3276,6 +3450,7 @@
<p>
The resource bundle contains the localized strings for the resource:
</p>
+
<h6 class='figure'>RootResources.properties</h6>
<p class='bcode'>
<cc>#--------------------------------------------------------------------------------
@@ -3299,6 +3474,7 @@
identify the subpath of the child.
For example, the <l>HelloWorldResource</l> class is annotated as follows:
</p>
+
<h6 class='figure'>HelloWorldResource.java</h6>
<p class='bcode'>
<ja>@RestResource</ja>(messages=<js>"nls/HelloWorldResource"</js>, path=<js>"/helloWorld"</js>)
@@ -3318,8 +3494,8 @@
</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
+ 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.
@@ -3340,6 +3516,7 @@
<p>
The <l>HelloWorldResource</l> class is a simple resource that prints a "Hello world!" message.
</p>
+
<h6 class='figure'>HelloWorldResource.java</h6>
<p class='bcode'>
<jd>/**
@@ -3362,6 +3539,7 @@
}
}
</p>
+
<h6 class='figure'>HelloWorldResource.properties</h6>
<p class='bcode'>
<cc>#--------------------------------------------------------------------------------
@@ -3375,19 +3553,25 @@
The class hierarchy for this class is:
</p>
<ul class='doctree'>
- <li class='jac'>{@link org.apache.juneau.rest.RestServlet org.apache.juneau.rest.RestServlet}
+ <li class='jac'>
+ {@link org.apache.juneau.rest.RestServlet org.apache.juneau.rest.RestServlet}
<br>Contains all the REST servlet logic.
- <ul>
- <li class='jac'>{@link org.apache.juneau.rest.RestServletDefault org.apache.juneau.rest.RestServletDefault}
- <br>Defines default serializers and parsers, and OPTIONs page logic.
<ul>
- <li class='jac'>{@link org.apache.juneau.microservice.Resource org.apache.juneau.microservice.Resource}
- <br>Specialized subclass when using the Microservice API.
- <ul>
- <li class='jc'><code>org.apache.juneau.rest.samples.HelloWorldResource</code>
- </ul>
+ <li class='jac'>
+ {@link org.apache.juneau.rest.RestServletDefault org.apache.juneau.rest.RestServletDefault}
+ <br>Defines default serializers and parsers, and OPTIONs page logic.
+ <ul>
+ <li class='jac'>
+ {@link org.apache.juneau.microservice.Resource org.apache.juneau.microservice.Resource}
+ <br>Specialized subclass when using the Microservice API.
+ <ul>
+ <li class='jc'><code>org.apache.juneau.rest.samples.HelloWorldResource</code>
+ </ul>
+ </li>
+ </ul>
+ </li>
</ul>
- </ul>
+ </li>
</ul>
<p>
Pointing a browser to the resource shows the following:
@@ -3408,16 +3592,21 @@
The <l>MethodExampleResource</l> class provides examples of the following:
</p>
<ul class='spaced-list'>
- <li>Using the {@link org.apache.juneau.rest.Redirect} object to perform redirections.
- <li>Using the various Java method parameter annotations to retrieve request attributes, parameters, etc.
- <li>Using the annotation programmatic equivalents on the {@link org.apache.juneau.rest.RestRequest} object.
- <li>Setting response POJOs by either returning them or using the
+ <li>
+ Using the {@link org.apache.juneau.rest.Redirect} object to perform redirections.
+ <li>
+ Using the various Java method parameter annotations to retrieve request attributes, parameters, etc.
+ <li>
+ Using the annotation programmatic equivalents on the {@link org.apache.juneau.rest.RestRequest} object.
+ <li>
+ Setting response POJOs by either returning them or using the
{@link org.apache.juneau.rest.RestResponse#setOutput(Object)} method.
</ul>
<p>
The resource is provided to show how various HTTP entities (e.g. parameters, headers) can be accessed
- as either annotated Java parameters, or through methods on the <l>RestRequest</l> object.
+ as either annotated Java parameters, or through methods on the <l>RestRequest</l> object.
</p>
+
<h6 class='figure'>MethodExampleResource.java</h6>
<p class='bcode'>
<jd>/**
@@ -3549,13 +3738,13 @@
The class consists of 4 methods:
</p>
<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
+ <li class='jm'>
+ <l>doExample()</l>
+ <br>The root page.
+ <br>Performs a simple redirection to the <l>doGetExample1()</l> method using a
{@link org.apache.juneau.rest.Redirect} object.
- <li class='jm'><l>example1()</l>
+ <li class='jm'>
+ <l>example1()</l>
<br>Shows how to use the following annotations:
<ul>
<li class='ja'>{@link org.apache.juneau.rest.annotation.Path @Path}
@@ -3565,9 +3754,9 @@
<li class='ja'>{@link org.apache.juneau.rest.annotation.PathRemainder @PathRemainder}
</ul>
Method returns a POJO to be serialized as the output.
- <li class='jm'><l>example2()</l>
- <br>
- Identical to <l>doGetExample1()</l> but shows how to use the
+ <li class='jm'>
+ <l>example2()</l>
+ <br>Identical to <l>doGetExample1()</l> but shows how to use the
{@link org.apache.juneau.rest.RestRequest} and {@link org.apache.juneau.rest.RestResponse} objects:
<ul>
<li class='jm'>{@link org.apache.juneau.rest.RestRequest#getPathMatch()}
@@ -3578,14 +3767,12 @@
<li class='jm'>{@link org.apache.juneau.rest.RequestPathMatch#getRemainder()}
</ul>
Method sets the POJO to be serialized using the {@link org.apache.juneau.rest.RestResponse#setOutput(Object)} method.
- <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
+ <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.
- <br>
- See <a class='doclink'
+ <br>See <a class='doclink'
href='org/apache/juneau/rest/package-summary.html#RestResources.MethodSignature'>Rest Resources /
Method Signature</a> for the list of all automatically support parameter types, and
{@link org.apache.juneau.rest.annotation.RestResource#paramResolvers() @RestResource.paramResolvers()}
@@ -3610,6 +3797,7 @@
<p>
Notice how the conversion to POJOs is automatically done for us, even for non-standard POJOs such as UUID.
</p>
+
<h6 class='topic'>Self-documenting design through Swagger OPTIONS pages</h6>
<p>
One of the main features of Juneau is that it produces OPTIONS pages for self-documenting design (i.e. REST
@@ -3619,15 +3807,16 @@
Much of the information populated on the OPTIONS page is determined through reflection.
This basic information can be augmented with information defined through:
</p>
- <ul>
- <li>Annotations - An example of this was shown in the <code>SystemPropertiesResource</code> example above.
- <br>
- Localized strings can be pulled from resource bundles using the <code>$L</code> localization variable.
- <li>Resource bundle properties - Described in detail in this section.
- <li>Swagger JSON files with the same name and location as the resource class (e.g.
+ <ul class='spaced-list'>
+ <li>
+ Annotations - An example of this was shown in the <code>SystemPropertiesResource</code> example above.
+ <br>Localized strings can be pulled from resource bundles using the <code>$L</code> localization variable.
+ <li>
+ Resource bundle properties - Described in detail in this section.
+ <li>
+ Swagger JSON files with the same name and location as the resource class (e.g.
<code>MethodExampleResource.json</code>).
- <br>
- Localized versions are defined by appending the locale to the file name (e.g.
+ <br>Localized versions are defined by appending the locale to the file name (e.g.
<code>MethodExampleResource_ja_JP.json</code>);
</ul>
<p>
@@ -3639,6 +3828,7 @@
To define an OPTIONS request handler, the {@link org.apache.juneau.rest.RestServletDefault} class defines
the following Java method:
</p>
+
<h6 class='figure'>RestServletDefault.java</h6>
<p class='bcode'>
<jd>/** OPTIONS request handler */</jd>
@@ -3669,7 +3859,8 @@
through a <code><ja>@RestResource</ja>(messages=<js>"nls/MethodExampleResources"</js>)</code> annotation.
The properties file contains localized descriptions for the resource, resource methods, and method
parameters.
- </p>
+ </p>
+
<h6 class='figure'>MethodExampleResource.properties</h6>
<p class='bcode'>
<cc>#--------------------------------------------------------------------------------
@@ -3715,13 +3906,16 @@
The <l>UrlEncodedFormResource</l> class provides examples of the following:
</p>
<ul class='spaced-list'>
- <li>How to use form entry beans to process form POSTs.
- <li>How to use the {@link org.apache.juneau.rest.RestRequest#getReaderResource(String)} method to
+ <li>
+ How to use form entry beans to process form POSTs.
+ <li>
+ How to use the {@link org.apache.juneau.rest.RestRequest#getReaderResource(String)} method to
serve up static files with embedded string variables.
</ul>
<p>
The class is shown below:
</p>
+
<h6 class='figure'>UrlEncodedFormResource.java</h6>
<p class='bcode'>
<jd>/**
@@ -3759,6 +3953,7 @@
The {@link org.apache.juneau.rest.RestRequest#getReaderResource(String,boolean)} method pulls in the following
file located in the same package as the class:
</p>
+
<h6 class='figure'>UrlEncodedForm.html</h6>
<p class='bcode'>
<xt><html></xt>
@@ -3810,6 +4005,7 @@
<p>
The <l>$L</l> variables are string variable that pull in localized values from the resource bundle:
</p>
+
<h6 class='figure'>UrlEncodedFormResource.properties</h6>
<p class='bcode'>
<cc>#--------------------------------------------------------------------------------
@@ -3888,9 +4084,11 @@
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jm'>{@link org.apache.juneau.rest.RestConfig#addVars(Class[])}
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestConfig#addVars(Class[])}
- Servlet and request variables.
- <li class='jm'>{@link org.apache.juneau.rest.RestCallHandler#getSessionObjects(RestRequest)}
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestCallHandler#getSessionObjects(RestRequest)}
- Var resolver session objects.
</ul>
</div>
@@ -3908,17 +4106,21 @@
It provides examples of the following:
</p>
<ul class='spaced-list'>
- <li>Using the {@link org.apache.juneau.rest.annotation.RestResource#properties() @RestResource.properties()}
+ <li>
+ Using the {@link org.apache.juneau.rest.annotation.RestResource#properties() @RestResource.properties()}
annotation to set serializer properties.
- <li>Using the {@link org.apache.juneau.rest.annotation.RestResource#beanFilters() @RestResource.beanFilters()}
+ <li>
+ Using the {@link org.apache.juneau.rest.annotation.RestResource#beanFilters() @RestResource.beanFilters()}
and {@link org.apache.juneau.rest.annotation.RestResource#pojoSwaps() @RestResource.pojoSwaps()}
annotations to set serializer transforms.
- <li>Using the {@link org.apache.juneau.rest.annotation.Properties @Properties} annotation to set
+ <li>
+ Using the {@link org.apache.juneau.rest.annotation.Properties @Properties} annotation to set
serializers properties programmatically on a request.
</ul>
<p>
The class is shown below:
</p>
+
<h6 class='figure'>RequestEchoResource.java</h6>
<p class='bcode'>
<jd>/**
@@ -3974,6 +4176,7 @@
The annotations are functionally equivalent to using the {@link org.apache.juneau.rest.RestConfig} class,
as follows:
</p>
+
<h6 class='figure'>Hypothetical RequestEchoResource.createSerializers() method</h6>
<p class='bcode'>
<jd>/** Override the default rest serializers to add some transforms */</jd>
@@ -4019,26 +4222,38 @@
It provides examples of the following:
</p>
<ul class='spaced-list'>
- <li>How to create RESTful interfaces using only POJOs.
- <li>How to use the {@link org.apache.juneau.xml.annotation.Xml @Xml} and
+ <li>
+ How to create RESTful interfaces using only POJOs.
+ <li>
+ How to use the {@link org.apache.juneau.xml.annotation.Xml @Xml} and
{@link org.apache.juneau.xml.annotation.XmlSchema @XmlSchema} annotations to provide XML namespaces
and alter how beans are handled by the XML serializer.
- <li>How to use the {@link org.apache.juneau.jena.annotation.Rdf @Rdf} and
+ <li>
+ How to use the {@link org.apache.juneau.jena.annotation.Rdf @Rdf} and
{@link org.apache.juneau.xml.annotation.XmlSchema @RdfSchema} annotations to provide XML namespaces
and alter how beans are handled by the Jena serializers.
- <li>How to use the {@link org.apache.juneau.annotation.BeanProperty @BeanProperty} annotation
+ <li>
+ How to use the {@link org.apache.juneau.annotation.BeanProperty @BeanProperty} annotation
to alter how bean properties are handled by the serializers.
- <li>How to use the {@link org.apache.juneau.rest.annotation.RestMethod#name() RestMethod.name()} annotation
+ <li>
+ How to use the {@link org.apache.juneau.rest.annotation.RestMethod#name() RestMethod.name()} annotation
to create overloaded methods beyond the standard GET/PUT/POST/DELETE.
- <li>How to augment data in the OPTIONS page.
- <li>How to use the {@link org.apache.juneau.rest.client.RestClient} API to interact with the REST resource
+ <li>
+ How to augment data in the OPTIONS page.
+ <li>
+ How to use the {@link org.apache.juneau.rest.client.RestClient} API to interact with the REST resource
using the same POJOs used to create the server-side API.
- <li>How to interact with the REST resource using only a browser.
- <li>Using the {@link org.apache.juneau.rest.converters.Traversable} converter to drill down into POJO models.
- <li>Using the {@link org.apache.juneau.rest.converters.Queryable} converter to provide search/view/sort
+ <li>
+ How to interact with the REST resource using only a browser.
+ <li>
+ Using the {@link org.apache.juneau.rest.converters.Traversable} converter to drill down into POJO models.
+ <li>
+ Using the {@link org.apache.juneau.rest.converters.Queryable} converter to provide search/view/sort
functionality against POJOs.
- <li>Using the {@link org.apache.juneau.rest.converters.Introspectable} converter to invoke methods on POJOs.
- <li>Using proxy interfaces.
+ <li>
+ Using the {@link org.apache.juneau.rest.converters.Introspectable} converter to invoke methods on POJOs.
+ <li>
+ Using proxy interfaces.
</ul>
<p>
Pointing a browser to the resource shows the following:
@@ -4053,19 +4268,25 @@
The code is straightforward, consisting of the following classes:
</p>
<ul class='spaced-list'>
- <li><l>package-info.java</l> - Used to define XML namespaces for POJOs in this package.
- <li><l>IAddressBook</l> - An interface describing the address book.
- <li><l>AddressBook</l> - A data structure consisting of a list of <code>Persons</code>.
- <li><l>Person, Address</l> - In-memory representations of people and addresses.
- <li><l>CreatePerson, CreateAddress</l> - POJOs for creating and updating people and address through the
+ <li>
+ <l>package-info.java</l> - Used to define XML namespaces for POJOs in this package.
+ <li>
+ <l>IAddressBook</l> - An interface describing the address book.
+ <li>
+ <l>AddressBook</l> - A data structure consisting of a list of <code>Persons</code>.
+ <li>
+ <l>Person, Address</l> - In-memory representations of people and addresses.
+ <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.
+ <li>
+ <l>AddressBookResource</l> - The REST resource class.
</ul>
<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.
+ 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.
</ul>
<p>
The <l>package-info.java</l> file is used to define XML and RDF namespaces on beans and properties in
@@ -4075,6 +4296,7 @@
It should be noted that these features are entirely optional, and there are often several ways of
defining these namespaces.
</p>
+
<h6 class='figure'>package-info.java</h6>
<p class='bcode'>
<jc>// XML and RDF namespaces used in this package</jc>
@@ -4100,6 +4322,7 @@
<p>
Our address book uses the following interface:
</p>
+
<h6 class='figure'>IAddressBook.java</h6>
<p class='bcode'>
<jd>/**
@@ -4130,15 +4353,18 @@
Person removePerson(<jk>int</jk> id);
}
</p>
+
<h6 class='topic'>Notes</h6>
<ul class='spaced-list'>
- <li>You interface an interface for our address book so that you can later
+ <li>
+ You interface an interface for our address book so that you can later
use it to demonstrate the proxy interface support.
</ul>
<p>
The <l>AddressBook</l> class is our address book.
It maintains a list of <l>Person</l> objects with some additional convenience methods:
</p>
+
<h6 class='figure'>AddressBook.java</h6>
<p class='bcode'>
<jd>/** Address book bean */</jd>
@@ -4217,23 +4443,28 @@
}
}
</p>
+
<h6 class='topic'>Notes</h6>
<ul class='spaced-list'>
- <li>The <code><ja>@Xml</ja>(elementName=<js>"addressBook"</js>)</code> annotation tells the toolkit that
+ <li>
+ The <code><ja>@Xml</ja>(elementName=<js>"addressBook"</js>)</code> annotation tells the toolkit that
when serialized as XML, the element name is <xt><addressBook></xt>.
Without this annotation, the element would revert to the generalized <xt><array></xt> tag.
- <li>The separate constructors are implementation specific and are needed because you're going to be
+ <li>
+ The separate constructors are implementation specific and are needed because you're going to be
using this class in two ways, since you'll be demonstrating the client code as well as the server
code, and it eliminates having to define separate client-side and server-side POJOs:
- <ol>
- <li>The normal constructor is used to programmatically create this object in the REST servlet code.
- <li>The no-arg constructor is used by the Juneau parsers to construct this object in our client
- side code.
- </ol>
+ <ol>
+ <li>The normal constructor is used to programmatically create this object in the REST servlet code.
+ <li>The no-arg constructor is used by the Juneau parsers to construct this object in our client
+ side code.
+ </ol>
+ </li>
</ul>
<p>
The <l>Person</l> bean is defined as follows:
</p>
+
<h6 class='figure'>Person.java</h6>
<p class='bcode'>
<jd>/** Person bean */</jd>
@@ -4286,15 +4517,19 @@
}
}
</p>
+
<h6 class='topic'>Notes</h6>
<ul class='spaced-list'>
- <li>The <l>ns="per"</l> annotations override the default <l>"ab"</l> namespace defined on the package.
+ <li>
+ The <l>ns="per"</l> annotations override the default <l>"ab"</l> namespace defined on the package.
It applies to this class and all properties of this class.
- <li>The <code><ja>@Rdf</ja>(beanUri=<jk>true</jk>)</code> annotation identifies the <l>uri</l> property
+ <li>
+ The <code><ja>@Rdf</ja>(beanUri=<jk>true</jk>)</code> annotation identifies the <l>uri</l> property
as the resource URI for this resource.
This property has special meaning for the RDF serializer.
The RDF serializer uses this property for the value of the <l>rdf:resource</l> attribute.
- <li>The <code><ja>@BeanProperty</ja>(swap=CalendarSwap.Medium.<jk>class</jk>)</code> annotation causes
+ <li>
+ The <code><ja>@BeanProperty</ja>(swap=CalendarSwap.Medium.<jk>class</jk>)</code> annotation causes
the date field to be serialized in the format <l>"MM dd, yyyy"</l>.
This could have also been specified globally on the resource level through the
{@link org.apache.juneau.rest.annotation.RestResource#properties} annotation.
@@ -4302,6 +4537,7 @@
<p>
The <l>Address</l> bean is defined as follows:
</p>
+
<h6 class='figure'>Address.java</h6>
<p class='bcode'>
<jd>/**
@@ -4341,14 +4577,17 @@
}
}
</p>
+
<h6 class='topic'>Notes</h6>
<ul class='spaced-list'>
- <li>This class shows how the namespace can be overridden at the property level through the
- <code><ja>@Xml</ja>(ns=<js>"mail"</js>)</code> annotation.
+ <li>
+ This class shows how the namespace can be overridden at the property level through the
+ <code><ja>@Xml</ja>(ns=<js>"mail"</js>)</code> annotation.
</ul>
<p>
The <l>CreatePerson</l> bean is used as the input data for creating a person.
</p>
+
<h6 class='figure'>CreatePerson.java</h6>
<p class='bcode'>
<jd>/** Bean for creating a new person */</jd>
@@ -4372,6 +4611,7 @@
<p>
The <l>CreateAddress</l> bean is used as the input data for creating an address.
</p>
+
<h6 class='figure'>CreateAddress.java</h6>
<p class='bcode'>
<jd>/** Bean for creating a new address */</jd>
@@ -4398,6 +4638,7 @@
<p>
The <l>AddressBookResource</l> class is our REST resource class.
</p>
+
<h6 class='figure'>AddressBookResource.java</h6>
<p class='bcode'>
<jd>/**
@@ -4715,16 +4956,20 @@
}
}
</p>
+
<h6 class='topic'>Notes</h6>
<ul class='spaced-list'>
- <li>The <l>@RestResource.messages()</l> annotation identifies
+ <li>
+ The <l>@RestResource.messages()</l> annotation identifies
<l>org/apache/juneau/samples/addressbook/nls/AddressBookResource.properties</l> as the resource
bundle for localized message for this class.
- <li>You are setting <l>XML_enableNamespaces</l> to <l>true</l> to enable XML namespaces.
+ <li>
+ You are setting <l>XML_enableNamespaces</l> to <l>true</l> to enable XML namespaces.
By default, XML namespace support is disabled per
{@link org.apache.juneau.xml.XmlSerializerContext#XML_enableNamespaces}, so you have to explicitly
enable it on our serializers.
- <li>The <l>XML_autoDetectNamespaces</l> setting is needed to get the XML serializer to add <l>xmlns</l>
+ <li>
+ The <l>XML_autoDetectNamespaces</l> setting is needed to get the XML serializer to add <l>xmlns</l>
attributes to the root elements.
This causes the XML serializer to scan the POJO objects for namespaces in order to populate the
root element.
@@ -4732,21 +4977,26 @@
setting at either the resource or method level, which might be preferred in high-performance
environments.
However, <l>XML_autoDetectNamespaces</l> produces the simplest code for our example.
- <li>The <l>updatePerson()</l> and <l>updateAddress()</l> methods use a guard to only allow
+ <li>
+ The <l>updatePerson()</l> and <l>updateAddress()</l> methods use a guard to only allow
administrators access.
For the sample code, the guard does nothing. It's up to the implementer to decide how to restrict
access.
- <li>The <l>updatePerson()</l> and <l>updateAddress()</l> methods use the
+ <li>
+ The <l>updatePerson()</l> and <l>updateAddress()</l> methods use the
{@link org.apache.juneau.utils.PojoRest} class
to locate and update individual nodes in a POJO tree using the path remainder on the request.
- <li>The <l>doInit()</l> method shows an example of an overloaded method using the
+ <li>
+ The <l>doInit()</l> method shows an example of an overloaded method using the
<l>@RestMethod(name="INIT")</l> annotation.
- <li>The <l>getOptions()</l> method shows the default OPTIONS page augmented with some additional
+ <li>
+ The <l>getOptions()</l> method shows the default OPTIONS page augmented with some additional
information.
</ul>
<p>
The OPTIONS page uses the servlet resource bundle to specify the labels so that they're globalizable.
</p>
+
<h6 class='figure'>AddressBookResource.properties</h6>
<p class='bcode'>
<ck>title</ck> = <cv>AddressBook sample resource</cv>
@@ -485
<TRUNCATED>
[17/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java b/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
index 6bda4e1..34f3590 100644
--- a/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
@@ -99,7 +99,7 @@ public abstract class CoreObjectBuilder {
/**
* Adds multiple configuration properties on this object.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling {@link PropertyStore#addProperties(Map)}.
@@ -117,7 +117,7 @@ public abstract class CoreObjectBuilder {
/**
* Sets multiple configuration properties on this object.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling {@link PropertyStore#setProperties(Map)}.
@@ -135,7 +135,7 @@ public abstract class CoreObjectBuilder {
/**
* Adds a value to a SET property.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>PropertyStore.addToProperty(name, value);</code>.
@@ -153,7 +153,7 @@ public abstract class CoreObjectBuilder {
/**
* Adds or overwrites a value to a MAP property.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>PropertyStore.putToProperty(name, key, value);</code>.
@@ -172,7 +172,7 @@ public abstract class CoreObjectBuilder {
/**
* Adds or overwrites a value to a MAP property.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>PropertyStore.putToProperty(name, value);</code>.
@@ -190,7 +190,7 @@ public abstract class CoreObjectBuilder {
/**
* Removes a value from a SET property.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>PropertyStore.removeFromProperty(name, value);</code>.
@@ -220,7 +220,7 @@ public abstract class CoreObjectBuilder {
* Otherwise, the bean will be serialized as a string using the {@link Object#toString()} method.
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_beansRequireDefaultConstructor</jsf>, value)</code>.
@@ -248,7 +248,7 @@ public abstract class CoreObjectBuilder {
* Otherwise, the bean will be serialized as a string using the {@link Object#toString()} method.
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_beansRequireSerializable</jsf>, value)</code>.
@@ -274,7 +274,7 @@ public abstract class CoreObjectBuilder {
* <p>
* If <jk>true</jk>, only getters that have equivalent setters will be considered as properties on a bean.
* Otherwise, they will be ignored.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_beansRequireSettersForGetters</jsf>, value)</code>.
@@ -302,7 +302,7 @@ public abstract class CoreObjectBuilder {
* Otherwise, the bean will be serialized as a string using the {@link Object#toString()} method.
* <p>
* The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_beansRequireSomeProperties</jsf>, value)</code>.
@@ -332,7 +332,7 @@ public abstract class CoreObjectBuilder {
* Otherwise, it returns <jk>null</jk>.
* <p>
* Disabled by default because it introduces a slight performance penalty.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_beanMapPutReturnsOldValue</jsf>, value)</code>.
@@ -359,7 +359,7 @@ public abstract class CoreObjectBuilder {
* Constructors not meeting this minimum visibility will be ignored.
* For example, if the visibility is <code>PUBLIC</code> and the constructor is <jk>protected</jk>, then
* the constructor will be ignored.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_beanConstructorVisibility</jsf>, value)</code>.
@@ -386,7 +386,7 @@ public abstract class CoreObjectBuilder {
* Classes are not considered beans unless they meet the minimum visibility requirements.
* For example, if the visibility is <code>PUBLIC</code> and the bean class is <jk>protected</jk>, then
* the class will not be interpreted as a bean class.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_beanClassVisibility</jsf>, value)</code>.
@@ -413,7 +413,7 @@ public abstract class CoreObjectBuilder {
* Fields are not considered bean properties unless they meet the minimum visibility requirements.
* For example, if the visibility is <code>PUBLIC</code> and the bean field is <jk>protected</jk>, then
* the field will not be interpreted as a bean property.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_beanFieldVisibility</jsf>, value)</code>.
@@ -441,7 +441,7 @@ public abstract class CoreObjectBuilder {
* Methods are not considered bean getters/setters unless they meet the minimum visibility requirements.
* For example, if the visibility is <code>PUBLIC</code> and the bean method is <jk>protected</jk>, then
* the method will not be interpreted as a bean getter or setter.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_methodVisibility</jsf>, value)</code>.
@@ -467,8 +467,8 @@ public abstract class CoreObjectBuilder {
* </ul>
* <p>
* Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
- * <p>
- * <h5 class='section'>Notes:</h5>
+ *
+ * <h5 class 'section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_useJavaBeanIntrospector</jsf>, value)</code>.
* <li>Most {@link Bean @Bean} annotations will be ignored if you enable this setting.
@@ -494,7 +494,7 @@ public abstract class CoreObjectBuilder {
* <p>
* If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an
* {@link InvocationHandler} if there is no other way of instantiating them.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_useInterfaceProxies</jsf>, value)</code>.
@@ -520,7 +520,7 @@ public abstract class CoreObjectBuilder {
* <p>
* If <jk>true</jk>, trying to set a value on a non-existent bean property will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_ignoreUnknownBeanProperties</jsf>, value)</code>.
@@ -546,7 +546,7 @@ public abstract class CoreObjectBuilder {
* <p>
* If <jk>true</jk>, trying to set a <jk>null</jk> value on a non-existent bean property will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_ignoreUnknownNullBeanProperties</jsf>, value)</code>.
@@ -572,7 +572,7 @@ public abstract class CoreObjectBuilder {
* <p>
* If <jk>true</jk>, trying to set a value on a bean property without a setter will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_ignorePropertiesWithoutSetters</jsf>, value)</code>.
@@ -598,7 +598,7 @@ public abstract class CoreObjectBuilder {
* <p>
* If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_ignoreInvocationExceptionsOnGetters</jsf>, value)</code>.
@@ -624,7 +624,7 @@ public abstract class CoreObjectBuilder {
* <p>
* If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_ignoreInvocationExceptionsOnSetters</jsf>, value)</code>.
@@ -653,7 +653,7 @@ public abstract class CoreObjectBuilder {
* JVM vendor.
* On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.
* On Oracle JVMs, the bean properties are not ordered (which follows the offical JVM specs).
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_sortProperties</jsf>, value)</code>.
@@ -695,7 +695,7 @@ public abstract class CoreObjectBuilder {
* Any classes within these packages will be serialized to strings using {@link Object#toString()}.
* <p>
* Note that you can specify prefix patterns to include all subpackages.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_notBeanPackages</jsf>, values)</code>.
@@ -724,7 +724,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to packages whose classes should not be considered beans.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_notBeanPackages</jsf>, values)</code>
@@ -754,7 +754,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from packages whose classes should not be considered beans.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>removeFromProperty(<jsf>BEAN_notBeanPackages</jsf>, values)</code>
@@ -796,7 +796,7 @@ public abstract class CoreObjectBuilder {
* <p>
* Not-bean classes are typically converted to <code>Strings</code> during serialization even if they
* appear to be bean-like.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_notBeanClasses</jsf>, values)</code>.
@@ -825,7 +825,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to classes that should not be considered beans.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_notBeanClasses</jsf>, values)</code>
@@ -857,7 +857,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from classes that should not be considered beans.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>removeFromProperty(<jsf>BEAN_notBeanClasses</jsf>, values)</code>
@@ -903,14 +903,16 @@ public abstract class CoreObjectBuilder {
* <p>
* There are two category of classes that can be passed in through this method:
* <ul class='spaced-list'>
- * <li>Subclasses of {@link BeanFilterBuilder}.
+ * <li>
+ * Subclasses of {@link BeanFilterBuilder}.
* These must have a public no-arg constructor.
- * <li>Bean interface classes.
+ * <li>
+ * Bean interface classes.
* A shortcut for defining a {@link InterfaceBeanFilterBuilder}.
* Any subclasses of an interface class will only have properties defined on the interface.
* All other bean properties will be ignored.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_beanFilters</jsf>, values)</code>.
@@ -939,7 +941,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to bean filters.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_beanFilters</jsf>, values)</code>
@@ -971,7 +973,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from bean filters.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>removeFromProperty(<jsf>BEAN_beanFilters</jsf>, values)</code>
@@ -1016,7 +1018,7 @@ public abstract class CoreObjectBuilder {
* <li>Subclasses of {@link PojoSwap}.
* <li>Surrogate classes. A shortcut for defining a {@link SurrogateSwap}.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_pojoSwaps</jsf>, values)</code>.
@@ -1045,7 +1047,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to POJO swaps.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_pojoSwaps</jsf>, values)</code>
@@ -1077,7 +1079,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from POJO swaps.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>removeFromProperty(<jsf>BEAN_pojoSwaps</jsf>, values)</code>
@@ -1120,7 +1122,7 @@ public abstract class CoreObjectBuilder {
* For interfaces and abstract classes this method can be used to specify an implementation
* class for the interface/abstract class so that instances of the implementation
* class are used when instantiated (e.g. during a parse).
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_implClasses</jsf>, values)</code>.
@@ -1136,7 +1138,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Implementation classes for interfaces and abstract classes.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>putToProperty(<jsf>BEAN_implClasses</jsf>, interfaceClass, implClass)</code>
@@ -1172,7 +1174,7 @@ public abstract class CoreObjectBuilder {
* <p>
* For example, <code>{Bean1:<js>"foo,bar"</js>}</code> means only serialize the <code>foo</code> and <code>bar</code>
* properties on the specified bean.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_includeProperties</jsf>, values)</code>.
@@ -1188,7 +1190,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Explicitly specify visible bean properties.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>putToProperty(<jsf>BEAN_includeProperties</jsf>, beanClassName, properties)</code>
@@ -1207,7 +1209,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Explicitly specify visible bean properties.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>putToProperty(<jsf>BEAN_includeProperties</jsf>, beanClass.getName(), properties)</code>
@@ -1242,7 +1244,7 @@ public abstract class CoreObjectBuilder {
* <p>
* For example, <code>{Bean1:<js>"foo,bar"</js>}</code> means don't serialize the <code>foo</code> and <code>bar</code>
* properties on the specified bean.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_excludeProperties</jsf>, values)</code>.
@@ -1258,7 +1260,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Exclude specified properties from beans.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>putToProperty(<jsf>BEAN_excludeProperties</jsf>, beanClassName, properties)</code>
@@ -1277,7 +1279,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Exclude specified properties from beans.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>putToProperty(<jsf>BEAN_excludeProperties</jsf>, beanClass.getName(), properties)</code>
@@ -1312,7 +1314,7 @@ public abstract class CoreObjectBuilder {
* <li>Any subclass of {@link BeanDictionaryMap} containing a mapping of type names to classes without type name
* annotations.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_beanDictionary</jsf>, values)</code>.
@@ -1341,7 +1343,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to bean dictionary.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_beanDictionary</jsf>, values)</code>
@@ -1373,7 +1375,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from bean dictionary.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>removeFromProperty(<jsf>BEAN_beanDictionary</jsf>, values)</code>
@@ -1412,7 +1414,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <js>"_type"</js>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_beanTypePropertyName</jsf>, value)</code>.
@@ -1437,7 +1439,7 @@ public abstract class CoreObjectBuilder {
* </ul>
* <p>
* Used in the in the {@link BeanSession#convertToType(Object, Class)} method.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_defaultParser</jsf>, value)</code>.
@@ -1460,7 +1462,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <code>Locale.getDefault()</code>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_locale</jsf>, value)</code>.
@@ -1483,7 +1485,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_timeZone</jsf>, value)</code>.
@@ -1508,7 +1510,7 @@ public abstract class CoreObjectBuilder {
* </ul>
* <p>
* Specifies a default media type value for serializer and parser sessions.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_mediaType</jsf>, value)</code>.
@@ -1534,17 +1536,20 @@ public abstract class CoreObjectBuilder {
* <p>
* Enables the following additional information during serialization:
* <ul class='spaced-list'>
- * <li>When bean getters throws exceptions, the exception includes the object stack information
+ * <li>
+ * When bean getters throws exceptions, the exception includes the object stack information
* in order to determine how that method was invoked.
- * <li>Enables {@link SerializerContext#SERIALIZER_detectRecursions}.
+ * <li>
+ * Enables {@link SerializerContext#SERIALIZER_detectRecursions}.
* </ul>
* <p>
* Enables the following additional information during parsing:
* <ul class='spaced-list'>
- * <li>When bean setters throws exceptions, the exception includes the object stack information
+ * <li>
+ * When bean setters throws exceptions, the exception includes the object stack information
* in order to determine how that method was invoked.
* </ul>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>This is equivalent to calling <code>property(<jsf>BEAN_debug</jsf>, value)</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java b/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
index 35ef6dd..83f32ef 100644
--- a/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
+++ b/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
@@ -30,114 +30,99 @@ import org.apache.juneau.parser.*;
* <p>
* The hierarchy of these objects are...
* <ul class='spaced-list'>
- * <li>{@link PropertyStore} - A thread-safe, modifiable context property store.
- * <br>
- * Used to create {@link Context} objects.
- *
- * <li>{@link Context} - A reusable, cacheable, thread-safe, read-only context with configuration properties copied
+ * <li>
+ * {@link PropertyStore} - A thread-safe, modifiable context property store.
+ * <br>Used to create {@link Context} objects.
+ * <li>
+ * {@link Context} - A reusable, cacheable, thread-safe, read-only context with configuration properties copied
* from the store.
- * <br>
- * Often used to create {@link Session} objects.
- *
- * <li>{@link Session} - A one-time-use non-thread-safe object.
+ * <br>Often used to create {@link Session} objects.
+ * <li>
+ * {@link Session} - A one-time-use non-thread-safe object.
* <br>Used by serializers and parsers to retrieve context properties and to be used as scratchpads.
* </ul>
*
* <h6 class='topic'>PropertyStore objects</h6>
* <p>
* Property stores can be thought of as consisting of the following:
- * <ul class='spaced-list'>
+ * <ul>
* <li>A <code>Map<String,Object></code> of context properties.
* <li>A <code>Map<Class,Context></code> of context instances.
* </ul>
+ *
* <p>
* Property stores are used to create and cache {@link Context} objects using the {@link #getContext(Class)} method.
+ *
* <p>
* As a general rule, {@link PropertyStore} objects are 'slow'.
- * <br>
- * Setting and retrieving properties on a store can involve relatively slow data conversion and synchronization.
- * <br>
- * However, the {@link #getContext(Class)} method is fast, and will return cached context objects if the context
+ * <br>Setting and retrieving properties on a store can involve relatively slow data conversion and synchronization.
+ * <br>However, the {@link #getContext(Class)} method is fast, and will return cached context objects if the context
* properties have not changed.
+ *
* <p>
* Property stores can be used to store context properties for a variety of contexts.
- * <br>
- * For example, a single store can store context properties for the JSON serializer, XML serializer, HTML serializer
+ * <br>For example, a single store can store context properties for the JSON serializer, XML serializer, HTML serializer
* etc... and can thus be used to retrieve context objects for those serializers.
- * <p>
*
* <h6 class='topic'>Context properties</h6>
* <p>
* Context properties are 'settings' for serializers and parsers.
- * <br>
- * For example, the {@link BeanContext#BEAN_sortProperties} context property defines whether bean properties should be
+ * <br>For example, the {@link BeanContext#BEAN_sortProperties} context property defines whether bean properties should be
* serialized in alphabetical order.
+ *
* <p>
* Each {@link Context} object should contain the context properties that apply to it as static fields
* (e.g {@link BeanContext#BEAN_sortProperties}).
+ *
* <p>
* Context properties can be of the following types:
* <ul class='spaced-list'>
- * <li><l>SIMPLE</l> - A simple property.
- * <br>
- * Examples include: booleans, integers, Strings, Classes, etc...
- * <br><br>
- * An example of this would be the {@link BeanContext#BEAN_sortProperties} property.
- * <br>
- * It's name is simply <js>"BeanContext.sortProperties"</js>.
- *
- * <li><l>SET</l> - A sorted set of objects.
- * <br>
- * These are denoted by appending <js>".set"</js> to the property name.
- * <br>
- * Objects can be of any type, even complex types.
- * <br>
- * Sorted sets use tree sets to maintain the value in alphabetical order.
- * <br>
- * For example, the {@link BeanContext#BEAN_notBeanClasses} property is used to store classes that should not be
+ * <li>
+ * <l>SIMPLE</l> - A simple property.
+ * <br>Examples include: booleans, integers, Strings, Classes, etc...
+ * <br>An example of this would be the {@link BeanContext#BEAN_sortProperties} property.
+ * <br>It's name is simply <js>"BeanContext.sortProperties"</js>.
+ * <li>
+ * <l>SET</l> - A sorted set of objects.
+ * <br>These are denoted by appending <js>".set"</js> to the property name.
+ * <br>Objects can be of any type, even complex types.
+ * <br>Sorted sets use tree sets to maintain the value in alphabetical order.
+ * <br>For example, the {@link BeanContext#BEAN_notBeanClasses} property is used to store classes that should not be
* treated like beans.
- * <br>
- * It's name is <js>"BeanContext.notBeanClasses.set"</js>.
- *
- * <li><l>LIST</l> - A list of unique objects.
- * <br>
- * These are denoted by appending <js>".list"</js> to the property name.
- * <br>
- * Objects can be of any type, even complex types.
- * <br>
- * Use lists if the ordering of the values in the set is important (similar to how the order of entries in a
+ * <br>It's name is <js>"BeanContext.notBeanClasses.set"</js>.
+ * <li>
+ * <l>LIST</l> - A list of unique objects.
+ * <br>These are denoted by appending <js>".list"</js> to the property name.
+ * <br>Objects can be of any type, even complex types.
+ * <br>Use lists if the ordering of the values in the set is important (similar to how the order of entries in a
* classpath is important).
- * <br>
- * <br>
- * For example, the {@link BeanContext#BEAN_beanFilters} property is used to store bean filters.
- * <br>
- * It's name is <js>"BeanContext.transforms.list"</js>.
- *
- * <li><l>MAP</l> - A sorted map of key-value pairs.
- * <br>
- * These are denoted by appending <js>".map"</js> to the property name.
- * <br>
- * Keys can be any type directly convertible to and from Strings.
+ * <br>For example, the {@link BeanContext#BEAN_beanFilters} property is used to store bean filters.
+ * <br>It's name is <js>"BeanContext.transforms.list"</js>.
+ * <li>
+ * <l>MAP</l> - A sorted map of key-value pairs.
+ * <br>These are denoted by appending <js>".map"</js> to the property name.
+ * <br>Keys can be any type directly convertible to and from Strings.
* Values can be of any type, even complex types.
- * <br>
- * <br>
- * For example, the {@link BeanContext#BEAN_implClasses} property is used to specify the names of implementation
+ * <br>For example, the {@link BeanContext#BEAN_implClasses} property is used to specify the names of implementation
* classes for interfaces.
- * <br>
- * It's name is <js>"BeanContext.implClasses.map"</js>.
+ * <br>It's name is <js>"BeanContext.implClasses.map"</js>.
* </ul>
+ *
* <p>
* All context properties are set using the {@link #setProperty(String, Object)} method.
+ *
* <p>
* Default values for context properties can be specified globally as system properties.
- * <br>
- * Example: <code>System.<jsm>setProperty</jsm>(<jsf>BEAN_sortProperties</jsf>, <jk>true</jk>);</code>
+ * <br>Example: <code>System.<jsm>setProperty</jsm>(<jsf>BEAN_sortProperties</jsf>, <jk>true</jk>);</code>
+ *
* <p>
* SET and LIST properties can be added to using the {@link #addToProperty(String, Object)} method and removed from
* using the {@link #removeFromProperty(String, Object)} method.
+ *
* <p>
* SET and LIST properties can also be added to and removed from by appending <js>".add"</js> or <js>".remove"</js> to
* the property name and using the {@link #setProperty(String, Object)} method.
+ *
* <p>
* The following shows the two different ways to append to a set or list property:
* <p class='bcode'>
@@ -150,6 +135,7 @@ import org.apache.juneau.parser.*;
* <jc>// Append to set property using set().</jc>
* ps.setProperty(<js>"BeanContext.notBeanClasses.set.add"</js>, MyNotBeanClass.<jk>class</jk>);
* </p>
+ *
* <p>
* SET and LIST properties can also be set and manipulated using JSON strings.
* <p class='bcode'>
@@ -167,15 +153,15 @@ import org.apache.juneau.parser.*;
* <jc>// Remove an array of values as a JSON array..
* ps.removeFromProperty(<js>"BeanContext.notBeanClasses.set"</js>, <js>"['com.my.MyNotBeanClass3']"</js>);
* </p>
+ *
* <p>
* MAP properties can be added to using the {@link #putToProperty(String, Object, Object)} and
* {@link #putToProperty(String, Object)} methods.
- * <br>
- * MAP property entries can be removed by setting the value to <jk>null</jk>
+ * <br>MAP property entries can be removed by setting the value to <jk>null</jk>
* (e.g. <code>putToProperty(<js>"BEAN_implClasses"</js>, MyNotBeanClass.<jk>class</jk>, <jk>null</jk>);</code>.
- * <br>
- * MAP properties can also be added to by appending <js>".put"</js> to the property name and using the
+ * <br>MAP properties can also be added to by appending <js>".put"</js> to the property name and using the
* {@link #setProperty(String, Object)} method.
+ *
* <p>
* The following shows the two different ways to append to a set property:
* <p class='bcode'>
@@ -189,6 +175,7 @@ import org.apache.juneau.parser.*;
* Map m = <jk>new</jk> AMap().append(MyInterface.<jk>class</jk>,MyInterfaceImpl.<jk>class</jk>);
* ps.setProperty(<js>"BeanContext.implClasses.map.put"</js>, m);
* </p>
+ *
* <p>
* MAP properties can also be set and manipulated using JSON strings.
* <p class='bcode'>
@@ -205,30 +192,33 @@ import org.apache.juneau.parser.*;
* <jc>// Remove from MAP using JSON object.</jc>
* ps.putToProperty(<js>"BeanContext.implClasses.map"</js>, <js>"{'com.my.MyInterface2':null}"</js>);
* </p>
+ *
* <p>
* Context properties are retrieved from this store using the following 3 methods:
* <ul class='spaced-list'>
- * <li>{@link #getProperty(String, Class, Object)} - Retrieve a SIMPLE or SET property converted to the specified
+ * <li>
+ * {@link #getProperty(String, Class, Object)} - Retrieve a SIMPLE or SET property converted to the specified
* class type.
- * <li>{@link #getMap(String, Class, Class, Map)} - Retrieve a MAP property with keys/values converted to the
+ * <li>
+ * {@link #getMap(String, Class, Class, Map)} - Retrieve a MAP property with keys/values converted to the
* specified class types.
- * <li>{@link #getPropertyMap(String)} - Retrieve a map of all context properties with the specified prefix
+ * <li>
+ * {@link #getPropertyMap(String)} - Retrieve a map of all context properties with the specified prefix
* (e.g. <js>"BeanContext"</js> for {@link BeanContext} properties).
* </ul>
+ *
* <p>
* As a general rule, only {@link Context} objects will use these read methods.
*
* <h6 class='topic'>Context objects</h6>
* <p>
* A Context object can be thought of as unmodifiable snapshot of a store.
- * <br>
- * They should be 'fast' by avoiding synchronization by using final fields whenever possible.
- * <br>
- * However, they MUST be thread safe.
+ * <br>They should be 'fast' by avoiding synchronization by using final fields whenever possible.
+ * <br>However, they MUST be thread safe.
+ *
* <p>
* Context objects are created using the {@link #getContext(Class)} method.
- * <br>
- * As long as the properties on a store have not been modified, the store will return a cached copy of a context.
+ * <br>As long as the properties on a store have not been modified, the store will return a cached copy of a context.
* <p class='bcode'>
* PropertyStore ps = PropertyStore.<jsm>create</jsm>();
*
@@ -250,12 +240,10 @@ import org.apache.juneau.parser.*;
* <h6 class='topic'>Session objects</h6>
* <p>
* Session objects are created through {@link Context} objects, typically through a <code>createContext()</code> method.
- * <br>
- * Unlike context objects, they are NOT reusable and NOT thread safe.
- * <br>
- * They are meant to be used one time and then thrown away.
- * <br>
- * They should NEVER need to use synchronization.
+ * <br>Unlike context objects, they are NOT reusable and NOT thread safe.
+ * <br>They are meant to be used one time and then thrown away.
+ * <br>They should NEVER need to use synchronization.
+ *
* <p>
* Session objects are also often used as scratchpads for information such as keeping track of call stack information
* to detect recursive loops when serializing beans.
@@ -406,16 +394,18 @@ public final class PropertyStore {
* </tr>
* </table>
*
- * @param name The configuration property name.
- * <br>If name ends with <l>.add</l>, then the specified value is added to the existing property value as an entry
- * in a SET or LIST property.
- * <br>If name ends with <l>.put</l>, then the specified value is added to the existing property value as a
- * key/value pair in a MAP property.
- * <br>If name ends with <l>.remove</l>, then the specified value is removed from the existing property property
- * value in a SET or LIST property.
- * @param value The new value.
- * If <jk>null</jk>, the property value is deleted.
- * In general, the value type can be anything.
+ * @param name
+ * The configuration property name.
+ * <br>If name ends with <l>.add</l>, then the specified value is added to the existing property value as an entry
+ * in a SET or LIST property.
+ * <br>If name ends with <l>.put</l>, then the specified value is added to the existing property value as a
+ * key/value pair in a MAP property.
+ * <br>If name ends with <l>.remove</l>, then the specified value is removed from the existing property property
+ * value in a SET or LIST property.
+ * @param value
+ * The new value.
+ * If <jk>null</jk>, the property value is deleted.
+ * In general, the value type can be anything.
* @return This object (for method chaining).
*/
public PropertyStore setProperty(String name, Object value) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java
index ba1ede3..78b4d6d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java
@@ -23,13 +23,18 @@ import org.apache.juneau.transform.*;
/**
* Used to tailor how beans get interpreted by the framework.
+ *
* <p>
* Can be used to do the following:
* <ul class='spaced-list'>
- * <li>Explicitly specify the set and order of properties on a bean.
- * <li>Associate a {@link PropertyNamer} with a class.
- * <li>Specify subtypes of a bean differentiated by a sub type property.
+ * <li>
+ * Explicitly specify the set and order of properties on a bean.
+ * <li>
+ * Associate a {@link PropertyNamer} with a class.
+ * <li>
+ * Specify subtypes of a bean differentiated by a sub type property.
* </ul>
+ *
* <p>
* This annotation can be applied to classes and interfaces.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
index c7b6af8..fb6a133 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
@@ -24,8 +24,7 @@ import org.apache.juneau.*;
* <p>
* This annotation can be used in the case of beans with properties whose values can only be set by passing them in
* through a constructor on the class.
- * <br>
- * Since method parameter names are lost during compilation, this annotation essentially redefines them so that they
+ * <br>Since method parameter names are lost during compilation, this annotation essentially redefines them so that they
* are available at runtime.
* <p>
* The definition of a read-only bean is a bean with properties with only getters, like shown below...
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java
index c106d66..46a8d19 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java
@@ -23,21 +23,32 @@ import org.apache.juneau.transform.*;
/**
* Used tailor how bean properties get interpreted by the framework.
+ *
* <p>
* Can be used to do the following:
* <ul class='spaced-list'>
- * <li>Override the name of a property.
- * <li>Identify a getter or setter with a non-standard naming convention.
- * <li>Identify a specific subclass for a property with a general class type.
- * <li>Identify class types of elements in properties of type <code>Collection</code> or <code>Map</code>.
- * <li>Hide properties during serialization.
- * <li>Associate transforms with bean property values, such as a POJO swap to convert a <code>Calendar</code> field
+ * <li>
+ * Override the name of a property.
+ * <li>
+ * Identify a getter or setter with a non-standard naming convention.
+ * <li>
+ * Identify a specific subclass for a property with a general class type.
+ * <li>
+ * Identify class types of elements in properties of type <code>Collection</code> or <code>Map</code>.
+ * <li>
+ * Hide properties during serialization.
+ * <li>
+ * Associate transforms with bean property values, such as a POJO swap to convert a <code>Calendar</code> field
* to a string.
- * <li>Override the list of properties during serialization on child elements of a property of type
+ * <li>
+ * Override the list of properties during serialization on child elements of a property of type
* <code>Collection</code> or <code>Map</code>.
- * <li>Identify a property as the URL for a bean.
- * <li>Identify a property as the ID for a bean.
+ * <li>
+ * Identify a property as the URL for a bean.
+ * <li>
+ * Identify a property as the ID for a bean.
* </ul>
+ *
* <p>
* This annotation is applied to public fields and public getter/setter methods of beans.
*/
@@ -57,7 +68,7 @@ public @interface BeanProperty {
* If the {@link BeanContext#BEAN_beanFieldVisibility} setting on the bean context excludes this field (e.g. the
* visibility is set to PUBLIC, but the field is PROTECTED), this annotation can be used to force the field to be
* identified as a property.
- * <p>
+ *
* <h6 class='topic'>Dynamic beans</h6>
* The bean property named <js>"*"</js> is the designated "dynamic property" which allows for "extra" bean
* properties not otherwise defined.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java
index dfd2ff8..bce8d94 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java
@@ -29,8 +29,7 @@ import org.apache.juneau.ini.*;
* <p>
* A commonly-used case is when you're parsing a JSON map containing beans where one of the bean properties is the key
* used in the map.
- * <br>
- * For example:
+ * <br>For example:
* <p class='bcode'>
* {
* id1: {name: <js>'John Smith'</js>, sex:<js>'M'</js>},
@@ -44,7 +43,7 @@ import org.apache.juneau.ini.*;
* <jk>public char</jk> <jf>sex</jf>;
* }
* </p>
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>The annotated field or method does not need to be public.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java
index cc903e7..6df9bb9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java
@@ -39,6 +39,7 @@ import org.apache.juneau.ini.*;
* }
* </p>
* <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>The annotated field or method does not need to be public.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
index 2d13768..aa29dc0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
@@ -27,8 +27,7 @@ import org.apache.juneau.serializer.*;
* Provides a way to define the contents of {@link Serializer#getMediaTypes()} through an annotation.
* <p>
* The {@link Serializer#getMediaTypes()} default implementation gathers the media types by looking for this annotation.
- * <br>
- * It should be noted that this annotation is optional and that the {@link Serializer#getMediaTypes()} method can
+ * <br>It should be noted that this annotation is optional and that the {@link Serializer#getMediaTypes()} method can
* be overridden by subclasses to return the media types programmatically.
*
* <h5 class='section'>Example:</h5>
@@ -41,8 +40,7 @@ import org.apache.juneau.serializer.*;
* <p>
* The media types can also be <code>media-range</code> values per
* <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC2616/14.1</a>.
- * <br>
- * When meta-characters are used, you should specify the {@link #contentType()} value to indicate the real media type
+ * <br>When meta-characters are used, you should specify the {@link #contentType()} value to indicate the real media type
* value that can be set on the <code>Content-Type</code> response header.
*
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java
index 6b2e190..926c263 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java
@@ -25,10 +25,12 @@ import org.apache.juneau.parser.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> -
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> -
* Properties associated with handling beans on serializers and parsers.
* <ul>
- * <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> -
+ * <li class='jc'>
+ * <a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> -
* Configurable properties common to all parsers.
* </ul>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java
index 1a77446..fa84e3e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java
@@ -25,10 +25,12 @@ import org.apache.juneau.serializer.*;
*
* <h6 class='topic'>Inherited configurable properties</h6>
* <ul class='doctree'>
- * <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a>
* - Properties associated with handling beans on serializers and parsers.
* <ul>
- * <li class='jc'><a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
+ * <li class='jc'>
+ * <a class="doclink" href="../serializer/SerializerContext.html#ConfigProperties">SerializerContext</a>
* - Configurable properties common to all serializers.
* </ul>
* </ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/doc-files/AddressBook.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/doc-files/AddressBook.html b/juneau-core/src/main/java/org/apache/juneau/doc-files/AddressBook.html
index 10f6427..b892477 100644
--- a/juneau-core/src/main/java/org/apache/juneau/doc-files/AddressBook.html
+++ b/juneau-core/src/main/java/org/apache/juneau/doc-files/AddressBook.html
@@ -22,7 +22,8 @@
<body style='margin:0 20'>
<p></p>
<!-- ======================================================================================================== -->
- <a id="AddressBookSampleSource"></a><h2 class='topic'>AddressBook sample source</h2>
+ <a id="AddressBookSampleSource"></a>
+ <h2 class='topic'>AddressBook sample source</h2>
<p>
Sample code use in various examples throughout the Javadocs. Represents a simple POJO model consisting
of a collection (<code>LinkedList</code>), beans (<code>Address</code>, <code>Person</code>), and a type 4a transformed type (<code>Calendar</code>).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/Link.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/Link.java b/juneau-core/src/main/java/org/apache/juneau/dto/Link.java
index cd1ed55..96d025f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/Link.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/Link.java
@@ -29,8 +29,7 @@ import org.apache.juneau.utils.*;
* <xt><a</xt> <xa>href</xa>=<xs>'href'</xs><xt>></xt>name<xt></a></xt>
* <p>
* When encountered by the {@link HtmlSerializer} class, this object gets converted to a hyperlink.
- * <br>
- * All other serializers simply convert it to a simple bean.
+ * <br>All other serializers simply convert it to a simple bean.
*/
@HtmlLink(nameProperty = "name", hrefProperty = "href")
public class Link implements Comparable<Link> {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
index d03199b..0850725 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
@@ -38,12 +38,17 @@ import org.apache.juneau.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
public class AtomBuilder {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java
index e0d0888..2922276 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java
@@ -24,7 +24,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents an <code>atomCategory</code> construct in the RFC4287 specification.
- * <p>
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomCategory =
@@ -39,12 +39,17 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@Bean(typeName="category")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java
index 26f9965..86c28aa 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java
@@ -24,7 +24,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents an <code>atomCommonAttributes</code> construct in the RFC4287 specification.
- * <p>
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomCommonAttributes =
@@ -35,12 +35,17 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@SuppressWarnings("hiding")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java
index 3d82327..32e34d2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java
@@ -23,16 +23,20 @@ import org.apache.juneau.xml.annotation.*;
/**
* Parent class of {@link Entry}, {@link Feed}, and {@link Source}
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@SuppressWarnings("hiding")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java
index c9c96da..5381c40 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java
@@ -24,7 +24,6 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents an <code>atomContent</code> construct in the RFC4287 specification.
- * <p>
*
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
@@ -65,12 +64,17 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@SuppressWarnings("hiding")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Entry.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Entry.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Entry.java
index f28f083..2bd640b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Entry.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Entry.java
@@ -21,7 +21,7 @@ import org.apache.juneau.transforms.*;
/**
* Represents an <code>atomEntry</code> construct in the RFC4287 specification.
- * <p>
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomEntry =
@@ -45,12 +45,17 @@ import org.apache.juneau.transforms.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@Bean(typeName="entry")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java
index a261320..0e00ebf 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java
@@ -23,7 +23,7 @@ import org.apache.juneau.xml.annotation.*;
* Top-level ATOM feed object.
* <p>
* Represents an <code>atomFeed</code> construct in the RFC4287 specification.
- * <p>
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomFeed =
@@ -48,12 +48,17 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@Bean(typeName="feed")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java
index 8a48a28..983d299 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java
@@ -24,7 +24,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents an <code>atomGenerator</code> construct in the RFC4287 specification.
- * <p>
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomGenerator = element atom:generator {
@@ -37,12 +37,17 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@Bean(typeName="generator")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java
index 964094c..e146669 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java
@@ -24,7 +24,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents an <code>atomIcon</code> construct in the RFC4287 specification.
- * <p>
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomIcon = element atom:icon {
@@ -35,12 +35,17 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@Bean(typeName="icon")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Id.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Id.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Id.java
index 1732a5f..01b194e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Id.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Id.java
@@ -19,7 +19,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents an <code>atomId</code> construct in the RFC4287 specification.
- * <p>
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomId = element atom:id {
@@ -30,12 +30,17 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@Bean(typeName="id")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java
index e6ea325..c3d7e4c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java
@@ -19,7 +19,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents an <code>atomLink</code> construct in the RFC4287 specification.
- * <p>
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomLink =
@@ -37,12 +37,17 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@Bean(typeName="link")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java
index b392e1c..ac1fdc0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java
@@ -24,7 +24,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents an <code>atomLogo</code> construct in the RFC4287 specification.
- * <p>
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomLogo = element atom:logo {
@@ -35,12 +35,17 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@Bean(typeName="logo")
@@ -54,8 +59,7 @@ public class Logo extends Common {
* Normal constructor.
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
- * <br>
- * Strings must be valid URIs.
+ * <br>Strings must be valid URIs.
* <p>
* URIs defined by {@link UriResolver} can be used for values.
*
@@ -87,8 +91,7 @@ public class Logo extends Common {
* Sets the URI of the logo.
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
- * <br>
- * Strings must be valid URIs.
+ * <br>Strings must be valid URIs.
* <p>
* URIs defined by {@link UriResolver} can be used for values.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java
index 7d0b8c4..9a30649 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java
@@ -23,7 +23,7 @@ import org.apache.juneau.annotation.*;
/**
* Represents an <code>atomPersonConstruct</code> construct in the RFC4287 specification.
- * <p>
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomPersonConstruct =
@@ -36,12 +36,17 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@SuppressWarnings("hiding")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Source.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Source.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Source.java
index 416c6fa..f86380b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Source.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Source.java
@@ -18,7 +18,7 @@ import org.apache.juneau.annotation.*;
/**
* Represents an <code>atomSource</code> construct in the RFC4287 specification.
- * <p>
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomSource =
@@ -42,12 +42,17 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@SuppressWarnings("hiding")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java
index f5ef404..fc1dd9f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java
@@ -19,7 +19,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents an <code>atomTextConstruct</code> construct in the RFC4287 specification.
- * <p>
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomTextConstruct = atomPlainTextConstruct | atomXHTMLTextConstruct
@@ -43,12 +43,17 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
@SuppressWarnings("hiding")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/Utils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Utils.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Utils.java
index c8d75a3..f42be90 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Utils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Utils.java
@@ -21,12 +21,17 @@ import javax.xml.bind.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
- * </ul>
- * <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.Atom'>Atom</a>
+ * </ul>
+ * </li>
+ * <li class='jp'>
+ * <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.atom</a>
+ * </li>
* </ul>
*/
class Utils {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/atom/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/package.html b/juneau-core/src/main/java/org/apache/juneau/dto/atom/package.html
index 1208216..4998a54 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/package.html
@@ -75,8 +75,7 @@
<div class='topic'>
<p>
Juneau supports generation and consumption of ATOM feeds through the use of DTOs (Data Transfer Objects).
- <br>
- It uses existing support for serializing and parsing POJOs to and from XML to define these ATOM objects.
+ <br>It uses existing support for serializing and parsing POJOs to and from XML to define these ATOM objects.
</p>
<p>
The examples shown here are pulled from the <code>AtomFeedResource</code> class in the
@@ -90,8 +89,7 @@
<div class='topic'>
<p>
The Juneau ATOM feed DTOs are simply beans with fluent-style setters.
- <br>
- The following code shows a feed being created programmatically using the
+ <br>The following code shows a feed being created programmatically using the
{@link org.apache.juneau.dto.atom.AtomBuilder} class.
</p>
<p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/cognos/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/package.html b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/package.html
index 1e8b44b..b19a781 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/package.html
@@ -79,6 +79,7 @@
<li>{@code MyBean[]}
<li>{@code HashMap[]}
</ul>
+
<h6 class='topic'>Example:</h6>
<p>
The following example shows how to generate Cognos-XML from a POJO.
@@ -148,14 +149,18 @@
<xt></c:data></xt>
<xt></c:dataset></xt>
</p>
+
<h6 class='topic'>Other data formats</h6>
<p>
The following shows examples of what this data structure looks like when serialized to other formats:
</p>
+
<h6 class='figure'>HTML</h6>
<img class='bordered' src='doc-files/HTML.png'>
+
<h6 class='figure'>JSON</h6>
<img class='bordered' src='doc-files/JSON.png'>
+
<h6 class='figure'>RDF/XML</h6>
<img class='bordered' src='doc-files/RDFXML.png'>
</div>
@@ -167,6 +172,7 @@
<p>
The {@link org.apache.juneau.dto.cognos.DataSet} class can be reconstructed from Cognos/XML using one of the standard XML parsers.
</p>
+
<h6 class='topic'>Example:</h6>
<p class='bcode'>
<jc>// Parse XML back into original DataSet</jc>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java
index d9a4286..843dfb6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java
@@ -25,11 +25,14 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="a")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java
index 7c08fb3..510df45 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-abbr-element"><abbr></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="abbr")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java
index 79900bd..91856d3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/sections.html#the-address-element"><address></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="address")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java
index fc8591d..7b69b4e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java
@@ -21,15 +21,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/embedded-content-0.html#the-area-element"><area></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="area")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java
index 1a5687d..2953d0d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/sections.html#the-article-element"><article></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="article")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java
index 5981926..c14e239 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/sections.html#the-aside-element"><aside></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="aside")
[02/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-rest/src/main/java/org/apache/juneau/rest/package.html
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/package.html b/juneau-rest/src/main/java/org/apache/juneau/rest/package.html
index 7c04791..0e0940c 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/package.html
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/package.html
@@ -95,7 +95,7 @@
<li><p><a class='doclink' href='#RestServlets.Headers'>Default Headers</a></p>
<li><p><a class='doclink' href='#RestServlets.Errors'>Handling Errors / Logging</a></p>
<li><p><a class='doclink' href='#RestServlets.ConfigFile'>Configuration Files</a></p>
- <li><p><a class='doclink' href='#RestServlets.Inheritence'>Annotation Inheritence</a></p>
+ <li><p><a class='doclink' href='#RestServlets.Inheritence'>Annotation Inheritance</a></p>
<li><p><a class='doclink' href='#RestServlets.HttpStatusCodes'>HTTP Status Codes</a></p>
<li><p><a class='doclink' href='#RestServlets.OverloadedHttpMethods'>Overloaded HTTP Methods</a></p>
<li><p><a class='doclink' href='#RestServlets.BuildInParams'>Built-In Parameters</a></p>
@@ -104,7 +104,7 @@
<li><p><a class='doclink' href='#RestServlets.OtherNotes'>Other Notes</a></p>
</ol>
<li><p><a class='doclink' href='#Osgi'>Using with OSGi</a></p>
- <li><p><a class='doclink' href='#PojosConvertableFromString'>POJOs Convertable From Strings</a></p>
+ <li><p><a class='doclink' href='#PojosConvertableFromString'>POJOs Convertible From Strings</a></p>
<li><p><a class='doclink' href='#AddressBookResource'>Address Book Resource</a></p>
</ol>
@@ -113,79 +113,93 @@
<h2 class='topic' onclick='toggle(this)'>1 - Introduction</h2>
<div class='topic'>
<p>
- The <l>juneau-rest.jar</l> library allows you to quickly wrap POJOs and expose them as full-fledged REST resources served up in a servlet container using a bare-minimum amount of code.
- The primary goal for Juneau was to make it as easy as possible to implement easy-to-read and self-documenting REST resources using very little code.
+ The <l>juneau-rest.jar</l> library allows you to quickly wrap POJOs and expose them as full-fledged REST
+ resources served up in a servlet container using a bare-minimum amount of code.
+ The primary goal for Juneau was to make it as easy as possible to implement easy-to-read and self-documenting
+ REST resources using very little code.
</p>
<p>
- One of the biggest advantages of the Juneau REST framework over similar architectures is that it hides the serialization layer from the developer.
- The developer can work entirely with POJOs and let the Juneau framework handle all the serialization and parsing work.
- The developer need never know what the <l>Accept</l> or <l>Content-Type</l> or <l>Accept-Encoding</l> (etc...) header values are because those details are all handled by the framework.
+ One of the biggest advantages of the Juneau REST framework over similar architectures is that it hides the
+ serialization layer from the developer.
+ The developer can work entirely with POJOs and let the Juneau framework handle all the serialization and
+ parsing work.
+ The developer need never know what the <l>Accept</l> or <l>Content-Type</l> or <l>Accept-Encoding</l> (etc...)
+ header values are because those details are all handled by the framework.
</p>
<p>
The API builds upon the existing JEE Servlet API.
- The root class, {@link org.apache.juneau.rest.RestServlet} is nothing but a specialized {@link javax.servlet.http.HttpServlet}, and the
- {@link org.apache.juneau.rest.RestRequest} and {@link org.apache.juneau.rest.RestResponse} classes are nothing more than specialized {@link javax.servlet.http.HttpServletRequest} and
- {@link javax.servlet.http.HttpServletResponse} objects.
- This allows maximum flexibility for the developer since you can let Juneau handle operations such as serialization, or you can revert
- to the existing servlet APIs to do low-level processing of requests yourself.
+ The root class, {@link org.apache.juneau.rest.RestServlet} is nothing but a specialized
+ {@link javax.servlet.http.HttpServlet}, and the {@link org.apache.juneau.rest.RestRequest} and
+ {@link org.apache.juneau.rest.RestResponse} classes are nothing more than specialized
+ {@link javax.servlet.http.HttpServletRequest} and {@link javax.servlet.http.HttpServletResponse} objects.
+ This allows maximum flexibility for the developer since you can let Juneau handle operations such as
+ serialization, or you can revert to the existing servlet APIs to do low-level processing of requests yourself.
It also means you need nothing more than a Servlet container such as Jetty to use the REST framework.
</p>
+
<h6 class='topic'>Features</h6>
<ul class='spaced-list'>
- <li>Serializes POJOs to JSON, XML, HTML, URL-Encoding, UON, RDF/XML, N-Triple, Turtle, N3, SOAP, or Java-serialized-object based on
- value of <l>Accept</l> header. <br>
- No user code is required to handle these types.
- <br>
+ <li>
+ Serializes POJOs to JSON, XML, HTML, URL-Encoding, UON, RDF/XML, N-Triple, Turtle, N3, SOAP, or
+ Java-serialized-object based on value of <l>Accept</l> header.
+ <br>No user code is required to handle these types.
<ul>
- <li>Extensible design that provides ability to override existing content type handlers, or add the ability to handle other kinds of content types.
+ <li>Extensible design that provides ability to override existing content type handlers, or add the
+ ability to handle other kinds of content types.
</ul>
- <br>
- <li>Parses content of POST/PUT request bodies to POJOs.
- <br><br>
- <li>Automatic built-in ability to serialize POJO metadata to JSON+SCHEMA, XML+SCHEMA, or HTML+SCHEMA based on <l>Accept</l> header.
- <br><br>
- <li>Automatic negotiation of output Writer based on HTTP headers.
- <br>
+ <li>
+ Parses content of POST/PUT request bodies to POJOs.
+ <li>
+ Automatic built-in ability to serialize POJO metadata to JSON+SCHEMA, XML+SCHEMA, or HTML+SCHEMA based on
+ <l>Accept</l> header.
+ <li>
+ Automatic negotiation of output Writer based on HTTP headers.
<ul>
<li>Automatic handling of <l>Accept-Charset</l> header for all character sets supported by the JVM.
<li>Automatic handling of <l>Accept-Encoding</l> header with registered encoders.
</ul>
- <br>
- <li>Automatic error handling.
- <br>
+ <li>
+ Automatic error handling.
<ul>
<li>Automatic 401 errors (Unauthorized) on failed guards.
<li>Automatic 404 errors (Not Found) on unmatched path patterns.
<li>Automatic 405 errors (Method Not Implemented) on unimplemented methods.
- <li>Automatic 406 errors (Not Acceptable) when no matching serializer was found to handle the <l>Accept</l> header.
+ <li>Automatic 406 errors (Not Acceptable) when no matching serializer was found to handle the
+ <l>Accept</l> header.
<li>Automatic 412 errors (Precondition Failed) when all matchers failed to match.
- <li>Automatic 415 errors (Unsupported Media Type) when no matching parser was found was found to handle the <l>Content-Type</l> header.
+ <li>Automatic 415 errors (Unsupported Media Type) when no matching parser was found was found to handle
+ the <l>Content-Type</l> header.
<li>Automatic 500 errors on uncaught exceptions.
</ul>
- <br>
- <li>Self-documenting REST interfaces.
- <br>
- <li>Various useful debugging features that make debugging using a browser extremely simple...
- <br>
+ <li>
+ Self-documenting REST interfaces.
+ <li>
+ Various useful debugging features that make debugging using a browser extremely simple...
<ul>
<li>Ability to pass HTTP header values as URL GET parameters (e.g. <l>&Accept=text/xml</l>).
- <li>Ability to pass HTTP content on PUT/POST requests as a URL GET parameter (e.g. <l>&content={foo:"bar"}</l>).
- <li>Ability to simulate non-GET requests using a <l>&method</l> GET parameter (e.g. <l>&method=POST</l>).
+ <li>Ability to pass HTTP content on PUT/POST requests as a URL GET parameter
+ (e.g. <l>&content={foo:"bar"}</l>).
+ <li>Ability to simulate non-GET requests using a <l>&method</l> GET parameter
+ (e.g. <l>&method=POST</l>).
<li>Ability to force <js>"text/plain"</js> on response using GET parameter <l>&plainText=true</l>.
</ul>
- <br>
- <li>Ability to implement overloaded HTTP methods through the use of the <l>&method</l> attribute (e.g. <l>&method=FOO</l>).
- <br><br>
- <li>Ability to match URL patterns (e.g. <l>/foo/{fooId}/bar/{barId}</l>) against URLs (e.g. <l>/foo/123/bar/456/bing</l>).
- <br><br>
- <li>Ability to associate guards at the resource or method levels through annotations.<br>
- Typically useful for security, but can be used for a variety of purposes.
- <br><br>
- <li>Ability to associate converters at the resource or method levels through annotations.<br>
- Typically useful for performing conversions on input and output, such as for supporting older input and output formats.
+ <li>
+ Ability to implement overloaded HTTP methods through the use of the <l>&method</l> attribute
+ (e.g. <l>&method=FOO</l>).
+ <li>
+ Ability to match URL patterns (e.g. <l>/foo/{fooId}/bar/{barId}</l>) against URLs
+ (e.g. <l>/foo/123/bar/456/bing</l>).
+ <li>
+ Ability to associate guards at the resource or method levels through annotations.
+ <br>Typically useful for security, but can be used for a variety of purposes.
+ <li>
+ Ability to associate converters at the resource or method levels through annotations.
+ <br>Typically useful for performing conversions on input and output, such as for supporting older input and
+ output formats.
</ul>
<p>
- Many of the examples in this document are pulled directly from the <l>microservice-samples-project.zip</l> project.
+ Many of the examples in this document are pulled directly from the <l>microservice-samples-project.zip</l>
+ project.
</p>
</div>
@@ -194,7 +208,8 @@
<h2 class='topic' onclick='toggle(this)'>2 - Hello World Example</h2>
<div class='topic'>
<p>
- A REST resource is an implementation of {@link org.apache.juneau.rest.RestServlet}, which itself is simply an extension of {@link javax.servlet.http.HttpServlet}.
+ A REST resource is an implementation of {@link org.apache.juneau.rest.RestServlet}, which itself is simply an
+ extension of {@link javax.servlet.http.HttpServlet}.
</p>
<p>
In this example, we define a resource called <l>HelloWorldResource</l>.
@@ -252,12 +267,15 @@
</p>
<p>
It doesn't much simpler than that.
- In this case, we're simply returning a string that will be converted to any of the supported languages (e.g. JSON, XML, HTML, ...).
+ In this case, we're simply returning a string that will be converted to any of the supported languages (e.g.
+ JSON, XML, HTML, ...).
However, we could have returned any POJO consisting of beans, maps, collections, etc...
</p>
<p>
- The {@link org.apache.juneau.rest.RestServletDefault} class that we're using here is a subclass of {@link org.apache.juneau.rest.RestServlet} that provides default support for a variety of content types.
- Implementers can choose to use this class, or create their own subclass of {@link org.apache.juneau.rest.RestServlet} with their own specialized serializers and parsers.
+ The {@link org.apache.juneau.rest.RestServletDefault} class that we're using here is a subclass of
+ {@link org.apache.juneau.rest.RestServlet} that provides default support for a variety of content types.
+ Implementers can choose to use this class, or create their own subclass of
+ {@link org.apache.juneau.rest.RestServlet} with their own specialized serializers and parsers.
</p>
<p>
If you were to start up this servlet and view it with a browser, you would see this:
@@ -268,12 +286,15 @@
Therefore, several built-in features are provided for making it easy to do so.
Specifically, we'll be using these available URL parameters...
</p>
- <ul class='normal'>
- <li><l>&plainText=true</l> - If specified, then the <l>Content-Type</l> on the response is always <l>"text/plain"</l> regardless of the data format.
- <br><br>
- <li><l>&Accept=X</l> - Specify the content type of the response.
- In a browser, <l>"text/html"</l> is the default content type, but this parameter can be used to override the content type on the response.<br>
- Note: The behavior is identical to setting the <l>Accept</l> header on the request.
+ <ul class='spaced-list'>
+ <li>
+ <l>&plainText=true</l> - If specified, then the <l>Content-Type</l> on the response is always
+ <l>"text/plain"</l> regardless of the data format.
+ <li>
+ <l>&Accept=X</l> - Specify the content type of the response.
+ In a browser, <l>"text/html"</l> is the default content type, but this parameter can be used to override
+ the content type on the response.
+ <br>Note: The behavior is identical to setting the <l>Accept</l> header on the request.
In fact, Juneau allows ANY HTTP request headers to be specified as URL parameters for debugging purposes.
</ul>
<p>
@@ -285,10 +306,12 @@
It is possible to specify your own stylesheet, but the default styles will usually suffice for most purposes.
</p>
<p>
- When accessed through a browser, the content type will default to HTML (based on the value of the <l>Accept</l> HTTP header).
+ When accessed through a browser, the content type will default to HTML (based on the value of the <l>Accept</l>
+ HTTP header).
</p>
<p>
- Let's use the <l>&Accept</l> URL paramter to override the <l>Accept</l> HTTP header to view this servlet in other formats...
+ Let's use the <l>&Accept</l> URL parameter to override the <l>Accept</l> HTTP header to view this servlet
+ in other formats...
</p>
<p>
In the case of <l>JSON</l>, we're serialize a single string, so it gets rendered as a JSON fragment....
@@ -309,7 +332,7 @@
The OPTIONS page is a serialized Swagger DTO bean populated by introspection of the class itself combined with
labels in the messages properties file and annotations.
It's composed of a POJO that gets serialized just like any other POJO.
- Therefore, the POJO can be searialized to any of the supported languages, like Swagger JSON.
+ Therefore, the POJO can be serialized to any of the supported languages, like Swagger JSON.
</p>
<img class='bordered' src="doc-files/HelloWorldResourceOptionsJson.png">
</div>
@@ -322,81 +345,107 @@
The class hierarchy for the REST servlet class is shown below:
</p>
<ul class='doctree'>
- <li class='jac'>{@link javax.servlet.http.HttpServlet javax.servlet.http.HttpServlet}
- <ul>
- <li class='jac'>{@link org.apache.juneau.rest.RestServlet org.apache.juneau.rest.RestServlet}
- <br>Contains all the main logic.
+ <li class='jac'>
+ {@link javax.servlet.http.HttpServlet javax.servlet.http.HttpServlet}
<ul>
- <li class='jac'>{@link org.apache.juneau.rest.RestServletDefault org.apache.juneau.rest.RestServletDefault}
- <br>Provides a default set of serializers, parsers, options page, stylesheet, and other common settings.
- <br><b>Developers will typically subclass this when creating REST resources in JEE environments.</b>
- <ul>
- <li class='jac'>{@link org.apache.juneau.microservice.Resource org.apache.juneau.microservice.Resource}
- <br>Subclass intented to be used in REST microservices.
- <br><b>Developers will typically subclass this when creating microservices.</b>
- <li class='jac'>{@link org.apache.juneau.rest.RestServletGroupDefault org.apache.juneau.rest.RestServletGroupDefault}
- <br>A default implementation for "router" pages.
+ <li class='jac'>
+ {@link org.apache.juneau.rest.RestServlet org.apache.juneau.rest.RestServlet}
+ <br>Contains all the main logic.
<ul>
- <li class='jac'>{@link org.apache.juneau.microservice.ResourceGroup org.apache.juneau.microservice.ResourceGroup}
- <br>Subclass intented to be used in REST microservices.
+ <li class='jac'>
+ {@link org.apache.juneau.rest.RestServletDefault org.apache.juneau.rest.RestServletDefault}
+ <br>Provides a default set of serializers, parsers, options page, stylesheet, and other common settings.
+ <br><b>Developers will typically subclass this when creating REST resources in JEE environments.</b>
+ <ul>
+ <li class='jac'>
+ {@link org.apache.juneau.microservice.Resource org.apache.juneau.microservice.Resource}
+ <br>Subclass intended to be used in REST microservices.
+ <br><b>Developers will typically subclass this when creating microservices.</b>
+ <li class='jac'>
+ {@link org.apache.juneau.rest.RestServletGroupDefault org.apache.juneau.rest.RestServletGroupDefault}
+ <br>A default implementation for "router" pages.
+ <ul>
+ <li class='jac'>
+ {@link org.apache.juneau.microservice.ResourceGroup org.apache.juneau.microservice.ResourceGroup}
+ <br>Subclass intended to be used in REST microservices.
+ </ul>
+ </li>
+ <li class='jc'>
+ {@link org.apache.juneau.rest.remoteable.RemoteableServlet org.apache.juneau.rest.remoteable.RemoteableServlet}
+ <br>REST servlet for implementing remoteable proxy interfaces.
+ </ul>
+ </li>
+ <li class='jac'>
+ {@link org.apache.juneau.rest.jena.RestServletJenaDefault org.apache.juneau.rest.jena.RestServletJenaDefault}
+ <br>Same as {@link org.apache.juneau.rest.RestServletDefault}, but adds RDF support.
+ <ul>
+ <li class='jac'>
+ {@link org.apache.juneau.microservice.ResourceJena org.apache.juneau.microservice.ResourceJena}
+ <br>Subclass intended to be used in REST microservices.
+ <li class='jac'>
+ {@link org.apache.juneau.rest.jena.RestServletJenaGroupDefault org.apache.juneau.rest.jena.RestServletJenaGroupDefault}
+ <br>Same as {@link org.apache.juneau.rest.RestServletGroupDefault}, but adds RDF support.
+ </ul>
+ </li>
</ul>
- <li class='jc'>{@link org.apache.juneau.rest.remoteable.RemoteableServlet org.apache.juneau.rest.remoteable.RemoteableServlet}
- <br>REST servlet for implementing remoteable proxy interfaces.
- </ul>
- <li class='jac'>{@link org.apache.juneau.rest.jena.RestServletJenaDefault org.apache.juneau.rest.jena.RestServletJenaDefault}
- <br>Same as {@link org.apache.juneau.rest.RestServletDefault}, but adds RDF support.
- <ul>
- <li class='jac'>{@link org.apache.juneau.microservice.ResourceJena org.apache.juneau.microservice.ResourceJena}
- <br>Subclass intented to be used in REST microservices.
- <li class='jac'>{@link org.apache.juneau.rest.jena.RestServletJenaGroupDefault org.apache.juneau.rest.jena.RestServletJenaGroupDefault}
- <br>Same as {@link org.apache.juneau.rest.RestServletGroupDefault}, but adds RDF support.
- </ul>
+ </li>
</ul>
- </ul>
+ </li>
</ul>
<p>
The servlets with RDF support require Jena on the classpath.
All other serializers and parsers do not have any external library dependencies.
- For this reason, we have separate servlets for supporting RDF so that you don't need Jena if you don't need to support RDF.
+ For this reason, we have separate servlets for supporting RDF so that you don't need Jena if you don't need to
+ support RDF.
</p>
<p>
- The {@link org.apache.juneau.rest.RestRequest} and {@link org.apache.juneau.rest.RestResponse} classes described later also extend from their servlet equivalents:
+ The {@link org.apache.juneau.rest.RestRequest} and {@link org.apache.juneau.rest.RestResponse} classes
+ described later also extend from their servlet equivalents:
</p>
<ul class='doctree'>
- <li class='jic'>{@link javax.servlet.http.HttpServletRequest javax.servlet.http.HttpServletRequest}
- <ul>
- <li class='jc'>{@link org.apache.juneau.rest.RestRequest org.apache.juneau.rest.RestRequest} - Augmented with specialized REST methods.
- </ul>
- <li class='jic'>{@link javax.servlet.http.HttpServletResponse javax.servlet.http.HttpServletResponse}
- <ul>
- <li class='jc'>{@link org.apache.juneau.rest.RestResponse org.apache.juneau.rest.RestResponse} - Augmented with specialized REST methods.
- </ul>
+ <li class='jic'>
+ {@link javax.servlet.http.HttpServletRequest javax.servlet.http.HttpServletRequest}
+ <ul>
+ <li class='jc'>
+ {@link org.apache.juneau.rest.RestRequest org.apache.juneau.rest.RestRequest}
+ - Augmented with specialized REST methods.
+ </ul>
+ </li>
+ <li class='jic'>
+ {@link javax.servlet.http.HttpServletResponse javax.servlet.http.HttpServletResponse}
+ <ul>
+ <li class='jc'>
+ {@link org.apache.juneau.rest.RestResponse org.apache.juneau.rest.RestResponse}
+ - Augmented with specialized REST methods.
+ </ul>
+ </li>
</ul>
</div>
- <!-- ======================================================================================================== -->
+<!-- ======================================================================================================== -->
<a id="RestResources"></a>
<h2 class='topic' onclick='toggle(this)'>4 - REST Servlets</h2>
- <div class='topic'>
- <p>
- Since REST servlets are subclasses of <l>HttpServlet</l>, they can be deployed in a J2EE
- container like any other servlet, typically inside a <l>web.xml</l> file.
- The REST servlet framework does not depend on any classloader scanning or external setup
- other than registering the servlet with the J2EE container.
- </p>
- <p>
+<div class='topic'>
+ <p>
+ Since REST servlets are subclasses of <l>HttpServlet</l>, they can be deployed in a J2EE container like any
+ other servlet, typically inside a <l>web.xml</l> file.
+ The REST servlet framework does not depend on any classloader scanning or external setup other than
+ registering the servlet with the J2EE container.
+ </p>
+ <p>
REST servlets can also be deployed by declaring them as children of other REST servlets (described later).
- </p>
- <p>
- A REST servlet consists of an instance of {@link org.apache.juneau.rest.RestServlet}
- annotated with {@link org.apache.juneau.rest.annotation.RestResource @RestResource} containing
- public Java methods annotated with {@link org.apache.juneau.rest.annotation.RestMethod @RestMethod}.
- </p>
- <p>
+ </p>
+ <p>
+ A REST servlet consists of an instance of {@link org.apache.juneau.rest.RestServlet} annotated with
+ {@link org.apache.juneau.rest.annotation.RestResource @RestResource} containing public Java methods
+ annotated with {@link org.apache.juneau.rest.annotation.RestMethod @RestMethod}.
+ </p>
+ <p>
Developers will typically subclass directly from {@link org.apache.juneau.rest.RestServletDefault}
- since it provides a default set of serializers and parsers for a variety of
- <l>Accept</l> and <l>Content-Type</l> types.
- </p>
+ since it provides a default set of serializers and parsers for a variety of <l>Accept</l> and
+ <l>Content-Type</l> types.
+ </p>
+
<h6 class='figure'>Valid Accept headers for RestServletDefault</h6>
<table class='styled'>
<tr>
@@ -465,6 +514,7 @@
<td>{@link org.apache.juneau.jso.JsoSerializer}</td>
</tr>
</table>
+
<h6 class='figure'>Valid Content-Type headers for RestServletDefault</h6>
<table class='styled'>
<tr>
@@ -498,15 +548,17 @@
</table>
<p>
{@link org.apache.juneau.rest.RestServletDefault} also provides a default OPTIONS page by implementing
- a {@link org.apache.juneau.rest.RestServletDefault#getOptions(RestRequest)} method that returns a POJO consisting
- of beans describing the class.
+ a {@link org.apache.juneau.rest.RestServletDefault#getOptions(RestRequest)} method that returns a POJO
+ consisting of beans describing the class.
This is what produces the output for the OPTIONS page on the Hello World sample above.
- </p>
+ </p>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jac'>{@link org.apache.juneau.rest.RestServletDefault}
- <li class='jac'>{@link org.apache.juneau.rest.jena.RestServletJenaDefault}
+ <li class='jac'>
+ {@link org.apache.juneau.rest.RestServletDefault}
+ <li class='jac'>
+ {@link org.apache.juneau.rest.jena.RestServletJenaDefault}
</ul>
<!-- ======================================================================================================== -->
@@ -514,7 +566,8 @@
<h3 class='topic' onclick='toggle(this)'>4.1 - REST Java Method Signature</h3>
<div class='topic'>
<p>
- REST Java methods are identified on REST servlets using the {@link org.apache.juneau.rest.annotation.RestMethod @RestMethod} annotation.
+ REST Java methods are identified on REST servlets using the
+ {@link org.apache.juneau.rest.annotation.RestMethod @RestMethod} annotation.
The annotation allows the framework to identify the available REST methods through reflection.
</p>
<p class='bcode'>
@@ -524,20 +577,26 @@
<jk>return</jk> <js>"Hello world!"</js>;
}
</p>
+
<h6 class='topic'>Method Name</h6>
<p>
There are no restrictions on the name of the Java method. However, if you plan on making use of the
- {@link org.apache.juneau.rest.annotation.RestResource#messages() @RestResource.messages()}
- annotation (described later), the method names must be unique to make it possible to identify unique keys for labels in the resource bundle.
- Therefore, you should not define two identically-named <l>doFoo(...)</l> methods that differ only by parameters.
+ {@link org.apache.juneau.rest.annotation.RestResource#messages() @RestResource.messages()} annotation
+ (described later), the method names must be unique to make it possible to identify unique keys for labels
+ in the resource bundle.
+ Therefore, you should not define two identically-named <l>doFoo(...)</l> methods that differ only by
+ parameters.
If you're not using messages for NLS support, then name them whatever you want!
</p>
+
<h6 class='topic'>Method Return Type</h6>
<p>
- The return type can be any serializable POJO as defined in <a class='doclink' href='../../../../overview-summary.html#Core.PojoCategories'>POJO Categories</a>.
- It can also be <jk>void</jk> if the method is not sending any output (e.g. a request redirect) or
- is setting the output using the {@link org.apache.juneau.rest.RestResponse#setOutput(Object)} method.
- Calling the {@link org.apache.juneau.rest.RestResponse#setOutput(Object)} method is functionally equivalent to returning a value.
+ The return type can be any serializable POJO as defined in <a class='doclink'
+ href='../../../../overview-summary.html#Core.PojoCategories'>POJO Categories</a>.
+ It can also be <jk>void</jk> if the method is not sending any output (e.g. a request redirect) or is
+ setting the output using the {@link org.apache.juneau.rest.RestResponse#setOutput(Object)} method.
+ Calling the {@link org.apache.juneau.rest.RestResponse#setOutput(Object)} method is functionally equivalent
+ to returning a value.
</p>
<p class='bcode'>
<jc>// Equivalent method 1</jc>
@@ -556,30 +615,43 @@
The return type can also be any of the following special object types:
</p>
<ul class='doctree'>
- <li class='jc'>{@link java.io.InputStream}
- <br>The contents are simply piped to the output stream returned by {@link org.apache.juneau.rest.RestResponse#getNegotiatedOutputStream()}.
- <br>Note that you should call {@link org.apache.juneau.rest.RestResponse#setContentType(String)} to set the <l>Content-Type</l> header if you use this object type.
- <li class='jc'>{@link java.io.Reader}
- <br>The contents are simply piped to the output stream returned by {@link org.apache.juneau.rest.RestResponse#getNegotiatedWriter()}.
- <br>Note that you should call {@link org.apache.juneau.rest.RestResponse#setContentType(String)} to set the <l>Content-Type</l> header if you use this object type.
- <li class='jc'>{@link org.apache.juneau.rest.Redirect}
+ <li class='jc'>
+ {@link java.io.InputStream}
+ <br>The contents are simply piped to the output stream returned by
+ {@link org.apache.juneau.rest.RestResponse#getNegotiatedOutputStream()}.
+ <br>Note that you should call {@link org.apache.juneau.rest.RestResponse#setContentType(String)} to set
+ the <l>Content-Type</l> header if you use this object type.
+ <li class='jc'>
+ {@link java.io.Reader}
+ <br>The contents are simply piped to the output stream returned by
+ {@link org.apache.juneau.rest.RestResponse#getNegotiatedWriter()}.
+ <br>Note that you should call {@link org.apache.juneau.rest.RestResponse#setContentType(String)} to set
+ the <l>Content-Type</l> header if you use this object type.
+ <li class='jc'>
+ {@link org.apache.juneau.rest.Redirect}
<br>Represents an HTTP redirect response.
- <li class='jic'>{@link org.apache.juneau.Streamable}
+ <li class='jic'>
+ {@link org.apache.juneau.Streamable}
<br>Interface that identifies that an object can be serialized directly to an output stream.
- <li class='jic'>{@link org.apache.juneau.Writable}
+ <li class='jic'>
+ {@link org.apache.juneau.Writable}
<br>Interface that identifies that an object can be serialized directly to a writer.
- <li class='jc'>{@link org.apache.juneau.utils.ZipFileList}
+ <li class='jc'>
+ {@link org.apache.juneau.utils.ZipFileList}
<br>Special interface for sending zip files as responses.
</ul>
<p>
- Additional "special types" can be defined through the {@link org.apache.juneau.rest.ResponseHandler} interface (described later).
+ Additional "special types" can be defined through the {@link org.apache.juneau.rest.ResponseHandler}
+ interface (described later).
</p>
+
<h6 class='topic'>Method Parameters</h6>
<p>
The method can contain any of the following parameters in any order:
</p>
<ul class='spaced-list'>
- <li>Parameters of the following class types:
+ <li>
+ Parameters of the following class types:
<ul>
<li>Request/response objects:
<ul>
@@ -654,7 +726,8 @@
<li>{@link org.apache.juneau.ini.ConfigFile} - The external config file for the resource.
</ul>
</ul>
- <li>Annotated parameters:
+ <li>
+ Annotated parameters:
<ul>
<li>{@link org.apache.juneau.rest.annotation.Path @Path} - Variables in matched URL path patterns.
<li>{@link org.apache.juneau.rest.annotation.FormData @FormData} - Multipart form post parameter values.
@@ -694,8 +767,9 @@
}
</p>
<p>
- All the annotated parameters (with the exception of <l>@Body</l>) can be any POJO type convertable from a <l>String</l>.
- (See <a class='doclink' href='#PojosConvertableFromString'>POJOs Convertable From String</a>)
+ All the annotated parameters (with the exception of <l>@Body</l>) can be any POJO type convertible from a
+ <l>String</l>.
+ (See <a class='doclink' href='#PojosConvertableFromString'>POJOs Convertible From String</a>)
</p>
<p>
For example, headers can be accessed as Strings or UUIDs...
@@ -716,17 +790,17 @@
<h4 class='topic' onclick='toggle(this)'>4.1.1 - Path</h4>
<div class='topic'>
<p>
- The {@link org.apache.juneau.rest.annotation.RestMethod#path() @RestMethod.path()} annotation
- allows you to define URL path patterns to match against.
+ The {@link org.apache.juneau.rest.annotation.RestMethod#path() @RestMethod.path()} annotation allows
+ you to define URL path patterns to match against.
These patterns can contain variables of the form <l>"{xxx}"</l> that can be passed in directly to the
- Java methods as extra parameters.
- </p>
- <p>
+ Java methods as extra parameters.
+ </p>
+ <p>
In the following example, 3 separate GET request handlers are defined with different path patterns.
- Note how the variables are passed in as additional arguments on the method, and how those arguments are automatically
- converted to the specified class type...
- </p>
- <p class='bcode'>
+ Note how the variables are passed in as additional arguments on the method, and how those arguments are
+ automatically converted to the specified class type...
+ </p>
+ <p class='bcode'>
<jc>// Default method</jc>
<ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/*"</js>)
<jk>public void</jk> doGetDefault() {
@@ -744,12 +818,12 @@
<jk>public void</jk> doGetWithArgs(<ja>@Path</ja> String foo, <ja>@Path</ja> <jk>int</jk> bar, <ja>@Path</ja> MyEnum baz, <ja>@Path</ja> UUID bing) {
...
}
- </p>
- <p>
+ </p>
+ <p>
By default, path patterns are matched using a best-match heuristic.
When overlaps occur, URLs are matched from most-specific to most-general order:
- </p>
- <p class='bcode'>
+ </p>
+ <p class='bcode'>
<jc>// Try first </jc>
<ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/foo/bar"</js>)
<jk>public void</jk> method1() {
@@ -773,19 +847,22 @@
<jk>public void</jk> method4(...) {
...
}
- </p>
- <p>
- The match heuristic behavior can be overridden by the {@link org.apache.juneau.rest.annotation.RestMethod#priority() @RestMethod.priority()} annotation property.
+ </p>
+ <p>
+ The match heuristic behavior can be overridden by the
+ {@link org.apache.juneau.rest.annotation.RestMethod#priority() @RestMethod.priority()} annotation
+ property.
However, in practice this is almost never needed.
- </p>
- <p>
+ </p>
+ <p>
Paths that end with <js>"/*"</js> will do a prefix match on the incoming URL.
- Any remainder after the match can be accessed through {@link org.apache.juneau.rest.RequestPathMatch#getRemainder()}
- or parameters with the {@link org.apache.juneau.rest.annotation.PathRemainder @PathRemainder} annotation.
- On the other hand, paths that don't end with <js>"/*"</js> (e.g. <js>"/"</js> or <js>"/foo"</js>) will require
- an exact URL match, and if any remainder exists, a 404 (not found) error will be thrown.
- </p>
- <p>
+ Any remainder after the match can be accessed through
+ {@link org.apache.juneau.rest.RequestPathMatch#getRemainder()} or parameters with the
+ {@link org.apache.juneau.rest.annotation.PathRemainder @PathRemainder} annotation.
+ On the other hand, paths that don't end with <js>"/*"</js> (e.g. <js>"/"</js> or <js>"/foo"</js>) will
+ require an exact URL match, and if any remainder exists, a 404 (not found) error will be thrown.
+ </p>
+ <p>
The following example shows the distinction.
</p>
<p class='bcode'>
@@ -798,8 +875,8 @@
<jk>public void</jk> doPut() {
<jc>// URL path pattern must match exactly and will cause a 404 error if a remainder exists.</jc>
}
- </p>
- <p>
+ </p>
+ <p>
Annotations are provided for easy access to URL parameters with automatic conversion to any parsable object type.
For example, the following example can process the URL <l>"/urlWithParams?foo=foo&bar=[1,2,3]&baz=067e6162-3b6f-4ae2-a171-2470b63dff00"</l>...
</p>
@@ -809,16 +886,18 @@
<jk>public</jk> String doGetWithParams(<ja>@Query</ja>(<js>"foo"</js>) String foo, <ja>@Query</ja>(<js>"bar"</js>) <jk>int</jk> bar, <ja>@Query</ja>(<js>"baz"</js>) UUID baz) <jk>throws</jk> Exception {
<jk>return</jk> <js>"GET /urlWithParams?foo="</js>+foo+<js>"&bar="</js>+bar+<js>"&baz="</js>+baz);
}
- </p>
+ </p>
</div>
<!-- ======================================================================================================== -->
<a id="RestResources.MethodSignature.Matchers"></a>
<h4 class='topic' onclick='toggle(this)'>4.1.2 - Matchers</h4>
<div class='topic'>
- <p>
- {@link org.apache.juneau.rest.RestMatcher RestMatchers} are used to allow multiple Java methods to be tied to the same HTTP method and path, but
- differentiated by some request attribute such as a specific header value.
+ <p>
+ {@link org.apache.juneau.rest.RestMatcher RestMatchers} are used to allow multiple Java methods to be
+ tied to the same HTTP method and path, but differentiated by some request attribute such as a specific
+ header value.
+ </p>
<p class='bcode'>
<jc>// GET method that gets invoked for administrators</jc>
<ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/*"</js>, matchers=IsAdminMatcher.<jk>class</jk>)
@@ -831,8 +910,8 @@
<jk>public</jk> Object doGetForEveryoneElse() {
...
}
- </p>
- <p>
+ </p>
+ <p>
The interface for matchers is simple:
</p>
<p class='bcode'>
@@ -842,18 +921,25 @@
<jk>return</jk> req.isUserInRole(<js>"ADMINS_GROUP"</js>);
}
}
- </p>
+ </p>
+
<h6 class='topic'>Other Notes</h6>
<ul class='spaced-list'>
- <li>If no methods are found with a matching matcher, a <l>412 Precondition Failed</l> status is returned.
- <li>If multiple matchers are specified on the same method, ONLY ONE matcher needs to match for the method to be invoked.
- <li>Note that you CANNOT define identical paths on different methods UNLESS you use matchers.
- <br>That includes paths that are only different in variable names (e.g. <l>"/foo/{bar}"</l> and <l>"/foo/{baz}"</l>).
+ <li>
+ If no methods are found with a matching matcher, a <l>412 Precondition Failed</l> status is returned.
+ <li>
+ If multiple matchers are specified on the same method, ONLY ONE matcher needs to match for the
+ method to be invoked.
+ <li>
+ Note that you CANNOT define identical paths on different methods UNLESS you use matchers.
+ <br>That includes paths that are only different in variable names (e.g. <l>"/foo/{bar}"</l> and
+ <l>"/foo/{baz}"</l>).
<br>If you try to do so, a <l>ServletException</l> will be thrown on startup.
- <li>Methods with matchers take precedence over methods without.
+ <li>
+ Methods with matchers take precedence over methods without.
<br>Otherwise, methods are attempted in the order they appear in the class.
</ul>
- </div>
+ </div>
</div>
<!-- ======================================================================================================== -->
@@ -874,8 +960,8 @@
</p>
<p>
The HTTP body of a request can be retrieved as a parsed POJO using either the
- {@link org.apache.juneau.rest.RestRequest#getBody()} method, or a parameter
- annotated with {@link org.apache.juneau.rest.annotation.Body @Body}.
+ {@link org.apache.juneau.rest.RestRequest#getBody()} method, or a parameter annotated with
+ {@link org.apache.juneau.rest.annotation.Body @Body}.
</p>
<p class='bcode'>
<jc>// Equivalent method 1</jc>
@@ -893,23 +979,24 @@
</p>
<p>
The Juneau framework will automatically determine the appropriate <l>Parser</l> to use based on the
- <l>Content-Type</l> HTTP header. So the body content could be JSON or XML or any other supported parsing types.
+ <l>Content-Type</l> HTTP header.
+ So the body content could be JSON or XML or any other supported parsing types.
</p>
- <!-- ======================================================================================================== -->
+ <!-- ======================================================================================================== -->
<a id="RestResources.RequestContent.FormPosts"></a>
<h4 class='topic' onclick='toggle(this)'>4.2.1 - Form Posts</h4>
- <div class='topic'>
- <p>
+ <div class='topic'>
+ <p>
URL-Encoded form posts require their own topic since they can be handled in multiple ways.
</p>
<p>
The best way to handle a form post is by using an input bean.
- The samples include a <l>UrlEncodedFormResource</l> class that takes in URL-Encoded
- form post of the form <l>"aString=foo&aNumber=123&aDate=2001-07-04T15:30:45Z"</l>.
+ The samples include a <l>UrlEncodedFormResource</l> class that takes in URL-Encoded form post of the
+ form <l>"aString=foo&aNumber=123&aDate=2001-07-04T15:30:45Z"</l>.
The code is shown here:
- </p>
- <p class='bcode'>
+ </p>
+ <p class='bcode'>
<ja>@RestResource</ja>(
path=<js>"/urlEncodedForm"</js>
)
@@ -929,8 +1016,8 @@
<jk>public</jk> Calendar <jf>aDate</jf>;
}
}
- </p>
- <p>
+ </p>
+ <p>
Another possibility is to access the form parameters individually:
</p>
<p class='bcode'>
@@ -942,14 +1029,15 @@
</p>
<p>
The advantage to the form input bean is that it can handle any of the parsable types (e.g. JSON, XML...)
- in addition to URL-Encoding. The latter approach only supports URL-Encoding.
+ in addition to URL-Encoding. The latter approach only supports URL-Encoding.
</p>
<ul class='doctree'>
- <li class='severe'>If you're using form input beans, DO NOT use the <l>@FormData</l> attribute
- or {@link org.apache.juneau.rest.RestRequest#getParameter(String)} method since this will
- cause the underlying JEE servlet to parse the HTTP body as a form post.
- <br>Your input bean will end up being null since there won't be any content left
- after the servlet has parsed the body of the request.
+ <li class='severe'>
+ If you're using form input beans, DO NOT use the <l>@FormData</l> attribute or
+ {@link org.apache.juneau.rest.RestRequest#getParameter(String)} method since this will cause the
+ underlying JEE servlet to parse the HTTP body as a form post.
+ <br>Your input bean will end up being null since there won't be any content left after the servlet
+ has parsed the body of the request.
<br>This applies to WHENEVER you use <l>@Body</l> or {@link org.apache.juneau.rest.RestRequest#getBody()}
</ul>
</div>
@@ -958,13 +1046,13 @@
<a id="RestResources.RequestContent"></a>
<h4 class='topic' onclick='toggle(this)'>4.2.2 - Multipart Form Posts</h4>
<div class='topic'>
- <p>
+ <p>
The Juneau framework does not natively support multipart form posts.
- However, it can be used in conjunction wih the Apache Commons File Upload library to do so.
- </p>
- <p>
- The samples include a <l>TempDirResource</l> class that uses the File Upload library
- to allow files to be uploaded as multipart form posts.
+ However, it can be used in conjunction with the Apache Commons File Upload library to do so.
+ </p>
+ <p>
+ The samples include a <l>TempDirResource</l> class that uses the File Upload library to allow files to
+ be uploaded as multipart form posts.
</p>
<p class='bcode'>
<ja>@RestResource</ja>(
@@ -998,7 +1086,7 @@
<jk>return</jk> contentType != <jk>null</jk> && contentType.startsWith(<js>"multipart/form-data"</js>);
}
}
- </p>
+ </p>
</div>
</div>
@@ -1010,11 +1098,15 @@
REST Java methods can generate output in any of the following ways:
</p>
<ul class='spaced-list'>
- <li>By returning a serializable POJO, or any of the following:
- <br>{@link java.io.Reader}, {@link java.io.InputStream}, {@link org.apache.juneau.Streamable}, {@link org.apache.juneau.Writable}
- <li>By calling {@link org.apache.juneau.rest.RestResponse#setOutput(Object)} with any of the types above.
- <li>By accessing the {@link java.io.Writer} directly by calling {@link org.apache.juneau.rest.RestResponse#getNegotiatedWriter()} and writing the output
- yourself.
+ <li>
+ By returning a serializable POJO, or any of the following:
+ <br>{@link java.io.Reader}, {@link java.io.InputStream}, {@link org.apache.juneau.Streamable},
+ {@link org.apache.juneau.Writable}
+ <li>
+ By calling {@link org.apache.juneau.rest.RestResponse#setOutput(Object)} with any of the types above.
+ <li>
+ By accessing the {@link java.io.Writer} directly by calling
+ {@link org.apache.juneau.rest.RestResponse#getNegotiatedWriter()} and writing the output yourself.
</ul>
<p class='bcode'>
<jc>// Equivalent method 1</jc>
@@ -1049,21 +1141,27 @@
<h3 class='topic' onclick='toggle(this)'>4.4 - OPTIONS Pages</h3>
<div class='topic'>
<p>
- One of the most useful features of Juneau is that it can produce OPTIONS pages for self-documenting designs (i.e. REST interfaces that document themselves).
+ One of the most useful features of Juneau is that it can produce OPTIONS pages for self-documenting designs
+ (i.e. REST interfaces that document themselves).
</p>
+
<h6 class='figure'>OPTIONS page for HelloWorld sample resource</h6>
<img class='bordered' src='doc-files/HelloWorldResourceOptions.png'>
<p>
- This page is constructed through reflection on the servlet class and it's methods, combined with information provided in the following locations:
+ This page is constructed through reflection on the servlet class and it's methods, combined with
+ information provided in the following locations:
</p>
<ul>
- <li>Annotations (i.e. {@link org.apache.juneau.rest.annotation.RestResource @RestResource} and {@link org.apache.juneau.rest.annotation.RestMethod @RestMethod}).
+ <li>Annotations (i.e. {@link org.apache.juneau.rest.annotation.RestResource @RestResource} and
+ {@link org.apache.juneau.rest.annotation.RestMethod @RestMethod}).
<li>Resource bundle properties.
<li>Swagger JSON files.
</ul>
<p>
- Swagger JSON files are specified with the same name as the servlet (e.g. <code>MyResource.java</code> -> <code>MyResource.json</code>).
- Localized versions of Swagger JSON files can be specified by appending the locale to the file name (e.g. <code>MyResource_ja_JP.json</code>).
+ Swagger JSON files are specified with the same name as the servlet
+ (e.g. <code>MyResource.java</code> -> <code>MyResource.json</code>).
+ Localized versions of Swagger JSON files can be specified by appending the locale to the file name
+ (e.g. <code>MyResource_ja_JP.json</code>).
The existence of Swagger JSON files will override any auto-generation of the OPTIONS pages.
This allows you to fully control the contents of the OPTIONS page with your own Swagger spec.
</p>
@@ -1073,9 +1171,10 @@
</p>
<p>
{@link org.apache.juneau.rest.RestServletDefault} provides a default OPTIONS page by implementing
- a {@link org.apache.juneau.rest.RestServletDefault#getOptions(RestRequest)} method that returns a POJO consisting
- of beans describing the class.
- It uses the {@link org.apache.juneau.rest.RestRequest#getSwagger()} method that returns a localized swagger bean.
+ a {@link org.apache.juneau.rest.RestServletDefault#getOptions(RestRequest)} method that returns a POJO
+ consisting of beans describing the class.
+ It uses the {@link org.apache.juneau.rest.RestRequest#getSwagger()} method that returns a localized swagger
+ bean.
</p>
<p class='bcode'>
<jd>/**
@@ -1094,13 +1193,17 @@
<jk>return</jk> req.getSwagger();
}
</p>
+
<h6 class='topic'>Title and Description</h6>
<p>
The title and description can be defined in the following ways.
</p>
<ul>
- <li>Annotations: {@link org.apache.juneau.rest.annotation.RestResource#title()}, {@link org.apache.juneau.rest.annotation.RestResource#description()}
- <li>By overriding methods on the servlet class: {@link org.apache.juneau.rest.RestInfoProvider#getTitle(RestRequest)}, {@link org.apache.juneau.rest.RestInfoProvider#getDescription(RestRequest)}
+ <li>Annotations: {@link org.apache.juneau.rest.annotation.RestResource#title()},
+ {@link org.apache.juneau.rest.annotation.RestResource#description()}
+ <li>By overriding methods on the servlet class:
+ {@link org.apache.juneau.rest.RestInfoProvider#getTitle(RestRequest)},
+ {@link org.apache.juneau.rest.RestInfoProvider#getDescription(RestRequest)}
<li>By defining properties in the resource bundle.
<li>By specifying them in a Swagger JSON file.
</ul>
@@ -1117,9 +1220,8 @@
</p>
<p>
The second approach which supports internationalization is to use the
- {@link org.apache.juneau.rest.annotation.RestResource#messages() @RestResource.messages()}
- annotation to point to a resource bundle, and then use predefined properties
- that identify the label and description.
+ {@link org.apache.juneau.rest.annotation.RestResource#messages() @RestResource.messages()} annotation to
+ point to a resource bundle, and then use predefined properties that identify the label and description.
</p>
<p class='bcode'>
<ja>@RestResource</ja>(
@@ -1138,7 +1240,8 @@
<ck>description</ck> = <cv>This shows how to use labels and descriptions.</cv>
</p>
<p>
- Message keys can optionally be prefixed by the short class name if the resource bundle is shared by multiple servlets:
+ Message keys can optionally be prefixed by the short class name if the resource bundle is shared by
+ multiple servlets:
</p>
<p class='bcode'>
<cc>#--------------------------------------------------------------------------------
@@ -1154,12 +1257,16 @@
The localized label and description are also available through the following methods:
</p>
<ul class='doctree'>
- <li class='jm'>{@link org.apache.juneau.rest.RestRequest#getServletTitle()}
- <li class='jm'>{@link org.apache.juneau.rest.RestRequest#getServletDescription()}
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestRequest#getServletTitle()}
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestRequest#getServletDescription()}
</ul>
<p>
- They are also made available as the request string variables <js>"$R{servletTitle}"</js> and <js>"$R{servletDescription}"</js>.
- These variable facilitate the localized label and descriptions on the HTML pages when using {@link org.apache.juneau.rest.RestServletDefault}:
+ They are also made available as the request string variables <js>"$R{servletTitle}"</js> and
+ <js>"$R{servletDescription}"</js>.
+ These variable facilitate the localized label and descriptions on the HTML pages when using
+ {@link org.apache.juneau.rest.RestServletDefault}:
</p>
<p class='bcode'>
<ja>@RestResource</ja>(
@@ -1170,7 +1277,8 @@
</p>
<p>
The title and description annotations support string variables.
- So in theory, you could also provide localized messages using <js>"$L"</js> variables pointing to your own resource bundle properties:
+ So in theory, you could also provide localized messages using <js>"$L"</js> variables pointing to your own
+ resource bundle properties:
</p>
<p class='bcode'>
<ja>@RestResource</ja>(
@@ -1183,13 +1291,14 @@
</p>
<p>
Another option is to override the {@link org.apache.juneau.rest.RestInfoProvider#getTitle(RestRequest)}
- and {@link org.apache.juneau.rest.RestInfoProvider#getDescription(RestRequest)} methods.
- </p>
+ and {@link org.apache.juneau.rest.RestInfoProvider#getDescription(RestRequest)} methods.
+ </p>
+
<h6 class='topic'>Method Description, Input, and Responses</h6>
<p>
The <l>methods</l> field in the OPTIONS page is mostly populated through reflection.
- However, the description, input, and responses field can be specified through either
- annotations or resource properties.
+ However, the description, input, and responses field can be specified through either annotations or
+ resource properties.
</p>
<p>
For example, the <l>AddressBookResource</l> has a <l>getPerson()</l> method
@@ -1197,9 +1306,10 @@
</p>
<img class='bordered' src='doc-files/Options2.png'>
<p>
- This method is described through the {@link org.apache.juneau.rest.annotation.RestMethod#description() @RestMethod.description()},
- {@link org.apache.juneau.rest.annotation.RestMethod#swagger() @RestMethod.swagger()},
- and {@link org.apache.juneau.rest.annotation.MethodSwagger @MethodSwagger} annotations.
+ This method is described through the
+ {@link org.apache.juneau.rest.annotation.RestMethod#description() @RestMethod.description()},
+ {@link org.apache.juneau.rest.annotation.RestMethod#swagger() @RestMethod.swagger()},
+ and {@link org.apache.juneau.rest.annotation.MethodSwagger @MethodSwagger} annotations.
</p>
<p class='bcode'>
<ja>@RestMethod</ja>(
@@ -1311,11 +1421,15 @@
<td>{@link org.apache.juneau.rest.annotation.MethodSwagger#responses() @MethodSwagger.responses()}</td>
</tr>
</table>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#description() @RestMethod.description()}
- <li class='ja'>{@link org.apache.juneau.rest.annotation.MethodSwagger#parameters() @MethodSwagger.parameters()}
- <li class='ja'>{@link org.apache.juneau.rest.annotation.MethodSwagger#responses() @MethodSwagger.responses()}
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.RestMethod#description() @RestMethod.description()}
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.MethodSwagger#parameters() @MethodSwagger.parameters()}
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.MethodSwagger#responses() @MethodSwagger.responses()}
</ul>
</div>
@@ -1324,20 +1438,27 @@
<h3 class='topic' onclick='toggle(this)'>4.5 - Serializers</h3>
<div class='topic'>
<p>
- REST servlets use the {@link org.apache.juneau.serializer.Serializer} API for defining serializers for serializing response POJOs.
+ REST servlets use the {@link org.apache.juneau.serializer.Serializer} API for defining serializers for
+ serializing response POJOs.
</p>
<p>
The servlet will pick which serializer to use by matching the request <l>Accept</l> header with the
- media types defined through the {@link org.apache.juneau.serializer.Serializer#getMediaTypes()} method
- (which itself usually comes from the {@link org.apache.juneau.annotation.Produces @Produces} annotation).
+ media types defined through the {@link org.apache.juneau.serializer.Serializer#getMediaTypes()} method
+ (which itself usually comes from the {@link org.apache.juneau.annotation.Produces @Produces} annotation).
</p>
<p>
Serializers can be associated with REST servlets in the following ways:
</p>
<ul class='doctree'>
- <li class='ja'>{@link org.apache.juneau.rest.annotation.RestResource#serializers() @RestResource.serializers()} - Annotation on servlet class.
- <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#serializers() @RestMethod.serializers()} - Annotation on individual servlet methods.
- <li class='jm'>{@link org.apache.juneau.rest.RestConfig#addSerializers(Class[])} - Override method to set the serializers programmatically.
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.RestResource#serializers() @RestResource.serializers()}
+ - Annotation on servlet class.
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.RestMethod#serializers() @RestMethod.serializers()}
+ - Annotation on individual servlet methods.
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestConfig#addSerializers(Class[])}
+ - Override method to set the serializers programmatically.
</ul>
<p>
The following are equivalent ways of defining serializers used by a servlet...
@@ -1369,13 +1490,15 @@
</p>
<ul class='doctree'>
<li class='info'>
- When debugging the output from REST servlets, it's almost always easier to bypass the REST servlet and try to serialize
- the POJOs using the serializers directly using the {@link org.apache.juneau.serializer.WriterSerializer#toString(Object)} method.
+ When debugging the output from REST servlets, it's almost always easier to bypass the REST servlet and
+ try to serialize the POJOs using the serializers directly using the
+ {@link org.apache.juneau.serializer.WriterSerializer#toString(Object)} method.
</ul>
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#serializersInherit() @RestMethod.serializersInherit()}
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.RestMethod#serializersInherit() @RestMethod.serializersInherit()}
<br>Controls how serializers are inherited from the servlet class.
</ul>
</div>
@@ -1385,20 +1508,27 @@
<h3 class='topic' onclick='toggle(this)'>4.6 - Parsers</h3>
<div class='topic'>
<p>
- REST servlets use the {@link org.apache.juneau.parser.Parser} API for defining parsers for parsing request body content and converting them into POJOs.
+ REST servlets use the {@link org.apache.juneau.parser.Parser} API for defining parsers for parsing request
+ body content and converting them into POJOs.
</p>
<p>
The servlet will pick which parser to use by matching the request <l>Content-Type</l> header with the
- media types defined through the {@link org.apache.juneau.parser.Parser#getMediaTypes()} method (which itself
- usually comes from the {@link org.apache.juneau.annotation.Consumes @Consumes} annotation).
+ media types defined through the {@link org.apache.juneau.parser.Parser#getMediaTypes()} method (which itself
+ usually comes from the {@link org.apache.juneau.annotation.Consumes @Consumes} annotation).
</p>
<p>
Parsers can be associated with REST servlets in the following ways:
</p>
<ul class='doctree'>
- <li class='ja'>{@link org.apache.juneau.rest.annotation.RestResource#parsers() @RestResource.parsers()} - Annotation on servlet class.
- <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#parsers() @RestMethod.parsers()} - Annotation on individual servlet methods.
- <li class='jm'>{@link org.apache.juneau.rest.RestConfig#addParsers(Class[])} - Override method to set the parsers programmatically.
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.RestResource#parsers() @RestResource.parsers()}
+ - Annotation on servlet class.
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.RestMethod#parsers() @RestMethod.parsers()}
+ - Annotation on individual servlet methods.
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestConfig#addParsers(Class[])}
+ - Override method to set the parsers programmatically.
</ul>
<p>
The following are equivalent ways of defining parsers used by a servlet...
@@ -1428,9 +1558,11 @@
.append(JsonParser.<jk>class</jk>, XmlParser.<jk>class</jk>);
}
</p>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#parsersInherit() @RestMethod.parsersInherit()}
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.RestMethod#parsersInherit() @RestMethod.parsersInherit()}
<br>Controls how parsers are inherited from the servlet class.
</ul>
</div>
@@ -1445,13 +1577,14 @@
</p>
<p>
There are several ways of defining properties in the REST API.
- The most common way is going to be through the {@link org.apache.juneau.rest.annotation.RestResource#properties() @RestResource.properties()}
+ The most common way is going to be through the
+ {@link org.apache.juneau.rest.annotation.RestResource#properties() @RestResource.properties()}
and {@link org.apache.juneau.rest.annotation.RestMethod#properties() @RestMethod.properties()} annotations.
</p>
<p>
- The {@link org.apache.juneau.rest.annotation.RestResource#properties() @RestResource.properties()} annotation
- can be used as a convenient way to set various serializer and parser
- properties to all serializers and parsers registered with the servlet.
+ The {@link org.apache.juneau.rest.annotation.RestResource#properties() @RestResource.properties()}
+ annotation can be used as a convenient way to set various serializer and parser properties to all
+ serializers and parsers registered with the servlet.
</p>
<p class='bcode'>
<jk>import static</jk> org.apache.juneau.SerializerContext.*;
@@ -1482,7 +1615,8 @@
</p>
<p>
The {@link org.apache.juneau.rest.annotation.RestMethod#properties() @RestMethod.properties()} annotation
- can be used to define method-level properties that can alter the behavior of serializers and parsers at the method level only.
+ can be used to define method-level properties that can alter the behavior of serializers and parsers at the
+ method level only.
</p>
<p class='bcode'>
<jc>// GET method with method-level properties</jc>
@@ -1508,26 +1642,32 @@
}
</p>
<p>
- In particular, the {@link org.apache.juneau.rest.RestContext} class has a variety of properties
- for controlling the behavior of the {@link org.apache.juneau.rest.RestServlet} class itself.
+ In particular, the {@link org.apache.juneau.rest.RestContext} class has a variety of properties for
+ controlling the behavior of the {@link org.apache.juneau.rest.RestServlet} class itself.
</p>
<p>
There are also ways to provide properties programmatically.
</p>
<ul class='spaced-list'>
- <li>By overriding the {@link org.apache.juneau.rest.RestConfig#setProperties(Map)} method.
- <li>By overriding the {@link org.apache.juneau.rest.RestConfig#addSerializers(Class[])} and
+ <li>
+ By overriding the {@link org.apache.juneau.rest.RestConfig#setProperties(Map)} method.
+ <li>
+ By overriding the {@link org.apache.juneau.rest.RestConfig#addSerializers(Class[])} and
{@link org.apache.juneau.rest.RestConfig#addParsers(Class[])} methods and setting properties on the
serializers and parsers directly.
</ul>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jc'>{@link org.apache.juneau.rest.RestContext}
+ <li class='jc'>
+ {@link org.apache.juneau.rest.RestContext}
<br>Properties associated with the {@link org.apache.juneau.rest.RestServlet} class.
- <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#serializersInherit @RestMethod.serializersInherit()}
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.RestMethod#serializersInherit @RestMethod.serializersInherit()}
<br>Controls how serializers inherit properties from the servlet class.
- <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#parsersInherit @RestMethod.parsersInheritInherit()}
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.RestMethod#parsersInherit @RestMethod.parsersInheritInherit()}
<br>Controls how parsers inherit properties from the servlet class.
</ul>
</div>
@@ -1568,24 +1708,30 @@
</p>
<p>
{@link org.apache.juneau.rest.annotation.RestMethod#beanFilters() @RestMethod.beanFilters()} and
- {@link org.apache.juneau.rest.annotation.RestMethod#pojoSwaps() @RestMethod.pojoSwaps()}
- are the equivalent annotations for individual Java methods.
+ {@link org.apache.juneau.rest.annotation.RestMethod#pojoSwaps() @RestMethod.pojoSwaps()}
+ are the equivalent annotations for individual Java methods.
</p>
<p>
Transforms can also be defined programmatically through the following:
</p>
<ul class='spaced-list'>
- <li>By overriding the {@link org.apache.juneau.rest.RestConfig#addBeanFilters(Class[])} and {@link org.apache.juneau.rest.RestConfig#addPojoSwaps(Class[])} methods.
- <li>By overriding the {@link org.apache.juneau.rest.RestConfig#addSerializers(Class[])} and
+ <li>
+ By overriding the {@link org.apache.juneau.rest.RestConfig#addBeanFilters(Class[])} and
+ {@link org.apache.juneau.rest.RestConfig#addPojoSwaps(Class[])} methods.
+ <li>
+ By overriding the {@link org.apache.juneau.rest.RestConfig#addSerializers(Class[])} and
{@link org.apache.juneau.rest.RestConfig#addParsers(Class[])} methods and setting transforms on the
serializers and parsers directly.
</ul>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#serializersInherit @RestMethod.serializersInherit()}
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.RestMethod#serializersInherit @RestMethod.serializersInherit()}
<br>Controls how serializers inherit transforms (bean filters and POJO swaps) from the servlet class.
- <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#parsersInherit @RestMethod.parsersInherit()}
+ <li class='ja'>
+ {@link org.apache.juneau.rest.annotation.RestMethod#parsersInherit @RestMethod.parsersInherit()}
<br>Controls how parsers inherit transforms from the servlet class.
</ul>
</div>
@@ -1599,7 +1745,8 @@
</p>
<p>
The {@link org.apache.juneau.rest.annotation.RestResource#guards @RestResource.guards()} annotation
- can be used to associate one or more class-level {@link org.apache.juneau.rest.RestGuard RestGuards} with a servlet.
+ can be used to associate one or more class-level {@link org.apache.juneau.rest.RestGuard RestGuards} with a
+ servlet.
</p>
<p class='bcode'>
<jc>// Servlet with class-level guard applied</jc>
@@ -1638,18 +1785,23 @@
</p>
<p>
A guard failure results in an <l>HTTP 401 Unauthorized</l> response.
- However, this can be configured by overriding the {@link org.apache.juneau.rest.RestGuard#guard(RestRequest,RestResponse)}
- and processing the response yourself.
+ However, this can be configured by overriding the
+ {@link org.apache.juneau.rest.RestGuard#guard(RestRequest,RestResponse)} and processing the response
+ yourself.
</p>
<p>
- When guards are associated at the class-level, it's equivalent to associating guards on all Java methods on the servlet.
+ When guards are associated at the class-level, it's equivalent to associating guards on all Java methods on
+ the servlet.
</p>
<p>
- Class-level guards can also be created programmatically by overriding the {@link org.apache.juneau.rest.RestConfig#addGuards(Class[])} method.
+ Class-level guards can also be created programmatically by overriding the
+ {@link org.apache.juneau.rest.RestConfig#addGuards(Class[])} method.
</p>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jac'>{@link org.apache.juneau.rest.RestGuard}
+ <li class='jac'>
+ {@link org.apache.juneau.rest.RestGuard}
</ul>
</div>
@@ -1662,8 +1814,8 @@
</p>
<p>
The {@link org.apache.juneau.rest.annotation.RestResource#converters @RestResource.converters()} annotation
- can be used as a convenient way to add {@link org.apache.juneau.rest.RestConverter RestConverters} to
- all Java REST methods on a servlet.
+ can be used as a convenient way to add {@link org.apache.juneau.rest.RestConverter RestConverters} to
+ all Java REST methods on a servlet.
</p>
<p class='bcode'>
<jc>// Associate the Traversable converter to all Java REST methods in this servlet</jc>
@@ -1674,7 +1826,7 @@
</p>
<p>
The {@link org.apache.juneau.rest.annotation.RestMethod#converters() @RestMethod.converters()} annotation
- can be used to associate converters on individual methods.
+ can be used to associate converters on individual methods.
</p>
<p class='bcode'>
<jc>// GET person request handler.</jc>
@@ -1689,10 +1841,12 @@
}
</p>
<p>
- The following converter is used to provide support for addressing child nodes in a POJO tree with
- URL path remainders.
- <br>In this code, the 3rd parameter is the object that was returned by the Java method (or set through <l>request.setObject(o);</l>).
- <br>The converter uses the {@link org.apache.juneau.utils.PojoRest} wrapper class to address nodes in the tree.
+ The following converter is used to provide support for addressing child nodes in a POJO tree with URL path
+ remainders.
+ <br>In this code, the 3rd parameter is the object that was returned by the Java method (or set through
+ <l>request.setObject(o);</l>).
+ <br>The converter uses the {@link org.apache.juneau.utils.PojoRest} wrapper class to address nodes in the
+ tree.
</p>
<p class='bcode'>
<jd>/**
@@ -1725,18 +1879,26 @@
Juneau defines the following converters out-of-the-box:
</p>
<ul class='doctree'>
- <li class='jic'>{@link org.apache.juneau.rest.RestConverter}
+ <li class='jic'>
+ {@link org.apache.juneau.rest.RestConverter}
<ul>
- <li class='jc'>{@link org.apache.juneau.rest.converters.Queryable}
- <br>Provides query parameters that can be used to transform the response (i.e. search/view/sort the POJO response before being serialized).
- <li class='jc'>{@link org.apache.juneau.rest.converters.Traversable}
- <br>Allows nodes in the POJO response tree to be individually accessed through additional path info on the request.
- <li class='jc'>{@link org.apache.juneau.rest.converters.Introspectable}
- <br>Allows method calls to be made on the response POJO, and for the result of that method call to be serialized as the response.
+ <li class='jc'>
+ {@link org.apache.juneau.rest.converters.Queryable}
+ <br>Provides query parameters that can be used to transform the response (i.e. search/view/sort the
+ POJO response before being serialized).
+ <li class='jc'>
+ {@link org.apache.juneau.rest.converters.Traversable}
+ <br>Allows nodes in the POJO response tree to be individually accessed through additional path info on
+ the request.
+ <li class='jc'>
+ {@link org.apache.juneau.rest.converters.Introspectable}
+ <br>Allows method calls to be made on the response POJO, and for the result of that method call to be
+ serialized as the response.
</ul>
</ul>
<p>
- Class-level converters can be created programmatically by overriding the {@link org.apache.juneau.rest.RestConfig#addConverters(Class[])} method.
+ Class-level converters can be created programmatically by overriding the
+ {@link org.apache.juneau.rest.RestConfig#addConverters(Class[])} method.
</p>
<p>
Note that from the example above, you can specify more than one converter.
@@ -1744,9 +1906,11 @@
(e.g. first the results will be traversed, then the resulting node will be searched/sorted).
</p>
+
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jic'>{@link org.apache.juneau.rest.RestConverter}
+ <li class='jic'>
+ {@link org.apache.juneau.rest.RestConverter}
</ul>
</div>
@@ -1756,7 +1920,7 @@
<div class='topic'>
<p>
Child Resources are REST servlets that are linked to parent servlets through the
- {@link org.apache.juneau.rest.annotation.RestResource#children() @RestResource.children()} annnotation.
+ {@link org.apache.juneau.rest.annotation.RestResource#children() @RestResource.children()} annotation.
</p>
<p class='bcode'>
<jd>/** Parent Resource */</jd>
@@ -1776,7 +1940,8 @@
...
</p>
<p>
- A HUGE advantage of using child resources is that they do not need to be declared in the JEE <l>web.xml</l> file.
+ A HUGE advantage of using child resources is that they do not need to be declared in the JEE <l>web.xml</l>
+ file.
Initialization of and access to the child resources occurs through the parent resource.
Children can be nested arbitrary deep to create complex REST interfaces with a single top-level REST servlet.
</p>
@@ -1786,7 +1951,7 @@
</p>
<p>
The {@link org.apache.juneau.rest.RestServletGroupDefault} class provides a default "router" page for
- child resources when a parent resource is nothing more than a grouping of child resources.
+ child resources when a parent resource is nothing more than a grouping of child resources.
</p>
<p>
The <l>RootResources</l> class in the Samples project is an example of a router page:
@@ -1828,10 +1993,9 @@
<img class='bordered' src="doc-files/Samples_RootResources.png"/>
<p>
The <l>RestServletGroupDefault</l> class is nothing more than a subclass of
- {@link org.apache.juneau.rest.RestServletDefault} with a <l>getChildren()</l>
- method mapped to the servlet root path.
- The method returns a POJO with is just a linked-list of beans with name/description
- properties.
+ {@link org.apache.juneau.rest.RestServletDefault} with a <l>getChildren()</l> method mapped to the servlet
+ root path.
+ The method returns a POJO with is just a linked-list of beans with name/description properties.
</p>
<p class='bcode'>
<jk>public class</jk> RestServletGroupDefault <jk>extends</jk> RestServletDefault {
@@ -1852,11 +2016,15 @@
Children can also be defined programmatically by overriding any of the following methods:
</p>
<ul class='doctree'>
- <li class='jac'>{@link org.apache.juneau.rest.RestConfig}
+ <li class='jac'>
+ {@link org.apache.juneau.rest.RestConfig}
<ul>
- <li class='jm'>{@link org.apache.juneau.rest.RestConfig#addChildResource(String,Object)}
- <li class='jm'>{@link org.apache.juneau.rest.RestConfig#addChildResources(Class[])}
- <li class='jm'>{@link org.apache.juneau.rest.RestConfig#addChildResources(Object[])}
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestConfig#addChildResource(String,Object)}
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestConfig#addChildResources(Class[])}
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestConfig#addChildResources(Object[])}
</ul>
</ul>
</div>
@@ -1866,7 +2034,8 @@
<h3 class='topic' onclick='toggle(this)'>4.12 - Localized Messages</h3>
<div class='topic'>
<p>
- The {@link org.apache.juneau.rest.annotation.RestResource#messages @RestResource.messages()} annotation can be used to associate a resource bundle with a servlet class.
+ The {@link org.apache.juneau.rest.annotation.RestResource#messages @RestResource.messages()} annotation can
+ be used to associate a resource bundle with a servlet class.
</p>
<p class='bcode'>
<jc>// Servlet with associated resource bundle</jc>
@@ -1880,7 +2049,8 @@
}
</p>
<p>
- The resource bundle can also be passed into the method by using the {@link org.apache.juneau.rest.annotation.Messages @Messages} annotation:
+ The resource bundle can also be passed into the method by using the
+ {@link org.apache.juneau.rest.annotation.Messages @Messages} annotation:
</p>
<p class='bcode'>
<ja>@RestMethod</ja>(name=<js>"GET"</js>)
@@ -1889,7 +2059,8 @@
}
</p>
<p>
- If a resource bundle is shared by multiple servlets, the label and description can be prefixed by the class name:
+ If a resource bundle is shared by multiple servlets, the label and description can be prefixed by the class
+ name:
</p>
<p class='bcode'>
<cc>#--------------------------------------------------------------------------------
@@ -1910,10 +2081,12 @@
<h3 class='topic' onclick='toggle(this)'>4.13- Encoders</h3>
<div class='topic'>
<p>
- The {@link org.apache.juneau.rest.annotation.RestResource#encoders @RestResource.encoders()} annotation can be used to associate character encoders with a servlet class.
- Encoders can be used to enable various kinds of compression (e.g. <l>"gzip"</l>) on requests and responses based on the request <l>Accept-Encoding</l>
- and <l>Content-Encoding</l> headers.
+ The {@link org.apache.juneau.rest.annotation.RestResource#encoders @RestResource.encoders()} annotation can
+ be used to associate character encoders with a servlet class.
+ Encoders can be used to enable various kinds of compression (e.g. <l>"gzip"</l>) on requests and responses
+ based on the request <l>Accept-Encoding</l> and <l>Content-Encoding</l> headers.
</p>
+
<h6 class='figure'>Example:</h6>
<p class='bcode'>
<jc>// Servlet with automated support for GZIP compression</jc>
@@ -1926,10 +2099,13 @@
Juneau defines the following encoders out-of-the-box:
</p>
<ul class='doctree'>
- <li class='jac'>{@link org.apache.juneau.encoders.Encoder}
+ <li class='jac'>
+ {@link org.apache.juneau.encoders.Encoder}
<ul>
- <li class='jc'>{@link org.apache.juneau.encoders.GzipEncoder}
- <li class='jc'>{@link org.apache.juneau.encoders.IdentityEncoder}
+ <li class='jc'>
+ {@link org.apache.juneau.encoders.GzipEncoder}
+ <li class='jc'>
+ {@link org.apache.juneau.encoders.IdentityEncoder}
</ul>
</ul>
</div>
@@ -1940,7 +2116,7 @@
<div class='topic'>
<p>
In the previous examples, there were several cases where embedded variables were contained within
- annotation values:
+ annotation values:
</p>
<p class='bcode'>
<ja>@RestResource</ja>(
@@ -1955,16 +2131,20 @@
Features include:
</p>
<ul class='spaced-list'>
- <li>Variables can be nested arbitrarily deep (e.g. <l>"$X{$Y{foo}}"</l>).
- <li>Variables can contain arguments (e.g. <l>"$L{my.label,arg1,arg2}"</l>).
- <li>Variables are recursively resolved.
- <br>i.e., if a variable results to a value with another variable in it, that
- variable will also be resolved.
+ <li>
+ Variables can be nested arbitrarily deep (e.g. <l>"$X{$Y{foo}}"</l>).
+ <li>
+ Variables can contain arguments (e.g. <l>"$L{my.label,arg1,arg2}"</l>).
+ <li>
+ Variables are recursively resolved.
+ <br>i.e., if a variable results to a value with another variable in it, that variable will also be
+ resolved.
</ul>
<p>
String variables are implemented through the {@link org.apache.juneau.svl.VarResolver} class and one or more
- {@link org.apache.juneau.svl.Var Vars}.
+ {@link org.apache.juneau.svl.Var Vars}.
</p>
+
<h6 class='figure'>Example:</h6>
<p class='bcode'>
<jc>// Create a variable that resolves system properties (e.g. "$S{java.home}")</jc>
@@ -1990,21 +2170,26 @@
The methods that define the var resolver on a servlet are:
</p>
<ul class='doctree'>
- <li class='jac'>{@link org.apache.juneau.rest.RestServlet}
- <ul>
- <li class='jm'>{@link org.apache.juneau.rest.RestContext#getVarResolver()}
- <br>Returns the <l>VarResolver</l> associated with a servlet.
- <li class='jm'>{@link org.apache.juneau.rest.RestConfig#addVars(Class[])}
- <br>The method used to create the servlet <l>VarResolver</l>.
- <br>Subclasses can override this method to provide their own resolver.
- <li class='jm'>{@link org.apache.juneau.rest.RestCallHandler#getSessionObjects(RestRequest)}
- <br>Defines the session objects for the var resolver.
- <br>Subclasses can override this method to provide additional session objects.
- </ul>
+ <li class='jac'>
+ {@link org.apache.juneau.rest.RestServlet}
+ <ul>
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestContext#getVarResolver()}
+ <br>Returns the <l>VarResolver</l> associated with a servlet.
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestConfig#addVars(Class[])}
+ <br>The method used to create the servlet <l>VarResolver</l>.
+ <br>Subclasses can override this method to provide their own resolver.
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestCallHandler#getSessionObjects(RestRequest)}
+ <br>Defines the session objects for the var resolver.
+ <br>Subclasses can override this method to provide additional session objects.
+ </ul>
+ </li>
</ul>
<p>
- The default {@link org.apache.juneau.rest.RestContext#getVarResolver()} method provides
- support the following string variable types:
+ The default {@link org.apache.juneau.rest.RestContext#getVarResolver()} method provides support the
+ following string variable types:
</p>
<table class='styled'>
<tr>
@@ -2039,6 +2224,7 @@
<p>
Subclasses can augment this list by adding their own variables.
</p>
+
<h6 class='figure'>Example:</h6>
<p class='bcode'>
<ja>@Override</ja> <jc>/* RestServlet */</jc>
@@ -2079,14 +2265,16 @@
</tr>
<tr>
<td><ck>$L{key}</ck><br><ck>$L{key,args...}</ck></td>
- <td>Localized strings pulled from resource bundle.
+ <td>
+ Localized strings pulled from resource bundle.
<br>Resolves to the value returned by {@link org.apache.juneau.rest.RestRequest#getMessage(String, Object...)}.
<br>Can include message arguments (e.g. <l>"$L{my.localized.string, foo, bar}"</l>)
</td>
</tr>
<tr>
<td><ck>$R{key}</ck></td>
- <td>Request-specific variables.
+ <td>
+ Request-specific variables.
<br>Possible values:
<ul>
<li><ck>$R{attribute.X}</ck> - Value returned by {@link org.apache.juneau.rest.RestRequest#getAttribute(String)} converted to a string.
@@ -2111,24 +2299,27 @@
</tr>
<tr>
<td><ck>$UE{...}</ck></td>
- <td>URL-Encode the specified value.
- <br>Takes the contents inside the varible and replaces it with a URL-encoded string.
+ <td>
+ URL-Encode the specified value.
+ <br>Takes the contents inside the variable and replaces it with a URL-encoded string.
</td>
</tr>
</table>
<p>
- In addition to being used in annotation values, string variables can also be embedded in resource files retrieved
- through the {@link org.apache.juneau.rest.RestRequest#getReaderResource(String,boolean)} method.
+ In addition to being used in annotation values, string variables can also be embedded in resource files
+ retrieved through the {@link org.apache.juneau.rest.RestRequest#getReaderResource(String,boolean)} method.
This can often be useful for embedding localized strings inside HTML form pages.
</p>
<p>
The <l>UrlEncodedFormResource</l> class in the Samples shows an example of using an HTML form page with
- localized variables. When you bring it up in a browser, you see the following:
+ localized variables.
+ When you bring it up in a browser, you see the following:
</p>
<img class='bordered' src='doc-files/UrlEncodedForm.png'>
<p>
This HTML page is a static file located in the <l>org.apache.juneau.rest.samples</l> package.
</p>
+
<h6 class='figure'>Contents of org/apache/juneau/server/samples/UrlEncodedForm.html</h6>
<p class='bcode'>
<xt><html></xt>
@@ -2164,6 +2355,7 @@
<xt></body></xt>
<xt></html></xt>
</p>
+
<h6 class='figure'>Contents of UrlEncodedFormResource.java</h6>
<p class='bcode'>
<jd>/**
@@ -2202,6 +2394,7 @@
}
}
</p>
+
<h6 class='figure'>Contents of UrlEncodedFormResource.properties</h6>
<p class='bcode'>
<cc>#--------------------------------------------------------------------------------
@@ -2217,9 +2410,12 @@
<h6 class='topic'>Additional Information</h6>
<ul class='doctree'>
- <li class='jc'>{@link org.apache.juneau.rest.ReaderResource}
- <li class='jm'>{@link org.apache.juneau.rest.RestRequest#getReaderResource(String,boolean)}
- <li class='jp'><a class='doclink' href='../svl/package-summary.html#TOC'>org.apache.juneau.svl</a>
+ <li class='jc'>
+ {@link org.apache.juneau.rest.ReaderResource}
+ <li class='jm'>
+ {@link org.apache.juneau.rest.RestRequest#getReaderResource(String,boolean)}
+ <li class='jp'>
+ <a class='doclink' href='../svl/package-summary.html#TOC'>org.apache.juneau.svl</a>
</ul>
</div>
@@ -2228,12 +2424,15 @@
<h3 class='topic' onclick='toggle(this)'>4.15 - Static Files</h3>
<div class='topic'>
<p>
- The {@link org.apache.juneau.rest.annotation.RestResource#staticFiles @RestResource.staticFiles()} annotation
- is used to define paths and locations of statically-served files such as images or HTML documents.
+ The {@link org.apache.juneau.rest.annotation.RestResource#staticFiles @RestResource.staticFiles()}
+ annotation is used to define paths and locations of statically-served files such as images or HTML
+ documents.
</p>
<p>
- The value is a JSON map of paths to packages/directories located on either the classpath or working directory.
+ The value is a JSON map of paths to packages/directories located on either the classpath or working
+ directory.
</p>
+
<h6 class='figure'>Example:</h6>
<p class='bcode'>
<jk>package</jk> com.foo.mypackage;
@@ -2250,18 +2449,24 @@
If not found, then an attempt is made to find the class in the Java working directory.
</p>
<p>
- In the example above, given a GET request to <l>/myresource/htdocs/foobar.html</l>, the servlet will attempt to find the <l>foobar.html</l> file
- in the following ordered locations:
+ In the example above, given a GET request to <l>/myresource/htdocs/foobar.html</l>, the servlet will
+ attempt to find the <l>foobar.html</l> file in the following ordered locations:
</p>
<ol>
<li><l>com.foo.mypackage.docs</l> package.
- <li><l>org.apache.juneau.rest.docs</l> package (since <l>RestServletDefault</l> is in <l>org.apache.juneau.rest</l>).
+ <li><l>org.apache.juneau.rest.docs</l> package (since <l>RestServletDefault</l> is in
+ <l>org.apache.juneau.rest</l>).
<li><l>[working-dir]/docs</l> directory.
</ol>
+
<h6 class='topic'>Notes:</h6>
<ul class='spaced-list'>
- <li>Mappings are cumulative from parent to child. Child resources can override mappings made on parent resources.
- <li>The media type on the response is determined by the {@link org.apache.juneau.rest.RestContext#getMediaTypeForName(String)} method.
+ <li>
+ Mappings are cumulative from parent to child. Child resources can override mappings made on parent
+ resources.
+ <li>
+ The media type on the response is determined by the
+ {@link org.apache.juneau.rest.RestContext#getMediaTypeForName(String)} method.
</ul>
</div>
@@ -2270,21 +2475,27 @@
<h3 class='topic' onclick='toggle(this)'>4.16 - Listener Methods</h3>
<div class='topic'>
<p>
- Various convenience listener methods are provided on the {@link org.apache.juneau.rest.RestCallHandler} class
- that subclasses can use to intercept requests:
+ Various convenience listener methods are provided on the {@link org.apache.juneau.rest.RestCallHandler}
+ class that subclasses can use to intercept requests:
</p>
<ul class='doctree'>
- <li class='jac'>{@link org.apache.juneau.rest.RestCallHandler}
- <ul>
- <li class='jm'>{@link org.apache.juneau.rest.RestCallHandler#onPreCall(RestRequest) onPreCall(RestRequest)}
- <br>Callback method that gets invoked right before the REST Java method is invoked.
- <li class='jm'>{@link org.apache.juneau.rest.RestCallHandler#onPostCall(RestRequest,RestResponse) onPostCall(RestRequest,RestResponse)}
- <br>Callback method that gets invoked right after the REST Java method is invoked, but before the serializer is invoked.
- <li class='jm'>{@link org.apache.juneau.rest.RestCallHandler#onSuccess(RestRequest,RestResponse,long) onSuccess(RestRequest,RestResponse,long)}
- <br>Callback method for listening for successful completion of requests.
- <li class='jm'>{@link org.apache.juneau.rest.RestLogger#onError(HttpServletRequest,HttpServletResponse,RestException) onError(HttpServletRequest,HttpServletResponse,RestExce
<TRUNCATED>
[16/19] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java
index 17887c2..7ff0379 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java
@@ -21,15 +21,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/embedded-content-0.html#the-audio-element"><audio></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="audio")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java
index 34cc254..1712bfa 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-b-element"><b></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="b")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java
index c4fecdb..16cf772 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java
@@ -21,15 +21,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/document-metadata.html#the-base-element"><base></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="base")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java
index 085532e..a9c9b06 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-bdi-element"><bdi></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="bdi")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java
index fcea11a..4e21958 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-bdo-element"><bdo></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="bdo")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
index 6f7b8be..57fd433 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-blockquote-element"><blockquote></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="blockquote")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java
index 1f111d5..8fbd2a4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/sections.html#the-body-element"><body></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="body")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java
index e9d0da2..f2c39c9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-br-element"><br></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="br")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java
index 2f7b0eb..fa9a75d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java
@@ -21,15 +21,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/forms.html#the-button-element"><button></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="button")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java
index b3eeb0e..eb95e4a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/scripting-1.html#the-canvas-element"><canvas></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="canvas")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java
index 4dc2ea5..a0da244 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/tabular-data.html#the-caption-element"><caption></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="caption")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java
index 2121e6e..f6a9b77 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-cite-element"><cite></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="cite")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java
index 23a1dd0..3ccccd6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-code-element"><code></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="code")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java
index 87d9476..4858630 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/tabular-data.html#the-col-element"><col></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="col")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
index 636efc2..ef4e220 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/tabular-data.html#the-colgroup-element"><colgroup></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="colgroup")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java
index 8ee1a6b..ae513a7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-data-element"><data></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="data")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java
index 6b7e79a..39e0a9e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/forms.html#the-datalist-element"><datalist></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="datalist")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java
index a06b86c..8d77b46 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-dd-element"><dd></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="dd")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java
index 8f55fd2..8bdfa2d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/edits.html#the-del-element"><del></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="del")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java
index 0ccf42f..3b1fa41 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-dfn-element"><dfn></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="dfn")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java
index 2b2b112..a442af8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-div-element"><div></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="div")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java
index 47c9417..690751e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-dl-element"><dl></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="dl")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java
index 2cda82d..fa4950c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-dt-element"><dt></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="dt")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java
index 46dda70..fb19cc5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-em-element"><em></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="em")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java
index 7f86e84..241d322 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java
@@ -21,15 +21,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/embedded-content-0.html#the-embed-element"><embed></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="embed")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
index 88844ac..0e51dbd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
@@ -17,17 +17,19 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/forms.html#the-fieldset-element"><fieldset></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
- */
+*/
@Bean(typeName="fieldset")
public class Fieldset extends HtmlElementMixed {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
index 91c3e98..a076f7d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-figcaption-element"><figcaption></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="figcaption")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java
index 8e58fa6..ae287cd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-figure-element"><figure></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="figure")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java
index 0487735..c1bcb59 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java
@@ -15,16 +15,19 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-footer-element"><footer></a> element.
- * <p>
+ * DTO for an HTML
+ * <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-footer-element"><footer></a> element.
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="footer")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java
index 5b8935f..4a9ced2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java
@@ -21,15 +21,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/forms.html#the-form-element"><form></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="form")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java
index 7ce0dbd..03ce913 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h1></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="h1")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java
index 99bd76a..96bf9aa 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h2></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="h2")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java
index 0760915..356fe70 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h3></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="h3")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java
index 2776e15..adcda96 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h4></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="h4")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java
index e51c785..6a25dad 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h5></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="h5")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java
index fc54e95..3cb5e56 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h6></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="h6")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java
index 8f90aa8..2095029 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/document-metadata.html#the-head-element"><head></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="head")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java
index 9bde6d2..b4e2806 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/sections.html#the-header-element"><header></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="header")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java
index 46fadac..4626424 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-hr-element"><hr></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="hr")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java
index 84fc1de..e96e4ab 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/semantics.html#the-html-element"><html></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="html")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java
index 978dd95..1313ebf 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java
@@ -16,15 +16,17 @@ import org.apache.juneau.*;
/**
* Defines the Java classes that make up the HTML DTO type dictionary.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
public class HtmlBeanDictionary extends BeanDictionaryList {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java
index 9273bd3..bdeba5a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java
@@ -17,11 +17,14 @@ package org.apache.juneau.dto.html5;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
public class HtmlBuilder {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
index 9c63665..14881cc 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
@@ -33,11 +33,14 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@org.apache.juneau.html.annotation.Html(asXml=true)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
index 5de9b4c..1628147 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
@@ -26,11 +26,14 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
public class HtmlElementContainer extends HtmlElement {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
index fd5e9a6..b2ff2da 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
@@ -26,11 +26,14 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
public class HtmlElementMixed extends HtmlElement {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java
index 3e2cfda..02af654 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java
@@ -21,11 +21,14 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@SuppressWarnings("hiding")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
index 1b5bc19..80e47e5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
@@ -20,11 +20,14 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@SuppressWarnings("hiding")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
index 7629401..365846d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
@@ -23,11 +23,14 @@ import org.apache.juneau.xml.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Xml(format=VOID)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java
index 8c66e26..58ed0ae 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-i-element"><i></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="i")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java
index d7126f1..86af1dc 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java
@@ -21,15 +21,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/embedded-content-0.html#the-iframe-element"><iframe></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="iframe")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java
index 4038de4..7701736 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java
@@ -24,11 +24,14 @@ import org.apache.juneau.annotation.*;
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="img")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java
index b555049..7932b30 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java
@@ -19,15 +19,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-input-element"><input></a>
* element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="input")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java
index d891ac4..0a60453 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/edits.html#the-ins-element"><ins></a>
* element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="ins")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java
index 51b13ea..454be16 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-kbd-element"><kbd></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="kbd")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java
index 416d332..4d57ec1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/forms.html#the-keygen-element"><keygen></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="keygen")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java
index 1fa3d8b..af3f55b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-label-element"><label></a>
* element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="label")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java
index a641249..be89826 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java
@@ -16,16 +16,18 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/forms.html#the-legend-element"><legend></a> element.
- * <p>
+ * href="https://www.w3.org/TR/html5/forms.html#the-legend-element"><legend></a> element.
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="legend")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java
index 88a417e..524347f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-li-element"><li></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="li")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java
index df31c52..d871bdb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java
@@ -21,15 +21,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/document-metadata.html#the-link-element"><link></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="link")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java
index 3002466..13888d8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/grouping-content.html#the-main-element"><main></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="main")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java
index 1f81c9a..1000736 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/embedded-content-0.html#the-map-element"><map></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="map")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java
index 26fb6a6..c9a3626 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/text-level-semantics.html#the-mark-element"><mark></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="mark")
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/0d913b38/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java
index 92bc56c..5be05b5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java
@@ -17,15 +17,17 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink"
* href="https://www.w3.org/TR/html5/document-metadata.html#the-meta-element"><meta></a> element.
- * <p>
*
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
- * <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
+ * <li class='link'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects
* (org.apache.juneau.dto)</a>
- * <ul>
- * <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
- * </ul>
+ * <ul>
+ * <li class='sublink'>
+ * <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
+ * </ul>
+ * </li>
* </ul>
*/
@Bean(typeName="meta")