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 2018/01/14 16:02:29 UTC
[01/32] juneau git commit: Javadoc updates.
Repository: juneau
Updated Branches:
refs/heads/master cd2b718e7 -> 5686b8d66
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Introspectable.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Introspectable.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Introspectable.java
index c26a2d1..2e26fa7 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Introspectable.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Introspectable.java
@@ -23,15 +23,15 @@ import org.apache.juneau.utils.*;
/**
* 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.
- *
+ *
* <p>
* 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'>
@@ -41,7 +41,7 @@ import org.apache.juneau.utils.*;
* <li>
* <code>&invokeArgs</code> - The arguments as a JSON array.
* </ul>
- *
+ *
* <p>
* See {@link PojoIntrospector} for additional information on introspection of POJO methods.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Queryable.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Queryable.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Queryable.java
index ed447c2..911bdc1 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Queryable.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Queryable.java
@@ -18,11 +18,11 @@ import org.apache.juneau.utils.*;
/**
* 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.
- *
+ *
* <p>
* The following HTTP request parameters are available for tabular data (e.g. {@code Collections} of {@code Maps},
* arrays of beans, etc...):
@@ -53,7 +53,7 @@ import org.apache.juneau.utils.*;
* <br>Only return the specified number of rows.
* <br>Default is {@code 0} (meaning return all rows).
* </ul>
- *
+ *
* <p>
* See {@link PojoQuery} for additional information on filtering POJO models.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Traversable.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Traversable.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Traversable.java
index 76842b3..fb16c20 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Traversable.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/converters/Traversable.java
@@ -21,18 +21,18 @@ import org.apache.juneau.utils.*;
/**
* 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.
- *
+ *
* <p class='bcode'>
* <jc>// Resource method on resource "http://localhost:8080/sample/addressBook"</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, converters=Traversable.<jk>class</jk>)
* <jk>public void</jk> doGet(RestRequest req, RestResponse res) {
* <jk>return new</jk> AddressBook();
* }
- *
+ *
* <jc>// Sample usage</jc>
* <jk>public static void</jk> main(String[] args) {
* <jc>// Get the zip code of the 2nd address of the first person in the address book.</jc>
@@ -40,7 +40,7 @@ import org.apache.juneau.utils.*;
* <jk>int</jk> zip = r.getResponse(Integer.<jk>class</jk>);
* }
* </p>
- *
+ *
* <p>
* See {@link PojoRest} for additional information on addressing elements in a POJO tree using URL notation.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java
index 327c220..8e8f05a 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java
@@ -17,11 +17,11 @@ 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.
- *
+ *
* <p>
* Useful for rendering simple information about a bean during REST OPTIONS requests.
*/
@@ -36,7 +36,7 @@ public final class BeanDescription {
/**
* Constructor
- *
+ *
* @param c The bean class type.
*/
public BeanDescription(Class<?> c) {
@@ -61,7 +61,7 @@ public final class BeanDescription {
/**
* Constructor.
- *
+ *
* @param name The bean property name.
* @param type The bean property class type.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java
index 809203f..c857c66 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java
@@ -18,7 +18,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.
*/
@@ -28,7 +28,7 @@ public class ChildResourceDescriptions extends LinkedList<ResourceDescription> {
/**
* Constructor.
- *
+ *
* @param context The servlet context that this bean describes.
* @param req The HTTP servlet request.
*/
@@ -38,7 +38,7 @@ public class ChildResourceDescriptions extends LinkedList<ResourceDescription> {
/**
* Constructor.
- *
+ *
* @param context The servlet context that this bean describes.
* @param req The HTTP servlet request.
* @param sort
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/NameDescription.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/NameDescription.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/NameDescription.java
index e7ff1cd..7417769 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/NameDescription.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/NameDescription.java
@@ -16,7 +16,7 @@ import org.apache.juneau.annotation.*;
/**
* Simple bean with {@code name} and {@code description} properties.
- *
+ *
* <p>
* Primarily used for constructing tables with name/description columns on REST OPTIONS requests.
*/
@@ -31,7 +31,7 @@ public class NameDescription {
/**
* Constructor.
- *
+ *
* @param name A name.
* @param description A description.
*/
@@ -42,7 +42,7 @@ public class NameDescription {
/**
* Returns the name field on this label.
- *
+ *
* @return The name.
*/
public Object getName() {
@@ -51,7 +51,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) {
@@ -60,7 +60,7 @@ public class NameDescription {
/**
* Returns the description field on this label.
- *
+ *
* @return The description.
*/
public Object getDescription() {
@@ -69,7 +69,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/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/ResourceDescription.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/ResourceDescription.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/ResourceDescription.java
index 966c1b7..30f296c 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/ResourceDescription.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/labels/ResourceDescription.java
@@ -16,7 +16,7 @@ import org.apache.juneau.html.annotation.*;
/**
* Shortcut label for child resources. Typically used in router resources.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>new</jk> ResourceLink(<js>"httpTool"</js>, <js>"HTTP request test client"</js>);
@@ -26,7 +26,7 @@ public final class ResourceDescription extends NameDescription implements Compar
/**
* Constructor.
- *
+ *
* @param name The name of the child resource.
* @param description The description of the child resource.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServiceProperties.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServiceProperties.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServiceProperties.java
index 1683122..447f277 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServiceProperties.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServiceProperties.java
@@ -18,14 +18,14 @@ 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.
- *
+ *
* <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.
* <br>Setting them on {@link RestMethod#properties() @RestMethod.properties()} has no effect.
@@ -35,7 +35,7 @@ public final class RemoteableServiceProperties {
/**
* 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/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServlet.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServlet.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServlet.java
index be4773a..c02d99e 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServlet.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/remoteable/RemoteableServlet.java
@@ -26,14 +26,14 @@ import org.apache.juneau.rest.annotation.*;
/**
* Abstract class for defining Remoteable services.
- *
+ *
* <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.
- *
+ *
* See <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.rest.remoteable</a> for details.
*/
@SuppressWarnings("serial")
@@ -47,10 +47,10 @@ public abstract class RemoteableServlet extends RestServletDefault {
/**
* Returns the list of interfaces to their implementation objects.
- *
+ *
* <p>
* This class is called often and not cached, so any caching should occur in the subclass if necessary.
- *
+ *
* @return The service map.
* @throws Exception
*/
@@ -62,7 +62,7 @@ public abstract class RemoteableServlet extends RestServletDefault {
/**
* [GET /] - Get the list of all remote interfaces.
- *
+ *
* @param req The HTTP servlet request.
* @return The list of links to the remote interfaces.
* @throws Exception
@@ -80,7 +80,7 @@ public abstract class RemoteableServlet extends RestServletDefault {
/**
* [GET /{javaInterface] - Get the list of all remoteable methods on the specified interface name.
- *
+ *
* @param javaInterface The Java interface name.
* @return The methods defined on the interface.
* @throws Exception
@@ -92,7 +92,7 @@ public abstract class RemoteableServlet extends RestServletDefault {
/**
* [POST /{javaInterface}/{javaMethod}] - Invoke the specified service method.
- *
+ *
* @param req The HTTP request.
* @param javaInterface The Java interface name.
* @param javaMethod The Java method name or signature.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java
index 93e4aa6..ef20136 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/DefaultHandler.java
@@ -25,13 +25,13 @@ import org.apache.juneau.serializer.*;
/**
* Response handler for POJOs not handled by other handlers.
- *
+ *
* <p>
* This uses the serializers defined on the response to serialize the POJO.
- *
+ *
* <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
* <code>produces</code> value passed in through the constructor.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java
index 073e030..31a5ad1 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/InputStreamHandler.java
@@ -19,10 +19,10 @@ import org.apache.juneau.utils.*;
/**
* Response handler for {@link InputStream} objects.
- *
+ *
* <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)}.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ReaderHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ReaderHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ReaderHandler.java
index 06b04f8..5d6eda1 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ReaderHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ReaderHandler.java
@@ -19,7 +19,7 @@ import org.apache.juneau.utils.*;
/**
* Response handler for {@link Reader} objects.
- *
+ *
* <p>
* Simply pipes the contents of the {@link Reader} to {@link RestResponse#getNegotiatedWriter()}.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java
index bfc5db1..c02e197 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/StreamableHandler.java
@@ -21,7 +21,7 @@ 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.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/WritableHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/WritableHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/WritableHandler.java
index 684c1c2..9a50ff9 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/WritableHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/WritableHandler.java
@@ -21,7 +21,7 @@ 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.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java
index 5a5c452..f1cd64e 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/response/ZipFileListResponseHandler.java
@@ -22,10 +22,10 @@ import org.apache.juneau.utils.ZipFileList.*;
/**
* Response handler for ZipFileList objects.
- *
+ *
* <p>
* Can be associated with a REST resource using the {@link RestResource#responseHandlers} annotation.
- *
+ *
* <p>
* Sets the following headers:
* <ul class='spaced-list'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/FileVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/FileVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/FileVar.java
index 30d2271..27b5a58 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/FileVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/FileVar.java
@@ -18,19 +18,19 @@ import org.apache.juneau.utils.*;
/**
* File resource variable resolver
- *
+ *
* <p>
* The format for this var is <js>"$F{path[,defaultValue]}"</js>.
- *
+ *
* <p>
* File variables resolve to the contents of resource files located on the classpath or local JVM directory.
* They use the {@link RestRequest#getClasspathReaderResource(String)} method to retrieve the contents of the file.
* That in turn uses the {@link ClasspathResourceFinder} associated with the servlet class to find the file.
- *
+ *
* <p>
* The {@link ClasspathResourceFinder} is similar to {@link Class#getResourceAsStream(String)} except if it doesn't find the
* resource on this class, it 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.
* <br>Path traversals outside the working directory are not allowed for security reasons.
@@ -44,7 +44,7 @@ import org.apache.juneau.utils.*;
* <li><js>"MyResource_ja.txt"</js>
* <li><js>"MyResource.txt"</js>
* </ol>
- *
+ *
* <p>
* Example:
* <p class='bcode'>
@@ -54,11 +54,11 @@ import org.apache.juneau.utils.*;
* )
* )
* </p>
- *
+ *
* <p>
* Files of type HTML, XHTML, XML, JSON, Javascript, and CSS will be stripped of comments.
* This allows you to place license headers in files without them being serialized to the output.
- *
+ *
* @see org.apache.juneau.svl
*/
public class FileVar extends DefaultingVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/LocalizationVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/LocalizationVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/LocalizationVar.java
index 43e15c9..233d219 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/LocalizationVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/LocalizationVar.java
@@ -19,22 +19,22 @@ import org.apache.juneau.svl.*;
/**
* Localized string variable resolver.
- *
+ *
* <p>
* The format for this var is <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.
- *
+ *
* <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.
- *
+ *
* <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.
- *
+ *
* @see org.apache.juneau.svl
*/
public class LocalizationVar extends MultipartVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestAttributeVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestAttributeVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestAttributeVar.java
index 94c66ea..f3e928d 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestAttributeVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestAttributeVar.java
@@ -20,7 +20,7 @@ import org.apache.juneau.svl.*;
/**
* Request attribute variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$RA{key1[,key2...]}"</js>.
*
@@ -28,13 +28,14 @@ import org.apache.juneau.svl.*;
* Used to resolve values returned by {@link HttpServletRequest#getAttribute(String)}.
* <br>When multiple keys are used, returns the first non-null/empty value.
*
- * <h6 class='figure'>Example:</h6>
+ * <h6 class='section'>Example:</h6>
* <p class='bcode'>
* String foo = restRequest.resolveVars(<js>"$RA{foo}"</js>);
* String fooOrBar = restRequest.resolveVars(<js>"$RA{foo,bar}"</js>);
* </p>
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ * <h
+ * 5 class='topic'>Notes</h5>
* <ul class='spaced-list'>
* <li>
* This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver
@@ -42,7 +43,7 @@ import org.apache.juneau.svl.*;
* <li>
* For security reasons, nested and recursive variables are not resolved.
* </ul>
- *
+ *
* @see org.apache.juneau.svl
*/
public class RequestAttributeVar extends MultipartResolvingVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestFormDataVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestFormDataVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestFormDataVar.java
index d820121..70ae2ec 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestFormDataVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestFormDataVar.java
@@ -17,21 +17,22 @@ import org.apache.juneau.svl.*;
/**
* Request form data variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$RF{key1[,key2...]}"</js>.
- *
+ *
* <p>
* Used to resolve values returned by {@link RestRequest#getFormData(String)}.
* <br>When multiple keys are used, returns the first non-null/empty value.
*
- * <h6 class='figure'>Example:</h6>
+ * <h6 class='section'>Example:</h6>
* <p class='bcode'>
* String foo = restRequest.resolveVars(<js>"$RF{foo}"</js>);
* String fooOrBar = restRequest.resolveVars(<js>"$RF{foo,bar}"</js>);
* </p>
*
- * <h5 class='section'>Notes:</h5>
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul class='spaced-list'>
* <li>
* This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestHeaderVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestHeaderVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestHeaderVar.java
index e1fc73d..e01caf4 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestHeaderVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestHeaderVar.java
@@ -17,21 +17,22 @@ import org.apache.juneau.svl.*;
/**
* Request header variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$RH{key1[,key2...]}"</js>.
- *
+ *
* <p>
* Used to resolve values returned by {@link RestRequest#getHeader(String)}.
* <br>When multiple keys are used, returns the first non-null/empty value.
*
- * <h6 class='figure'>Example:</h6>
+ * <h6 class='section'>Example:</h6>
* <p class='bcode'>
* String foo = restRequest.resolveVars(<js>"$RH{Foo}"</js>);
* String fooOrBar = restRequest.resolveVars(<js>"$RH{Foo,Bar}"</js>);
* </p>
*
- * <h5 class='section'>Notes:</h5>
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul class='spaced-list'>
* <li>
* This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver
@@ -39,7 +40,7 @@ import org.apache.juneau.svl.*;
* <li>
* For security reasons, nested and recursive variables are not resolved.
* </ul>
- *
+ *
* @see org.apache.juneau.svl
*/
public class RequestHeaderVar extends MultipartResolvingVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestPathVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestPathVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestPathVar.java
index f971199..3b612fe 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestPathVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestPathVar.java
@@ -17,22 +17,23 @@ import org.apache.juneau.svl.*;
/**
* Request path variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$RP{key1[,key2...]}"</js>.
- *
+ *
* <p>
* Used to resolve values returned by {@link RestRequest#getPath(String)}.
* <br>When multiple keys are used, returns the first non-null/empty value.
*
- * <h6 class='figure'>Example:</h6>
+ * <h6 class='section'>Example:</h6>
* <p class='bcode'>
* <jc>// URI path pattern = "/foo/{foo}/bar/{bar}"</jc>
* String foo = restRequest.resolveVars(<js>"$RP{foo}"</js>);
* String fooOrBar = restRequest.resolveVars(<js>"$RP{foo,bar}"</js>);
* </p>
*
- * <h5 class='section'>Notes:</h5>
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul class='spaced-list'>
* <li>
* This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver
@@ -40,7 +41,7 @@ import org.apache.juneau.svl.*;
* <li>
* For security reasons, nested and recursive variables are not resolved.
* </ul>
- *
+ *
* @see org.apache.juneau.svl
*/
public class RequestPathVar extends MultipartResolvingVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestQueryVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestQueryVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestQueryVar.java
index 322e25e..9479762 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestQueryVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestQueryVar.java
@@ -17,22 +17,23 @@ import org.apache.juneau.svl.*;
/**
* Request query variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$RQ{key1[,key2...]}"</js>.
- *
+ *
* <p>
* Used to resolve values returned by {@link RestRequest#getQuery(String)}.
* <br>When multiple keys are used, returns the first non-null/empty value.
*
- * <h6 class='figure'>Example:</h6>
+ * <h6 class='section'>Example:</h6>
* <p class='bcode'>
* <jc>// URI = "...?foo=X&bar=Y"</jc>
* String foo = restRequest.resolveVars(<js>"$RQ{foo}"</js>);
* String fooOrBar = restRequest.resolveVars(<js>"$RQ{foo,bar}"</js>);
* </p>
*
- * <h5 class='section'>Notes:</h5>
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul class='spaced-list'>
* <li>
* This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver
@@ -40,7 +41,7 @@ import org.apache.juneau.svl.*;
* <li>
* For security reasons, nested and recursive variables are not resolved.
* </ul>
- *
+ *
* @see org.apache.juneau.svl
*/
public class RequestQueryVar extends MultipartResolvingVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestVar.java
index a21c8a0..0c1a509 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RequestVar.java
@@ -19,11 +19,11 @@ import org.apache.juneau.svl.*;
/**
* Request attribute variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$R{key1[,key2...]}"</js>.
* <br>When multiple keys are used, returns the first non-null/empty value.
- *
+ *
* <p>
* The possible values are:
* <ul>
@@ -43,13 +43,14 @@ import org.apache.juneau.svl.*;
* </ul>
*
* <p>
- * <h6 class='figure'>Example:</h6>
+ * <h6 class='section'>Example:</h6>
* <p class='bcode'>
* String servletTitle = restRequest.resolveVars(<js>"$R{servletTitle}"</js>);
* String servletTitleOrDescription = restRequest.resolveVars(<js>"$R{servletTitle,servletDescription}"</js>);
* </p>
*
- * <h5 class='section'>Notes:</h5>
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul class='spaced-list'>
* <li>
* This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver
@@ -57,7 +58,7 @@ import org.apache.juneau.svl.*;
* <li>
* For security reasons, nested and recursive variables are not resolved.
* </ul>
- *
+ *
* @see org.apache.juneau.svl
*/
public class RequestVar extends MultipartResolvingVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RestInfoVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RestInfoVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RestInfoVar.java
index 13f064b..a5f427e 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RestInfoVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/RestInfoVar.java
@@ -23,14 +23,14 @@ import org.apache.juneau.svl.*;
/**
* Rest info variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$RI{key1[,key2...]}"</js>.
*
* <p>
* Used to resolve values returned by {@link RestRequest#getInfoProvider()}..
* <br>When multiple keys are used, returns the first non-null/empty value.
- *
+ *
* <p>
* The possible values are:
* <ul>
@@ -48,13 +48,14 @@ import org.apache.juneau.svl.*;
* </ul>
*
* <p>
- * <h6 class='figure'>Example:</h6>
+ * <h6 class='section'>Example:</h6>
* <p class='bcode'>
* String title = restRequest.resolveVars(<js>"$RI{title}"</js>);
* String titleOrDescription = restRequest.resolveVars(<js>"$RI{title,description}"</js>);
* </p>
*
- * <h5 class='section'>Notes:</h5>
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul class='spaced-list'>
* <li>
* This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver
@@ -62,7 +63,7 @@ import org.apache.juneau.svl.*;
* <li>
* For security reasons, nested and recursive variables are not resolved.
* </ul>
- *
+ *
* @see org.apache.juneau.svl
*/
public class RestInfoVar extends MultipartResolvingVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/SerializedRequestAttrVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/SerializedRequestAttrVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/SerializedRequestAttrVar.java
index f124d9c..de5e1d6 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/SerializedRequestAttrVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/SerializedRequestAttrVar.java
@@ -22,18 +22,18 @@ import org.apache.juneau.svl.*;
/**
* Serialized request attribute variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$SA{contentType,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.
- *
+ *
* <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.
- *
+ *
* @see org.apache.juneau.svl
*/
public class SerializedRequestAttrVar extends StreamedVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/ServletInitParamVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/ServletInitParamVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/ServletInitParamVar.java
index 8125f8b..d6f2077 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/ServletInitParamVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/ServletInitParamVar.java
@@ -17,21 +17,21 @@ import org.apache.juneau.svl.*;
/**
* Servlet init parameter variable resolver.
- *
+ *
* <p>
* The format for this var is <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.
- *
+ *
* <p>
* Values are pulled from the {@link RestServlet#getInitParameter(String)} method.
- *
+ *
* <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.
- *
+ *
* @see org.apache.juneau.svl
*/
public class ServletInitParamVar extends DefaultingVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/UrlEncodeVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/UrlEncodeVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/UrlEncodeVar.java
index e629a10..84d5d83 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/UrlEncodeVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/UrlEncodeVar.java
@@ -19,18 +19,18 @@ import org.apache.juneau.svl.*;
/**
* URL-encoding variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$UE{uriPart}"</js>.
- *
+ *
* <p>
* 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.
- *
+ *
* @see org.apache.juneau.svl
*/
public class UrlEncodeVar extends SimpleVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/UrlVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/UrlVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/UrlVar.java
index be54af0..74e4da1 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/UrlVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/UrlVar.java
@@ -19,24 +19,24 @@ import org.apache.juneau.svl.*;
/**
* URL variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$U{uri}"</js>.
- *
+ *
* <p>
* 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>
* <li>{@link HtmlDoc#widgets() @HtmlDoc.widgets()}
* </ul>
- *
+ *
* <p>
* Uses the URI resolver returned by {@link RestRequest#getUriResolver(UriResolution, UriRelativity)} with resolution
* {@link UriResolution#ROOT_RELATIVE} and relativity {@link UriRelativity#RESOURCE}.
- *
+ *
* @see org.apache.juneau.svl
*/
public class UrlVar extends SimpleVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/WidgetVar.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/WidgetVar.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/WidgetVar.java
index 2bdd87c..4d359fc 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/WidgetVar.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/vars/WidgetVar.java
@@ -19,19 +19,19 @@ import org.apache.juneau.svl.*;
/**
* HTML widget variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$W{widgetName}"</js>.
- *
+ *
* <p>
* Widgets are simple class that produce some sort of string based on a passed-in HTTP request.
- *
+ *
* <p>
* They're registered via the following mechanisms:
* <ul>
* <li>{@link HtmlDoc#widgets() @HtmlDoc.widgets()}
* </ul>
- *
+ *
* @see org.apache.juneau.svl
*/
public class WidgetVar extends SimpleVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/ContentTypeMenuItem.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/ContentTypeMenuItem.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/ContentTypeMenuItem.java
index 57d8324..005557a 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/ContentTypeMenuItem.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/ContentTypeMenuItem.java
@@ -25,10 +25,10 @@ import org.apache.juneau.utils.*;
/**
* Widget that returns back a list of hyperlinks for rendering the contents of a page in a variety of content types.
- *
+ *
* <p>
* The variable it resolves is <js>"$W{ContentTypeMenuItem}"</js>.
- *
+ *
* <p>
* An example of this widget can be found in the <code>PetStoreResource</code> in the examples that provides
* a drop-down menu item for rendering all other supported content types in plain text:
@@ -52,7 +52,7 @@ import org.apache.juneau.utils.*;
* )
* <jk>public</jk> Collection<Pet> getPets() {
* </p>
- *
+ *
* <p>
* It renders the following popup-box:
* <br><img class='bordered' src='doc-files/ContentTypeMenuItem.png'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/MenuItemWidget.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/MenuItemWidget.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/MenuItemWidget.java
index ea1b114..ff01cbd 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/MenuItemWidget.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/MenuItemWidget.java
@@ -21,21 +21,21 @@ import org.apache.juneau.serializer.*;
/**
* A subclass of widgets for rendering menu items with drop-down windows.
- *
+ *
* <p>
* Defines some simple CSS and Javascript for enabling drop-down menus in the nav section of the page (although
* nothing keeps you from using it in an arbitrary location in the page).
- *
+ *
* <p>
* The script specifies a <js>"menuClick(element)"</js> function that toggles the visibility of the next sibling of the
* element.
- *
+ *
* <p>
* Subclasses should implement the following two methods:
* <ul>
* <li>{@link #getLabel(RestRequest)} - The menu item label.
* <li>{@link #getContent(RestRequest)} - The menu item content.
- *
+ *
* <p>
* For example, to render a link that brings up a simple dialog in a div tag:
* <p class='bcode'>
@@ -43,13 +43,13 @@ import org.apache.juneau.serializer.*;
* <jk>public</jk> String getLabel() {
* <jk>return</jk> <js>"my-menu-item"</js>;
* };
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> Div getLabel() {
* <jk>return</jk> Html5Builder.<jsm>div</jsm>(<js>"Surprise!"</js>).style(<js>"color:red"</js>);
* };
* </p>
- *
+ *
* <p>
* The HTML content returned by the {@link #getHtml(RestRequest)} method is added where the <js>"$W{...}"</js> is
* referenced in the page.
@@ -103,7 +103,7 @@ public abstract class MenuItemWidget extends Widget {
/**
* The label for the menu item as it's rendered in the menu bar.
- *
+ *
* @param req The HTTP request object.
* @return The menu item label.
* @throws Exception
@@ -112,7 +112,7 @@ public abstract class MenuItemWidget extends Widget {
/**
* The content of the popup.
- *
+ *
* @param req The HTTP request object.
* @return
* The content of the popup.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByApache.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByApache.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByApache.java
index c4a88ac..d070bbd 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByApache.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByApache.java
@@ -17,14 +17,14 @@ import org.apache.juneau.rest.*;
/**
* Widget that places a powered-by-Apache message on the page.
- *
+ *
* <p>
* The variable it resolves is <js>"$W{PoweredByApache}"</js>.
- *
+ *
* <p>
* It produces a simple Apache icon floating on the right.
* Typically it's used in the footer of the page, as shown below in the <code>RootResources</code> from the examples:
- *
+ *
* <p class='bcode'>
* <ja>@RestResource</ja>(
* path=<js>"/"</js>,
@@ -37,7 +37,7 @@ import org.apache.juneau.rest.*;
* footer=<js>"$W{PoweredByApache}"</js>
* )
* </p>
- *
+ *
* <p>
* It renders the following image:
* <img class='bordered' src='doc-files/PoweredByApacheWidget.png'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByJuneau.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByJuneau.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByJuneau.java
index 19542df..f13a170 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByJuneau.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/PoweredByJuneau.java
@@ -17,14 +17,14 @@ import org.apache.juneau.rest.*;
/**
* Widget that places a powered-by-Juneau message on the page.
- *
+ *
* <p>
* The variable it resolves is <js>"$W{PoweredByJuneau}"</js>.
- *
+ *
* <p>
* It produces a simple Apache Juneau icon floating on the right.
* Typically it's used in the footer of the page, as shown below in the <code>AddressBookResource</code> from the examples:
- *
+ *
* <p class='bcode'>
* <ja>@RestResource</ja>(
* path=<js>"/addressBook"</js>,
@@ -35,7 +35,7 @@ import org.apache.juneau.rest.*;
* footer=<js>"$W{PoweredByJuneau}"</js>
* )
* </p>
- *
+ *
* <p>
* It renders the following image:
* <img class='bordered' src='doc-files/PoweredByJuneauWidget.png'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/QueryMenuItem.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/QueryMenuItem.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/QueryMenuItem.java
index 6eda0f3..49576f5 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/QueryMenuItem.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/QueryMenuItem.java
@@ -17,15 +17,15 @@ import org.apache.juneau.rest.converters.*;
/**
* Widget that returns a menu-item drop-down form for entering search/view/sort arguments.
- *
+ *
* <p>
* The variable it resolves is <js>"$W{QueryMenuItem}"</js>.
- *
+ *
* <p>
* This widget is designed to be used in conjunction with the {@link Queryable} converter, although implementations
* can process the query parameters themselves if they wish to do so by using the {@link RequestQuery#getSearchArgs()}
* method to retrieve the arguments and process the data themselves.
- *
+ *
* <p>
* An example of this widget can be found in the <code>PetStoreResource</code> in the examples that provides
* search/view/sort capabilities against the collection of POJOs:
@@ -50,15 +50,15 @@ import org.apache.juneau.rest.converters.*;
* )
* <jk>public</jk> Collection<Pet> getPets() {
* </p>
- *
+ *
* <p>
* It renders the following popup-box:
* <br><img class='bordered' src='doc-files/QueryMenuItem_1.png'>
- *
+ *
* <p>
* Tooltips are provided by hovering over the field names.
* <br><img class='bordered' src='doc-files/QueryMenuItem_2.png'>
- *
+ *
* <p>
* When submitted, the form submits a GET request against the current URI with special GET search API query parameters.
* <br>(e.g. <js>"?s=column1=Foo*&v=column1,column2&o=column1,column2-&p=100&l=100"</js>).
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/StyleMenuItem.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/StyleMenuItem.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/StyleMenuItem.java
index 8b7337d..8770001 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/StyleMenuItem.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/StyleMenuItem.java
@@ -20,10 +20,10 @@ import org.apache.juneau.utils.*;
/**
* Widget that returns back a list of hyperlinks for rendering the contents of a page in the various default styles.
- *
+ *
* <p>
* The variable it resolves is <js>"$W{StyleMenuItem}"</js>.
- *
+ *
* <p>
* An example of this widget can be found in the <code>PetStoreResource</code> in the examples that provides
* a drop-down menu item for rendering all other supported content types in plain text:
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Tooltip.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Tooltip.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Tooltip.java
index 27cc13d..dcfe949 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Tooltip.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Tooltip.java
@@ -21,22 +21,22 @@ import org.apache.juneau.dto.html5.*;
/**
* Simple template for adding tooltips to HTML5 bean constructs, typically in menu item widgets.
- *
+ *
* <p>
* Tooltips depend on the existence of the <code>tooltip</code> and <code>tooltiptext</code> styles that should be
* present in the stylesheet for the document.
- *
+ *
* <p>
* The following examples shows how tooltips can be added to a menu item widget.
- *
+ *
* <p class='bcode'>
* <jk>public class</jk> MyFormMenuItem <jk>extends</jk> MenuItemWidget {
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> String getLabel(RestRequest req) <jk>throws</jk> Exception {
* <jk>return</jk> <js>"myform"</js>;
* }
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> Object getContent(RestRequest req) <jk>throws</jk> Exception {
* <jk>return</jk> div(
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Widget.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Widget.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Widget.java
index 354574d..80247d2 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Widget.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Widget.java
@@ -21,7 +21,7 @@ import org.apache.juneau.utils.*;
/**
* Defines an interface for resolvers of <js>"$W{...}"</js> string variables.
- *
+ *
* <p>
* Widgets are associated with resources through the following
* <ul>
@@ -29,20 +29,20 @@ import org.apache.juneau.utils.*;
* <li>{@link RestContextBuilder#widgets(Class...)}
* <li>{@link RestContextBuilder#widgets(Widget...)}
* </ul>
- *
+ *
* <p>
* Widgets allow you to add arbitrary HTML, CSS, and Javascript to the page.
- *
+ *
* <p>
* The HTML content returned by the {@link #getHtml(RestRequest)} method is added where the <js>"$W{...}"</js> is
* referenced in the page.
* The Javascript and stylesheet content is added to the header of the page.
* They allow you to control the look and behavior of your widgets.
- *
+ *
* <p>
* The following examples shows how to associate a widget with a REST method and then have it rendered in the links
* and aside section of the page:
- *
+ *
* <p class='bcode'>
* <ja>@RestMethod</ja>(
* widgets={
@@ -58,19 +58,19 @@ import org.apache.juneau.utils.*;
* )
* )
* </p>
- *
+ *
* <p>
* The following shows an example of a widget that renders an image located in the <code>htdocs</code> static files
* directory in your classpath (see {@link RestResource#staticFiles() @RestResource.staticFiles()}):
* <p class='bcode'>
* <jk>public class</jk> MyWidget <jk>extends</jk> Widget {
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> String getHtml(RestRequest req) <jk>throws</jk> Exception {
* UriResolver r = req.getUriResolver();
* <jk>return</jk> <js>"<img class='myimage' onclick='myalert(this)' src='"</js>+r.resolve(<js>"servlet:/htdocs/myimage.png"</js>)+<js>"'>"</js>;
* }
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> String getScript(RestRequest req) <jk>throws</jk> Exception {
* <jk>return</jk> <js>""</js>
@@ -78,7 +78,7 @@ import org.apache.juneau.utils.*;
* + <js>"\n alert('cool!');"</js>
* + <js>"\n }"</js>;
* }
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> String getStyle(RestRequest req) <jk>throws</jk> Exception {
* <jk>return</jk> <js>""</js>
@@ -88,23 +88,23 @@ import org.apache.juneau.utils.*;
* }
* }
* </p>
- *
+ *
* <p>
* Note the {@link #getClasspathResourceAsString(String)} and {@link #getClasspathResourceAsString(String, Locale)} convenience methods
* provided for quickly loading javascript and css files from the classpath or file system.
* These are useful if your script or styles are complex and you want them loaded from files.
- *
+ *
* <p>
* <p class='bcode'>
* <jk>public class</jk> MyWidget <jk>extends</jk> Widget {
- *
+ *
* ...
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> String getScript(RestRequest req) <jk>throws</jk> Exception {
* <jk>return</jk> getResourceAsString(<js>"MyWidget.js"</js>);
* }
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> String getStyle(RestRequest req) <jk>throws</jk> Exception {
* <jk>return</jk> getResourceAsString(<js>"MyWidget.css"</js>);
@@ -128,16 +128,16 @@ public abstract class Widget {
/**
* The widget key.
- *
+ *
* <p>
* (i.e. The variable name inside the <js>"$W{...}"</js> variable).
- *
+ *
* <p>
* The returned value must not be <jk>null</jk>.
- *
+ *
* <p>
* If not overridden, the default value is the class simple name.
- *
+ *
* @return The widget key.
*/
public String getName() {
@@ -146,10 +146,10 @@ public abstract class Widget {
/**
* Resolves the HTML content for this widget.
- *
+ *
* <p>
* A returned value of <jk>null</jk> will cause nothing to be added to the page.
- *
+ *
* @param req The HTTP request object.
* @return The HTML content of this widget.
* @throws Exception
@@ -160,10 +160,10 @@ public abstract class Widget {
/**
* Resolves any Javascript that should be added to the <xt><head>/<script></xt> element.
- *
+ *
* <p>
* A returned value of <jk>null</jk> will cause nothing to be added to the page.
- *
+ *
* @param req The HTTP request object.
* @return The Javascript needed by this widget.
* @throws Exception
@@ -174,10 +174,10 @@ public abstract class Widget {
/**
* Resolves any CSS styles that should be added to the <xt><head>/<style></xt> element.
- *
+ *
* <p>
* A returned value of <jk>null</jk> will cause nothing to be added to the page.
- *
+ *
* @param req The HTTP request object.
* @return The CSS styles needed by this widget.
* @throws Exception
@@ -188,15 +188,15 @@ public abstract class Widget {
/**
* Retrieves the specified classpath resource and returns the contents as a string.
- *
+ *
* <p>
* 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 relative to the JVM working directory.
* <br>Path traversals outside the working directory are not allowed for security reasons.
- *
+ *
* @param name Name of the desired resource.
* @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.
* @throws IOException
@@ -207,7 +207,7 @@ public abstract class Widget {
/**
* Same as {@link #getClasspathResourceAsString(String)} except also looks for localized-versions of the file.
- *
+ *
* <p>
* If the <code>locale</code> is specified, then we look for resources whose name matches that locale.
* <br>For example, if looking for the resource <js>"MyResource.txt"</js> for the Japanese locale, we will look for
@@ -217,8 +217,8 @@ public abstract class Widget {
* <li><js>"MyResource_ja.txt"</js>
* <li><js>"MyResource.txt"</js>
* </ol>
- *
- *
+ *
+ *
* @param name Name of the desired resource.
* @param locale The locale. Can be <jk>null</jk>.
* @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.
@@ -231,10 +231,10 @@ public abstract class Widget {
/**
* Convenience method for calling {@link #getClasspathResourceAsString(String)} except also strips Javascript comments from
* the file.
- *
+ *
* <p>
* Comments are assumed to be Java-style block comments: <js>"/*"</js>.
- *
+ *
* @param name Name of the desired resource.
* @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.
* @throws IOException
@@ -249,10 +249,10 @@ public abstract class Widget {
/**
* Convenience method for calling {@link #getClasspathResourceAsString(String)} except also strips CSS comments from
* the file.
- *
+ *
* <p>
* Comments are assumed to be Java-style block comments: <js>"/*"</js>.
- *
+ *
* @param name Name of the desired resource.
* @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.
* @throws IOException
@@ -267,10 +267,10 @@ public abstract class Widget {
/**
* Convenience method for calling {@link #getClasspathResourceAsString(String)} except also strips HTML comments from the
* file.
- *
+ *
* <p>
* Comment are assumed to be <js>"<!-- -->"</js> code blocks.
- *
+ *
* @param name Name of the desired resource.
* @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.
* @throws IOException
[28/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Input.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Input.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Input.java
index 1cf0520..2966668 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Input.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Input.java
@@ -19,7 +19,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -29,7 +29,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="input")
@@ -37,10 +37,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-accept">accept</a> attribute.
- *
+ *
* <p>
* Hint for expected file type in file upload controls.
- *
+ *
* @param accept The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -51,10 +51,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-alt">alt</a> attribute.
- *
+ *
* <p>
* Replacement text for use when images are not available.
- *
+ *
* @param alt The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -65,10 +65,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autocomplete">autocomplete</a> attribute.
- *
+ *
* <p>
* Hint for form auto-fill feature.
- *
+ *
* @param autocomplete The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -79,10 +79,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autofocus">autofocus</a> attribute.
- *
+ *
* <p>
* Automatically focus the form control when the page is loaded.
- *
+ *
* @param autofocus The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -93,10 +93,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-checked">checked</a> attribute.
- *
+ *
* <p>
* Whether the command or control is checked.
- *
+ *
* @param checked
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -109,10 +109,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-dirname">dirname</a> attribute.
- *
+ *
* <p>
* Name of form field to use for sending the element's directionality in form submission.
- *
+ *
* @param dirname The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -123,10 +123,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-disabled">disabled</a> attribute.
- *
+ *
* <p>
* Whether the form control is disabled.
- *
+ *
* @param disabled
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -139,10 +139,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
- *
+ *
* <p>
* Associates the control with a form element.
- *
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -153,10 +153,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formaction">formaction</a> attribute.
- *
+ *
* <p>
* URL to use for form submission.
- *
+ *
* @param formaction The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -167,10 +167,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formenctype">formenctype</a> attribute.
- *
+ *
* <p>
* Form data set encoding type to use for form submission.
- *
+ *
* @param formenctype The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -181,10 +181,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formmethod">formmethod</a> attribute.
- *
+ *
* <p>
* HTTP method to use for form submission.
- *
+ *
* @param formmethod The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -196,10 +196,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formnovalidate">formnovalidate</a>
* attribute.
- *
+ *
* <p>
* Bypass form control validation for form submission.
- *
+ *
* @param formnovalidate The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -210,10 +210,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formtarget">formtarget</a> attribute.
- *
+ *
* <p>
* Browsing context for form submission.
- *
+ *
* @param formtarget The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -225,10 +225,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
* attribute.
- *
+ *
* <p>
* Vertical dimension.
- *
+ *
* @param height
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -243,7 +243,7 @@ public class Input extends HtmlElementVoid {
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-input-inputmode">inputmode</a>
* attribute.
* Hint for selecting an input modality.
- *
+ *
* @param inputmode The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -254,10 +254,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-list">list</a> attribute.
- *
+ *
* <p>
* List of auto-complete options.
- *
+ *
* @param list The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -268,10 +268,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-max">max</a> attribute.
- *
+ *
* <p>
* Maximum value.
- *
+ *
* @param max
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -285,7 +285,7 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-maxlength">maxlength</a> attribute.
* Maximum length of value.
- *
+ *
* @param maxlength The new value for this attribute.
* Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
@@ -297,10 +297,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-min">min</a> attribute.
- *
+ *
* <p>
* Minimum value.
- *
+ *
* @param min
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -313,10 +313,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-minlength">minlength</a> attribute.
- *
+ *
* <p>
* Minimum length of value.
- *
+ *
* @param minlength
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -329,10 +329,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-multiple">multiple</a> attribute.
- *
+ *
* <p>
* Whether to allow multiple values.
- *
+ *
* @param multiple
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -345,10 +345,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
- *
+ *
* <p>
* Name of form control to use for form submission and in the form.elements API.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -359,10 +359,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-pattern">pattern</a> attribute.
- *
+ *
* <p>
* Pattern to be matched by the form control's value.
- *
+ *
* @param pattern The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -373,10 +373,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-placeholder">placeholder</a> attribute.
- *
+ *
* <p>
* User-visible label to be placed within the form control.
- *
+ *
* @param placeholder The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -387,10 +387,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-readonly">readonly</a> attribute.
- *
+ *
* <p>
* Whether to allow the value to be edited by the user.
- *
+ *
* @param readonly
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -404,10 +404,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-readonly">readonly</a> attribute.
- *
+ *
* <p>
* Whether to allow the value to be edited by the user.
- *
+ *
* @param readonly If <jk>true</jk>, adds <code>readonly="readonly"</code>.
* @return This object (for method chaining).
*/
@@ -419,10 +419,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-readonly">required</a> attribute.
- *
+ *
* <p>
* Whether the control is required for form submission.
- *
+ *
* @param required
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -435,10 +435,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-size">size</a> attribute.
- *
+ *
* <p>
* Size of the control.
- *
+ *
* @param size
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -451,10 +451,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-src">src</a> attribute.
- *
+ *
* <p>
* Address of the resource.
- *
+ *
* @param src
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
@@ -467,10 +467,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-step">step</a> attribute.
- *
+ *
* <p>
* Granularity to be matched by the form control's value.
- *
+ *
* @param step The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -481,10 +481,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-type">type</a> attribute.
- *
+ *
* <p>
* Type of form control.
- *
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -495,10 +495,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-input-value">value</a> attribute.
- *
+ *
* <p>
* Value of the form control.
- *
+ *
* @param value
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -511,10 +511,10 @@ public class Input extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
- *
+ *
* <p>
* Horizontal dimension.
- *
+ *
* @param width
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ins.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ins.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ins.java
index 820f303..f009f2e 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ins.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ins.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="ins")
@@ -35,10 +35,10 @@ public class Ins extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/edits.html#attr-mod-cite">cite</a> attribute.
- *
+ *
* <p>
* Link to the source of the quotation or more information about the edit.
- *
+ *
* @param cite The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -49,10 +49,10 @@ public class Ins extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/edits.html#attr-mod-datetime">datetime</a> attribute.
- *
+ *
* <p>
* Date and (optionally) time of the change.
- *
+ *
* @param datetime The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Kbd.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Kbd.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Kbd.java
index 1b4b857..876d153 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Kbd.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Kbd.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="kbd")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Keygen.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Keygen.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Keygen.java
index 176cafe..25c78cb 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Keygen.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Keygen.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="keygen")
@@ -35,10 +35,10 @@ public class Keygen extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autofocus">autofocus</a> attribute.
- *
+ *
* <p>
* Automatically focus the form control when the page is loaded.
- *
+ *
* @param autofocus
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -51,10 +51,10 @@ public class Keygen extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-keygen-challenge">challenge</a> attribute.
- *
+ *
* <p>
* String to package with the generated and signed public key.
- *
+ *
* @param challenge The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -65,10 +65,10 @@ public class Keygen extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-disabled">disabled</a> attribute.
- *
+ *
* <p>
* Whether the form control is disabled.
- *
+ *
* @param disabled
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -81,10 +81,10 @@ public class Keygen extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
- *
+ *
* <p>
* Associates the control with a form element.
- *
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -95,10 +95,10 @@ public class Keygen extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-keygen-keytype">keytype</a> attribute.
- *
+ *
* <p>
* The type of cryptographic key to generate.
- *
+ *
* @param keytype The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -109,10 +109,10 @@ public class Keygen extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
- *
+ *
* <p>
* Name of form control to use for form submission and in the form.elements API.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Label.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Label.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Label.java
index d9f366e..24c15d2 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Label.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Label.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="label")
@@ -35,10 +35,10 @@ public class Label extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-label-for">for</a> attribute.
- *
+ *
* <p>
* Associate the label with form control.
- *
+ *
* @param _for The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -49,10 +49,10 @@ public class Label extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
- *
+ *
* <p>
* Associates the control with a form element.
- *
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Legend.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Legend.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Legend.java
index c2a06cf..ad5364c 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Legend.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Legend.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="legend")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Li.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Li.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Li.java
index 8b7debc..a808a77 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Li.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Li.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="li")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Link.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Link.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Link.java
index 48cc15c..69e2124 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Link.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Link.java
@@ -21,7 +21,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="link")
@@ -40,10 +40,10 @@ public class Link extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-crossorigin">crossorigin</a>
* attribute.
- *
+ *
* <p>
* How the element handles cross-origin requests.
- *
+ *
* @param crossorigin The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -54,17 +54,17 @@ public class Link extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-href">href</a> attribute.
- *
+ *
* <p>
* Address of the hyperlink.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param href
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
@@ -78,10 +78,10 @@ public class Link extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-hreflang">hreflang</a>
* attribute.
- *
+ *
* <p>
* Language of the linked resource.
- *
+ *
* @param hreflang The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -92,10 +92,10 @@ public class Link extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-media">media</a> attribute.
- *
+ *
* <p>
* Applicable media.
- *
+ *
* @param media The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -106,10 +106,10 @@ public class Link extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-rel">rel</a> attribute.
- *
+ *
* <p>
* Relationship between the document containing the hyperlink and the destination resource.
- *
+ *
* @param rel The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -120,10 +120,10 @@ public class Link extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-link-sizes">sizes</a> attribute.
- *
+ *
* <p>
* Sizes of the icons (for rel="icon").
- *
+ *
* @param sizes The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -134,10 +134,10 @@ public class Link extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-type">type</a> attribute.
- *
+ *
* <p>
* Hint for the type of the referenced resource.
- *
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Main.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Main.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Main.java
index f34d0a4..a0e783e 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Main.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Main.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="main")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Map.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Map.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Map.java
index b8bcfba..6fce8c8 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Map.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Map.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="map")
@@ -35,10 +35,10 @@ public class Map extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-map-name">name</a> attribute.
- *
+ *
* <p>
* Name of image map to reference from the usemap attribute.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Mark.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Mark.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Mark.java
index 38d70c5..8f2ad47 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Mark.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Mark.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="mark")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Meta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Meta.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Meta.java
index 392aed6..26ab304 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Meta.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Meta.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="meta")
@@ -36,10 +36,10 @@ public class Meta extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-meta-charset">charset</a>
* attribute.
- *
+ *
* <p>
* Character encoding declaration.
- *
+ *
* @param charset The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -51,10 +51,10 @@ public class Meta extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-meta-content">content</a>
* attribute.
- *
+ *
* <p>
* Value of the element.
- *
+ *
* @param content The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -66,10 +66,10 @@ public class Meta extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-meta-http-equiv">http-equiv</a>
* attribute.
- *
+ *
* <p>
* Pragma directive.
- *
+ *
* @param httpequiv The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -80,10 +80,10 @@ public class Meta extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-meta-name">name</a> attribute.
- *
+ *
* <p>
* Metadata name.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Meter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Meter.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Meter.java
index 2963931..0a4d184 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Meter.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Meter.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="meter")
@@ -35,10 +35,10 @@ public class Meter extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-high">high</a> attribute.
- *
+ *
* <p>
* Low limit of high range.
- *
+ *
* @param high
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -51,10 +51,10 @@ public class Meter extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-low">low</a> attribute.
- *
+ *
* <p>
* High limit of low range.
- *
+ *
* @param low
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -67,10 +67,10 @@ public class Meter extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-max">max</a> attribute.
- *
+ *
* <p>
* Upper bound of range.
- *
+ *
* @param max
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -83,10 +83,10 @@ public class Meter extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-min">min</a> attribute.
- *
+ *
* <p>
* Lower bound of range.
- *
+ *
* @param min
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -99,10 +99,10 @@ public class Meter extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-optimum">optimum</a> attribute.
- *
+ *
* <p>
* Optimum value in gauge.
- *
+ *
* @param optimum
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -115,10 +115,10 @@ public class Meter extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-meter-value">value</a> attribute.
- *
+ *
* <p>
* Current value of the element.
- *
+ *
* @param value
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Nav.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Nav.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Nav.java
index 007f1d0..4cf89f9 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Nav.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Nav.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="nav")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Noscript.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Noscript.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Noscript.java
index a41820a..a8f18fe 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Noscript.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Noscript.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="noscript")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Object2.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Object2.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Object2.java
index bcbe8dc..4683a5d 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Object2.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Object2.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="object")
@@ -35,10 +35,10 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-object-data">data</a> attribute.
- *
+ *
* <p>
* Address of the resource.
- *
+ *
* @param data The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -49,10 +49,10 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
- *
+ *
* <p>
* Associates the control with a form element.
- *
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -64,10 +64,10 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
* attribute.
- *
+ *
* <p>
* Vertical dimension.
- *
+ *
* @param height
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -80,10 +80,10 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-object-name">name</a> attribute.
- *
+ *
* <p>
* Name of nested browsing context.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -94,10 +94,10 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-object-type">type</a> attribute.
- *
+ *
* <p>
* Type of embedded resource.
- *
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -109,10 +109,10 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-object-typemustmatch">typemustmatch</a>
* attribute.
- *
+ *
* <p>
* Whether the type attribute and the Content-Type value need to match for the resource to be used.
- *
+ *
* @param typemustmatch
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -126,10 +126,10 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-hyperlink-usemap">usemap</a>
* attribute.
- *
+ *
* <p>
* Name of image map to use.
- *
+ *
* @param usemap The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -140,10 +140,10 @@ public class Object2 extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
- *
+ *
* <p>
* Horizontal dimension.
- *
+ *
* @param width
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ol.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ol.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ol.java
index a559fce..4b06d4c 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ol.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ol.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="ol")
@@ -36,10 +36,10 @@ public class Ol extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-ol-reversed">reversed</a>
* attribute.
- *
+ *
* <p>
* Number the list backwards..
- *
+ *
* @param reversed
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -52,10 +52,10 @@ public class Ol extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-ol-start">start</a> attribute.
- *
+ *
* <p>
* Ordinal value of the first item.
- *
+ *
* @param start
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -68,10 +68,10 @@ public class Ol extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-ol-type">type</a> attribute.
- *
+ *
* <p>
* Kind of list marker.
- *
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Optgroup.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
index 2ee4ede..88ed414 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="optgroup")
@@ -35,10 +35,10 @@ public class Optgroup extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-optgroup-disabled">disabled</a> attribute.
- *
+ *
* <p>
* Whether the form control is disabled.
- *
+ *
* @param disabled
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -51,10 +51,10 @@ public class Optgroup extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-optgroup-label">label</a> attribute.
- *
+ *
* <p>
* User-visible label.
- *
+ *
* @param label The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Option.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Option.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Option.java
index 4fef873..1453ab1 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Option.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Option.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="option")
@@ -35,10 +35,10 @@ public class Option extends HtmlElementText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-option-disabled">disabled</a> attribute.
- *
+ *
* <p>
* Whether the form control is disabled.
- *
+ *
* @param disabled
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -51,10 +51,10 @@ public class Option extends HtmlElementText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-option-label">label</a> attribute.
- *
+ *
* <p>
* User-visible label.
- *
+ *
* @param label The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -65,10 +65,10 @@ public class Option extends HtmlElementText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-option-selected">selected</a> attribute.
- *
+ *
* <p>
* Whether the option is selected by default.
- *
+ *
* @param selected
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -81,10 +81,10 @@ public class Option extends HtmlElementText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-option-value">value</a> attribute.
- *
+ *
* <p>
* Value to be used for form submission.
- *
+ *
* @param value
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Output.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Output.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Output.java
index 6666dad..d15f77f 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Output.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Output.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="output")
@@ -35,10 +35,10 @@ public class Output extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-output-for">for</a> attribute.
- *
+ *
* <p>
* Specifies controls from which the output was calculated.
- *
+ *
* @param _for The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -49,10 +49,10 @@ public class Output extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
- *
+ *
* <p>
* Associates the control with a form element.
- *
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -63,10 +63,10 @@ public class Output extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
- *
+ *
* <p>
* Name of form control to use for form submission and in the form.elements API.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/P.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/P.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/P.java
index dddd064..94b0149 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/P.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/P.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="p")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Param.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Param.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Param.java
index 51dd668..86ac0f4 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Param.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Param.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="param")
@@ -35,10 +35,10 @@ public class Param extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-param-name">name</a> attribute.
- *
+ *
* <p>
* Name of parameter.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -50,10 +50,10 @@ public class Param extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-param-value">value</a>
* attribute.
- *
+ *
* <p>
* Value of parameter.
- *
+ *
* @param value
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Pre.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Pre.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Pre.java
index cb65eeb..83a83b1 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Pre.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Pre.java
@@ -22,7 +22,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -32,7 +32,7 @@ import org.apache.juneau.xml.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="pre")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Progress.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Progress.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Progress.java
index bb81676..1ae39f1 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Progress.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Progress.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="progress")
@@ -35,10 +35,10 @@ public class Progress extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-progress-max">max</a> attribute.
- *
+ *
* <p>
* Upper bound of range.
- *
+ *
* @param max
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -51,10 +51,10 @@ public class Progress extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-progress-value">value</a> attribute.
- *
+ *
* <p>
* Current value of the element.
- *
+ *
* @param value
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Q.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Q.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Q.java
index 69e33eb..d45375b 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Q.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Q.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="q")
@@ -35,10 +35,10 @@ public class Q extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#attr-q-cite">cite</a> attribute.
- *
+ *
* <p>
* Link to the source of the quotation or more information about the edit.
- *
+ *
* @param cite The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rb.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rb.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rb.java
index e48d0c0..a12c8f1 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rb.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rb.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="rb")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rp.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rp.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rp.java
index fba84cb..920eb3c 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rp.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rp.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="rp")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rt.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rt.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rt.java
index 824b54c..177d014 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rt.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rt.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="rt")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rtc.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rtc.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rtc.java
index 5c3ffed..4543c18 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rtc.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Rtc.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="rtc")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ruby.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ruby.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ruby.java
index cd4fbe2..590e875 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ruby.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ruby.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="ruby")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/S.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/S.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/S.java
index 51caac5..91055de 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/S.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/S.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="s")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Samp.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Samp.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Samp.java
index 8dfdbef..22c0204 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Samp.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Samp.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="samp")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Script.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Script.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Script.java
index b59999e..0eb9c6d 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Script.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Script.java
@@ -21,7 +21,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="script")
@@ -39,10 +39,10 @@ public class Script extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-async">async</a> attribute.
- *
+ *
* <p>
* Execute script asynchronously.
- *
+ *
* @param async
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -55,10 +55,10 @@ public class Script extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-charset">charset</a> attribute.
- *
+ *
* <p>
* Character encoding of the external script resource.
- *
+ *
* @param charset The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -70,10 +70,10 @@ public class Script extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-crossorigin">crossorigin</a>
* attribute.
- *
+ *
* <p>
* How the element handles cross-origin requests.
- *
+ *
* @param crossorigin The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -84,10 +84,10 @@ public class Script extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-defer">defer</a> attribute.
- *
+ *
* <p>
* Defer script execution.
- *
+ *
* @param defer
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -100,17 +100,17 @@ public class Script extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-src">src</a> attribute.
- *
+ *
* <p>
* Address of the resource.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param src
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
@@ -123,10 +123,10 @@ public class Script extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-script-type">type</a> attribute.
- *
+ *
* <p>
* Type of embedded resource.
- *
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Section.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Section.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Section.java
index 38c97ae..ea839e5 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Section.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Section.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="section")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Select.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Select.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Select.java
index 3e0da8e..c68f236 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Select.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Select.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="select")
@@ -35,10 +35,10 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autofocus">autofocus</a> attribute.
- *
+ *
* <p>
* Automatically focus the form control when the page is loaded.
- *
+ *
* @param autofocus
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -51,10 +51,10 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-disabled">disabled</a> attribute.
- *
+ *
* <p>
* Whether the form control is disabled.
- *
+ *
* @param disabled
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -67,10 +67,10 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
- *
+ *
* <p>
* Associates the control with a form element.
- *
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -81,10 +81,10 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-select-multiple">multiple</a> attribute.
- *
+ *
* <p>
* Whether to allow multiple values.
- *
+ *
* @param multiple
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -97,10 +97,10 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
- *
+ *
* <p>
* Name of form control to use for form submission and in the form.elements API.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -111,10 +111,10 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-select-required">required</a> attribute.
- *
+ *
* <p>
* Whether the control is required for form submission.
- *
+ *
* @param required
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -127,10 +127,10 @@ public class Select extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-select-size">size</a> attribute.
- *
+ *
* <p>
* Size of the control.
- *
+ *
* @param size
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Small.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Small.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Small.java
index eb40c63..b34f419 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Small.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Small.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="small")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Source.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Source.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Source.java
index 19e42f7..7b8ae8f 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Source.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Source.java
@@ -21,7 +21,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="source")
@@ -39,17 +39,17 @@ public class Source extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-source-src">src</a> attribute.
- *
+ *
* <p>
* Address of the resource.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param src
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
@@ -62,10 +62,10 @@ public class Source extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-source-type">type</a> attribute.
- *
+ *
* <p>
* Type of embedded resource.
- *
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Span.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Span.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Span.java
index c8b3a75..b3809f7 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Span.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Span.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="span")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Strong.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Strong.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Strong.java
index 364a90e..6c6ebb3 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Strong.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Strong.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="strong")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Style.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Style.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Style.java
index 23bddeb..725b07e 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Style.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Style.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="style")
@@ -35,10 +35,10 @@ public class Style extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-style-media">media</a> attribute.
- *
+ *
* <p>
* Applicable media.
- *
+ *
* @param media The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -49,10 +49,10 @@ public class Style extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-style-type">type</a> attribute.
- *
+ *
* <p>
* Type of embedded resource.
- *
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Sub.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Sub.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Sub.java
index 1d159d9..b724ab2 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Sub.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Sub.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="sub")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Sup.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Sup.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Sup.java
index 7224be9..d5269e6 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Sup.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Sup.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="sup")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Table.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Table.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Table.java
index 8f3db7e..5e61942 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Table.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Table.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="table")
@@ -35,7 +35,7 @@ public class Table extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-table-border">border</a> attribute.
- *
+ *
* @param border
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tbody.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tbody.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tbody.java
index b476ba7..0d2ca05 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tbody.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tbody.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="tbody")
[21/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectList.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectList.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectList.java
index e7f557c..8afd4a9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectList.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectList.java
@@ -23,10 +23,10 @@ import org.apache.juneau.utils.*;
/**
* Java implementation of a JSON array.
- *
+ *
* <p>
* An extension of {@link LinkedList}, so all methods available to in that class are also available to this class.
- *
+ *
* <p>
* Note that the use of this class is optional.
* The serializers will accept any objects that implement the {@link Collection} interface.
@@ -34,23 +34,23 @@ import org.apache.juneau.utils.*;
* Collections Framework objects.
* For example, a constructor is provided for converting a JSON array string directly into a {@link List}.
* It also contains accessor methods for to avoid common typecasting when accessing elements in a list.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct an empty List</jc>
* List l = <jk>new</jk> ObjectList();
- *
+ *
* <jc>// Construct a list of objects using various methods</jc>
* l = <jk>new</jk> ObjectList().append(<js>"foo"</js>).append(123).append(<jk>true</jk>);
* l = <jk>new</jk> ObjectList().append(<js>"foo"</js>, 123, <jk>true</jk>); <jc>// Equivalent</jc>
* l = <jk>new</jk> ObjectList(<js>"foo"</js>, 123, <jk>true</jk>); <jc>// Equivalent</jc>
- *
+ *
* <jc>// Construct a list of integers from JSON</jc>
* l = <jk>new</jk> ObjectList(<js>"[1,2,3]"</js>);
- *
+ *
* <jc>// Construct a list of generic ObjectMap objects from JSON</jc>
* l = <jk>new</jk> ObjectList(<js>"[{foo:'bar'},{baz:'bing'}]"</js>);
- *
+ *
* <jc>// Construct a list of integers from XML</jc>
* String xml = <js>"<array><number>1</number><number>2</number><number>3</number></array>"</js>;
* l = <jk>new</jk> ObjectList(xml, DataFormat.<jsf>XML</jsf>);
@@ -58,39 +58,39 @@ import org.apache.juneau.utils.*;
* l = (List)XmlParser.<jsf>DEFAULT</jsf>.parse(Object.<jk>class</jk>, xml); <jc>// Equivalent</jc>
* l = XmlParser.<jsf>DEFAULT</jsf>.parse(List.<jk>class</jk>, xml); <jc>// Equivalent</jc>
* l = XmlParser.<jsf>DEFAULT</jsf>.parse(ObjectList.<jk>class</jk>, xml); <jc>// Equivalent</jc>
- *
+ *
* <jc>// Construct JSON from ObjectList</jc>
* l = <jk>new</jk> ObjectList(<js>"[{foo:'bar'},{baz:'bing'}]"</js>);
* String json = l.toString(); <jc>// Produces "[{foo:'bar'},{baz:'bing'}]"</jc>
* json = l.toString(JsonSerializer.<jsf>DEFAULT_CONDENSED</jsf>); <jc>// Equivalent</jc>
* json = JsonSerializer.<jsf>DEFAULT_CONDENSED</jsf>.serialize(l); <jc>// Equivalent</jc>
- *
+ *
* <jc>// Get one of the entries in the list as an Integer</jc>
* l = <jk>new</jk> ObjectList(<js>"[1,2,3]"</js>);
* Integer i = l.getInt(1);
* i = l.get(Integer.<jk>class</jk>, 1); <jc>// Equivalent</jc>
- *
+ *
* <jc>// Get one of the entries in the list as an Float</jc>
* l = <jk>new</jk> ObjectList(<js>"[1,2,3]"</js>);
* Float f = l.getFloat(1); <jc>// Returns 2f </jc>
* f = l.get(Float.<jk>class</jk>, 1); <jc>// Equivalent</jc>
- *
+ *
* <jc>// Same as above, except converted to a String</jc>
* l = <jk>new</jk> ObjectList(<js>"[1,2,3]"</js>);
* String s = l.getString(1); <jc>// Returns "2" </jc>
* s = l.get(String.<jk>class</jk>, 1); <jc>// Equivalent</jc>
- *
+ *
* <jc>// Get one of the entries in the list as a bean (converted to a bean if it isn't already one)</jc>
* l = <jk>new</jk> ObjectList(<js>"[{name:'John Smith',age:45}]"</js>);
* Person p = l.get(Person.<jk>class</jk>, 0);
- *
+ *
* <jc>// Iterate over a list of beans using the elements() method</jc>
* ObjectList ObjectList = <jk>new</jk> ObjectList(<js>"[{name:'John Smith',age:45}]"</js>);
* <jk>for</jk> (Person p : ObjectList.elements(Person.<jk>class</jk>) {
* <jc>// Do something with p</jc>
* }
* </p>
- *
+ *
* <p>
* This class is not thread safe.
*/
@@ -134,7 +134,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Construct a JSON array directly from text using the specified parser.
- *
+ *
* @param s The string being parsed.
* @param p The parser to use to parse the input.
* @throws ParseException If the input contains a syntax error or is malformed.
@@ -154,7 +154,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Shortcut for <code><jk>new</jk> ObjectList(String,JsonParser.<jsf>DEFAULT</jsf>);</code>
- *
+ *
* @param s The string being parsed.
* @throws ParseException If the input contains a syntax error or is malformed.
*/
@@ -164,7 +164,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Construct a JSON array directly from a reader using the specified parser.
- *
+ *
* @param r
* The reader to read from.
* Will automatically be wrapped in a {@link BufferedReader} if it isn't already a BufferedReader.
@@ -179,7 +179,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Shortcut for <code><jk>new</jk> ObjectList(reader, JsonParser.<jsf>DEFAULT</jsf>)</code>.
- *
+ *
* @param r
* The reader to read from.
* The reader will be wrapped in a {@link BufferedReader} if it isn't already.
@@ -206,7 +206,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Construct an empty JSON array with the specified bean context. (i.e. an empty {@link LinkedList}).
- *
+ *
* @param session The bean context to associate with this object list for creating beans.
*/
public ObjectList(BeanSession session) {
@@ -216,7 +216,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Construct a JSON array and fill it with the specified objects.
- *
+ *
* @param o A list of objects to add to this list.
*/
public ObjectList(Object... o) {
@@ -225,7 +225,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Construct a JSON array and fill it with the specified collection of objects.
- *
+ *
* @param c A list of objects to add to this list.
*/
public ObjectList(Collection<?> c) {
@@ -234,13 +234,13 @@ public class ObjectList extends LinkedList<Object> {
/**
* Override the default bean session used for converting POJOs.
- *
+ *
* <p>
* Default is {@link BeanContext#DEFAULT}, which is sufficient in most cases.
- *
+ *
* <p>
* Useful if you're serializing/parsing beans with transforms defined.
- *
+ *
* @param session The new bean session.
* @return This object (for method chaining).
*/
@@ -251,7 +251,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Convenience method for adding multiple objects to this list.
- *
+ *
* @param o The objects to add to the list.
* @return This object (for method chaining).
*/
@@ -263,33 +263,33 @@ public class ObjectList extends LinkedList<Object> {
/**
* Get the entry at the specified index, converted to the specified type.
- *
+ *
* <p>
* This is the preferred get method for simple types.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* ObjectList l = <jk>new</jk> ObjectList(<js>"..."</js>);
- *
+ *
* <jc>// Value converted to a string.</jc>
* String s = l.get(1, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a bean.</jc>
* MyBean b = l.get(2, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a bean array.</jc>
* MyBean[] ba = l.get(3, MyBean[].<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a linked-list of objects.</jc>
* List l1 = l.get(4, LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a map of object keys/values.</jc>
* Map m1 = l.get(5, TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
- *
+ *
* @param index The index into this list.
* @param type The type of object to convert the entry to.
* @param <T> The type of object to convert the entry to.
@@ -301,42 +301,42 @@ public class ObjectList extends LinkedList<Object> {
/**
* Get the entry at the specified index, converted to the specified type.
- *
+ *
* <p>
* The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* ObjectList l = <jk>new</jk> ObjectList(<js>"..."</js>);
- *
+ *
* <jc>// Value converted to a linked-list of strings.</jc>
* List<String> l1 = l.get(1, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a linked-list of beans.</jc>
* List<MyBean> l2 = l.get(2, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a linked-list of linked-lists of strings.</jc>
* List<List<String>> l3 = l.get(3, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a map of string keys/values.</jc>
* Map<String,String> m1 = l.get(4, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a map containing string keys and values of lists containing beans.</jc>
* Map<String,List<MyBean>> m2 = l.get(5, 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>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
- *
+ *
* @param index The index into this list.
* @param type The type of object to convert the entry to.
* @param args The type arguments of the type to convert the entry to.
@@ -349,7 +349,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Shortcut for calling <code>get(index, String.<jk>class</jk>)</code>.
- *
+ *
* @param index The index.
* @return The converted value.
*/
@@ -359,7 +359,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Shortcut for calling <code>get(index, Integer.<jk>class</jk>)</code>.
- *
+ *
* @param index The index.
* @return The converted value.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -370,7 +370,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Shortcut for calling <code>get(index, Boolean.<jk>class</jk>)</code>.
- *
+ *
* @param index The index.
* @return The converted value.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -381,7 +381,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Shortcut for calling <code>get(index, Long.<jk>class</jk>)</code>.
- *
+ *
* @param index The index.
* @return The converted value.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -392,7 +392,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Shortcut for calling <code>get(index, Map.<jk>class</jk>)</code>.
- *
+ *
* @param index The index.
* @return The converted value.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -403,7 +403,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Same as {@link #getMap(int)} except converts the keys and values to the specified types.
- *
+ *
* @param index The index.
* @param keyType The key type class.
* @param valType The value type class.
@@ -416,7 +416,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Shortcut for calling <code>get(index, List.<jk>class</jk>)</code>.
- *
+ *
* @param index The index.
* @return The converted value.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -427,7 +427,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Same as {@link #getList(int)} except converts the elements to the specified types.
- *
+ *
* @param index The index.
* @param elementType The element type class.
* @return The converted value.
@@ -439,7 +439,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Shortcut for calling <code>get(index, ObjectMap.<jk>class</jk>)</code>.
- *
+ *
* @param index The index.
* @return The converted value.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -450,7 +450,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Shortcut for calling <code>get(index, ObjectList.<jk>class</jk>)</code>.
- *
+ *
* @param index The index.
* @return The converted value.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -462,27 +462,27 @@ public class ObjectList extends LinkedList<Object> {
/**
* Same as {@link #get(int,Class) get(int,Class)}, but the key is a slash-delimited path used to traverse entries in
* this POJO.
- *
+ *
* <p>
* For example, the following code is equivalent:
* </p>
* <p class='bcode'>
* ObjectMap m = getObjectMap();
- *
+ *
* <jc>// Long way</jc>
* <jk>long</jk> l = m.getObjectMap(<js>"foo"</js>).getObjectList(<js>"bar"</js>).getObjectMap(<js>"0"</js>).getLong(<js>"baz"</js>);
- *
+ *
* <jc>// Using this method</jc>
* <jk>long</jk> l = m.getAt(<js>"foo/bar/0/baz"</js>, <jk>long</jk>.<jk>class</jk>);
* </p>
- *
+ *
* <p>
* This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
* class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
- *
+ *
* @param path The path to the entry.
* @param type The class type.
- *
+ *
* @param <T> The class type.
* @return The value, or <jk>null</jk> if the entry doesn't exist.
*/
@@ -492,11 +492,11 @@ public class ObjectList extends LinkedList<Object> {
/**
* Same as {@link #getAt(String,Class)}, but allows for conversion to complex maps and collections.
- *
+ *
* @param path The path to the entry.
* @param type The class type.
* @param args The class parameter types.
- *
+ *
* @param <T> The class type.
* @return The value, or <jk>null</jk> if the entry doesn't exist.
*/
@@ -507,24 +507,24 @@ public class ObjectList extends LinkedList<Object> {
/**
* Same as {@link #set(int,Object) set(int,Object)}, but the key is a slash-delimited path used to traverse entries
* in this POJO.
- *
+ *
* <p>
* For example, the following code is equivalent:
* </p>
* <p class='bcode'>
* ObjectMap m = getObjectMap();
- *
+ *
* <jc>// Long way</jc>
* m.getObjectMap(<js>"foo"</js>).getObjectList(<js>"bar"</js>).getObjectMap(<js>"0"</js>).put(<js>"baz"</js>, 123);
- *
+ *
* <jc>// Using this method</jc>
* m.putAt(<js>"foo/bar/0/baz"</js>, 123);
* </p>
- *
+ *
* <p>
* This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
* class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
- *
+ *
* @param path The path to the entry.
* @param o The new value.
* @return The previous value, or <jk>null</jk> if the entry doesn't exist.
@@ -535,24 +535,24 @@ public class ObjectList extends LinkedList<Object> {
/**
* Similar to {@link #putAt(String,Object) putAt(String,Object)}, but used to append to collections and arrays.
- *
+ *
* <p>
* For example, the following code is equivalent:
* </p>
* <p class='bcode'>
* ObjectMap m = getObjectMap();
- *
+ *
* <jc>// Long way</jc>
* m.getObjectMap(<js>"foo"</js>).getObjectList(<js>"bar"</js>).append(123);
- *
+ *
* <jc>// Using this method</jc>
* m.postAt(<js>"foo/bar"</js>, 123);
* </p>
- *
+ *
* <p>
* This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
* class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
- *
+ *
* @param path The path to the entry.
* @param o The new value.
* @return The previous value, or <jk>null</jk> if the entry doesn't exist.
@@ -564,24 +564,24 @@ public class ObjectList extends LinkedList<Object> {
/**
* Similar to {@link #remove(int) remove(int)},but the key is a slash-delimited path used to traverse entries in
* this POJO.
- *
+ *
* <p>
* For example, the following code is equivalent:
* </p>
* <p class='bcode'>
* ObjectMap m = getObjectMap();
- *
+ *
* <jc>// Long way</jc>
* m.getObjectMap(<js>"foo"</js>).getObjectList(<js>"bar"</js>).getObjectMap(1).remove(<js>"baz"</js>);
- *
+ *
* <jc>// Using this method</jc>
* m.deleteAt(<js>"foo/bar/0/baz"</js>);
* </p>
- *
+ *
* <p>
* This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
* class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
- *
+ *
* @param path The path to the entry.
* @return The previous value, or <jk>null</jk> if the entry doesn't exist.
*/
@@ -591,17 +591,17 @@ public class ObjectList extends LinkedList<Object> {
/**
* Creates an {@link Iterable} with elements of the specified child type.
- *
+ *
* <p>
* Attempts to convert the child objects to the correct type if they aren't already the correct type.
- *
+ *
* <p>
* The <code>next()</code> method on the returned iterator may throw a {@link InvalidDataConversionException} if
* the next element cannot be converted to the specified type.
- *
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for a description of valid conversions.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Iterate over a list of ObjectMaps.</jc>
@@ -609,13 +609,13 @@ public class ObjectList extends LinkedList<Object> {
* for (ObjectMap m : l.elements(ObjectMap.<jk>class</jk>)) {
* <jc>// Do something with m.</jc>
* }
- *
+ *
* <jc>// Iterate over a list of ints.</jc>
* ObjectList l = <jk>new</jk> ObjectList(<js>"[1,2,3]"</js>);
* for (Integer i : l.elements(Integer.<jk>class</jk>)) {
* <jc>// Do something with i.</jc>
* }
- *
+ *
* <jc>// Iterate over a list of beans.</jc>
* <jc>// Automatically converts to beans.</jc>
* ObjectList l = <jk>new</jk> ObjectList(<js>"[{name:'John Smith',age:45}]"</js>);
@@ -623,7 +623,7 @@ public class ObjectList extends LinkedList<Object> {
* <jc>// Do something with p.</jc>
* }
* </p>
- *
+ *
* @param <E> The child object type.
* @param childType The child object type.
* @return A new <code>Iterable</code> object over this list.
@@ -658,7 +658,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Returns the {@link ClassMeta} of the class of the object at the specified index.
- *
+ *
* @param index An index into this list, zero-based.
* @return The data type of the object at the specified index, or <jk>null</jk> if the value is null.
*/
@@ -674,7 +674,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Serialize this array to a string using the specified serializer.
- *
+ *
* @param serializer The serializer to use to convert this object to a string.
* @return This object as a serialized string.
* @throws SerializeException If a problem occurred trying to convert the output.
@@ -698,7 +698,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Convenience method for serializing this ObjectList to the specified Writer using the JsonSerializer.DEFAULT
* serializer.
- *
+ *
* @param w The writer to send the serialized contents of this object.
* @throws IOException If a problem occurred trying to write to the writer.
* @throws SerializeException If a problem occurred trying to convert the output.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectMap.java
index 6c45010..272433c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectMap.java
@@ -28,7 +28,7 @@ import org.apache.juneau.utils.*;
/**
* Java implementation of a JSON object.
- *
+ *
* <p>
* An extension of {@link LinkedHashMap}, so all methods available in that class are also available to this class.
* <p>
@@ -38,20 +38,20 @@ import org.apache.juneau.utils.*;
* Collections Framework objects.
* For example, a constructor is provided for converting a JSON object string directly into a {@link Map}.
* It also contains accessor methods for to avoid common typecasting when accessing elements in a list.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct an empty Map</jc>
* Map m = <jk>new</jk> ObjectMap();
- *
+ *
* <jc>// Construct a Map from JSON</jc>
* String json = <js>"{a:'A',b:{c:'C',d:123}}"</js>;
* m = <jk>new</jk> ObjectMap(json);
- *
+ *
* <jc>// Construct a Map using the append method</jc>
* m = <jk>new</jk> ObjectMap().append(<js>"foo"</js>,<js>"x"</js>).append(<js>"bar"</js>,123)
* .append(<js>"baz"</js>,<jk>true</jk>);
- *
+ *
* <jc>// Construct a Map from XML generated by XmlSerializer</jc>
* String xml = <js>"<object><a type='string'>A</a><b type='object'><c type='string'>C</c><d type='number'>123</d></b></object>"</js>;
* m = <jk>new</jk> ObjectMap(xml, DataFormat.<jsf>XML</jsf>);
@@ -59,45 +59,45 @@ import org.apache.juneau.utils.*;
* m = (Map)XmlParser.<jsf>DEFAULT</jsf>.parse(Object.<jk>class</jk>, xml); <jc>// Equivalent</jc>
* m = XmlParser.<jsf>DEFAULT</jsf>.parse(Map.<jk>class</jk>, xml); <jc>// Equivalent</jc>
* m = XmlParser.<jsf>DEFAULT</jsf>.parse(ObjectMap.<jk>class</jk>, xml); <jc>// Equivalent</jc>
- *
+ *
* <jc>// Construct a Map from a URL GET parameter string generated by UrlEncodingParser</jc>
* String urlParams = <js>"?a='A'&b={c:'C',d:123}"</js>;
* m = <jk>new</jk> ObjectMap(urlParams, DataFormat.<jsf>URLPARAM</jsf>);
* m = (Map)UrlEncodingParser.<jsf>DEFAULT</jsf>.parse(Object.<jk>class</jk>, xml); <jc>// Equivalent</jc>
* m = UrlEncodingParser.<jsf>DEFAULT</jsf>.parse(Map.<jk>class</jk>, xml); <jc>// Equivalent</jc>
* m = UrlEncodingParser.<jsf>DEFAULT</jsf>.parse(ObjectMap.<jk>class</jk>, xml); <jc>// Equivalent</jc>
- *
+ *
* <jc>// Construct JSON from ObjectMap</jc>
* m = <jk>new</jk> ObjectMap(<js>"{foo:'bar'},{baz:[123,true]}"</js>);
* json = m.toString(); <jc>// Produces "{foo:'bar'},{baz:[123,true]}"</jc>
* json = m.toString(JsonSerializer.<jsf>DEFAULT_CONDENSED</jsf>); <jc>// Equivalent</jc>
* json = JsonSerializer.<jsf>DEFAULT_CONDENSED</jsf>.serialize(m); <jc>// Equivalent</jc>
- *
+ *
* <jc>// Get a map entry as an Integer</jc>
* m = <jk>new</jk> ObjectMap(<js>"{foo:123}"</js>);
* Integer i = m.getInt(<js>"foo"</js>);
* i = m.get(Integer.<jk>class</jk>, <js>"foo"</js>); <jc>// Equivalent</jc>
- *
+ *
* <jc>// Get a map entry as a Float</jc>
* m = <jk>new</jk> ObjectMap(<js>"{foo:123}"</js>);
* Float f = m.getFloat(<js>"foo"</js>);
* f = m.get(Float.<jk>class</jk>, <js>"foo"</js>); <jc>// Equivalent</jc>
- *
+ *
* <jc>// Same as above, except converted to a String</jc>
* m = <jk>new</jk> ObjectMap(<js>"{foo:123}"</js>);
* String s = m.getString(<js>"foo"</js>); <jc>// Returns "123"</jc>
* s = m.get(String.<jk>class</jk>, <js>"foo"</js>); <jc>// Equivalent</jc>
- *
+ *
* <jc>// Get one of the entries in the list as a bean (converted to a bean if it isn't already one)</jc>
* m = <jk>new</jk> ObjectMap(<js>"{person:{name:'John Smith',age:45}}"</js>);
* Person p = m.get(Person.<jk>class</jk>, <js>"person"</js>);
- *
+ *
* <jc>// Add an inner map</jc>
* ObjectMap m1 = <jk>new</jk> ObjectMap(<js>"{a:1}"</js>);
* ObjectMap m2 = <jk>new</jk> ObjectMap(<js>"{b:2}"</js>).setInner(m1);
* <jk>int</jk> a = m2.getInt(<js>"a"</js>); <jc>// a == 1 </jc>
* </p>
- *
+ *
* <p>
* This class is not thread safe.
*/
@@ -143,7 +143,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Construct an ObjectMap directly from a string using the specified parser.
- *
+ *
* @param s The string being parsed.
* @param p The parser to use to parse the input.
* @throws ParseException If the input contains a syntax error or is malformed.
@@ -163,7 +163,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Shortcut for <code><jk>new</jk> ObjectMap(string,JsonParser.<jsf>DEFAULT</jsf>);</code>
- *
+ *
* @param s The JSON text to parse.
* @throws ParseException If the input contains a syntax error or is malformed.
*/
@@ -173,7 +173,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Construct an ObjectMap directly from a reader using the specified parser.
- *
+ *
* @param r The reader to read from. The reader will be wrapped in a {@link BufferedReader} if it isn't already.
* @param p The parser to use to parse the input.
* @throws ParseException If the input contains a syntax error or is malformed.
@@ -186,7 +186,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Shortcut for <code><jk>new</jk> ObjectMap(reader, JsonParser.<jsf>DEFAULT</jsf>)</code>.
- *
+ *
* @param r The reader to read from. The reader will be wrapped in a {@link BufferedReader} if it isn't already.
* @throws ParseException If the input contains a syntax error or is malformed.
* @throws IOException If a problem occurred trying to read from the reader.
@@ -211,7 +211,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Construct an empty JSON object (i.e. an empty {@link LinkedHashMap}) with the specified bean context.
- *
+ *
* @param session The bean session to use for creating beans.
*/
public ObjectMap(BeanSession session) {
@@ -220,7 +220,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Construct a JSON object and fill it with the contents from the specified {@link Map}.
- *
+ *
* @param m The map whose entries will be copied into this map.
*/
public ObjectMap(Map<?,?> m) {
@@ -231,14 +231,14 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Set an inner map in this map to allow for chained get calls.
- *
+ *
* <p>
* If {@link #get(Object)} returns <jk>null</jk>, then {@link #get(Object)} will be called on the inner map.
- *
+ *
* <p>
* In addition to providing the ability to chain maps, this method also provides the ability to wrap an existing map
* inside another map so that you can add entries to the outer map without affecting the values on the inner map.
- *
+ *
* <p class='bcode'>
* ObjectMap m1 = <jk>new</jk> ObjectMap(<js>"{foo:1}"</js>);
* ObjectMap m2 = <jk>new</jk> ObjectMap().setInner(m1);
@@ -246,7 +246,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* <jk>int</jk> foo1 = m1.getInt(<js>"foo"</js>); <jc>// foo1 == 1 </jc>
* <jk>int</jk> foo2 = m2.getInt(<js>"foo"</js>); <jc>// foo2 == 2 </jc>
* </p>
- *
+ *
* @param inner
* The inner map.
* Can be <jk>null</jk> to remove the inner map from an existing map.
@@ -259,7 +259,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Searches for the specified key in this map ignoring case.
- *
+ *
* @param key
* The key to search for.
* For performance reasons, it's preferable that the key be all lowercase.
@@ -274,13 +274,13 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Override the default bean session used for converting POJOs.
- *
+ *
* <p>
* Default is {@link BeanContext#DEFAULT}, which is sufficient in most cases.
- *
+ *
* <p>
* Useful if you're serializing/parsing beans with transforms defined.
- *
+ *
* @param session The new bean session.
* @return This object (for method chaining).
*/
@@ -291,7 +291,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the {@link BeanSession} currently associated with this map.
- *
+ *
* @return The {@link BeanSession} currently associated with this map.
*/
public BeanSession getBeanSession() {
@@ -300,10 +300,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Convenience method for adding multiple objects to this map.
- *
+ *
* <p>
* Equivalent to calling {@code put(key, value)}, but returns this map so that the method can be chained.
- *
+ *
* @param key The key.
* @param value The value.
* @return This object (for method chaining).
@@ -315,10 +315,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Convenience method for adding a contents of another map to this map.
- *
+ *
* <p>
* Equivalent to calling {@code putAll(m)}, but returns this map so that the method can be chained.
- *
+ *
* @param m The map whose contents should be added to this map.
* @return This object (for method chaining).
*/
@@ -337,33 +337,33 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link Map#get(Object) get()}, but casts or converts the value to the specified class type.
- *
+ *
* <p>
* This is the preferred get method for simple types.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* ObjectMap m = <jk>new</jk> ObjectMap(<js>"..."</js>);
- *
+ *
* <jc>// Value converted to a string.</jc>
* String s = m.get(<js>"key1"</js>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a bean.</jc>
* MyBean b = m.get(<js>"key2"</js>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a bean array.</jc>
* MyBean[] ba = m.get(<js>"key3"</js>, MyBean[].<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a linked-list of objects.</jc>
* List l = m.get(<js>"key4"</js>, LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a map of object keys/values.</jc>
* Map m2 = m.get(<js>"key5"</js>, TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
- *
+ *
* @param key The key.
* @param <T> The class type returned.
* @param type The class type returned.
@@ -375,47 +375,47 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link #get(String,Class)}, but allows for complex data types consisting of collections or maps.
- *
+ *
* <p>
* The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* ObjectMap m = <jk>new</jk> ObjectMap(<js>"..."</js>);
- *
+ *
* <jc>// Value converted to a linked-list of strings.</jc>
* List<String> l1 = m.get(<js>"key1"</js>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a linked-list of beans.</jc>
* List<MyBean> l2 = m.get(<js>"key2"</js>, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a linked-list of linked-lists of strings.</jc>
* List<List<String>> l3 = m.get(<js>"key3"</js>, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a map of string keys/values.</jc>
* Map<String,String> m1 = m.get(<js>"key4"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a map containing string keys and values of lists containing beans.</jc>
* Map<String,List<MyBean>> m2 = m.get(<js>"key5"</js>, 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>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Use the {@link #get(String, Class)} method instead if you don't need a parameterized map/collection.
* </ul>
- *
+ *
* @param key The key.
* @param <T> The class type returned.
* @param type The class type returned.
@@ -428,7 +428,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link Map#get(Object) get()}, but returns the default value if the key could not be found.
- *
+ *
* @param key The key.
* @param def The default value if the entry doesn't exist.
* @return The value, or the default value if the entry doesn't exist.
@@ -440,7 +440,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link #get(String,Class)} but returns a default value if the value does not exist.
- *
+ *
* @param key The key.
* @param def The default value. Can be <jk>null</jk>.
* @param <T> The class type returned.
@@ -453,7 +453,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link #get(String,Type,Type...)} but returns a default value if the value does not exist.
- *
+ *
* @param key The key.
* @param def The default value. Can be <jk>null</jk>.
* @param <T> The class type returned.
@@ -470,7 +470,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link Map#get(Object) get()}, but converts the raw value to the specified class type using the specified
* POJO swap.
- *
+ *
* @param key The key.
* @param pojoSwap The swap class used to convert the raw type to a transformed type.
* @param <T> The transformed class type.
@@ -494,7 +494,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the value for the first key in the list that has an entry in this map.
- *
+ *
* @param keys The keys to look up in order.
* @return The value of the first entry whose key exists, or <jk>null</jk> if none of the keys exist in this map.
*/
@@ -507,13 +507,13 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the value for the first key in the list that has an entry in this map.
- *
+ *
* <p>
* Casts or converts the value to the specified class type.
- *
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
- *
+ *
* @param type The class type to convert the value to.
* @param <T> The class type to convert the value to.
* @param keys The keys to look up in order.
@@ -529,28 +529,28 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link #get(String,Class) get(String,Class)}, but the key is a slash-delimited path used to traverse
* entries in this POJO.
- *
+ *
* <p>
* For example, the following code is equivalent:
* </p>
* <p class='bcode'>
* ObjectMap m = getObjectMap();
- *
+ *
* <jc>// Long way</jc>
* <jk>long</jk> l = m.getObjectMap(<js>"foo"</js>).getObjectList(<js>"bar"</js>).getObjectMap(<js>"0"</js>)
* .getLong(<js>"baz"</js>);
- *
+ *
* <jc>// Using this method</jc>
* <jk>long</jk> l = m.getAt(<js>"foo/bar/0/baz"</js>, <jk>long</jk>.<jk>class</jk>);
* </p>
- *
+ *
* <p>
* This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
* class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
- *
+ *
* @param path The path to the entry.
* @param type The class type.
- *
+ *
* @param <T> The class type.
* @return The value, or <jk>null</jk> if the entry doesn't exist.
*/
@@ -560,15 +560,15 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link #getAt(String,Class)}, but allows for conversion to complex maps and collections.
- *
+ *
* <p>
* This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
* class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
- *
+ *
* @param path The path to the entry.
* @param type The class type.
* @param args The class parameter types.
- *
+ *
* @param <T> The class type.
* @return The value, or <jk>null</jk> if the entry doesn't exist.
*/
@@ -579,25 +579,25 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as <code>put(String,Object)</code>, but the key is a slash-delimited path used to traverse entries in this
* POJO.
- *
+ *
* <p>
* For example, the following code is equivalent:
* </p>
* <p class='bcode'>
* ObjectMap m = getObjectMap();
- *
+ *
* <jc>// Long way</jc>
* m.getObjectMap(<js>"foo"</js>).getObjectList(<js>"bar"</js>).getObjectMap(<js>"0"</js>)
* .put(<js>"baz"</js>, 123);
- *
+ *
* <jc>// Using this method</jc>
* m.putAt(<js>"foo/bar/0/baz"</js>, 123);
* </p>
- *
+ *
* <p>
* This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
* class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
- *
+ *
* @param path The path to the entry.
* @param o The new value.
* @return The previous value, or <jk>null</jk> if the entry doesn't exist.
@@ -608,24 +608,24 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Similar to {@link #putAt(String,Object) putAt(String,Object)}, but used to append to collections and arrays.
- *
+ *
* <p>
* For example, the following code is equivalent:
* </p>
* <p class='bcode'>
* ObjectMap m = getObjectMap();
- *
+ *
* <jc>// Long way</jc>
* m.getObjectMap(<js>"foo"</js>).getObjectList(<js>"bar"</js>).append(123);
- *
+ *
* <jc>// Using this method</jc>
* m.postAt(<js>"foo/bar"</js>, 123);
* </p>
- *
+ *
* <p>
* This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
* class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
- *
+ *
* @param path The path to the entry.
* @param o The new value.
* @return The previous value, or <jk>null</jk> if the entry doesn't exist.
@@ -637,24 +637,24 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Similar to {@link #remove(Object) remove(Object)}, but the key is a slash-delimited path used to traverse entries
* in this POJO.
- *
+ *
* <p>
* For example, the following code is equivalent:
* </p>
* <p class='bcode'>
* ObjectMap m = getObjectMap();
- *
+ *
* <jc>// Long way</jc>
* m.getObjectMap(<js>"foo"</js>).getObjectList(<js>"bar"</js>).getObjectMap(0).remove(<js>"baz"</js>);
- *
+ *
* <jc>// Using this method</jc>
* m.deleteAt(<js>"foo/bar/0/baz"</js>);
* </p>
- *
+ *
* <p>
* This method uses the {@link PojoRest} class to perform the lookup, so the map can contain any of the various
* class types that the {@link PojoRest} class supports (e.g. beans, collections, arrays).
- *
+ *
* @param path The path to the entry.
* @return The previous value, or <jk>null</jk> if the entry doesn't exist.
*/
@@ -664,10 +664,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Convenience method for inserting JSON directly into an attribute on this object.
- *
+ *
* <p>
* The JSON text can be an object (i.e. <js>"{...}"</js>) or an array (i.e. <js>"[...]"</js>).
- *
+ *
* @param key The key.
* @param json The JSON text that will be parsed into an Object and then inserted into this map.
* @throws ParseException If the input contains a syntax error or is malformed.
@@ -678,10 +678,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link String}.
- *
+ *
* <p>
* Shortcut for <code>get(key, String.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
*/
@@ -691,10 +691,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link String}.
- *
+ *
* <p>
* Shortcut for <code>get(key, String[].<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
*/
@@ -704,7 +704,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link #getStringArray(String)} but returns a default value if the value cannot be found.
- *
+ *
* @param key The map key.
* @param def The default value if value is not found.
* @return The value converted to a string array.
@@ -727,10 +727,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link String}.
- *
+ *
* <p>
* Shortcut for <code>getWithDefault(key, defVal, String.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -741,10 +741,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to an {@link Integer}.
- *
+ *
* <p>
* Shortcut for <code>get(key, Integer.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -755,10 +755,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to an {@link Integer}.
- *
+ *
* <p>
* Shortcut for <code>getWithDefault(key, defVal, Integer.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -770,10 +770,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Long}.
- *
+ *
* <p>
* Shortcut for <code>get(key, Long.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -784,10 +784,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Long}.
- *
+ *
* <p>
* Shortcut for <code>getWithDefault(key, defVal, Long.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -799,10 +799,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Boolean}.
- *
+ *
* <p>
* Shortcut for <code>get(key, Boolean.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -813,10 +813,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Boolean}.
- *
+ *
* <p>
* Shortcut for <code>getWithDefault(key, defVal, Boolean.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -828,10 +828,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Map}.
- *
+ *
* <p>
* Shortcut for <code>get(key, Map.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -842,10 +842,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Map}.
- *
+ *
* <p>
* Shortcut for <code>getWithDefault(key, defVal, Map.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -857,7 +857,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link #getMap(String, Map)} except converts the keys and values to the specified types.
- *
+ *
* @param key The key.
* @param keyType The key type class.
* @param valType The value type class.
@@ -874,10 +874,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link List}.
- *
+ *
* <p>
* Shortcut for <code>get(key, List.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -888,10 +888,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link List}.
- *
+ *
* <p>
* Shortcut for <code>getWithDefault(key, defVal, List.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -903,7 +903,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link #getList(String, List)} except converts the elements to the specified types.
- *
+ *
* @param key The key.
* @param elementType The element type class.
* @param def The default value if the map doesn't contain the specified mapping.
@@ -919,10 +919,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Map}.
- *
+ *
* <p>
* Shortcut for <code>get(key, ObjectMap.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -933,10 +933,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link ObjectMap}.
- *
+ *
* <p>
* Shortcut for <code>getWithDefault(key, defVal, ObjectMap.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -948,10 +948,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link ObjectList}.
- *
+ *
* <p>
* Shortcut for <code>get(key, ObjectList.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -962,10 +962,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link ObjectList}.
- *
+ *
* <p>
* Shortcut for <code>getWithDefault(key, defVal, ObjectList.<jk>class</jk>)</code>.
- *
+ *
* @param key The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -977,10 +977,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link String}.
- *
+ *
* <p>
* Shortcut for <code>find(String.<jk>class</jk>, keys)</code>.
- *
+ *
* @param keys The list of keys to look for.
* @return
* The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
@@ -992,10 +992,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to an {@link Integer}.
- *
+ *
* <p>
* Shortcut for <code>find(Integer.<jk>class</jk>, keys)</code>.
- *
+ *
* @param keys The list of keys to look for.
* @return
* The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
@@ -1008,10 +1008,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link Long}.
- *
+ *
* <p>
* Shortcut for <code>find(Long.<jk>class</jk>, keys)</code>.
- *
+ *
* @param keys The list of keys to look for.
* @return
* The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
@@ -1024,10 +1024,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link Boolean}.
- *
+ *
* <p>
* Shortcut for <code>find(Boolean.<jk>class</jk>, keys)</code>.
- *
+ *
* @param keys The list of keys to look for.
* @return
* The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
@@ -1040,10 +1040,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link Map}.
- *
+ *
* <p>
* Shortcut for <code>find(Map.<jk>class</jk>, keys)</code>.
- *
+ *
* @param keys The list of keys to look for.
* @return
* The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
@@ -1056,10 +1056,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link List}.
- *
+ *
* <p>
* Shortcut for <code>find(List.<jk>class</jk>, keys)</code>.
- *
+ *
* @param keys The list of keys to look for.
* @return
* The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
@@ -1072,10 +1072,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link ObjectMap}.
- *
+ *
* <p>
* Shortcut for <code>find(ObjectMap.<jk>class</jk>, keys)</code>.
- *
+ *
* @param keys The list of keys to look for.
* @return
* The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
@@ -1088,10 +1088,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first entry that exists converted to a {@link ObjectList}.
- *
+ *
* <p>
* Shortcut for <code>find(ObjectList.<jk>class</jk>, keys)</code>.
- *
+ *
* @param keys The list of keys to look for.
* @return
* The converted value of the first key in the list that has an entry in this map, or <jk>null</jk> if the map
@@ -1104,7 +1104,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the first key in the map.
- *
+ *
* @return The first key in the map, or <jk>null</jk> if the map is empty.
*/
public String getFirstKey() {
@@ -1113,7 +1113,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the class type of the object at the specified index.
- *
+ *
* @param key The key into this map.
* @return
* The data type of the object at the specified key, or <jk>null</jk> if the value is null or does not exist.
@@ -1127,7 +1127,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* @param key The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @param type The class type.
- *
+ *
* @param <T> The class type.
* @return The converted value, or the default value if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -1141,7 +1141,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Convenience method for removing several keys at once.
- *
+ *
* @param keys The list of keys to remove.
*/
public void removeAll(Collection<String> keys) {
@@ -1151,7 +1151,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Convenience method for removing several keys at once.
- *
+ *
* @param keys The list of keys to remove.
*/
public void removeAll(String... keys) {
@@ -1170,7 +1170,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns <jk>true</jk> if this map contains the specified key, ignoring the inner map if it exists.
- *
+ *
* @param key The key to look up.
* @return <jk>true</jk> if this map contains the specified key.
*/
@@ -1180,7 +1180,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns a copy of this <code>ObjectMap</code> with only the specified keys.
- *
+ *
* @param keys The keys of the entries to copy.
* @return A new map with just the keys and values from this map.
*/
@@ -1195,7 +1195,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns a copy of this <code>ObjectMap</code> without the specified keys.
- *
+ *
* @param keys The keys of the entries not to copy.
* @return A new map without the keys and values from this map.
*/
@@ -1214,7 +1214,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Sets a value in this map if the entry does not exist or the value is <jk>null</jk>.
- *
+ *
* @param key The map key.
* @param val The value to set if the current value does not exist or is <jk>null</jk>.
* @return This object (for method chaining).
@@ -1228,7 +1228,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Sets a value in this map if the entry does not exist or the value is <jk>null</jk> or an empty string.
- *
+ *
* @param key The map key.
* @param val The value to set if the current value does not exist or is <jk>null</jk> or an empty string.
* @return This object (for method chaining).
@@ -1242,10 +1242,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Converts this map into an object of the specified type.
- *
+ *
* <p>
* If this map contains a <js>"_type"</js> entry, it must be the same as or a subclass of the <code>type</code>.
- *
+ *
* @param <T> The class type to convert this map object to.
* @param type The class type to convert this map object to.
* @return The new object.
@@ -1265,7 +1265,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Same as {@link #cast(Class)}, except allows you to specify a {@link ClassMeta} parameter.
- *
+ *
* @param <T> The class type to convert this map object to.
* @param cm The class type to convert this map object to.
* @return The new object.
@@ -1385,7 +1385,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Serialize this object into a string using the specified serializer.
- *
+ *
* @param serializer The serializer to use to convert this object to a string.
* @return This object serialized as a string.
* @throws SerializeException If a problem occurred trying to convert the output.
@@ -1409,7 +1409,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Convenience method for serializing this map to the specified <code>Writer</code> using the
* {@link JsonSerializer#DEFAULT} serializer.
- *
+ *
* @param w The writer to serialize this object to.
* @return This object (for method chaining).
* @throws IOException If a problem occurred trying to write to the writer.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamer.java
index 7863f2a..0a2ebe2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamer.java
@@ -16,11 +16,11 @@ import org.apache.juneau.annotation.*;
/**
* Defines an API for converting conventional bean property names to some other form.
- *
+ *
* <p>
* For example, given the bean property <js>"fooBarURL"</js>, the {@link PropertyNamerDLC} property namer will convert
* this to <js>"foo-bar-url"</js>.
- *
+ *
* <p>
* Property namers are associated with beans through the {@link Bean#propertyNamer @Bean.propertyNamer()} annotation.
*/
@@ -28,7 +28,7 @@ public interface PropertyNamer {
/**
* Convert the specified default property name to some other value.
- *
+ *
* @param name The original bean property name.
* @return The converted property name.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerDLC.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerDLC.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerDLC.java
index db21ed7..910be07 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerDLC.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerDLC.java
@@ -14,8 +14,8 @@ package org.apache.juneau;
/**
* Converts property names to dashed-lower-case format.
- *
- * <h5 class='section'>Examples:</h5>
+ *
+ * <h5 class='section'>Example:</h5>
* <ul>
* <li><js>"fooBar"</js> -> <js>"foo-bar"</js>
* <li><js>"fooBarURL"</js> -> <js>"foo-bar-url"</js>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerDefault.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerDefault.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerDefault.java
index 2b6e18f..3e5a6b3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerDefault.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerDefault.java
@@ -16,15 +16,15 @@ import java.beans.*;
/**
* Default property namer.
- *
- * <h5 class='section'>Examples:</h5>
+ *
+ * <h5 class='section'>Example:</h5>
* <ul>
* <li><js>"fooBar"</js> -> <js>"fooBar"</js>
* <li><js>"fooBarURL"</js> -> <js>"fooBarURL"</js>
* <li><js>"FooBarURL"</js> -> <js>"fooBarURL"</js>
* <li><js>"URL"</js> -> <js>"URL"</js>
* </ul>
- *
+ *
* <p>
* See {@link Introspector#decapitalize(String)} for exact rules.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerULC.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerULC.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerULC.java
index e5a4672..2d9cfcc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerULC.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyNamerULC.java
@@ -14,8 +14,8 @@ package org.apache.juneau;
/**
* Converts property names to underscore-lower-case format.
- *
- * <h5 class='section'>Examples:</h5>
+ *
+ * <h5 class='section'>Example:</h5>
* <ul>
* <li><js>"fooBar"</js> -> <js>"foo_bar"</js>
* <li><js>"fooBarURL"</js> -> <js>"foo_bar_url"</js>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyStore.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyStore.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyStore.java
index ef7c8bf..34640ec 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyStore.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyStore.java
@@ -29,7 +29,8 @@ import org.apache.juneau.json.*;
* The general idea behind a property store is to serve as a reusable configuration of an artifact (e.g. a Serializer)
* such that the artifact can be cached and reused if the property stores are 'equal'.
*
- * <h6 class='topic'>Concept</h6>
+ *
+ * <h5 class='topic'>Concept</h5>
*
* <p>
* For example, two serializers of the same type created with the same configuration will always end up being
@@ -45,7 +46,8 @@ import org.apache.juneau.json.*;
* This has the effect of significantly improving performance, especially if you're creating many Serializers and
* Parsers.
*
- * <h6 class='topic'>PropertyStoreBuilder</h6>
+ *
+ * <h5 class='topic'>PropertyStoreBuilder</h5>
*
* <p>
* The {@link PropertyStoreBuilder} class is used to build up and instantiate immutable <code>PropertyStore</code>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyStoreBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyStoreBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyStoreBuilder.java
index 2705db0..6d0e8f5 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyStoreBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/PropertyStoreBuilder.java
@@ -98,7 +98,7 @@ public class PropertyStoreBuilder {
/**
* Sets a configuration property value on this object.
- *
+ *
* @param key
* The configuration property key.
* <br>(e.g <js>"BeanContext.foo.ss/add.1"</js>)
@@ -172,10 +172,10 @@ public class PropertyStoreBuilder {
/**
* Convenience method for setting multiple properties in one call.
- *
+ *
* <p>
* This replaces any previous configuration properties set on this store.
- *
+ *
* @param newProperties The new properties to set.
* @return This object (for method chaining).
*/
@@ -188,10 +188,10 @@ public class PropertyStoreBuilder {
/**
* Convenience method for setting multiple properties in one call.
- *
+ *
* <p>
* This appends to any previous configuration properties set on this store.
- *
+ *
* @param newProperties The new properties to set.
* @return This object (for method chaining).
*/
@@ -207,7 +207,7 @@ public class PropertyStoreBuilder {
/**
* Adds one or more values to a SET, LIST, or MAP property.
- *
+ *
* @param key The property key.
* @param arg
* The argument.
@@ -249,7 +249,7 @@ public class PropertyStoreBuilder {
*
* <p>
* Shortcut for calling <code>addTo(key, <jk>null</jk>, value);</code>.
- *
+ *
* @param key The property key.
* @param value
* The new value to add to the property.
@@ -266,7 +266,7 @@ public class PropertyStoreBuilder {
/**
* Removes a value from a SET or LIST property.
- *
+ *
* @param key The property key.
* @param value The property value in the property.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Session.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Session.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Session.java
index daaed58..5a9b510 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Session.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Session.java
@@ -24,7 +24,7 @@ import org.apache.juneau.serializer.*;
/**
* A one-time-use non-thread-safe object that's meant to be used once and then thrown away.
- *
+ *
* <p>
* Serializers and parsers use session objects to retrieve config properties and to use it as a scratchpad during
* serialize and parse actions.
@@ -40,7 +40,7 @@ public abstract class Session {
/**
* Default constructor.
- *
+ *
* @param args
* Runtime arguments.
*/
@@ -194,10 +194,10 @@ public abstract class Session {
/**
* Adds an arbitrary object to this session's cache.
- *
+ *
* <p>
* Can be used to store objects for reuse during a session.
- *
+ *
* @param key The key. Can be any string.
* @param val The cached object.
*/
@@ -209,10 +209,10 @@ public abstract class Session {
/**
* Adds arbitrary objects to this session's cache.
- *
+ *
* <p>
* Can be used to store objects for reuse during a session.
- *
+ *
* @param cacheObjects
* The objects to add to this session's cache.
* No-op if <jk>null</jk>.
@@ -227,7 +227,7 @@ public abstract class Session {
/**
* Returns an object stored in the session cache.
- *
+ *
* @param c The class type of the object.
* @param key The session object key.
* @return The cached object, or <jk>null</jk> if it doesn't exist.
@@ -239,7 +239,7 @@ public abstract class Session {
/**
* Logs a warning message.
- *
+ *
* @param msg The warning message.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -252,7 +252,7 @@ public abstract class Session {
/**
* Returns <jk>true</jk> if warnings occurred in this session.
- *
+ *
* @return <jk>true</jk> if warnings occurred in this session.
*/
public final boolean hasWarnings() {
@@ -261,7 +261,7 @@ public abstract class Session {
/**
* Returns the warnings that occurred in this session.
- *
+ *
* @return The warnings that occurred in this session, or <jk>null</jk> if no warnings occurred.
*/
public final List<String> getWarnings() {
@@ -270,10 +270,10 @@ public abstract class Session {
/**
* Returns the logger associated with this session.
- *
+ *
* <p>
* Subclasses can override this method to provide their own logger.
- *
+ *
* @return The logger associated with this session.
*/
protected final JuneauLogger getLogger() {
@@ -284,7 +284,7 @@ public abstract class Session {
/**
* Returns the properties defined on this bean context as a simple map for debugging purposes.
- *
+ *
* @return A new map containing the properties defined on this context.
*/
public ObjectMap asMap() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/SessionArgs.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/SessionArgs.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/SessionArgs.java
index 7c26085..0d1d008 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/SessionArgs.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/SessionArgs.java
@@ -31,7 +31,7 @@ public class SessionArgs {
/**
* Constructor.
- *
+ *
* @param properties
* Session-level properties.
* <br>These override context-level properties.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Setter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Setter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Setter.java
index d81da79..b831dbc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Setter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Setter.java
@@ -21,7 +21,7 @@ public interface Setter {
/**
* Call the setter on the specified object.
- *
+ *
* @param object The object to call the setter on
* @param value The value to set.
* @throws Exception
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Streamable.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Streamable.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Streamable.java
index 3d98b92..31436a1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Streamable.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Streamable.java
@@ -18,7 +18,7 @@ import org.apache.juneau.http.*;
/**
* Interface that identifies that an object can be serialized directly to an output stream.
- *
+ *
* <p>
* Instances must identify the media type of the content by implementing the {@link #getMediaType()} method.
*/
@@ -26,7 +26,7 @@ public interface Streamable {
/**
* Serialize this object to the specified output stream.
- *
+ *
* @param os The output stream to stream to.
* @throws IOException
*/
@@ -34,7 +34,7 @@ public interface Streamable {
/**
* Returns the serialized media type for this resource (e.g. <js>"text/html"</js>).
- *
+ *
* @return The media type, or <jk>null</jk> if the media type is not known.
*/
MediaType getMediaType();
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriContext.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriContext.java
index d42b0f5..a76c0a3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriContext.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriContext.java
@@ -20,7 +20,7 @@ import org.apache.juneau.parser.*;
/**
* Represents a URL broken into authority/context-root/servlet-path/path-info parts.
- *
+ *
* <p>
* A typical request against a URL takes the following form:
* <p class='bcode'>
@@ -28,7 +28,7 @@ import org.apache.juneau.parser.*;
* | authority | context | resource | path |
* +--------------------------------------------------+
* </p>
- *
+ *
* <p>
* This class allows you to convert URL strings to absolute (e.g. <js>"http://host:port/foo/bar"</js>) or root-relative
* (e.g. <js>"/foo/bar"</js>) URLs.
@@ -38,7 +38,7 @@ public class UriContext {
/**
* Default URI context.
- *
+ *
* <p>
* No information about authority, servlet-root, context-root, or path-info is known.
*/
@@ -52,13 +52,13 @@ public class UriContext {
/**
* Constructor.
- *
+ *
* <p>
* Leading and trailing slashes are trimmed of all parameters.
- *
+ *
* <p>
* Any parameter can be <jk>null</jk>. Blanks and nulls are equivalent.
- *
+ *
* @param authority
* The authority portion of URL (e.g. <js>"http://hostname:port"</js>)
* @param contextRoot
@@ -80,7 +80,7 @@ public class UriContext {
/**
* Default constructor.
- *
+ *
* <p>
* All <jk>null</jk> values.
*/
@@ -94,7 +94,7 @@ public class UriContext {
* <p>
* Input string is a JSON object with the following format:
* <js>{authority:'xxx',contextRoot:'xxx',servletPath:'xxx',pathInfo:'xxx'}</js>
- *
+ *
* @param s
* The input string.
* <br>Example: <js>{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}</js>
@@ -113,13 +113,13 @@ public class UriContext {
/**
* Returns the absolute URI of just the authority portion of this URI context.
- *
+ *
* <p>
* Example: <js>"http://hostname:port"</js>
- *
+ *
* <p>
* If the authority is null/empty, returns <js>"/"</js>.
- *
+ *
* @return
* The absolute URI of just the authority portion of this URI context.
* Never <jk>null</jk>.
@@ -130,10 +130,10 @@ public class UriContext {
/**
* Returns the absolute URI of the context-root portion of this URI context.
- *
+ *
* <p>
* Example: <js>"http://hostname:port/context-root"</js>
- *
+ *
* @return
* The absolute URI of the context-root portion of this URI context.
* Never <jk>null</jk>.
@@ -154,10 +154,10 @@ public class UriContext {
/**
* Returns the root-relative URI of the context portion of this URI context.
- *
+ *
* <p>
* Example: <js>"/context-root"</js>
- *
+ *
* @return
* The root-relative URI of the context portion of this URI context.
* Never <jk>null</jk>.
@@ -170,10 +170,10 @@ public class UriContext {
/**
* Returns the absolute URI of the resource portion of this URI context.
- *
+ *
* <p>
* Example: <js>"http://hostname:port/context-root/servlet-path"</js>
- *
+ *
* @return
* The absolute URI of the resource portion of this URI context.
* Never <jk>null</jk>.
@@ -202,10 +202,10 @@ public class UriContext {
/**
* Returns the root-relative URI of the resource portion of this URI context.
- *
+ *
* <p>
* Example: <js>"/context-root/servlet-path"</js>
- *
+ *
* @return
* The root-relative URI of the resource portion of this URI context.
* Never <jk>null</jk>.
@@ -230,7 +230,7 @@ public class UriContext {
/**
* Returns the parent of the URL returned by {@link #getAbsoluteServletPath()}.
- *
+ *
* @return The parent of the URL returned by {@link #getAbsoluteServletPath()}.
*/
public String getAbsoluteServletPathParent() {
@@ -239,7 +239,7 @@ public class UriContext {
/**
* Returns the parent of the URL returned by {@link #getRootRelativeServletPath()}.
- *
+ *
* @return The parent of the URL returned by {@link #getRootRelativeServletPath()}.
*/
public String getRootRelativeServletPathParent() {
@@ -248,10 +248,10 @@ public class UriContext {
/**
* Returns the absolute URI of the path portion of this URI context.
- *
+ *
* <p>
* Example: <js>"http://hostname:port/context-root/servlet-path/path-info"</js>
- *
+ *
* @return
* The absolute URI of the path portion of this URI context.
* Never <jk>null</jk>.
@@ -294,10 +294,10 @@ public class UriContext {
/**
* Returns the root-relative URI of the path portion of this URI context.
- *
+ *
* <p>
* Example: <js>"/context-root/servlet-path/path-info"</js>
- *
+ *
* @return
* The root-relative URI of the path portion of this URI context.
* Never <jk>null</jk>.
@@ -337,7 +337,7 @@ public class UriContext {
/**
* Returns the parent of the URL returned by {@link #getAbsolutePathInfo()}.
- *
+ *
* @return The parent of the URL returned by {@link #getAbsolutePathInfo()}.
*/
public String getAbsolutePathInfoParent() {
@@ -346,7 +346,7 @@ public class UriContext {
/**
* Returns the parent of the URL returned by {@link #getRootRelativePathInfo()}.
- *
+ *
* @return The parent of the URL returned by {@link #getRootRelativePathInfo()}.
*/
public String getRootRelativePathInfoParent() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriResolver.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriResolver.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriResolver.java
index a82e6c6..98c53a4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriResolver.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriResolver.java
@@ -24,16 +24,16 @@ import org.apache.juneau.internal.*;
/**
* Class used to create absolute and root-relative URIs based on your current URI 'location' and rules about how to
* make such resolutions.
- *
+ *
* <p>
* Combines a {@link UriContext} instance with rules for resolution ({@link UriResolution} and relativity
* ({@link UriRelativity}) to define simple {@link #resolve(Object)} and {@link #append(Appendable, Object)} methods.
- *
+ *
* <p>
* Three special protocols are used to represent context-root-relative, servlet-relative, and request-path-relative
* URIs:
* <js>"context:/"</js>, <js>"servlet:/"</js>, and <js>"request:/"</js>.
- *
+ *
* <p>
* The following list shows the protocols of URLs that can be resolved with this class:
* <ul>
@@ -58,7 +58,7 @@ public class UriResolver {
/**
* Constructor.
- *
+ *
* @param resolution Rule on how URIs should be resolved.
* @param relativity Rule on what relative URIs are relative to.
* @param uriContext Current URI context (i.e. the current URI 'location').
@@ -75,7 +75,7 @@ public class UriResolver {
/**
* Converts the specified URI to absolute form based on values in this context.
- *
+ *
* @param uri
* The URI to convert to absolute form.
* Can be any of the following:
@@ -117,18 +117,18 @@ public class UriResolver {
/**
* Relativizes a URI.
- *
+ *
* <p>
* Similar to {@link URI#relativize(URI)}, except supports special protocols (e.g. <js>"servlet:/"</js>) for both
* the <code>relativeTo</code> and <code>uri</code> parameters.
- *
+ *
* <p>
* For example, to relativize a URI to its servlet-relative form:
* <p class='bcode'>
* <jc>// relativeUri == "path/foo"</jc>
* String relativeUri = resolver.relativize(<js>"servlet:/"</js>, <js>"/context/servlet/path/foo"</js>);
* </p>
- *
+ *
* @param relativeTo The URI to relativize against.
* @param uri The URI to relativize.
* @return The relativized URI.
@@ -141,7 +141,7 @@ public class UriResolver {
/**
* Same as {@link #resolve(Object)} except appends result to the specified appendable.
- *
+ *
* @param a The appendable to append the URL to.
* @param o The URI to convert to absolute form.
* @return The same appendable passed in.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Visibility.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Visibility.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Visibility.java
index 2e5a0f6..8d989cb 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Visibility.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Visibility.java
@@ -16,10 +16,10 @@ import java.lang.reflect.*;
/**
* Defines class/field/method visibilities.
- *
+ *
* <p>
* Used to specify minimum levels of visibility when detecting bean classes, methods, and fields.
- *
+ *
* <p>
* Used in conjunction with the following bean context properties:
* <ul>
@@ -48,7 +48,7 @@ public enum Visibility {
/**
* Identifies if the specified mod matches this visibility.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jsf>PUBLIC</jsf>.isVisible(MyPublicClass.<jk>class</jk>.getModifiers()); <jc>//true</jc>
@@ -56,7 +56,7 @@ public enum Visibility {
* <jsf>PRIVATE</jsf>.isVisible(MyPrivateClass.<jk>class</jk>.getModifiers()); <jc>//true</jc>
* <jsf>NONE</jsf>.isVisible(MyPublicClass.<jk>class</jk>.getModifiers()); <jc>//false</jc>
* </p>
- *
+ *
* @param mod The modifier from the object being tested (e.g. results from {@link Class#getModifiers()}.
* @return <jk>true</jk> if this visibility matches the specified modifier attribute.
*/
@@ -72,7 +72,7 @@ public enum Visibility {
/**
* Shortcut for <code>isVisible(x.getModifiers());</code>
- *
+ *
* @param x The constructor to check.
* @return <jk>true</jk> if the constructor is at least as visible as this object.
*/
@@ -82,7 +82,7 @@ public enum Visibility {
/**
* Shortcut for <code>isVisible(x.getModifiers());</code>
- *
+ *
* @param x The method to check.
* @return <jk>true</jk> if the method is at least as visible as this object.
*/
@@ -92,7 +92,7 @@ public enum Visibility {
/**
* Shortcut for <code>isVisible(x.getModifiers());</code>
- *
+ *
* @param x The field to check.
* @return <jk>true</jk> if the field is at least as visible as this object.
*/
@@ -102,10 +102,10 @@ public enum Visibility {
/**
* Makes constructor accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't.
- *
+ *
* <p>
* Security exceptions thrown on the call to {@link Constructor#setAccessible(boolean)} are quietly ignored.
- *
+ *
* @param x The constructor.
* @return
* The same constructor if visibility requirements met, or <jk>null</jk> if visibility requirement not
@@ -122,10 +122,10 @@ public enum Visibility {
/**
* Makes method accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't.
- *
+ *
* <p>
* Security exceptions thrown on the call to {@link Method#setAccessible(boolean)} are quietly ignored.
- *
+ *
* @param x The method.
* @return
* The same method if visibility requirements met, or <jk>null</jk> if visibility requirement not
@@ -142,10 +142,10 @@ public enum Visibility {
/**
* Makes field accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't.
- *
+ *
* <p>
* Security exceptions thrown on the call to {@link Field#setAccessible(boolean)} are quietly ignored.
- *
+ *
* @param x The field.
* @return
* The same field if visibility requirements met, or <jk>null</jk> if visibility requirement not
@@ -162,7 +162,7 @@ public enum Visibility {
/**
* Attempts to call <code>x.setAccessible(<jk>true</jk>)</code> and quietly ignores security exceptions.
- *
+ *
* @param x The constructor.
* @return <jk>true</jk> if call was successful.
*/
@@ -178,7 +178,7 @@ public enum Visibility {
/**
* Attempts to call <code>x.setAccessible(<jk>true</jk>)</code> and quietly ignores security exceptions.
- *
+ *
* @param x The method.
* @return <jk>true</jk> if call was successful.
*/
@@ -194,7 +194,7 @@ public enum Visibility {
/**
* Attempts to call <code>x.setAccessible(<jk>true</jk>)</code> and quietly ignores security exceptions.
- *
+ *
* @param x The field.
* @return <jk>true</jk> if call was successful.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Writable.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Writable.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Writable.java
index 656cf37..bf507c8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Writable.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Writable.java
@@ -18,7 +18,7 @@ import org.apache.juneau.http.*;
/**
* Interface that identifies that an object can be serialized directly to a writer.
- *
+ *
* <p>
* Instances must identify the media type of the content by implementing the {@link #getMediaType()} method.
*/
@@ -26,7 +26,7 @@ public interface Writable {
/**
* Serialize this object to the specified writer.
- *
+ *
* @param w The writer to write to.
* @throws IOException
*/
@@ -34,7 +34,7 @@ public interface Writable {
/**
* Returns the serialized media type for this resource (e.g. <js>"text/html"</js>)
- *
+ *
* @return The media type, or <jk>null</jk> if the media type is not known.
*/
MediaType getMediaType();
[05/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestHeaders.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestHeaders.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestHeaders.java
index a08bbd7..d94c02b 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestHeaders.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestHeaders.java
@@ -28,7 +28,7 @@ import org.apache.juneau.parser.*;
/**
* Represents the headers in an HTTP request.
- *
+ *
* <p>
* Entries are stored in a case-insensitive map.
*/
@@ -60,10 +60,10 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Adds default entries to these headers.
- *
+ *
* <p>
* This includes the default headers defined on the servlet and method levels.
- *
+ *
* @param defaultEntries The default entries. Can be <jk>null</jk>.
* @return This object (for method chaining).
*/
@@ -82,7 +82,7 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Adds a set of header values to this object.
- *
+ *
* @param name The header name.
* @param values The header values.
* @return This object (for method chaining).
@@ -101,11 +101,11 @@ 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.
- *
+ *
* @param name The header name.
* @return The header value, or <jk>null</jk> if it doesn't exist.
*/
@@ -122,11 +122,11 @@ 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.
- *
+ *
* @param name The HTTP header name.
* @param def The default value to return if the header value isn't found.
* @return The header value, or the default value if the header isn't present.
@@ -138,7 +138,7 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Same as {@link #getString(String)} but converts the value to an integer.
- *
+ *
* @param name The HTTP header name.
* @return The header value, or the default value if the header isn't present.
*/
@@ -148,7 +148,7 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Same as {@link #getString(String,String)} but converts the value to an integer.
- *
+ *
* @param name The HTTP header name.
* @param def The default value to return if the header value isn't found.
* @return The header value, or the default value if the header isn't present.
@@ -160,7 +160,7 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Same as {@link #getString(String)} but converts the value to a boolean.
- *
+ *
* @param name The HTTP header name.
* @return The header value, or the default value if the header isn't present.
*/
@@ -170,7 +170,7 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Same as {@link #getString(String,String)} but converts the value to a boolean.
- *
+ *
* @param name The HTTP header name.
* @param def The default value to return if the header value isn't found.
* @return The header value, or the default value if the header isn't present.
@@ -182,7 +182,7 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Sets a request header value.
- *
+ *
* @param name The header name.
* @param value The header value.
*/
@@ -192,20 +192,20 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the specified header value converted to a POJO.
- *
+ *
* <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>
* <jk>int</jk> myheader = req.getHeader(<js>"My-Header"</js>, <jk>int</jk>.<jk>class</jk>);
- *
+ *
* <jc>// Parse a UUID.</jc>
* UUID myheader = req.getHeader(<js>"My-Header"</js>, UUID.<jk>class</jk>);
* </p>
- *
+ *
* @param name The HTTP header name.
* @param type The class type to convert the header value to.
* @param <T> The class type to convert the header value to.
@@ -218,7 +218,7 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Same as {@link #get(String, Class)} but allows you to override the part parser used.
- *
+ *
* @param parser
* The parser to use for parsing the string header.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -234,7 +234,7 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Same as {@link #get(String, Class)} but returns a default value if not found.
- *
+ *
* @param name The HTTP header name.
* @param def The default value if the header was not specified or is <jk>null</jk>.
* @param type The class type to convert the header value to.
@@ -248,7 +248,7 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Same as {@link #get(String, Object, Class)} but allows you to override the part parser used.
- *
+ *
* @param parser
* The parser to use for parsing the string header.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -270,17 +270,17 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the specified header value converted to a POJO.
- *
+ *
* <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>
* List<String> myheader = req.getHeader(<js>"My-Header"</js>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
* </p>
- *
+ *
* @param name The HTTP header name.
* @param type
* The type of object to create.
@@ -332,7 +332,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.
*/
@@ -346,7 +346,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.
*/
@@ -356,15 +356,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Accept</code> header on the request.
- *
+ *
* <p>
* Content-Types that are acceptable for the response.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Accept: text/plain
* </p>
- *
+ *
* @return The parsed <code>Accept</code> header on the request, or <jk>null</jk> if not found.
*/
public Accept getAccept() {
@@ -373,15 +373,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Accept-Charset</code> header on the request.
- *
+ *
* <p>
* Character sets that are acceptable.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Accept-Charset: utf-8
* </p>
- *
+ *
* @return The parsed <code>Accept-Charset</code> header on the request, or <jk>null</jk> if not found.
*/
public AcceptCharset getAcceptCharset() {
@@ -390,15 +390,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Accept-Encoding</code> header on the request.
- *
+ *
* <p>
* List of acceptable encodings.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Accept-Encoding: gzip, deflate
* </p>
- *
+ *
* @return The parsed <code>Accept-Encoding</code> header on the request, or <jk>null</jk> if not found.
*/
public AcceptEncoding getAcceptEncoding() {
@@ -407,15 +407,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Accept-Language</code> header on the request.
- *
+ *
* <p>
* List of acceptable human languages for response.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Accept-Language: en-US
* </p>
- *
+ *
* @return The parsed <code>Accept-Language</code> header on the request, or <jk>null</jk> if not found.
*/
public AcceptLanguage getAcceptLanguage() {
@@ -424,15 +424,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Authorization</code> header on the request.
- *
+ *
* <p>
* Authentication credentials for HTTP authentication.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
* </p>
- *
+ *
* @return The parsed <code>Authorization</code> header on the request, or <jk>null</jk> if not found.
*/
public Authorization getAuthorization() {
@@ -441,15 +441,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Cache-Control</code> header on the request.
- *
+ *
* <p>
* Used to specify directives that must be obeyed by all caching mechanisms along the request-response chain.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Cache-Control: no-cache
* </p>
- *
+ *
* @return The parsed <code>Cache-Control</code> header on the request, or <jk>null</jk> if not found.
*/
public CacheControl getCacheControl() {
@@ -458,16 +458,16 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Connection</code> header on the request.
- *
+ *
* <p>
* Control options for the current connection and list of hop-by-hop request fields.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Connection: keep-alive
* Connection: Upgrade
* </p>
- *
+ *
* @return The parsed <code></code> header on the request, or <jk>null</jk> if not found.
*/
public Connection getConnection() {
@@ -476,15 +476,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Content-Length</code> header on the request.
- *
+ *
* <p>
* The length of the request body in octets (8-bit bytes).
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Content-Length: 348
* </p>
- *
+ *
* @return The parsed <code>Content-Length</code> header on the request, or <jk>null</jk> if not found.
*/
public ContentLength getContentLength() {
@@ -493,15 +493,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Content-Type</code> header on the request.
- *
+ *
* <p>
* The MIME type of the body of the request (used with POST and PUT requests).
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Content-Type: application/x-www-form-urlencoded
* </p>
- *
+ *
* @return The parsed <code>Content-Type</code> header on the request, or <jk>null</jk> if not found.
*/
public ContentType getContentType() {
@@ -510,15 +510,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Date</code> header on the request.
- *
+ *
* <p>
* The date and time that the message was originated (in "HTTP-date" format as defined by RFC 7231 Date/Time Formats).
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Date: Tue, 15 Nov 1994 08:12:31 GMT
* </p>
- *
+ *
* @return The parsed <code>Date</code> header on the request, or <jk>null</jk> if not found.
*/
public Date getDate() {
@@ -527,15 +527,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Expect</code> header on the request.
- *
+ *
* <p>
* Indicates that particular server behaviors are required by the client.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Expect: 100-continue
* </p>
- *
+ *
* @return The parsed <code>Expect</code> header on the request, or <jk>null</jk> if not found.
*/
public Expect getExpect() {
@@ -544,15 +544,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>From</code> header on the request.
- *
+ *
* <p>
* The email address of the user making the request.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* From: user@example.com
* </p>
- *
+ *
* @return The parsed <code>From</code> header on the request, or <jk>null</jk> if not found.
*/
public From getFrom() {
@@ -561,17 +561,17 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Host</code> header on the request.
- *
+ *
* <p>
* The domain name of the server (for virtual hosting), and the TCP port number on which the server is listening.
* The port number may be omitted if the port is the standard port for the service requested.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Host: en.wikipedia.org:8080
* Host: en.wikipedia.org
* </p>
- *
+ *
* @return The parsed <code>Host</code> header on the request, or <jk>null</jk> if not found.
*/
public Host getHost() {
@@ -580,17 +580,17 @@ 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.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* If-Match: "737060cd8c284d8af7ad3082f209582d"
* </p>
- *
+ *
* @return The parsed <code>If-Match</code> header on the request, or <jk>null</jk> if not found.
*/
public IfMatch getIfMatch() {
@@ -599,15 +599,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>If-Modified-Since</code> header on the request.
- *
+ *
* <p>
* Allows a 304 Not Modified to be returned if content is unchanged.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* If-Modified-Since: Sat, 29 Oct 1994 19:43:31 GMT
* </p>
- *
+ *
* @return The parsed <code>If-Modified-Since</code> header on the request, or <jk>null</jk> if not found.
*/
public IfModifiedSince getIfModifiedSince() {
@@ -616,15 +616,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>If-None-Match</code> header on the request.
- *
+ *
* <p>
* Allows a 304 Not Modified to be returned if content is unchanged, see HTTP ETag.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* If-None-Match: "737060cd8c284d8af7ad3082f209582d"
* </p>
- *
+ *
* @return The parsed <code>If-None-Match</code> header on the request, or <jk>null</jk> if not found.
*/
public IfNoneMatch getIfNoneMatch() {
@@ -633,15 +633,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>If-Range</code> header on the request.
- *
+ *
* <p>
* If the entity is unchanged, send me the part(s) that I am missing; otherwise, send me the entire new entity.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* If-Range: "737060cd8c284d8af7ad3082f209582d"
* </p>
- *
+ *
* @return The parsed <code>If-Range</code> header on the request, or <jk>null</jk> if not found.
*/
public IfRange getIfRange() {
@@ -650,15 +650,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>If-Unmodified-Since</code> header on the request.
- *
+ *
* <p>
* Only send the response if the entity has not been modified since a specific time.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* If-Unmodified-Since: Sat, 29 Oct 1994 19:43:31 GMT
* </p>
- *
+ *
* @return The parsed <code>If-Unmodified-Since</code> header on the request, or <jk>null</jk> if not found.
*/
public IfUnmodifiedSince getIfUnmodifiedSince() {
@@ -667,15 +667,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Max-Forwards</code> header on the request.
- *
+ *
* <p>
* Limit the number of times the message can be forwarded through proxies or gateways.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Max-Forwards: 10
* </p>
- *
+ *
* @return The parsed <code>Max-Forwards</code> header on the request, or <jk>null</jk> if not found.
*/
public MaxForwards getMaxForwards() {
@@ -684,15 +684,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Pragma</code> header on the request.
- *
+ *
* <p>
* Implementation-specific fields that may have various effects anywhere along the request-response chain.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Pragma: no-cache
* </p>
- *
+ *
* @return The parsed <code>Pragma</code> header on the request, or <jk>null</jk> if not found.
*/
public Pragma getPragma() {
@@ -701,15 +701,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Proxy-Authorization</code> header on the request.
- *
+ *
* <p>
* Authorization credentials for connecting to a proxy.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
* </p>
- *
+ *
* @return The parsed <code>Proxy-Authorization</code> header on the request, or <jk>null</jk> if not found.
*/
public ProxyAuthorization getProxyAuthorization() {
@@ -718,15 +718,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Range</code> header on the request.
- *
+ *
* <p>
* Request only part of an entity. Bytes are numbered from 0.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Range: bytes=500-999
* </p>
- *
+ *
* @return The parsed <code>Range</code> header on the request, or <jk>null</jk> if not found.
*/
public Range getRange() {
@@ -735,15 +735,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Referer</code> header on the request.
- *
+ *
* <p>
* This is the address of the previous web page from which a link to the currently requested page was followed.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Referer: http://en.wikipedia.org/wiki/Main_Page
* </p>
- *
+ *
* @return The parsed <code>Referer</code> header on the request, or <jk>null</jk> if not found.
*/
public Referer getReferer() {
@@ -752,17 +752,17 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>TE</code> header on the request.
- *
+ *
* <p>
* The transfer encodings the user agent is willing to accept: the same values as for the response header field
* Transfer-Encoding can be used, plus the "trailers" value (related to the "chunked" transfer method) to notify the
* server it expects to receive additional fields in the trailer after the last, zero-sized, chunk.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* TE: trailers, deflate
* </p>
- *
+ *
* @return The parsed <code>TE</code> header on the request, or <jk>null</jk> if not found.
*/
public TE getTE() {
@@ -771,10 +771,10 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Time-Zone</code> header value on the request if there is one.
- *
+ *
* <p>
* Example: <js>"GMT"</js>.
- *
+ *
* @return The <code>Time-Zone</code> header value on the request, or <jk>null</jk> if not present.
*/
public TimeZone getTimeZone() {
@@ -786,15 +786,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>User-Agent</code> header on the request.
- *
+ *
* <p>
* The user agent string of the user agent.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:12.0) Gecko/20100101 Firefox/21.0
* </p>
- *
+ *
* @return The parsed <code>User-Agent</code> header on the request, or <jk>null</jk> if not found.
*/
public UserAgent getUserAgent() {
@@ -803,15 +803,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Upgrade</code> header on the request.
- *
+ *
* <p>
* Ask the server to upgrade to another protocol.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Upgrade: HTTP/2.0, HTTPS/1.3, IRC/6.9, RTA/x11, websocket
* </p>
- *
+ *
* @return The parsed <code>Upgrade</code> header on the request, or <jk>null</jk> if not found.
*/
public Upgrade getUpgrade() {
@@ -820,15 +820,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Via</code> header on the request.
- *
+ *
* <p>
* Informs the server of proxies through which the request was sent.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Via: 1.0 fred, 1.1 example.com (Apache/1.1)
* </p>
- *
+ *
* @return The parsed <code>Via</code> header on the request, or <jk>null</jk> if not found.
*/
public Via getVia() {
@@ -837,15 +837,15 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Returns the <code>Warning</code> header on the request.
- *
+ *
* <p>
* A general warning about possible problems with the entity body.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* Warning: 199 Miscellaneous warning
* </p>
- *
+ *
* @return The parsed <code>Warning</code> header on the request, or <jk>null</jk> if not found.
*/
public Warning getWarning() {
@@ -854,7 +854,7 @@ public class RequestHeaders extends TreeMap<String,String[]> {
/**
* Converts the headers to a readable string.
- *
+ *
* @param sorted Sort the headers by name.
* @return A JSON string containing the contents of the headers.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestPathMatch.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestPathMatch.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestPathMatch.java
index 48288f9..ea30efa 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestPathMatch.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestPathMatch.java
@@ -23,7 +23,7 @@ import org.apache.juneau.parser.*;
/**
* Contains information about the matched path on the HTTP request.
- *
+ *
* <p>
* Provides access to the matched path variables and path match remainder.
*/
@@ -56,7 +56,7 @@ public class RequestPathMatch extends TreeMap<String,String> {
/**
* Sets a request query parameter value.
- *
+ *
* @param name The parameter name.
* @param value The parameter value.
*/
@@ -66,29 +66,29 @@ public class RequestPathMatch extends TreeMap<String,String> {
/**
* Returns the specified path parameter converted to a POJO.
- *
+ *
* <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>
* <jk>int</jk> myparam = req.getPathParameter(<js>"myparam"</js>, <jk>int</jk>.<jk>class</jk>);
- *
+ *
* <jc>// Parse into an int array.</jc>
* <jk>int</jk>[] myparam = req.getPathParameter(<js>"myparam"</js>, <jk>int</jk>[].<jk>class</jk>);
* <jc>// Parse into a bean.</jc>
* MyBean myparam = req.getPathParameter(<js>"myparam"</js>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of objects.</jc>
* List myparam = req.getPathParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of object keys/values.</jc>
* Map myparam = req.getPathParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* @param name The attribute name.
* @param type The class type to convert the attribute value to.
* @param <T> The class type to convert the attribute value to.
@@ -101,29 +101,29 @@ public class RequestPathMatch extends TreeMap<String,String> {
/**
* Returns the specified path parameter converted to a POJO.
- *
+ *
* <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>).
- *
+ *
* <p>
* Use this method if you want to parse into a parameterized <code>Map</code>/<code>Collection</code> object.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into a linked-list of strings.</jc>
* List<String> myparam = req.getPathParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of linked-lists of strings.</jc>
* List<List<String>> myparam = req.getPathParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of string keys/values.</jc>
* Map<String,String> myparam = req.getPathParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map containing string keys and values of lists containing beans.</jc>
* Map<String,List<MyBean>> myparam = req.getPathParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);
* </p>
- *
+ *
* @param name The attribute name.
* @param type
* The type of object to create.
@@ -155,7 +155,7 @@ public class RequestPathMatch extends TreeMap<String,String> {
/**
* Returns the decoded remainder of the URL following any path pattern matches.
- *
+ *
* <p>
* The behavior of path remainder is shown below given the path pattern "/foo/*":
* <table class='styled'>
@@ -192,7 +192,7 @@ public class RequestPathMatch extends TreeMap<String,String> {
* <td><js>"a/b"</js></td>
* </tr>
* </table>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// REST method</jc>
@@ -200,11 +200,11 @@ public class RequestPathMatch extends TreeMap<String,String> {
* <jk>public</jk> String doGetById(RequestPathParams pathParams, <jk>int</jk> bar) {
* <jk>return</jk> pathParams.getRemainder();
* }
- *
+ *
* <jc>// Prints "path/remainder"</jc>
* <jk>new</jk> RestCall(servletPath + <js>"/foo/123/path/remainder"</js>).connect();
* </p>
- *
+ *
* @return The path remainder string.
*/
public String getRemainder() {
@@ -213,7 +213,7 @@ public class RequestPathMatch extends TreeMap<String,String> {
/**
* Same as {@link #getRemainder()} but doesn't decode characters.
- *
+ *
* @return The un-decoded path remainder.
*/
public String getRemainderUndecoded() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestQuery.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestQuery.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestQuery.java
index 8f1d62f..f51d5be 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestQuery.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestQuery.java
@@ -58,10 +58,10 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Adds default entries to these query parameters.
- *
+ *
* <p>
* This includes the default queries defined on the servlet and method levels.
- *
+ *
* @param defaultEntries The default entries. Can be <jk>null</jk>.
* @return This object (for method chaining).
*/
@@ -80,7 +80,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Sets a request query parameter value.
- *
+ *
* @param name The parameter name.
* @param value The parameter value.
*/
@@ -90,18 +90,18 @@ 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.
- *
+ *
* <p>
* 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.
- *
+ *
* @param name The URL parameter name.
* @return The parameter value, or <jk>null</jk> if parameter not specified or has no value (e.g. <js>"&foo"</js>.
*/
@@ -122,7 +122,7 @@ 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.
- *
+ *
* @param name The URL parameter name.
* @param def The default value.
* @return
@@ -136,7 +136,7 @@ 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
@@ -148,7 +148,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getString(String,String)} but converts the value to an integer.
- *
+ *
* @param name The URL parameter name.
* @param def The default value.
* @return
@@ -162,7 +162,7 @@ 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
@@ -174,7 +174,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getString(String,String)} but converts the value to a boolean.
- *
+ *
* @param name The URL parameter name.
* @param def The default value.
* @return
@@ -188,29 +188,29 @@ 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.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into an integer.</jc>
* <jk>int</jk> myparam = req.getQueryParameter(<js>"myparam"</js>, <jk>int</jk>.<jk>class</jk>);
- *
+ *
* <jc>// Parse into an int array.</jc>
* <jk>int</jk>[] myparam = req.getQueryParameter(<js>"myparam"</js>, <jk>int</jk>[].<jk>class</jk>);
* <jc>// Parse into a bean.</jc>
* MyBean myparam = req.getQueryParameter(<js>"myparam"</js>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of objects.</jc>
* List myparam = req.getQueryParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of object keys/values.</jc>
* Map myparam = req.getQueryParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* @param name The parameter name.
* @param type The class type to convert the parameter value to.
* @param <T> The class type to convert the parameter value to.
@@ -223,7 +223,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Class)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -239,7 +239,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Class)} except returns a default value if not found.
- *
+ *
* @param name The parameter name.
* @param def The default value if the parameter was not specified or is <jk>null</jk>.
* @param type The class type to convert the parameter value to.
@@ -253,7 +253,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Object, Class)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -270,29 +270,29 @@ 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>
* Use this method if you want to parse into a parameterized <code>Map</code>/<code>Collection</code> object.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into a linked-list of strings.</jc>
* List<String> myparam = req.getQueryParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of linked-lists of strings.</jc>
* List<List<String>> myparam = req.getQueryParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of string keys/values.</jc>
* Map<String,String> myparam = req.getQueryParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map containing string keys and values of lists containing beans.</jc>
* Map<String,List<MyBean>> myparam = req.getQueryParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);
* </p>
- *
+ *
* @param name The parameter name.
* @param type
* The type of object to create.
@@ -313,11 +313,11 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Type, Type...)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
- *
+ *
* @param name The parameter name.
* @param type
* The type of object to create.
@@ -338,7 +338,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Class)} except returns a default value if not found.
- *
+ *
* @param name The parameter name.
* @param type
* The type of object to create.
@@ -360,7 +360,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Object, Type, Type...)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -386,10 +386,10 @@ public final class RequestQuery 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>).
- *
+ *
* <p>
* This method must only be called when parsing into classes of type Collection or array.
- *
+ *
* @param name The query parameter name.
* @param c The class type to convert the parameter value to.
* @param <T> The class type to convert the parameter value to.
@@ -403,10 +403,10 @@ public final class RequestQuery 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>).
- *
+ *
* <p>
* This method must only be called when parsing into classes of type Collection or array.
- *
+ *
* @param name The query parameter name.
* @param type
* The type of object to create.
@@ -427,7 +427,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getAll(String, Type, Type...)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -451,7 +451,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Returns <jk>true</jk> if the request contains any of the specified query parameters.
- *
+ *
* @param params The list of parameters to check for.
* @return <jk>true</jk> if the request contains any of the specified query parameters.
*/
@@ -464,7 +464,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Locates the special search query arguments in the query and returns them as a {@link SearchArgs} object.
- *
+ *
* <p>
* The query arguments are as follows:
* <ul>
@@ -489,10 +489,10 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
* <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.
@@ -513,7 +513,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Returns <jk>true</jk> if the query parameters contains any of the specified names.
- *
+ *
* @param paramNames The parameter names to check for.
* @return <jk>true</jk> if the query parameters contains any of the specified names.
*/
@@ -575,7 +575,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Converts the query parameters to a readable string.
- *
+ *
* @param sorted Sort the query parameters by name.
* @return A JSON string containing the contents of the query parameters.
*/
@@ -590,10 +590,10 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> {
/**
* Converts this object to a query string.
- *
+ *
* <p>
* Returned query string does not start with <js>'?'</js>.
- *
+ *
* @return A new query string, or an empty string if this object is empty.
*/
public String toQueryString() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ResponseHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ResponseHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ResponseHandler.java
index 34bc79a..475d4f4 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ResponseHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ResponseHandler.java
@@ -22,11 +22,11 @@ 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.
- *
+ *
* <p>
* Response handlers can be associated with {@link RestServlet RestServlets} through the following ways:
* <ul class='spaced-list'>
@@ -36,7 +36,7 @@ import org.apache.juneau.rest.response.*;
* By calling the {@link RestContextBuilder#responseHandlers(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'>
@@ -55,11 +55,11 @@ import org.apache.juneau.rest.response.*;
* <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.
- *
+ *
* <p>
* The following example shows how to create a response handler to handle special <code>Foo</code> objects outside the
* normal Juneau architecture.
@@ -69,12 +69,12 @@ import org.apache.juneau.rest.response.*;
* responseHandlers=FooHandler.<jk>class</jk>
* )
* <jk>public class</jk> Example <jk>extends</jk> RestServlet {
- *
+ *
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/"</js>)
* <jk>public</jk> Foo test1() {
* <jk>return new</jk> Foo(<js>"123"</js>);
* }
- *
+ *
* <jk>public static class</jk> FooHandler <jk>implements</jk> ResponseHandler {
* <ja>@Override</ja>
* <jk>public boolean</jk> handle(RestRequest req, RestResponse res, Object output) <jk>throws</jk> IOException, RestException {
@@ -96,7 +96,7 @@ public interface ResponseHandler {
/**
* Process this response if possible.
* This method should return <jk>false</jk> if it wasn't able to process the response.
- *
+ *
* @param req The HTTP servlet request.
* @param res The HTTP servlet response;
* @param output The POJO returned by the REST method that now needs to be sent to the response.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestCallHandler.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestCallHandler.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestCallHandler.java
index b8ac10d..70e66a3 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestCallHandler.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestCallHandler.java
@@ -28,11 +28,11 @@ import org.apache.juneau.rest.vars.*;
/**
* Class that handles the basic lifecycle of an HTTP REST call.
- *
+ *
* <p>
* Subclasses can override these methods to tailor how HTTP REST calls are handled.
* Subclasses MUST implement a public constructor that takes in a {@link RestContext} object.
- *
+ *
* <p>
* RestCallHandlers are associated with servlets/resources in one of the following ways:
* <ul>
@@ -48,7 +48,7 @@ public class RestCallHandler {
/**
* Constructor.
- *
+ *
* @param context The resource context.
*/
public RestCallHandler(RestContext context) {
@@ -59,10 +59,10 @@ public class RestCallHandler {
/**
* Creates a {@link RestRequest} object based on the specified incoming {@link HttpServletRequest} object.
- *
+ *
* <p>
* Subclasses may choose to override this method to provide a specialized request object.
- *
+ *
* @param req The request object from the {@link #service(HttpServletRequest, HttpServletResponse)} method.
* @return The wrapped request object.
* @throws ServletException If any errors occur trying to interpret the request.
@@ -74,10 +74,10 @@ public class RestCallHandler {
/**
* Creates a {@link RestResponse} object based on the specified incoming {@link HttpServletResponse} object
* and the request returned by {@link #createRequest(HttpServletRequest)}.
- *
+ *
* <p>
* Subclasses may choose to override this method to provide a specialized response object.
- *
+ *
* @param req The request object returned by {@link #createRequest(HttpServletRequest)}.
* @param res The response object from the {@link #service(HttpServletRequest, HttpServletResponse)} method.
* @return The wrapped response object.
@@ -89,10 +89,10 @@ public class RestCallHandler {
/**
* The main service method.
- *
+ *
* <p>
* Subclasses can optionally override this method if they want to tailor the behavior of requests.
- *
+ *
* @param r1 The incoming HTTP servlet request object.
* @param r2 The incoming HTTP servlet response object.
* @throws ServletException
@@ -202,16 +202,16 @@ public class RestCallHandler {
/**
* 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.
- *
+ *
* <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>.
- *
+ *
* @param req The HTTP request.
* @param res The HTTP response.
* @param output The output to serialize in the response.
@@ -228,11 +228,11 @@ public class RestCallHandler {
/**
* Handle the case where a matching method was not found.
- *
+ *
* <p>
* Subclasses can override this method to provide a 2nd-chance for specifying a response.
* The default implementation will simply throw an exception with an appropriate message.
- *
+ *
* @param rc The HTTP response code.
* @param req The HTTP request.
* @param res The HTTP response.
@@ -254,14 +254,14 @@ public class RestCallHandler {
/**
* Method for handling response errors.
- *
+ *
* <p>
* 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.
- *
+ *
* @param req The servlet request.
* @param res The servlet response.
* @param e The exception that occurred.
@@ -275,14 +275,14 @@ 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 RestResource#renderResponseStackTraces() @RestResource.renderResponseStackTraces()} is enabled.
- *
+ *
* <p>
* Subclasses can override this method to provide their own custom error response handling.
- *
+ *
* @param req The servlet request.
* @param res The servlet response.
* @param e The exception that occurred.
@@ -321,10 +321,10 @@ public class RestCallHandler {
/**
* Returns the session objects for the specified request.
- *
+ *
* <p>
* The default implementation simply returns a single map containing <code>{'req':req}</code>.
- *
+ *
* @param req The REST request.
* @return The session objects for that request.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestCallRouter.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestCallRouter.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestCallRouter.java
index 48bac28..78c5e43 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestCallRouter.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestCallRouter.java
@@ -21,7 +21,7 @@ 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...
- *
+ *
* <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 RestJavaMethod.
@@ -68,10 +68,10 @@ public class RestCallRouter {
/**
* Workhorse method.
- *
+ *
* <p>
* Routes this request to one of the CallMethods.
- *
+ *
* @param pathInfo The value of {@link HttpServletRequest#getPathInfo()} (sorta)
* @return The HTTP response code.
*/
[19/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
index f538e9c..eb0d0ce 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
@@ -17,21 +17,22 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO metamodels to HTML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/html+schema</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/html+schema</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/html</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/html</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Essentially the same as {@link HtmlSerializer}, except serializes the POJO metamodel instead of the model itself.
- *
+ *
* <p>
* Produces output that describes the POJO metamodel similar to an XML schema document.
- *
+ *
* <p>
* The easiest way to create instances of this class is through the {@link HtmlSerializer#getSchemaSerializer()},
* which will create a schema serializer with the same settings as the originating serializer.
@@ -40,7 +41,7 @@ public final class HtmlSchemaDocSerializer extends HtmlDocSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store to use for creating the context for this serializer.
*/
@@ -50,7 +51,7 @@ public final class HtmlSchemaDocSerializer extends HtmlDocSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializerSession.java
index 4e7f940..1a75407 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializerSession.java
@@ -22,7 +22,7 @@ import org.apache.juneau.transform.*;
/**
* Context object that lives for the duration of a single serialization of {@link HtmlSchemaDocSerializer} and its subclasses.
- *
+ *
* <p>
* This class is NOT thread safe. It is meant to be discarded after one-time use.
*/
@@ -30,7 +30,7 @@ public class HtmlSchemaDocSerializerSession extends HtmlDocSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -49,7 +49,7 @@ public class HtmlSchemaDocSerializerSession extends HtmlDocSerializerSession {
/*
* Creates a schema representation of the specified class type.
- *
+ *
* @param eType The class type to get the schema of.
* @param ctx Serialize context used to prevent infinite loops.
* @param attrName The name of the current attribute.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializer.java
index d46f053..b496180 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializer.java
@@ -21,16 +21,17 @@ import org.apache.juneau.xml.*;
/**
* Serializes POJO models to HTML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/html</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/html</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/html</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/html</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* The conversion is as follows...
* <ul class='spaced-list'>
* <li>
@@ -44,17 +45,17 @@ import org.apache.juneau.xml.*;
* <li>
* Everything else is converted to text.
* </ul>
- *
+ *
* <p>
* This serializer provides several serialization options. Typically, one of the predefined <jsf>DEFAULT</jsf>
* serializers will be sufficient.
* However, custom serializers can be constructed to fine-tune behavior.
- *
+ *
* <p>
* The {@link HtmlLink} annotation can be used on beans to add hyperlinks to the output.
- *
+ *
* <h6 class='topic'>Behavior-specific subclasses</h6>
- *
+ *
* The following direct subclasses are provided for convenience:
* <ul class='spaced-list'>
* <li>
@@ -62,25 +63,25 @@ import org.apache.juneau.xml.*;
* <li>
* {@link SqReadable} - Default serializer, single quotes, whitespace added.
* </ul>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Use one of the default serializers to serialize a POJO</jc>
* String html = HtmlSerializer.<jsf>DEFAULT</jsf>.serialize(someObject);
- *
+ *
* <jc>// Create a custom serializer that doesn't use whitespace and newlines</jc>
* HtmlSerializer serializer = <jk>new</jk> HtmlSerializerBuider().ws().build();
- *
+ *
* <jc>// Same as above, except uses cloning</jc>
* HtmlSerializer serializer = HtmlSerializer.<jsf>DEFAULT</jsf>.builder().ws().build();
- *
+ *
* <jc>// Serialize POJOs to HTML</jc>
- *
+ *
* <jc>// Produces: </jc>
* <jc>// <ul><li>1<li>2<li>3</ul></jc>
* List l = new ObjectList(1, 2, 3);
* String html = HtmlSerializer.<jsf>DEFAULT</jsf>.serialize(l);
- *
+ *
* <jc>// Produces: </jc>
* <jc>// <table> </jc>
* <jc>// <tr><th>firstName</th><th>lastName</th></tr> </jc>
@@ -93,7 +94,7 @@ import org.apache.juneau.xml.*;
* l.add(<jk>new</jk> ObjectMap(<js>"{firstName:'Billy',lastName:'TheKid'}"</js>));
* l.add(<jk>new</jk> ObjectMap(<js>"{firstName:'Barney',lastName:'Miller'}"</js>));
* String html = HtmlSerializer.<jsf>DEFAULT</jsf>.serialize(l);
- *
+ *
* <jc>// Produces: </jc>
* <jc>// <table> </jc>
* <jc>// <tr><th>key</th><th>value</th></tr> </jc>
@@ -102,7 +103,7 @@ import org.apache.juneau.xml.*;
* <jc>// </table> </jc>
* Map m = <jk>new</jk> ObjectMap(<js>"{foo:'bar',baz:123}"</js>);
* String html = HtmlSerializer.<jsf>DEFAULT</jsf>.serialize(m);
- *
+ *
* <jc>// HTML elements can be nested arbitrarily deep</jc>
* <jc>// Produces: </jc>
* <jc>// <table> </jc>
@@ -118,8 +119,8 @@ import org.apache.juneau.xml.*;
* <jc>// </td></tr> </jc>
* <jc>// </table> </jc>
* Map m = <jk>new</jk> ObjectMap(<js>"{foo:'bar',baz:123}"</js>);
- * m.put("someNumbers", new ObjectList(1, 2, 3));
- * m.put(<js>"someSubMap"</js>, new ObjectMap(<js>"{a:'b'}"</js>));
+ * m.put(<js>"someNumbers"</js>, <jk>new</jk> ObjectList(1, 2, 3));
+ * m.put(<js>"someSubMap"</js>, <jk>new</jk> ObjectMap(<js>"{a:'b'}"</js>));
* String html = HtmlSerializer.<jsf>DEFAULT</jsf>.serialize(m);
* </p>
*/
@@ -133,7 +134,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.addBeanTypeProperties.b"</js>
@@ -145,7 +146,7 @@ public class HtmlSerializer extends XmlSerializer {
* <li class='jm'>{@link HtmlSerializerBuilder#addBeanTypeProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
@@ -153,7 +154,7 @@ public class HtmlSerializer extends XmlSerializer {
* 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>
* When present, this value overrides the {@link #SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -162,7 +163,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Configuration property: Add key/value headers on bean/map tables.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.addKeyValueTableHeaders.b"</js>
@@ -184,7 +185,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Configuration property: Look for URLs in {@link String Strings}.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.detectLinksInStrings.b"</js>
@@ -196,7 +197,7 @@ public class HtmlSerializer extends XmlSerializer {
* <li class='jm'>{@link HtmlSerializerBuilder#detectLinksInStrings(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <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
@@ -206,7 +207,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Configuration property: The parameter name to use when using {@link #HTML_lookForLabelParameters}.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.labelParameter.s"</js>
@@ -223,7 +224,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Configuration property: Look for link labels in the <js>"label"</js> parameter of the URL.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.lookForLabelParameters.b"</js>
@@ -235,11 +236,11 @@ public class HtmlSerializer extends XmlSerializer {
* <li class='jm'>{@link HtmlSerializerBuilder#lookForLabelParameters(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* 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 #HTML_labelParameter} property.
*/
@@ -247,7 +248,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Configuration property: Anchor text source.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.uriAnchorText.s"</js>
@@ -263,12 +264,12 @@ public class HtmlSerializer extends XmlSerializer {
* <li class='jm'>{@link HtmlSerializerBuilder#uriAnchorText(AnchorText)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* When creating anchor tags (e.g. <code><xt><a</xt> <xa>href</xa>=<xs>'...'</xs>
* <xt>></xt>text<xt></a></xt></code>) in HTML, this setting defines what to set the inner text to.
- *
+ *
* <p>
* See the {@link AnchorText} enum for possible values.
*/
@@ -298,7 +299,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Sq(PropertyStore ps) {
@@ -315,7 +316,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public SqReadable(PropertyStore ps) {
@@ -345,7 +346,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -355,7 +356,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
index 0b2ef60..564e8d2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
@@ -35,7 +35,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public HtmlSerializerBuilder(PropertyStore ps) {
@@ -54,7 +54,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Configuration property: Add key/value headers on bean/map tables.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link HtmlSerializer#HTML_addKeyValueTableHeaders}
@@ -74,7 +74,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
*
* <p>
* Shortcut for calling <code>addKeyValueTableHeaders(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link HtmlSerializer#HTML_addKeyValueTableHeaders}
@@ -88,12 +88,12 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Configuration property: Look for URLs in {@link String Strings}.
- *
+ *
* <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 HtmlSerializer#HTML_uriAnchorText}.
- *
- *
+ *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link HtmlSerializer#HTML_detectLinksInStrings}
@@ -110,7 +110,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Configuration property: The parameter name to use when using {@link HtmlSerializer#HTML_lookForLabelParameters}.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link HtmlSerializer#HTML_labelParameter}
@@ -127,10 +127,10 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Configuration property: Look for link labels in the <js>"label"</js> parameter of the URL.
- *
+ *
* <p>
* If the URL has a label parameter (e.g. <js>"?label=foobar"</js>), then use that as the anchor text of the link.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link HtmlSerializer#HTML_lookForLabelParameters}
@@ -147,11 +147,11 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Configuration property: Anchor text source.
- *
+ *
* <p>
* When creating anchor tags (e.g. <code><xt><a</xt> <xa>href</xa>=<xs>'...'</xs><xt>></xt>text<xt></a></xt></code>)
* in HTML, this setting defines what to set the inner text to.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link HtmlSerializer#HTML_uriAnchorText}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
index c01a2c3..ff048b1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
@@ -29,7 +29,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Session object that lives for the duration of a single use of {@link HtmlSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -48,7 +48,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -84,7 +84,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Converts the specified output target object to an {@link HtmlWriter}.
- *
+ *
* @param out The output target object.
* @return The output target object wrapped in an {@link HtmlWriter}.
* @throws Exception
@@ -101,7 +101,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Returns <jk>true</jk> if the specified object is a URL.
- *
+ *
* @param cm The ClassMeta of the object being serialized.
* @param pMeta
* The property metadata of the bean property of the object.
@@ -121,7 +121,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Returns the anchor text to use for the specified URL object.
- *
+ *
* @param pMeta
* The property metadata of the bean property of the object.
* Can be <jk>null</jk> if the object isn't from a bean property.
@@ -168,7 +168,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Returns the {@link HtmlSerializer#HTML_addKeyValueTableHeaders} setting value for this session.
- *
+ *
* @return The {@link HtmlSerializer#HTML_addKeyValueTableHeaders} setting value for this session.
*/
public final boolean isAddKeyValueTableHeaders() {
@@ -177,7 +177,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Returns the {@link HtmlSerializer#HTML_addBeanTypeProperties} setting value for this session.
- *
+ *
* @return The {@link HtmlSerializer#HTML_addBeanTypeProperties} setting value for this session.
*/
@Override /* SerializerSession */
@@ -197,7 +197,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Main serialization routine.
- *
+ *
* @param session The serialization context object.
* @param o The object being serialized.
* @param w The writer to serialize to.
@@ -211,7 +211,7 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Serialize the specified object to the specified writer.
- *
+ *
* @param out The writer.
* @param o The object to serialize.
* @param eType The expected type of the object if this is a bean property.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
index 1676dbb..4a2cedd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
@@ -17,16 +17,17 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJOs to HTTP responses as stripped HTML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/html+stripped</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/html+stripped</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/html</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/html</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Produces the same output as {@link HtmlDocSerializer}, but without the header and body tags and page title and
* description.
* Used primarily for JUnit testing the {@link HtmlDocSerializer} class.
@@ -35,7 +36,7 @@ public class HtmlStrippedDocSerializer extends HtmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public HtmlStrippedDocSerializer(PropertyStore ps) {
@@ -44,7 +45,7 @@ public class HtmlStrippedDocSerializer extends HtmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializerSession.java
index 1459fba..c90cf37 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializerSession.java
@@ -19,7 +19,7 @@ import org.apache.juneau.serializer.*;
/**
* Session object that lives for the duration of a single use of {@link HtmlStrippedDocSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe. It is meant to be discarded after one-time use.
*/
@@ -27,7 +27,7 @@ public class HtmlStrippedDocSerializerSession extends HtmlSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlWriter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlWriter.java
index 559cae4..b5386ef 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlWriter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlWriter.java
@@ -26,7 +26,7 @@ public class HtmlWriter extends XmlWriter {
/**
* Constructor.
- *
+ *
* @param out The writer being wrapped.
* @param useWhitespace If <jk>true</jk>, tabs will be used in output.
* @param maxIndent The maximum indentation level.
@@ -41,7 +41,7 @@ public class HtmlWriter extends XmlWriter {
/**
* Append an attribute with a URI value.
- *
+ *
* @param name The attribute name.
* @param value The attribute value. Can be any object whose <code>toString()</code> method returns a URI.
* @return This object (for method chaining);
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java
index 299ba7d..f845b36 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/SimpleHtmlWriter.java
@@ -16,7 +16,7 @@ import java.io.*;
/**
* Utility class for creating custom HTML.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* String table = <jk>new</jk> SimpleHtmlWriter().sTag(<js>"table"</js>).sTag(<js>"tr"</js>).sTag(<js>"td"</js>)
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/annotation/Html.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/annotation/Html.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/annotation/Html.java
index f8698d1..7cc74e9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/annotation/Html.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/annotation/Html.java
@@ -30,14 +30,14 @@ public @interface Html {
/**
* Use the specified anchor text when serializing a URI.
- *
+ *
* <p>
* The text can contain any bean property values resolved through variables of the form <js>"{property-name}"</js>.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <jk>public class</jk> FileSpace {
- *
+ *
* <ja>@Html</ja>(anchorText=<js>"drive/{drive}"</js>)
* <jk>public</jk> String getDrive() {
* ...;
@@ -49,7 +49,7 @@ public @interface Html {
/**
* Treat as plain text.
- *
+ *
* <p>
* Object is serialized to a String using the <code>toString()</code> method and written directly to output.
* Useful when you want to serialize custom HTML.
@@ -58,7 +58,7 @@ public @interface Html {
/**
* Treat as XML.
- *
+ *
* <p>
* Useful when creating beans that model HTML elements.
*/
@@ -66,10 +66,10 @@ public @interface Html {
/**
* Adds a hyperlink to a bean property when rendered as HTML.
- *
+ *
* <p>
* The text can contain any bean property values resolved through variables of the form <js>"{property-name}"</js>.
- *
+ *
* <p>
* The URLs can be any of the following forms:
* <ul>
@@ -79,11 +79,11 @@ public @interface Html {
* <li>Servlet-relative - e.g. <js>"servlet:/myPath"</js>
* <li>Path-info-relative - e.g. <js>"myPath"</js>
* </ul>
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <jk>public class</jk> FileSpace {
- *
+ *
* <ja>@Html</ja>(link=<js>"servlet:/drive/{drive}"</js>)
* <jk>public</jk> String getDrive() {
* ...;
@@ -95,7 +95,7 @@ public @interface Html {
/**
* When <jk>true</jk>, don't add headers to tables.
- *
+ *
* <p>
* Default is <jk>false</jk>.
*/
@@ -103,7 +103,7 @@ public @interface Html {
/**
* When <jk>true</jk>, collections of beans should be rendered as trees instead of tables.
- *
+ *
* <p>
* Default is <jk>false</jk>.
*/
@@ -111,7 +111,7 @@ public @interface Html {
/**
* Associates an {@link HtmlRender} with a bean property for custom HTML rendering of the property.
- *
+ *
* <p>
* This annotation applies to bean properties and classes.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Accept.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Accept.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Accept.java
index f095f97..7b56fad 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Accept.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Accept.java
@@ -21,25 +21,25 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Accept</l> HTTP request header.
- *
+ *
* <p>
* Content-Types that are acceptable for the response.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept: text/plain
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Accept request-header field can be used to specify certain media types which are acceptable for the response.
* Accept headers can be used to indicate that the request is specifically limited to a small set of desired types, as
* in the case of a request for an in-line image.
- *
+ *
* <p class='bcode'>
* Accept = "Accept" ":
* #( media-range [ accept-params ] )
- *
+ *
* media-range = ( "* /*"
* | ( type "/" "*" )
* | ( type "/" subtype )
@@ -47,12 +47,12 @@ import org.apache.juneau.internal.*;
* accept-params = ";" "q" "=" qvalue *( accept-extension )
* accept-extension = ";" token [ "=" ( token | quoted-string ) ]
* </p>
- *
+ *
* <p>
* The asterisk "*" character is used to group media types into ranges, with "* /*" indicating all media types and
* "type/*" indicating all subtypes of that type.
* The media-range MAY include media type parameters that are applicable to that range.
- *
+ *
* <p>
* Each media-range MAY be followed by one or more accept-params, beginning with the "q" parameter for indicating a
* relative quality factor.
@@ -60,7 +60,7 @@ import org.apache.juneau.internal.*;
* Quality factors allow the user or user agent to indicate the relative degree of preference for that media-range,
* using the qvalue scale from 0 to 1 (section 3.9).
* The default value is q=1.
- *
+ *
* <p>
* Note: Use of the "q" parameter name to separate media type parameters from Accept extension parameters is due to
* historical practice.
@@ -68,7 +68,7 @@ import org.apache.juneau.internal.*;
* believed to be unlikely given the lack of any "q" parameters in the IANA
* media type registry and the rare usage of any media type parameters in Accept.
* Future media types are discouraged from registering any parameter named "q".
- *
+ *
* <p>
* The example
* <p class='bcode'>
@@ -77,26 +77,26 @@ import org.apache.juneau.internal.*;
* <p>
* SHOULD be interpreted as "I prefer audio/basic, but send me any audio type if it is the best available after an 80%
* mark-down in quality."
- *
+ *
* <p>
* If no Accept header field is present, then it is assumed that the client accepts all media types.
- *
+ *
* <p>
* If an Accept header field is present, and if the server cannot send a response which is acceptable according to the
* combined Accept field value, then the server SHOULD send a 406 (not acceptable) response.
- *
+ *
* <p>
* A more elaborate example is
* <p class='bcode'>
* Accept: text/plain; q=0.5, text/html,
* text/x-dvi; q=0.8, text/x-c
* </p>
- *
+ *
* <p>
* Verbally, this would be interpreted as "text/html and text/x-c are the preferred media types, but if they do not
* exist, then send the
* text/x-dvi entity, and if that does not exist, send the text/plain entity."
- *
+ *
* <p>
* Media ranges can be overridden by more specific media ranges or specific media types.
* If more than one media range applies to a given type, the most specific reference has precedence.
@@ -112,7 +112,7 @@ import org.apache.juneau.internal.*;
* <li>text/*
* <li>* /*
* </ol>
- *
+ *
* <p>
* The media type quality factor associated with a given type is determined by finding the media range with the highest
* precedence which matches that type.
@@ -131,12 +131,12 @@ import org.apache.juneau.internal.*;
* text/html;level=2 = 0.4
* text/html;level=3 = 0.7
* </p>
- *
+ *
* <p>
* Note: A user agent might be provided with a default set of quality values for certain media ranges.
* However, unless the user agent is a closed system which cannot interact with other rendering agents, this default
* set ought to be configurable by the user.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -152,7 +152,7 @@ public final class Accept {
/**
* Returns a parsed <code>Accept</code> header.
- *
+ *
* @param value The <code>Accept</code> header string.
* @return The parsed <code>Accept</code> header, or <jk>null</jk> if the string was null.
*/
@@ -176,10 +176,10 @@ public final class Accept {
/**
* Returns the list of the media ranges that make up this header.
- *
+ *
* <p>
* The media ranges in the list are sorted by their q-value in descending order.
- *
+ *
* @return An unmodifiable list of media ranges.
*/
public List<MediaTypeRange> asRanges() {
@@ -188,7 +188,7 @@ public final class Accept {
/**
* Given a list of media types, returns the best match for this <code>Accept</code> header.
- *
+ *
* <p>
* Note that fuzzy matching is allowed on the media types where the <code>Accept</code> header may
* contain additional subtype parts.
@@ -197,11 +197,11 @@ public final class Accept {
* isn't found.
* <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'>
* ActivityPub / Retrieving Objects</a>
- *
+ *
* @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.
*/
@@ -235,11 +235,11 @@ public final class Accept {
/**
* Convenience method for searching through all of the subtypes of all the media ranges in this header for the
* presence of a subtype fragment.
- *
+ *
* <p>
* For example, given the header <js>"text/json+activity"</js>, calling
* <code>hasSubtypePart(<js>"activity"</js>)</code> returns <jk>true</jk>.
- *
+ *
* @param part The media type subtype fragment.
* @return <jk>true</jk> if subtype fragment exists.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptCharset.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptCharset.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptCharset.java
index 39e6c79..3d00338 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptCharset.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptCharset.java
@@ -19,19 +19,19 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Accept-Charset</l> HTTP request header.
- *
+ *
* <p>
* Character sets that are acceptable.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept-Charset: utf-8
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Accept-Charset request-header field can be used to indicate what character sets are acceptable for the response.
- *
+ *
* <p>
* This field allows clients capable of understanding more comprehensive or special- purpose character sets to signal
* that capability to a server which is capable of representing documents in those character sets.
@@ -39,7 +39,7 @@ import org.apache.juneau.internal.*;
* Accept-Charset = "Accept-Charset" ":"
* 1#( ( charset | "*" )[ ";" "q" "=" qvalue ] )
* </p>
- *
+ *
* <p>
* Character set values are described in section 3.4. Each charset MAY be given an associated quality value which
* represents the user's preference for that charset.
@@ -48,23 +48,23 @@ import org.apache.juneau.internal.*;
* <p class='bcode'>
* Accept-Charset: iso-8859-5, unicode-1-1;q=0.8
* </p>
- *
+ *
* <p>
* The special value "*", if present in the Accept-Charset field, matches every character set (including ISO-8859-1)
* which is not mentioned elsewhere in the Accept-Charset field.
- *
+ *
* <p>
* If no "*" is present in an Accept-Charset field, then all character sets not explicitly mentioned get a quality
* value of 0, except for ISO-8859-1, which gets a quality value of 1 if not explicitly mentioned.
- *
+ *
* <p>
* If no Accept-Charset header is present, the default is that any character set is acceptable.
- *
+ *
* <p>
* If an Accept-Charset header is present, and if the server cannot send a response which is acceptable according to
* the Accept-Charset header, then the server SHOULD send an error response with the 406 (not acceptable) status code,
* though the sending of an unacceptable response is also allowed.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -80,7 +80,7 @@ public final class AcceptCharset extends HeaderRangeArray {
/**
* Returns a parsed <code>Accept-Charset</code> header.
- *
+ *
* @param value The <code>Accept-Charset</code> header string.
* @return The parsed <code>Accept-Charset</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptEncoding.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptEncoding.java
index 9a8a516..071c6d2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptEncoding.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptEncoding.java
@@ -18,26 +18,26 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Accept-Encoding</l> HTTP request header.
- *
+ *
* <p>
* List of acceptable encodings.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept-Encoding: gzip, deflate
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Accept-Encoding request-header field is similar to Accept, but restricts the content-codings (section 3.5) that
* are acceptable in the response.
- *
+ *
* <p class='bcode'>
* Accept-Encoding = "Accept-Encoding" ":"
* 1#( codings [ ";" "q" "=" qvalue ] )
* codings = ( content-coding | "*" )
* </p>
- *
+ *
* <p>
* Examples of its use are:
* <p class='bcode'>
@@ -47,7 +47,7 @@ import org.apache.juneau.internal.*;
* Accept-Encoding: compress;q=0.5, gzip;q=1.0
* Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0
* </p>
- *
+ *
* <p>
* A server tests whether a content-coding is acceptable, according to an Accept-Encoding field, using these rules:
* <ol>
@@ -63,28 +63,28 @@ import org.apache.juneau.internal.*;
* "identity" content-coding.
* If the Accept-Encoding field-value is empty, then only the "identity" encoding is acceptable.
* </ol>
- *
+ *
* <p>
* If an Accept-Encoding field is present in a request, and if the server cannot send a response which is acceptable
* according to the Accept-Encoding header, then the server SHOULD send an error response with the 406 (Not Acceptable)
* status code.
- *
+ *
* <p>
* If no Accept-Encoding field is present in a request, the server MAY assume that the client will accept any content
* coding.
* In this case, if "identity" is one of the available content-codings, then the server SHOULD use the "identity"
* content-coding, unless it has additional information that a different content-coding is meaningful to the client.
- *
+ *
* <p>
* Note: If the request does not include an Accept-Encoding field, and if the "identity" content-coding is unavailable,
* then content-codings commonly understood by HTTP/1.0 clients (i.e.,"gzip" and "compress") are preferred; some older
* clients improperly display messages sent with other content-codings.
* The server might also make this decision based on information about the particular user-agent or client.
- *
+ *
* <p>
* Note: Most HTTP/1.0 applications do not recognize or obey qvalues associated with content-codings.
* This means that qvalues will not work and are not permitted with x-gzip or x-compress.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -100,7 +100,7 @@ public final class AcceptEncoding extends HeaderRangeArray {
/**
* Returns a parsed <code>Accept-Encoding</code> header.
- *
+ *
* @param value The <code>Accept-Encoding</code> header string.
* @return The parsed <code>Accept-Encoding</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptLanguage.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptLanguage.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptLanguage.java
index c855445..b9bef20 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptLanguage.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptLanguage.java
@@ -18,27 +18,27 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Accept-Language</l> HTTP request header.
- *
+ *
* <p>
* List of acceptable human languages for response.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept-Language: en-US
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Accept-Language request-header field is similar to Accept, but restricts the set of natural languages that are
* preferred as a response to the request.
* Language tags are defined in section 3.10.
- *
+ *
* <p class='bcode'>
* Accept-Language = "Accept-Language" ":"
* 1#( language-range [ ";" "q" "=" qvalue ] )
* language-range = ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) | "*" )
* </p>
- *
+ *
* <p>
* Each language-range MAY be given an associated quality value which represents an estimate of the user's preference
* for the languages specified by that range.
@@ -49,46 +49,46 @@ import org.apache.juneau.internal.*;
* </p>
* <p>
* ...would mean: "I prefer Danish, but will accept British English and other types of English."
- *
+ *
* <p>
* A language-range matches a language-tag if it exactly equals the tag, or if it exactly equals a prefix of the tag
* such that the first tag character following the prefix is "-".
- *
+ *
* <p>
* The special range "*", if present in the Accept-Language field, matches every tag not matched by any other range
* present in the Accept-Language field.
- *
+ *
* <p>
* Note: This use of a prefix matching rule does not imply that language tags are assigned to languages in such a way
* that it is always true that if a user understands a language with a certain
* tag, then this user will also understand all languages with tags for which this tag is a prefix.
* The prefix rule simply allows the use of prefix tags if this is the case.
- *
+ *
* <p>
* The language quality factor assigned to a language-tag by the Accept-Language field is the quality value of the
* longest language- range in the field that matches the language-tag.
- *
+ *
* <p>
* If no language- range in the field matches the tag, the language quality factor assigned is 0.
- *
+ *
* <p>
* If no Accept-Language header is present in the request, the server SHOULD assume that all languages are equally
* acceptable.
- *
+ *
* <p>
* If an Accept-Language header is present, then all languages which are assigned a quality factor greater than 0 are
* acceptable.
- *
+ *
* <p>
* It might be contrary to the privacy expectations of the user to send an Accept-Language header with the complete
* linguistic preferences of the user in every request.
* For a discussion of this issue, see section 15.1.4.
- *
+ *
* <p>
* As intelligibility is highly dependent on the individual user, it is recommended that client applications make the
* choice of linguistic preference available to the user.
* If the choice is not made available, then the Accept-Language header field MUST NOT be given in the request.
- *
+ *
* <p>
* Note: When making the choice of linguistic preference available to the user, we remind implementors of the fact that
* users are not familiar with the details of language matching as described above, and should provide appropriate
@@ -96,7 +96,7 @@ import org.apache.juneau.internal.*;
* As an example, users might assume that on selecting "en-gb", they will be served any kind of English document if
* British English is not available.
* A user agent might suggest in such a case to add "en" to get the best matching behavior.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -112,7 +112,7 @@ public final class AcceptLanguage extends HeaderRangeArray {
/**
* Returns a parsed <code>Accept-Language</code> header.
- *
+ *
* @param value The <code>Accept-Language</code> header string.
* @return The parsed <code>Accept-Language</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptRanges.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptRanges.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptRanges.java
index 18023b8..9650084 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptRanges.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/AcceptRanges.java
@@ -14,24 +14,24 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Accept-Range</l> HTTP response header.
- *
+ *
* <p>
* What partial content range types this server supports via byte serving.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept-Ranges: bytes
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Accept-Ranges response-header field allows the server to indicate its acceptance of range requests for a
* resource:
* <p class='bcode'>
* Accept-Ranges = "Accept-Ranges" ":" acceptable-ranges
* acceptable-ranges = 1#range-unit | "none"
* </p>
- *
+ *
* <p>
* Origin servers that accept byte-range requests MAY send...
* <p class='bcode'>
@@ -39,13 +39,13 @@ package org.apache.juneau.http;
* </p>
* <p>
* ...but are not required to do so.
- *
+ *
* <p>
* Clients MAY generate byte-range requests without having received this header for the resource involved.
- *
+ *
* <p>
* Range units are defined in section 3.12.
- *
+ *
* <p>
* Servers that do not accept any kind of range request for a resource MAY send...
* <p class='bcode'>
@@ -53,7 +53,7 @@ package org.apache.juneau.http;
* </p>
* <p>
* ...to advise the client not to attempt a range request.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -67,7 +67,7 @@ public final class AcceptRanges extends HeaderString {
/**
* Returns a parsed <code>Accept-Ranges</code> header.
- *
+ *
* @param value The <code>Accept-Ranges</code> header string.
* @return The parsed <code>Accept-Ranges</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Age.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Age.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Age.java
index 8cbdff0..4286b33 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Age.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Age.java
@@ -14,41 +14,41 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Age</l> HTTP response header.
- *
+ *
* <p>
* The age the object has been in a proxy cache in seconds.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Age: 12
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Age response-header field conveys the sender's estimate of the amount of time since the response (or its
* revalidation) was generated at the origin server.
* A cached response is "fresh" if its age does not exceed its freshness lifetime.
* Age values are calculated as specified in section 13.2.3.
- *
+ *
* <p class='bcode'>
* Age = "Age" ":" age-value
* age-value = delta-seconds
* </p>
- *
+ *
* <p>
* Age values are non-negative decimal integers, representing time in seconds.
- *
+ *
* <p>
* If a cache receives a value larger than the largest positive integer it can represent, or if any of its age
* calculations overflows, it MUST transmit an Age header with a value of 2147483648 (2^31).
- *
+ *
* <p>
* An HTTP/1.1 server that includes a cache MUST include an Age header field in every response generated from its own
* cache.
- *
+ *
* <p>
* Caches SHOULD use an arithmetic type of at least 31 bits of range.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -62,7 +62,7 @@ public final class Age extends HeaderInteger {
/**
* Returns a parsed <code>Age</code> header.
- *
+ *
* @param value The <code>Age</code> header string.
* @return The parsed <code>Age</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Allow.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Allow.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Allow.java
index b0fab92..21dbc29 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Allow.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Allow.java
@@ -14,51 +14,51 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Allow</l> HTTP response header.
- *
+ *
* <p>
* Valid methods for a specified resource. To be used for a 405 Method not allowed.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Allow: GET, HEAD
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Allow entity-header field lists the set of methods supported by the resource identified by the Request-URI.
* The purpose of this field is strictly to inform the recipient of valid methods associated with the resource.
* An Allow header field MUST be present in a 405 (Method Not Allowed) response.
- *
+ *
* <p class='bcode'>
* Allow = "Allow" ":" #Method
* </p>
- *
+ *
* <p>
* Example of use:
* <p class='bcode'>
* Allow: GET, HEAD, PUT
* </p>
- *
+ *
* <p>
* This field cannot prevent a client from trying other methods.
* However, the indications given by the Allow header field value SHOULD be followed.
- *
+ *
* <p>
* The actual set of allowed methods is defined by the origin server at the time of each request.
- *
+ *
* <p>
* The Allow header field MAY be provided with a PUT request to recommend the methods to be supported by the new or
* modified resource.
- *
+ *
* <p>
* The server is not required to support these methods and SHOULD include an Allow header in the response giving the
* actual supported methods.
- *
+ *
* <p>
* A proxy MUST NOT modify the Allow header field even if it does not understand all the methods specified, since the
* user agent might
* have other means of communicating with the origin server.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -72,7 +72,7 @@ public final class Allow extends HeaderStringArray {
/**
* Returns a parsed <code>Allow</code> header.
- *
+ *
* @param value The <code>Allow</code> header string.
* @return The parsed <code>Allow</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Authorization.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Authorization.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Authorization.java
index 07412c8..8a3cfdc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Authorization.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Authorization.java
@@ -14,36 +14,36 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Authorization</l> HTTP request header.
- *
+ *
* <p>
* Authentication credentials for HTTP authentication.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* A user agent that wishes to authenticate itself with a server--usually, but not necessarily, after receiving a 401
* response--does so by including an Authorization request-header field with the request.
- *
+ *
* <p>
* The Authorization field value consists of credentials containing the authentication information of the user agent for
* the realm of the resource being requested.
- *
+ *
* <p class='bcode'>
* Authorization = "Authorization" ":" credentials
* </p>
- *
+ *
* <p>
* HTTP access authentication is described in "HTTP Authentication: Basic and Digest Access Authentication".
- *
+ *
* <p>
* If a request is authenticated and a realm specified, the same credentials SHOULD be valid for all other requests
* within this realm (assuming that the authentication scheme itself does not require otherwise, such as credentials
* that vary according to a challenge value or using synchronized clocks).
- *
+ *
* <p>
* When a shared cache (see section 13.7) receives a request containing an Authorization field, it MUST NOT return the
* corresponding response as a reply to any other request, unless one of the following specific exceptions holds:
@@ -62,7 +62,7 @@ package org.apache.juneau.http;
* <li>If the response includes the "public" cache-control directive, it MAY be returned in reply to any subsequent
* request.
* </ol>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -76,7 +76,7 @@ public final class Authorization extends HeaderString {
/**
* Returns a parsed <code>Authorization</code> header.
- *
+ *
* @param value The <code>Authorization</code> header string.
* @return The parsed <code>Authorization</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/CacheControl.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/CacheControl.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/CacheControl.java
index 8c46228..b618673 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/CacheControl.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/CacheControl.java
@@ -14,33 +14,33 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Cache-Control</l> HTTP request header.
- *
+ *
* <p>
* Used to specify directives that must be obeyed by all caching mechanisms along the request-response chain.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Cache-Control: no-cache
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Cache-Control general-header field is used to specify directives that MUST be obeyed by all caching mechanisms
* along the request/response chain.
* The directives specify behavior intended to prevent caches from adversely interfering with the request or response.
* These directives typically override the default caching algorithms.
* Cache directives are unidirectional in that the presence of a directive in a request does not imply that the same
* directive is to be given in the response.
- *
+ *
* <p>
* Note that HTTP/1.0 caches might not implement Cache-Control and might only implement Pragma: no-cache (see section
* 14.32).
- *
+ *
* <p>
* Cache directives MUST be passed through by a proxy or gateway application, regardless of their significance to that
* application, since the directives might be applicable to all recipients along the request/response chain.
* It is not possible to specify a cache- directive for a specific cache.
- *
+ *
* <p class='bcode'>
* Cache-Control = "Cache-Control" ":" 1#cache-directive
* cache-directive = cache-request-directive
@@ -67,13 +67,13 @@ package org.apache.juneau.http;
* | cache-extension ; Section 14.9.6
* cache-extension = token [ "=" ( token | quoted-string ) ]
* </p>
- *
+ *
* <p>
* When a directive appears without any 1#field-name parameter, the directive applies to the entire request or response.
* When such a directive appears with a 1#field-name parameter, it applies only to the named field or fields, and not
* to the rest of the request or response. This mechanism supports extensibility; implementations of future versions
* of the HTTP protocol might apply these directives to header fields not defined in HTTP/1.1.
- *
+ *
* <p>
* The cache-control directives can be broken down into these general categories:
* <ul>
@@ -86,7 +86,7 @@ package org.apache.juneau.http;
* <li>Control over transformation of entities.
* <li>Extensions to the caching system.
* </ul>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -100,7 +100,7 @@ public final class CacheControl extends HeaderString {
/**
* Returns a parsed <code>Cache-Control</code> header.
- *
+ *
* @param value The <code>Cache-Control</code> header string.
* @return The parsed <code>Cache-Control</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Connection.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Connection.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Connection.java
index c005c25..8ac955f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Connection.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Connection.java
@@ -14,38 +14,38 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Connection</l> HTTP request header.
- *
+ *
* <p>
* Control options for the current connection and list of hop-by-hop request fields.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Connection: keep-alive
* Connection: Upgrade
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Connection general-header field allows the sender to specify options that are desired for that particular
* connection and MUST NOT be communicated by proxies over further connections.
- *
+ *
* <p>
* The Connection header has the following grammar:
* <p class='bcode'>
* Connection = "Connection" ":" 1#(connection-token)
* connection-token = token
* </p>
- *
+ *
* <p>
* HTTP/1.1 proxies MUST parse the Connection header field before a message is forwarded and, for each connection-token
* in this field, remove any header field(s) from the message with the same name as the connection-token.
* Connection options are signaled by the presence of a connection-token in the Connection header field, not by any
* corresponding additional header field(s), since the additional header field may not be sent if there are no
* parameters associated with that connection option.
- *
+ *
* <p>
* Message headers listed in the Connection header MUST NOT include end-to-end headers, such as Cache-Control.
- *
+ *
* <p>
* HTTP/1.1 defines the "close" connection option for the sender to signal that the connection will be closed after
* completion of the response.
@@ -56,18 +56,18 @@ package org.apache.juneau.http;
* <p>
* ...in either the request or the response header fields indicates that the connection SHOULD NOT be considered
* `persistent' (section 8.1) after the current request/response is complete.
- *
+ *
* <p>
* HTTP/1.1 applications that do not support persistent connections MUST include the "close" connection option in
* every message.
- *
+ *
* <p>
* A system receiving an HTTP/1.0 (or lower-version) message that includes a Connection header MUST, for each
* connection-token in this field, remove and ignore any header field(s) from the message with the same name as the
* connection-token.
* This protects against mistaken forwarding of such header fields by pre-HTTP/1.1 proxies.
* See section 19.6.2.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -81,7 +81,7 @@ public final class Connection extends HeaderString {
/**
* Returns a parsed <code>Connection</code> header.
- *
+ *
* @param value The <code>Connection</code> header string.
* @return The parsed <code>Connection</code> header, or <jk>null</jk> if the string was null.
*/
@@ -98,7 +98,7 @@ public final class Connection extends HeaderString {
/**
* Returns <jk>true</jk> if the header value is <code>close</code>.
- *
+ *
* @return <jk>true</jk> if the header value is <code>close</code>.
*/
public boolean isClose() {
@@ -107,7 +107,7 @@ public final class Connection extends HeaderString {
/**
* Returns <jk>true</jk> if the header value is <code>keep-alive</code>.
- *
+ *
* @return <jk>true</jk> if the header value is <code>keep-alive</code>.
*/
public boolean isKeepAlive() {
@@ -116,7 +116,7 @@ public final class Connection extends HeaderString {
/**
* Returns <jk>true</jk> if the header value is <code>upgrade</code>.
- *
+ *
* @return <jk>true</jk> if the header value is <code>upgrade</code>.
*/
public boolean isUpgrade() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Constants.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Constants.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Constants.java
index 2547b48..c3ab5d7 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Constants.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Constants.java
@@ -14,7 +14,7 @@ package org.apache.juneau.http;
/**
* Constants used by classes in this package.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncoding.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncoding.java
index 76f9552..ce0ee3c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncoding.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncoding.java
@@ -14,17 +14,17 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Content-Encoding</l> HTTP response header.
- *
+ *
* <p>
* The type of encoding used on the data.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Content-Encoding: gzip
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Content-Encoding entity-header field is used as a modifier to the media-type.
* When present, its value indicates what additional content codings have been applied to the entity-body, and thus
* what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type header
@@ -34,32 +34,32 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Content-Encoding = "Content-Encoding" ":" 1#content-coding
* </p>
- *
+ *
* <p>
* Content codings are defined in section 3.5. An example of its use is...
* <p class='bcode'>
* Content-Encoding: gzip
* </p>
- *
+ *
* <p>
* The content-coding is a characteristic of the entity identified by the Request-URI.
* Typically, the entity-body is stored with this encoding and is only decoded before rendering or analogous usage.
* However, a non-transparent proxy MAY modify the content-coding if the new coding is known to be acceptable to the
* recipient, unless the "no-transform" cache-control directive is present in the message.
- *
+ *
* <p>
* If the content-coding of an entity is not "identity", then the response MUST include a Content-Encoding
* entity-header (section 14.11) that lists the non-identity content-coding(s) used.
- *
+ *
* <p>
* If the content-coding of an entity in a request message is not acceptable to the origin server, the server SHOULD
* respond with a status code of 415 (Unsupported Media Type).
- *
+ *
* <p>
* If multiple encodings have been applied to an entity, the content codings MUST be listed in the order in which they
* were applied.
* Additional information about the encoding parameters MAY be provided.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -73,7 +73,7 @@ public final class ContentEncoding extends HeaderEnum<ContentEncodingEnum> {
/**
* Returns a parsed <code>Content-Encoding</code> header.
- *
+ *
* @param value The <code>Content-Encoding</code> header string.
* @return The parsed <code>Content-Encoding</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
index 9e7e820..58b4517 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentEncodingEnum.java
@@ -14,7 +14,7 @@ package org.apache.juneau.http;
/**
* Represents the possible values for a <code>Content-Encoding</code> header.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLanguage.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLanguage.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLanguage.java
index 4e6cef5..294b3e3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLanguage.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLanguage.java
@@ -14,24 +14,24 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Content-Language</l> HTTP response header.
- *
+ *
* <p>
* The natural language or languages of the intended audience for the enclosed content.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Content-Language: da
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Content-Language entity-header field describes the natural language(s) of the intended audience for the
* enclosed entity.
* Note that this might not be equivalent to all the languages used within the entity-body.
* <p class='bcode'>
* Content-Language = "Content-Language" ":" 1#language-tag
* </p>
- *
+ *
* <p>
* Language tags are defined in section 3.10.
* The primary purpose of Content-Language is to allow a user to identify and differentiate entities according to the
@@ -40,12 +40,12 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Content-Language: da
* </p>
- *
+ *
* <p>
* If no Content-Language is specified, the default is that the content is intended for all language audiences.
* This might mean that the sender does not consider it to be specific to any natural language, or that the sender
* does not know for which language it is intended.
- *
+ *
* <p>
* Multiple languages MAY be listed for content that is intended for multiple audiences.
* For example, a rendition of the "Treaty of Waitangi," presented simultaneously in the original Maori and English
@@ -53,17 +53,17 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Content-Language: mi, en
* </p>
- *
+ *
* <p>
* However, just because multiple languages are present within an entity does not mean that it is intended for
* multiple linguistic audiences.
* An example would be a beginner's language primer, such as "A First Lesson in Latin," which is clearly intended to
* be used by an English-literate audience.
* In this case, the Content-Language would properly only include "en".
- *
+ *
* <p>
* Content-Language MAY be applied to any media type -- it is not limited to textual documents.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -77,7 +77,7 @@ public final class ContentLanguage extends HeaderStringArray {
/**
* Returns a parsed <code>Content-Language</code> header.
- *
+ *
* @param value The <code>Content-Language</code> header string.
* @return The parsed <code>Content-Language</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLength.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLength.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLength.java
index a0f3777..9c93965 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLength.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLength.java
@@ -14,44 +14,44 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Content-Length</l> HTTP request/response header.
- *
+ *
* <p>
* The length of the response body in octets (8-bit bytes).
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Content-Length: 348
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Content-Length entity-header field indicates the size of the entity-body, in decimal number of OCTETs, sent to
* the recipient or, in the case of the HEAD method, the size of the entity-body that would have been sent had the
* request been a GET.
* <p class='bcode'>
* Content-Length = "Content-Length" ":" 1*DIGIT
* </p>
- *
+ *
* <p>
* An example is...
* <p class='bcode'>
* Content-Length: 3495
* </p>
- *
+ *
* <p>
* Applications SHOULD use this field to indicate the transfer-length of the message-body, unless this is prohibited by
* the rules in section 4.4.
- *
+ *
* <p>
* Any Content-Length greater than or equal to zero is a valid value.
* Section 4.4 describes how to determine the length of a message-body if a Content-Length is not given.
- *
+ *
* <p>
* Note that the meaning of this field is significantly different from the corresponding definition in MIME, where it is
* an optional field used within the "message/external-body" content-type.
* In HTTP, it SHOULD be sent whenever the message's length can be determined prior to being transferred, unless this is
* prohibited by the rules in section 4.4.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -65,7 +65,7 @@ public final class ContentLength extends HeaderInteger {
/**
* Returns a parsed <code>Content-Length</code> header.
- *
+ *
* @param value The <code>Content-Length</code> header string.
* @return The parsed <code>Content-Length</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLocation.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLocation.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLocation.java
index f222af0..69b81f8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLocation.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentLocation.java
@@ -14,17 +14,17 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Content-Location</l> HTTP response header.
- *
+ *
* <p>
* An alternate location for the returned data.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Content-Location: /index.htm
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Content-Location entity-header field MAY be used to supply the resource location for the entity enclosed in the
* message when that entity is accessible from a location separate from the requested resource's URI.
* A server SHOULD provide a Content-Location for the variant corresponding to the response entity; especially in the
@@ -35,29 +35,29 @@ package org.apache.juneau.http;
* Content-Location = "Content-Location" ":"
* ( absoluteURI | relativeURI )
* </p>
- *
+ *
* <p>
* The value of Content-Location also defines the base URI for the entity.
- *
+ *
* <p>
* The Content-Location value is not a replacement for the original requested URI; it is only a statement of the
* location of the resource corresponding to this particular entity at the time of the request.
* Future requests MAY specify the Content-Location URI as the request- URI if the desire is to identify the source of
* that particular entity.
- *
+ *
* <p>
* A cache cannot assume that an entity with a Content-Location different from the URI used to retrieve it can be used
* to respond to later requests on that Content-Location URI.
* However, the Content- Location can be used to differentiate between multiple entities retrieved from a single
* requested resource, as described in section 13.6.
- *
+ *
* <p>
* If the Content-Location is a relative URI, the relative URI is interpreted relative to the Request-URI.
- *
+ *
* <p>
* The meaning of the Content-Location header in PUT or POST requests is undefined; servers are free to ignore it in
* those cases.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -71,7 +71,7 @@ public final class ContentLocation extends HeaderUri {
/**
* Returns a parsed <code>Content-Location</code> header.
- *
+ *
* @param value The <code>Content-Location</code> header string.
* @return The parsed <code>Content-Location</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentRange.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentRange.java
index dc7ef18..b688c87 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentRange.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentRange.java
@@ -14,17 +14,17 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Content-Range</l> HTTP response header.
- *
+ *
* <p>
* Where in a full body message this partial message belongs.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Content-Range: bytes 21010-47021/47022
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Content-Range entity-header is sent with a partial entity-body to specify where in the full entity-body the
* partial body should be applied.
* Range units are defined in section 3.12.
@@ -38,28 +38,28 @@ package org.apache.juneau.http;
* | "*"
* instance-length = 1*DIGIT
* </p>
- *
+ *
* <p>
* The header SHOULD indicate the total length of the full entity-body, unless this length is unknown or difficult to
* determine.
* The asterisk "*" character means that the instance-length is unknown at the time when the response was generated.
- *
+ *
* <p>
* Unlike byte-ranges-specifier values (see section 14.35.1), a byte- range-resp-spec MUST only specify one range, and
* MUST contain absolute byte positions for both the first and last byte of the range.
- *
+ *
* <p>
* A byte-content-range-spec with a byte-range-resp-spec whose last- byte-pos value is less than its first-byte-pos
* value, or whose instance-length value is less than or equal to its last-byte-pos value, is invalid.
* The recipient of an invalid byte-content-range- spec MUST ignore it and any content transferred along with it.
- *
+ *
* <p>
* A server sending a response with status code 416 (Requested range not satisfiable) SHOULD include a Content-Range
* field with a byte-range- resp-spec of "*".
* The instance-length specifies the current length of the selected resource.
* A response with status code 206 (Partial Content) MUST NOT include a Content-Range field with a byte-range-resp-spec
* of "*".
- *
+ *
* <p>
* Examples of byte-content-range-spec values, assuming that the entity contains a total of 1234 bytes:
* <p class='bcode'>
@@ -72,7 +72,7 @@ package org.apache.juneau.http;
* The last 500 bytes:
* bytes 734-1233/1234
* </p>
- *
+ *
* <p>
* When an HTTP message includes the content of a single range (for example, a response to a request for a single range,
* or to a request for a set of ranges that overlap without any holes), this content is transmitted with a Content-Range
@@ -86,40 +86,40 @@ package org.apache.juneau.http;
* Content-Length: 26012
* Content-Type: image/gif
* </p>
- *
+ *
* <p>
* When an HTTP message includes the content of multiple ranges (for example, a response to a request for multiple
* non-overlapping ranges), these are transmitted as a multipart message.
* The multipart media type used for this purpose is "multipart/byteranges" as defined in appendix 19.2.
* See appendix 19.6.3 for a compatibility issue.
- *
+ *
* <p>
* A response to a request for a single range MUST NOT be sent using the multipart/byteranges media type.
* A response to a request for multiple ranges, whose result is a single range, MAY be sent as a multipart/byteranges
* media type with one part.
* A client that cannot decode a multipart/byteranges message MUST NOT ask for multiple byte-ranges in a single request.
- *
+ *
* <p>
* When a client requests multiple byte-ranges in one request, the server SHOULD return them in the order that they
* appeared in the request.
- *
+ *
* <p>
* If the server ignores a byte-range-spec because it is syntactically invalid, the server SHOULD treat the request as
* if the invalid Range header field did not exist.
* (Normally, this means return a 200 response containing the full entity).
- *
+ *
* <p>
* If the server receives a request (other than one including an If- Range request-header field) with an unsatisfiable
* Range request- header field
* (that is, all of whose byte-range-spec values have a first-byte-pos value greater than the current length of the
* selected resource),
* it SHOULD return a response code of 416 (Requested range not satisfiable) (section 10.4.17).
- *
+ *
* <p>
* Note: clients cannot depend on servers to send a 416 (Requested range not satisfiable) response instead of a 200 (OK)
* response for
* an unsatisfiable Range request-header, since not all servers implement this request-header.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -133,7 +133,7 @@ public final class ContentRange extends HeaderString {
/**
* Returns a parsed <code>Content-Range</code> header.
- *
+ *
* @param value The <code>Content-Range</code> header string.
* @return The parsed <code>Content-Range</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentType.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentType.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentType.java
index 062a199..3a5bb79 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentType.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ContentType.java
@@ -18,30 +18,30 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Content-Type</l> HTTP request/response header.
- *
+ *
* <p>
* The MIME type of this content.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Content-Type: text/html; charset=utf-8
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Content-Type entity-header field indicates the media type of the entity-body sent to the recipient or, in the
* case of the HEAD method, the media type that would have been sent had the request been a GET.
* <p class='bcode'>
* Content-Type = "Content-Type" ":" media-type
* </p>
- *
+ *
* <p>
* Media types are defined in section 3.7.
* An example of the field is...
* <p class='bcode'>
* Content-Type: text/html; charset=ISO-8859-4
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -57,7 +57,7 @@ public class ContentType extends MediaType {
/**
* Returns a parsed <code>Content-Type</code> header.
- *
+ *
* @param value The <code>Content-Type</code> header string.
* @return The parsed <code>Content-Type</code> header, or <jk>null</jk> if the string was null.
*/
@@ -77,7 +77,7 @@ public class ContentType extends MediaType {
/**
* Given a list of media types, returns the best match for this <code>Content-Type</code> header.
- *
+ *
* <p>
* Note that fuzzy matching is allowed on the media types where the <code>Content-Types</code> header may
* contain additional subtype parts.
@@ -86,7 +86,7 @@ public class ContentType extends MediaType {
* 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.
- *
+ *
* @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.
*/
[09/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java
index a026209..39e4171 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializerBuilder.java
@@ -34,7 +34,7 @@ public class XmlSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public XmlSerializerBuilder(PropertyStore ps) {
@@ -53,10 +53,10 @@ public class XmlSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Add namespace URLs to the root element.
- *
+ *
* <p>
* Use this setting to add {@code xmlns:x} attributes to the root element for the default and all mapped namespaces.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlSerializer#XML_addNamespaceUrisToRoot}
@@ -73,10 +73,10 @@ public class XmlSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Add namespace URLs to the root element.
- *
+ *
* <p>
* Shortcut for calling <code>addNamespaceUrisToRoot(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlSerializer#XML_addNamespaceUrisToRoot}
@@ -90,10 +90,10 @@ public class XmlSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Auto-detect namespace usage.
- *
+ *
* <p>
* Detect namespace usage before serialization.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlSerializer#XML_autoDetectNamespaces}
@@ -110,10 +110,10 @@ public class XmlSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Default namespace.
- *
+ *
* <p>
* Specifies the default namespace URI for this document.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlSerializer#XML_defaultNamespace}
@@ -130,10 +130,10 @@ public class XmlSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Enable support for XML namespaces.
- *
+ *
* <p>
* If not enabled, XML output will not contain any namespaces regardless of any other settings.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlSerializer#XML_enableNamespaces}
@@ -150,10 +150,10 @@ public class XmlSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Enable support for XML namespaces.
- *
+ *
* <p>
* Shortcut for calling <code>enableNamespaces(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlSerializer#XML_enableNamespaces}
@@ -167,10 +167,10 @@ public class XmlSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Enable support for XML namespaces.
- *
+ *
* <p>
* Shortcut for calling <code>enableNamespaces(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlSerializer#XML_enableNamespaces}
@@ -184,10 +184,10 @@ public class XmlSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Default namespaces.
- *
+ *
* <p>
* The default list of namespaces associated with this serializer.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlSerializer#XML_namespaces}
@@ -202,11 +202,11 @@ public class XmlSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: XMLSchema namespace.
- *
+ *
* <p>
* Specifies the namespace for the <code>XMLSchema</code> namespace, used by the schema generated by the
* {@link XmlSchemaSerializer} class.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlSerializer#XML_xsNamespace}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java
index 46290ed..935dfd4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializerSession.java
@@ -29,7 +29,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Session object that lives for the duration of a single use of {@link XmlSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -52,7 +52,7 @@ public class XmlSerializerSession extends WriterSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -107,7 +107,7 @@ public class XmlSerializerSession extends WriterSerializerSession {
/*
* Add a namespace to this session.
- *
+ *
* @param ns The namespace being added.
*/
private void addNamespace(Namespace ns) {
@@ -126,7 +126,7 @@ public class XmlSerializerSession extends WriterSerializerSession {
/**
* Returns the {@link XmlSerializer#XML_addBeanTypeProperties} setting value for this session.
- *
+ *
* @return The {@link XmlSerializer#XML_addBeanTypeProperties} setting value for this session.
*/
@Override /* SerializerSession */
@@ -136,11 +136,11 @@ public class XmlSerializerSession extends WriterSerializerSession {
/**
* Returns <jk>true</jk> if we're serializing HTML.
- *
+ *
* <p>
* The difference in behavior is how empty non-void elements are handled.
* The XML serializer will produce a collapsed tag, whereas the HTML serializer will produce a start and end tag.
- *
+ *
* @return <jk>true</jk> if we're generating HTML.
*/
protected boolean isHtmlMode() {
@@ -149,7 +149,7 @@ public class XmlSerializerSession extends WriterSerializerSession {
/**
* Converts the specified output target object to an {@link XmlWriter}.
- *
+ *
* @param out The output target object.
* @return The output target object wrapped in an {@link XmlWriter}.
* @throws Exception
@@ -172,7 +172,7 @@ public class XmlSerializerSession extends WriterSerializerSession {
/**
* Recursively searches for the XML namespaces on the specified POJO and adds them to the serializer context object.
- *
+ *
* @param o The POJO to check.
* @throws SerializeException
*/
@@ -254,7 +254,7 @@ public class XmlSerializerSession extends WriterSerializerSession {
/**
* Workhorse method.
- *
+ *
* @param out The writer to send the output to.
* @param o The object to serialize.
* @param eType The expected type if this is a bean property value being serialized.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlUtils.java
index 8cbdccc..88d9270 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlUtils.java
@@ -35,7 +35,7 @@ public final class XmlUtils {
/**
* Encodes any invalid XML element name characters to <code>_x####_</code> sequences.
- *
+ *
* @param w The writer to send the output to.
* @param o The object being encoded.
* @return The same writer passed in.
@@ -57,7 +57,7 @@ public final class XmlUtils {
/**
* Encodes any invalid XML element name characters to <code>_x####_</code> sequences.
- *
+ *
* @param o The object being encoded.
* @return The encoded element name string.
*/
@@ -131,7 +131,7 @@ public final class XmlUtils {
/**
* Escapes invalid XML text characters to <code>_x####_</code> sequences.
- *
+ *
* @param o The object being encoded.
* @return The encoded string.
*/
@@ -166,13 +166,13 @@ 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.
- *
+ *
* @param w The writer to send the output to.
* @param o The object being encoded.
* @param trim Trim the text before serializing it.
@@ -245,7 +245,7 @@ public final class XmlUtils {
/**
* Serializes and encodes the specified object as valid XML attribute name.
- *
+ *
* @param w The writer to send the output to.
* @param o The object being serialized.
* @return This object (for method chaining).
@@ -302,13 +302,13 @@ 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.
- *
+ *
* @param w The writer to send the output to.
* @param o The object being encoded.
* @param trim
@@ -380,7 +380,7 @@ public final class XmlUtils {
/**
* Translates any _x####_ sequences (introduced by the various encode methods) back into their original characters.
- *
+ *
* @param s The string being decoded.
* @param sb The string builder to use as a scratch pad.
* @return The decoded string.
@@ -418,7 +418,7 @@ public final class XmlUtils {
/**
* Given a list of Strings and other Objects, combines Strings that are next to each other in the list.
- *
+ *
* @param l The list of text nodes to collapse.
* @return The same list.
*/
@@ -481,10 +481,10 @@ public final class XmlUtils {
/**
* Find the namespace given a list of <ja>@Xml</ja> and <ja>@XmlSchema</ja> annotations.
- *
+ *
* <p>
* The annotations should be a child-to-parent ordering of annotations found on a class or method.
- *
+ *
* @param xmls The list of <ja>@Xml</ja> annotations.
* @param schemas The list of <ja>@XmlSchema</ja> annotations.
* @return The namespace, or <jk>null</jk> if it couldn't be found.
@@ -548,7 +548,7 @@ public final class XmlUtils {
/**
* Utility method that converts the current event on the XML stream to something human-readable for debug purposes.
- *
+ *
* @param r The XML stream reader whose current event is to be converted to a readable string.
* @return The event in human-readable form.
*/
@@ -589,7 +589,7 @@ public final class XmlUtils {
/**
* Shortcut for calling <code>URLEncoder.<jsm>encode</jsm>(o.toString(), <js>"UTF-8"</js>)</code>.
- *
+ *
* @param o The object to encode.
* @return The URL encoded string, or <jk>null</jk> if the object was null.
*/
@@ -603,7 +603,7 @@ public final class XmlUtils {
/**
* Shortcut for calling <code>URLEncoder.<jsm>decode</jsm>(o.toString(), <js>"UTF-8"</js>)</code>.
- *
+ *
* @param s The string to decode.
* @return The decoded string, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlWriter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlWriter.java
index 509b6a2..5a4cf52 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlWriter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlWriter.java
@@ -21,8 +21,9 @@ import org.apache.juneau.xml.annotation.*;
/**
* Specialized writer for serializing XML.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>This class is not intended for external use.
* </ul>
@@ -34,7 +35,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Constructor.
- *
+ *
* @param out The wrapped writer.
* @param useWhitespace If <jk>true</jk> XML elements will be indented.
* @param maxIndent The maximum indentation level.
@@ -53,7 +54,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Writes an opening tag to the output: <code><xt><ns:name</xt></code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
* @param needsEncoding If <jk>true</jk>, element name will be encoded.
@@ -73,7 +74,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>oTag(ns, name, <jk>false</jk>);</code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
* @return This object (for method chaining).
@@ -85,7 +86,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>oTag(<jk>null</jk>, name, <jk>false</jk>);</code>
- *
+ *
* @param name The element name.
* @return This object (for method chaining).
* @throws IOException If a problem occurred.
@@ -96,7 +97,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>i(indent).oTag(ns, name, needsEncoding);</code>
- *
+ *
* @param indent The number of prefix tabs to add.
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
@@ -110,7 +111,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>i(indent).oTag(ns, name, <jk>false</jk>);</code>
- *
+ *
* @param indent The number of prefix tabs to add.
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
@@ -123,7 +124,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>i(indent).oTag(<jk>null</jk>, name, <jk>false</jk>);</code>
- *
+ *
* @param indent The number of prefix tabs to add.
* @param name The element name.
* @return This object (for method chaining).
@@ -135,10 +136,10 @@ public class XmlWriter extends SerializerWriter {
/**
* Closes a tag.
- *
+ *
* <p>
* Shortcut for <code>append(<js>'>'</js>);</code>
- *
+ *
* @return This object (for method chaining).
* @throws IOException
*/
@@ -149,10 +150,10 @@ public class XmlWriter extends SerializerWriter {
/**
* Closes an empty tag.
- *
+ *
* <p>
* Shortcut for <code>append(<js>'/'</js>).append(<js>'>'</js>);</code>
- *
+ *
* @return This object (for method chaining).
* @throws IOException
*/
@@ -163,7 +164,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Writes a closed tag to the output: <code><xt><ns:name/></xt></code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
* @param needsEncoding If <jk>true</jk>, element name will be encoded.
@@ -183,7 +184,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>tag(ns, name, <jk>false</jk>);</code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
* @return This object (for method chaining).
@@ -195,7 +196,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>tag(<jk>null</jk>, name, <jk>false</jk>);</code>
- *
+ *
* @param name The element name.
* @return This object (for method chaining).
* @throws IOException If a problem occurred.
@@ -206,7 +207,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>i(indent).tag(<jk>null</jk>, name, <jk>false</jk>);</code>
- *
+ *
* @param indent The number of prefix tabs to add.
* @param name The element name.
* @return This object (for method chaining).
@@ -218,7 +219,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>i(indent).tag(ns, name, needsEncoding);</code>
- *
+ *
* @param indent The number of prefix tabs to add.
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
@@ -232,7 +233,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>i(indent).tag(ns, name, <jk>false</jk>);</code>
- *
+ *
* @param indent The number of prefix tabs to add.
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
@@ -246,7 +247,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Writes a start tag to the output: <code><xt><ns:name></xt></code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
* @param needsEncoding If <jk>true</jk>, element name will be encoded.
@@ -259,7 +260,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>sTag(ns, name, <jk>false</jk>);</code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
* @return This object (for method chaining).
@@ -271,7 +272,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>sTag(<jk>null</jk>, name, <jk>false</jk>);</code>
- *
+ *
* @param name The element name.
* @return This object (for method chaining).
* @throws IOException If a problem occurred.
@@ -282,7 +283,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>i(indent).sTag(ns, name, needsEncoding);</code>
- *
+ *
* @param indent The number of prefix tabs to add.
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
@@ -296,7 +297,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>i(indent).sTag(ns, name, <jk>false</jk>);</code>
- *
+ *
* @param indent The number of prefix tabs to add.
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
@@ -309,7 +310,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>i(indent).sTag(<jk>null</jk>, name, <jk>false</jk>);</code>
- *
+ *
* @param indent The number of prefix tabs to add.
* @param name The element name.
* @return This object (for method chaining).
@@ -322,7 +323,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Writes an end tag to the output: <code><xt></ns:name></xt></code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
* @param needsEncoding If <jk>true</jk>, element name will be encoded.
@@ -342,7 +343,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>eTag(ns, name, <jk>false</jk>);</code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
* @return This object (for method chaining).
@@ -354,7 +355,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>eTag(<jk>null</jk>, name, <jk>false</jk>);</code>
- *
+ *
* @param name The element name.
* @return This object (for method chaining).
* @throws IOException If a problem occurred.
@@ -365,7 +366,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>i(indent).eTag(ns, name, needsEncoding);</code>
- *
+ *
* @param indent The number of prefix tabs to add.
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
@@ -379,7 +380,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>i(indent).eTag(ns, name, <jk>false</jk>);</code>
- *
+ *
* @param indent The number of prefix tabs to add.
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The element name.
@@ -392,7 +393,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>i(indent).eTag(<jk>null</jk>, name, <jk>false</jk>);</code>
- *
+ *
* @param indent The number of prefix tabs to add.
* @param name The element name.
* @return This object (for method chaining).
@@ -404,7 +405,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Writes an attribute to the output: <code><xa>ns:name</xa>=<xs>'value'</xs></code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The attribute name.
* @param value The attribute value.
@@ -418,7 +419,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>attr(<jk>null</jk>, name, value, <jk>false</jk>);</code>
- *
+ *
* @param name The attribute name.
* @param value The attribute value.
* @param valNeedsEncoding If <jk>true</jk>, attribute name will be encoded.
@@ -431,7 +432,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>attr(ns, name, value, <jk>false</jk>);</code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The attribute name.
* @param value The attribute value.
@@ -444,7 +445,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Same as {@link #attr(String, String, Object)}, except pass in a {@link Namespace} object for the namespace.
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The attribute name.
* @param value The attribute value.
@@ -457,7 +458,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for <code>attr(<jk>null</jk>, name, value, <jk>false</jk>);</code>
- *
+ *
* @param name The attribute name.
* @param value The attribute value.
* @return This object (for method chaining).
@@ -470,7 +471,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Writes an open-ended attribute to the output: <code><xa>ns:name</xa>=</code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The attribute name.
* @return This object (for method chaining).
@@ -486,7 +487,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Writes an open-ended attribute to the output: <code><xa>ns:name</xa>=</code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The attribute name.
* @return This object (for method chaining).
@@ -498,7 +499,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Writes an attribute with a URI value to the output: <code><xa>ns:name</xa>=<xs>'uri-value'</xs></code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The attribute name.
* @param value The attribute value, convertible to a URI via <code>toString()</code>
@@ -511,7 +512,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Writes an attribute with a URI value to the output: <code><xa>ns:name</xa>=<xs>'uri-value'</xs></code>
- *
+ *
* @param ns The namespace. Can be <jk>null</jk>.
* @param name The attribute name.
* @param value The attribute value, convertible to a URI via <code>toString()</code>
@@ -524,7 +525,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Shortcut for calling <code>text(o, <jk>false</jk>);</code>
- *
+ *
* @param o The object being serialized.
* @return This object (for method chaining).
* @throws IOException If a problem occurred.
@@ -536,7 +537,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Serializes and encodes the specified object as valid XML text.
- *
+ *
* @param o The object being serialized.
* @param preserveWhitespace
* If <jk>true</jk>, then we're serializing {@link XmlFormat#MIXED_PWS} or {@link XmlFormat#TEXT_PWS} content.
@@ -550,7 +551,7 @@ public class XmlWriter extends SerializerWriter {
/**
* Same as {@link #text(Object)} but treats the value as a URL to resolved then serialized.
- *
+ *
* @param o The object being serialized.
* @return This object (for method chaining).
* @throws IOException
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/Xml.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/Xml.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/Xml.java
index 80e93c4..f4681a0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/Xml.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/Xml.java
@@ -19,10 +19,10 @@ import java.lang.annotation.*;
/**
* Annotation for specifying various XML options for the XML and RDF/XML serializers.
- *
+ *
* <p>
* Can be applied to Java packages, types, fields, and methods.
- *
+ *
* <p>
* Can be used for the following:
* <ul>
@@ -39,10 +39,10 @@ public @interface Xml {
/**
* Sets the name of the XML child elements for bean properties of type collection and array.
- *
+ *
* <p>
* Applies only to collection and array bean properties.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> MyBean {
@@ -50,7 +50,7 @@ public @interface Xml {
* <jk>public</jk> String[] <jf>children</jf> = {<js>"foo"</js>,<js>"bar"</js>};
* }
* </p>
- *
+ *
* <p>
* Without the <ja>@Xml</ja> annotation, serializing this bean as XML would have produced the following...
* <p class='bcode'>
@@ -61,7 +61,7 @@ public @interface Xml {
* <xt></children></xt>
* <xt></object></xt>
* </p>
- *
+ *
* <p>
* With the annotations, serializing this bean as XML produces the following...
* <p class='bcode'>
@@ -77,29 +77,29 @@ public @interface Xml {
/**
* The {@link XmlFormat} to use for serializing this object type.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> MyBean {
- *
+ *
* <jc>// Normally, bean properties would be rendered as child elements of the bean element.</jc>
* <jc>// Override so that it's rendered as a "f1='123'" attribute on the bean element instead.</jc>
* <ja>@Xml</ja>(format=XmlFormat.<jsf>ATTR</jsf>}
* <jk>public int</jk> f1 = 123;
- *
+ *
* <jc>// Normally, bean URL properties would be rendered as XML attributes on the bean element.</jc>
* <jc>// Override so that it's rendered as an <href>http://foo</href> child element instead.</jc>
* <ja>@BeanProperty</ja>(uri=<jk>true</jk>)
* <ja>@Xml</ja>(format=XmlFormat.<jsf>ELEMENT</jsf>}
* <jk>public</jk> URL <jf>href</jf> = <jk>new</jk> URL(<js>"http://foo"</js>);
- *
+ *
* <jc>// Normally, collection properties would be grouped under a single <children> child element on the bean element.</jc>
* <jc>// Override so that entries are directly children of the bean element with each entry having an element name of <child>.</jc>
* <ja>@Xml</ja>(format=XmlFormat.<jsf>COLLAPSED</jsf>, childName=<js>"child"</js>}
* <jk>public</jk> String[] <jf>children</jf> = <js>"foo"</js>,<js>"bar"</js>};
* }
* </p>
- *
+ *
* <p>
* Without the <ja>@Xml</ja> annotations, serializing this bean as XML would have produced the following...
* <p class='bcode'>
@@ -111,7 +111,7 @@ public @interface Xml {
* <xt></children></xt>
* <xt></object></xt>
* </p>
- *
+ *
* <p>
* With the annotations, serializing this bean as XML produces the following...
* <p class='bcode'>
@@ -126,7 +126,7 @@ public @interface Xml {
/**
* Sets the namespace URI of this property or class.
- *
+ *
* <p>
* Must be matched with a {@link #prefix()} annotation on this object, a parent object, or a {@link XmlNs @XmlNs} with the
* same name through the {@link XmlSchema#xmlNs() @XmlSchema.xmlNs()} annotation on the package.
@@ -135,7 +135,7 @@ 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
@@ -144,7 +144,7 @@ public @interface Xml {
* When applied to bean properties on {@link ElementType#METHOD} and {@link ElementType#FIELD}, applies
* to the bean property.
* </ul>
- *
+ *
* <p>
* Must either be matched to a {@link #namespace()} annotation on the same object, parent object, or a
* {@link XmlNs @XmlNs} with the same name through the {@link XmlSchema#xmlNs() @XmlSchema.xmlNs()} annotation on the package.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java
index f536b7c..f730e25 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java
@@ -19,10 +19,10 @@ public enum XmlFormat {
/**
* Normal formatting (default).
- *
+ *
* <p>
* On a bean class, implies {@link #ELEMENTS} meaning bean properties will be serialized as child elements by default.
- *
+ *
* <p>
* On a bean property, implies {@link #ELEMENT} meaning the bean property will be serialized as a child element.
*/
@@ -30,10 +30,10 @@ public enum XmlFormat {
/**
* Render a bean property as an attribute instead of an element.
- *
+ *
* <p>
* Only applicable for bean properties, not bean classes.
- *
+ *
* <p>
* Can only be applied to properties (methods/fields) of class types that can be convertible to <code>Strings</code>.
*/
@@ -41,10 +41,10 @@ public enum XmlFormat {
/**
* Render property as attributes instead of an element.
- *
+ *
* <p>
* On a bean class, implies bean properties will be serialized as attributes instead of child elements by default.
- *
+ *
* <p>
* On bean properties, implies that the bean property value itself should be serialized as attributes on the bean
* element.
@@ -55,10 +55,10 @@ public enum XmlFormat {
/**
* Render property as an element instead of an attribute.
- *
+ *
* <p>
* Only applicable for bean properties, not bean classes.
- *
+ *
* <p>
* Used to override the behavior of the {@link #ATTRS} format applied to the bean class.
*/
@@ -66,14 +66,14 @@ public enum XmlFormat {
/**
* Render property value directly as the contents of the element.
- *
+ *
* <p>
* On a bean class, implies that bean properties will be serialized as child elements.
* Note that this is equivalent to {@link #DEFAULT}.
- *
+ *
* <p>
* Only applicable for objects of type array/Collection.
- *
+ *
* <p>
* On a bean property, implies that the bean property value itself should be serialized as child elements of the
* bean element.
@@ -82,13 +82,13 @@ public enum XmlFormat {
/**
* Same as {@link #ELEMENTS} except primitive types (e.g. string/boolean/number/null) are not wrapped in elements.
- *
+ *
* <p>
* Only applicable for bean properties, not bean classes.
- *
+ *
* <p>
* Only applicable for objects of type array/Collection.
- *
+ *
* <p>
* Use of this format may cause data type loss during parsing if the types cannot be inferred through reflection.
*/
@@ -96,7 +96,7 @@ public enum XmlFormat {
/**
* Same as {@link XmlFormat#MIXED}, but whitespace in text nodes are not trimmed during parsing.
- *
+ *
* <p>
* An example use is HTML5 <xt><pre></xt> where whitespace should not be discarded.
*/
@@ -104,13 +104,13 @@ public enum XmlFormat {
/**
* Render property value as the text content of the element.
- *
+ *
* <p>
* Similar to {@link #MIXED} but value must be a single value, not a collection.
- *
+ *
* <p>
* Only applicable for bean properties, not bean classes.
- *
+ *
* <p>
* Use of this format may cause data type loss during parsing if the type cannot be inferred through reflection.
*/
@@ -123,13 +123,13 @@ public enum XmlFormat {
/**
* Same as {@link #TEXT} except the content is expected to be fully-formed XML that will get serialized as-is.
- *
+ *
* <p>
* During parsing, this XML text will be re-serialized and set on the property.
- *
+ *
* <p>
* Only applicable for bean properties, not bean classes.
- *
+ *
* <p>
* Use of this format may cause data type loss during parsing if the type cannot be inferred through reflection.
*/
@@ -137,7 +137,7 @@ public enum XmlFormat {
/**
* Prevents collections and arrays from being enclosed in <xt><array></xt> elements.
- *
+ *
* <p>
* Can only be applied to properties (methods/fields) of type collection or array, or collection classes.
*/
@@ -145,13 +145,13 @@ public enum XmlFormat {
/**
* Identifies a void element.
- *
+ *
* <p>
* Only applicable for bean classes.
- *
+ *
* <p>
* Identifies an element that never contains content.
- *
+ *
* <p>
* The main difference in behavior is how non-void empty elements are handled in the HTML serializer.
* Void elements are serialized as collapsed nodes (e.g. <js>"<br/>"</js>) whereas non-void empty elements are
@@ -161,7 +161,7 @@ public enum XmlFormat {
/**
* Returns <jk>true</jk> if this format is one of those specified.
- *
+ *
* @param formats The formats to match against.
* @return <jk>true</jk> if this format is one of those specified.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlNs.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlNs.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlNs.java
index 1f4f6d1..38d973d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlNs.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlNs.java
@@ -18,7 +18,7 @@ import java.lang.annotation.*;
/**
* Namespace name/URL mapping pair.
- *
+ *
* <p>
* Used to identify a namespace/URI pair on a {@link XmlSchema#xmlNs() @XmlSchema.xmlNs()} annotation.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java
index b60b085..a8ec5eb 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlSchema.java
@@ -28,7 +28,7 @@ public @interface XmlSchema {
/**
* Sets the default XML namespace URL for all classes in this and child packages.
- *
+ *
* <p>
* Must either be matched with a {@link #prefix()} annotation, or an {@link #xmlNs()} mapping with the same
* {@link XmlNs#namespaceURI() @XmlNs.namespaceURI()} value.
@@ -37,7 +37,7 @@ public @interface XmlSchema {
/**
* Sets the default XML prefix for all classes in this and child packages.
- *
+ *
* <p>
* Must either be matched with a {@link #namespace()} annotation, or an {@link #xmlNs()} mapping with the same
* {@link XmlNs#prefix} value.
@@ -46,14 +46,14 @@ public @interface XmlSchema {
/**
* Lists all namespace mappings to be used on all classes within this package.
- *
+ *
* <p>
* The purpose of this annotation is to allow namespace mappings to be defined in a single location and referred
* to by name through just the {@link Xml#prefix() @Xml.prefix()} annotation.
- *
+ *
* <p>
* Inherited by child packages.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p>
* Contents of <code>package-info.java</code>...
@@ -70,19 +70,19 @@ public @interface XmlSchema {
* <jk>package</jk> org.apache.juneau.examples.addressbook;
* <jk>import</jk> org.apache.juneau.xml.annotation.*;
* </p>
- *
+ *
* <p>
* Class in package using defined namespaces...
* <p class='bcode'>
* <jk>package</jk> corg.apache.juneau.examples.addressbook;
- *
+ *
* <jc>// Bean class, override "ab" namespace on package.</jc>
* <ja>@Xml</ja>(prefix=<js>"addr"</js>)
* <jk>public class</jk> Address {
- *
+ *
* <jc>// Bean property, use "addr" namespace on class.</jc>
* <jk>public int</jk> <jf>id</jf>;
- *
+ *
* <jc>// Bean property, override with "mail" namespace.</jc>
* <ja>@Xml</ja>(prefix=<js>"mail"</js>)
* <jk>public</jk> String <jf>street</jf>, <jf>city</jf>, <jf>state</jf>;
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlClassMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlClassMeta.java
index 6398cfb..a61625b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlClassMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlClassMeta.java
@@ -26,7 +26,7 @@ public class YamlClassMeta extends ClassMetaExtended {
/**
* Constructor.
- *
+ *
* @param cm The class that this annotation is defined on.
*/
public YamlClassMeta(ClassMeta<?> cm) {
@@ -36,7 +36,7 @@ public class YamlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Json @Json} annotation defined on the class.
- *
+ *
* @return The value of the annotation, or <jk>null</jk> if not specified.
*/
protected Json getAnnotation() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParser.java
index 42a8ce4..ede1366 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParser.java
@@ -17,16 +17,18 @@ import org.apache.juneau.parser.*;
/**
* Parses any valid JSON text into a POJO model.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Content-Type</code> types: <code>application/json, text/json</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Content-Type</code> types: <code><b>application/json, text/json</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* This parser uses a state machine, which makes it very fast and efficient. It parses JSON in about 70% of the
* time that it takes the built-in Java DOM parsers to parse equivalent XML.
- *
+ *
* <p>
* This parser handles all valid JSON syntax.
* In addition, when strict mode is disable, the parser also handles the following:
@@ -40,10 +42,10 @@ import org.apache.juneau.parser.*;
* <li>
* Unquoted attributes.
* </ul>
- *
+ *
* <p>
* 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'>
@@ -68,7 +70,7 @@ import org.apache.juneau.parser.*;
* <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'>
@@ -91,7 +93,7 @@ import org.apache.juneau.parser.*;
* <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
* {@link ObjectMap#ObjectMap(CharSequence) ObjectMap(CharSequence)} or {@link ObjectList#ObjectList(CharSequence)
@@ -120,7 +122,7 @@ public class YamlParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Strict(PropertyStore ps) {
@@ -135,7 +137,7 @@ public class YamlParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public YamlParser(PropertyStore ps) {
@@ -144,7 +146,7 @@ public class YamlParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
* @param consumes The list of media types that this parser consumes (e.g. <js>"application/json"</js>).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParserBuilder.java
index dcf12a0..19e27f0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParserBuilder.java
@@ -32,7 +32,7 @@ public class YamlParserBuilder extends ParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public YamlParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParserSession.java
index 188ce90..b494a41 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlParserSession.java
@@ -25,7 +25,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link YamlParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -37,7 +37,7 @@ public final class YamlParserSession extends ReaderParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -50,12 +50,12 @@ public final class YamlParserSession extends ReaderParserSession {
/**
* Returns <jk>true</jk> if the specified character is whitespace.
- *
+ *
* <p>
* The definition of whitespace is different for strict vs lax mode.
* Strict mode only interprets 0x20 (space), 0x09 (tab), 0x0A (line feed) and 0x0D (carriage return) as whitespace.
* Lax mode uses {@link Character#isWhitespace(int)} to make the determination.
- *
+ *
* @param cp The codepoint.
* @return <jk>true</jk> if the specified character is whitespace.
*/
@@ -67,7 +67,7 @@ public final class YamlParserSession extends ReaderParserSession {
/**
* Returns <jk>true</jk> if the specified character is whitespace or '/'.
- *
+ *
* @param cp The codepoint.
* @return <jk>true</jk> if the specified character is whitespace or '/'.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializer.java
index 0715f07..c69c4f3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializer.java
@@ -20,15 +20,17 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO models to JSON.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>application/json, text/json</code>
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>application/json, text/json</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>application/json</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>application/json</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* The conversion is as follows...
* <ul class='spaced-list'>
* <li>
@@ -49,30 +51,30 @@ import org.apache.juneau.serializer.*;
* <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 into JSON-primitive object types through
* {@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated through the
* {@link BeanContextBuilder#pojoSwaps(Class...)} method.
* Several default transforms are provided for transforming Dates, Enums, Iterators, etc...
- *
+ *
* <p>
* This serializer provides several serialization options.
* Typically, one of the predefined DEFAULT serializers will be sufficient.
* However, custom serializers can be constructed to fine-tune behavior.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Use one of the default serializers to serialize a POJO</jc>
* String json = JsonSerializer.<jsf>DEFAULT</jsf>.serialize(someObject);
- *
+ *
* <jc>// Create a custom serializer for lax syntax using single quote characters</jc>
* JsonSerializer serializer = JsonSerializer.<jsm>create</jsm>().simple().sq().build();
- *
+ *
* <jc>// Clone an existing serializer and modify it to use single-quotes</jc>
* JsonSerializer serializer = JsonSerializer.<jsf>DEFAULT</jsf>.builder().sq().build();
- *
+ *
* <jc>// Serialize a POJO to JSON</jc>
* String json = serializer.serialize(someObject);
* </p>
@@ -88,7 +90,7 @@ public class YamlSerializer extends WriterSerializer {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"JsonSerializer.addBeanTypeProperties.b"</js>
@@ -100,12 +102,12 @@ public class YamlSerializer extends WriterSerializer {
* <li class='jm'>{@link JsonSerializerBuilder#addBeanTypeProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
* through reflection.
- *
+ *
* <p>
* When present, this value overrides the {@link #SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -114,7 +116,7 @@ public class YamlSerializer extends WriterSerializer {
/**
* Configuration property: Prefix solidus <js>'/'</js> characters with escapes.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"JsonSerializer.escapeSolidus.b"</js>
@@ -127,7 +129,7 @@ public class YamlSerializer extends WriterSerializer {
* <li class='jm'>{@link JsonSerializerBuilder#escapeSolidus()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, solidus (e.g. slash) characters should be escaped.
@@ -159,7 +161,7 @@ public class YamlSerializer extends WriterSerializer {
/**
* Configuration property: Simple JSON mode.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"JsonSerializer.simpleMode.b"</js>
@@ -173,7 +175,7 @@ public class YamlSerializer extends WriterSerializer {
* <li class='jm'>{@link JsonSerializerBuilder#ssq()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, JSON attribute names will only be quoted when necessary.
@@ -260,7 +262,7 @@ public class YamlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -270,7 +272,7 @@ public class YamlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializerBuilder.java
index 7f27569..2ab79c0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializerBuilder.java
@@ -34,7 +34,7 @@ public class YamlSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public YamlSerializerBuilder(PropertyStore ps) {
@@ -53,13 +53,13 @@ public class YamlSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Prefix solidus <js>'/'</js> characters with escapes.
- *
+ *
* <p>
* If <jk>true</jk>, solidus (e.g. slash) characters should be escaped.
* 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>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link YamlSerializer#YAML_escapeSolidus}
@@ -74,11 +74,11 @@ public class YamlSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Simple JSON mode.
- *
+ *
* <p>
* If <jk>true</jk>, JSON attribute names will only be quoted when necessary.
* Otherwise, they are always quoted.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link YamlSerializer#YAML_simpleMode}
@@ -93,7 +93,7 @@ public class YamlSerializerBuilder extends SerializerBuilder {
/**
* Shortcut for calling <code>setSimpleMode(<jk>true</jk>).sq()</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link YamlSerializer#YAML_simpleMode}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializerSession.java
index 5a2dda1..f299a7a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlSerializerSession.java
@@ -23,7 +23,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link YamlSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -35,7 +35,7 @@ public class YamlSerializerSession extends WriterSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -220,7 +220,7 @@ public class YamlSerializerSession extends WriterSerializerSession {
/**
* Returns the {@link #YAML_addBeanTypeProperties} setting value for this session.
- *
+ *
* @return The {@link #YAML_addBeanTypeProperties} setting value for this session.
*/
@Override /* SerializerSession */
@@ -230,7 +230,7 @@ public class YamlSerializerSession extends WriterSerializerSession {
/**
* Converts the specified output target object to an {@link YamlWriter}.
- *
+ *
* @param out The output target object.
* @return The output target object wrapped in an {@link YamlWriter}.
* @throws Exception
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlWriter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlWriter.java
index f9345b0..2b657a2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlWriter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/YamlWriter.java
@@ -20,8 +20,9 @@ import org.apache.juneau.serializer.*;
/**
* Specialized writer for serializing JSON.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>This class is not intended for external use.
* </ul>
@@ -51,7 +52,7 @@ public final class YamlWriter extends SerializerWriter {
/**
* Constructor.
- *
+ *
* @param out The writer being wrapped.
* @param quoteChar The quote character to use (i.e. <js>'\''</js> or <js>'"'</js>)
* @param trimStrings If <jk>true</jk>, strings will be trimmed before being serialized.
@@ -64,7 +65,7 @@ public final class YamlWriter extends SerializerWriter {
/**
* Serializes the specified object as a JSON string value.
- *
+ *
* @param s The object being serialized.
* @return This object (for method chaining).
* @throws IOException Should never happen.
@@ -109,7 +110,7 @@ public final class YamlWriter extends SerializerWriter {
/**
* Serializes the specified object as a JSON attribute name.
- *
+ *
* @param s The object being serialized.
* @return This object (for method chaining).
* @throws IOException Should never happen.
@@ -157,7 +158,7 @@ public final class YamlWriter extends SerializerWriter {
/**
* Appends a URI to the output.
- *
+ *
* @param uri The URI to append to the output.
* @return This object (for method chaining).
* @throws IOException
@@ -184,7 +185,7 @@ public final class YamlWriter extends SerializerWriter {
/**
* Performs an indentation only if we're currently past max indentation.
- *
+ *
* @param depth The current indentation depth.
* @return This object (for method chaining).
* @throws IOException
@@ -227,7 +228,7 @@ public final class YamlWriter extends SerializerWriter {
/**
* Adds a space only if the current indentation level is below maxIndent.
- *
+ *
* @param indent
* @return This object (for method chaining).
* @throws IOException
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/annotation/Yaml.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/annotation/Yaml.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/annotation/Yaml.java
index 08e2e50..d3d3c9f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/annotation/Yaml.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/yaml/proto/annotation/Yaml.java
@@ -19,10 +19,10 @@ import java.lang.annotation.*;
/**
* Annotation for specifying various YAML options for the YAML serializers and parsers.
- *
+ *
* <p>
* Can be applied to Java types.
- *
+ *
* <p>
* Can be used for the following:
* <ul class='spaced-list'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/DefaultingVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/DefaultingVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/DefaultingVar.java
index 2497f03..3b3d2a6 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/DefaultingVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/DefaultingVar.java
@@ -16,21 +16,21 @@ import static org.apache.juneau.internal.StringUtils.*;
/**
* Interface for the resolution of vars with a default value if the <code>resolve()</code> method returns <jk>null</jk>.
- *
+ *
* <p>
* For example, to resolve the system property <js>"myProperty"</js> but resolve to <js>"not found"</js> if the
* property doesn't exist: <js>"$S{myProperty,not found}"</js>
- *
+ *
* <p>
* Subclasses must implement the {@link #resolve(VarResolverSession, String)} method.
- *
+ *
* @see org.apache.juneau.svl
*/
public abstract class DefaultingVar extends SimpleVar {
/**
* Constructor.
- *
+ *
* @param name The name of this variable.
*/
public DefaultingVar(String name) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MapVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MapVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MapVar.java
index e13eeb6..41e5bc7 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MapVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MapVar.java
@@ -20,7 +20,7 @@ import org.apache.juneau.internal.*;
/**
* A subclass of {@link DefaultingVar} that simply pulls values from a {@link Map}.
- *
+ *
* @see org.apache.juneau.svl
*/
@SuppressWarnings("rawtypes")
@@ -30,7 +30,7 @@ public abstract class MapVar extends DefaultingVar {
/**
* Constructor.
- *
+ *
* @param name The name of this variable.
* @param m The map to pull values from.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MultipartResolvingVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MultipartResolvingVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MultipartResolvingVar.java
index b4c8d9b..9ba8acf 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MultipartResolvingVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MultipartResolvingVar.java
@@ -16,21 +16,21 @@ import static org.apache.juneau.internal.StringUtils.*;
/**
* Interface for the resolution of vars that can have one or more keys where the first non-null resolution is returned.
- *
+ *
* <p>
* For example, to resolve the system property <js>"myProperty"</js> but then resolve <js>"myProperty2"</js> if the
* property doesn't exist: <js>"$S{myProperty1,myProperty2}"</js>
- *
+ *
* <p>
* Subclasses must implement the {@link #resolve(VarResolverSession, String)} method.
- *
+ *
* @see org.apache.juneau.svl
*/
public abstract class MultipartResolvingVar extends SimpleVar {
/**
* Constructor.
- *
+ *
* @param name The name of this variable.
*/
public MultipartResolvingVar(String name) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MultipartVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MultipartVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MultipartVar.java
index 9c3f2d1..7fe18c0 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MultipartVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/MultipartVar.java
@@ -16,17 +16,17 @@ import static org.apache.juneau.internal.StringUtils.*;
/**
* Interface for the resolution of vars that consist of a comma-delimited list.
- *
+ *
* <p>
* (e.g. <js>"$X{foo, bar, baz}"</js>)
- *
+ *
* @see org.apache.juneau.svl
*/
public abstract class MultipartVar extends SimpleVar {
/**
* Constructor.
- *
+ *
* @param name The name of this variable.
*/
public MultipartVar(String name) {
@@ -35,7 +35,7 @@ public abstract class MultipartVar extends SimpleVar {
/**
* The interface that needs to be implemented for this interface.
- *
+ *
* @param session The session object used for a single instance of a string resolution.
* @param args The arguments inside the variable.
* @return The resolved variable.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/ResolvingObjectMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/ResolvingObjectMap.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/ResolvingObjectMap.java
index a31ae91..75d2506 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/ResolvingObjectMap.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/ResolvingObjectMap.java
@@ -16,7 +16,7 @@ import org.apache.juneau.*;
/**
* Subclass of an {@link ObjectMap} that automatically resolves any SVL variables in values.
- *
+ *
* <p>
* Resolves variables in the following values:
* <ul>
@@ -25,7 +25,7 @@ import org.apache.juneau.*;
* <li>Collections containing values of type {@link CharSequence}.
* <li>Maps containing values of type {@link CharSequence}.
* </ul>
- *
+ *
* <p>
* All other data types are left as-is.
*/
@@ -36,7 +36,7 @@ public class ResolvingObjectMap extends ObjectMap {
/**
* Constructor.
- *
+ *
* @param varResolver The var resolver session to use for resolving SVL variables.
*/
public ResolvingObjectMap(VarResolverSession varResolver) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/SimpleVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/SimpleVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/SimpleVar.java
index ad74aa7..fcf2ff0 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/SimpleVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/SimpleVar.java
@@ -16,22 +16,22 @@ import java.io.*;
/**
* Abstract superclass of all Simple Var Language variables that resolve to simple returned string values.
- *
+ *
* <p>
* Note the difference between this class and {@link StreamedVar} that streams values to writers.
* Unlike the {@link StreamedVar} class, the returned value from this class can contain nested variables that will be
* recursively resolved by {@link VarResolver}.
- *
+ *
* <p>
* Subclasses must implement the {@link #resolve(VarResolverSession, String)} method.
- *
+ *
* @see org.apache.juneau.svl
*/
public abstract class SimpleVar extends Var {
/**
* Constructor.
- *
+ *
* @param name The variable name (e.g. <js>"C"</js> for variables of the form <js>"$C{...}"</js>)
*/
protected SimpleVar(String name) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/StreamedVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/StreamedVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/StreamedVar.java
index d94b93e..4819cf8 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/StreamedVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/StreamedVar.java
@@ -14,23 +14,23 @@ package org.apache.juneau.svl;
/**
* Abstract superclass of all Simple Var Language variables that write their values directly to a writer.
- *
+ *
* <p>
* Note the difference between this class and {@link SimpleVar} that returns simple string values.
* Unlike the {@link SimpleVar} class, the output from this class cannot contain nested variables.
* However, this class can be more efficient for variables that produce large amounts of output so that the creation
* of large in-memory strings is avoided.
- *
+ *
* <p>
* Subclasses must implement the {@link #resolveTo(VarResolverSession, java.io.Writer, String)} method.
- *
+ *
* @see org.apache.juneau.svl
*/
public abstract class StreamedVar extends Var {
/**
* Constructor.
- *
+ *
* @param name The variable name (e.g. <js>"C"</js> for variables of the form <js>"$C{...}"</js>)
*/
public StreamedVar(String name) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/Var.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/Var.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/Var.java
index 4b47d22..bca200d 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/Var.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/Var.java
@@ -18,30 +18,30 @@ import java.io.*;
/**
* Abstract superclass of all Simple Var Language variables.
- *
+ *
* <p>
* Vars are used to convert simple variables of the form <js>"$varName{varKey}"</js> into something else by the
* {@link VarResolver} class.
- *
+ *
* <p>
* Subclasses must implement one of the following two methods:
* <ul>
* <li>{@link #resolve(VarResolverSession,String)} - For simple vars.
* <li>{@link #resolveTo(VarResolverSession,Writer,String)} - For streamed vars.
* </ul>
- *
+ *
* <p>
* Subclasses MUST implement a no-arg constructor so that class names can be passed to the
* {@link VarResolverBuilder#vars(Class...)} method.
* They must also be thread safe!
- *
+ *
* <p>
* Two direct abstract subclasses are provided to differentiated between simple and streamed vars:
* <ul>
* <li>{@link SimpleVar}
* <li>{@link StreamedVar}
* </ul>
- *
+ *
* @see org.apache.juneau.svl
*/
public abstract class Var {
@@ -51,7 +51,7 @@ public abstract class Var {
/**
* Constructor.
- *
+ *
* @param name The name of this variable.
* @param streamed
* Whether this variable is 'streamed', meaning the {@link #resolveTo(VarResolverSession, Writer, String)} method
@@ -74,11 +74,11 @@ public abstract class Var {
/**
* Return the name of this variable.
- *
+ *
* <p>
* For example, the system property variable returns <js>"S"</js> since the format of the variable is
* <js>"$S{system.property}"</js>.
- *
+ *
* @return The name of this variable.
*/
protected String getName() {
@@ -126,11 +126,11 @@ public abstract class Var {
/**
* The method called from {@link VarResolver}.
- *
+ *
* <p>
* Can be overridden to intercept the request and do special handling.
* Default implementation simply calls resolve(String).
- *
+ *
* @param session The session object used for a single instance of a string resolution.
* @param arg The inside argument of the variable.
* @return The resolved value.
@@ -142,7 +142,7 @@ public abstract class Var {
/**
* The interface that needs to be implemented for subclasses of {@link SimpleVar}.
- *
+ *
* @param session The session object used for a single instance of a var resolution.
* @param arg The inside argument of the variable.
* @return The resolved value.
@@ -152,7 +152,7 @@ public abstract class Var {
/**
* The interface that needs to be implemented for subclasses of {@link StreamedVar}.
- *
+ *
* @param session The session object used for a single instance of a var resolution.
* @param w The writer to send the resolved value to.
* @param arg The inside argument of the variable.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolver.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolver.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolver.java
index 28053ac..38bb335 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolver.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolver.java
@@ -20,58 +20,58 @@ 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.
- *
+ *
* <p>
* Variables are defined through the {@link VarResolverBuilder#vars(Class[])} method.
- *
+ *
* <p>
* The {@link Var} interface defines how variables are converted to values.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> SystemPropertiesVar <jk>extends</jk> SimpleVar {
- *
+ *
* <jc>// Must have a no-arg constructor!</jc>
* <jk>public</jk> SystemPropertiesVar() {
* <jk>super</jk>(<js>"S"</js>);
* }
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> String resolve(VarResolverSession session, String varVal) {
* <jk>return</jk> System.<jsm>getProperty</jsm>(varVal);
* }
* }
- *
+ *
* <jc>// Create a variable resolver that resolves system properties (e.g. "$S{java.home}")</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(SystemPropertiesVar.<js>class</js>);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"java.home is set to $S{java.home}"</js>));
* </p>
- *
+ *
* <h6 class='topic'>Context objects</h6>
- *
+ *
* Var resolvers can have zero or more context objects associated with them.
- *
+ *
* <p>
* Context objects are arbitrary objects associated with this var resolver, such as a <code>ConfigFile</code> object.
* They can be any class type.
- *
+ *
* <p>
* Context objects can be retrieved by {@link Var} classes through the
* {@link VarResolverSession#getSessionObject(Class, String)} method.
- *
+ *
* <h6 class='topic'>Session objects</h6>
- *
+ *
* Session objects are considered more ephemeral than context objects.
* While a context object is unlikely to ever change, a session object may change on every use of the var resolver.
* For example, the server API defines various <code>Var</code> objects that use the <code>RestRequest</code>
* object as a session object for the duration of a single HTTP request.
- *
+ *
* <p>
* Session objects are used by calling the {@link #createSession()} or {@link #createSession(Map)} methods to create
* an instance of a {@link VarResolverSession} object that contains {@link VarResolverSession#resolve(String)}
@@ -79,37 +79,38 @@ import org.apache.juneau.svl.vars.*;
* {@link VarResolver#resolve(String)} and {@link VarResolver#resolveTo(String, Writer)} except that the
* <code>Var</code> objects have access to the session objects through the
* {@link VarResolverSession#getSessionObject(Class, String)} method.
- *
+ *
* <p>
* Session objects are specified through either the {@link #createSession(Map)} method or the
* {@link VarResolverSession#sessionObject(String, Object)} methods.
- *
- * <h6 class='topic'>Cloning</h6>
- *
+ *
+ *
+ * <h5 class='topic'>Cloning</h5>
+ *
* 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a resolver that copies the default resolver and adds $C and $ARG vars.</jc>
* VarResolver myVarResolver = VarResolver.<jsf>DEFAULT</jsf>.builder().vars(ConfigVar.<jk>class</jk>,
* ArgsVar.<jk>class</jk>).build();
* </p>
- *
+ *
* @see org.apache.juneau.svl
*/
public class VarResolver {
/**
* Default string variable resolver with support for system properties and environment variables:
- *
+ *
* <ul>
* <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>$IF{booleanValue,thenValue[,elseValue]}</code> - If-else patterns.
* <li><code>$SW{test,matchPattern,thenValue[,matchPattern,thenValue][,elseValue]}</code> - Switch patterns.
* </ul>
- *
+ *
* @see SystemPropertiesVar
* @see EnvVariablesVar
*/
@@ -119,7 +120,7 @@ public class VarResolver {
/**
* Constructor.
- *
+ *
* @param vars The var classes
* @param contextObjects
*/
@@ -129,7 +130,7 @@ public class VarResolver {
/**
* Returns a new builder object using the settings in this resolver as a base.
- *
+ *
* @return A new var resolver builder.
*/
public VarResolverBuilder builder() {
@@ -140,7 +141,7 @@ public class VarResolver {
/**
* Returns the read-only properties on this variable resolver.
- *
+ *
* @return The read-only properties on this variable resolver.
*/
public VarResolverContext getContext() {
@@ -149,11 +150,11 @@ public class VarResolver {
/**
* Creates a new resolver session with no session objects.
- *
+ *
* <p>
* Session objects can be associated with the specified session using the {@link VarResolverSession#sessionObject(String, Object)}
* method.
- *
+ *
* @return A new resolver session.
*/
public VarResolverSession createSession() {
@@ -162,7 +163,7 @@ public class VarResolver {
/**
* Same as {@link #createSession()} except allows you to specify session objects as a map.
- *
+ *
* @param sessionObjects The session objects to associate with the session.
* @return A new resolver session.
*/
@@ -172,12 +173,12 @@ public class VarResolver {
/**
* Resolve variables in the specified string.
- *
+ *
* <p>
* This is a shortcut for calling <code>createSession(<jk>null</jk>).resolve(s);</code>.
* This method can only be used if the string doesn't contain variables that rely on the existence of session
* variables.
- *
+ *
* @param s The input string.
* @return The string with variables resolved, or the same string if it doesn't contain any variables to resolve.
*/
@@ -187,12 +188,12 @@ public class VarResolver {
/**
* Resolve variables in the specified string and sends the results to the specified writer.
- *
+ *
* <p>
* This is a shortcut for calling <code>createSession(<jk>null</jk>).resolveTo(s, w);</code>.
* This method can only be used if the string doesn't contain variables that rely on the existence of session
* variables.
- *
+ *
* @param s The input string.
* @param w The writer to send the result to.
* @throws IOException
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverBuilder.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverBuilder.java
index 5ceef57..58d02b1 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverBuilder.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverBuilder.java
@@ -28,7 +28,7 @@ public class VarResolverBuilder {
/**
* Create a new var resolver using the settings in this builder.
- *
+ *
* @return A new var resolver.
*/
public VarResolver build() {
@@ -37,7 +37,7 @@ public class VarResolverBuilder {
/**
* Register new variables with this resolver.
- *
+ *
* @param vars
* The variable resolver classes.
* These classes must subclass from {@link Var} and have no-arg constructors.
@@ -54,7 +54,7 @@ public class VarResolverBuilder {
/**
* Adds the default variables to this builder.
- *
+ *
* <p>
* The default variables are:
* <ul>
@@ -63,7 +63,7 @@ public class VarResolverBuilder {
* <li>{@link SwitchVar}
* <li>{@link IfVar}
* </ul>
- *
+ *
* @return This object (for method chaining).
*/
public VarResolverBuilder defaultVars() {
@@ -72,11 +72,11 @@ public class VarResolverBuilder {
/**
* Associates a context object with this resolver.
- *
+ *
* <p>
* A context object is essentially some environmental object that doesn't change but is used by vars to customize
* output.
- *
+ *
* @param name The name of the context object.
* @param object The context object.
* @return This object (for method chaining).
@@ -88,11 +88,11 @@ public class VarResolverBuilder {
/**
* Associates multiple context objects with this resolver.
- *
+ *
* <p>
* A context object is essentially some environmental object that doesn't change but is used by vars to customize
* output.
- *
+ *
* @param map A map of context objects keyed by their name.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverContext.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverContext.java
index f0eecf6..5283de8 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverContext.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverContext.java
@@ -19,10 +19,10 @@ import java.util.concurrent.*;
/**
* Configurable properties on the {@link VarResolver} class.
- *
+ *
* <p>
* Used to associate {@link Var Vars} and context objects with {@link VarResolver VarResolvers}.
- *
+ *
* @see org.apache.juneau.svl
*/
public class VarResolverContext {
@@ -33,7 +33,7 @@ public class VarResolverContext {
/**
* Constructor.
- *
+ *
* @param vars The Var classes used for resolving string variables.
* @param contextObjects Read-only context objects.
*/
@@ -55,7 +55,7 @@ public class VarResolverContext {
/**
* Returns an unmodifiable map of {@link Var Vars} associated with this context.
- *
+ *
* @return A map whose keys are var names (e.g. <js>"S"</js>) and values are {@link Var} instances.
*/
protected Map<String,Var> getVarMap() {
@@ -64,7 +64,7 @@ public class VarResolverContext {
/**
* Returns an array of variables define in this variable resolver context.
- *
+ *
* @return A new array containing the variables in this context.
*/
protected Class<?>[] getVars() {
@@ -73,7 +73,7 @@ public class VarResolverContext {
/**
* Returns the context object with the specified name.
- *
+ *
* @param name The name of the context object.
* @return The context object, or <jk>null</jk> if no context object is specified with that name.
*/
@@ -83,7 +83,7 @@ public class VarResolverContext {
/**
* Returns the context map of this variable resolver context.
- *
+ *
* @return An unmodifiable map of the context objects of this variable resolver context.
*/
protected Map<String,Object> getContextObjects() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverSession.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverSession.java
index bbc6ffc..4009b56 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverSession.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/VarResolverSession.java
@@ -22,20 +22,20 @@ import org.apache.juneau.*;
/**
* A var resolver session that combines a {@link VarResolver} with one or more session objects.
- *
+ *
* <p>
* Instances of this class are considered light-weight and fast to construct, use, and discard.
- *
+ *
* <p>
* This class contains the workhorse code for var resolution.
- *
+ *
* <p>
* Instances of this class are created through the {@link VarResolver#createSession()} and
* {@link VarResolver#createSession(Map)} methods.
- *
+ *
* <p>
* Instances of this class are NOT guaranteed to be thread safe.
- *
+ *
* @see org.apache.juneau.svl
*/
public class VarResolverSession {
@@ -45,12 +45,12 @@ public class VarResolverSession {
/**
* Constructor.
- *
+ *
* @param context
* The {@link VarResolver} context object that contains the {@link Var Vars} and context objects associated with
* that resolver.
* @param sessionObjects The session objects.
- *
+ *
*/
public VarResolverSession(VarResolverContext context, Map<String,Object> sessionObjects) {
this.context = context;
@@ -59,7 +59,7 @@ public class VarResolverSession {
/**
* Adds a session object to this session.
- *
+ *
* @param name The name of the session object.
* @param o The session object.
* @return This method (for method chaining).
@@ -71,7 +71,7 @@ public class VarResolverSession {
/**
* Resolve all variables in the specified string.
- *
+ *
* @param s
* The string to resolve variables in.
* @return
@@ -119,7 +119,7 @@ public class VarResolverSession {
/**
* Convenience method for resolving variables in arbitrary objects.
- *
+ *
* <p>
* Supports resolving variables in the following object types:
* <ul>
@@ -130,7 +130,7 @@ public class VarResolverSession {
* <li>Maps containing values of type {@link CharSequence}.
* <br>Map class must have a no-arg constructor.
* </ul>
- *
+ *
* @param o The object.
* @return The same object if no resolution was needed, otherwise a new object or data structure if resolution was
* needed.
@@ -243,11 +243,11 @@ public class VarResolverSession {
/**
* Resolves variables in the specified string and sends the output to the specified writer.
- *
+ *
* <p>
* More efficient than first parsing to a string and then serializing to the writer since this method doesn't need
* to construct a large string.
- *
+ *
* @param s The string to resolve variables in.
* @param out The writer to write to.
* @return The same writer.
@@ -364,10 +364,10 @@ public class VarResolverSession {
/**
* Returns the session object with the specified name.
- *
+ *
* <p>
* Casts it to the specified class type for you.
- *
+ *
* @param c The class type to cast to.
* @param name The name of the session object.
* @return The session object. Never <jk>null</jk>.
@@ -394,7 +394,7 @@ public class VarResolverSession {
/**
* Returns the {@link Var} with the specified name.
- *
+ *
* @param name The var name (e.g. <js>"S"</js>).
* @return The {@link Var} instance, or <jk>null</jk> if no <code>Var</code> is associated with the specified name.
*/
[08/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
index b5e7fd2..5387299 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
@@ -17,31 +17,31 @@ import org.apache.juneau.utils.*;
/**
* JVM args variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$ARG{argNameOrNum}"</js> or <js>"$ARG{argNameOrNum,defaultValue}"</js>
- *
+ *
* <p>
* This variable resolver requires that an {@link Args} object be set as a context object on the resolver or a
* session object on the resolver session.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create an args object from the main(String[]) method.</jc>
* Args args = new Args(argv);
- *
+ *
* <jc>// Create a variable resolver that resolves JVM arguments (e.g. "$ARG{1}")</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(ArgsVar.<js>class</js>)
* .addContextObject(<jsf>SESSION_args</jsf>, args);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"Arg #1 is set to $ARG{1}"</js>));
* </p>
- *
+ *
* <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.
- *
+ *
* @see org.apache.juneau.utils.Args
* @see org.apache.juneau.svl
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceAndRecurseVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceAndRecurseVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceAndRecurseVar.java
index bcfda2c..4dd0471 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceAndRecurseVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceAndRecurseVar.java
@@ -16,7 +16,7 @@ import org.apache.juneau.svl.*;
/**
* A basic variable resolver that returns the first non-null value.
- *
+ *
* <p>
* The format for this var is <js>"$CR{arg1[,arg2...]}"</js>.
*
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceVar.java
index cbc198a..6844a3a 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceVar.java
@@ -16,7 +16,7 @@ import org.apache.juneau.svl.*;
/**
* A basic variable resolver that returns the first non-null value.
- *
+ *
* <p>
* The format for this var is <js>"$CO{arg1[,arg2...]}"</js>.
*
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/EnvVariablesVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/EnvVariablesVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/EnvVariablesVar.java
index 7a78664..f9da2fd 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/EnvVariablesVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/EnvVariablesVar.java
@@ -16,23 +16,23 @@ import org.apache.juneau.svl.*;
/**
* Environment variable variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$E{envVar[,defaultValue]}"</js>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a variable resolver that resolves environment variables (e.g. "$E{PATH}")</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(EnvVariablesVar.<js>class</js>);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"Environment variable PATH is set to $E{PATH}"</js>));
* </p>
- *
+ *
* <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.
- *
+ *
* @see org.apache.juneau.svl
*/
public class EnvVariablesVar extends DefaultingVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/IfVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/IfVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/IfVar.java
index 4f7d9b6..e26f306 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/IfVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/IfVar.java
@@ -18,33 +18,33 @@ import org.apache.juneau.svl.*;
/**
* A basic if-else logic variable resolver.
- *
+ *
* <p>
* The format for this var is one of the following:
* <ul>
* <li><js>"$IF{booleanArg,thenValue}"</js>
* <li><js>"$IF{booleanArg,thenValue,elseValue}"</js>
* </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>,
* <js>"T"</js>,<js>"1"</js>.
* <br>All else are interpreted as <jk>false</jk>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a variable resolver that resolves system properties and $IF vars.</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(IfVar.<jk>class</jk>, SystemPropertiesVar.<jk>class</jk>);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"Property $IF{$S{someBooleanFlag},IS,IS NOT} set!"</js>));
* </p>
- *
+ *
* <p>
* Since this is a {@link MultipartVar}, 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.
- *
+ *
* @see org.apache.juneau.svl
*/
public class IfVar extends MultipartVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java
index 18eb086..d6bbc83 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java
@@ -17,31 +17,31 @@ import org.apache.juneau.utils.*;
/**
* Manifest file entries variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$MF{key}"</js> or <js>"$MF{key,defaultValue}"</js>
- *
+ *
* <p>
* This variable resolver requires that a {@link ManifestFile} object be set as a context object on the resolver or a
* session object on the resolver session.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a ManifestFile object that contains the manifest of the jar file containing this class.</jc>
* ManifestFile mf = <jk>new</jk> ManifestFile(<jk>this</jk>.getClass());
- *
+ *
* <jc>// Create a variable resolver that resolves manifest file entries (e.g. "$MF{Main-Class}")</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(ManifestFile.<js>class</js>)
* .addContextObject(<jsf>SESSION_manifest</jsf>, mf);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"The main class is $MF{Main-Class}"</js>));
* </p>
- *
+ *
* <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.
- *
+ *
* @see org.apache.juneau.utils.ManifestFile
* @see org.apache.juneau.svl
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java
index 11dce68..e51740c 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java
@@ -20,7 +20,7 @@ import org.apache.juneau.svl.*;
/**
* A basic switch/case logic variable resolver.
- *
+ *
* <p>
* The format for this var is one of the following:
* <ul>
@@ -30,20 +30,20 @@ import org.apache.juneau.svl.*;
* <li><js>"$SW{stringArg,pattern,thenValue,pattern,thenValue,elsePattern}"</js>
* <li>...
* </ul>
- *
+ *
* <p>
* The pattern can be any string optionally containing <js>'*'</js> or <js>'?'</js> representing any or one character
* respectively.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a variable resolver that resolves system properties and $SW vars.</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(SwitchVar.<jk>class</jk>, SystemPropertiesVar.<jk>class</jk>);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"We are running on $SW{$P{os.name},*win*,Windows,Something else}!"</js>));
* </p>
- *
+ *
* <p>
* Since this is a {@link MultipartVar}, 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/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SystemPropertiesVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SystemPropertiesVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SystemPropertiesVar.java
index a147f39..2218df7 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SystemPropertiesVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SystemPropertiesVar.java
@@ -16,23 +16,23 @@ import org.apache.juneau.svl.*;
/**
* System property variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$S{systemProperty[,defaultValue]}"</js></js>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a variable resolver that resolves system properties (e.g. "$S{java.home}")</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(SystemPropertiesVar.<js>class</js>);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"java.home is set to $S{java.home}"</js>));
* </p>
- *
+ *
* <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.
- *
+ *
* @see org.apache.juneau.svl
*/
public class SystemPropertiesVar extends MapVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonConfigurationExample.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonConfigurationExample.java b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonConfigurationExample.java
index dd53f7d..31b9205 100644
--- a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonConfigurationExample.java
+++ b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonConfigurationExample.java
@@ -6,9 +6,9 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonSimpleExample.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonSimpleExample.java b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonSimpleExample.java
index 565dc14..7c53e22 100644
--- a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonSimpleExample.java
+++ b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonSimpleExample.java
@@ -6,9 +6,9 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/pojo/Pojo.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/pojo/Pojo.java b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/pojo/Pojo.java
index 46e9308..86e974a 100644
--- a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/pojo/Pojo.java
+++ b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/pojo/Pojo.java
@@ -6,9 +6,9 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/rdf/RdfExample.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/rdf/RdfExample.java b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/rdf/RdfExample.java
index a5f0643..b9353ad 100644
--- a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/rdf/RdfExample.java
+++ b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/rdf/RdfExample.java
@@ -6,9 +6,9 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-examples/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/RestTestcase.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/RestTestcase.java b/juneau-examples/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/RestTestcase.java
index 8b7471a..cff048b 100644
--- a/juneau-examples/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/RestTestcase.java
+++ b/juneau-examples/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/RestTestcase.java
@@ -16,7 +16,7 @@ import org.junit.*;
/**
* Superclass of REST testcases that start up the REST test microservice before running the tests locally.
- *
+ *
* @author James Bognar (james.bognar@salesforce.com)
*/
public class RestTestcase {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Microservice.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Microservice.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Microservice.java
index 1067e30..1671e2c 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Microservice.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Microservice.java
@@ -47,9 +47,9 @@ import org.apache.juneau.utils.*;
* <p>
* Your microservice class must be specified as the <jk>Main-Class</jk> entry in the manifest file of your microservice
* jar file.
- *
+ *
* <h6 class='topic'>Microservice Configuration</h6>
- *
+ *
* This class defines the following method for accessing configuration for your microservice:
* <ul class='spaced-list'>
* <li>
@@ -59,9 +59,9 @@ import org.apache.juneau.utils.*;
* <li>
* {@link #getManifest()} - The manifest file for the main jar file.
* </ul>
- *
+ *
* <h6 class='topic'>Entry point Method</h6>
- *
+ *
* Subclasses must implement a static void main method as the entry point for the microservice.
* Typically, this method will simply consist of the following...
* <p class='bcode'>
@@ -69,9 +69,9 @@ import org.apache.juneau.utils.*;
* <jk>new</jk> MyMicroservice(args).start();
* }
* </p>
- *
+ *
* <h6 class='topic'>Lifecycle Methods</h6>
- *
+ *
* Subclasses must implement the following lifecycle methods:
* <ul class='spaced-list'>
* <li>
@@ -81,9 +81,9 @@ import org.apache.juneau.utils.*;
* <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>
- *
+ *
* Subclasses can optionally implement the following event listener methods:
* <ul class='spaced-list'>
* <li>
@@ -95,9 +95,9 @@ import org.apache.juneau.utils.*;
* <li>
* {@link #onConfigChange(ConfigFile, Set)} - Gets executed after a config file has been modified.
* </ul>
- *
+ *
* <h6 class='topic'>Other Methods</h6>
- *
+ *
* Subclasses can optionally override the following methods to provide customized behavior:
* <ul class='spaced-list'>
* <li>
@@ -139,7 +139,7 @@ public abstract class Microservice {
/**
* Constructor.
- *
+ *
* @param args Command line arguments.
* @throws Exception
*/
@@ -172,7 +172,7 @@ public abstract class Microservice {
*
* <p>
* If this path does not exist, a {@link FileNotFoundException} will be thrown from the {@link #start()} command.
- *
+ *
* @param cfPath The absolute or relative path of the config file.
* @param create Create the file if it doesn't exist.
* @return This object (for method chaining).
@@ -196,7 +196,7 @@ public abstract class Microservice {
* <p>
* Note that if you use this method instead of {@link #setConfig(String,boolean)}, the config file will not use
* the variable resolver constructed from {@link #createVarResolver()}.
- *
+ *
* @param cf The config file for this application, or <jk>null</jk> if no config file is needed.
*/
public void setConfig(ConfigFile cf) {
@@ -214,7 +214,7 @@ public abstract class Microservice {
* is located in the project root.
* <li>Using the class loader for this class to find the file at the URL <js>"META-INF/MANIFEST.MF"</js>.
* </ol>
- *
+ *
* @param mf The manifest file of this microservice.
*/
public void setManifest(Manifest mf) {
@@ -223,7 +223,7 @@ public abstract class Microservice {
/**
* Convenience method for specifying the manifest contents directly.
- *
+ *
* @param contents The lines in the manifest file.
* @return This object (for method chaining).
* @throws IOException
@@ -236,7 +236,7 @@ public abstract class Microservice {
/**
* Same as {@link #setManifest(Manifest)} except specified through a {@link File} object.
- *
+ *
* @param f The manifest file of this microservice.
* @throws IOException If a problem occurred while trying to read the manifest file.
*/
@@ -247,7 +247,7 @@ public abstract class Microservice {
/**
* Same as {@link #setManifest(Manifest)} except finds and loads the manifest file of the jar file that the
* specified class is contained within.
- *
+ *
* @param c The class whose jar file contains the manifest to use for this microservice.
* @throws IOException If a problem occurred while trying to read the manifest file.
*/
@@ -273,7 +273,7 @@ public abstract class Microservice {
*
* <p>
* Subclasses can override this method to provide their own variables.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jd>/**
@@ -301,7 +301,7 @@ public abstract class Microservice {
* <jc>// Example java code</jc>
* String myentry = getConfig().getString(<js>"MySection/myEntry"</js>); <jc>// == "[foo]"</js>
* </p>
- *
+ *
* @return A new {@link VarResolver}.
*/
protected VarResolverBuilder createVarResolver() {
@@ -323,7 +323,7 @@ public abstract class Microservice {
*
* <p>
* See {@link Args} for details on using this method.
- *
+ *
* @return The command-line arguments passed into the application.
*/
public Args getArgs() {
@@ -356,50 +356,50 @@ public abstract class Microservice {
*
* <p>
* This method can be called from the class constructor.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <cc>#--------------------------</cc>
* <cc># My section</cc>
* <cc>#--------------------------</cc>
* <cs>[MySection]</cs>
- *
+ *
* <cc># An integer</cc>
* <ck>anInt</ck> = 1
- *
+ *
* <cc># A boolean</cc>
* <ck>aBoolean</ck> = true
- *
+ *
* <cc># An int array</cc>
* <ck>anIntArray</ck> = 1,2,3
- *
+ *
* <cc># A POJO that can be converted from a String</cc>
* <ck>aURL</ck> = http://foo
- *
+ *
* <cc># A POJO that can be converted from JSON</cc>
* <ck>aBean</ck> = {foo:'bar',baz:123}
- *
+ *
* <cc># A system property</cc>
* <ck>locale</ck> = $S{java.locale, en_US}
- *
+ *
* <cc># An environment variable</cc>
* <ck>path</ck> = $E{PATH, unknown}
- *
+ *
* <cc># A manifest file entry</cc>
* <ck>mainClass</ck> = $MF{Main-Class}
- *
+ *
* <cc># Another value in this config file</cc>
* <ck>sameAsAnInt</ck> = $C{MySection/anInt}
- *
+ *
* <cc># A command-line argument in the form "myarg=foo"</cc>
* <ck>myArg</ck> = $ARG{myarg}
- *
+ *
* <cc># The first command-line argument</cc>
* <ck>firstArg</ck> = $ARG{0}
- *
+ *
* <cc># Look for system property, or env var if that doesn't exist, or command-line arg if that doesn't exist.</cc>
* <ck>nested</ck> = $S{mySystemProperty,$E{MY_ENV_VAR,$ARG{0}}}
- *
+ *
* <cc># A POJO with embedded variables</cc>
* <ck>aBean2</ck> = {foo:'$ARG{0}',baz:$C{MySection/anInt}}
* </p>
@@ -407,7 +407,7 @@ public abstract class Microservice {
* <p class='bcode'>
* <jc>// Java code for accessing config entries above.</jc>
* ConfigFile cf = getConfig();
- *
+ *
* <jk>int</jk> anInt = cf.getInt(<js>"MySection/anInt"</js>);
* <jk>boolean</jk> aBoolean = cf.getBoolean(<js>"MySection/aBoolean"</js>);
* <jk>int</jk>[] anIntArray = cf.getObject(<jk>int</jk>[].<jk>class</jk>, <js>"MySection/anIntArray"</js>);
@@ -420,7 +420,7 @@ public abstract class Microservice {
* String myArg = cf.getString(<js>"MySection/myArg"</js>);
* String firstArg = cf.getString(<js>"MySection/firstArg"</js>);
* </p>
- *
+ *
* @return The config file for this application, or <jk>null</jk> if no config file is configured.
*/
public ConfigFile getConfig() {
@@ -435,16 +435,16 @@ public abstract class Microservice {
* simple strings.
* <p>
* This method can be called from the class constructor.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Get Main-Class from manifest file.</jc>
* String mainClass = Microservice.<jsm>getManifest</jsm>().getString(<js>"Main-Class"</js>, <js>"unknown"</js>);
- *
+ *
* <jc>// Get Rest-Resources from manifest file.</jc>
* String[] restResources = Microservice.<jsm>getManifest</jsm>().getStringArray(<js>"Rest-Resources"</js>);
* </p>
- *
+ *
* @return The manifest file from the main jar, or <jk>null</jk> if the manifest file could not be retrieved.
*/
public ManifestFile getManifest() {
@@ -483,7 +483,7 @@ public abstract class Microservice {
*
* <p>
* Overridden methods MUST call this method FIRST so that the {@link #onStart()} method is called.
- *
+ *
* @return This object (for method chaining).
* @throws Exception
*/
@@ -611,7 +611,7 @@ public abstract class Microservice {
*
* <p>
* Note that this is typically started after all initialization has occurred so that the console output isn't polluted.
- *
+ *
* @return This object (for method chaining).
* @throws Exception
*/
@@ -675,25 +675,25 @@ public abstract class Microservice {
* # See FileHandler Java class for details.
* #================================================================================</cc>
* <cs>[Logging]</cs>
- *
+ *
* <cc># The directory where to create the log file.
* # Default is ".".</cc>
* <ck>logDir</ck> = logs
- *
+ *
* <cc># The name of the log file to create for the main logger.
* # The logDir and logFile make up the pattern that's passed to the FileHandler
* # constructor.
* # If value is not specified, then logging to a file will not be set up.</cc>
* <ck>logFile</ck> = microservice.%g.log
- *
+ *
* <cc># Whether to append to the existing log file or create a new one.
* # Default is false.</cc>
* <ck>append</ck> =
- *
+ *
* <cc># The SimpleDateFormat format to use for dates.
* # Default is "yyyy.MM.dd hh:mm:ss".</cc>
* <ck>dateFormat</ck> =
- *
+ *
* <cc># The log message format.
* # The value can contain any of the following variables:
* # {date} - The date, formatted per dateFormat.
@@ -706,32 +706,32 @@ public abstract class Microservice {
* # {exception} - The localized exception message.
* # Default is "[{date} {level}] {msg}%n".</cc>
* <ck>format</ck> =
- *
+ *
* <cc># The maximum log file size.
* # Suffixes available for numbers.
* # See ConfigFile.getInt(String,int) for details.
* # Default is 1M.</cc>
* <ck>limit</ck> = 10M
- *
+ *
* <cc># Max number of log files.
* # Default is 1.</cc>
* <ck>count</ck> = 5
- *
+ *
* <cc># Default log levels.
* # Keys are logger names.
* # Values are serialized Level POJOs.</cc>
* <ck>levels</ck> = { org.apache.juneau:'INFO' }
- *
+ *
* <cc># Only print unique stack traces once and then refer to them by a simple 8 character hash identifier.
* # Useful for preventing log files from filling up with duplicate stack traces.
* # Default is false.</cc>
* <ck>useStackTraceHashes</ck> = true
- *
+ *
* <cc># The default level for the console logger.
* # Default is WARNING.</cc>
* <ck>consoleLevel</ck> = WARNING
* </p>
- *
+ *
* @throws Exception
*/
protected void initLogging() throws Exception {
@@ -770,7 +770,7 @@ public abstract class Microservice {
*
* <p>
* Default implementation is a no-op.
- *
+ *
* @return This object (for method chaining).
* @throws Exception
*/
@@ -786,7 +786,7 @@ public abstract class Microservice {
*
* <p>
* Overridden methods MUST call this method LAST so that the {@link #onStop()} method is called.
- *
+ *
* @return This object (for method chaining).
*/
public Microservice stop() {
@@ -829,7 +829,7 @@ public abstract class Microservice {
*
* <p>
* Subclasses can override this method to listen for config file changes.
- *
+ *
* @param cf The config file.
*/
protected void onConfigSave(ConfigFile cf) {}
@@ -839,7 +839,7 @@ public abstract class Microservice {
*
* <p>
* Subclasses can override this method to listen for config file changes.
- *
+ *
* @param cf The config file.
* @param changes The list of keys in the config file being changed.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Resource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Resource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Resource.java
index d98a293..9baf89b 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Resource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Resource.java
@@ -28,7 +28,7 @@ import org.apache.juneau.svl.vars.*;
* <li>
* <code class='snippet'>$ARG{...}</code> - Command line arguments pulled from {@link Microservice#getArgs()}.
*
- * <h6 class='figure'>Example:</h6>
+ * <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>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/RestMicroservice.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/RestMicroservice.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/RestMicroservice.java
index 1e71d57..513e2ef 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/RestMicroservice.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/RestMicroservice.java
@@ -32,21 +32,22 @@ import org.eclipse.jetty.xml.*;
/**
* Entry point for Juneau microservice that implements a REST interface using Jetty on a single port.
- *
+ *
* <h6 class='topic'>Jetty Server Details</h6>
*
* 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.
- *
+ *
* <h6 class='topic'>Defining REST Resources</h6>
*
* Top-level REST resources are defined in the <code>jetty.xml</code> file as normal servlets.
- *
- * <h6 class='topic'>Logging</h6>
+ *
+ *
+ * <h5 class='topic'>Logging</h5>
*
* Logging is initialized by the {@link #initLogging()} method.
* This method can be overridden to provide customized logging behavior.
- *
+ *
* <h6 class='topic'>Lifecycle Listener Methods</h6>
* Subclasses can optionally implement the following event listener methods:
* <ul class='spaced-list'>
@@ -93,7 +94,7 @@ public class RestMicroservice extends Microservice {
*
* <p>
* Subclasses must also implement this method!
- *
+ *
* @param args Command line arguments.
* @throws Exception
*/
@@ -103,7 +104,7 @@ public class RestMicroservice extends Microservice {
/**
* Constructor.
- *
+ *
* @param args Command line arguments.
* @throws Exception
*/
@@ -282,7 +283,7 @@ public class RestMicroservice extends Microservice {
* # jetty.xml file as "$S{availablePort}" (assuming resolveVars is enabled).</cc>
* <ck>port</ck> = 10000,0,0,0
* </p>
- *
+ *
* @return The newly-created server.
* @throws Exception
*/
@@ -389,7 +390,7 @@ public class RestMicroservice extends Microservice {
*
* <p>
* Subclasses can override this method to customize server startup.
- *
+ *
* @return The port that this server started on.
* @throws Exception
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ConfigResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ConfigResource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ConfigResource.java
index ef020af..c7c9de2 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ConfigResource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ConfigResource.java
@@ -47,7 +47,7 @@ public class ConfigResource extends Resource {
/**
* [GET /] - Show contents of config file.
- *
+ *
* @return The config file.
* @throws Exception
*/
@@ -58,7 +58,7 @@ public class ConfigResource extends Resource {
/**
* [GET /edit] - Show config file edit page.
- *
+ *
* @param req The HTTP request.
* @return The config file as a reader resource.
* @throws Exception
@@ -81,7 +81,7 @@ public class ConfigResource extends Resource {
/**
* [GET /{section}] - Show config file section.
- *
+ *
* @param section The section name.
* @return The config file section.
* @throws Exception
@@ -100,7 +100,7 @@ public class ConfigResource extends Resource {
/**
* [GET /{section}/{key}] - Show config file entry.
- *
+ *
* @param section The section name.
* @param key The section key.
* @return The value of the config file entry.
@@ -121,7 +121,7 @@ public class ConfigResource extends Resource {
/**
* [POST /] - Sets contents of config file from a FORM post.
- *
+ *
* @param contents The new contents of the config file.
* @return The new config file contents.
* @throws Exception
@@ -140,7 +140,7 @@ public class ConfigResource extends Resource {
/**
* [PUT /] - Sets contents of config file.
- *
+ *
* @param contents The new contents of the config file.
* @return The new config file contents.
* @throws Exception
@@ -160,7 +160,7 @@ public class ConfigResource extends Resource {
/**
* [PUT /{section}] - Add or overwrite a config file section.
- *
+ *
* @param section The section name.
* @param contents The new contents of the config file section.
* @return The new section.
@@ -182,7 +182,7 @@ public class ConfigResource extends Resource {
/**
* [PUT /{section}/{key}] - Add or overwrite a config file entry.
- *
+ *
* @param section The section name.
* @param key The section key.
* @param value The new value.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
index e0e7b74..11d08a4 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
@@ -114,7 +114,7 @@ public class DirectoryResource extends Resource {
/**
* [GET /*] - On directories, returns a directory listing. On files, returns information about the file.
- *
+ *
* @param req The HTTP request.
* @return Either a FileResource or list of FileResources depending on whether it's a
* file or directory.
@@ -152,7 +152,7 @@ public class DirectoryResource extends Resource {
/**
* [DELETE /*] - Delete a file on the file system.
- *
+ *
* @param req The HTTP request.
* @return The message <js>"File deleted"</js> if successful.
* @throws Exception If file could not be read or access was not granted.
@@ -173,7 +173,7 @@ public class DirectoryResource extends Resource {
/**
* [PUT /*] - Add or overwrite a file on the file system.
- *
+ *
* @param req The HTTP request.
* @return The message <js>"File added"</js> if successful.
* @throws Exception If file could not be read or access was not granted.
@@ -199,7 +199,7 @@ public class DirectoryResource extends Resource {
*
* <p>
* Applies to files only.
- *
+ *
* @param req The HTTP request.
* @param res The HTTP response.
* @return A Reader containing the contents of the file.
@@ -228,7 +228,7 @@ public class DirectoryResource extends Resource {
*
* <p>
* Applies to files only.
- *
+ *
* @param req The HTTP request.
* @param res The HTTP response.
* @return A Reader containing the contents of the file.
@@ -258,7 +258,7 @@ public class DirectoryResource extends Resource {
* <p>
* Subclasses can override this method to provide customized behavior.
* Method should throw a {@link RestException} if the request should be disallowed.
- *
+ *
* @param req The HTTP request.
*/
protected void checkAccess(RestRequest req) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java
index 02a2dcf..91c36d6 100644
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java
@@ -50,7 +50,7 @@ public class LogEntryFormatter extends Formatter {
/**
* Create a new formatter.
- *
+ *
* @param format
* The log entry format. e.g. <js>"[{date} {level}] {msg}%n"</js>
* The string can contain any of the following variables:
@@ -182,7 +182,7 @@ public class LogEntryFormatter extends Formatter {
/**
* Returns the regular expression pattern used for matching log entries.
- *
+ *
* @return The regular expression pattern used for matching log entries.
*/
public Pattern getLogEntryPattern() {
@@ -191,7 +191,7 @@ public class LogEntryFormatter extends Formatter {
/**
* Returns the {@link DateFormat} used for matching dates.
- *
+ *
* @return The {@link DateFormat} used for matching dates.
*/
public DateFormat getDateFormat() {
@@ -201,7 +201,7 @@ public class LogEntryFormatter extends Formatter {
/**
* Given a matcher that has matched the pattern specified by {@link #getLogEntryPattern()}, returns the field value
* from the match.
- *
+ *
* @param fieldName
* The field name.
* Possible values are:
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogParser.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogParser.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogParser.java
index ca5c896..229277d 100644
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogParser.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogParser.java
@@ -35,7 +35,7 @@ public final class LogParser implements Iterable<LogParser.Entry>, Iterator<LogP
/**
* Constructor.
- *
+ *
* @param formatter The log entry formatter.
* @param f The log file.
* @param start Don't return rows before this date. If <jk>null</jk>, start from the beginning of the file.
@@ -111,7 +111,7 @@ public final class LogParser implements Iterable<LogParser.Entry>, Iterator<LogP
/**
* Serializes the contents of the parsed log file to the specified writer and then closes the underlying reader.
- *
+ *
* @param w The writer to write the log file to.
* @throws IOException
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
index c5f9932..173872b 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
@@ -84,7 +84,7 @@ public class LogsResource extends Resource {
/**
* [GET /*] - Get file details or directory listing.
- *
+ *
* @param req The HTTP request
* @param res The HTTP response
* @param properties The writable properties for setting the descriptions.
@@ -120,7 +120,7 @@ public class LogsResource extends Resource {
/**
* [VIEW /*] - Retrieve the contents of a log file.
- *
+ *
* @param req The HTTP request.
* @param res The HTTP response.
* @param path The log file path.
@@ -190,7 +190,7 @@ public class LogsResource extends Resource {
/**
* [VIEW /*] - Retrieve the contents of a log file as parsed entries.
- *
+ *
* @param req The HTTP request.
* @param path The log file path.
* @param start Optional start timestamp. Don't print lines logged before the specified timestamp. Example: "&start=2014-01-23 11:25:47".
@@ -222,7 +222,7 @@ public class LogsResource extends Resource {
/**
* [DOWNLOAD /*] - Download file.
- *
+ *
* @param res The HTTP response.
* @param path The log file path.
* @return The contents of the log file.
@@ -249,7 +249,7 @@ public class LogsResource extends Resource {
/**
* [DELETE /*] - Delete a file.
- *
+ *
* @param path The log file path.
* @return A redirect object to the root.
* @throws Exception
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ShutdownResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ShutdownResource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ShutdownResource.java
index be66963..e950c15 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ShutdownResource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ShutdownResource.java
@@ -30,7 +30,7 @@ public class ShutdownResource extends Resource {
/**
* [GET /] - Shutdown this resource.
- *
+ *
* @return The string <js>"OK"</js>.
* @throws Exception
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/HtmlDocLinksResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/HtmlDocLinksResource.java b/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/HtmlDocLinksResource.java
index 57c1a71..3c54110 100644
--- a/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/HtmlDocLinksResource.java
+++ b/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/HtmlDocLinksResource.java
@@ -143,7 +143,7 @@ public class HtmlDocLinksResource extends RestServletDefault {
)
public static class HtmlDocLinksResource2 extends HtmlDocLinksResource {
/**
- *
+ *
*/
private static final long serialVersionUID = 1L;
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/pojos/Constants.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/pojos/Constants.java b/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/pojos/Constants.java
index 76c469e..ba7aced 100644
--- a/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/pojos/Constants.java
+++ b/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/pojos/Constants.java
@@ -15,7 +15,7 @@ package org.apache.juneau.rest.test.pojos;
/**
* Description.
* <p>
- *
+ *
* @author James Bognar (james.bognar@salesforce.com)
*/
public class Constants {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/GzipTest.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/GzipTest.java b/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/GzipTest.java
index 2df12fd..f6efc23 100644
--- a/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/GzipTest.java
+++ b/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/GzipTest.java
@@ -26,7 +26,7 @@ import org.junit.*;
/**
* Test Accept-Encoding and Content-Encoding handling.
- *
+ *
* Note: WAS does automatic gzip decompression on http request messages, so we have to invent
* our own 'mycoding' compression.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/RestTestcase.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/RestTestcase.java b/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/RestTestcase.java
index 983180e..0a5c2ea 100644
--- a/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/RestTestcase.java
+++ b/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/RestTestcase.java
@@ -22,7 +22,7 @@ import org.junit.*;
/**
* Superclass of REST testcases that start up the REST test microservice before running the tests locally.
- *
+ *
* @author James Bognar (james.bognar@salesforce.com)
*/
public class RestTestcase {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java
index 17e945f..4199936 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java
@@ -16,8 +16,9 @@ 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>.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>
* This class is similar to <code>org.apache.http.impl.client.LaxRedirectStrategy</code>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java
index 98f2412..b5994d7 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java
@@ -19,7 +19,7 @@ import org.apache.http.message.*;
/**
* Convenience class for setting date headers in RFC2616 format.
- *
+ *
* <p>
* Equivalent to the following code:
* <p class='bcode'>
@@ -32,7 +32,7 @@ public final class DateHeader extends BasicHeader {
/**
* Creates a date request property in RFC2616 format.
- *
+ *
* @param name The header name.
* @param value The header value.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/HttpMethod.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/HttpMethod.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/HttpMethod.java
index 9dc0d67..f89b71e 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/HttpMethod.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/HttpMethod.java
@@ -52,7 +52,7 @@ public enum HttpMethod {
/**
* Returns whether this HTTP method normally has content.
- *
+ *
* @return <jk>true</jk> if this HTTP method normally has content.
*/
public boolean hasContent() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java
index d63ea31..2fe804b 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java
@@ -24,11 +24,11 @@ import org.apache.juneau.urlencoding.*;
/**
* 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* NameValuePairs params = <jk>new</jk> NameValuePairs()
@@ -43,7 +43,7 @@ public final class NameValuePairs extends LinkedList<NameValuePair> {
/**
* Appends the specified pair to the end of this list.
- *
+ *
* @param pair The pair to append to this list.
* @return This object (for method chaining).
*/
@@ -54,10 +54,10 @@ public final class NameValuePairs extends LinkedList<NameValuePair> {
/**
* Appends the specified name/value pair to the end of this list.
- *
+ *
* <p>
* The value is simply converted to a string using <code>toString()</code>, or <js>"null"</js> if <jk>null</jk>.
- *
+ *
* @param name The pair name.
* @param value The pair value.
* @return This object (for method chaining).
@@ -69,10 +69,10 @@ public final class NameValuePairs extends LinkedList<NameValuePair> {
/**
* Appends the specified name/value pair to the end of this list.
- *
+ *
* <p>
* The value is converted to UON notation using the {@link UrlEncodingSerializer} defined on the client.
- *
+ *
* @param name The pair name.
* @param value The pair value.
* @param partSerializer The serializer to use for converting values to simple strings.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java
index cf491c6..66e55ca 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java
@@ -17,18 +17,18 @@ import java.util.regex.*;
/**
* Used to find regular expression matches in REST responses made through {@link RestCall}.
- *
+ *
* <p>
* 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.
* <p class='bcode'>
* <jk>final</jk> List<Number> xList = <jk>new</jk> ArrayList<Number>();
* <jk>final</jk> List<String> yList = <jk>new</jk> ArrayList<String>();
- *
+ *
* restClient.doGet(<jsf>URL</jsf>)
* .addResponsePattern(
* <jk>new</jk> ResponsePattern(<js>"x=(\\d+)"</js>) {
@@ -56,7 +56,7 @@ import java.util.regex.*;
* )
* .run();
* </p>
- *
+ *
* <h5 class='notes'>Important Notes:</h5>
* <ol class='notes'>
* <li>
@@ -80,7 +80,7 @@ public abstract class ResponsePattern {
/**
* Constructor.
- *
+ *
* @param pattern Regular expression pattern.
*/
public ResponsePattern(String pattern) {
@@ -104,7 +104,7 @@ public abstract class ResponsePattern {
/**
* Returns the pattern passed in through the constructor.
- *
+ *
* @return The pattern passed in through the constructor.
*/
protected String getPattern() {
@@ -113,10 +113,10 @@ public abstract class ResponsePattern {
/**
* 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.
- *
+ *
* @param rc The {@link RestCall} that this pattern finder is being used on.
* @param m The regular expression {@link Matcher}. Can be used to retrieve group matches in the pattern.
* @throws RestCallException Instances can throw an exception if a failure condition is detected.
@@ -125,7 +125,7 @@ public abstract class ResponsePattern {
/**
* Instances can override this method to handle when a regular expression pattern doesn't match on the output.
- *
+ *
* @param rc The {@link RestCall} that this pattern finder is being used on.
* @throws RestCallException Instances can throw an exception if a failure condition is detected.
*/
[10/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRest.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRest.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRest.java
index 2d7429a..7c7dafa 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRest.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRest.java
@@ -24,10 +24,10 @@ import org.apache.juneau.parser.*;
/**
* Provides the ability to perform standard REST operations (GET, PUT, POST, DELETE) against nodes in a POJO model.
- *
+ *
* <p>
* 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'>
@@ -38,20 +38,20 @@ import org.apache.juneau.parser.*;
* <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.
- *
+ *
* <p>
* Leading slashes in URLs are ignored.
* So <js>"/xxx/yyy/zzz"</js> and <js>"xxx/yyy/zzz"</js> are considered identical.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct an unstructured POJO model</jc>
@@ -74,34 +74,34 @@ import org.apache.juneau.parser.*;
* + <js>" 'fico score':' > 640' "</js>
* + <js>"} "</js>
* );
- *
+ *
* <jc>// Wrap Map inside a PojoRest object</jc>
* PojoRest johnSmith = <jk>new</jk> PojoRest(m);
- *
+ *
* <jc>// Get a simple value at the top level</jc>
* <jc>// "John Smith"</jc>
* String name = johnSmith.getString(<js>"name"</js>);
- *
+ *
* <jc>// Change a simple value at the top level</jc>
* johnSmith.put(<js>"name"</js>, <js>"The late John Smith"</js>);
- *
+ *
* <jc>// Get a simple value at a deep level</jc>
* <jc>// "21 2nd Street"</jc>
* String streetAddress = johnSmith.getString(<js>"address/streetAddress"</js>);
- *
+ *
* <jc>// Set a simple value at a deep level</jc>
* johnSmith.put(<js>"address/streetAddress"</js>, <js>"101 Cemetery Way"</js>);
- *
+ *
* <jc>// Get entries in a list</jc>
* <jc>// "212 555-1111"</jc>
* String firstPhoneNumber = johnSmith.getString(<js>"phoneNumbers/0"</js>);
- *
+ *
* <jc>// Add entries to a list</jc>
* johnSmith.post(<js>"phoneNumbers"</js>, <js>"212 555-3333"</js>);
- *
+ *
* <jc>// Delete entries from a model</jc>
* johnSmith.delete(<js>"fico score"</js>);
- *
+ *
* <jc>// Add entirely new structures to the tree</jc>
* ObjectMap medicalInfo = new ObjectMap(<js>""</js>
* + <js>"{"</js>
@@ -112,12 +112,12 @@ import org.apache.juneau.parser.*;
* );
* 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Get map/bean with name attribute value of 'foo' from a list of items</jc>
@@ -141,10 +141,10 @@ public final class PojoRest {
/**
* Create a new instance of a REST interface over the specified object.
- *
+ *
* <p>
* Uses {@link BeanContext#DEFAULT} for working with Java beans.
- *
+ *
* @param o The object to be wrapped.
*/
public PojoRest(Object o) {
@@ -153,10 +153,10 @@ public final class PojoRest {
/**
* Create a new instance of a REST interface over the specified object.
- *
+ *
* <p>
* The parser is used as the bean context.
- *
+ *
* @param o The object to be wrapped.
* @param parser The parser to use for parsing arguments and converting objects to the correct data type.
*/
@@ -170,7 +170,7 @@ public final class PojoRest {
/**
* Call this method to prevent the root object from being overwritten on <code>put("", xxx);</code> calls.
- *
+ *
* @return This object (for method chaining).
*/
public PojoRest setRootLocked() {
@@ -180,7 +180,7 @@ public final class PojoRest {
/**
* The root object that was passed into the constructor of this method.
- *
+ *
* @return The root object.
*/
public Object getRootObject() {
@@ -189,7 +189,7 @@ public final class PojoRest {
/**
* Retrieves the element addressed by the URL.
- *
+ *
* @param url
* The URL of the element to retrieve.
* <br>If <jk>null</jk> or blank, returns the root.
@@ -201,7 +201,7 @@ public final class PojoRest {
/**
* Retrieves the element addressed by the URL.
- *
+ *
* @param url
* The URL of the element to retrieve.
* <br>If <jk>null</jk> or blank, returns the root.
@@ -215,35 +215,35 @@ public final class PojoRest {
/**
* Retrieves the element addressed by the URL as the specified object type.
- *
+ *
* <p>
* Will convert object to the specified type per {@link BeanSession#convertToType(Object, Class)}.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* PojoRest r = <jk>new</jk> PojoRest(object);
- *
+ *
* <jc>// Value converted to a string.</jc>
* String s = r.get(<js>"path/to/string"</js>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a bean.</jc>
* MyBean b = r.get(<js>"path/to/bean"</js>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a bean array.</jc>
* MyBean[] ba = r.get(<js>"path/to/beanarray"</js>, MyBean[].<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a linked-list of objects.</jc>
* List l = r.get(<js>"path/to/list"</js>, LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a map of object keys/values.</jc>
* Map m2 = r.get(<js>"path/to/map"</js>, TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* @param url
* The URL of the element to retrieve.
* If <jk>null</jk> or blank, returns the root.
* @param type The specified object type.
- *
+ *
* @param <T> The specified object type.
* @return The addressed element, or null if that element does not exist in the tree.
*/
@@ -253,53 +253,53 @@ public final class PojoRest {
/**
* Retrieves the element addressed by the URL as the specified object type.
- *
+ *
* <p>
* Will convert object to the specified type per {@link BeanSession#convertToType(Object, Class)}.
- *
+ *
* <p>
* The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* PojoMap r = <jk>new</jk> PojoMap(object);
- *
+ *
* <jc>// Value converted to a linked-list of strings.</jc>
* List<String> l1 = r.get(<js>"path/to/list1"</js>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a linked-list of beans.</jc>
* List<MyBean> l2 = r.get(<js>"path/to/list2"</js>, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a linked-list of linked-lists of strings.</jc>
* List<List<String>> l3 = r.get(<js>"path/to/list3"</js>, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a map of string keys/values.</jc>
* Map<String,String> m1 = r.get(<js>"path/to/map1"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Value converted to a map containing string keys and values of lists containing beans.</jc>
* Map<String,List<MyBean>> m2 = r.get(<js>"path/to/map2"</js>, 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.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Use the {@link #get(String, Class)} method instead if you don't need a parameterized map/collection.
* </ul>
- *
+ *
* @param url
* The URL of the element to retrieve.
* If <jk>null</jk> or blank, returns the root.
* @param type The specified object type.
* @param args The specified object parameter types.
- *
+ *
* @param <T> The specified object type.
* @return The addressed element, or null if that element does not exist in the tree.
*/
@@ -309,13 +309,13 @@ public final class PojoRest {
/**
* Same as {@link #get(String, Class)} but returns a default value if the addressed element is null or non-existent.
- *
+ *
* @param url
* The URL of the element to retrieve.
* If <jk>null</jk> or blank, returns the root.
* @param def The default value if addressed item does not exist.
* @param type The specified object type.
- *
+ *
* @param <T> The specified object type.
* @return The addressed element, or null if that element does not exist in the tree.
*/
@@ -328,14 +328,14 @@ public final class PojoRest {
/**
* Same as {@link #get(String,Type,Type[])} but returns a default value if the addressed element is null or non-existent.
- *
+ *
* @param url
* The URL of the element to retrieve.
* If <jk>null</jk? or blank, returns the root.
* @param def The default value if addressed item does not exist.
* @param type The specified object type.
* @param args The specified object parameter types.
- *
+ *
* @param <T> The specified object type.
* @return The addressed element, or null if that element does not exist in the tree.
*/
@@ -348,10 +348,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link String}.
- *
+ *
* <p>
* Shortcut for <code>get(String.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
*/
@@ -361,10 +361,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link String}.
- *
+ *
* <p>
* Shortcut for <code>get(String.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -375,10 +375,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to an {@link Integer}.
- *
+ *
* <p>
* Shortcut for <code>get(Integer.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -389,10 +389,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to an {@link Integer}.
- *
+ *
* <p>
* Shortcut for <code>get(Integer.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -404,10 +404,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Long}.
- *
+ *
* <p>
* Shortcut for <code>get(Long.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -418,10 +418,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Long}.
- *
+ *
* <p>
* Shortcut for <code>get(Long.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -433,10 +433,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Boolean}.
- *
+ *
* <p>
* Shortcut for <code>get(Boolean.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -447,10 +447,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Boolean}.
- *
+ *
* <p>
* Shortcut for <code>get(Boolean.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -462,10 +462,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Map}.
- *
+ *
* <p>
* Shortcut for <code>get(Map.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -476,10 +476,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Map}.
- *
+ *
* <p>
* Shortcut for <code>get(Map.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -491,10 +491,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link List}.
- *
+ *
* <p>
* Shortcut for <code>get(List.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -505,10 +505,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link List}.
- *
+ *
* <p>
* Shortcut for <code>get(List.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -520,10 +520,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link Map}.
- *
+ *
* <p>
* Shortcut for <code>get(ObjectMap.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -534,10 +534,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link ObjectMap}.
- *
+ *
* <p>
* Shortcut for <code>get(ObjectMap.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -549,10 +549,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link ObjectList}.
- *
+ *
* <p>
* Shortcut for <code>get(ObjectList.<jk>class</jk>, key)</code>.
- *
+ *
* @param url The key.
* @return The converted value, or <jk>null</jk> if the map contains no mapping for this key.
* @throws InvalidDataConversionException If value cannot be converted.
@@ -563,10 +563,10 @@ public final class PojoRest {
/**
* Returns the specified entry value converted to a {@link ObjectList}.
- *
+ *
* <p>
* Shortcut for <code>get(ObjectList.<jk>class</jk>, key, defVal)</code>.
- *
+ *
* @param url The key.
* @param defVal The default value if the map doesn't contain the specified mapping.
* @return The converted value, or the default value if the map contains no mapping for this key.
@@ -578,7 +578,7 @@ public final class PojoRest {
/**
* Executes the specified method with the specified parameters on the specified object.
- *
+ *
* @param url The URL of the element to retrieve.
* @param method
* The method signature.
@@ -628,7 +628,7 @@ public final class PojoRest {
/**
* Returns the list of available methods that can be passed to the {@link #invokeMethod(String, String, String)}
* for the object addressed by the specified URL.
- *
+ *
* @param url The URL.
* @return The list of methods.
*/
@@ -641,7 +641,7 @@ public final class PojoRest {
/**
* Returns the class type of the object at the specified URL.
- *
+ *
* @param url The URL.
* @return The class type.
*/
@@ -654,10 +654,10 @@ public final class PojoRest {
/**
* Sets/replaces the element addressed by the URL.
- *
+ *
* <p>
* This method expands the POJO model as necessary to create the new element.
- *
+ *
* @param url
* The URL of the element to create.
* If <jk>null</jk> or blank, the root itself is replaced with the specified value.
@@ -670,16 +670,16 @@ public final class PojoRest {
/**
* Adds a value to a list element in a POJO model.
- *
+ *
* <p>
* The URL is the address of the list being added to.
- *
+ *
* <p>
* 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.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>You can only post to three types of nodes:
@@ -689,7 +689,7 @@ public final class PojoRest {
* <li>arrays
* </ul>
* </ul>
- *
+ *
* @param url
* The URL of the element being added to.
* If <jk>null</jk> or blank, the root itself (assuming it's one of the types specified above) is added to.
@@ -702,10 +702,10 @@ public final class PojoRest {
/**
* Remove an element from a POJO model.
- *
+ *
* <p>
* If the element does not exist, no action is taken.
- *
+ *
* @param url
* The URL of the element being deleted.
* If <jk>null</jk> or blank, the root itself is deleted.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRestException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRestException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRestException.java
index 77ec174..98b1151 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRestException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoRestException.java
@@ -19,10 +19,10 @@ import org.apache.juneau.*;
/**
* Generic exception thrown from the {@link PojoRest} class.
- *
+ *
* <p>
* Typically, this is a user-error, such as trying to address a non-existent node in the tree.
- *
+ *
* <p>
* The status code is an HTTP-equivalent code. It will be one of the following:
* <ul class='spaced-list'>
@@ -45,7 +45,7 @@ public final class PojoRestException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param status The HTTP-equivalent status code.
* @param message The detailed message.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -57,10 +57,10 @@ public final class PojoRestException extends FormattedRuntimeException {
/**
* The HTTP-equivalent status code.
- *
+ *
* <p>
* See above for details.
- *
+ *
* @return The HTTP-equivalent status code.
*/
public int getStatus() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ProcBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ProcBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ProcBuilder.java
index d243803..ab3bfe1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ProcBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ProcBuilder.java
@@ -25,7 +25,7 @@ import org.apache.juneau.utils.IOPipe.*;
/**
* Utility class for running operating system processes.
- *
+ *
* <p>
* Similar to {@link java.lang.ProcessBuilder} but with additional features.
*/
@@ -41,10 +41,10 @@ public class ProcBuilder {
/**
* Creates a process builder with the specified arguments.
- *
+ *
* <p>
* Equivalent to calling <code>ProcessBuilder.create().command(args);</code>
- *
+ *
* @param args The command-line arguments.
* @return A new process builder.
*/
@@ -54,7 +54,7 @@ public class ProcBuilder {
/**
* Creates an empty process builder.
- *
+ *
* @return A new process builder.
*/
public static ProcBuilder create() {
@@ -63,10 +63,10 @@ public class ProcBuilder {
/**
* Command arguments.
- *
+ *
* <p>
* Arguments can be collections or arrays and will be automatically expanded.
- *
+ *
* @param args The command-line arguments.
* @return This object (for method chaining).
*/
@@ -76,10 +76,10 @@ public class ProcBuilder {
/**
* Command arguments if the specified matcher matches.
- *
+ *
* <p>
* Can be used for specifying OS-specific commands.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* ProcBuilder pb = ProcBuilder
@@ -89,7 +89,7 @@ public class ProcBuilder {
* .merge()
* .execute();
* </p>
- *
+ *
* @param m The matcher.
* @param args The command line arguments if matcher matches.
* @return This object (for method chaining).
@@ -102,10 +102,10 @@ public class ProcBuilder {
/**
* Append to the command arguments.
- *
+ *
* <p>
* Arguments can be collections or arrays and will be automatically expanded.
- *
+ *
* @param args The command-line arguments.
* @return This object (for method chaining).
*/
@@ -115,10 +115,10 @@ public class ProcBuilder {
/**
* Append to the command arguments if the specified matcher matches.
- *
+ *
* <p>
* Arguments can be collections or arrays and will be automatically expanded.
- *
+ *
* @param m The matcher.
* @param args The command line arguments if matcher matches.
* @return This object (for method chaining).
@@ -131,7 +131,7 @@ public class ProcBuilder {
/**
* Merge STDOUT and STDERR into a single stream.
- *
+ *
* @return This object (for method chaining).
*/
public ProcBuilder merge() {
@@ -141,10 +141,10 @@ public class ProcBuilder {
/**
* Use by-lines mode.
- *
+ *
* <p>
* Flushes output after every line of input.
- *
+ *
* @return This object (for method chaining).
*/
public ProcBuilder byLines() {
@@ -154,10 +154,10 @@ public class ProcBuilder {
/**
* Pipe output to the specified writer.
- *
+ *
* <p>
* The method can be called multiple times to write to multiple writers.
- *
+ *
* @param w The writer to pipe to.
* @param close Close the writer afterwards.
* @return This object (for method chaining).
@@ -169,7 +169,7 @@ public class ProcBuilder {
/**
* Pipe output to the specified writer, but don't close the writer.
- *
+ *
* @param w The writer to pipe to.
* @return This object (for method chaining).
*/
@@ -179,10 +179,10 @@ public class ProcBuilder {
/**
* Pipe output to the specified writer, including the command and return code.
- *
+ *
* <p>
* The method can be called multiple times to write to multiple writers.
- *
+ *
* @param w The writer to pipe to.
* @param close Close the writer afterwards.
* @return This object (for method chaining).
@@ -195,11 +195,11 @@ public class ProcBuilder {
/**
* Pipe output to the specified writer, including the command and return code.
- *
+ *
* <p>
* The method can be called multiple times to write to multiple writers.
* Don't close the writer afterwards.
- *
+ *
* @param w The writer to pipe to.
* @return This object (for method chaining).
*/
@@ -210,7 +210,7 @@ public class ProcBuilder {
/**
* Pipe output to the specified writer, including the command and return code.
* The method can be called multiple times to write to multiple writers.
- *
+ *
* @param level The log level.
* @param logger The logger to log to.
* @return This object (for method chaining).
@@ -232,7 +232,7 @@ public class ProcBuilder {
/**
* Line processor to use to process/convert lines of output returned by the process.
- *
+ *
* @param lp The new line processor.
* @return This object (for method chaining).
*/
@@ -243,7 +243,7 @@ public class ProcBuilder {
/**
* Append the specified environment variables to the process.
- *
+ *
* @param env The new set of environment variables.
* @return This object (for method chaining).
*/
@@ -257,7 +257,7 @@ public class ProcBuilder {
/**
* Append the specified environment variable.
- *
+ *
* @param key The environment variable name.
* @param val The environment variable value.
* @return This object (for method chaining).
@@ -269,7 +269,7 @@ public class ProcBuilder {
/**
* Sets the directory where the command will be executed.
- *
+ *
* @param directory The directory.
* @return This object (for method chaining).
*/
@@ -280,11 +280,11 @@ public class ProcBuilder {
/**
* Sets the maximum allowed return code on the process call.
- *
+ *
* <p>
* If the return code exceeds this value, an IOException is returned on the {@link #run()} command.
* The default value is '0'.
- *
+ *
* @param maxExitStatus The maximum exit status.
* @return This object (for method chaining).
*/
@@ -295,7 +295,7 @@ public class ProcBuilder {
/**
* Run this command and pipes the output to the specified writer or output stream.
- *
+ *
* @return The exit code from the process.
* @throws IOException
* @throws InterruptedException
@@ -320,7 +320,7 @@ public class ProcBuilder {
/**
* Run this command and returns the output as a simple string.
- *
+ *
* @return The output from the command.
* @throws IOException
* @throws InterruptedException
@@ -333,7 +333,7 @@ public class ProcBuilder {
/**
* Returns the output from this process as a {@link Scanner}.
- *
+ *
* @return The output from the process as a Scanner object.
* @throws IOException
* @throws InterruptedException
@@ -347,7 +347,7 @@ public class ProcBuilder {
/**
* Destroys the underlying process.
- *
+ *
* <p>
* This method is only needed if the {@link #getScanner()} method was used.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/SearchArgs.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/SearchArgs.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/SearchArgs.java
index ea7001e..93d3c7c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/SearchArgs.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/SearchArgs.java
@@ -41,7 +41,7 @@ public class SearchArgs {
/**
* Creates a new builder for {@link SearchArgs}
- *
+ *
* @return A new builder for {@link SearchArgs}
*/
public static Builder builder() {
@@ -60,22 +60,22 @@ public class SearchArgs {
/**
* Adds search terms to this builder.
- *
+ *
* <p>
* The search terms are a comma-delimited list of key/value pairs of column-names and search tokens.
- *
+ *
* <p>
* For example:
* <p class='bcode'>
* builder.search(<js>"column1=foo*, column2=bar baz"</js>);
* </p>
- *
+ *
* <p>
* It's up to implementers to decide the syntax and meaning of the search terms.
- *
+ *
* <p>
* Whitespace is trimmed from column names and search tokens.
- *
+ *
* @param searchTerms
* The search terms string.
* Can be <jk>null</jk>.
@@ -96,10 +96,10 @@ public class SearchArgs {
/**
* Adds a search term to this builder.
- *
+ *
* <p>
* It's up to implementers to decide the syntax and meaning of the search term.
- *
+ *
* @param column The column being searched.
* @param searchTerm The search term.
* @return This object (for method chaining).
@@ -111,22 +111,22 @@ public class SearchArgs {
/**
* Specifies the list of columns to view.
- *
+ *
* <p>
* The columns argument is a simple comma-delimited list of column names.
- *
+ *
* <p>
* For example:
* <p class='bcode'>
* builder.view(<js>"column1, column2"</js>);
* </p>
- *
+ *
* <p>
* Whitespace is trimmed from column names.
- *
+ *
* <p>
* Empty view columns imply view all columns.
- *
+ *
* @param columns
* The columns being viewed.
* Can be <jk>null</jk>.
@@ -140,10 +140,10 @@ public class SearchArgs {
/**
* Specifies the list of columns to view.
- *
+ *
* <p>
* Empty view columns imply view all columns.
- *
+ *
* @param columns The columns being viewed.
* @return This object (for method chaining).
*/
@@ -154,25 +154,25 @@ 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.
- *
+ *
* @param sortArgs
* The columns to sort by.
* Can be <jk>null</jk>.
@@ -186,14 +186,14 @@ public class SearchArgs {
/**
* Specifies the sort arguments.
- *
+ *
* <p>
* 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.
- *
+ *
* @param sortArgs
* The columns to sort by.
* Can be <jk>null</jk>.
@@ -213,7 +213,7 @@ public class SearchArgs {
/**
* Specifies the starting line number.
- *
+ *
* @param position The zero-indexed position.
* @return This object (for method chaining).
*/
@@ -224,7 +224,7 @@ public class SearchArgs {
/**
* Specifies the number of rows to return.
- *
+ *
* @param limit
* The number of rows to return.
* If <code><=0</code>, all rows should be returned.
@@ -237,10 +237,10 @@ public class SearchArgs {
/**
* Specifies whether case-insensitive search should be used.
- *
+ *
* <p>
* The default is <jk>false</jk>.
- *
+ *
* @param value The ignore-case flag value.
* @return This object (for method chaining).
*/
@@ -251,10 +251,10 @@ public class SearchArgs {
/**
* Construct the {@link SearchArgs} object.
- *
+ *
* <p>
* This method can be called multiple times to construct new objects.
- *
+ *
* @return A new {@link SearchArgs} object initialized with values in this builder.
*/
public SearchArgs build() {
@@ -264,13 +264,13 @@ public class SearchArgs {
/**
* The query search terms.
- *
+ *
* <p>
* The search terms are key/value pairs consisting of column-names and search tokens.
- *
+ *
* <p>
* It's up to implementers to decide the syntax and meaning of the search term.
- *
+ *
* @return An unmodifiable map of query search terms.
*/
public Map<String,String> getSearch() {
@@ -279,11 +279,11 @@ public class SearchArgs {
/**
* The view columns.
- *
+ *
* <p>
* The view columns are the list of columns that should be displayed.
* An empty list implies all columns should be displayed.
- *
+ *
* @return An unmodifiable list of columns to view.
*/
public List<String> getView() {
@@ -292,11 +292,11 @@ public class SearchArgs {
/**
* The sort columns.
- *
+ *
* <p>
* The sort columns are key/value pairs consisting of column-names and direction flags
* (<jk>false</jk> = ascending, <jk>true</jk> = descending).
- *
+ *
* @return An unmodifiable ordered map of sort columns and directions.
*/
public Map<String,Boolean> getSort() {
@@ -305,7 +305,7 @@ public class SearchArgs {
/**
* The first-row position.
- *
+ *
* @return
* The zero-indexed row number of the first row to display.
* Default is <code>0</code>
@@ -316,7 +316,7 @@ public class SearchArgs {
/**
* The number of rows to return.
- *
+ *
* @return
* The number of rows to return in the result.
* Default is <code>0</code> which means return all rows.
@@ -327,10 +327,10 @@ public class SearchArgs {
/**
* The ignore-case flag.
- *
+ *
* <p>
* Used in conjunction with {@link #getSearch()} to specify whether case-insensitive searches should be performed.
- *
+ *
* @return
* The number of rows to return in the result.
* Default is <jk>false</jk>.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringMessage.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringMessage.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringMessage.java
index 329d58a..17ed8fa 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringMessage.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringMessage.java
@@ -22,7 +22,7 @@ import org.apache.juneau.http.*;
/**
* An encapsulated MessageFormat-style string and arguments.
- *
+ *
* <p>
* Useful for delayed serialization of arguments for logging.
* Message string will not be constructed until the <code>toString()</code> method is called.
@@ -35,7 +35,7 @@ public class StringMessage implements CharSequence, Writable {
/**
* Constructor.
- *
+ *
* @param pattern {@link MessageFormat}-style pattern.
* @param args Message arguments.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringObject.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringObject.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringObject.java
index 0cf0b28..2982db6 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringObject.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/StringObject.java
@@ -21,13 +21,13 @@ import org.apache.juneau.serializer.*;
/**
* A serializer/object pair used for delayed object serialization.
- *
+ *
* <p>
* Useful in certain conditions such as logging when you don't want to needlessly serialize objects.
- *
+ *
* <p>
* Instances of this method are created by the {@link WriterSerializer#toStringObject(Object)} method.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// The POJO will not be serialized unless DEBUG is enabled.</jc>
@@ -42,7 +42,7 @@ public class StringObject implements CharSequence, Writable {
/**
* Constructor.
- *
+ *
* @param s The serializer to use to serialize the object.
* @param o The object to be serialized.
*/
@@ -53,7 +53,7 @@ public class StringObject implements CharSequence, Writable {
/**
* Constructor with default serializer {@link JsonSerializer#DEFAULT_LAX}
- *
+ *
* @param o The object to be serialized.
*/
public StringObject(Object o) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ZipFileList.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ZipFileList.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ZipFileList.java
index a12183f..9395016 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ZipFileList.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ZipFileList.java
@@ -19,7 +19,7 @@ import java.util.zip.*;
/**
* Utility class for representing the contents of a zip file as a list of entries whose contents don't resolve until
* serialization time.
- *
+ *
* <p>
* Generally associated with <code>RestServlets</code> using the <code>responseHandlers</code> annotation so that
* REST methods can easily create ZIP file responses by simply returning instances of this class.
@@ -34,7 +34,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
/**
* Constructor.
- *
+ *
* @param fileName The file name of the zip file to create.
*/
public ZipFileList(String fileName) {
@@ -43,7 +43,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
/**
* Add an entry to this list.
- *
+ *
* @param e The zip file entry.
* @return This object (for method chaining).
*/
@@ -58,7 +58,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
public static interface ZipFileEntry {
/**
* Write this entry to the specified output stream.
- *
+ *
* @param zos The output stream to write to.
* @throws IOException
*/
@@ -78,7 +78,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
/**
* Constructor.
- *
+ *
* @param root The root file that represents the base path.
* @param file The file to add to the zip file.
*/
@@ -89,7 +89,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
/**
* Constructor.
- *
+ *
* @param file The file to add to the zip file.
*/
public FileEntry(File file) {
@@ -104,7 +104,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
/**
* Subclasses can override this method to customize which files get added to a zip file.
- *
+ *
* @param f The file being added to the zip file.
* @return Always returns <jk>true</jk>.
*/
@@ -114,7 +114,7 @@ public class ZipFileList extends LinkedList<ZipFileList.ZipFileEntry> {
/**
* Adds the specified file to the specified output stream.
- *
+ *
* @param zos The output stream.
* @param f The file to add.
* @throws IOException
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/Namespace.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/Namespace.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/Namespace.java
index d89a3e1..6451ec2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/Namespace.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/Namespace.java
@@ -21,7 +21,7 @@ import org.apache.juneau.internal.*;
/**
* Represents a simple namespace mapping between a simple name and URI.
- *
+ *
* <p>
* In general, the simple name will be used as the XML prefix mapping unless there are conflicts or prefix re-mappings
* in the serializer.
@@ -37,7 +37,7 @@ public final class Namespace {
*
* <p>
* Previously-encountered name/uri pairs return a cached copy.
- *
+ *
* @param name The namespace name. See {@link Namespace#getName()}.
* @param uri The namespace URI. See {@link Namespace#getUri()}.
* @return The namespace object.
@@ -73,14 +73,14 @@ public final class Namespace {
/**
* Converts the specified object into a {@link Namespace} object.
- *
+ *
* <p>
* Can be any of following types:
* <ul>
* <li>A {@link Namespace} object
* <li>A string containing a name/value pair of the form <js>"name:uri"</js>.
* </ul>
- *
+ *
* @param o The input.
* @return The namespace object, or <jk>null</jk> if the input was <jk>null</jk> or an empty JSON object.
*/
@@ -96,7 +96,7 @@ public final class Namespace {
/**
* Converts the specified object into an array of {@link Namespace} object.
- *
+ *
* <p>
* Can be any of following types:
* <ul>
@@ -104,7 +104,7 @@ public final class Namespace {
* <li>A comma-delimited string with key/value pairs of the form <js>"name:uri"</js>.
* <li>A <code>Collection</code> containing any of object that can be passed to {@link #createArray(Object)}.
* </ul>
- *
+ *
* @param o The input.
* @return The namespace objects, or <jk>null</jk> if the input was <jk>null</jk> or an empty JSON object.
*/
@@ -145,7 +145,7 @@ public final class Namespace {
/**
* Constructor.
- *
+ *
* @param name The short name of this schema.
* @param uri The URI of this schema.
*/
@@ -157,7 +157,7 @@ public final class Namespace {
/**
* Returns the namespace name.
- *
+ *
* @return The namespace name.
*/
public String getName() {
@@ -166,7 +166,7 @@ public final class Namespace {
/**
* Returns the namespace URI.
- *
+ *
* @return The namespace URI.
*/
public String getUri() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java
index c93c08c..91e75e3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanMeta.java
@@ -35,7 +35,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* Constructor.
- *
+ *
* @param beanMeta The metadata on the bean that this metadata applies to.
*/
public XmlBeanMeta(BeanMeta<?> beanMeta) {
@@ -138,7 +138,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The list of properties that should be rendered as XML attributes.
- *
+ *
* @return Map of property names to property metadata.
*/
protected Map<String,BeanPropertyMeta> getAttrProperties() {
@@ -147,7 +147,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The list of names of properties that should be rendered as XML attributes.
- *
+ *
* @return Set of property names.
*/
protected Set<String> getAttrPropertyNames() {
@@ -156,7 +156,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The list of properties that should be rendered as child elements.
- *
+ *
* @return Map of property names to property metadata.
*/
protected Map<String,BeanPropertyMeta> getElementProperties() {
@@ -165,7 +165,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The list of names of properties that should be rendered as child elements.
- *
+ *
* @return Set of property names.
*/
protected Set<String> getElementPropertyNames() {
@@ -175,7 +175,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The list of properties that should be rendered as collapsed child elements.
* <br>See {@link Xml#childName() @Xml.childName()}
- *
+ *
* @return Map of property names to property metadata.
*/
protected Map<String,BeanPropertyMeta> getCollapsedProperties() {
@@ -184,7 +184,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The list of names of properties that should be rendered as collapsed child elements.
- *
+ *
* @return Set of property names.
*/
protected Set<String> getCollapsedPropertyNames() {
@@ -193,7 +193,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The property that returns a map of XML attributes as key/value pairs.
- *
+ *
* @return The bean property metadata, or <jk>null</jk> if there is no such method.
*/
protected BeanPropertyMeta getAttrsProperty() {
@@ -202,7 +202,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The name of the property that returns a map of XML attributes as key/value pairs.
- *
+ *
* @return The bean property name, or <jk>null</jk> if there is no such method.
*/
protected String getAttrsPropertyName() {
@@ -211,7 +211,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The property that represents the inner XML content of this bean.
- *
+ *
* @return The bean property metadata, or <jk>null</jk> if there is no such method.
*/
protected BeanPropertyMeta getContentProperty() {
@@ -220,7 +220,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* The name of the property that represents the inner XML content of this bean.
- *
+ *
* @return The bean property name, or <jk>null</jk> if there is no such method.
*/
protected String getContentPropertyName() {
@@ -229,7 +229,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* Returns the format of the inner XML content of this bean.
- *
+ *
* <p>
* Can be one of the following:
* <ul>
@@ -242,7 +242,7 @@ public class XmlBeanMeta extends BeanMetaExtended {
* <li>{@link XmlFormat#VOID}
* <li><jk>null</jk>
* </ul>
- *
+ *
* @return The format of the inner XML content of this bean.
*/
protected XmlFormat getContentFormat() {
@@ -251,11 +251,11 @@ public class XmlBeanMeta extends BeanMetaExtended {
/**
* Returns bean property meta with the specified name.
- *
+ *
* <p>
* This is identical to calling {@link BeanMeta#getPropertyMeta(String)} except it first retrieves the bean property
* meta based on the child name (e.g. a property whose name is "people", but whose child name is "person").
- *
+ *
* @param fieldName The bean property name.
* @return The property metadata.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java
index ecef9e0..5c062a8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlBeanPropertyMeta.java
@@ -29,7 +29,7 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Constructor.
- *
+ *
* @param bpm The metadata of the bean property of this additional metadata.
*/
public XmlBeanPropertyMeta(BeanPropertyMeta bpm) {
@@ -48,7 +48,7 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns the XML namespace associated with this bean property.
- *
+ *
* <p>
* Namespace is determined in the following order of {@link Xml#prefix() @Xml.prefix()} annotation:
* <ol>
@@ -62,7 +62,7 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
* <li>Bean interfaces.
* <li>Bean interface packages.
* </ol>
- *
+ *
* @return The namespace associated with this bean property, or <jk>null</jk> if no namespace is associated with it.
*/
public Namespace getNamespace() {
@@ -71,7 +71,7 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns the XML format of this property from the {@link Xml#format} annotation on this bean property.
- *
+ *
* @return The XML format, or {@link XmlFormat#DEFAULT} if annotation not specified.
*/
protected XmlFormat getXmlFormat() {
@@ -80,7 +80,7 @@ public class XmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns the child element of this property from the {@link Xml#childName} annotation on this bean property.
- *
+ *
* @return The child element, or <jk>null</jk> if annotation not specified.
*/
protected String getChildName() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlClassMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlClassMeta.java
index 8dfb445..b3c853d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlClassMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlClassMeta.java
@@ -34,7 +34,7 @@ public class XmlClassMeta extends ClassMetaExtended {
/**
* Constructor.
- *
+ *
* @param cm The class that this annotation is defined on.
*/
public XmlClassMeta(ClassMeta<?> cm) {
@@ -54,7 +54,7 @@ public class XmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Xml @Xml} annotation defined on the class.
- *
+ *
* @return
* The value of the annotation defined on the class, or <jk>null</jk> if annotation is not specified.
*/
@@ -64,7 +64,7 @@ public class XmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Xml#format() @Xml.format()} annotation defined on the class.
- *
+ *
* @return The value of the annotation, or {@link XmlFormat#DEFAULT} if not specified.
*/
protected XmlFormat getFormat() {
@@ -73,7 +73,7 @@ public class XmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Xml#childName() @Xml.childName()} annotation defined on the class.
- *
+ *
* @return The value of the annotation, or <jk>null</jk> if not specified.
*/
protected String getChildName() {
@@ -82,7 +82,7 @@ public class XmlClassMeta extends ClassMetaExtended {
/**
* Returns the XML namespace associated with this class.
- *
+ *
* <p>
* Namespace is determined in the following order of {@link Xml#prefix() @Xml.prefix()} annotation:
* <ol>
@@ -93,7 +93,7 @@ public class XmlClassMeta extends ClassMetaExtended {
* <li>Interfaces.
* <li>Interface packages.
* </ol>
- *
+ *
* @return The namespace associated with this class, or <jk>null</jk> if no namespace is associated with it.
*/
protected Namespace getNamespace() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java
index a47849e..b9fef1a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializer.java
@@ -17,19 +17,20 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJOs to HTTP responses as XML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/xml</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/xml</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/xml</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/xml</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Same as {@link XmlSerializer}, except prepends <code><xt><?xml</xt> <xa>version</xa>=<xs>'1.0'</xs>
* <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?></xt></code> to the response to make it a valid XML document.
- *
+ *
*/
public class XmlDocSerializer extends XmlSerializer {
@@ -42,7 +43,7 @@ public class XmlDocSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Ns(PropertyStore ps) {
@@ -57,7 +58,7 @@ public class XmlDocSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public XmlDocSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializerSession.java
index 3f9449f..6763467 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlDocSerializerSession.java
@@ -16,7 +16,7 @@ import org.apache.juneau.serializer.*;
/**
* Session object that lives for the duration of a single use of {@link XmlDocSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -25,7 +25,7 @@ public class XmlDocSerializerSession extends XmlSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParseException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParseException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParseException.java
index ca91a50..5e46e57 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParseException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParseException.java
@@ -28,7 +28,7 @@ public class XmlParseException extends ParseException {
/**
* Constructor.
- *
+ *
* @param location The location of the exception.
* @param message The exception message containing {@link MessageFormat}-style arguments.
* @param args Optional {@link MessageFormat}-style arguments.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParser.java
index 9b41700..45e77e0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParser.java
@@ -20,13 +20,14 @@ import org.apache.juneau.parser.*;
/**
* Parses text generated by the {@link XmlSerializer} class back into a POJO model.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Content-Type</code> types: <code>text/xml</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Content-Type</code> types: <code><b>text/xml</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* See the {@link XmlSerializer} class for a description of Juneau-generated XML.
*/
public class XmlParser extends ReaderParser {
@@ -39,7 +40,7 @@ public class XmlParser extends ReaderParser {
/**
* Configuration property: XML event allocator.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlParser.eventAllocator.c"</js>
@@ -51,7 +52,7 @@ public class XmlParser extends ReaderParser {
* <li class='jm'>{@link XmlParserBuilder#eventAllocator(XMLEventAllocator)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Associates an {@link XMLEventAllocator} with this parser.
@@ -60,7 +61,7 @@ public class XmlParser extends ReaderParser {
/**
* Configuration property: Preserve root element during generalized parsing.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlParser.preserveRootElement.b"</js>
@@ -73,12 +74,12 @@ public class XmlParser extends ReaderParser {
* <li class='jm'>{@link XmlParserBuilder#preserveRootElement()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, when parsing into a generic {@link ObjectMap}, the map will contain a single entry whose key
* is the root element name.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Parser with preserve-root-element.</jc>
@@ -106,7 +107,7 @@ public class XmlParser extends ReaderParser {
/**
* Configuration property: XML reporter.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlParser.reporter.c"</js>
@@ -118,11 +119,11 @@ public class XmlParser extends ReaderParser {
* <li class='jm'>{@link XmlParserBuilder#reporter(XMLReporter)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Associates an {@link XMLReporter} with this parser.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Reporters are not copied to new parsers during a clone.
@@ -132,7 +133,7 @@ public class XmlParser extends ReaderParser {
/**
* Configuration property: XML resolver.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlParser.resolver.c"</js>
@@ -144,7 +145,7 @@ public class XmlParser extends ReaderParser {
* <li class='jm'>{@link XmlParserBuilder#resolver(XMLResolver)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Associates an {@link XMLResolver} with this parser.
@@ -153,7 +154,7 @@ public class XmlParser extends ReaderParser {
/**
* Configuration property: Enable validation.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlParser.validating.b"</js>
@@ -166,7 +167,7 @@ public class XmlParser extends ReaderParser {
* <li class='jm'>{@link XmlParserBuilder#validating()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, XML document will be validated.
@@ -198,7 +199,7 @@ public class XmlParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -208,7 +209,7 @@ public class XmlParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param consumes
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
index 1858b88..fc819fc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserBuilder.java
@@ -37,7 +37,7 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public XmlParserBuilder(PropertyStore ps) {
@@ -56,10 +56,10 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: XML event allocator.
- *
+ *
* <p>
* Associates an {@link XMLEventAllocator} with this parser.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_eventAllocator}
@@ -74,11 +74,11 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: Preserve root element during generalized parsing.
- *
+ *
* <p>
* If <jk>true</jk>, when parsing into a generic {@link ObjectMap}, the map will contain a single entry whose key is
* the root element name.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_preserveRootElement}
@@ -95,10 +95,10 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: Preserve root element during generalized parsing.
- *
+ *
* <p>
* Shortcut for calling <code>preserveRootElement(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_preserveRootElement}
@@ -112,10 +112,10 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: XML reporter.
- *
+ *
* <p>
* Associates an {@link XMLReporter} with this parser.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_reporter}
@@ -130,10 +130,10 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: XML resolver.
- *
+ *
* <p>
* Associates an {@link XMLResolver} with this parser.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_resolver}
@@ -148,10 +148,10 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: Enable validation.
- *
+ *
* <p>
* If <jk>true</jk>, XML document will be validated.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_validating}
@@ -168,10 +168,10 @@ public class XmlParserBuilder extends ParserBuilder {
/**
* Configuration property: Enable validation.
- *
+ *
* <p>
* Shortcut for calling <code>validating(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link XmlParser#XML_validating}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserSession.java
index 2784e95..630bce6 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlParserSession.java
@@ -30,7 +30,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Session object that lives for the duration of a single use of {@link XmlParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -50,7 +50,7 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -80,7 +80,7 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Wrap the specified reader in a STAX reader based on settings in this context.
- *
+ *
* @param pipe The parser input.
* @return The new STAX reader.
* @throws Exception If problem occurred trying to create reader.
@@ -91,10 +91,10 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Decodes and trims the specified string.
- *
+ *
* <p>
* Any <js>'_x####_'</js> sequences in the string will be decoded.
- *
+ *
* @param s The string to be decoded.
* @return The decoded string.
*/
@@ -134,13 +134,13 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Returns the text content of the current XML element.
- *
+ *
* <p>
* Any <js>'_x####_'</js> sequences in the string will be decoded.
- *
+ *
* <p>
* Leading and trailing whitespace (unencoded) will be trimmed from the result.
- *
+ *
* @param r The reader to read the element text from.
* @return The decoded text. <jk>null</jk> if the text consists of the sequence <js>'_x0000_'</js>.
* @throws Exception
@@ -189,7 +189,7 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Parses the current element as text.
- *
+ *
* @param r
* @return The parsed text.
* @throws Exception
@@ -223,11 +223,11 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Returns <jk>true</jk> if the current element is a whitespace element.
- *
+ *
* <p>
* For the XML parser, this always returns <jk>false</jk>.
* However, the HTML parser defines various whitespace elements such as <js>"br"</js> and <js>"sp"</js>.
- *
+ *
* @param r The XML stream reader to read the current event from.
* @return <jk>true</jk> if the current element is a whitespace element.
*/
@@ -237,11 +237,11 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Parses the current whitespace element.
- *
+ *
* <p>
* For the XML parser, this always returns <jk>null</jk> since there is no concept of a whitespace element.
* However, the HTML parser defines various whitespace elements such as <js>"br"</js> and <js>"sp"</js>.
- *
+ *
* @param r The XML stream reader to read the current event from.
* @return The whitespace character or characters.
* @throws XMLStreamException
@@ -270,7 +270,7 @@ public class XmlParserSession extends ReaderParserSession {
/**
* Workhorse method.
- *
+ *
* @param eType The expected type of object.
* @param currAttr The current bean property name.
* @param r The reader.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlReader.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlReader.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlReader.java
index c7206ce..7b8affa 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlReader.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlReader.java
@@ -22,7 +22,7 @@ import org.apache.juneau.parser.*;
/**
* Wrapper class around a {@link XMLStreamReader}.
- *
+ *
* <p>
* The purpose is to encapsulate the reader with the {@link ParserPipe} object so that it can be retrieved for
* debugging purposes.
@@ -34,7 +34,7 @@ public final class XmlReader implements XMLStreamReader {
/**
* Constructor.
- *
+ *
* @param pipe The parser input.
* @param validating The value for the {@link XMLInputFactory#IS_VALIDATING} setting.
* @param reporter The value for the {@link XMLInputFactory#REPORTER} setting.
@@ -68,7 +68,7 @@ public final class XmlReader implements XMLStreamReader {
/**
* Returns the pipe passed into the constructor.
- *
+ *
* @return The pipe passed into the constructor.
*/
public ParserPipe getPipe() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java
index 233aa79..8247fd4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializer.java
@@ -17,16 +17,16 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO metadata to HTTP responses as XML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/xml+schema</code>
- *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/xml+schema</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/xml</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/xml</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Same as {@link XmlSchemaSerializer}, except prepends <code><xt><?xml</xt> <xa>version</xa>=<xs>'1.0'</xs>
* <xa>encoding</xa>=<xs>'UTF-8'</xs><xt>?></xt></code> to the response to make it a valid XML document.
*/
@@ -38,7 +38,7 @@ public class XmlSchemaDocSerializer extends XmlSchemaSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public XmlSchemaDocSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializerSession.java
index 4d2dca7..f2ad70d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaDocSerializerSession.java
@@ -16,7 +16,7 @@ import org.apache.juneau.serializer.*;
/**
* Session object that lives for the duration of a single use of {@link XmlSchemaDocSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -25,7 +25,7 @@ public class XmlSchemaDocSerializerSession extends XmlSchemaSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java
index be2b2af..26780e7 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializer.java
@@ -17,23 +17,23 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO metadata to HTTP responses as XML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/xml+schema</code>
- *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/xml+schema</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/xml</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/xml</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Produces the XML-schema representation of the XML produced by the {@link XmlSerializer} class with the same properties.
*/
public class XmlSchemaSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps Initialize with the specified config property store.
*/
public XmlSchemaSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java
index 147e8aa..94b1a7b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerBuilder.java
@@ -32,7 +32,7 @@ public class XmlSchemaSerializerBuilder extends XmlSerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public XmlSchemaSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerSession.java
index aef9e26..9a3762f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSchemaSerializerSession.java
@@ -31,7 +31,7 @@ import org.w3c.dom.ls.*;
/**
* Session object that lives for the duration of a single use of {@link XmlSchemaSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -40,7 +40,7 @@ public class XmlSchemaSerializerSession extends XmlSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -69,7 +69,7 @@ public class XmlSchemaSerializerSession extends XmlSerializerSession {
/**
* Returns an XML-Schema validator based on the output returned by {@link #doSerialize(SerializerPipe, Object)};
- *
+ *
* @param out The target writer.
* @param o The object to serialize.
* @return The new validator.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializer.java
index 51f906b..9feffa3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/XmlSerializer.java
@@ -18,18 +18,19 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO models to XML.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/xml</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/xml</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/xml</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/xml</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* See the {@link JsonSerializer} class for details on how Java models map to JSON.
- *
+ *
* <p>
* For example, the following JSON...
* <p class='bcode'>
@@ -70,7 +71,7 @@ import org.apache.juneau.serializer.*;
* <xt><height></xt>62.4<xt></height></xt>
* <xt><fico_x0020_score></xt> &gt; 640<xt></fico_x0020_score></xt>
* <xt></object></xt>
- *
+ *
* <p>
* An additional "add-json-properties" mode is also provided to prevent loss of JSON data types...
* <p class='bcode'>
@@ -91,18 +92,18 @@ import org.apache.juneau.serializer.*;
* <xt><fico_x0020_score</xt> <xa>_type</xa>=<xs>'string'</xs><xt>></xt> &gt; 640<xt></fico_x0020_score></xt>
* <xt></object></xt>
* </p>
- *
+ *
* <p>
* This serializer provides several serialization options.
* Typically, one of the predefined <jsf>DEFAULT</jsf> serializers will be sufficient.
* However, custom serializers can be constructed to fine-tune behavior.
- *
+ *
* <p>
* If an attribute name contains any non-valid XML element characters, they will be escaped using standard
* {@code _x####_} notation.
- *
+ *
* <h6 class='topic'>Behavior-specific subclasses</h6>
- *
+ *
* The following direct subclasses are provided for convenience:
* <ul>
* <li>{@link Sq} - Default serializer, single quotes.
@@ -119,7 +120,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.addBeanTypeProperties.b"</js>
@@ -131,12 +132,12 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#addBeanTypeProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
* through reflection.
- *
+ *
* <p>
* When present, this value overrides the {@link #SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -145,7 +146,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: Add namespace URLs to the root element.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.addNamespaceUrisToRoot.b"</js>
@@ -158,11 +159,11 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#addNamespaceUrisToRoot()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* 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 #XML_enableNamespaces} is not enabled.
*/
@@ -170,7 +171,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: Auto-detect namespace usage.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.autoDetectNamespaces.b"</js>
@@ -182,22 +183,22 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#autoDetectNamespaces(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Detect namespace usage before serialization.
- *
+ *
* <p>
* Used in conjunction with {@link #XML_addNamespaceUrisToRoot} to reduce the list of namespace URLs appended to the
* root element to only those that will be used in the resulting document.
- *
+ *
* <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>
* This setting is ignored if {@link #XML_enableNamespaces} is not enabled.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Auto-detection of namespaces can be costly performance-wise.
@@ -209,7 +210,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: Default namespace.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.defaultNamespace.s"</js>
@@ -221,7 +222,7 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#defaultNamespace(String)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies the default namespace URI for this document.
@@ -230,7 +231,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: Enable support for XML namespaces.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.enableNamespaces.b"</js>
@@ -242,7 +243,7 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#enableNamespaces(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If not enabled, XML output will not contain any namespaces regardless of any other settings.
@@ -251,7 +252,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: Default namespaces.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.namespaces.ls"</js>
@@ -263,7 +264,7 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#defaultNamespace(String)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* The default list of namespaces associated with this serializer.
@@ -272,7 +273,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Configuration property: XMLSchema namespace.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"XmlSerializer.xsNamespace.s"</js>
@@ -284,7 +285,7 @@ public class XmlSerializer extends WriterSerializer {
* <li class='jm'>{@link XmlSerializerBuilder#xsNamespace(Namespace)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies the namespace for the <code>XMLSchema</code> namespace, used by the schema generated by the
@@ -325,7 +326,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Sq(PropertyStore ps) {
@@ -342,7 +343,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public SqReadable(PropertyStore ps) {
@@ -360,7 +361,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Ns(PropertyStore ps) {
@@ -379,7 +380,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public NsSq(PropertyStore ps) {
@@ -397,7 +398,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public NsSqReadable(PropertyStore ps) {
@@ -436,7 +437,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -446,7 +447,7 @@ public class XmlSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
[23/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java
index ae50c93..52ef3d2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java
@@ -30,7 +30,7 @@ import org.apache.juneau.transform.*;
/**
* Core class of the Juneau architecture.
- *
+ *
* <p>
* This class servers multiple purposes:
* <ul class='spaced-list'>
@@ -40,15 +40,16 @@ import org.apache.juneau.transform.*;
* Serves as a repository for metadata on POJOs, such as associated {@link BeanFilter BeanFilters},
* {@link PropertyNamer PropertyNamers}, etc... which are used to tailor how POJOs are serialized and parsed.
* </ul>
- *
+ *
* <p>
* All serializers and parsers extend from this context so that they can handle POJOs using a common framework.
- *
+ *
+ *
* <h5 class='topic'>Bean Contexts</h5>
- *
+ *
* Bean contexts are created through the {@link BeanContext#create() BeanContext.create()} and {@link BeanContextBuilder#build()} methods.
* <br>These context objects are read-only, reusable, and thread-safe.
- *
+ *
* <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.
@@ -56,39 +57,41 @@ import org.apache.juneau.transform.*;
* the same cache. This allows for efficient reuse of <code>ClassMeta</code> objects so that the information about
* classes only needs to be calculated once.
* 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>
- *
+ *
* Whereas <code>BeanContext</code> objects are permanent, unchangeable, cached, and thread-safe,
* {@link BeanSession} objects are ephemeral and not thread-safe.
* They are meant to be used as quickly-constructed scratchpads for creating bean maps.
* {@link BeanMap} objects can only be created through the session.
- *
+ *
+ *
* <h5 class='topic'>BeanContext configuration properties</h5>
- *
+ *
* <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 #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 #BEAN_beanFieldVisibility}) are used to determine what kinds of properties are
* detected on beans.
- *
+ *
* <p>
* Some settings (e.g. {@link #BEAN_beanMapPutReturnsOldValue}) change the runtime behavior of bean maps.
- *
+ *
* <p>
* Settings are specified using the {@link BeanContextBuilder#set(String, Object)} method and related convenience
* methods.
- *
+ *
* <h5 class='section'>Example:</h5>
- *
+ *
* <p class='bcode'>
* <jc>// Construct a context from scratch.</jc>
* BeanContext beanContext = BeanContext
@@ -97,12 +100,13 @@ import org.apache.juneau.transform.*;
* .notBeanClasses(Foo.<jk>class</jk>)
* .build();
* </p>
- *
+ *
+ *
* <h5 class='topic'>Bean Maps</h5>
- *
+ *
* {@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,9 +115,9 @@ import org.apache.juneau.transform.*;
* <li>{@link BeanSession#newBeanMap(Class) BeanSession.newBeanMap()} - Create a new bean instance wrapped in a
* {@code Map} wrapper.
* </ol>
- *
+ *
* <h5 class='section'>Example:</h5>
- *
+ *
* <p class='bcode'>
* <jc>// A sample bean class</jc>
* <jk>public class</jk> Person {
@@ -122,26 +126,27 @@ import org.apache.juneau.transform.*;
* <jk>public int</jk> getAge();
* <jk>public void</jk> setAge(<jk>int</jk> age);
* }
- *
+ *
* <jc>// Create a new bean session</jc>
* BeanSession session = BeanContext.<jsf>DEFAULT</jsf>.createSession();
- *
+ *
* <jc>// Wrap an existing bean in a new bean map</jc>
* BeanMap<Person> m1 = session.toBeanMap(<jk>new</jk> Person());
* m1.put(<js>"name"</js>, <js>"John Smith"</js>);
* m1.put(<js>"age"</js>, 45);
- *
+ *
* <jc>// Create a new bean instance wrapped in a new bean map</jc>
* BeanMap<Person> m2 = session.newBeanMap(Person.<jk>class</jk>);
* m2.put(<js>"name"</js>, <js>"John Smith"</js>);
* m2.put(<js>"age"</js>, 45);
* Person p = m2.getBean(); <jc>// Get the bean instance that was created.</jc>
* </p>
- *
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.ContextsBuildersSessionsPropertyStores">Overview > Contexts, Builders, Sessions, and PropertyStores</a>
- * </ul>
+ *
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.ContextsBuildersSessionsPropertyStores">Overview > Contexts, Builders, Sessions, and PropertyStores</a>
+ * </ul>
*/
@SuppressWarnings({"unchecked","rawtypes"})
public class BeanContext extends Context {
@@ -191,7 +196,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Minimum bean constructor visibility.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanConstructorVisibility.s"</js>
@@ -232,7 +237,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean dictionary.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanDictionary.lc"</js>
@@ -276,7 +281,7 @@ public class BeanContext extends Context {
* <li>Any subclass of {@link BeanDictionaryMap} containing a mapping of type names to classes without type name annotations.
* <li>Any array or collection of the objects above.
* </ul>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a parser and tell it which classes to try to resolve.</jc>
@@ -323,7 +328,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Minimum bean field visibility.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFieldVisibility.s"</js>
@@ -335,7 +340,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beanFieldVisibility(Visibility)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Only look for bean fields with the specified minimum visibility.
@@ -370,7 +375,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean filters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFilters.lc"</js>
@@ -385,13 +390,13 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beanFiltersRemove(Object...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* This is a programmatic equivalent to the {@link Bean @Bean} annotation.
* <br>It's useful when you want to use the <code>@Bean</code> annotation functionality, but you don't have the ability to alter
* the bean classes.
- *
+ *
* <p>
* Values can consist of any of the following types:
* <ul class='spaced-list'>
@@ -448,7 +453,7 @@ public class BeanContext extends Context {
/**
* Configuration property: BeanMap.put() returns old property value.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanMapPutReturnsOldValue.b"</js>
@@ -461,9 +466,9 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beanMapPutReturnsOldValue()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
- *
+ *
* <p>
* If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
* values.
@@ -495,7 +500,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Minimum bean method visibility.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanMethodVisibility.s"</js>
@@ -507,7 +512,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beanMethodVisibility(Visibility)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Only look for bean methods with the specified minimum visibility.
@@ -536,7 +541,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Beans require no-arg constructors.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireDefaultConstructor.b"</js>
@@ -549,12 +554,12 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beansRequireDefaultConstructor()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, a Java class must implement a default no-arg constructor to be considered a bean.
* <br>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>.
*
@@ -577,7 +582,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Beans require Serializable interface.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSerializable.b"</js>
@@ -590,12 +595,12 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beansRequireSerializable()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, a Java class must implement the {@link Serializable} interface to be considered a bean.
* <br>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>.
*
@@ -618,7 +623,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Beans require setters for getters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSettersForGetters.b"</js>
@@ -631,7 +636,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beansRequireSettersForGetters()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, only getters that have equivalent setters will be considered as properties on a bean.
@@ -656,7 +661,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Beans require at least one property.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSomeProperties.b"</js>
@@ -668,12 +673,12 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#beansRequireSomeProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then a Java class must contain at least 1 property to be considered a bean.
* <br>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>.
*
@@ -696,7 +701,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean type property name.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanTypePropertyName.s"</js>
@@ -731,7 +736,7 @@ public class BeanContext extends Context {
* .set(<jsf>BEAN_beanTypePropertyName</jsf>, <js>"type"</js>)
* .build();
* </p>
- *
+ *
* <h5 class='section'>Documentation:</h5>
* <ul>
* <li><a class="doclink" href="../../../overview-summary.html#juneau-marshall.BeanDictionaries">Overview > Bean Names and Dictionaries</a>
@@ -741,7 +746,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Debug mode.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.debug.b"</js>
@@ -754,7 +759,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#debug()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Enables the following additional information during serialization:
@@ -765,7 +770,7 @@ public class BeanContext extends Context {
* <li>
* Enables {@link Serializer#SERIALIZER_detectRecursions}.
* </ul>
- *
+ *
* <p>
* Enables the following additional information during parsing:
* <ul class='spaced-list'>
@@ -793,7 +798,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean property excludes.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.excludeProperties.sms"</js>
@@ -812,20 +817,20 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanFilterBuilder#excludeProperties(String...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <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 any beans whose simple class name is <code>Bean1</code>.
- *
+ *
* <p>
* Setting applies to specified class and all subclasses.
*
@@ -854,7 +859,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Ignore invocation errors on getters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnGetters.b"</js>
@@ -867,7 +872,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#ignoreInvocationExceptionsOnGetters()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored.
@@ -892,7 +897,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Ignore invocation errors on setters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnSetters.b"</js>
@@ -905,7 +910,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#ignoreInvocationExceptionsOnSetters()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored.
@@ -930,7 +935,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Ignore properties without setters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignorePropertiesWithoutSetters.b"</js>
@@ -942,7 +947,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#ignorePropertiesWithoutSetters(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, trying to set a value on a bean property without a setter will silently be ignored.
@@ -967,7 +972,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Ignore unknown properties.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownBeanProperties.b"</js>
@@ -980,7 +985,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#ignoreUnknownBeanProperties()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, trying to set a value on a non-existent bean property will silently be ignored.
@@ -1005,7 +1010,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Ignore unknown properties with null values.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownNullBeanProperties.b"</js>
@@ -1017,7 +1022,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#ignoreUnknownNullBeanProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, trying to set a <jk>null</jk> value on a non-existent bean property will silently be ignored.
@@ -1042,7 +1047,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Implementation classes.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.implClasses.smc"</js>
@@ -1055,7 +1060,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#implClass(Class, Class)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* For interfaces and abstract classes this method can be used to specify an implementation class for the
@@ -1081,7 +1086,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean property includes.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.properties.sms"</js>
@@ -1101,20 +1106,20 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanFilterBuilder#properties(String...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies the set and order of names of properties associated with the 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 only serialize the <code>foo</code> and
* <code>bar</code> properties on the specified bean.
- *
+ *
* <p>
* Setting applies to specified class and all subclasses.
*
@@ -1143,7 +1148,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Locale.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.locale.s"</js>
@@ -1182,7 +1187,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Media type.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.mediaType.s"</js>
@@ -1195,7 +1200,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanSessionArgs#mediaType(MediaType)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies a default media type value for serializer and parser sessions.
@@ -1225,7 +1230,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean class exclusions.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanClasses.sc"</js>
@@ -1244,7 +1249,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#notBeanClassesRemove(Object...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* List of classes that should not be treated as beans even if they appear to be bean-like.
@@ -1286,7 +1291,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean package exclusions.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanPackages.ss"</js>
@@ -1311,14 +1316,14 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#notBeanPackagesRemove(Object...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <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 suffix patterns to include all subpackages.
*
@@ -1359,7 +1364,7 @@ public class BeanContext extends Context {
/**
* Configuration property: POJO swaps.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.pojoSwaps.lc"</js>
@@ -1379,7 +1384,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#pojoSwapsRemove(Object...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* POJO swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization,
@@ -1473,7 +1478,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Bean property namer.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.propertyNamer.c"</js>
@@ -1523,7 +1528,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Sort bean properties.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.sortProperties.b"</js>
@@ -1542,14 +1547,14 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanFilterBuilder#sortProperties()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order.
* <br>Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
* <br>On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.
* <br>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
@@ -1574,7 +1579,7 @@ public class BeanContext extends Context {
/**
* Configuration property: TimeZone.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.timeZone.s"</js>
@@ -1587,7 +1592,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanSessionArgs#timeZone(TimeZone)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a serializer that uses GMT if the timezone is not specified in the session args.</jc>
@@ -1613,7 +1618,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Use interface proxies.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useInterfaceProxies.b"</js>
@@ -1625,7 +1630,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#useInterfaceProxies(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an
@@ -1651,7 +1656,7 @@ public class BeanContext extends Context {
/**
* Configuration property: Use Java Introspector.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useJavaBeanIntrospector.b"</js>
@@ -1664,7 +1669,7 @@ public class BeanContext extends Context {
* <li class='jm'>{@link BeanContextBuilder#useJavaBeanIntrospector()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
@@ -1776,10 +1781,10 @@ public class BeanContext extends Context {
/**
* Constructor.
- *
+ *
* <p>
* Typically only called from {@link ContextBuilder#build(Class)} method.
- *
+ *
* @param ps The property store containing the unmodifiable configuration for this bean context.
*/
public BeanContext(PropertyStore ps) {
@@ -1895,11 +1900,11 @@ 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.
- *
+ *
* @return A new session object.
*/
@Override /* Context */
@@ -1910,7 +1915,7 @@ public class BeanContext extends Context {
/**
* Create a new bean session based on the properties defined on this context combined with the specified
* runtime args.
- *
+ *
* <p>
* Use this method for creating sessions if you don't need to override any
* properties or locale/timezone currently set on this context.
@@ -1966,10 +1971,10 @@ 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.
* @return <jk>true</jk> if the bean contexts have equivalent settings and thus share caches.
*/
@@ -1980,7 +1985,7 @@ 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.
- *
+ *
* @param c The class type being tested.
* @return <jk>true</jk> if the specified class matches any of the exclusion parameters.
*/
@@ -2004,7 +2009,7 @@ public class BeanContext extends Context {
/**
* Returns <jk>true</jk> if the specified object is a bean.
- *
+ *
* @param o The object to test.
* @return <jk>true</jk> if the specified object is a bean. <jk>false</jk> if the bean is <jk>null</jk>.
*/
@@ -2030,7 +2035,7 @@ public class BeanContext extends Context {
/**
* Returns the {@link BeanMeta} class for the specified class.
- *
+ *
* @param <T> The class type to get the meta-data on.
* @param c The class to get the meta-data on.
* @return
@@ -2045,7 +2050,7 @@ public class BeanContext extends Context {
/**
* Construct a {@code ClassMeta} wrapper around a {@link Class} object.
- *
+ *
* @param <T> The class type being wrapped.
* @param type The class to resolve.
* @return
@@ -2058,7 +2063,7 @@ public class BeanContext extends Context {
/**
* Construct a {@code ClassMeta} wrapper around a {@link Class} object.
- *
+ *
* @param <T> The class type being wrapped.
* @param type The class to resolve.
* @param waitForInit
@@ -2097,16 +2102,16 @@ 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.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <ul>
* <li><code>getClassMeta(String.<jk>class</jk>);</code> - A normal type.
@@ -2122,7 +2127,7 @@ public class BeanContext extends Context {
* <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);</code> -
* A map containing string keys and values of lists containing beans.
* </ul>
- *
+ *
* @param type
* The class to resolve.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
@@ -2313,7 +2318,7 @@ public class BeanContext extends Context {
/**
* Shortcut for calling {@code getClassMeta(o.getClass())}.
- *
+ *
* @param <T> The class of the object being passed in.
* @param o The class to find the class type for.
* @return The ClassMeta object, or <jk>null</jk> if {@code o} is <jk>null</jk>.
@@ -2327,7 +2332,7 @@ public class BeanContext extends Context {
/**
* Used for determining the class type on a method or field where a {@code @BeanProperty} annotation may be present.
- *
+ *
* @param <T> The class type we're wrapping.
* @param p The property annotation on the type if there is one.
* @param t The type.
@@ -2386,7 +2391,7 @@ 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.
- *
+ *
* @param <T> The class associated with the swap.
* @param c The class associated with the swap.
* @return The swap associated with the class, or null if there is no association.
@@ -2405,7 +2410,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.
*/
@@ -2426,7 +2431,7 @@ 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.
- *
+ *
* @param <T> The class associated with the bean filter.
* @param c The class associated with the bean filter.
* @return The bean filter associated with the class, or null if there is no association.
@@ -2441,7 +2446,7 @@ public class BeanContext extends Context {
/**
* Returns the type property name as defined by {@link #BEAN_beanTypePropertyName}.
- *
+ *
* @return The type property name. Never <jk>null</jk>.
*/
protected final String getBeanTypePropertyName() {
@@ -2450,7 +2455,7 @@ public class BeanContext extends Context {
/**
* Returns the bean registry defined in this bean context defined by {@link #BEAN_beanDictionary}.
- *
+ *
* @return The bean registry defined in this bean context. Never <jk>null</jk>.
*/
protected final BeanRegistry getBeanRegistry() {
@@ -2459,7 +2464,7 @@ public class BeanContext extends Context {
/**
* Gets the no-arg constructor for the specified class.
- *
+ *
* @param <T> The class to check.
* @param c The class to check.
* @param v The minimum visibility for the constructor.
@@ -2503,7 +2508,7 @@ public class BeanContext extends Context {
/**
* Returns the {@link #BEAN_includeProperties} setting for the specified class.
- *
+ *
* @param c The class.
* @return The properties to include for the specified class, or <jk>null</jk> if it's not defined for the class.
*/
@@ -2525,7 +2530,7 @@ public class BeanContext extends Context {
/**
* Returns the {@link #BEAN_excludeProperties} setting for the specified class.
- *
+ *
* @param c The class.
* @return The properties to exclude for the specified class, or <jk>null</jk> if it's not defined for the class.
*/
@@ -2547,7 +2552,7 @@ public class BeanContext extends Context {
/**
* Creates an instance of the specified class.
- *
+ *
* @param c
* The class to cast to.
* @param c2
@@ -2564,7 +2569,7 @@ public class BeanContext extends Context {
/**
* Creates an instance of the specified class.
- *
+ *
* @param c
* The class to cast to.
* @param c2
@@ -2613,14 +2618,14 @@ 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.
- *
+ *
* <p>
* 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.
*/
protected final ClassMeta<Object> object() {
@@ -2629,14 +2634,14 @@ 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.
- *
+ *
* @return The {@link ClassMeta} object associated with the <code>String</code> class.
*/
protected final ClassMeta<String> string() {
@@ -2645,14 +2650,14 @@ 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.
- *
+ *
* @return The {@link ClassMeta} object associated with the <code>String</code> class.
*/
protected final ClassMeta<Class> _class() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContextBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContextBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContextBuilder.java
index bf815bf..d5f54ed 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContextBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContextBuilder.java
@@ -53,10 +53,11 @@ import org.apache.juneau.transform.*;
* .build(); <jc>// Create a JsonSerializer</jc>
* </p>
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.ConfigurableProperties">Overview > Configurable Properties</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.ConfigurableProperties">Overview > Configurable Properties</a>
+ * </ul>
*/
public class BeanContextBuilder extends ContextBuilder {
@@ -71,7 +72,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public BeanContextBuilder(PropertyStore ps) {
@@ -89,14 +90,14 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Minimum bean class visibility.
- *
+ *
* <p>
* Classes are not considered beans unless they meet the minimum visibility requirements.
*
* <p>
* 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 and will be treated as a string.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanClassVisibility}
@@ -113,10 +114,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Minimum bean constructor visibility.
- *
+ *
* <p>
* Only look for constructors with the specified minimum visibility.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanConstructorVisibility}
@@ -133,7 +134,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean dictionary.
- *
+ *
* <p>
* Adds to the list of classes that make up the bean dictionary in this bean context.
*
@@ -152,10 +153,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean dictionary.
- *
+ *
* <p>
* Same as {@link #beanDictionary(Object...)} but takes in an array of classes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanDictionary}
@@ -195,7 +196,7 @@ public class BeanContextBuilder extends ContextBuilder {
*
* <p>
* Removes from the list of classes that make up the bean dictionary in this bean context.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanDictionary}
@@ -211,7 +212,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Minimum bean field visibility.
- *
+ *
* <p>
* Only look for bean fields with the specified minimum visibility.
*
@@ -231,12 +232,12 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean filters.
- *
+ *
* <p>
* This is a programmatic equivalent to the {@link Bean @Bean} annotation.
* <br>It's useful when you want to use the Bean annotation functionality, but you don't have the ability to alter
* the bean classes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanFilters}
@@ -262,7 +263,7 @@ public class BeanContextBuilder extends ContextBuilder {
*
* <p>
* Same as {@link #beanFilters(Object...)} but takes in an array of classes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanFilters}
@@ -281,7 +282,7 @@ public class BeanContextBuilder extends ContextBuilder {
*
* <p>
* Same as {@link #beanFilters(Object...)} but allows you to optionally overwrite the previous value.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanFilters}
@@ -306,10 +307,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean filters.
- *
+ *
* <p>
* Removes from the list of classes that make up the bean filters in this bean context.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanFilters}
@@ -332,12 +333,12 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: BeanMap.put() returns old property value.
- *
+ *
* <p>
* If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
* values.
* <br>Otherwise, it returns <jk>null</jk>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanMapPutReturnsOldValue}
@@ -354,10 +355,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: BeanMap.put() returns old property value.
- *
+ *
* <p>
* Shortcut for calling <code>beanMapPutReturnsOldValue(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanMapPutReturnsOldValue}
@@ -371,7 +372,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Minimum bean method visibility.
- *
+ *
* <p>
* Only look for bean methods with the specified minimum visibility.
*
@@ -391,11 +392,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require no-arg constructors.
- *
+ *
* <p>
* If <jk>true</jk>, a Java class must implement a default no-arg constructor to be considered a bean.
* <br>Otherwise, the bean will be serialized as a string using the {@link Object#toString()} method.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireDefaultConstructor}
@@ -412,10 +413,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require no-arg constructors.
- *
+ *
* <p>
* Shortcut for calling <code>beansRequireDefaultConstructor(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireDefaultConstructor}
@@ -429,11 +430,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require Serializable interface.
- *
+ *
* <p>
* If <jk>true</jk>, a Java class must implement the {@link Serializable} interface to be considered a bean.
* <br>Otherwise, the bean will be serialized as a string using the {@link Object#toString()} method.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireSerializable}
@@ -450,10 +451,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require Serializable interface.
- *
+ *
* <p>
* Shortcut for calling <code>beansRequireSerializable(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireSerializable}
@@ -467,11 +468,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require setters for getters.
- *
+ *
* <p>
* If <jk>true</jk>, only getters that have equivalent setters will be considered as properties on a bean.
* <br>Otherwise, they will be ignored.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireSettersForGetters}
@@ -488,10 +489,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require setters for getters.
- *
+ *
* <p>
* Shortcut for calling <code>beansRequireSettersForGetters(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireSettersForGetters}
@@ -505,11 +506,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Beans require at least one property.
- *
+ *
* <p>
* If <jk>true</jk>, then a Java class must contain at least 1 property to be considered a bean.
* <br>Otherwise, the bean will be serialized as a string using the {@link Object#toString()} method.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beansRequireSomeProperties}
@@ -526,7 +527,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean type property name.
- *
+ *
* <p>
* This specifies the name of the bean property used to store the dictionary name of a bean type so that the
* parser knows the data type to reconstruct.
@@ -547,7 +548,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Debug mode.
- *
+ *
* <p>
* Enables the following additional information during serialization:
* <ul class='spaced-list'>
@@ -557,7 +558,7 @@ public class BeanContextBuilder extends ContextBuilder {
* <li>
* Enables {@link Serializer#SERIALIZER_detectRecursions}.
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_debug}
@@ -574,10 +575,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Debug mode.
- *
+ *
* <p>
* Shortcut for calling <code>debug(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_debug}
@@ -591,7 +592,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property excludes.
- *
+ *
* <p>
* Specifies to exclude the specified list of properties for the specified bean class.
*
@@ -610,10 +611,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property excludes.
- *
+ *
* <p>
* Specifies to exclude the specified list of properties for the specified bean classes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_excludeProperties}
@@ -629,7 +630,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property excludes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_excludeProperties}
@@ -647,11 +648,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore invocation errors on getters.
- *
+ *
* <p>
* If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreInvocationExceptionsOnGetters}
@@ -668,10 +669,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore invocation errors on getters.
- *
+ *
* <p>
* Shortcut for calling <code>ignoreInvocationExceptionsOnGetters(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreInvocationExceptionsOnGetters}
@@ -685,11 +686,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore invocation errors on setters.
- *
+ *
* <p>
* If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored.
* <br>Otherwise, a {@code BeanRuntimeException} is thrown.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreInvocationExceptionsOnSetters}
@@ -706,10 +707,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore invocation errors on setters.
- *
+ *
* <p>
* Shortcut for calling <code>ignoreInvocationExceptionsOnSetters(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreInvocationExceptionsOnSetters}
@@ -723,11 +724,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore properties without setters.
- *
+ *
* <p>
* If <jk>true</jk>, trying to set a value on a bean property without a setter will silently be ignored.
* <br>Otherwise, a {@code BeanRuntimeException} is thrown.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignorePropertiesWithoutSetters}
@@ -744,11 +745,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore unknown properties.
- *
+ *
* <p>
* If <jk>true</jk>, trying to set a value on a non-existent bean property will silently be ignored.
* <br>Otherwise, a {@code BeanRuntimeException} is thrown.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreUnknownBeanProperties}
@@ -765,10 +766,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore unknown properties.
- *
+ *
* <p>
* Shortcut for calling <code>ignoreUnknownBeanProperties(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreUnknownBeanProperties}
@@ -782,11 +783,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Ignore unknown properties with null values.
- *
+ *
* <p>
* If <jk>true</jk>, trying to set a <jk>null</jk> value on a non-existent bean property will silently be ignored.
* <br>Otherwise, a {@code BeanRuntimeException} is thrown.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_ignoreUnknownNullBeanProperties}
@@ -803,7 +804,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Implementation classes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_implClasses}
@@ -820,12 +821,12 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Implementation classes.
- *
+ *
* <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).
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_implClasses}
@@ -840,7 +841,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property includes.
- *
+ *
* <p>
* Specifies the set and order of names of properties associated with the bean class.
*
@@ -859,10 +860,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property includes.
- *
+ *
* <p>
* Specifies the set and order of names of properties associated with the bean class.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_includeProperties}
@@ -877,7 +878,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property includes.
- *
+ *
* <p>
* Specifies the set and order of names of properties associated with the bean class.
*
@@ -898,10 +899,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Locale.
- *
+ *
* <p>
* Specifies a default locale for serializer and parser sessions.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_locale}
@@ -916,10 +917,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Media type.
- *
+ *
* <p>
* Specifies a default media type value for serializer and parser sessions.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_mediaType}
@@ -934,11 +935,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean class exclusions.
- *
+ *
* <p>
* Not-bean classes are converted to <code>Strings</code> during serialization even if they appear to be
* bean-like.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanClasses}
@@ -985,7 +986,7 @@ public class BeanContextBuilder extends ContextBuilder {
* <p>
* List of classes that should not be treated as beans even if they appear to be bean-like.
* <br>Not-bean classes are converted to <code>Strings</code> during serialization.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanClasses}
@@ -1006,7 +1007,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean class exclusions.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanClasses}
@@ -1027,10 +1028,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean package exclusions.
- *
+ *
* <p>
* When specified, the current list of ignore packages are appended to.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
@@ -1054,7 +1055,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean package exclusions.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
@@ -1075,7 +1076,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean package exclusions.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
@@ -1091,7 +1092,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean package exclusions.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_notBeanPackages}
@@ -1112,14 +1113,14 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: POJO swaps.
- *
+ *
* <p>
* POJO swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization,
* and "swap in" the non-serializable class during parsing.
*
* <p>
* An example of a POJO swap would be a <code>Calendar</code> object that gets swapped out for an ISO8601 string.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
@@ -1143,7 +1144,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: POJO swaps.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
@@ -1158,7 +1159,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: POJO swaps.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
@@ -1180,7 +1181,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: POJO swaps.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
@@ -1202,7 +1203,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Bean property namer
- *
+ *
* <p>
* The class to use for calculating bean property names.
*
@@ -1222,11 +1223,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Sort bean properties.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_sortProperties}
@@ -1243,10 +1244,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Sort bean properties.
- *
+ *
* <p>
* Shortcut for calling <code>sortProperties(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_sortProperties}
@@ -1260,7 +1261,7 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: TimeZone.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_timeZone}
@@ -1275,11 +1276,11 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Use interface proxies.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_useInterfaceProxies}
@@ -1296,15 +1297,15 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Use Java Introspector.
- *
+ *
* <p>
* Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
- *
+ *
* <h5 class 'section'>Notes:</h5>
* <ul>
* <li>Most {@link Bean @Bean} annotations will be ignored if you enable this setting.
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_useJavaBeanIntrospector}
@@ -1321,10 +1322,10 @@ public class BeanContextBuilder extends ContextBuilder {
/**
* Configuration property: Use Java Introspector.
- *
+ *
* <p>
* Shortcut for calling <code>useJavaBeanIntrospector(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_useJavaBeanIntrospector}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryList.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryList.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryList.java
index b1b771a..997e043 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryList.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryList.java
@@ -18,7 +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>
@@ -44,7 +44,7 @@ import org.apache.juneau.annotation.*;
* .beanDictionary(MyBeanDictionaryList.<jk>class</jk>)
* .build();
* </p>
- *
+ *
* <p>
* Subclasses must implement a public no-arg constructor so that it can be instantiated by the bean context code.
*/
@@ -53,7 +53,7 @@ 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() @Bean.typeName()} value or be another subclass of
@@ -65,7 +65,7 @@ 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() @Bean.typeName()} value or be another subclass of
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryMap.java
index 573438d..2cb7294 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanDictionaryMap.java
@@ -19,11 +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() @Bean.typeName()} annotation.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// A bean dictionary map consisting of classes without @Bean.typeName() annotations</jc>
@@ -67,7 +67,7 @@ public class BeanDictionaryMap extends LinkedHashMap<String,Object> {
/**
* Add a dictionary name mapping for the specified class.
- *
+ *
* @param typeName The dictionary name of the class.
* @param c The class represented by the dictionary name.
* @return This object (for method chaining).
@@ -79,7 +79,7 @@ public class BeanDictionaryMap extends LinkedHashMap<String,Object> {
/**
* Add a dictionary name mapping for the specified map class with the specified key and value classes.
- *
+ *
* @param typeName The dictionary name of the class.
* @param mapClass The map implementation class.
* @param keyClass The key class.
@@ -95,7 +95,7 @@ public class BeanDictionaryMap extends LinkedHashMap<String,Object> {
/**
* Add a dictionary name mapping for the specified collection class with the specified entry class.
- *
+ *
* @param typeName The dictionary name of the class.
* @param collectionClass The collection implementation class.
* @param entryClass The entry class.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMap.java
index 9d61ce6..611f6e8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMap.java
@@ -25,17 +25,18 @@ import org.apache.juneau.xml.annotation.*;
/**
* Java bean wrapper class.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* 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.
- *
+ *
* <h6 class='topic'>Bean property order</h6>
- *
+ *
* 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'>
@@ -46,16 +47,16 @@ import org.apache.juneau.xml.annotation.*;
* 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>
- *
+ *
* <p>
* <br>The order can also be overridden through the use of a {@link BeanFilter}.
- *
+ *
* <h6 class='topic'>POJO swaps</h6>
- *
+ *
* If {@link PojoSwap PojoSwaps} are defined on the class types of the properties of this bean or the bean properties
* themselves, the {@link #get(Object)} and {@link #put(String, Object)} methods will automatically transform the
* property value to and from the serialized form.
- *
+ *
* @param <T> Specifies the type of object that this map encapsulates.
*/
public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T> {
@@ -77,7 +78,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Instance of this class are instantiated through the BeanContext class.
- *
+ *
* @param session The bean session object that created this bean map.
* @param bean The bean to wrap inside this map.
* @param meta The metadata associated with the bean class.
@@ -93,7 +94,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the metadata associated with this bean map.
- *
+ *
* @return The metadata associated with this bean map.
*/
public BeanMeta<T> getMeta() {
@@ -102,7 +103,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the bean session that created this bean map.
- *
+ *
* @return The bean session that created this bean map.
*/
public final BeanSession getBeanSession() {
@@ -111,11 +112,11 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the wrapped bean object.
- *
+ *
* <p>
* Triggers bean creation if bean has read-only properties set through a constructor defined by the
* {@link BeanConstructor @BeanConstructor} annotation.
- *
+ *
* @return The inner bean object.
*/
public T getBean() {
@@ -140,15 +141,15 @@ 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 @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.
- *
+ *
* @param create If bean hasn't been instantiated yet, then instantiate it.
* @return The inner bean object.
*/
@@ -176,7 +177,7 @@ 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.
@@ -184,22 +185,22 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
* {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
* {@link Swap#value() @Swap.value()} 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'>
* <jc>// Construct a bean with a 'birthDate' Date field</jc>
* Person p = <jk>new</jk> Person();
- *
+ *
* <jc>// Create a bean context and add the ISO8601 date-time swap</jc>
* BeanContext beanContext = <jk>new</jk> BeanContext().pojoSwaps(DateSwap.ISO8601DT.<jk>class</jk>);
- *
+ *
* <jc>// Wrap our bean in a bean map</jc>
* BeanMap<Person> b = beanContext.forBean(p);
- *
+ *
* <jc>// Set the field</jc>
* myBeanMap.put(<js>"birthDate"</js>, <js>"'1901-03-03T04:05:06-5000'"</js>);
* </p>
- *
+ *
* @param property The name of the property to set.
* @param value The value to set the property to.
* @return
@@ -233,11 +234,11 @@ 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.
- *
+ *
* @param property Property name or child-element name (if {@link Xml#childName() @Xml.childName()} is specified).
* @param value The value to add to the collection or array.
*/
@@ -254,7 +255,7 @@ 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.
@@ -262,23 +263,23 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
* {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
* {@link Swap#value() @Swap.value()} annotation, this method will return a String containing an
* ISO8601 date-time string value.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct a bean with a 'birthDate' Date field</jc>
* Person p = <jk>new</jk> Person();
* p.setBirthDate(<jk>new</jk> Date(1, 2, 3, 4, 5, 6));
- *
+ *
* <jc>// Create a bean context and add the ISO8601 date-time swap</jc>
* BeanContext beanContext = <jk>new</jk> BeanContext().pojoSwaps(DateSwap.ISO8601DT.<jk>class</jk>);
- *
+ *
* <jc>// Wrap our bean in a bean map</jc>
* BeanMap<Person> b = beanContext.forBean(p);
- *
+ *
* <jc>// Get the field as a string (i.e. "'1901-03-03T04:05:06-5000'")</jc>
* String s = myBeanMap.get(<js>"birthDate"</js>);
* </p>
- *
+ *
* @param property The name of the property to get.
* @throws
* RuntimeException if any of the following occur.
@@ -302,7 +303,7 @@ 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.
- *
+ *
* @param property The name of the property to get.
* @return The raw property value.
*/
@@ -316,12 +317,12 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Convenience method for setting multiple property values by passing in JSON text.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* aPersonBean.load(<js>"{name:'John Smith',age:21}"</js>)
* </p>
- *
+ *
* @param input The text that will get parsed into a map and then added to this map.
* @return This object (for method chaining).
* @throws ParseException If the input contains a syntax error or is malformed.
@@ -333,7 +334,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Convenience method for setting multiple property values by passing in a reader.
- *
+ *
* @param r The text that will get parsed into a map and then added to this map.
* @param p The parser to use to parse the text.
* @return This object (for method chaining).
@@ -347,10 +348,10 @@ 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.
- *
+ *
* @param entries The map containing the entries to add to this map.
* @return This object (for method chaining).
*/
@@ -362,7 +363,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.
*/
@@ -384,14 +385,14 @@ 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.
- *
+ *
* <p>
* 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.
*/
@@ -404,7 +405,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the metadata on the specified property.
- *
+ *
* @param propertyName The name of the bean property.
* @return Metadata on the specified property, or <jk>null</jk> if that property does not exist.
*/
@@ -417,7 +418,7 @@ public class BeanMap<T> extends AbstractMap<String,Object> implements Delegate<T
/**
* Returns the {@link ClassMeta} of the wrapped bean.
- *
+ *
* @return The class type of the wrapped bean.
*/
@Override /* Delegate */
@@ -427,10 +428,10 @@ 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.
* @param prependVals
@@ -473,7 +474,7 @@ 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.
- *
+ *
* @param s The string containing variables.
* @return A new string with variables replaced, or the same string if no variables were found.
*/
@@ -483,7 +484,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() {
@@ -492,7 +493,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/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMapEntry.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMapEntry.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMapEntry.java
index a5a77d2..a72536d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMapEntry.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMapEntry.java
@@ -19,24 +19,24 @@ 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct a new bean</jc>
* Person p = <jk>new</jk> Person();
- *
+ *
* <jc>// Wrap it in a bean map</jc>
* BeanMap<Person> b = BeanContext.<jsf>DEFAULT</jsf>.forBean(p);
- *
+ *
* <jc>// Get a reference to the birthDate property</jc>
* BeanMapEntry birthDate = b.getProperty(<js>"birthDate"</js>);
- *
+ *
* <jc>// Set the property value</jc>
* birthDate.setValue(<jk>new</jk> Date(1, 2, 3, 4, 5, 6));
- *
+ *
* <jc>// Or if the DateSwap.DEFAULT_ISO8601DT is registered with the bean context, set a transformed value</jc>
* birthDate.setValue(<js>"'1901-03-03T04:05:06-5000'"</js>);
* </p>
@@ -48,7 +48,7 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
/**
* Constructor.
- *
+ *
* @param beanMap The bean map that this entry belongs to.
* @param property The bean property.
* @param pName The bean property name.
@@ -66,7 +66,7 @@ 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.
@@ -82,14 +82,14 @@ 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.
@@ -97,7 +97,7 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
* {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
* {@link Swap#value() @Swap.value()} 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.
*/
@Override /* Map.Entry */
@@ -107,7 +107,7 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
/**
* Returns the bean map that contains this property.
- *
+ *
* @return The bean map that contains this property.
*/
public BeanMap<?> getBeanMap() {
@@ -116,7 +116,7 @@ public class BeanMapEntry implements Map.Entry<String,Object> {
/**
* Returns the metadata about this bean property.
- *
+ *
* @return Metadata about this bean property.
*/
public BeanPropertyMeta getMeta() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMeta.java
index 157f7b4..c9d86b9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMeta.java
@@ -28,16 +28,17 @@ import org.apache.juneau.utils.*;
/**
* Encapsulates all access to the properties of a bean class (like a souped-up {@link java.beans.BeanInfo}).
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Uses introspection to find all the properties associated with this class. If the {@link Bean @Bean} annotation
* is present on the class, or the class has a {@link BeanFilter} registered with it in the bean context,
* then that information is used to determine the properties on the class.
* Otherwise, the {@code BeanInfo} functionality in Java is used to determine the properties on the class.
- *
+ *
* <h6 class='topic'>Bean property ordering</h6>
- *
+ *
* The order of the properties are as follows:
* <ul class='spaced-list'>
* <li>
@@ -51,10 +52,10 @@ import org.apache.juneau.utils.*;
* <li>Non-standard getters/setters with {@link BeanProperty @BeanProperty} annotation defined on them.
* </ul>
* </ul>
- *
+ *
* <p>
* The order can also be overridden through the use of an {@link BeanFilter}.
- *
+ *
* @param <T> The class type that this metadata applies to.
*/
public class BeanMeta<T> {
@@ -102,7 +103,7 @@ public class BeanMeta<T> {
/**
* Constructor.
- *
+ *
* @param classMeta The target class.
* @param ctx The bean context that created this object.
* @param beanFilter Optional bean filter associated with the target class. Can be <jk>null</jk>.
@@ -456,7 +457,7 @@ public class BeanMeta<T> {
/**
* Returns the {@link ClassMeta} of this bean.
- *
+ *
* @return The {@link ClassMeta} of this bean.
*/
@BeanIgnore
@@ -466,7 +467,7 @@ public class BeanMeta<T> {
/**
* Returns the dictionary name for this bean as defined through the {@link Bean#typeName() @Bean.typeName()} annotation.
- *
+ *
* @return The dictionary name for this bean, or <jk>null</jk> if it has no dictionary name defined.
*/
public final String getDictionaryName() {
@@ -476,7 +477,7 @@ public class BeanMeta<T> {
/**
* 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.
*/
public final BeanPropertyMeta getTypeProperty() {
@@ -546,7 +547,7 @@ public class BeanMeta<T> {
/*
* Find all the bean methods on this class.
- *
+ *
* @param c The transformed class.
* @param stopClass Don't look above this class in the hierarchy.
* @param v The minimum method visibility.
@@ -652,7 +653,7 @@ public class BeanMeta<T> {
/**
* Returns the metadata on all properties associated with this bean.
- *
+ *
* @return Metadata on all properties associated with this bean.
*/
public Collection<BeanPropertyMeta> getPropertyMetas() {
@@ -661,7 +662,7 @@ public class BeanMeta<T> {
/**
* Returns the metadata on the specified list of properties.
- *
+ *
* @param pNames The list of properties to retrieve. If <jk>null</jk>, returns all properties.
* @return The metadata on the specified list of properties.
*/
@@ -676,7 +677,7 @@ public class BeanMeta<T> {
/**
* Returns the language-specified extended metadata on this bean class.
- *
+ *
* @param metaDataClass The name of the metadata class to create.
* @return Extended metadata on this bean class. Never <jk>null</jk>.
*/
@@ -686,7 +687,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.
*/
@@ -699,7 +700,7 @@ public class BeanMeta<T> {
/**
* Creates a new instance of this bean.
- *
+ *
* @param outer The outer object if bean class is a non-static inner member class.
* @return A new instance of this bean if possible, or <jk>null</jk> if not.
* @throws IllegalArgumentException Thrown by constructor.
@@ -727,7 +728,7 @@ 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.
- *
+ *
* <p>
* For example, given the following classes...
* <p class='bcode'>
@@ -742,18 +743,18 @@ public class BeanMeta<T> {
* <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!
- *
+ *
* @param t The type we're recursing.
* @param m Where the results are loaded.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaExtended.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaExtended.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaExtended.java
index f4c2eab..b06acbc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaExtended.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaExtended.java
@@ -14,7 +14,7 @@ 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.
@@ -25,7 +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.
*/
@@ -35,7 +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/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaFiltered.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaFiltered.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaFiltered.java
index 583e098..2673529 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaFiltered.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanMetaFiltered.java
@@ -18,14 +18,14 @@ import org.apache.juneau.annotation.*;
/**
* Same as {@link BeanMeta}, except the list of bean properties are limited by a {@link BeanProperty#properties() @BeanProperty.properties()} annotation.
- *
+ *
* @param <T> The class type that this metadata applies to.
*/
public final class BeanMetaFiltered<T> extends BeanMeta<T> {
/**
* Wrapper constructor.
- *
+ *
* @param innerMeta The untransformed bean meta of the bean property.
* @param pNames The list of transformed property names.
*/
@@ -35,7 +35,7 @@ public final class BeanMetaFiltered<T> extends BeanMeta<T> {
/**
* Wrapper constructor.
- *
+ *
* @param innerMeta The untransformed bean meta of the bean property.
* @param pNames The list of transformed property names.
*/
[16/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java
index 1af9076..cab2b9c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java
@@ -19,11 +19,11 @@ import org.apache.juneau.*;
/**
* Represents a wrapped {@link BeanMap} where property values can be overridden, removed, or reordered without
* affecting the underlying bean.
- *
+ *
* <p>
* Provides the {@link #filterKeys(List)} method for specifying the keys to keep in the bean map and in what order
* they should appear.
- *
+ *
* @param <T> The class type of the wrapped bean.
*/
public class DelegateBeanMap<T> extends BeanMap<T> {
@@ -33,7 +33,7 @@ public class DelegateBeanMap<T> extends BeanMap<T> {
/**
* Constructor.
- *
+ *
* @param bean The bean being wrapped.
* @param session The bean session that created this bean map.
*/
@@ -45,7 +45,7 @@ public class DelegateBeanMap<T> extends BeanMap<T> {
/**
* Add a key in the next position.
- *
+ *
* @param key The key to add.
*/
public void addKey(String key) {
@@ -73,10 +73,10 @@ public class DelegateBeanMap<T> extends BeanMap<T> {
/**
* Remove all but the specified properties from this bean map.
- *
+ *
* <p>
* This does not affect the underlying bean.
- *
+ *
* @param keys The remaining keys in the bean map (in the specified order).
*/
public void filterKeys(List<String> keys) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateList.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateList.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateList.java
index e04da5f..03603bb 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateList.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateList.java
@@ -19,7 +19,7 @@ import org.apache.juneau.*;
/**
* Represents a wrapped {@link Collection} where entries in the list can be removed or reordered without affecting the
* underlying list.
- *
+ *
* @param <T> The class type of the wrapped bean.
*/
public class DelegateList<T extends Collection<?>> extends ObjectList implements Delegate<T> {
@@ -29,7 +29,7 @@ public class DelegateList<T extends Collection<?>> extends ObjectList implements
/**
* Constructor.
- *
+ *
* @param classMeta The data type represented by this delegate.
*/
public DelegateList(ClassMeta<T> classMeta) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateMap.java
index 83d7440..41abc97 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DelegateMap.java
@@ -18,7 +18,7 @@ import org.apache.juneau.*;
/**
* Represents a wrapped {@link Map} where entries in the map can be removed without affecting the underlying map.
- *
+ *
* @param <T> The class type of the wrapped bean.
*/
public class DelegateMap<T> extends ObjectMap implements Delegate<T> {
@@ -28,7 +28,7 @@ public class DelegateMap<T> extends ObjectMap implements Delegate<T> {
/**
* Constructor.
- *
+ *
* @param classMeta The metadata object that created this delegate object.
*/
public DelegateMap(ClassMeta<T> classMeta) {
@@ -42,10 +42,10 @@ public class DelegateMap<T> extends ObjectMap implements Delegate<T> {
/**
* Remove all but the specified keys from this map.
- *
+ *
* <p>
* This does not affect the underlying map.
- *
+ *
* @param keys The remaining keys in the map (in the specified order).
*/
public void filterKeys(List<String> keys) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FileUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FileUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FileUtils.java
index c18fd02..630deb7 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FileUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FileUtils.java
@@ -25,7 +25,7 @@ public class FileUtils {
/**
* Same as {@link File#mkdirs()} except throws a RuntimeExeption if directory could not be created.
- *
+ *
* @param f The directory to create. Must not be <jk>null</jk>.
* @param clean If <jk>true</jk>, deletes the contents of the directory if it already exists.
* @return The same file.
@@ -48,7 +48,7 @@ public class FileUtils {
/**
* Same as {@link #mkdirs(String, boolean)} but uses String path.
- *
+ *
* @param path The path of the directory to create. Must not be <jk>null</jk>
* @param clean If <jk>true</jk>, deletes the contents of the directory if it already exists.
* @return The directory.
@@ -60,7 +60,7 @@ public class FileUtils {
/**
* Recursively deletes a file or directory.
- *
+ *
* @param f The file or directory to delete.
* @return <jk>true</jk> if file or directory was successfully deleted.
*/
@@ -78,10 +78,10 @@ public class FileUtils {
/**
* Creates a file if it doesn't already exist using {@link File#createNewFile()}.
- *
+ *
* <p>
* Throws a {@link RuntimeException} if the file could not be created.
- *
+ *
* @param f The file to create.
*/
public static void create(File f) {
@@ -97,10 +97,10 @@ public class FileUtils {
/**
* Updates the modified timestamp on the specified file.
- *
+ *
* <p>
* Method ensures that the timestamp changes even if it's been modified within the past millisecond.
- *
+ *
* @param f The file to modify the modified timestamp on.
*/
public static void modifyTimestamp(File f) {
@@ -121,14 +121,14 @@ public class FileUtils {
/**
* Create a temporary file with the specified name.
- *
+ *
* <p>
* The name is broken into file name and suffix, and the parts are passed to
* {@link File#createTempFile(String, String)}.
- *
+ *
* <p>
* {@link File#deleteOnExit()} is called on the resulting file before being returned by this method.
- *
+ *
* @param name The file name
* @return A newly-created temporary file.
* @throws IOException
@@ -142,7 +142,7 @@ public class FileUtils {
/**
* Strips the extension from a file name.
- *
+ *
* @param name The file name.
* @return The file name without the extension, or <jk>null</jk> if name was <jk>null</jk>.
*/
@@ -157,7 +157,7 @@ public class FileUtils {
/**
* Returns the extension from a file name.
- *
+ *
* @param name The file name.
* @return The the extension, or <jk>null</jk> if name was <jk>null</jk>.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FilteredMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FilteredMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FilteredMap.java
index 516e698..e2414d4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FilteredMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FilteredMap.java
@@ -20,7 +20,7 @@ import org.apache.juneau.*;
/**
* Wrapper around a map where the key names are overridden.
- *
+ *
* @param <K> The key class type.
* @param <V> The value class type.
*/
@@ -32,7 +32,7 @@ public final class FilteredMap<K,V> extends AbstractMap<K,V> implements Delegate
/**
* Constructor.
- *
+ *
* @param classMeta The class type of the map being wrapped.
* @param innerMap The map being wrapped. Must not be <jk>null</jk>.
* @param keys The keys in the new map. Must not be <jk>null</jk>.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/HashCode.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/HashCode.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/HashCode.java
index 8e76000..8bb15be 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/HashCode.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/HashCode.java
@@ -14,7 +14,7 @@ package org.apache.juneau.internal;
/**
* Utility class for generating integer hash codes.
- *
+ *
* <p>
* General usage:
* <p class='bcode'>
@@ -27,7 +27,7 @@ public class HashCode {
/**
* Create a new HashCode object.
- *
+ *
* @return A new HashCode object.
*/
public static final HashCode create() {
@@ -36,7 +36,7 @@ public class HashCode {
/**
* Hashes the hashcode of the specified object into this object.
- *
+ *
* @param o The object whose hashcode will be hashed with this object.
* @return This object (for method chaining).
*/
@@ -48,10 +48,10 @@ public class HashCode {
/**
* Hashes the hashcode into this object.
- *
+ *
* <p>
* The formula is simply <code>hashCode = 31*hashCode + i;</code>
- *
+ *
* @param i The hashcode to hash into this object's hashcode.
* @return This object (for method chaining).
*/
@@ -62,7 +62,7 @@ public class HashCode {
/**
* Return the calculated hashcode value.
- *
+ *
* @return The calculated hashcode.
*/
public int get() {
@@ -71,14 +71,14 @@ public class HashCode {
/**
* Converts the object to a normalized form before grabbing it's hashcode.
- *
+ *
* <p>
* Subclasses can override this method to provide specialized handling (e.g. converting numbers to strings so that
* <code>123</code> and <js>"123"</js> end up creating the same hashcode.)
- *
+ *
* <p>
* Default implementation does nothing.
- *
+ *
* @param o The object to normalize before getting it's hashcode.
* @return The normalized object.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/IOUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/IOUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/IOUtils.java
index a17ae60..606d7f8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/IOUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/IOUtils.java
@@ -30,7 +30,7 @@ public final class IOUtils {
/**
* Reads the contents of a file into a string.
- *
+ *
* @param path The path of the file to read using default character encoding.
* @return The contents of the reader as a string, or <jk>null</jk> if file does not exist.
* @throws IOException If a problem occurred trying to read from the reader.
@@ -41,7 +41,7 @@ public final class IOUtils {
/**
* Reads the contents of a file into a string.
- *
+ *
* @param in The file to read using default character encoding.
* @return The contents of the reader as a string, or <jk>null</jk> if file does not exist.
* @throws IOException If a problem occurred trying to read from the reader.
@@ -56,7 +56,7 @@ public final class IOUtils {
/**
* Reads the specified object to a <code>String</code>.
- *
+ *
* <p>
* Can be any of the following object types:
* <ul>
@@ -66,7 +66,7 @@ public final class IOUtils {
* <li>{@link InputStream}
* <li><code><jk>byte</jk>[]</code>
* </ul>
- *
+ *
* @param o The object to read.
* @return The object serialized to a string, or <jk>null</jk> if it wasn't a supported type.
* @throws IOException
@@ -87,7 +87,7 @@ public final class IOUtils {
/**
* Writes the contents of the specified <code>Reader</code> to the specified file.
- *
+ *
* @param out The file to write the output to.
* @param in The reader to pipe from.
* @return The number of characters written to the file.
@@ -103,7 +103,7 @@ public final class IOUtils {
/**
* Writes the contents of the specified <code>InputStream</code> to the specified file.
- *
+ *
* @param out The file to write the output to.
* @param in The input stream to pipe from.
* @return The number of characters written to the file.
@@ -119,7 +119,7 @@ public final class IOUtils {
/**
* Reads the contents of a reader into a string.
- *
+ *
* @param in The input reader.
* @return The contents of the reader as a string.
* @throws IOException If a problem occurred trying to read from the reader.
@@ -130,7 +130,7 @@ public final class IOUtils {
/**
* Reads the contents of an input stream into a string using the specified charset.
- *
+ *
* @param in The input stream.
* @param cs The charset of the contents of the input stream.
* @return The contents of the reader as a string. <jk>null</jk> if input stream was null.
@@ -144,7 +144,7 @@ public final class IOUtils {
/**
* Reads the contents of an input stream into a string using the system default charset.
- *
+ *
* @param in The input stream.
* @return The contents of the reader as a string, or <jk>null</jk> if the input stream is null.
* @throws IOException If a problem occurred trying to read from the input stream.
@@ -157,7 +157,7 @@ public final class IOUtils {
/**
* Read the specified input stream into a byte array and closes the stream.
- *
+ *
* @param in The input stream.
* @param bufferSize The expected size of the buffer.
* @return The contents of the stream as a byte array.
@@ -183,7 +183,7 @@ public final class IOUtils {
/**
* Reads a raw stream of bytes from the specified file.
- *
+ *
* @param f The file to read.
* @return A byte array containing the contents of the file.
* @throws IOException
@@ -199,14 +199,14 @@ public final class IOUtils {
/**
* Reads the specified input into a {@link String} until the end of the input is reached.
- *
+ *
* <p>
* The {@code Reader} is automatically closed.
- *
+ *
* <p>
* If the {@code Reader} is not an instance of a {@code BufferedReader}, then it gets wrapped in a
* {@code BufferedReader}.
- *
+ *
* @param in The input reader.
* @param length Specify a positive number if the length of the input is known.
* @param bufferSize Specify the buffer size to use.
@@ -231,10 +231,10 @@ public final class IOUtils {
/**
* Pipes the contents of the specified reader into the writer.
- *
+ *
* <p>
* The reader is closed, the writer is not.
- *
+ *
* @param in
* The reader to pipe from.
* @param out
@@ -249,10 +249,10 @@ public final class IOUtils {
/**
* Pipes the contents of the specified object into the writer.
- *
+ *
* <p>
* The reader is closed, the writer is not.
- *
+ *
* @param in
* The input to pipe from.
* Can be any of the types defined by {@link #toReader(Object)}.
@@ -266,10 +266,10 @@ public final class IOUtils {
/**
* Pipes the contents of the specified streams.
- *
+ *
* <p>
* The input stream is closed, the output stream is not.
- *
+ *
* @param in
* The reader to pipe from.
* @param out
@@ -284,10 +284,10 @@ public final class IOUtils {
/**
* Pipes the contents of the specified object into the output stream.
- *
+ *
* <p>
* The input stream is closed, the output stream is not.
- *
+ *
* @param in
* The input to pipe from.
* Can be any of the types defined by {@link #toInputStream(Object)}.
@@ -301,7 +301,7 @@ public final class IOUtils {
/**
* Wraps the specified reader in a buffered reader.
- *
+ *
* @param r The reader being wrapped.
* @return
* The reader wrapped in a {@link BufferedReader}, or the original {@link Reader} if it's already a buffered
@@ -315,7 +315,7 @@ public final class IOUtils {
/**
* Counts the number of bytes in the input stream and then closes the stream.
- *
+ *
* @param is The input stream to read from.
* @return The number of bytes read.
* @throws IOException
@@ -335,7 +335,7 @@ public final class IOUtils {
/**
* Counts the number of characters in the reader and then closes the reader.
- *
+ *
* @param r The reader to read from.
* @return The number of characters read.
* @throws IOException
@@ -355,10 +355,10 @@ public final class IOUtils {
/**
* Given the specified <js>"Content-Length"</js> header value, return an appropriate buffer size.
- *
+ *
* <p>
* The maximum buffer size is 1MB.
- *
+ *
* @param contentLength The value of the <js>"Content-Length"</js> header.
* @return The appropriate buffer size.
*/
@@ -380,10 +380,10 @@ public final class IOUtils {
/**
* Close input stream and ignore any exceptions.
- *
+ *
* <p>
* No-op if input stream is <jk>null</jk>.
- *
+ *
* @param is The input stream to close.
*/
public static void closeQuietly(InputStream is) {
@@ -395,10 +395,10 @@ public final class IOUtils {
/**
* Close output stream and ignore any exceptions.
- *
+ *
* <p>
* No-op if output stream is <jk>null</jk>.
- *
+ *
* @param os The output stream to close.
*/
public static void closeQuietly(OutputStream os) {
@@ -410,10 +410,10 @@ public final class IOUtils {
/**
* Close reader and ignore any exceptions.
- *
+ *
* <p>
* No-op if reader is <jk>null</jk>.
- *
+ *
* @param r The reader to close.
*/
public static void closeQuietly(Reader r) {
@@ -425,10 +425,10 @@ public final class IOUtils {
/**
* Close writer and ignore any exceptions.
- *
+ *
* <p>
* No-op if writer is <jk>null</jk>.
- *
+ *
* @param w The writer to close.
*/
public static void closeQuietly(Writer w) {
@@ -440,7 +440,7 @@ public final class IOUtils {
/**
* Quietly close all specified input streams, output streams, readers, and writers.
- *
+ *
* @param o The list of all objects to quietly close.
*/
public static void closeQuietly(Object...o) {
@@ -458,7 +458,7 @@ public final class IOUtils {
/**
* Flushes multiple output streams and writers in a single call.
- *
+ *
* @param o
* The objects to flush.
* <jk>null</jk> entries are ignored.
@@ -482,7 +482,7 @@ public final class IOUtils {
/**
* Close all specified input streams, output streams, readers, and writers.
- *
+ *
* @param o
* The list of all objects to close.
* <jk>null</jk> entries are ignored.
@@ -510,7 +510,7 @@ public final class IOUtils {
/**
* Converts an object to a <code>Reader</code>.
- *
+ *
* @param o
* The object to convert to a reader.
* Can be any of the following:
@@ -544,7 +544,7 @@ public final class IOUtils {
/**
* Converts an object to an <code>InputStream</code>.
- *
+ *
* @param o
* The object to convert to an input stream.
* Can be any of the following:
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/IdentityList.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/IdentityList.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/IdentityList.java
index 5feb470..4b35fb1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/IdentityList.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/IdentityList.java
@@ -16,19 +16,20 @@ 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.
* </ul>
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>This class is NOT thread safe, and is intended for use on small lists.
* </ul>
- *
+ *
* @param <T> Entry type.
*/
public class IdentityList<T> extends LinkedList<T> {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/JuneauLogger.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/JuneauLogger.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/JuneauLogger.java
index 200b79b..77100f9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/JuneauLogger.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/JuneauLogger.java
@@ -46,7 +46,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Get logger for specified class.
- *
+ *
* @param forClass The class to create a logger for.
* @return A new <l>Logger</l>.
*/
@@ -56,7 +56,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Get logger for specified class using the specified resource bundle name.
- *
+ *
* @param forClass The class to create a logger for.
* @param resourceBundleName
* The name of the resource bundle.
@@ -74,7 +74,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Get logger with specified name using the specified resource bundle name.
- *
+ *
* @param name The name of the logger to use.
* @param resourceBundleName
* The name of the resource bundle.
@@ -92,7 +92,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Constructor.
- *
+ *
* @param innerLogger The wrapped logger.
*/
protected JuneauLogger(java.util.logging.Logger innerLogger) {
@@ -103,7 +103,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Logs a message with the specified {@link MessageFormat}-style arguments at {@link Level#SEVERE} level.
- *
+ *
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -114,7 +114,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Logs a message with the specified {@link MessageFormat}-style arguments at {@link Level#WARNING} level.
- *
+ *
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -125,7 +125,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Logs a message with the specified {@link MessageFormat}-style arguments at {@link Level#INFO} level.
- *
+ *
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -136,7 +136,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Logs a message with the specified {@link MessageFormat}-style arguments at {@link Level#CONFIG} level.
- *
+ *
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -147,7 +147,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Logs a message with the specified {@link MessageFormat}-style arguments at {@link Level#FINE} level.
- *
+ *
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -158,7 +158,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Logs a message with the specified {@link MessageFormat}-style arguments at {@link Level#FINER} level.
- *
+ *
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -169,7 +169,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Logs a message with the specified {@link MessageFormat}-style arguments at {@link Level#FINEST} level.
- *
+ *
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -180,7 +180,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Logs an exception as {@link Level#SEVERE} level.
- *
+ *
* @param t The Throwable object to log.
*/
public void severe(Throwable t) {
@@ -190,7 +190,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Logs an exception as {@link Level#WARNING} level.
- *
+ *
* @param t The Throwable object to log.
*/
public void warning(Throwable t) {
@@ -200,7 +200,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Logs a message with the specified {@link MessageFormat}-style arguments at {@link Level#SEVERE} level.
- *
+ *
* @param t The Throwable object associated with the event that needs to be logged.
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -212,7 +212,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Logs a message with the specified {@link MessageFormat}-style arguments at {@link Level#WARNING} level.
- *
+ *
* @param t The Throwable object associated with the event that needs to be logged.
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -224,7 +224,7 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Logs a message with the specified {@link MessageFormat}-style arguments at {@link Level#INFO} level.
- *
+ *
* @param t The Throwable object associated with the event that needs to be logged.
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -247,10 +247,10 @@ public class JuneauLogger extends java.util.logging.Logger {
/**
* Similar to {@link #log(Level, String, Object[])}, except arguments are converted to objects
* that are serialized using the {@link JsonSerializer#toStringObject(Object)} method.
- *
+ *
* <p>
* This allows arbitrary POJOs to be serialized as message parameters.
- *
+ *
* @param level The level of the given message.
* @param msg The message to log.
* @param args The POJO arguments.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/KeywordSet.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/KeywordSet.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/KeywordSet.java
index b2f79d7..2df4363 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/KeywordSet.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/KeywordSet.java
@@ -22,7 +22,7 @@ public final class KeywordSet {
/**
* Constructor.
- *
+ *
* @param keywords The list of keywords.
*/
public KeywordSet(String... keywords) {
@@ -32,7 +32,7 @@ public final class KeywordSet {
/**
* Returns <jk>true</jk> if the specified string exists in this store.
- *
+ *
* @param s The string to check.
* @return <jk>true</jk> if the specified string exists in this store.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/MultiIterable.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/MultiIterable.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/MultiIterable.java
index c283076..8bfd566 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/MultiIterable.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/MultiIterable.java
@@ -18,7 +18,7 @@ import java.util.*;
/**
* Utility class for defining an iterator over one or more iterables.
- *
+ *
* @param <E> The element class type.
*/
public class MultiIterable<E> implements Iterable<E> {
@@ -27,7 +27,7 @@ public class MultiIterable<E> implements Iterable<E> {
/**
* Constructor.
- *
+ *
* @param iterators The list of iterators to iterate over.
*/
@SuppressWarnings("unchecked")
@@ -38,7 +38,7 @@ public class MultiIterable<E> implements Iterable<E> {
/**
* Appends the specified iterator to this list of iterators.
- *
+ *
* @param iterator The iterator to append.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/MultiSet.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/MultiSet.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/MultiSet.java
index b021e56..5734f20 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/MultiSet.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/MultiSet.java
@@ -18,7 +18,7 @@ import java.util.*;
/**
* Encapsulates multiple collections so they can be iterated over as if they were all part of the same collection.
- *
+ *
* @param <E> The object type of this set.
*/
public class MultiSet<E> extends AbstractSet<E> {
@@ -28,7 +28,7 @@ public class MultiSet<E> extends AbstractSet<E> {
/**
* Create a new Set that consists as a coalesced set of the specified collections.
- *
+ *
* @param c Zero or more collections to add to this set.
*/
@SuppressWarnings("unchecked")
@@ -39,7 +39,7 @@ public class MultiSet<E> extends AbstractSet<E> {
/**
* Appends the specified collection to this set of collections.
- *
+ *
* @param c The collection to append to this set of collections.
* @return This object (for method chaining).
*/
@@ -93,7 +93,7 @@ public class MultiSet<E> extends AbstractSet<E> {
/**
* Enumerates over all entries in all collections.
- *
+ *
* @return An enumeration wrapper around this set.
*/
public Enumeration<E> enumerator() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ObjectUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ObjectUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ObjectUtils.java
index 422c557..d188cfb 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ObjectUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ObjectUtils.java
@@ -20,10 +20,10 @@ import org.apache.juneau.transform.*;
/**
* Utility class for efficiently converting objects between types.
- *
+ *
* <p>
* If the value isn't an instance of the specified type, then converts the value if possible.
- *
+ *
* <p>
* The following conversions are valid:
* <table class='styled'>
@@ -155,7 +155,7 @@ public final class ObjectUtils {
/**
* Converts the specified object to the specified type.
- *
+ *
* @param <T> The class type to convert the value to.
* @param value The value to convert.
* @param type The class type to convert the value to.
@@ -168,7 +168,7 @@ public final class ObjectUtils {
/**
* Converts the specified object to the specified type.
- *
+ *
* @param <T> The class type to convert the value to.
* @param outer
* If class is a member class, this is the instance of the containing class.
@@ -184,10 +184,10 @@ public final class ObjectUtils {
/**
* Returns <jk>true</jk> if the specified objects are equal.
- *
+ *
* <p>
* Gracefully handles <jk>null</jk>s.
- *
+ *
* @param o1 Object #1
* @param o2 Object #2
* @return <jk>true</jk> if the objects are equal or both <jk>null</jk>.
@@ -202,7 +202,7 @@ public final class ObjectUtils {
/**
* Returns <jk>true</jk> if the specified object is empty.
- *
+ *
* <p>
* Return <jk>true</jk> if the value is any of the following:
* <ul>
@@ -213,7 +213,7 @@ public final class ObjectUtils {
* <li>An empty CharSequence
* <li>An empty String when serialized to a string using {@link Object#toString()}.
* </ul>
- *
+ *
* @param o The object to test.
* @return <jk>true</jk> if the specified object is empty.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Pair.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Pair.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Pair.java
index 3593277..bfaa209 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Pair.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Pair.java
@@ -14,7 +14,7 @@ package org.apache.juneau.internal;
/**
* Represents a simple object pair.
- *
+ *
* @param <F> The first object type.
* @param <S> The second object type.
*/
@@ -24,7 +24,7 @@ public class Pair<F,S> {
/**
* Constructor.
- *
+ *
* @param first The first object in the pair.
* @param second The second object in the pair.
*/
@@ -35,7 +35,7 @@ public class Pair<F,S> {
/**
* Returns the first object in the pair.
- *
+ *
* @return The first object in the pair.
*/
public F first() {
@@ -44,7 +44,7 @@ public class Pair<F,S> {
/**
* Returns the second object in the pair.
- *
+ *
* @return The second object in the pair.
*/
public S second() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ReflectionUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ReflectionUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ReflectionUtils.java
index 6d0e80b..293f51d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ReflectionUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ReflectionUtils.java
@@ -25,7 +25,7 @@ public final class ReflectionUtils {
/**
* Similar to {@link Class#getAnnotation(Class)} except also searches annotations on interfaces.
- *
+ *
* @param <T> The annotation class type.
* @param a The annotation class.
* @param c The annotated class.
@@ -53,11 +53,11 @@ public final class ReflectionUtils {
/**
* Returns the specified annotation only if it's been declared on the specified class.
- *
+ *
* <p>
* More efficient than calling {@link Class#getAnnotation(Class)} since it doesn't recursively look for the class
* up the parent chain.
- *
+ *
* @param <T> The annotation class type.
* @param a The annotation class.
* @param c The annotated class.
@@ -73,11 +73,11 @@ public final class ReflectionUtils {
/**
* Returns all instances of the specified annotation on the specified class.
- *
+ *
* <p>
* Searches all superclasses and superinterfaces.
* Results are ordered child-to-parent.
- *
+ *
* @param <T> The annotation class type.
* @param a The annotation class type.
* @param c The class being searched.
@@ -91,7 +91,7 @@ public final class ReflectionUtils {
/**
* Same as {@link #findAnnotations(Class, Class)} but returns the list in parent-to-child order.
- *
+ *
* @param a The annotation class type.
* @param c The class being searched.
* @return The found matches, or an empty array if annotation was not found.
@@ -105,10 +105,10 @@ public final class ReflectionUtils {
/**
* Same as {@link #findAnnotations(Class, Class)} except returns the annotations as a map with the keys being the
* class on which the annotation was found.
- *
+ *
* <p>
* Results are ordered child-to-parent.
- *
+ *
* @param <T> The annotation class type.
* @param a The annotation class type.
* @param c The class being searched.
@@ -122,7 +122,7 @@ public final class ReflectionUtils {
/**
* Same as {@link #findAnnotationsMap(Class, Class)} except returns results in parent-to-child order.
- *
+ *
* @param <T> The annotation class type.
* @param a The annotation class type.
* @param c The class being searched.
@@ -149,7 +149,7 @@ public final class ReflectionUtils {
/**
* Finds and appends the specified annotation on the specified class and superclasses/interfaces to the specified
* list.
- *
+ *
* @param a The annotation.
* @param c The class.
* @param l The list of annotations.
@@ -172,7 +172,7 @@ public final class ReflectionUtils {
/**
* Similar to {@link Class#getResourceAsStream(String)} except looks up the parent hierarchy for the existence of
* the specified resource.
- *
+ *
* @param c The class to return the resource on.
* @param name The resource name.
* @return An input stream on the specified resource, or <jk>null</jk> if the resource could not be found.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/SimpleMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/SimpleMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/SimpleMap.java
index 699e0c5..bbf5f4d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/SimpleMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/SimpleMap.java
@@ -22,13 +22,13 @@ import org.apache.juneau.*;
/**
* An instance of a <code>Map</code> where the keys and values are simple <code>String[]</code> and
* <code>Object[]</code> arrays.
- *
+ *
* <p>
* Typically more efficient than <code>HashMaps</code> for small maps (e.g. <10 entries).
- *
+ *
* <p>
* Does not support adding or removing entries.
- *
+ *
* <p>
* Setting values overwrites the value on the underlying value array.
*/
@@ -40,7 +40,7 @@ public final class SimpleMap extends AbstractMap<String,Object> {
/**
* Constructor.
- *
+ *
* @param keys The map keys. Must not be <jk>null</jk>.
* @param values The map values. Must not be <jk>null</jk>.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/StringBuilderWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/StringBuilderWriter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/StringBuilderWriter.java
index 81bdda3..852b36f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/StringBuilderWriter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/StringBuilderWriter.java
@@ -16,7 +16,7 @@ import java.io.*;
/**
* Similar to {@link StringWriter}, but uses a {@link StringBuilder} instead to avoid synchronization overhead.
- *
+ *
* <p>
* Note that this class is NOT thread safe.
*/
@@ -34,7 +34,7 @@ public final class StringBuilderWriter extends Writer {
/**
* Create a new string writer around an existing string builder.
- *
+ *
* @param sb The string builder being wrapped.
*/
public StringBuilderWriter(StringBuilder sb) {
@@ -44,7 +44,7 @@ public final class StringBuilderWriter extends Writer {
/**
* Create a new string writer using the specified initial string-builder size.
- *
+ *
* @param initialSize
* The number of <tt>char</tt> values that will fit into this buffer before it is automatically expanded.
* @throws IllegalArgumentException If <tt>initialSize</tt> is negative.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/StringUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/StringUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/StringUtils.java
index a808b27..d4ed252 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/StringUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/StringUtils.java
@@ -58,7 +58,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.
@@ -84,7 +84,7 @@ public final class StringUtils {
/**
* Reads a numeric string from the specified reader.
- *
+ *
* @param r The reader to read form.
* @return The parsed number string.
* @throws Exception
@@ -106,7 +106,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.
@@ -207,7 +207,7 @@ public final class StringUtils {
/**
* Returns <jk>true</jk> if this string can be parsed by {@link #parseNumber(String, Class)}.
- *
+ *
* @param s The string to check.
* @return <jk>true</jk> if this string can be parsed without causing an exception.
*/
@@ -221,7 +221,7 @@ public final class StringUtils {
/**
* Returns <jk>true</jk> if the specified character is a valid first character for a number.
- *
+ *
* @param c The character to test.
* @return <jk>true</jk> if the specified character is a valid first character for a number.
*/
@@ -231,7 +231,7 @@ public final class StringUtils {
/**
* Returns <jk>true</jk> if the specified string is a floating point number.
- *
+ *
* @param s The string to check.
* @return <jk>true</jk> if the specified string is a floating point number.
*/
@@ -256,7 +256,7 @@ public final class StringUtils {
/**
* Returns <jk>true</jk> if the specified string is numeric.
- *
+ *
* @param s The string to check.
* @return <jk>true</jk> if the specified string is numeric.
*/
@@ -307,7 +307,7 @@ public final class StringUtils {
/**
* Convenience method for getting a stack trace as a string.
- *
+ *
* @param t The throwable to get the stack trace from.
* @return The same content that would normally be rendered via <code>t.printStackTrace()</code>
*/
@@ -321,7 +321,7 @@ public final class StringUtils {
/**
* Join the specified tokens into a delimited string.
- *
+ *
* @param tokens The tokens to join.
* @param separator The delimiter.
* @return The delimited string. If <code>tokens</code> is <jk>null</jk>, returns <jk>null</jk>.
@@ -340,7 +340,7 @@ public final class StringUtils {
/**
* Join the specified tokens into a delimited string.
- *
+ *
* @param tokens The tokens to join.
* @param d The delimiter.
* @return The delimited string. If <code>tokens</code> is <jk>null</jk>, returns <jk>null</jk>.
@@ -359,7 +359,7 @@ public final class StringUtils {
/**
* Join the specified tokens into a delimited string.
- *
+ *
* @param tokens The tokens to join.
* @param d The delimiter.
* @return The delimited string. If <code>tokens</code> is <jk>null</jk>, returns <jk>null</jk>.
@@ -372,7 +372,7 @@ public final class StringUtils {
/**
* Joins the specified tokens into a delimited string and writes the output to the specified string builder.
- *
+ *
* @param tokens The tokens to join.
* @param d The delimiter.
* @param sb The string builder to append the response to.
@@ -391,7 +391,7 @@ public final class StringUtils {
/**
* Joins the specified tokens into a delimited string.
- *
+ *
* @param tokens The tokens to join.
* @param d The delimiter.
* @return The delimited string. If <code>tokens</code> is <jk>null</jk>, returns <jk>null</jk>.
@@ -404,7 +404,7 @@ public final class StringUtils {
/**
* Join the specified tokens into a delimited string and writes the output to the specified string builder.
- *
+ *
* @param tokens The tokens to join.
* @param d The delimiter.
* @param sb The string builder to append the response to.
@@ -423,7 +423,7 @@ public final class StringUtils {
/**
* Join the specified tokens into a delimited string.
- *
+ *
* @param tokens The tokens to join.
* @param d The delimiter.
* @return The delimited string. If <code>tokens</code> is <jk>null</jk>, returns <jk>null</jk>.
@@ -442,7 +442,7 @@ public final class StringUtils {
/**
* Join the specified tokens into a delimited string.
- *
+ *
* @param tokens The tokens to join.
* @param d The delimiter.
* @return The delimited string. If <code>tokens</code> is <jk>null</jk>, returns <jk>null</jk>.
@@ -461,7 +461,7 @@ public final class StringUtils {
/**
* Shortcut for calling <code>split(s, <js>','</js>)</code>
- *
+ *
* @param s The string to split. Can be <jk>null</jk>.
* @return The tokens, or <jk>null</jk> if the string was null.
*/
@@ -471,11 +471,11 @@ public final class StringUtils {
/**
* Splits a character-delimited string into a string array.
- *
+ *
* <p>
* Does not split on escaped-delimiters (e.g. "\,");
* Resulting tokens are trimmed of whitespace.
- *
+ *
* <p>
* <b>NOTE:</b> This behavior is different than the Jakarta equivalent.
* split("a,b,c",',') -> {"a","b","c"}
@@ -487,7 +487,7 @@ public final class StringUtils {
* split("a,b\,c,d", ',', false) -> {"a","b\,c","d"}
* split("a,b\\,c,d", ',', false) -> {"a","b\","c","d"}
* split("a,b\,c,d", ',', true) -> {"a","b,c","d"}
- *
+ *
* @param s The string to split. Can be <jk>null</jk>.
* @param c The character to split on.
* @return The tokens, or <jk>null</jk> if the string was null.
@@ -498,7 +498,7 @@ public final class StringUtils {
/**
* Same as {@link #split(String, char)} but limits the number of tokens returned.
- *
+ *
* @param s The string to split. Can be <jk>null</jk>.
* @param c The character to split on.
* @param limit The maximum number of tokens to return.
@@ -539,7 +539,7 @@ public final class StringUtils {
/**
* Same as {@link #split(String, char)} except splits all strings in the input and returns a single result.
- *
+ *
* @param s The string to split. Can be <jk>null</jk>.
* @param c The character to split on.
* @return The tokens.
@@ -559,14 +559,14 @@ public final class StringUtils {
/**
* Splits a list of key-value pairs into an ordered map.
- *
+ *
* <p>
* Example:
* <p class='bcode'>
* String in = <js>"foo=1;bar=2"</js>;
* Map m = StringUtils.<jsm>splitMap</jsm>(in, <js>';'</js>, <js>'='</js>, <jk>true</jk>);
* </p>
- *
+ *
* @param s The string to split.
* @param delim The delimiter between the key-value pairs.
* @param eq The delimiter between the key and value.
@@ -746,7 +746,7 @@ public final class StringUtils {
/**
* Returns <jk>true</jk> if specified string is <jk>null</jk> or empty.
- *
+ *
* @param s The string to check.
* @return <jk>true</jk> if specified string is <jk>null</jk> or empty.
*/
@@ -757,7 +757,7 @@ public final class StringUtils {
/**
* Returns <jk>true</jk> if specified string is <jk>null</jk> or it's {@link #toString()} method returns an empty
* string.
- *
+ *
* @param s The string to check.
* @return
* <jk>true</jk> if specified string is <jk>null</jk> or it's {@link #toString()} method returns an empty string.
@@ -768,7 +768,7 @@ public final class StringUtils {
/**
* Returns <jk>null</jk> if the specified string is <jk>null</jk> or empty.
- *
+ *
* @param s The string to check.
* @return <jk>null</jk> if the specified string is <jk>null</jk> or empty, or the same string if not.
*/
@@ -780,7 +780,7 @@ public final class StringUtils {
/**
* Returns an empty string if the specified string is <jk>null</jk>.
- *
+ *
* @param s The string to check.
* @return An empty string if the specified string is <jk>null</jk>, or the same string otherwise.
*/
@@ -792,7 +792,7 @@ public final class StringUtils {
/**
* Removes escape characters (\) from the specified characters.
- *
+ *
* @param s The string to remove escape characters from.
* @param toEscape The characters escaped.
* @return A new string if characters were removed, or the same string if not or if the input was <jk>null</jk>.
@@ -803,7 +803,7 @@ public final class StringUtils {
/**
* Removes escape characters (specified by escapeChar) from the specified characters.
- *
+ *
* @param s The string to remove escape characters from.
* @param toEscape The characters escaped.
* @param escapeChar The escape character.
@@ -838,7 +838,7 @@ public final class StringUtils {
/**
* Debug method for rendering non-ASCII character sequences.
- *
+ *
* @param s The string to decode.
* @return A string with non-ASCII characters converted to <js>"[hex]"</js> sequences.
*/
@@ -857,7 +857,7 @@ public final class StringUtils {
/**
* An efficient method for checking if a string starts with a character.
- *
+ *
* @param s The string to check. Can be <jk>null</jk>.
* @param c The character to check for.
* @return <jk>true</jk> if the specified string is not <jk>null</jk> and starts with the specified character.
@@ -873,7 +873,7 @@ public final class StringUtils {
/**
* An efficient method for checking if a string ends with a character.
- *
+ *
* @param s The string to check. Can be <jk>null</jk>.
* @param c The character to check for.
* @return <jk>true</jk> if the specified string is not <jk>null</jk> and ends with the specified character.
@@ -889,7 +889,7 @@ public final class StringUtils {
/**
* Same as {@link #endsWith(String, char)} except check for multiple characters.
- *
+ *
* @param s The string to check. Can be <jk>null</jk>.
* @param c The characters to check for.
* @return <jk>true</jk> if the specified string is not <jk>null</jk> and ends with the specified character.
@@ -909,7 +909,7 @@ public final class StringUtils {
/**
* Converts the specified number into a 4 hexadecimal characters.
- *
+ *
* @param num The number to convert to hex.
* @return A <code><jk>char</jk>[4]</code> containing the specified characters.
*/
@@ -928,7 +928,7 @@ public final class StringUtils {
/**
* Tests two strings for equality, but gracefully handles nulls.
- *
+ *
* @param s1 String 1.
* @param s2 String 2.
* @return <jk>true</jk> if the strings are equal.
@@ -943,7 +943,7 @@ public final class StringUtils {
/**
* Shortcut for calling <code>base64Encode(in.getBytes(<js>"UTF-8"</js>))</code>
- *
+ *
* @param in The input string to convert.
* @return The string converted to BASE-64 encoding.
*/
@@ -955,7 +955,7 @@ public final class StringUtils {
/**
* BASE64-encodes the specified byte array.
- *
+ *
* @param in The input byte array to convert.
* @return The byte array converted to a BASE-64 encoded string.
*/
@@ -984,7 +984,7 @@ public final class StringUtils {
/**
* Shortcut for calling <code>base64Decode(String)</code> and converting the result to a UTF-8 encoded string.
- *
+ *
* @param in The BASE-64 encoded string to decode.
* @return The decoded string.
*/
@@ -997,7 +997,7 @@ public final class StringUtils {
/**
* BASE64-decodes the specified string.
- *
+ *
* @param in The BASE-64 encoded string.
* @return The decoded byte array.
*/
@@ -1042,10 +1042,10 @@ public final class StringUtils {
/**
* Generated a random UUID with the specified number of characters.
- *
+ *
* <p>
* Characters are composed of lower-case ASCII letters and numbers only.
- *
+ *
* <p>
* This method conforms to the restrictions for hostnames as specified in <a class="doclink"
* href="https://tools.ietf.org/html/rfc952">RFC 952</a>
@@ -1054,12 +1054,12 @@ public final class StringUtils {
* <code>sqrt(36^N)</code>.
* Dividing this number by 10 gives you an approximation of the number of generated IDs needed to produce a
* <1% chance of collision.
- *
+ *
* <p>
* For example, given 5 characters, the number of generated IDs need to produce a <1% chance of collision would
* be:
* <code>sqrt(36^5)/10=777</code>
- *
+ *
* @param numchars The number of characters in the generated UUID.
* @return A new random UUID.
*/
@@ -1077,7 +1077,7 @@ public final class StringUtils {
/**
* Same as {@link String#trim()} but prevents <code>NullPointerExceptions</code>.
- *
+ *
* @param s The string to trim.
* @return The trimmed string, or <jk>null</jk> if the string was <jk>null</jk>.
*/
@@ -1089,7 +1089,7 @@ public final class StringUtils {
/**
* Parses an ISO8601 string into a date.
- *
+ *
* @param date The date string.
* @return The parsed date.
* @throws IllegalArgumentException
@@ -1116,16 +1116,16 @@ public final class StringUtils {
/**
* Simple utility for replacing variables of the form <js>"{key}"</js> with values in the specified map.
- *
+ *
* <p>
* Nested variables are supported in both the input string and map values.
- *
+ *
* <p>
* If the map does not contain the specified value, the variable is not replaced.
- *
+ *
* <p>
* <jk>null</jk> values in the map are treated as blank strings.
- *
+ *
* @param s The string containing variables to replace.
* @param m The map containing the variable values.
* @return The new string with variables replaced, or the original string if it didn't have variables in it.
@@ -1189,7 +1189,7 @@ public final class StringUtils {
/**
* Returns <jk>true</jk> if the specified path string is prefixed with the specified prefix.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* pathStartsWith(<js>"foo"</js>, <js>"foo"</js>); <jc>// true</jc>
@@ -1197,7 +1197,7 @@ public final class StringUtils {
* pathStartsWith(<js>"foo2"</js>, <js>"foo"</js>); <jc>// false</jc>
* pathStartsWith(<js>"foo2"</js>, <js>""</js>); <jc>// false</jc>
* </p>
- *
+ *
* @param path The path to check.
* @param pathPrefix The prefix.
* @return <jk>true</jk> if the specified path string is prefixed with the specified prefix.
@@ -1212,7 +1212,7 @@ public final class StringUtils {
/**
* Same as {@link #pathStartsWith(String, String)} but returns <jk>true</jk> if at least one prefix matches.
- *
+ *
* @param path The path to check.
* @param pathPrefixes The prefixes.
* @return <jk>true</jk> if the specified path string is prefixed with any of the specified prefixes.
@@ -1226,7 +1226,7 @@ public final class StringUtils {
/**
* Replaces <js>"\\uXXXX"</js> character sequences with their unicode characters.
- *
+ *
* @param s The string to replace unicode sequences in.
* @return A string with unicode sequences replaced.
*/
@@ -1246,7 +1246,7 @@ public final class StringUtils {
/**
* Returns the specified field in a delimited string without splitting the string.
- *
+ *
* <p>
* Equivalent to the following:
* <p class='bcode'>
@@ -1254,7 +1254,7 @@ public final class StringUtils {
* String[] parts = in.split(<js>","</js>);
* String p1 = (parts.<jk>length</jk> > 1 ? parts[1] : <js>""</js>);
* </p>
- *
+ *
* @param fieldNum The field number. Zero-indexed.
* @param s The input string.
* @param delim The delimiter character.
@@ -1266,7 +1266,7 @@ public final class StringUtils {
/**
* Same as {@link #getField(int, String, char)} except allows you to specify the default value.
- *
+ *
* @param fieldNum The field number. Zero-indexed.
* @param s The input string.
* @param delim The delimiter character.
@@ -1294,7 +1294,7 @@ public final class StringUtils {
/**
* Calls {@link #toString()} on the specified object if it's not null.
- *
+ *
* @param o The object to convert to a string.
* @return The object converted to a string, or <jk>null</jk> if the object was null.
*/
@@ -1304,7 +1304,7 @@ public final class StringUtils {
/**
* Converts an array of objects to an array of strings.
- *
+ *
* @param o The array of objects to convert to strings.
* @return A new array of objects converted to strings.
*/
@@ -1321,7 +1321,7 @@ public final class StringUtils {
/**
* Converts a hexadecimal byte stream (e.g. "34A5BC") into a UTF-8 encoded string.
- *
+ *
* @param hex The hexadecimal string.
* @return The UTF-8 string.
*/
@@ -1336,7 +1336,7 @@ public final class StringUtils {
/**
* Converts a space-deliminted hexadecimal byte stream (e.g. "34 A5 BC") into a UTF-8 encoded string.
- *
+ *
* @param hex The hexadecimal string.
* @return The UTF-8 string.
*/
@@ -1353,7 +1353,7 @@ public final class StringUtils {
/**
* Converts a byte array into a simple hexadecimal character string.
- *
+ *
* @param bytes The bytes to convert to hexadecimal.
* @return A new string consisting of hexadecimal characters.
*/
@@ -1368,7 +1368,7 @@ public final class StringUtils {
/**
* Same as {@link #toHex(byte[])} but puts spaces between the byte strings.
- *
+ *
* @param bytes The bytes to convert to hexadecimal.
* @return A new string consisting of hexadecimal characters.
*/
@@ -1385,7 +1385,7 @@ public final class StringUtils {
/**
* Converts a hexadecimal character string to a byte array.
- *
+ *
* @param hex The string to convert to a byte array.
* @return A new byte array.
*/
@@ -1399,7 +1399,7 @@ public final class StringUtils {
/**
* Same as {@link #fromHex(String)} except expects spaces between the byte strings.
- *
+ *
* @param hex The string to convert to a byte array.
* @return A new byte array.
*/
@@ -1413,7 +1413,7 @@ public final class StringUtils {
/**
* Creates a repeated pattern.
- *
+ *
* @param count The number of times to repeat the pattern.
* @param pattern The pattern to repeat.
* @return A new string consisting of the repeated pattern.
@@ -1427,7 +1427,7 @@ public final class StringUtils {
/**
* Trims whitespace characters from the beginning of the specified string.
- *
+ *
* @param s The string to trim.
* @return The trimmed string, or <jk>null</jk> if the string was <jk>null</jk>.
*/
@@ -1440,7 +1440,7 @@ public final class StringUtils {
/**
* Trims whitespace characters from the end of the specified string.
- *
+ *
* @param s The string to trim.
* @return The trimmed string, or <jk>null</jk> if the string was <jk>null</jk>.
*/
@@ -1453,7 +1453,7 @@ public final class StringUtils {
/**
* Returns <jk>true</jk> if the specified string is one of the specified values.
- *
+ *
* @param s
* The string to test.
* Can be <jk>null</jk>.
@@ -1471,7 +1471,7 @@ public final class StringUtils {
/**
* Trims <js>'/'</js> characters from both the start and end of the specified string.
- *
+ *
* @param s The string to trim.
* @return A new trimmed string, or the same string if no trimming was necessary.
*/
@@ -1487,7 +1487,7 @@ public final class StringUtils {
/**
* Trims <js>'/'</js> characters from the end of the specified string.
- *
+ *
* @param s The string to trim.
* @return A new trimmed string, or the same string if no trimming was necessary.
*/
@@ -1501,7 +1501,7 @@ public final class StringUtils {
/**
* Trims <js>'/'</js> characters from the end of the specified string.
- *
+ *
* @param s The string to trim.
* @return The same string buffer.
*/
@@ -1515,7 +1515,7 @@ public final class StringUtils {
/**
* Decodes a <code>application/x-www-form-urlencoded</code> string using <code>UTF-8</code> encoding scheme.
- *
+ *
* @param s The string to decode.
* @return The decoded string, or <jk>null</jk> if input is <jk>null</jk>.
*/
@@ -1537,7 +1537,7 @@ public final class StringUtils {
/**
* Encodes a <code>application/x-www-form-urlencoded</code> string using <code>UTF-8</code> encoding scheme.
- *
+ *
* @param s The string to encode.
* @return The encoded string, or <jk>null</jk> if input is <jk>null</jk>.
*/
@@ -1557,7 +1557,7 @@ public final class StringUtils {
/**
* Returns the first non-whitespace character in the string.
- *
+ *
* @param s The string to check.
* @return
* The first non-whitespace character, or <code>0</code> if the string is <jk>null</jk>, empty, or composed
@@ -1573,7 +1573,7 @@ public final class StringUtils {
/**
* Returns the character at the specified index in the string without throwing exceptions.
- *
+ *
* @param s The string.
* @param i The index position.
* @return
@@ -1590,7 +1590,7 @@ public final class StringUtils {
/**
* Efficiently determines whether a URL is of the pattern "xxx://xxx"
- *
+ *
* @param s The string to test.
* @return <jk>true</jk> if it's an absolute path.
*/
@@ -1639,13 +1639,13 @@ public final class StringUtils {
/**
* Efficiently determines whether a URL is of the pattern "xxx:/xxx".
- *
+ *
* <p>
* The pattern matched is: <code>[a-z]{2,}\:\/.*</code>
- *
+ *
* <p>
* Note that this excludes filesystem paths such as <js>"C:/temp"</js>.
- *
+ *
* @param s The string to test.
* @return <jk>true</jk> if it's an absolute path.
*/
@@ -1691,7 +1691,7 @@ public final class StringUtils {
/**
* Given an absolute URI, returns just the authority portion (e.g. <js>"http://hostname:port"</js>)
- *
+ *
* @param s The URI string.
* @return Just the authority portion of the URI.
*/
@@ -1744,7 +1744,7 @@ public final class StringUtils {
/**
* Converts the specified object to a URI.
- *
+ *
* @param o The object to convert to a URI.
* @return A new URI, or the same object if the object was already a URI, or
*/
@@ -1760,7 +1760,7 @@ public final class StringUtils {
/**
* Returns the first non-null, non-empty string in the list.
- *
+ *
* @param s The strings to test.
* @return The first non-empty string in the list, or <jk>null</jk> if they were all <jk>null</jk> or empty.
*/
@@ -1773,7 +1773,7 @@ public final class StringUtils {
/**
* Same as {@link String#indexOf(int)} except allows you to check for multiple characters.
- *
+ *
* @param s The string to check.
* @param c The characters to check for.
* @return The index into the string that is one of the specified characters.
@@ -1792,7 +1792,7 @@ public final class StringUtils {
/**
* Similar to {@link MessageFormat#format(String, Object...)} except allows you to specify POJO arguments.
- *
+ *
* @param pattern The string pattern.
* @param args The arguments.
* @return The formatted string.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/SystemUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/SystemUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/SystemUtils.java
index 5f7a6b9..058ccfb 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/SystemUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/SystemUtils.java
@@ -19,7 +19,7 @@ public class SystemUtils {
/**
* Returns the first non-<jk>null</jk> system property.
- *
+ *
* @param def
* The default value if none are found.
* Can be <jk>null</jk>.
@@ -39,7 +39,7 @@ public class SystemUtils {
/**
* Returns the first non-<jk>null</jk> boolean system property.
- *
+ *
* @param def
* The default value if none are found.
* Can be <jk>null</jk>.
@@ -55,7 +55,7 @@ public class SystemUtils {
/**
* Returns the first non-<jk>null</jk> integer system property.
- *
+ *
* @param def
* The default value if none are found.
* Can be <jk>null</jk>.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/TeeOutputStream.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/TeeOutputStream.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/TeeOutputStream.java
index 2952f9e..114c982 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/TeeOutputStream.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/TeeOutputStream.java
@@ -24,7 +24,7 @@ public class TeeOutputStream extends OutputStream {
/**
* Constructor.
- *
+ *
* @param outputStreams The list of output streams.
*/
public TeeOutputStream(OutputStream...outputStreams) {
@@ -33,7 +33,7 @@ public class TeeOutputStream extends OutputStream {
/**
* Constructor.
- *
+ *
* @param outputStreams The list of output streams.
*/
public TeeOutputStream(Collection<OutputStream> outputStreams) {
@@ -42,7 +42,7 @@ public class TeeOutputStream extends OutputStream {
/**
* Adds an output stream to this tee output stream.
- *
+ *
* @param os The output stream to add to this tee output stream.
* @param close
* If <jk>false</jk>, then calling {@link #close()} on this stream will not filter to the specified output stream.
@@ -70,7 +70,7 @@ public class TeeOutputStream extends OutputStream {
/**
* Returns the output stream identified through the <code>id</code> parameter passed in through the
* {@link #add(String, OutputStream, boolean)} method.
- *
+ *
* @param id The ID associated with the output stream.
* @return The output stream, or <jk>null</jk> if no identifier was specified when the output stream was added.
*/
@@ -83,7 +83,7 @@ public class TeeOutputStream extends OutputStream {
/**
* Same as {@link #add(OutputStream, boolean)} but associates the stream with an identifier so the stream can be
* retrieved through {@link #getOutputStream(String)}.
- *
+ *
* @param id The ID to associate the output stream with.
* @param os The output stream to add.
* @param close Close the specified stream afterwards.
@@ -100,7 +100,7 @@ public class TeeOutputStream extends OutputStream {
/**
* Returns the number of inner streams in this tee stream.
- *
+ *
* @return The number of streams in this tee stream.
*/
public int size() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/TeeWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/TeeWriter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/TeeWriter.java
index 618a701..accf4b4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/TeeWriter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/TeeWriter.java
@@ -24,7 +24,7 @@ public class TeeWriter extends Writer {
/**
* Constructor.
- *
+ *
* @param writers The list of writers.
*/
public TeeWriter(Writer...writers) {
@@ -33,7 +33,7 @@ public class TeeWriter extends Writer {
/**
* Constructor.
- *
+ *
* @param writers The list of writers.
*/
public TeeWriter(Collection<Writer> writers) {
@@ -42,7 +42,7 @@ public class TeeWriter extends Writer {
/**
* Adds a writer to this tee writer.
- *
+ *
* @param w The writer to add to this tee writer.
* @param close
* If <jk>false</jk>, then calling {@link #close()} on this tee writer will not filter to the specified writer.
@@ -70,7 +70,7 @@ public class TeeWriter extends Writer {
/**
* Same as {@link #add(Writer, boolean)} but associates the writer with an identifier so the writer can be retrieved
* through {@link #getWriter(String)}.
- *
+ *
* @param id The ID to associate the writer with.
* @param w The writer to add.
* @param close Close the specified writer afterwards.
@@ -87,7 +87,7 @@ public class TeeWriter extends Writer {
/**
* Returns the number of inner writers in this tee writer.
- *
+ *
* @return The number of writers.
*/
public int size() {
@@ -97,7 +97,7 @@ public class TeeWriter extends Writer {
/**
* Returns the writer identified through the <code>id</code> parameter passed in through the
* {@link #add(String, Writer, boolean)} method.
- *
+ *
* @param id The ID associated with the writer.
* @return The writer, or <jk>null</jk> if no identifier was specified when the writer was added.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ThrowableUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ThrowableUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ThrowableUtils.java
index b5199cc..f77a61f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ThrowableUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ThrowableUtils.java
@@ -23,7 +23,7 @@ public class ThrowableUtils {
/**
* Throws an {@link IllegalArgumentException} if the specified object is <jk>null</jk>.
- *
+ *
* @param o The object to check.
* @param msg The message of the IllegalArgumentException.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -36,7 +36,7 @@ public class ThrowableUtils {
/**
* Throws an {@link IllegalArgumentException} if the specified field is <jk>null</jk>.
- *
+ *
* @param fieldValue The object to check.
* @param fieldName The name of the field.
* @throws IllegalArgumentException
@@ -48,7 +48,7 @@ public class ThrowableUtils {
/**
* Throws an {@link IllegalArgumentException} if the specified field is <code><=0</code>.
- *
+ *
* @param fieldValue The object to check.
* @param fieldName The name of the field.
* @throws IllegalArgumentException
@@ -60,7 +60,7 @@ public class ThrowableUtils {
/**
* Shortcut for calling <code><jk>new</jk> IllegalArgumentException(MessageFormat.<jsm>format</jsm>(msg, args));</code>
- *
+ *
* @param msg The message of the IllegalArgumentException.
* @param args Optional {@link MessageFormat}-style arguments.
* @throws IllegalArgumentException
@@ -71,7 +71,7 @@ public class ThrowableUtils {
/**
* Throws an exception if the specified thread ID is not the same as the current thread.
- *
+ *
* @param threadId The ID of the thread to compare against.
* @param msg The message of the IllegalStateException.
* @param args Optional {@link MessageFormat}-style arguments.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Utils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Utils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Utils.java
index 5c40951..93bfc76 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Utils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Utils.java
@@ -19,7 +19,7 @@ public class Utils {
/**
* Compare two integers numerically.
- *
+ *
* @param i1 Integer #1
* @param i2 Integer #2
* @return
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Version.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Version.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Version.java
index 375f1f9..04af40d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Version.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Version.java
@@ -16,7 +16,7 @@ import static org.apache.juneau.internal.StringUtils.*;
/**
* Represents a version string such as <js>"1.2"</js> or <js>"1.2.3"</js>
- *
+ *
* <p>
* Used to compare version numbers.
*/
@@ -26,7 +26,7 @@ public class Version {
/**
* Constructor
- *
+ *
* @param versionString
* A string of the form <js>"#.#..."</js> where there can be any number of parts.
* <br>Valid values:
@@ -54,7 +54,7 @@ public class Version {
/**
* Returns <jk>true</jk> if the specified version is at least this version.
- *
+ *
* <p>
* Note that the following is true:
* <p class='bcode'>
@@ -62,7 +62,7 @@ public class Version {
* b = <jk>new</jk> Version(<js>"1.2"</js>).isAtLeast(<jk>new</jk> Version(<js>"1.2.3"</js>)); <jc>// == true </jc>
* b = <jk>new</jk> Version(<js>"1.2.0"</js>).isAtLeast(<jk>new</jk> Version(<js>"1.2.3"</js>)); <jc>// == false</jc>
* </p>
- *
+ *
* @param v The version to compare to.
* @param exclusive Match down-to-version but not including.
* @return <jk>true</jk> if the specified version is at least this version.
@@ -83,7 +83,7 @@ public class Version {
/**
* Returns <jk>true</jk> if the specified version is at most this version.
- *
+ *
* <p>
* Note that the following is true:
* <p class='bcode'>
@@ -91,7 +91,7 @@ public class Version {
* b = <jk>new</jk> Version(<js>"1.2.3"</js>).isAtMost(<jk>new</jk> Version(<js>"1.2"</js>)); <jc>// == true </jc>
* b = <jk>new</jk> Version(<js>"1.2.3"</js>).isAtMost(<jk>new</jk> Version(<js>"1.2.0"</js>)); <jc>// == false</jc>
* </p>
- *
+ *
* @param v The version to compare to.
* @param exclusive Match up-to-version but not including.
* @return <jk>true</jk> if the specified version is at most this version.
@@ -112,7 +112,7 @@ public class Version {
/**
* Returns <jk>true</jk> if the specified version is equal to this version.
- *
+ *
* <p>
* Note that the following is true:
* <p class='bcode'>
@@ -120,7 +120,7 @@ public class Version {
* b = <jk>new</jk> Version(<js>"1.2.3"</js>).equals(<jk>new</jk> Version(<js>"1.2"</js>)); <jc>// == true </jc>
* b = <jk>new</jk> Version(<js>"1.2"</js>).equals(<jk>new</jk> Version(<js>"1.2.3"</js>)); <jc>// == true</jc>
* </p>
- *
+ *
* @param v The version to compare to.
* @return <jk>true</jk> if the specified version is equal to this version.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/VersionRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/VersionRange.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/VersionRange.java
index 16d6294..bf8c7e5 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/VersionRange.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/VersionRange.java
@@ -14,7 +14,7 @@ package org.apache.juneau.internal;
/**
* Represents an OSGi-style version range like <js>"1.2"</js> or <js>"[1.0,2.0)"</js>.
- *
+ *
* <p>
* The range can be any of the following formats:
* <ul>
@@ -30,7 +30,7 @@ public class VersionRange {
/**
* Constructor.
- *
+ *
* @param range The range string to parse.
*/
public VersionRange(String range) {
@@ -57,7 +57,7 @@ public class VersionRange {
/**
* Returns <jk>true</jk> if the specified version string matches this version range.
- *
+ *
* @param v The version string (e.g. <js>"1.2.3"</js>)
* @return <jk>true</jk> if the specified version string matches this version range.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/WrappedMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/WrappedMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/WrappedMap.java
index 534786d..11084ec 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/WrappedMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/WrappedMap.java
@@ -16,7 +16,7 @@ import java.util.*;
/**
* Wraps an existing map inside an extensible interface so that convenience methods can be added to the subclass.
- *
+ *
* @param <K> The key type.
* @param <V> The value type.
*/
@@ -26,7 +26,7 @@ public class WrappedMap<K,V> implements Map<K,V> {
/**
* Constructor.
- *
+ *
* @param inner The inner map.
*/
protected WrappedMap(Map<K,V> inner) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParser.java
index 55b9dc4..3b1a117 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParser.java
@@ -19,10 +19,11 @@ import org.apache.juneau.parser.*;
/**
* Parses POJOs from HTTP responses as Java {@link ObjectInputStream ObjectInputStreams}.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Consumes <code>Content-Type</code> types: <code>application/x-java-serialized-object</code>
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Consumes <code>Content-Type</code> types: <code><b>application/x-java-serialized-object</b></code>
*/
public final class JsoParser extends InputStreamParser {
@@ -40,7 +41,7 @@ public final class JsoParser extends InputStreamParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public JsoParser(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParserBuilder.java
index 000ac60..6f026ee 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParserBuilder.java
@@ -32,7 +32,7 @@ public class JsoParserBuilder extends ParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public JsoParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParserSession.java
index 12f9cf2..a082e92 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoParserSession.java
@@ -19,7 +19,7 @@ import org.apache.juneau.parser.*;
/**
* Session object that lives for the duration of a single use of {@link JsoParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -29,7 +29,7 @@ public class JsoParserSession extends InputStreamParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param args
* Runtime session arguments.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializer.java
index 4a15da4..31f576e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializer.java
@@ -19,13 +19,13 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJOs to HTTP responses as Java Serialized Object {@link ObjectOutputStream ObjectOutputStreams}.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>application/x-java-serialized-object</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>application/x-java-serialized-object</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>application/x-java-serialized-object</code>
+ * Produces <code>Content-Type</code> types: <code><b>application/x-java-serialized-object</b></code>
*/
public class JsoSerializer extends OutputStreamSerializer {
@@ -43,7 +43,7 @@ public class JsoSerializer extends OutputStreamSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public JsoSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializerBuilder.java
index 5be6b90..e6791ca 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializerBuilder.java
@@ -32,7 +32,7 @@ public class JsoSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public JsoSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializerSession.java
index 5d4f6f8..0f05065 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/jso/JsoSerializerSession.java
@@ -18,7 +18,7 @@ import org.apache.juneau.serializer.*;
/**
* Session object that lives for the duration of a single use of {@link JsoSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -27,7 +27,7 @@ public class JsoSerializerSession extends OutputStreamSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonClassMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonClassMeta.java
index e8b31d1..b99be5b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonClassMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonClassMeta.java
@@ -29,7 +29,7 @@ public class JsonClassMeta extends ClassMetaExtended {
/**
* Constructor.
- *
+ *
* @param cm The class that this annotation is defined on.
*/
public JsonClassMeta(ClassMeta<?> cm) {
@@ -44,7 +44,7 @@ public class JsonClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Json @Json} annotation defined on the class.
- *
+ *
* @return The value of the annotation, or <jk>null</jk> if not specified.
*/
protected Json getAnnotation() {
@@ -53,7 +53,7 @@ public class JsonClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Json#wrapperAttr() @Json.wrapperAttr()} annotation defined on the class.
- *
+ *
* @return The value of the annotation, or <jk>null</jk> if not specified.
*/
protected String getWrapperAttr() {
[17/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Referer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Referer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Referer.java
index f7ba76f..884f647 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Referer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Referer.java
@@ -14,19 +14,19 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Referer</l> HTTP request header.
- *
+ *
* <p>
* This is the address of the previous web page from which a link to the currently requested page was followed.
* (The word “referrer” has been misspelled in the RFC as well as in most implementations to the point that it has
* become standard usage and is considered correct terminology)
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Referer: http://en.wikipedia.org/wiki/Main_Page
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Referer[sic] request-header field allows the client to specify, for the server's benefit, the address (URI) of
* the resource from which the Request-URI was obtained (the "referrer", although the header field is misspelled.)
* The Referer request-header allows a server to generate lists of back-links to resources for interest, logging,
@@ -34,21 +34,21 @@ package org.apache.juneau.http;
* It also allows obsolete or mistyped links to be traced for maintenance.
* The Referer field MUST NOT be sent if the Request-URI was obtained from a source that does not have its own URI,
* such as input from the user keyboard.
- *
+ *
* <p class='bcode'>
* Referer = "Referer" ":" ( absoluteURI | relativeURI )
* </p>
- *
+ *
* <p>
* Example:
* <p class='bcode'>
* Referer: http://www.w3.org/hypertext/DataSources/Overview.html
* </p>
- *
+ *
* <p>
* If the field value is a relative URI, it SHOULD be interpreted relative to the Request-URI.
* The URI MUST NOT include a fragment. See section 15.1.3 for security considerations.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -62,7 +62,7 @@ public final class Referer extends HeaderUri {
/**
* Returns a parsed <code>Referer</code> header.
- *
+ *
* @param value The <code>Referer</code> header string.
* @return The parsed <code>Referer</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/RetryAfter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/RetryAfter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/RetryAfter.java
index d5278e8..7e5d372 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/RetryAfter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/RetryAfter.java
@@ -18,40 +18,40 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Retry-After</l> HTTP response header.
- *
+ *
* <p>
* If an entity is temporarily unavailable, this instructs the client to try again later.
* Value could be a specified period of time (in seconds) or a HTTP-date.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Retry-After: 120
* Retry-After: Fri, 07 Nov 2014 23:59:59 GMT
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Retry-After response-header field can be used with a 503 (Service Unavailable) response to indicate how long the
* service is expected to be unavailable to the requesting client.
* This field MAY also be used with any 3xx (Redirection) response to indicate the minimum time the user-agent is asked
* wait before issuing the redirected request.
* The value of this field can be either an HTTP-date or an integer number of seconds (in decimal) after the time of the
* response.
- *
+ *
* <p class='bcode'>
* Retry-After = "Retry-After" ":" ( HTTP-date | delta-seconds )
* </p>
- *
+ *
* <p>
* Two examples of its use are
* <p class='bcode'>
* Retry-After: Fri, 31 Dec 1999 23:59:59 GMT
* Retry-After: 120
* </p>
- *
+ *
* <p>
* In the latter example, the delay is 2 minutes.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -65,7 +65,7 @@ public final class RetryAfter extends HeaderString {
/**
* Returns a parsed <code>Retry-After</code> header.
- *
+ *
* @param value The <code>Retry-After</code> header string.
* @return The parsed <code>Retry-After</code> header, or <jk>null</jk> if the string was null.
*/
@@ -81,7 +81,7 @@ public final class RetryAfter extends HeaderString {
/**
* Returns this header value as a {@link java.util.Date} object.
- *
+ *
* @return This header value as a {@link java.util.Date} object, or <jk>null</jk> if the value is not a date.
*/
public java.util.Date asDate() {
@@ -93,7 +93,7 @@ public final class RetryAfter extends HeaderString {
/**
* Returns this header value as an integer.
- *
+ *
* @return This header value as a integer, or <code>-1</code> if the value is not an integer.
*/
public int asInt() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Server.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Server.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Server.java
index e98a3a0..9e51822 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Server.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Server.java
@@ -14,42 +14,42 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Server</l> HTTP response header.
- *
+ *
* <p>
* A name for the server.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Server: Apache/2.4.1 (Unix)
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Server response-header field contains information about the software used by the origin server to handle the
* request.
* The field can contain multiple product tokens (section 3.8) and comments identifying the server and any significant
* sub-products.
* The product tokens are listed in order of their significance for identifying the application.
- *
+ *
* <p class='bcode'>
* Server = "Server" ":" 1*( product | comment )
* </p>
- *
+ *
* <p>
* Example:
* <p class='bcode'>
* Server: CERN/3.0 libwww/2.17
* </p>
- *
+ *
* <p>
* If the response is being forwarded through a proxy, the proxy application MUST NOT modify the Server response-header.
* Instead, it SHOULD include a Via field (as described in section 14.45).
- *
+ *
* <p>
* Note: Revealing the specific software version of the server might allow the server machine to become more vulnerable
* to attacks against software that is known to contain security holes.
* Server implementors are encouraged to make this field a configurable option.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -63,7 +63,7 @@ public final class Server extends HeaderString {
/**
* Returns a parsed <code>Server</code> header.
- *
+ *
* @param value The <code>Server</code> header string.
* @return The parsed <code>Server</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/StringRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/StringRange.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/StringRange.java
index 8a5a3fb..09f062e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/StringRange.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/StringRange.java
@@ -21,14 +21,14 @@ import org.apache.juneau.internal.*;
/**
* Represents a single value in a comma-delimited header value that optionally contains a quality metric for
* comparison and extension parameters.
- *
+ *
* <p>
* Similar in concept to {@link MediaTypeRange} except instead of media types (e.g. <js>"text/json"</js>),
* it's a simple type (e.g. <js>"iso-8601"</js>).
- *
+ *
* <p>
* An example of a type range is a value in an <code>Accept-Encoding</code> header.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -49,7 +49,7 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Parses a header such as an <code>Accept-Encoding</code> header value into an array of type ranges.
- *
+ *
* <p>
* The syntax expected to be found in the referenced <code>value</code> complies with the syntax described in
* RFC2616, Section 14.1, as described below:
@@ -58,7 +58,7 @@ public final class StringRange implements Comparable<StringRange> {
* 1#( codings [ ";" "q" "=" qvalue ] )
* codings = ( content-coding | "*" )
* </p>
- *
+ *
* <p>
* Examples of its use are:
* <p class='bcode'>
@@ -68,7 +68,7 @@ public final class StringRange implements Comparable<StringRange> {
* Accept-Encoding: compress;q=0.5, gzip;q=1.0
* Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0
* </p>
- *
+ *
* @param value
* The value to parse.
* If <jk>null</jk> or empty, returns a single <code>TypeRange</code> is returned that represents all types.
@@ -151,14 +151,14 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Returns the type enclosed by this type range.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <ul>
* <li><js>"compress"</js>
* <li><js>"gzip"</js>
* <li><js>"*"</js>
* </ul>
- *
+ *
* @return The type of this type range, lowercased, never <jk>null</jk>.
*/
public String getType() {
@@ -167,14 +167,14 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Returns the <js>'q'</js> (quality) value for this type, as described in Section 3.9 of RFC2616.
- *
+ *
* <p>
* The quality value is a float between <code>0.0</code> (unacceptable) and <code>1.0</code> (most acceptable).
- *
+ *
* <p>
* If 'q' value doesn't make sense for the context (e.g. this range was extracted from a <js>"content-*"</js>
* header, as opposed to <js>"accept-*"</js> header, its value will always be <js>"1"</js>.
- *
+ *
* @return The 'q' value for this type, never <jk>null</jk>.
*/
public Float getQValue() {
@@ -183,10 +183,10 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Returns the optional set of custom extensions defined for this type.
- *
+ *
* <p>
* Values are lowercase and never <jk>null</jk>.
- *
+ *
* @return The optional list of extensions, never <jk>null</jk>.
*/
public Map<String,Set<String>> getExtensions() {
@@ -195,10 +195,10 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Provides a string representation of this media range, suitable for use as an <code>Accept</code> header value.
- *
+ *
* <p>
* The literal text generated will be all lowercase.
- *
+ *
* @return A media range suitable for use as an Accept header value, never <code>null</code>.
*/
@Override /* Object */
@@ -229,7 +229,7 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Returns <jk>true</jk> if the specified object is also a <code>MediaType</code>, and has the same qValue, type,
* parameters, and extensions.
- *
+ *
* @return <jk>true</jk> if object is equivalent.
*/
@Override /* Object */
@@ -249,7 +249,7 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Returns a hash based on this instance's <code>media-type</code>.
- *
+ *
* @return A hash based on this instance's <code>media-type</code>.
*/
@Override /* Object */
@@ -259,14 +259,14 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Compares two MediaRanges for equality.
- *
+ *
* <p>
* The values are first compared according to <code>qValue</code> values.
* Should those values be equal, the <code>type</code> is then lexicographically compared (case-insensitive) in
* ascending order, with the <js>"*"</js> type demoted last in that order.
* <code>TypeRanges</code> with the same types but with extensions are promoted over those same types with no
* extensions.
- *
+ *
* @param o The range to compare to. Never <jk>null</jk>.
*/
@Override /* Comparable */
@@ -285,10 +285,10 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Checks if the specified type matches this range.
- *
+ *
* <p>
* The type will match this range if the range type string is the same or <js>"*"</js>.
- *
+ *
* @param type The type to match against this range.
* @return <jk>true</jk> if the specified type matches this range.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TE.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TE.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TE.java
index e944191..e30087e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TE.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TE.java
@@ -18,35 +18,35 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>TE</l> HTTP request header.
- *
+ *
* <p>
* The transfer encodings the user agent is willing to accept: the same values as for the response header field
* Transfer-Encoding can be used, plus the "trailers" value (related to the "chunked" transfer method) to notify the
* server it expects to receive additional fields in the trailer after the last, zero-sized, chunk.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* TE: trailers, deflate
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The TE request-header field indicates what extension transfer-codings it is willing to accept in the response and
* whether or not it is willing to accept trailer fields in a chunked transfer-coding.
* Its value may consist of the keyword "trailers" and/or a comma-separated list of extension transfer-coding names
* with optional accept parameters (as described in section 3.6).
- *
+ *
* <p class='bcode'>
* TE = "TE" ":" #( t-codings )
* t-codings = "trailers" | ( transfer-extension [ accept-params ] )
* </p>
- *
+ *
* <p>
* The presence of the keyword "trailers" indicates that the client is willing to accept trailer fields in a chunked
* transfer-coding, as defined in section 3.6.1.
* This keyword is reserved for use with transfer-coding values even though it does not itself represent a
* transfer-coding.
- *
+ *
* <p>
* Examples of its use are:
* <p class='bcode'>
@@ -54,12 +54,12 @@ import org.apache.juneau.internal.*;
* TE:
* TE: trailers, deflate;q=0.5
* </p>
- *
+ *
* <p>
* The TE header field only applies to the immediate connection.
* Therefore, the keyword MUST be supplied within a Connection header field (section 14.10) whenever TE is present in
* an HTTP/1.1 message.
- *
+ *
* <p>
* A server tests whether a transfer-coding is acceptable, according to a TE field, using these rules:
* <ol>
@@ -77,11 +77,11 @@ import org.apache.juneau.internal.*;
* qvalue is preferred.
* The "chunked" transfer-coding always has a qvalue of 1.
* </ol>
- *
+ *
* <p>
* If the TE field-value is empty or if no TE field is present, the only transfer-coding is "chunked".
* A message with no transfer-coding is always acceptable.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -97,7 +97,7 @@ public final class TE extends HeaderRangeArray {
/**
* Returns a parsed <code>Accept</code> header.
- *
+ *
* @param value The <code>Accept</code> header string.
* @return The parsed <code>Accept</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Trailer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Trailer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Trailer.java
index 25167b5..a64f456 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Trailer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Trailer.java
@@ -14,34 +14,34 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Trailer</l> HTTP response header.
- *
+ *
* <p>
* The Trailer general field value indicates that the given set of header fields is present in the trailer of a message
* encoded with chunked transfer coding.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Trailer: Max-Forwards
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Trailer general field value indicates that the given set of header fields is present in the trailer of a message
* encoded with chunked transfer-coding.
- *
+ *
* <p class='bcode'>
* Trailer = "Trailer" ":" 1#field-name
* </p>
- *
+ *
* <p>
* An HTTP/1.1 message SHOULD include a Trailer header field in a message using chunked transfer-coding with a non-empty
* trailer.
* Doing so allows the recipient to know which header fields to expect in the trailer.
- *
+ *
* <p>
* If no Trailer header field is present, the trailer SHOULD NOT include any header fields.
* See section 3.6.1 for restrictions on the use of trailer fields in a "chunked" transfer-coding.
- *
+ *
* <p>
* Message header fields listed in the Trailer header field MUST NOT include the following header fields:
* <ul>
@@ -49,7 +49,7 @@ package org.apache.juneau.http;
* <li>Content-Length
* <li>Trailer
* </ul>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -63,7 +63,7 @@ public final class Trailer extends HeaderString {
/**
* Returns a parsed <code>Trailer</code> header.
- *
+ *
* @param value The <code>Trailer</code> header string.
* @return The parsed <code>Trailer</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TransferEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TransferEncoding.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TransferEncoding.java
index b5ee9f9..9b0a6a3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TransferEncoding.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TransferEncoding.java
@@ -14,42 +14,42 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Transfer-Encoding</l> HTTP response header.
- *
+ *
* <p>
* The form of encoding used to safely transfer the entity to the user.
* Currently defined methods are: chunked, compress, deflate, gzip, identity.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Transfer-Encoding: chunked
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Transfer-Encoding general-header field indicates what (if any) type of transformation has been applied to the
* message body in order to safely transfer it between the sender and the recipient.
* This differs from the content-coding in that the transfer-coding is a property of the message, not of the entity.
- *
+ *
* <p class='bcode'>
* Transfer-Encoding = "Transfer-Encoding" ":" 1#transfer-coding
* </p>
- *
+ *
* <p>
* Transfer-codings are defined in section 3.6. An example is:
- *
+ *
* <p class='bcode'>
* Transfer-Encoding: chunked
* </p>
- *
+ *
* <p>
* If multiple encodings have been applied to an entity, the transfer-codings MUST be listed in the order in which
* they were applied.
* Additional information about the encoding parameters MAY be provided by other entity-header fields not defined by
* this specification.
- *
+ *
* <p>
* Many older HTTP/1.0 applications do not understand the Transfer-Encoding header.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -63,7 +63,7 @@ public final class TransferEncoding extends HeaderString {
/**
* Returns a parsed <code>Transfer-Encoding</code> header.
- *
+ *
* @param value The <code>Transfer-Encoding</code> header string.
* @return The parsed <code>Transfer-Encoding</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Upgrade.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Upgrade.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Upgrade.java
index 655de91..330efaf 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Upgrade.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Upgrade.java
@@ -14,32 +14,32 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Upgrade</l> HTTP request header.
- *
+ *
* <p>
* Ask the client to upgrade to another protocol.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Upgrade: HTTP/2.0, HTTPS/1.3, IRC/6.9, RTA/x11, websocket
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Upgrade general-header allows the client to specify what additional communication protocols it supports and
* would like to use if the server finds it appropriate to switch protocols.
* The server MUST use the Upgrade header field within a 101 (Switching Protocols) response to indicate which
* protocol(s) are being switched.
- *
+ *
* <p class='bcode'>
* Upgrade = "Upgrade" ":" 1#product
* </p>
- *
+ *
* <p>
* For example,
* <p class='bcode'>
* Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11
* </p>
- *
+ *
* <p>
* The Upgrade header field is intended to provide a simple mechanism for transition from HTTP/1.1 to some other,
* incompatible protocol.
@@ -49,7 +49,7 @@ package org.apache.juneau.http;
* the more commonly supported protocol while indicating to the server that it would like to use a "better" protocol if
* available (where "better" is determined by the server, possibly according to the nature of the method and/or resource
* being requested).
- *
+ *
* <p>
* The Upgrade header field only applies to switching application-layer protocols upon the existing transport-layer
* connection.
@@ -57,22 +57,22 @@ package org.apache.juneau.http;
* The capabilities and nature of the application-layer communication after the protocol change is entirely dependent
* upon the new protocol chosen, although the first action after changing the protocol MUST be a response to the initial
* HTTP request containing the Upgrade header field.
- *
+ *
* <p>
* The Upgrade header field only applies to the immediate connection.
* Therefore, the upgrade keyword MUST be supplied within a Connection header field (section 14.10) whenever Upgrade is
* present in an HTTP/1.1 message.
- *
+ *
* <p>
* The Upgrade header field cannot be used to indicate a switch to a protocol on a different connection.
* For that purpose, it is more appropriate to use a 301, 302, 303, or 305 redirection response.
- *
+ *
* <p>
* This specification only defines the protocol name "HTTP" for use by the family of Hypertext Transfer Protocols, as
* defined by the HTTP version rules of section 3.1 and future updates to this specification.
* Any token can be used as a protocol name; however, it will only be useful if both the client and server associate
* the name with the same protocol.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -86,7 +86,7 @@ public final class Upgrade extends HeaderStringArray {
/**
* Returns a parsed <code>Upgrade</code> header.
- *
+ *
* @param value The <code>Upgrade</code> header string.
* @return The parsed <code>Upgrade</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/UserAgent.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/UserAgent.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/UserAgent.java
index 4f85e7e..6ecd07b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/UserAgent.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/UserAgent.java
@@ -14,17 +14,17 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>User-Agent</l> HTTP request header.
- *
+ *
* <p>
* The user agent string of the user agent.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:12.0) Gecko/20100101 Firefox/21.0
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The User-Agent request-header field contains information about the user agent originating the request.
* This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for
* the sake of tailoring responses to avoid particular user agent limitations.
@@ -32,17 +32,17 @@ package org.apache.juneau.http;
* The field can contain multiple product tokens (section 3.8) and comments identifying the agent and any sub-products
* which form a significant part of the user agent.
* By convention, the product tokens are listed in order of their significance for identifying the application.
- *
+ *
* <p class='bcode'>
* User-Agent = "User-Agent" ":" 1*( product | comment )
* </p>
- *
+ *
* <p>
* Example:
* <p class='bcode'>
* User-Agent: CERN-LineMode/2.15 libwww/2.17b3
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -56,7 +56,7 @@ public final class UserAgent extends HeaderString {
/**
* Returns a parsed <code>User-Agent</code> header.
- *
+ *
* @param value The <code>User-Agent</code> header string.
* @return The parsed <code>User-Agent</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Vary.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Vary.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Vary.java
index 1a8a1e0..0335755 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Vary.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Vary.java
@@ -14,19 +14,19 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Vary</l> HTTP response header.
- *
+ *
* <p>
* Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather
* than requesting a fresh one from the origin server.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Vary: *
* Vary: Accept-Language
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Vary field value indicates the set of request-header fields that fully determines, while the response is fresh,
* whether a cache is permitted to use the response to reply to a subsequent request without revalidation.
* For uncacheable or stale responses, the Vary field value advises the user agent about the criteria that were used to
@@ -37,7 +37,7 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Vary = "Vary" ":" ( "*" | 1#field-name )
* </p>
- *
+ *
* <p>
* An HTTP/1.1 server SHOULD include a Vary header field with any cacheable response that is subject to server-driven
* negotiation.
@@ -46,23 +46,23 @@ package org.apache.juneau.http;
* A server MAY include a Vary header field with a non-cacheable response that is subject to server-driven negotiation,
* since this might provide the user agent with useful information about the dimensions over which the response varies
* at the time of the response.
- *
+ *
* <p>
* A Vary field value consisting of a list of field-names signals that the representation selected for the response is
* based on a selection algorithm which considers ONLY the listed request-header field values in selecting the most
* appropriate representation.
* A cache MAY assume that the same selection will be made for future requests with the same values for the listed
* field names, for the duration of time for which the response is fresh.
- *
+ *
* <p>
* The field-names given are not limited to the set of standard request-header fields defined by this specification.
* Field names are case-insensitive.
- *
+ *
* <p>
* A Vary field value of "*" signals that unspecified parameters not limited to the request-headers (e.g., the network
* address of the client), play a role in the selection of the response representation.
* The "*" value MUST NOT be generated by a proxy server; it may only be generated by an origin server.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -76,7 +76,7 @@ public final class Vary extends HeaderString {
/**
* Returns a parsed <code>Vary</code> header.
- *
+ *
* @param value The <code>Vary</code> header string.
* @return The parsed <code>Vary</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Via.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Via.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Via.java
index 2b300fc..0f6c943 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Via.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Via.java
@@ -14,33 +14,33 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Via</l> HTTP response header.
- *
+ *
* <p>
* Informs the client of proxies through which the response was sent.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Via: 1.0 fred, 1.1 example.com (Apache/1.1)
* </p>
- *
+ *
* <p>
* Informs the client of proxies through which the response was sent.
- *
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Via: 1.0 fred, 1.1 example.com (Apache/1.1)
* </p>
- *
+ *
* <p>
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Via general-header field MUST be used by gateways and proxies to indicate the intermediate protocols and
* recipients between the user agent and the server on requests, and between the origin server and the client on
* responses.
* It is analogous to the "Received" field of RFC 822 and is intended to be used for tracking message forwards,
* avoiding request loops, and identifying the protocol capabilities of all senders along the request/response chain.
- *
+ *
* <p class='bcode'>
* Via = "Via" ":" 1#( received-protocol received-by [ comment ] )
* received-protocol = [ protocol-name "/" ] protocol-version
@@ -49,31 +49,31 @@ package org.apache.juneau.http;
* received-by = ( host [ ":" port ] ) | pseudonym
* pseudonym = token
* </p>
- *
+ *
* <p>
* The received-protocol indicates the protocol version of the message received by the server or client along each
* segment of the request/response chain.
* The received-protocol version is appended to the Via field value when the message is forwarded so that information
* about the protocol capabilities of upstream applications remains visible to all recipients.
- *
+ *
* <p>
* The protocol-name is optional if and only if it would be "HTTP".
* The received-by field is normally the host and optional port number of a recipient server or client that subsequently
* forwarded the message.
* However, if the real host is considered to be sensitive information, it MAY be replaced by a pseudonym.
* If the port is not given, it MAY be assumed to be the default port of the received-protocol.
- *
+ *
* <p>
* Multiple Via field values represents each proxy or gateway that has forwarded the message.
* Each recipient MUST append its information such that the end result is ordered according to the sequence of
* forwarding applications.
- *
+ *
* <p>
* Comments MAY be used in the Via header field to identify the software of the recipient proxy or gateway, analogous
* to the User-Agent and Server header fields.
* However, all comments in the Via field are optional and MAY be removed by any recipient prior to forwarding the
* message.
- *
+ *
* <p>
* For example, a request message could be sent from an HTTP/1.0 user agent to an internal proxy code-named "fred",
* which uses HTTP/1.1 to forward the request to a public proxy at nowhere.com, which completes the request by
@@ -82,14 +82,14 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1)
* </p>
- *
+ *
* <p>
* Proxies and gateways used as a portal through a network firewall SHOULD NOT, by default, forward the names and ports
* of hosts within the firewall region.
* This information SHOULD only be propagated if explicitly enabled.
* If not enabled, the received-by host of any host behind the firewall SHOULD be replaced by an appropriate pseudonym
* for that host.
- *
+ *
* <p>
* For organizations that have strong privacy requirements for hiding internal structures, a proxy MAY combine an
* ordered subsequence of Via header field entries with identical received-protocol values into a single such entry.
@@ -97,18 +97,18 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Via: 1.0 ricky, 1.1 ethel, 1.1 fred, 1.0 lucy
* </p>
- *
+ *
* <p>
* ...could be collapsed to...
* <p class='bcode'>
* Via: 1.0 ricky, 1.1 mertz, 1.0 lucy
* </p>
- *
+ *
* <p>
* Applications SHOULD NOT combine multiple entries unless they are all under the same organizational control and the
* hosts have already been replaced by pseudonyms.
* Applications MUST NOT combine entries which have different received-protocol values.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -122,7 +122,7 @@ public final class Via extends HeaderStringArray {
/**
* Returns a parsed <code>Via</code> header.
- *
+ *
* @param value The <code>Via</code> header string.
* @return The parsed <code>Via</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Warning.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Warning.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Warning.java
index d972396..a2eeed0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Warning.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Warning.java
@@ -14,22 +14,22 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Warning</l> HTTP request/response header.
- *
+ *
* <p>
* A general warning about possible problems with the entity body.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Warning: 199 Miscellaneous warning
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Warning general-header field is used to carry additional information about the status or transformation of a
* message which might not be reflected in the message.
* This information is typically used to warn about a possible lack of semantic transparency from caching operations
* or transformations applied to the entity body of the message.
- *
+ *
* <p>
* Warning headers are sent with responses using:
* <p class='bcode'>
@@ -43,21 +43,21 @@ package org.apache.juneau.http;
* warn-text = quoted-string
* warn-date = <"> HTTP-date <">
* </p>
- *
+ *
* <p>
* A response MAY carry more than one Warning header.
- *
+ *
* <p>
* The warn-text SHOULD be in a natural language and character set that is most likely to be intelligible to the human
* user receiving the response.
* This decision MAY be based on any available knowledge, such as the location of the cache or user, the
* Accept-Language field in a request, the Content-Language field in a response, etc.
* The default language is English and the default character set is ISO-8859-1.
- *
+ *
* <p>
* If a character set other than ISO-8859-1 is used, it MUST be encoded in the warn-text using the method described in
* RFC 2047.
- *
+ *
* <p>
* Warning headers can in general be applied to any message, however some specific warn-codes are specific to caches
* and can only be applied to response messages.
@@ -67,7 +67,7 @@ package org.apache.juneau.http;
* to that entry except as specified for specific Warning codes.
* It MUST then add any Warning headers received in the validating response.
* In other words, Warning headers are those that would be attached to the most recent relevant response.
- *
+ *
* <p>
* When multiple Warning headers are attached to a response, the user agent ought to inform the user of as many of them
* as possible, in the order that they appear in the response.
@@ -77,13 +77,13 @@ package org.apache.juneau.http;
* <li>Warnings in the user's preferred character set take priority over warnings in other character sets but with
* identical warn-codes and warn-agents.
* </ul>
- *
+ *
* <p>
* Systems that generate multiple Warning headers SHOULD order them with this user agent behavior in mind.
- *
+ *
* <p>
* Requirements for the behavior of caches with respect to Warnings are stated in section 13.1.2.
- *
+ *
* <p>
* This is a list of the currently-defined warn-codes, each with a recommended warn-text in English, and a description
* of its meaning.
@@ -105,18 +105,18 @@ package org.apache.juneau.http;
* <li>299 Miscellaneous persistent warning The warning text MAY include arbitrary information to be presented to a
* human user, or logged. A system receiving this warning MUST NOT take any automated action.
* </ul>
- *
+ *
* <p>
* If an implementation sends a message with one or more Warning headers whose version is HTTP/1.0 or lower, then the
* sender MUST include in each warning-value a warn-date that matches the date in the response.
- *
+ *
* <p>
* If an implementation receives a message with a warning-value that includes a warn-date, and that warn-date is
* different from the Date value in the response, then that warning-value MUST be deleted from the message before
* storing, forwarding, or using it.
* (This prevents bad consequences of naive caching of Warning header fields.)
* If all of the warning-values are deleted for this reason, the Warning header MUST be deleted as well.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -130,7 +130,7 @@ public final class Warning extends HeaderString {
/**
* Returns a parsed <code>Warning</code> header.
- *
+ *
* @param value The <code>Warning</code> header string.
* @return The parsed <code>Warning</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/WwwAuthenticate.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
index bbfacd6..d336783 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
@@ -14,31 +14,31 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>WWW-Authenticate </l> HTTP response header.
- *
+ *
* <p>
* Indicates the authentication scheme that should be used to access the requested entity.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* WWW-Authenticate: Basic
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The WWW-Authenticate response-header field MUST be included in 401 (Unauthorized) response messages.
* The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters
* applicable to the Request-URI.
- *
+ *
* <p class='bcode'>
* WWW-Authenticate = "WWW-Authenticate" ":" 1#challenge
* </p>
- *
+ *
* <p>
* The HTTP access authentication process is described in "HTTP Authentication: Basic and Digest Access Authentication".
* User agents are advised to take special care in parsing the WWW-Authenticate field value as it might contain more
* than one challenge, or if more than one WWW-Authenticate header field is provided, the contents of a challenge
* itself can contain a comma-separated list of authentication parameters.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -52,7 +52,7 @@ public final class WwwAuthenticate extends HeaderString {
/**
* Returns a parsed <code>WWW-Authenticate</code> header.
- *
+ *
* @param value The <code>WWW-Authenticate</code> header string.
* @return The parsed <code>WWW-Authenticate</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartParser.java
index 428445a..9df3428 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartParser.java
@@ -17,7 +17,7 @@ import org.apache.juneau.parser.*;
/**
* Interface used to convert HTTP headers, query parameters, form-data parameters, and URI path variables to POJOs
- *
+ *
* <p>
* The following default implementations are provided:
* <ul class='doctree'>
@@ -41,7 +41,7 @@ public interface HttpPartParser {
/**
* Converts the specified input to the specified class type.
- *
+ *
* @param partType The part type being parsed.
* @param in The input being parsed.
* @param type The category of value being parsed.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSerializer.java
index b2902d9..27577b0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSerializer.java
@@ -18,7 +18,7 @@ import org.apache.juneau.remoteable.*;
/**
* Interface used to convert POJOs to simple strings in HTTP headers, query parameters, form-data parameters, and URI
* path variables.
- *
+ *
* <p>
* The following default implementations are provided:
* <ul class='doctree'>
@@ -41,7 +41,7 @@ import org.apache.juneau.remoteable.*;
* <li class='ja'>{@link RequestBean#serializer()}
* <li class='jc'><code>RestClientBuilder.partSerializer(Class)</code>
* </ul>
- *
+ *
* <p>
* Implementations must include either a public no-args constructor or a public constructor that takes in a single
* {@link PropertyStore} object.
@@ -59,10 +59,10 @@ public interface HttpPartSerializer {
/**
* Converts the specified value to a string that can be used as an HTTP header value, query parameter value,
* form-data parameter, or URI path variable.
- *
+ *
* <p>
* Returned values should NOT be URL-encoded.
- *
+ *
* @param type The category of value being serialized.
* @param value The value being serialized.
* @return The serialized value.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializer.java
index fe2ca70..b69b16f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializer.java
@@ -44,7 +44,7 @@ public class SimpleUonPartSerializer extends UonPartSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java
index 8039c5a..50261e3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java
@@ -33,7 +33,7 @@ public class SimpleUonPartSerializerBuilder extends UonPartSerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public SimpleUonPartSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParser.java
index 78ae8b4..ec8d320 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParser.java
@@ -41,7 +41,7 @@ public class UonPartParser extends UonParser implements HttpPartParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public UonPartParser(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java
index 5a3007d..99a7900 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java
@@ -35,7 +35,7 @@ public class UonPartParserBuilder extends UonParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public UonPartParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java
index dec921a..0d9ed56 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java
@@ -41,7 +41,7 @@ public class UonPartSerializer extends UonSerializer implements HttpPartSerializ
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java
index a20fef6..7ab3aba 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java
@@ -33,7 +33,7 @@ public class UonPartSerializerBuilder extends UonSerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public UonPartSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ArrayUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ArrayUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ArrayUtils.java
index 9bb852e..7c60001 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ArrayUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ArrayUtils.java
@@ -24,7 +24,7 @@ public final class ArrayUtils {
/**
* Appends one or more elements to an array.
- *
+ *
* @param <T> The element type.
* @param array The array to append to.
* @param newElements The new elements to append to the array.
@@ -46,7 +46,7 @@ public final class ArrayUtils {
/**
* Appends one or more elements to an array.
- *
+ *
* @param <T> The element type.
* @param array The array to append to.
* @param newElements The new elements to append to the array.
@@ -68,7 +68,7 @@ public final class ArrayUtils {
/**
* Combine an arbitrary number of arrays into a single array.
- *
+ *
* @param arrays Collection of arrays to combine.
* @return A new combined array, or <jk>null</jk> if all arrays are <jk>null</jk>.
*/
@@ -95,7 +95,7 @@ public final class ArrayUtils {
/**
* Creates a new array with reversed entries.
- *
+ *
* @param <T> The class type of the array.
* @param array The array to reverse.
* @return A new array with reversed entries, or <jk>null</jk> if the array was <jk>null</jk>.
@@ -131,10 +131,10 @@ public final class ArrayUtils {
/**
* Converts the specified array to a <code>Set</code>.
- *
+ *
* <p>
* The order of the entries in the set are the same as the array.
- *
+ *
* @param <T> The entry type of the array.
* @param array The array being wrapped in a <code>Set</code> interface.
* @return The new set.
@@ -178,11 +178,11 @@ public final class ArrayUtils {
/**
* Returns an iterator against an array.
- *
+ *
* <p>
* This works with any array type (e.g. <code>String[]</code>, <code>Object[]</code>,
* <code><jk>int</jk>[]</code>, etc...).
- *
+ *
* @param array The array to create an iterator over.
* @return An iterator over the specified array.
*/
@@ -212,10 +212,10 @@ public final class ArrayUtils {
/**
* Converts the specified collection to an array.
- *
+ *
* <p>
* Works on both object and primitive arrays.
- *
+ *
* @param c The collection to convert to an array.
* @param componentType The component type of the collection.
* @return A new array.
@@ -231,7 +231,7 @@ public final class ArrayUtils {
/**
* Returns <jk>true</jk> if the specified object is an array.
- *
+ *
* @param array The array to test.
* @return <jk>true</jk> if the specified object is an array.
*/
@@ -241,7 +241,7 @@ public final class ArrayUtils {
/**
* Converts the specified array to an <code>ArrayList</code>
- *
+ *
* @param array The array to convert.
* @param componentType
* The type of objects in the array.
@@ -258,7 +258,7 @@ public final class ArrayUtils {
/**
* Shortcut for calling <code>myList.toArray(new T[myList.size()]);</code>
- *
+ *
* @param c The collection being converted to an array.
* @param componentType The component type of the array.
* @return The collection converted to an array.
@@ -275,10 +275,10 @@ public final class ArrayUtils {
/**
* Copies the specified array into the specified list.
- *
+ *
* <p>
* Works on both object and primitive arrays.
- *
+ *
* @param array The array to copy into a list.
* @param list The list to copy the values into.
* @return The same list passed in.
@@ -296,7 +296,7 @@ public final class ArrayUtils {
/**
* Returns <jk>true</jk> if the specified array contains the specified element using the {@link Object#equals(Object)}
* method.
- *
+ *
* @param element The element to check for.
* @param array The array to check.
* @return
@@ -309,7 +309,7 @@ public final class ArrayUtils {
/**
* Returns the index position of the element in the specified array using the {@link Object#equals(Object)} method.
- *
+ *
* @param element The element to check for.
* @param array The array to check.
* @return
@@ -330,7 +330,7 @@ public final class ArrayUtils {
/**
* Returns <jk>true</jk> if the specified array contains the specified element using the {@link String#equals(Object)}
* method.
- *
+ *
* @param element The element to check for.
* @param array The array to check.
* @return
@@ -343,7 +343,7 @@ public final class ArrayUtils {
/**
* Returns the index position of the element in the specified array using the {@link String#equals(Object)} method.
- *
+ *
* @param element The element to check for.
* @param array The array to check.
* @return
@@ -363,7 +363,7 @@ public final class ArrayUtils {
/**
* Converts a primitive wrapper array (e.g. <code>Integer[]</code>) to a primitive array (e.g. <code><jk>int</jk>[]</code>).
- *
+ *
* @param o The array to convert. Must be a primitive wrapper array.
* @return A new array.
* @throws IllegalArgumentException If object is not a wrapper object array.
@@ -384,7 +384,7 @@ public final class ArrayUtils {
/**
* Converts an Iterable to a list.
- *
+ *
* @param i The iterable to convert.
* @return A new list of objects copied from the iterable.
*/
@@ -398,7 +398,7 @@ public final class ArrayUtils {
/**
* Returns the first object in the specified collection or array.
- *
+ *
* @param val The collection or array object.
* @return
* The first object, or <jk>null</jk> if the collection or array is empty or <jk>null</jk> or the value
@@ -420,11 +420,11 @@ public final class ArrayUtils {
/**
* Converts the specified collection to an array of strings.
- *
+ *
* <p>
* Entries are converted to strings using {@link #toString()}.
* <jk>null</jk> values remain <jk>null</jk>.
- *
+ *
* @param c The collection to convert.
* @return The collection as a string array.
*/
@@ -438,7 +438,7 @@ public final class ArrayUtils {
/**
* Returns <jk>true</jk> if the following sorted arrays are equals.
- *
+ *
* @param a1 Array #1.
* @param a2 Array #2.
* @return <jk>true</jk> if the following sorted arrays are equals.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiMap.java
index 4f63f77..645cc91 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiMap.java
@@ -20,7 +20,7 @@ public final class AsciiMap {
/**
* Adds an entry to this map.
- *
+ *
* @param c The key.
* @param s The value.
* @return This object (for method chaining).
@@ -33,7 +33,7 @@ public final class AsciiMap {
/**
* Returns the value for the specified key.
- *
+ *
* @param c The key.
* @return The value.
*/
@@ -43,7 +43,7 @@ public final class AsciiMap {
/**
* Returns <jk>true</jk> if the specified character is in this store.
- *
+ *
* @param c The character to check.
* @return <jk>true</jk> if the specified character is in this store.
*/
@@ -55,7 +55,7 @@ public final class AsciiMap {
/**
* Returns <jk>true</jk> if the specified character is in this store.
- *
+ *
* @param c The character to check.
* @return <jk>true</jk> if the specified character is in this store.
*/
@@ -67,7 +67,7 @@ public final class AsciiMap {
/**
* Returns <jk>true</jk> if the specified string contains at least one character in this set.
- *
+ *
* @param s The string to test.
* @return <jk>true</jk> if the string is not null and contains at least one character in this set.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiSet.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiSet.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiSet.java
index 7f84418..87439bd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiSet.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiSet.java
@@ -20,7 +20,7 @@ public final class AsciiSet {
/**
* Constructor.
- *
+ *
* @param chars The characters to keep in this store.
*/
public AsciiSet(String chars) {
@@ -33,7 +33,7 @@ public final class AsciiSet {
/**
* Returns <jk>true</jk> if the specified character is in this store.
- *
+ *
* @param c The character to check.
* @return <jk>true</jk> if the specified character is in this store.
*/
@@ -45,7 +45,7 @@ public final class AsciiSet {
/**
* Returns <jk>true</jk> if the specified character is in this store.
- *
+ *
* @param c The character to check.
* @return <jk>true</jk> if the specified character is in this store.
*/
@@ -57,7 +57,7 @@ public final class AsciiSet {
/**
* Returns <jk>true</jk> if the specified string contains at least one character in this set.
- *
+ *
* @param s The string to test.
* @return <jk>true</jk> if the string is not null and contains at least one character in this set.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayCache.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
index dc90746..ff77624 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
@@ -23,7 +23,7 @@ public class ByteArrayCache {
/**
* Default global byte array cache.
- *
+ *
* <p>
* Note that this can't ever get garbage collected so don't add really large arrays!
*/
@@ -33,7 +33,7 @@ public class ByteArrayCache {
/**
* Add the specified byte array to this cache.
- *
+ *
* @param contents The byte array to add to this cache.
* @return
* Either the same byte array or a previously cached byte array depending on whether the byte array already
@@ -49,7 +49,7 @@ public class ByteArrayCache {
/**
* Add the specified input stream to this cache.
- *
+ *
* @param contents The input stream whose contents are to be added to this cache.
* @return
* Either the same byte array or a previously cached byte array depending on whether the byte array already
@@ -66,7 +66,7 @@ public class ByteArrayCache {
/**
* Returns the number of byte arrays in this cache.
- *
+ *
* @return The number of byte arrays in this cache.
*/
public int size() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayInOutStream.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayInOutStream.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayInOutStream.java
index 62b9e19..8e8c569 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayInOutStream.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayInOutStream.java
@@ -21,7 +21,7 @@ public class ByteArrayInOutStream extends ByteArrayOutputStream {
/**
* Creates a new input stream from this object.
- *
+ *
* @return A new input stream from this object.
*/
public ByteArrayInputStream getInputStream() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Cache.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Cache.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Cache.java
index 65bf6f6..1964c02 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Cache.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Cache.java
@@ -16,10 +16,10 @@ import java.util.concurrent.*;
/**
* Simple in-memory cache of objects.
- *
+ *
* <p>
* Essentially just a wrapper around a ConcurrentHashMap.
- *
+ *
* @param <K> The key type.
* @param <V> The value type.
*/
@@ -30,7 +30,7 @@ public class Cache<K,V> {
/**
* Constructor.
- *
+ *
* @param disabled If <jk>true</jk> then the cache is disabled.
* @param maxSize The maximum size of the cache. If this threshold is reached, the cache is flushed.
*/
@@ -45,7 +45,7 @@ public class Cache<K,V> {
/**
* Retrieves the value with the specified key from this cache.
- *
+ *
* @param key The key.
* @return The value, or <jk>null</jk> if the value is not in the cache, or the cache is disabled.
*/
@@ -57,7 +57,7 @@ public class Cache<K,V> {
/**
* Adds the value with the specified key to this cache.
- *
+ *
* @param key The key.
* @param value The value.
* @return
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CharSequenceReader.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CharSequenceReader.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CharSequenceReader.java
index bfe877c..d607fc7 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CharSequenceReader.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CharSequenceReader.java
@@ -28,7 +28,7 @@ public final class CharSequenceReader extends BufferedReader {
/**
* Constructor.
- *
+ *
* @param cs The char sequence to read from. Can be <jk>null</jk>.
*/
public CharSequenceReader(CharSequence cs) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java
index 8e002f0..936f80d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java
@@ -54,7 +54,7 @@ public final class ClassUtils {
/**
* Given the specified list of objects, return readable names for the class types of the objects.
- *
+ *
* @param o The objects.
* @return An array of readable class type strings.
*/
@@ -67,7 +67,7 @@ public final class ClassUtils {
/**
* Shortcut for calling <code><jsm>getReadableClassName</jsm>(c.getName())</code>
- *
+ *
* @param c The class.
* @return A readable class type name, or <jk>null</jk> if parameter is <jk>null</jk>.
*/
@@ -79,7 +79,7 @@ public final class ClassUtils {
/**
* Shortcut for calling <code><jsm>getReadableClassName</jsm>(c.getClass().getName())</code>
- *
+ *
* @param o The object whose class we want to render.
* @return A readable class type name, or <jk>null</jk> if parameter is <jk>null</jk>.
*/
@@ -91,7 +91,7 @@ public final class ClassUtils {
/**
* Converts the specified class name to a readable form when class name is a special construct like <js>"[[Z"</js>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jsm>getReadableClassName</jsm>(<js>"java.lang.Object"</js>); <jc>// Returns "java.lang.Object"</jc>
@@ -101,7 +101,7 @@ public final class ClassUtils {
* <jsm>getReadableClassName</jsm>(<js>"[Ljava.lang.Object;"</js>); <jc>// Returns "java.lang.Object[]"</jc>
* <jsm>getReadableClassName</jsm>(<jk>null</jk>); <jc>// Returns null</jc>
* </p>
- *
+ *
* @param className The class name.
* @return A readable class type name, or <jk>null</jk> if parameter is <jk>null</jk>.
*/
@@ -138,10 +138,10 @@ public final class ClassUtils {
/**
* Converts the string generated by {@link #getReadableClassName(Class)} back into a {@link Class}.
- *
+ *
* <p>
* Generics are stripped from the string since they cannot be converted to a class.
- *
+ *
* @param cl The classloader to use to load the class.
* @param name The readable class name.
* @return The class object.
@@ -153,7 +153,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if <code>parent</code> is a parent class of <code>child</code>.
- *
+ *
* @param parent The parent class.
* @param child The child class.
* @param strict If <jk>true</jk> returns <jk>false</jk> if the classes are the same.
@@ -165,7 +165,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if <code>parent</code> is a parent class or the same as <code>child</code>.
- *
+ *
* @param parent The parent class.
* @param child The child class.
* @return <jk>true</jk> if <code>parent</code> is a parent class or the same as <code>child</code>.
@@ -176,7 +176,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if <code>parent</code> is a parent class or the same as <code>child</code>.
- *
+ *
* @param parent The parent class.
* @param child The child class.
* @return <jk>true</jk> if <code>parent</code> is a parent class or the same as <code>child</code>.
@@ -189,12 +189,12 @@ public final class ClassUtils {
/**
* Returns the signature of the specified method.
- *
+ *
* <p>
* For no-arg methods, the signature will be a simple string such as <js>"toString"</js>.
* For methods with one or more args, the arguments will be fully-qualified class names (e.g.
* <js>"append(java.util.StringBuilder,boolean)"</js>)
- *
+ *
* @param m The methods to get the signature on.
* @return The methods signature.
*/
@@ -238,7 +238,7 @@ public final class ClassUtils {
/**
* If the specified class is a primitive (e.g. <code><jk>int</jk>.<jk>class</jk></code>) returns it's wrapper class
* (e.g. <code>Integer.<jk>class</jk></code>).
- *
+ *
* @param c The class.
* @return The wrapper class, or <jk>null</jk> if class is not a primitive.
*/
@@ -249,7 +249,7 @@ public final class ClassUtils {
/**
* If the specified class is a primitive wrapper (e.g. <code><jk>Integer</jk>.<jk>class</jk></code>) returns it's
* primitive class (e.g. <code>int.<jk>class</jk></code>).
- *
+ *
* @param c The class.
* @return The primitive class, or <jk>null</jk> if class is not a primitive wrapper.
*/
@@ -260,7 +260,7 @@ public final class ClassUtils {
/**
* If the specified class is a primitive (e.g. <code><jk>int</jk>.<jk>class</jk></code>) returns it's wrapper class
* (e.g. <code>Integer.<jk>class</jk></code>).
- *
+ *
* @param c The class.
* @return The wrapper class if it's primitive, or the same class if class is not a primitive.
*/
@@ -272,7 +272,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified class has the {@link Deprecated @Deprecated} annotation on it.
- *
+ *
* @param c The class.
* @return <jk>true</jk> if the specified class has the {@link Deprecated @Deprecated} annotation on it.
*/
@@ -282,7 +282,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified method has the {@link Deprecated @Deprecated} annotation on it.
- *
+ *
* @param m The method.
* @return <jk>true</jk> if the specified method has the {@link Deprecated @Deprecated} annotation on it.
*/
@@ -293,7 +293,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified constructor has the {@link Deprecated @Deprecated} annotation on it.
- *
+ *
* @param c The constructor.
* @return <jk>true</jk> if the specified constructor has the {@link Deprecated @Deprecated} annotation on it.
*/
@@ -303,7 +303,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified class is public.
- *
+ *
* @param c The class.
* @return <jk>true</jk> if the specified class is public.
*/
@@ -313,7 +313,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified class is public.
- *
+ *
* @param c The class.
* @return <jk>true</jk> if the specified class is public.
*/
@@ -323,7 +323,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified class is abstract.
- *
+ *
* @param c The class.
* @return <jk>true</jk> if the specified class is abstract.
*/
@@ -333,7 +333,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified method is public.
- *
+ *
* @param m The method.
* @return <jk>true</jk> if the specified method is public.
*/
@@ -343,7 +343,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified method is static.
- *
+ *
* @param m The method.
* @return <jk>true</jk> if the specified method is static.
*/
@@ -353,7 +353,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified constructor is public.
- *
+ *
* @param c The constructor.
* @return <jk>true</jk> if the specified constructor is public.
*/
@@ -363,16 +363,16 @@ public final class ClassUtils {
/**
* Returns the specified annotation on the specified method.
- *
+ *
* <p>
* Similar to {@link Method#getAnnotation(Class)}, but searches up the parent hierarchy for the annotation
* defined on parent classes and interfaces.
- *
+ *
* <p>
* Normally, annotations defined on methods of parent classes and interfaces are not inherited by the child methods.
* This utility method gets around that limitation by searching the class hierarchy for the "same" method
* (i.e. the same name and arguments).
- *
+ *
* @param a The annotation to search for.
* @param m The method to search.
* @return The annotation, or <jk>null</jk> if it wasn't found.
@@ -383,16 +383,16 @@ public final class ClassUtils {
/**
* Returns the specified annotation on the specified method.
- *
+ *
* <p>
* Similar to {@link Method#getAnnotation(Class)}, but searches up the parent hierarchy for the annotation defined
* on parent classes and interfaces.
- *
+ *
* <p>
* Normally, annotations defined on methods of parent classes and interfaces are not inherited by the child methods.
* This utility method gets around that limitation by searching the class hierarchy for the "same" method
* (i.e. the same name and arguments).
- *
+ *
* @param a The annotation to search for.
* @param c
* The child class to start searching from.
@@ -429,12 +429,12 @@ public final class ClassUtils {
/**
* Locates the no-arg constructor for the specified class.
- *
+ *
* <p>
* Constructor must match the visibility requirements specified by parameter 'v'.
* If class is abstract, always returns <jk>null</jk>.
* Note that this also returns the 1-arg constructor for non-static member classes.
- *
+ *
* @param c The class from which to locate the no-arg constructor.
* @param v The minimum visibility.
* @return The constructor, or <jk>null</jk> if no no-arg constructor exists with the required visibility.
@@ -455,7 +455,7 @@ public final class ClassUtils {
/**
* Finds the real parameter type of the specified class.
- *
+ *
* @param c The class containing the parameters (e.g. PojoSwap<T,S>)
* @param index The zero-based index of the parameter to resolve.
* @param oc The class we're trying to resolve the parameter type for.
@@ -546,7 +546,7 @@ public final class ClassUtils {
/**
* Finds a public method with the specified parameters.
- *
+ *
* @param c The class to look for the method.
* @param name The method name.
* @param returnType
@@ -574,7 +574,7 @@ public final class ClassUtils {
/**
* Finds a public constructor with the specified parameters without throwing an exception.
- *
+ *
* @param c The class to search for a constructor.
* @param fuzzyArgs
* Use fuzzy-arg matching.
@@ -666,7 +666,7 @@ public final class ClassUtils {
/**
* Finds the public constructor that can take in the specified arguments.
- *
+ *
* @param c The class we're trying to construct.
* @param args The arguments we want to pass into the constructor.
* @return
@@ -679,7 +679,7 @@ public final class ClassUtils {
/**
* Finds the public constructor that can take in the specified arguments.
- *
+ *
* @param c The class we're trying to construct.
* @param args The argument types we want to pass into the constructor.
* @return
@@ -692,7 +692,7 @@ public final class ClassUtils {
/**
* Finds the public constructor that can take in the specified arguments.
- *
+ *
* @param c The class we're trying to construct.
* @param fuzzyArgs
* Use fuzzy-arg matching.
@@ -708,7 +708,7 @@ public final class ClassUtils {
/**
* Returns the class types for the specified arguments.
- *
+ *
* @param args The objects we're getting the classes of.
* @return The classes of the arguments.
*/
@@ -721,7 +721,7 @@ public final class ClassUtils {
/**
* Returns a {@link MethodInfo} bean that describes the specified method.
- *
+ *
* @param m The method to describe.
* @return The bean with information about the method.
*/
@@ -731,7 +731,7 @@ public final class ClassUtils {
/**
* Returns {@link MethodInfo} beans that describe the specified methods.
- *
+ *
* @param m The methods to describe.
* @return The beans with information about the methods.
*/
@@ -764,7 +764,7 @@ public final class ClassUtils {
/**
* Creates an instance of the specified class.
- *
+ *
* @param c
* The class to cast to.
* @param c2
@@ -781,7 +781,7 @@ public final class ClassUtils {
/**
* Creates an instance of the specified class.
- *
+ *
* @param c
* The class to cast to.
* @param c2
@@ -882,10 +882,10 @@ public final class ClassUtils {
/**
* Returns all the fields in the specified class and all parent classes.
- *
+ *
* <p>
* Fields are ordered in either parent-to-child, or child-to-parent order, then alphabetically.
- *
+ *
* @param c The class to get all fields on.
* @param parentFirst Order them in parent-class-to-child-class order, otherwise child-class-to-parent-class order.
* @return An iterable of all fields in the specified class.
@@ -940,10 +940,10 @@ public final class ClassUtils {
/**
* Returns all the methods in the specified class and all parent classes.
- *
+ *
* <p>
* Methods are ordered in either parent-to-child, or child-to-parent order, then alphabetically.
- *
+ *
* @param c The class to get all methods on.
* @param parentFirst Order them in parent-class-to-child-class order, otherwise child-class-to-parent-class order.
* @return An iterable of all methods in the specified class.
@@ -1015,7 +1015,7 @@ public final class ClassUtils {
/**
* Sorts methods in alphabetical order.
- *
+ *
* @param m The methods to sort.
* @return The same array, but with elements sorted.
*/
@@ -1034,7 +1034,7 @@ public final class ClassUtils {
/**
* Sorts methods in alphabetical order.
- *
+ *
* @param m The methods to sort.
* @return The same array, but with elements sorted.
*/
@@ -1045,7 +1045,7 @@ public final class ClassUtils {
/**
* Returns a list of all the parent classes of the specified class including the class itself.
- *
+ *
* @param c The class to retrieve the parent classes.
* @param parentFirst In parent-to-child order, otherwise child-to-parent.
* @param includeInterfaces Include interfaces.
@@ -1077,7 +1077,7 @@ public final class ClassUtils {
/**
* Returns the default value for the specified primitive class.
- *
+ *
* @param primitiveClass The primitive class to get the default value for.
* @return The default value, or <jk>null</jk> if the specified class is not a primitive class.
*/
@@ -1107,10 +1107,10 @@ public final class ClassUtils {
/**
* Returns a readable representation of the specified method.
- *
+ *
* <p>
* The format of the string is <js>"full-qualified-class.method-name(parameter-simple-class-names)"</js>.
- *
+ *
* @param m The method to stringify.
* @return The stringified method.
*/
@@ -1127,10 +1127,10 @@ public final class ClassUtils {
/**
* Returns a readable representation of the specified field.
- *
+ *
* <p>
* The format of the string is <js>"full-qualified-class.field-name"</js>.
- *
+ *
* @param f The field to stringify.
* @return The stringified field.
*/
@@ -1140,7 +1140,7 @@ public final class ClassUtils {
/**
* Throws an {@link IllegalArgumentException} if the parameters on the method are not in the specified list provided.
- *
+ *
* @param m The method to test.
* @param args The valid class types (exact) for the arguments.
* @throws FormattedIllegalArgumentException If any of the parameters on the method weren't in the list.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CollectionUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CollectionUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CollectionUtils.java
index 7bb2e50..a71ea97 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CollectionUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CollectionUtils.java
@@ -25,7 +25,7 @@ public final class CollectionUtils {
/**
* Reverses the order of a {@link LinkedHashMap}.
- *
+ *
* @param in The map to reverse the order on.
* @return A new {@link LinkedHashMap} with keys in reverse order.
*/
@@ -46,7 +46,7 @@ public final class CollectionUtils {
/**
* Add a value to a list if the value is not null.
- *
+ *
* @param l The list to add to.
* @param o The element to add.
* @return The same list.
@@ -59,10 +59,10 @@ public final class CollectionUtils {
/**
* Adds the contents of one list to the other in reverse order.
- *
+ *
* <p>
* i.e. add values from 2nd list from end-to-start order to the end of the 1st list.
- *
+ *
* @param list The list to append to.
* @param append Contains the values to append to the list.
* @return The same list.
@@ -76,10 +76,10 @@ public final class CollectionUtils {
/**
* Adds the contents of the array to the list in reverse order.
- *
+ *
* <p>
* i.e. add values from the array from end-to-start order to the end of the list.
- *
+ *
* @param list The list to append to.
* @param append Contains the values to append to the list.
* @return The same list.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java
index e37cabe..57cfce3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java
@@ -20,10 +20,10 @@ import javax.xml.bind.*;
/**
* A utility class for parsing and formatting HTTP dates as used in cookies and other headers.
- *
+ *
* <p>
* This class handles dates as defined by RFC 2616 section 3.3.1 as well as some other common non-standard formats.
- *
+ *
* <p>
* This class was copied from HttpClient 4.3.
*/
@@ -56,7 +56,7 @@ public final class DateUtils {
/**
* Parses a date value. The formats used for parsing the date value are retrieved from the default http params.
- *
+ *
* @param dateValue the date value to parse
* @return the parsed date or null if input could not be parsed
*/
@@ -66,7 +66,7 @@ public final class DateUtils {
/**
* Parses the date value using the given date formats.
- *
+ *
* @param dateValue the date value to parse
* @param dateFormats the date formats to use
* @return the parsed date or null if input could not be parsed
@@ -77,7 +77,7 @@ public final class DateUtils {
/**
* Parses the date value using the given date formats.
- *
+ *
* @param dateValue the date value to parse
* @param dateFormats the date formats to use
* @param startDate
@@ -109,7 +109,7 @@ public final class DateUtils {
/**
* Parses an ISO8601 string and converts it to a {@link Calendar}.
- *
+ *
* @param s The string to parse.
* @return The parsed value, or <jk>null</jk> if the string was <jk>null</jk> or empty.
*/
@@ -121,7 +121,7 @@ public final class DateUtils {
/**
* Formats the given date according to the RFC 1123 pattern.
- *
+ *
* @param date The date to format.
* @return An RFC 1123 formatted date string.
* @see #PATTERN_RFC1123
@@ -132,10 +132,10 @@ public final class DateUtils {
/**
* Formats the given date according to the specified pattern.
- *
+ *
* <p>
* The pattern must conform to that used by the {@link SimpleDateFormat simple date format} class.
- *
+ *
* @param date The date to format.
* @param pattern The pattern to use for formatting the date.
* @return A formatted date string.
@@ -156,7 +156,7 @@ public final class DateUtils {
/**
* A factory for {@link SimpleDateFormat}s.
- *
+ *
* <p>
* The instances are stored in a thread-local way because SimpleDateFormat is not thread-safe as noted in
* {@link SimpleDateFormat its javadoc}.
@@ -172,7 +172,7 @@ public final class DateUtils {
/**
* Creates a {@link SimpleDateFormat} for the requested format string.
- *
+ *
* @param pattern
* A non-<code>null</code> format String according to {@link SimpleDateFormat}.
* The format is not checked against <code>null</code> since all paths go through {@link DateUtils}.
@@ -204,7 +204,7 @@ public final class DateUtils {
/**
* Pads out an ISO8601 string so that it can be parsed using {@link DatatypeConverter#parseDateTime(String)}.
- *
+ *
* <ul>
* <li><js>"2001-07-04T15:30:45-05:00"</js> --> <js>"2001-07-04T15:30:45-05:00"</js>
* <li><js>"2001-07-04T15:30:45Z"</js> --> <js>"2001-07-04T15:30:45Z"</js>
@@ -215,7 +215,7 @@ public final class DateUtils {
* <li><js>"2001-07"</js> --> <js>"2001-07-01T00:00:00"</js>
* <li><js>"2001"</js> --> <js>"2001-01-01T00:00:00"</js>
* </ul>
- *
+ *
* @param in The string to pad.
* @return The padded string.
*/
[11/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerSession.java
index 6bb21a9..7730c9c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerSession.java
@@ -23,7 +23,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link UonSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -65,7 +65,7 @@ public class UonSerializerSession extends WriterSerializerSession {
/**
* Returns the {@link UonSerializer#UON_addBeanTypeProperties} setting value for this session.
- *
+ *
* @return The {@link UonSerializer#UON_addBeanTypeProperties} setting value for this session.
*/
@Override /* SerializerSession */
@@ -75,7 +75,7 @@ public class UonSerializerSession extends WriterSerializerSession {
/**
* Converts the specified output target object to an {@link UonWriter}.
- *
+ *
* @param out The output target object.
* @return The output target object wrapped in an {@link UonWriter}.
* @throws Exception
@@ -97,7 +97,7 @@ public class UonSerializerSession extends WriterSerializerSession {
/**
* Workhorse method. Determines the type of object, and then calls the appropriate type-specific serialization
* method.
- *
+ *
* @param out The writer to serialize to.
* @param o The object being serialized.
* @param eType The expected type of the object if this is a bean property.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonUtils.java
index 50290da..7a77546 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonUtils.java
@@ -26,10 +26,10 @@ public final class UonUtils {
/**
* Returns <jk>true</jk> if the specified string needs to be quoted per UON notation.
- *
+ *
* <p>
* For example, strings that start with '(' or '@' or look like boolean or numeric values need to be quoted.
- *
+ *
* @param s The string to test.
* @return <jk>true</jk> if the specified string needs to be quoted per UON notation.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonWriter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonWriter.java
index 0476fa0..60f6aa4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonWriter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonWriter.java
@@ -20,8 +20,9 @@ import org.apache.juneau.serializer.*;
/**
* Specialized writer for serializing UON-encoded text.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>This class is not intended for external use.
* </ul>
@@ -47,7 +48,7 @@ public final class UonWriter extends SerializerWriter {
/**
* Constructor.
- *
+ *
* @param session The session that created this writer.
* @param out The writer being wrapped.
* @param useWhitespace If <jk>true</jk>, tabs will be used in output.
@@ -67,7 +68,7 @@ public final class UonWriter extends SerializerWriter {
/**
* Serializes the specified simple object as a UON string value.
- *
+ *
* @param o The object being serialized.
* @param isTopAttrName If this is a top-level attribute name we're serializing.
* @return This object (for method chaining).
@@ -126,7 +127,7 @@ public final class UonWriter extends SerializerWriter {
/**
* Appends a boolean value to the output.
- *
+ *
* @param o The boolean value to append to the output.
* @return This object (for method chaining).
* @throws IOException
@@ -138,7 +139,7 @@ public final class UonWriter extends SerializerWriter {
/**
* Appends a numeric value to the output.
- *
+ *
* @param o The numeric value to append to the output.
* @return This object (for method chaining).
* @throws IOException
@@ -160,7 +161,7 @@ public final class UonWriter extends SerializerWriter {
/**
* Appends a URI to the output.
- *
+ *
* @param uri The URI to append to the output.
* @return This object (for method chaining).
* @throws IOException
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingClassMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingClassMeta.java
index b585e67..0348594 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingClassMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingClassMeta.java
@@ -26,7 +26,7 @@ public class UrlEncodingClassMeta extends ClassMetaExtended {
/**
* Constructor.
- *
+ *
* @param cm The class that this annotation is defined on.
*/
public UrlEncodingClassMeta(ClassMeta<?> cm) {
@@ -41,7 +41,7 @@ public class UrlEncodingClassMeta extends ClassMetaExtended {
/**
* Returns the {@link UrlEncoding} annotation defined on the class.
- *
+ *
* @return The value of the {@link UrlEncoding} annotation, or <jk>null</jk> if annotation is not specified.
*/
protected UrlEncoding getAnnotation() {
@@ -50,7 +50,7 @@ public class UrlEncodingClassMeta extends ClassMetaExtended {
/**
* Returns the {@link UrlEncoding#expandedParams()} annotation defined on the class.
- *
+ *
* @return The value of the {@link UrlEncoding#expandedParams()} annotation.
*/
protected boolean isExpandedParams() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParser.java
index c8051b9..e8c67b5 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParser.java
@@ -19,18 +19,20 @@ import org.apache.juneau.urlencoding.annotation.*;
/**
* Parses URL-encoded text into POJO models.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Content-Type</code> types: <code>application/x-www-form-urlencoded</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Content-Type</code> types: <code><b>application/x-www-form-urlencoded</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Parses URL-Encoded text (e.g. <js>"foo=bar&baz=bing"</js>) into POJOs.
- *
+ *
* <p>
* Expects parameter values to be in UON notation.
- *
+ *
* <p>
* This parser uses a state machine, which makes it very fast and efficient.
*/
@@ -44,7 +46,7 @@ public class UrlEncodingParser extends UonParser {
/**
* Configuration property: Parser bean property collections/arrays as separate key/value pairs
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"UrlEncodingParser.expandedParams.b"</js>
@@ -58,22 +60,22 @@ public class UrlEncodingParser extends UonParser {
* <li class='ja'>{@link UrlEncoding#expandedParams()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* This is the parser-side equivalent of the {@link #URLENC_expandedParams} setting.
- *
+ *
* <p>
* If <jk>false</jk>, serializing the array <code>[1,2,3]</code> results in <code>?key=$a(1,2,3)</code>.
* <br>If <jk>true</jk>, serializing the same array results in <code>?key=1&key=2&key=3</code>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> A {
* <jk>public</jk> String[] f1;
* <jk>public</jk> List<String> f2;
* }
- *
+ *
* UrlEncodingParser p1 = UrlEncodingParser.<jsf>DEFAULT</jsf>;
* UrlEncodingParser p2 = UrlEncodingParser.<jsm>create</jsm>().expandedParams().build();
*
@@ -81,10 +83,10 @@ public class UrlEncodingParser extends UonParser {
*
* A a2 = p2.parse(<js>"f1=a&f1=b&f2=c&f2=d"</js>, A.<jk>class</jk>);
* </p>
- *
+ *
* <p>
* This option only applies to beans.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>If parsing multi-part parameters, it's highly recommended to use Collections or Lists
@@ -112,7 +114,7 @@ public class UrlEncodingParser extends UonParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public UrlEncodingParser(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java
index d996452..79e14b4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserBuilder.java
@@ -35,7 +35,7 @@ public class UrlEncodingParserBuilder extends UonParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public UrlEncodingParserBuilder(PropertyStore ps) {
@@ -54,10 +54,10 @@ public class UrlEncodingParserBuilder extends UonParserBuilder {
/**
* Configuration property: Serialize bean property collections/arrays as separate key/value pairs.
- *
+ *
* <p>
* This is the parser-side equivalent of the {@link UrlEncodingParser#URLENC_expandedParams} setting.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UrlEncodingParser#URLENC_expandedParams}
@@ -74,10 +74,10 @@ public class UrlEncodingParserBuilder extends UonParserBuilder {
/**
* Configuration property: Serialize bean property collections/arrays as separate key/value pairs.
- *
+ *
* <p>
* Shortcut for calling <code>expandedParams(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UrlEncodingParser#URLENC_expandedParams}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserSession.java
index b843046..2207577 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingParserSession.java
@@ -25,7 +25,7 @@ import org.apache.juneau.uon.*;
/**
* Session object that lives for the duration of a single use of {@link UrlEncodingParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -37,7 +37,7 @@ public class UrlEncodingParserSession extends UonParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -59,7 +59,7 @@ public class UrlEncodingParserSession extends UonParserSession {
/**
* Returns <jk>true</jk> if the specified bean property should be expanded as multiple key-value pairs.
- *
+ *
* @param pMeta The metadata on the bean property.
* @return <jk>true</jk> if the specified bean property should be expanded as multiple key-value pairs.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializer.java
index 2c669b8..c7ea512 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializer.java
@@ -18,18 +18,21 @@ import org.apache.juneau.uon.*;
/**
* Serializes POJO models to URL-encoded notation with UON-encoded values (a notation for URL-encoded query paramter values).
- *
+ *
+ *
* <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>application/x-www-form-urlencoded</code>
+ *
+ * Handles <code>Accept</code> types: <code><b>application/x-www-form-urlencoded</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>application/x-www-form-urlencoded</code>
- *
- * <h5 class='section'>Description:</h5>
- *
- * This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient.
- * However, custom serializers can be constructed to fine-tune behavior.
- *
+ * Produces <code>Content-Type</code> types: <code><b>application/x-www-form-urlencoded</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
+ * This serializer provides several serialization options.
+ * <br>Typically, one of the predefined DEFAULT serializers will be sufficient.
+ * <br>However, custom serializers can be constructed to fine-tune behavior.
+ *
* <p>
* The following shows a sample object defined in Javascript:
* <p class='bcode'>
@@ -54,7 +57,7 @@ import org.apache.juneau.uon.*;
* ]
* }
* </p>
- *
+ *
* <p>
* Using the "strict" syntax defined in this document, the equivalent URL-encoded notation would be as follows:
* <p class='bcode'>
@@ -77,16 +80,16 @@ import org.apache.juneau.uon.*;
* )
* )
* </p>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Serialize a Map</jc>
* Map m = <jk>new</jk> ObjectMap(<js>"{a:'b',c:1,d:false,e:['f',1,false],g:{h:'i'}}"</js>);
- *
+ *
* <jc>// Serialize to value equivalent to JSON.</jc>
* <jc>// Produces "a=b&c=1&d=false&e=@(f,1,false)&g=(h=i)"</jc>
* String s = UrlEncodingSerializer.<jsf>DEFAULT</jsf>.serialize(s);
- *
+ *
* <jc>// Serialize a bean</jc>
* <jk>public class</jk> Person {
* <jk>public</jk> Person(String s);
@@ -95,16 +98,16 @@ import org.apache.juneau.uon.*;
* <jk>public</jk> Address getAddress();
* <jk>public boolean</jk> deceased;
* }
- *
+ *
* <jk>public class</jk> Address {
* <jk>public</jk> String getStreet();
* <jk>public</jk> String getCity();
* <jk>public</jk> String getState();
* <jk>public int</jk> getZip();
* }
- *
+ *
* Person p = <jk>new</jk> Person(<js>"John Doe"</js>, 23, <js>"123 Main St"</js>, <js>"Anywhere"</js>, <js>"NY"</js>, 12345, <jk>false</jk>);
- *
+ *
* <jc>// Produces "name=John+Doe&age=23&address=(street='123+Main+St',city=Anywhere,state=NY,zip=12345)&deceased=false"</jc>
* String s = UrlEncodingSerializer.<jsf>DEFAULT</jsf>.serialize(s);
* </p>
@@ -119,7 +122,7 @@ public class UrlEncodingSerializer extends UonSerializer {
/**
* Configuration property: Serialize bean property collections/arrays as separate key/value pairs.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"UrlEncodingSerializer.expandedParams.b"</js>
@@ -132,15 +135,15 @@ public class UrlEncodingSerializer extends UonSerializer {
* <li class='jm'>{@link UrlEncodingSerializerBuilder#expandedParams()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>false</jk>, serializing the array <code>[1,2,3]</code> results in <code>?key=$a(1,2,3)</code>.
* <br>If <jk>true</jk>, serializing the same array results in <code>?key=1&key=2&key=3</code>.
- *
+ *
* <p>
* This option only applies to beans.
- *
+ *
* <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>
@@ -155,20 +158,20 @@ public class UrlEncodingSerializer extends UonSerializer {
* <jk>public</jk> String[] f1 = {<js>"a"</js>,<js>"b"</js>};
* <jk>public</jk> List<String> f2 = Arrays.<jsm>asList</jsm>(<jk>new</jk> String[]{<js>"c"</js>,<js>"d"</js>});
* }
- *
+ *
* <jc>// Normal serializer.</jc>
* WriterSerializer s1 = UrlEncodingSerializer.<jsf>DEFAULT</jsf>;
*
* <jc>// Expanded-params serializer.</jc>
* WriterSerializer s2 = UrlEncodingSerializer.<jsm>create</jsm>().expandedParams().build();
- *
- * <jc>// Produces "f1=(a,b)&f2=(c,d)"</jc>
+ *
+ * <jc>// Produces "f1=(a,b)&f2=(c,d)"</jc>
* String ss1 = s1.serialize(<jk>new</jk> A());
*
* <jc>// Produces "f1=a&f1=b&f2=c&f2=d"</jc>
* String ss2 = s2.serialize(<jk>new</jk> A()); <jc>
* </p>
- *
+ *
*/
public static final String URLENC_expandedParams = PREFIX + "expandedParams.b";
@@ -201,7 +204,7 @@ public class UrlEncodingSerializer extends UonSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Expanded(PropertyStore ps) {
@@ -216,7 +219,7 @@ public class UrlEncodingSerializer extends UonSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Readable(PropertyStore ps) {
@@ -231,7 +234,7 @@ public class UrlEncodingSerializer extends UonSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public PlainText(PropertyStore ps) {
@@ -249,7 +252,7 @@ public class UrlEncodingSerializer extends UonSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -259,7 +262,7 @@ public class UrlEncodingSerializer extends UonSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java
index 20bcc68..b45f82c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerBuilder.java
@@ -35,7 +35,7 @@ public class UrlEncodingSerializerBuilder extends UonSerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public UrlEncodingSerializerBuilder(PropertyStore ps) {
@@ -54,11 +54,11 @@ public class UrlEncodingSerializerBuilder extends UonSerializerBuilder {
/**
* Configuration property: Serialize bean property collections/arrays as separate key/value pairs.
- *
+ *
* <p>
* If <jk>false</jk>, serializing the array <code>[1,2,3]</code> results in <code>?key=$a(1,2,3)</code>.
* <br>If <jk>true</jk>, serializing the same array results in <code>?key=1&key=2&key=3</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UrlEncodingSerializer#URLENC_expandedParams}
@@ -75,10 +75,10 @@ public class UrlEncodingSerializerBuilder extends UonSerializerBuilder {
/**
* Configuration property: Serialize bean property collections/arrays as separate key/value pairs.
- *
+ *
* <p>
* Shortcut for calling <code>expandedParams(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UrlEncodingSerializer#URLENC_expandedParams}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.java
index 8a56c09..f0d3bfc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.java
@@ -26,7 +26,7 @@ import org.apache.juneau.uon.*;
/**
* Session object that lives for the duration of a single use of {@link UrlEncodingSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -38,7 +38,7 @@ public class UrlEncodingSerializerSession extends UonSerializerSession {
/**
* Constructor.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java
index d8b9d2d..5a0d4a7 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/urlencoding/annotation/UrlEncoding.java
@@ -31,7 +31,7 @@ public @interface UrlEncoding {
/**
* When true, bean properties of type array or Collection will be expanded into multiple key/value pairings.
- *
+ *
* <p>
* This annotation is identical in behavior to using the {@link UrlEncodingSerializer#URLENC_expandedParams}
* and {@link UrlEncodingParser#URLENC_expandedParams} properties, but applies to only instances of this bean.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/AList.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/AList.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/AList.java
index 2c5e766..45aa3fc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/AList.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/AList.java
@@ -16,14 +16,14 @@ import java.util.*;
/**
* An extension of {@link LinkedList} with a convenience {@link #append(Object)} method.
- *
+ *
* <p>
* Primarily used for testing purposes for quickly creating populated lists.
* <p class='bcode'>
* <jc>// Example:</jc>
* List<String> l = <jk>new</jk> AList<String>().append(<js>"foo"</js>).append(<js>"bar"</js>);
* </p>
- *
+ *
* @param <T> The entry type.
*/
@SuppressWarnings({"serial","unchecked"})
@@ -31,7 +31,7 @@ public final class AList<T> extends LinkedList<T> {
/**
* Adds an entry to this list.
- *
+ *
* @param t The entry to add to this list.
* @return This object (for method chaining).
*/
@@ -42,7 +42,7 @@ public final class AList<T> extends LinkedList<T> {
/**
* Adds multiple entries to this list.
- *
+ *
* @param t The entries to add to this list.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/AMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/AMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/AMap.java
index e6a8420..0ccfe9a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/AMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/AMap.java
@@ -16,7 +16,7 @@ import java.util.*;
/**
* An extension of {@link LinkedHashMap} with a convenience {@link #append(Object,Object)} method.
- *
+ *
* <p>
* Primarily used for testing purposes for quickly creating populated maps.
* <p class='bcode'>
@@ -24,7 +24,7 @@ import java.util.*;
* Map<String,Integer> m = <jk>new</jk> AMap<String,Integer>()
* .append(<js>"foo"</js>,1).append(<js>"bar"</js>,2);
* </p>
- *
+ *
* @param <K> The key type.
* @param <V> The value type.
*/
@@ -33,7 +33,7 @@ public final class AMap<K,V> extends LinkedHashMap<K,V> {
/**
* Adds an entry to this map.
- *
+ *
* @param k The key.
* @param v The value.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ASet.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ASet.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ASet.java
index f6fe987..036cb21 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ASet.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ASet.java
@@ -16,14 +16,14 @@ import java.util.*;
/**
* An extension of {@link LinkedHashSet} with a convenience {@link #append(Object)} method.
- *
+ *
* <p>
* Primarily used for testing purposes for quickly creating populated sets.
* <p class='bcode'>
* <jc>// Example:</jc>
* Set<String> s = <jk>new</jk> ASet<String>().append(<js>"foo"</js>).append(<js>"bar"</js>);
* </p>
- *
+ *
* @param <T> The entry type.
*/
@SuppressWarnings({"serial","unchecked"})
@@ -31,7 +31,7 @@ public final class ASet<T> extends LinkedHashSet<T> {
/**
* Adds an entry to this set.
- *
+ *
* @param t The entry to add to this set.
* @return This object (for method chaining).
*/
@@ -42,7 +42,7 @@ public final class ASet<T> extends LinkedHashSet<T> {
/**
* Adds multiple entries to this set.
- *
+ *
* @param t The entries to add to this set.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/Args.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/Args.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/Args.java
index b16e16d..fdeca7f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/Args.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/Args.java
@@ -22,17 +22,17 @@ import org.apache.juneau.internal.*;
/**
* Utility class to make it easier to work with command-line arguments pass in through a
* <code>main(String[] args)</code> method.
- *
+ *
* <p>
* Used to parse command-line arguments of the form
* <js>"[zero or more main arguments] [zero or more optional arguments]"</js>.
- *
+ *
* <p>
* 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>.
- *
+ *
* <h6 class='topic'>Command-line examples</h6>
* <ul>
* <li><code>java com.sample.MyClass mainArg1</code>
@@ -43,62 +43,62 @@ import org.apache.juneau.internal.*;
* <li><code>java com.sample.MyClass mainArg1 -optArg1 optArg1Val1 optArg1Val2</code>
* <li><code>java com.sample.MyClass mainArg1 -optArg1 optArg1Val1 -optArg1 optArg1Val2</code>
* </ul>
- *
- * <h5 class='section'>Examples:</h5>
+ *
+ * <h5 class='section'>Example:</h5>
* <p class='bcode'>
- *
+ *
* <jc>// Main method with arguments</jc>
* <jk>public static void</jk> <jsm>main</jsm>(String[] args) {
- *
+ *
* <jc>// Wrap in Args</jc>
* Args a = new Args(args);
- *
+ *
* <jc>// One main argument</jc>
* <jc>// a1</jc>
* String a1 = a.getArg(0); <jc>// "a1"</jc>
* String a2 = a.getArg(1); <jc>// null</jc>
- *
+ *
* <jc>// Two main arguments</jc>
* <jc>// a1 a2</jc>
* String a1 = a.getArg(0); <jc>// "a1"</jc>
* String a2 = a.getArg(1); <jc>// "a2"</jc>
- *
+ *
* <jc>// One main argument and one optional argument with no value</jc>
* <jc>// a1 -a2</jc>
* String a1 = a.getArg(0);
* <jk>boolean</jk> hasA2 = a.hasArg(<js>"a2"</js>); <jc>// true</jc>
* <jk>boolean</jk> hasA3 = a.hasArg(<js>"a3"</js>); <jc>// false</jc>
- *
+ *
* <jc>// One main argument and one optional argument with one value</jc>
* <jc>// a1 -a2 v2</jc>
* String a1 = a.getArg(0);
* String a2 = a.getArg(<js>"a2"</js>); <jc>// "v2"</jc>
* String a3 = a.getArg(<js>"a3"</js>); <jc>// null</jc>
- *
+ *
* <jc>// One main argument and one optional argument with two values</jc>
* <jc>// a1 -a2 v2a v2b</jc>
* String a1 = a.getArg(0);
* List<String> a2 = a.getArgs(<js>"a2"</js>); <jc>// Contains ["v2a","v2b"]</jc>
* List<String> a3 = a.getArgs(<js>"a3"</js>); <jc>// Empty list</jc>
- *
+ *
* <jc>// Same as previous, except specify optional argument name multiple times</jc>
* <jc>// a1 -a2 v2a -a2 v2b</jc>
* String a1 = a.getArg(0);
* List<String> a2 = a.getArgs(<js>"a2"</js>); <jc>// Contains ["v2a","v2b"]</jc>
* }
* </p>
- *
+ *
* <p>
* Main arguments are available through numeric string keys (e.g. <js>"0"</js>, <js>"1"</js>, ...).
* So you could use the {@link ObjectMap} API to convert main arguments directly to POJOs, such as an <code>Enum</code>
* <p class='bcode'>
* <jc>// Get 1st main argument as an Enum</jc>
* MyEnum e = a.get(MyEnum.<jk>class</jk>, <js>"0"</js>);
- *
+ *
* <jc>// Get 1st main argument as an integer</jc>
* int i = a.get(<jk>int</jk>.<jk>class</jk>, <js>"0"</js>);
* </p>
- *
+ *
* <p>
* Equivalent operations are available on optional arguments through the {@link #getArg(Class, String)} method.
*/
@@ -108,7 +108,7 @@ public final class Args extends ObjectMap {
/**
* Constructor.
- *
+ *
* @param args Arguments passed in through a <code>main(String[] args)</code> method.
*/
public Args(String[] args) {
@@ -142,7 +142,7 @@ public final class Args extends ObjectMap {
/**
* Constructor.
- *
+ *
* @param args Arguments passed in as a raw command line.
*/
public Args(String args) {
@@ -151,29 +151,29 @@ public final class Args extends ObjectMap {
/**
* Returns main argument at the specified index, or <jk>null</jk> if the index is out of range.
- *
+ *
* <p>
* Can be used in conjunction with {@link #hasArg(int)} to check for existence of arg.
* <p class='bcode'>
* <jc>// Check for no arguments</jc>
* <jk>if</jk> (! args.hasArg(0))
* printUsageAndExit();
- *
+ *
* <jc>// Get the first argument</jc>
* String firstArg = args.getArg(0);
* </p>
- *
+ *
* <p>
* Since main arguments are stored as numeric keys, this method is essentially equivalent to...
* <p class='bcode'>
* <jc>// Check for no arguments</jc>
* <jk>if</jk> (! args.containsKey(<js>"0"</js>))
* printUsageAndExit();
- *
+ *
* <jc>// Get the first argument</jc>
* String firstArg = args.getString("0");
* </p>
- *
+ *
* @param i The index position of the main argument (zero-indexed).
* @return The main argument value, or <js>""</js> if argument doesn't exist at that position.
*/
@@ -183,7 +183,7 @@ public final class Args extends ObjectMap {
/**
* Returns <jk>true</jk> if argument exists at specified index.
- *
+ *
* @param i The zero-indexed position of the argument.
* @return <jk>true</jk> if argument exists at specified index.
*/
@@ -193,10 +193,10 @@ public final class Args extends ObjectMap {
/**
* Returns the optional argument value, or blank if the optional argument was not specified.
- *
+ *
* <p>
* If the optional arg has multiple values, returns values as a comma-delimited list.
- *
+ *
* @param name The optional argument name.
* @return The optional argument value, or blank if the optional argument was not specified.
*/
@@ -211,17 +211,17 @@ public final class Args extends ObjectMap {
/**
* Returns the optional argument value converted to the specified object type.
- *
+ *
* <p>
* If the optional arg has multiple values, returns only the first converted value.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Command: java com.sample.MyClass -verbose true -debug 5</jc>
* <jk>boolean</jk> b = args.getArg(<jk>boolean</jk>.<jk>class</jk>, <js>"verbose"</js>);
* <jk>int</jk> i = args.getArg(<jk>int</jk>.<jk>class</jk>, <js>"debug"</js>);
* </p>
- *
+ *
* @param c The class type to convert the value to.
* @param <T> The class type to convert the value to.
* @param name The optional argument name.
@@ -236,14 +236,14 @@ public final class Args extends ObjectMap {
/**
* Returns the optional argument values as a list of strings.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Command: java com.sample.MyClass -extraArgs foo bar baz</jc>
* List<String> l1 = args.getArgs(<js>"extraArgs"</js>); <jc>// ['foo','bar','baz']</jc>
* List<String> l2 = args.getArgs(<js>"nonExistentArgs"</js>); <jc>// An empty list</jc>
* </p>
- *
+ *
* @param name The optional argument name.
* @return The optional argument values, or an empty list if the optional argument was not specified.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/CalendarUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/CalendarUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/CalendarUtils.java
index 644b6b7..7bf4f6b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/CalendarUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/CalendarUtils.java
@@ -36,12 +36,12 @@ public class CalendarUtils {
/**
* Transform to ISO8601 date-time-local strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"2001-07-04T15:30:45"</js>
* </ul>
- *
+ *
* <h6 class='topic'>Example input:</h6>
* <ul>
* <li><js>"2001-07-04T15:30:45"</js>
@@ -56,13 +56,13 @@ public class CalendarUtils {
/**
* Transform to ISO8601 date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"2001-07-04T15:30:45-05:00"</js>
* <li><js>"2001-07-04T15:30:45Z"</js>
* </ul>
- *
+ *
* <h6 class='topic'>Example input:</h6>
* <ul>
* <li><js>"2001-07-04T15:30:45-05:00"</js>
@@ -78,7 +78,7 @@ public class CalendarUtils {
/**
* Same as {@link CalendarUtils.Format#ISO8601_DT}, except always serializes in GMT.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <js>"2001-07-04T15:30:45Z"</js>
*/
@@ -86,7 +86,7 @@ public class CalendarUtils {
/**
* Same as {@link CalendarUtils.Format#ISO8601_DT} except serializes to millisecond precision.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <js>"2001-07-04T15:30:45.123Z"</js>
*/
@@ -94,7 +94,7 @@ public class CalendarUtils {
/**
* Same as {@link CalendarUtils.Format#ISO8601_DTZ} except serializes to millisecond precision.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <js>"2001-07-04T15:30:45.123"</js>
*/
@@ -102,7 +102,7 @@ public class CalendarUtils {
/**
* ISO8601 date only.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <js>"2001-07-04"</js>
*/
@@ -110,7 +110,7 @@ public class CalendarUtils {
/**
* Transform to {@link String Strings} using the {@code Date.toString()} method.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Wed Jul 04 15:30:45 EST 2001"</js>
@@ -120,7 +120,7 @@ public class CalendarUtils {
/**
* Transform to RFC2822 date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Sat, 03 Mar 2001 10:11:12 +0000"</js> <jc>// en_US</jc>
@@ -132,7 +132,7 @@ public class CalendarUtils {
/**
* Same as {@link CalendarUtils.Format#RFC2822_DT}, except always serializes in GMT.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Sat, 03 Mar 2001 10:11:12 GMT"</js> <jc>// en_US</jc>
@@ -144,7 +144,7 @@ public class CalendarUtils {
/**
* Transform to RFC2822 date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"03 Mar 2001"</js> <jc>// en_US</jc>
@@ -156,7 +156,7 @@ public class CalendarUtils {
/**
* Transform to simple <js>"yyyy/MM/dd HH:mm:ss"</js> date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"2001/03/03 10:11:12"</js>
@@ -166,7 +166,7 @@ public class CalendarUtils {
/**
* Transform to simple <js>"yyyy/MM/dd"</js> date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"2001/03/03"</js>
@@ -176,7 +176,7 @@ public class CalendarUtils {
/**
* Transform to simple <js>"HH:mm:ss"</js> time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11:12"</js>
@@ -186,7 +186,7 @@ public class CalendarUtils {
/**
* Transform to {@link DateFormat#FULL} date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Saturday, March 3, 2001"</js> <jc>// en_US</jc>
@@ -198,7 +198,7 @@ public class CalendarUtils {
/**
* Transform to {@link DateFormat#LONG} date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"March 3, 2001"</js> <jc>// en_US</jc>
@@ -210,7 +210,7 @@ public class CalendarUtils {
/**
* Transform to {@link DateFormat#MEDIUM} date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Mar 3, 2001"</js> <jc>// en_US</jc>
@@ -222,7 +222,7 @@ public class CalendarUtils {
/**
* Transform to {@link DateFormat#SHORT} date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"3/3/01"</js> <jc>// en_US</jc>
@@ -234,7 +234,7 @@ public class CalendarUtils {
/**
* Transform to {@link DateFormat#FULL} time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11:12 AM GMT"</js> <jc>// en_US</jc>
@@ -246,7 +246,7 @@ public class CalendarUtils {
/**
* Transform to {@link DateFormat#LONG} time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11:12 AM GMT"</js> <jc>// en_US</jc>
@@ -258,7 +258,7 @@ public class CalendarUtils {
/**
* Transform to {@link DateFormat#MEDIUM} time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11:12 AM"</js> <jc>// en_US</jc>
@@ -270,7 +270,7 @@ public class CalendarUtils {
/**
* Transform to {@link DateFormat#SHORT} time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11 AM"</js> <jc>// en_US</jc>
@@ -282,7 +282,7 @@ public class CalendarUtils {
/**
* Transform to {@link DateFormat#FULL} date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Saturday, March 3, 2001 10:11:12 AM GMT"</js> <jc>// en_US</jc>
@@ -294,7 +294,7 @@ public class CalendarUtils {
/**
* Transform to {@link DateFormat#LONG} date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"March 3, 2001 10:11:12 AM GMT"</js> <jc>// en_US</jc>
@@ -306,7 +306,7 @@ public class CalendarUtils {
/**
* Transform to {@link DateFormat#MEDIUM} date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Mar 3, 2001 10:11:12 AM"</js> <jc>// en_US</jc>
@@ -318,7 +318,7 @@ public class CalendarUtils {
/**
* Transform to {@link DateFormat#SHORT} date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"3/3/01 10:11 AM"</js> <jc>// en_US</jc>
@@ -416,7 +416,7 @@ public class CalendarUtils {
/**
* Converts the specified calendar to a string of the specified format.
- *
+ *
* @param c The calendar to serialize.
* @param format The date format.
* @param locale The locale to use. If <jk>null</jk>, uses {@link Locale#getDefault()}.
@@ -481,7 +481,7 @@ public class CalendarUtils {
/**
* Converts the specified date to a string of the specified format.
- *
+ *
* @param format The date format.
* @param d The date to serialize.
* @param locale The locale to use. If <jk>null</jk>, uses {@link Locale#getDefault()}.
@@ -547,7 +547,7 @@ public class CalendarUtils {
/**
* Converts the specified serialized date back into a {@link Calendar} object.
- *
+ *
* @param format The date format.
* @param in The serialized date.
* @param locale
@@ -619,7 +619,7 @@ public class CalendarUtils {
/**
* Converts the specified serialized date back into a {@link Date} object.
- *
+ *
* @param format The date format.
* @param in The serialized date.
* @param locale
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceFinderBasic.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceFinderBasic.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceFinderBasic.java
index 99114c2..327540e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceFinderBasic.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceFinderBasic.java
@@ -17,7 +17,7 @@ import java.util.*;
/**
* Utility class for finding resources for a class.
- *
+ *
* <p>
* Same as {@link ClasspathResourceFinderSimple}, but if the resource cannot be found in the classpath, then an attempt
* is made to look in the JVM working directory.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceFinderSimple.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceFinderSimple.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceFinderSimple.java
index bdec620..6e0ada9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceFinderSimple.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceFinderSimple.java
@@ -20,10 +20,10 @@ import java.util.ResourceBundle.*;
/**
* Utility class for finding resources for a class.
- *
+ *
* <p>
* Same as {@link Class#getResourceAsStream(String)} except looks for resources with localized file names.
- *
+ *
* <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
@@ -72,7 +72,7 @@ public class ClasspathResourceFinderSimple implements ClasspathResourceFinder {
/**
* Returns the candidate file names for the specified file name in the specified locale.
- *
+ *
* <p>
* For example, if looking for the <js>"MyResource.txt"</js> file in the Japanese locale, the iterator will return
* names in the following order:
@@ -81,10 +81,10 @@ public class ClasspathResourceFinderSimple implements ClasspathResourceFinder {
* <li><js>"MyResource_ja.txt"</js>
* <li><js>"MyResource.txt"</js>
* </ol>
- *
+ *
* <p>
* If the locale is <jk>null</jk>, then it will only return <js>"MyResource.txt"</js>.
- *
+ *
* @param fileName The name of the file to get candidate file names on.
* @param l The locale.
* @return An iterator of file names to look at.
@@ -124,7 +124,7 @@ public class ClasspathResourceFinderSimple implements ClasspathResourceFinder {
/**
* Returns the candidate locales for the specified locale.
- *
+ *
* <p>
* For example, if <code>locale</code> is <js>"ja_JP"</js>, then this method will return:
* <ol>
@@ -132,7 +132,7 @@ public class ClasspathResourceFinderSimple implements ClasspathResourceFinder {
* <li><js>"ja"</js>
* <li><js>""</js>
* </ol>
- *
+ *
* @param locale The locale to get the list of candidate locales for.
* @return The list of candidate locales.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceManager.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceManager.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceManager.java
index 4dcb5c7..8d734cd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceManager.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ClasspathResourceManager.java
@@ -60,7 +60,7 @@ public final class ClasspathResourceManager {
/**
* Finds the resource with the given name.
- *
+ *
* @param name Name of the desired resource.
* @return An input stream to the object, or <jk>null</jk> if the resource could not be found.
* @throws IOException
@@ -71,7 +71,7 @@ public final class ClasspathResourceManager {
/**
* Finds the resource with the given name for the specified locale and returns it as an input stream.
- *
+ *
* @param name Name of the desired resource.
* @param locale The locale. Can be <jk>null</jk>.
* @return An input stream to the object, or <jk>null</jk> if the resource could not be found.
@@ -116,7 +116,7 @@ public final class ClasspathResourceManager {
/**
* Finds the resource with the given name and converts it to a simple string.
- *
+ *
* @param name Name of the desired resource.
* @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.
* @throws IOException
@@ -127,7 +127,7 @@ public final class ClasspathResourceManager {
/**
* Finds the resource with the given name and converts it to a simple string.
- *
+ *
* @param baseClass
* Overrides the default class to use for retrieving the classpath resource.
* <br>If <jk>null<jk>, uses the base class passed in through the constructor of this class.
@@ -141,7 +141,7 @@ public final class ClasspathResourceManager {
/**
* Finds the resource with the given name and converts it to a simple string.
- *
+ *
* @param name Name of the desired resource.
* @param locale The locale. Can be <jk>null</jk>.
* @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.
@@ -153,7 +153,7 @@ public final class ClasspathResourceManager {
/**
* Finds the resource with the given name and converts it to a simple string.
- *
+ *
* @param baseClass
* Overrides the default class to use for retrieving the classpath resource.
* <br>If <jk>null<jk>, uses the base class passed in through the constructor of this class.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/IOPipe.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/IOPipe.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/IOPipe.java
index 5e4d7f0..53bec8f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/IOPipe.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/IOPipe.java
@@ -22,7 +22,7 @@ import org.apache.juneau.internal.*;
/**
* A utility class for piping input streams and readers to output streams and writers.
- *
+ *
* <p>
* A typical usage is as follows...
* <p class='bcode'>
@@ -30,7 +30,7 @@ import org.apache.juneau.internal.*;
* Writer out = getWriter();
* IOPipe.create(in, out).closeOut().run();
* </p>
- *
+ *
* <p>
* By default, the input stream is closed and the output stream is not.
* This can be changed by calling {@link #closeOut()} and {@link #close(boolean, boolean)}.
@@ -62,7 +62,7 @@ public class IOPipe {
/**
* Creates a new pipe with the specified input and output.
- *
+ *
* @param input The input. Must be one of the following types: Reader, InputStream, CharSequence.
* @param output The output. Must be one of the following types: Writer, OutputStream.
* @return This object (for method chaining).
@@ -73,7 +73,7 @@ public class IOPipe {
/**
* Close output after piping.
- *
+ *
* @return This object (for method chaining).
*/
public IOPipe closeOut() {
@@ -83,7 +83,7 @@ public class IOPipe {
/**
* Specifies whether to close the input and output after piping.
- *
+ *
* @param in Close input stream. Default is <jk>true</jk>.
* @param out Close output stream. Default is <jk>false</jk>.
* @return This object (for method chaining).
@@ -96,7 +96,7 @@ public class IOPipe {
/**
* Specifies the temporary buffer size.
- *
+ *
* @param buffSize The buffer size. Default is <code>1024</code>.
* @return This object (for method chaining).
*/
@@ -108,10 +108,10 @@ public class IOPipe {
/**
* Specifies whether the content should be piped line-by-line.
- *
+ *
* <p>
* This can be useful if you're trying to pipe console-based input.
- *
+ *
* @param byLines Pipe content line-by-line. Default is <jk>false</jk>.
* @return This object (for method chaining).
*/
@@ -122,7 +122,7 @@ public class IOPipe {
/**
* Same as calling {@link #byLines()} with <jk>true</jk>.
- *
+ *
* @return This object (for method chaining).
*/
public IOPipe byLines() {
@@ -132,7 +132,7 @@ public class IOPipe {
/**
* Specifies a line processor that can be used to process lines before they're piped to the output.
- *
+ *
* @param lineProcessor The line processor.
* @return This object (for method chaining).
*/
@@ -147,7 +147,7 @@ public class IOPipe {
public interface LineProcessor {
/**
* Process the specified line.
- *
+ *
* @param line The line to process.
* @return The processed line.
*/
@@ -156,7 +156,7 @@ public class IOPipe {
/**
* Performs the piping of the input to the output.
- *
+ *
* @return The number of bytes (if streams) or characters (if readers/writers) piped.
* @throws IOException
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ManifestFile.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ManifestFile.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ManifestFile.java
index 25c2ecd..67c7bf4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ManifestFile.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/ManifestFile.java
@@ -23,7 +23,7 @@ import org.apache.juneau.*;
/**
* Utility class for working with Jar manifest files.
- *
+ *
* <p>
* Copies the contents of a {@link Manifest} into an {@link ObjectMap} so that the various convenience methods on that
* class can be used to retrieve values.
@@ -34,7 +34,7 @@ public class ManifestFile extends ObjectMap {
/**
* Create an instance of this class from a manifest file on the file system.
- *
+ *
* @param f The manifest file.
* @throws IOException If a problem occurred while trying to read the manifest file.
*/
@@ -50,7 +50,7 @@ public class ManifestFile extends ObjectMap {
/**
* Create an instance of this class from a {@link Manifest} object.
- *
+ *
* @param f The manifest to read from.
*/
public ManifestFile(Manifest f) {
@@ -59,7 +59,7 @@ public class ManifestFile extends ObjectMap {
/**
* Finds and loads the manifest file of the jar file that the specified class is contained within.
- *
+ *
* @param c The class to get the manifest file of.
* @throws IOException If a problem occurred while trying to read the manifest file.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/MessageBundle.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/MessageBundle.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/MessageBundle.java
index 28df465..c529fc8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/MessageBundle.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/MessageBundle.java
@@ -23,7 +23,7 @@ import org.apache.juneau.*;
/**
* 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
@@ -47,10 +47,10 @@ import org.apache.juneau.*;
* the message can be retrieved using <code>getString(<js>"myMessage"</js>)</code>.
* </ul>
*
- * <h5 class='section'>Notes:</h5>
- * <ul>
- * <li>This class is thread-safe.
- * </ul>
+ * <h5 class='section'>Notes:</h5>
+ * <ul>
+ * <li>This class is thread-safe.
+ * </ul>
*/
public class MessageBundle extends ResourceBundle {
@@ -78,7 +78,7 @@ public class MessageBundle extends ResourceBundle {
/**
* Sets the locale for this thread so that calls to {@link #getClientString(String, Object...)} return messages in
* that locale.
- *
+ *
* @param locale The new client locale.
*/
public static void setClientLocale(Locale locale) {
@@ -144,7 +144,7 @@ public class MessageBundle extends ResourceBundle {
/**
* Constructor.
- *
+ *
* @param forClass The class using this resource bundle.
* @param bundlePath
* The path of the resource bundle to wrap.
@@ -197,14 +197,14 @@ public class MessageBundle extends ResourceBundle {
/**
* Add another bundle path to this resource bundle.
- *
+ *
* <p>
* Order of property lookup is first-to-last.
- *
+ *
* <p>
* This method must be called from the same thread as the call to the constructor.
* This eliminates the need for synchronization.
- *
+ *
* @param forClass The class using this resource bundle.
* @param bundlePath The bundle path.
* @return This object (for method chaining).
@@ -226,7 +226,7 @@ public class MessageBundle extends ResourceBundle {
/**
* Similar to {@link ResourceBundle#getString(String)} except allows you to pass in {@link MessageFormat} objects.
- *
+ *
* @param key The resource bundle key.
* @param args Optional {@link MessageFormat}-style arguments.
* @return
@@ -243,7 +243,7 @@ public class MessageBundle extends ResourceBundle {
/**
* Same as {@link #getString(String, Object...)} but allows you to specify the locale.
- *
+ *
* @param locale The locale of the resource bundle to retrieve message from.
* @param key The resource bundle key.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -260,7 +260,7 @@ public class MessageBundle extends ResourceBundle {
/**
* Same as {@link #getString(String, Object...)} but uses the locale specified on the call to {@link #setClientLocale(Locale)}.
- *
+ *
* @param key The resource bundle key.
* @param args Optional {@link MessageFormat}-style arguments.
* @return
@@ -274,7 +274,7 @@ public class MessageBundle extends ResourceBundle {
/**
* Looks for all the specified keys in the resource bundle and returns the first value that exists.
- *
+ *
* @param keys The list of possible keys.
* @return The resolved value, or <jk>null</jk> if no value is found or the resource bundle is missing.
*/
@@ -290,7 +290,7 @@ public class MessageBundle extends ResourceBundle {
/**
* Same as {@link #findFirstString(String...)}, but uses the specified locale.
- *
+ *
* @param locale The locale of the resource bundle to retrieve message from.
* @param keys The list of possible keys.
* @return The resolved value, or <jk>null</jk> if no value is found or the resource bundle is missing.
@@ -307,7 +307,7 @@ public class MessageBundle extends ResourceBundle {
/**
* Returns all keys in this resource bundle with the specified prefix.
- *
+ *
* @param prefix The prefix.
* @return The set of all keys in the resource bundle with the prefix.
*/
@@ -348,15 +348,15 @@ public class MessageBundle extends ResourceBundle {
/**
* Returns this resource bundle as an {@link ObjectMap}.
- *
+ *
* <p>
* Useful for debugging purposes.
* Note that any class that implements a <code>swap()</code> method will automatically be serialized by
* calling this method and serializing the result.
- *
+ *
* <p>
* This method always constructs a new {@link ObjectMap} on each call.
- *
+ *
* @return A new map containing all the keys and values in this bundle.
*/
public ObjectMap swap() {
@@ -368,7 +368,7 @@ public class MessageBundle extends ResourceBundle {
/**
* Returns the resource bundle for the specified locale.
- *
+ *
* @param locale The client locale.
* @return The resource bundle for the specified locale. Never <jk>null</jk>.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/MetadataMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/MetadataMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/MetadataMap.java
index 459f200..6535f82 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/MetadataMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/MetadataMap.java
@@ -20,10 +20,10 @@ import org.apache.juneau.*;
/**
* Utility class for quick lookup of class metadata instances.
- *
+ *
* <p>
* Class instances are created once and then cached.
- *
+ *
* <p>
* Classes must have a constructor that takes in a single argument.
*/
@@ -35,7 +35,7 @@ public class MetadataMap {
/**
* Constructor.
- *
+ *
* @param c The metadata class to create.
* @param constructorArg The argument needed to construct the metadata.
* @return The cached metadata object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoIntrospector.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
index 9683934..56f1770 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
@@ -21,7 +21,7 @@ import org.apache.juneau.parser.*;
/**
* Used to invoke methods on {@code Objects} using arguments in serialized form.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* String s = <js>"foobar"</js>;
@@ -36,7 +36,7 @@ public final class PojoIntrospector {
/**
* Constructor.
- *
+ *
* @param o The object on which Java methods will be invoked.
* @param p The parser to use to parse the method arguments.
* If <jk>null</jk>, {@link JsonParser#DEFAULT} is used.
@@ -50,7 +50,7 @@ public final class PojoIntrospector {
/**
* Shortcut for calling <code><jk>new</jk> PojoIntrospector(o, <jk>null</jk>);</code>
- *
+ *
* @param o The object on which Java methods will be invoked.
*/
public PojoIntrospector(Object o) {
@@ -59,7 +59,7 @@ public final class PojoIntrospector {
/**
* Primary method. Invokes the specified method on this bean.
- *
+ *
* @param method The method being invoked.
* @param args
* The arguments to pass as parameters to the method.
@@ -96,7 +96,7 @@ public final class PojoIntrospector {
/**
* Convenience method for invoking argument from method signature (@see {@link ClassUtils#getMethodSignature(Method)}.
- *
+ *
* @param method The method being invoked.
* @param args
* The arguments to pass as parameters to the method.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoMerge.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoMerge.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoMerge.java
index b967922..ae21934 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoMerge.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoMerge.java
@@ -16,53 +16,54 @@ import java.lang.reflect.*;
/**
* Utility class for merging POJOs behind a single interface.
- *
+ *
* <p>
* Useful in cases where you want to define beans with 'default' values.
- *
+ *
* <p>
* For example, given the following bean classes...
- *
+ *
* <p class='bcode'>
* <jk>public interface</jk> IA {
* String getX();
* <jk>void</jk> setX(String x);
* }
- *
+ *
* <jk>public class</jk> A <jk>implements</jk> IA {
* <jk>private</jk> String <jf>x</jf>;
- *
+ *
* <jk>public</jk> A(String x) {
* <jk>this</jk>.<jf>x</jf> = x;
* }
- *
+ *
* <jk>public</jk> String getX() {
* <jk>return</jk> <jf>x</jf>;
* }
- *
+ *
* <jk>public void</jk> setX(String x) {
* <jk>this</jk>.<jf>x</jf> = x;
* }
* }
* </p>
- *
+ *
* <p>
* The getters will be called in order until the first non-null value is returned...
- *
+ *
* <p class='bcode'>
* PojoMerge m;
- *
+ *
* m = PojoMerge.<jsm>merge</jsm>(IA.<jk>class</jk>, <jk>new</jk> A(<js>"1"</js>), <jk>new</jk> A(<js>"2"</js>));
* <jsm>assertEquals</jsm>(<js>"1"</js>, m.getX());
- *
+ *
* m = PojoMerge.<jsm>merge</jsm>(IA.<jk>class</jk>, <jk>new</jk> A(<jk>null</jk>), <jk>new</jk> A(<js>"2"</js>));
* <jsm>assertEquals</jsm>(<js>"2"</js>, m.getX());
- *
+ *
* m = PojoMerge.<jsm>merge</jsm>(IA.<jk>class</jk>, <jk>new</jk> A(<jk>null</jk>), <jk>new</jk> A(<jk>null</jk>));
* <jsm>assertEquals</jsm>(<jk>null</jk>, m.getX());
* </p>
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>Null POJOs are ignored.
* <li>Non-getter methods are either invoked on the first POJO or all POJOs depending on the <code>callAllNonGetters</code> flag
@@ -74,10 +75,10 @@ public class PojoMerge {
/**
* Create a proxy interface on top of zero or more POJOs.
- *
+ *
* <p>
* This is a shortcut to calling <code>merge(interfaceClass, <jk>false</jk>, pojos);</code>
- *
+ *
* @param interfaceClass The common interface class.
* @param pojos
* Zero or more POJOs to merge.
@@ -91,7 +92,7 @@ public class PojoMerge {
/**
* Create a proxy interface on top of zero or more POJOs.
- *
+ *
* @param interfaceClass The common interface class.
* @param callAllNonGetters
* If <jk>true</jk>, when calling a method that's not a getter, the method will be invoked on all POJOs.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoQuery.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoQuery.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoQuery.java
index 3ff1666..912098c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoQuery.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoQuery.java
@@ -25,10 +25,10 @@ import org.apache.juneau.internal.*;
/**
* Designed to provide search/view/sort/paging filtering on tabular in-memory POJO models.
- *
+ *
* <p>
* It can also perform just view filtering on beans/maps.
- *
+ *
* <p>
* Examples of tabular POJO models:
* <ul>
@@ -37,7 +37,7 @@ import org.apache.juneau.internal.*;
* <li><tt>Map[]</tt>
* <li><tt>Bean[]</tt>
* </ul>
- *
+ *
* <p>
* Tabular POJO models can be thought of as tables of data. For example, a list of the following beans...
* <p class='bcode'>
@@ -54,7 +54,7 @@ import org.apache.juneau.internal.*;
* <tr><td>123</td><td>'foobar'</td><td>yyyy/MM/dd HH:mm:ss</td></tr>
* <tr><td colspan=3>...</td></tr>
* </table>
- *
+ *
* <p>
* From this table, you can perform the following functions:
* <ul class='spaced-list'>
@@ -67,13 +67,14 @@ import org.apache.juneau.internal.*;
* <li>
* Position/limit - Only return a subset of rows.
* </ul>
- *
+ *
+ *
* <h5 class='topic'>Search</h5>
- *
+ *
* 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).
- *
+ *
* <h5 class='section'>Example:</h5>
* <ul class='spaced-list'>
* <li>
@@ -83,13 +84,14 @@ import org.apache.juneau.internal.*;
* <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>
- *
+ *
* Any objects can be queried against using string patterns.
* If the objects being searched are not strings, then the patterns are matched against whatever is return by the
* {@code Object#toString()} method.
- *
+ *
* <h6 class='topic'>Example string query patterns:</h6>
* <ul>
* <li><tt>foo</tt> - The string 'foo'
@@ -99,7 +101,7 @@ import org.apache.juneau.internal.*;
* <li><tt>foo*</tt> - <tt>*</tt> matches zero-or-more characters.
* <li><tt>foo?</tt> - <tt>?</tt> matches exactly one character
* </ul>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
@@ -109,11 +111,12 @@ import org.apache.juneau.internal.*;
* <li>
* Prepend <tt>-</tt> to tokens that must not match. (e.g. <tt>+foo* -*bar</tt>)
* </ul>
- *
+ *
+ *
* <h5 class='topic'>Numeric Patterns</h5>
- *
+ *
* Any object of type {@link Number} (or numeric primitives) can be searched using numeric patterns.
- *
+ *
* <h6 class='topic'>Example numeric query patterns:</h6>
* <ul>
* <li><tt>123</tt> - The single number 123
@@ -125,7 +128,7 @@ import org.apache.juneau.internal.*;
* <li><tt>>= 100</tt> - Greater than or equal to 100
* <li><tt>!123</tt> - Not 123
* </ul>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>
@@ -133,15 +136,16 @@ import org.apache.juneau.internal.*;
* <li>
* Negative numbers are supported.
* </ul>
- *
+ *
+ *
* <h5 class='topic'>Date Patterns</h5>
- *
+ *
* Any object of type {@link Date} or {@link Calendar} can be searched using date patterns.
- *
+ *
* <p>
* The default valid input timestamp formats (which can be overridden via the {@link #setValidTimestampFormats(String...)}
* method are...
- *
+ *
* <ul>
* <li><tt>yyyy.MM.dd.HH.mm.ss</tt>
* <li><tt>yyyy.MM.dd.HH.mm</tt>
@@ -150,7 +154,7 @@ import org.apache.juneau.internal.*;
* <li><tt>yyyy.MM</tt>
* <li><tt>yyyy</tt>
* </ul>
- *
+ *
* <h6 class='topic'>Example date query patterns:</h6>
* <ul>
* <li><tt>2001</tt> - A specific year.
@@ -160,29 +164,31 @@ import org.apache.juneau.internal.*;
* <li><tt>2001 - 2003.06.30</tt> - A date range.
* <li><tt>2001 2003 2005</tt> - Multiple date patterns are ORed.
* </ul>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Whitespace is ignored in search patterns.
* </ul>
- *
+ *
+ *
* <h5 class='topic'>View</h5>
- *
+ *
* 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>.
- *
+ *
* <h6 class='topic'>Example view parameters:</h6>
* <ul>
* <li><tt>column1</tt> - Return only column 'column1'.
* <li><tt>column2, column1</tt> - Return only columns 'column2' and 'column1' in that order.
* </ul>
- *
+ *
+ *
* <h5 class='topic'>Sort</h5>
- *
+ *
* 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
* ascending and descending order accordingly.
- *
+ *
* <h6 class='topic'>Example sort parameters:</h6>
* <ul>
* <li><tt>column1</tt> - Sort rows by column 'column1' ascending.
@@ -190,9 +196,10 @@ import org.apache.juneau.internal.*;
* <li><tt>column1-</tt> - Sort rows by column 'column1' descending.
* <li><tt>column1, column2-</tt> - Sort rows by column 'column1' ascending, then 'column2' descending.
* </ul>
- *
+ *
+ *
* <h5 class='topic'>Paging</h5>
- *
+ *
* Use the <tt>position</tt> and <tt>limit</tt> parameters to specify a subset of rows to return.
*/
@SuppressWarnings({"unchecked","rawtypes"})
@@ -204,7 +211,7 @@ public final class PojoQuery {
/**
* Constructor.
- *
+ *
* @param input The POJO we're going to be filtering.
* @param session The bean session to use to create bean maps for beans.
*/
@@ -216,7 +223,7 @@ public final class PojoQuery {
/**
* Filters the input object as a collection of maps.
- *
+ *
* @param args The search arguments.
* @return The filtered collection.
* Returns the unaltered input if the input is not a collection or array of objects.
@@ -505,7 +512,7 @@ public final class PojoQuery {
/**
* Construct a number matcher for the given search pattern.
- *
+ *
* @param searchPattern A date search paattern. See class usage for a description.
*/
public NumberMatcher(String searchPattern) {
@@ -651,7 +658,7 @@ public final class PojoQuery {
/**
* Use this method to override the allowed search patterns when used in locales where time formats are different.
- *
+ *
* @param s A comma-delimited list of valid time formats.
*/
public void setValidTimestampFormats(String...s) {
@@ -666,7 +673,7 @@ public final class PojoQuery {
/**
* Construct a timestamp matcher for the given search pattern.
- *
+ *
* @param searchPattern The search pattern.
*/
DateMatcher(String searchPattern) {
@@ -677,7 +684,7 @@ public final class PojoQuery {
/**
* Returns <jk>true</jk> if the specified date matches the pattern passed in through the constructor.
- *
+ *
* <p>
* <br>The Object can be of type {@link Date} or {@link Calendar}.
* <br>Always returns <jk>false</jk> on <jk>null</jk> input.
@@ -851,7 +858,7 @@ public final class PojoQuery {
* Parses a timestamp string off the beginning of the string segment 'seg'.
* Goes through each possible valid timestamp format until it finds a match.
* The position where the parsing left off is stored in pp.
- *
+ *
* @param seg The string segment being parsed.
* @param pp Where parsing last left off.
* @return An object representing a timestamp.
@@ -919,7 +926,7 @@ public final class PojoQuery {
/**
* Construct a string matcher for the given search pattern.
- *
+ *
* @param searchPattern The search pattern. See class usage for details.
* @param ignoreCase If <jk>true</jk>, use case-insensitive matching.
*/
@@ -1132,7 +1139,7 @@ public final class PojoQuery {
/**
* Replaces tokens in a string with a different token.
- *
+ *
* <p>
* replace("A and B and C", "and", "or") -> "A or B or C"
* replace("andandand", "and", "or") -> "ororor"
[29/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java
index 9437a10..9c6476c 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlBuilder.java
@@ -14,7 +14,7 @@ package org.apache.juneau.dto.html5;
/**
* Various useful static methods for creating HTML elements.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -24,14 +24,14 @@ package org.apache.juneau.dto.html5;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
public class HtmlBuilder {
/**
* Creates an empty {@link A} element.
- *
+ *
* @return The new element.
*/
public static final A a() {
@@ -41,7 +41,7 @@ public class HtmlBuilder {
/**
* Creates an {@link A} element with the specified {@link A#href(Object)} attribute and {@link A#children(Object[])}
* nodes.
- *
+ *
* @param href The {@link A#href(Object)} attribute.
* @param children The {@link A#children(Object[])} nodes.
* @return The new element.
@@ -52,7 +52,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Abbr} element.
- *
+ *
* @return The new element.
*/
public static final Abbr abbr() {
@@ -62,7 +62,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Abbr} element with the specified {@link Abbr#title(String)} attribute and
* {@link Abbr#children(Object[])} nodes.
- *
+ *
* @param title The {@link Abbr#title(String)} attribute.
* @param children The {@link Abbr#children(Object[])} nodes.
* @return The new element.
@@ -73,7 +73,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Address} element.
- *
+ *
* @return The new element.
*/
public static final Address address() {
@@ -82,7 +82,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Address} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -92,7 +92,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Area} element.
- *
+ *
* @return The new element.
*/
public static final Area area() {
@@ -102,7 +102,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Area} element with the specified {@link Area#shape(String)}, {@link Area#coords(String)},
* and {@link Area#href(Object)} attributes.
- *
+ *
* @param shape The {@link Area#shape(String)} attribute.
* @param coords The {@link Area#coords(String)} attribute.
* @param href The {@link Area#href(Object)} attribute.
@@ -114,7 +114,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Article} element.
- *
+ *
* @return The new element.
*/
public static final Article article() {
@@ -123,7 +123,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Article} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -133,7 +133,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Aside} element.
- *
+ *
* @return The new element.
*/
public static final Aside aside() {
@@ -142,7 +142,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Aside} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -152,7 +152,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Audio} element.
- *
+ *
* @return The new element.
*/
public static final Audio audio() {
@@ -161,7 +161,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Audio} element with the specified {@link Audio#src(Object)} attribute.
- *
+ *
* @param src The {@link Audio#src(Object)} attribute.
* @return The new element.
*/
@@ -171,7 +171,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link B} element.
- *
+ *
* @return The new element.
*/
public static final B b() {
@@ -180,7 +180,7 @@ public class HtmlBuilder {
/**
* Creates a {@link B} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -190,7 +190,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Base} element.
- *
+ *
* @return The new element.
*/
public static final Base base() {
@@ -199,7 +199,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Base} element with the specified {@link Base#href(Object)} attribute.
- *
+ *
* @param href The {@link Base#href(Object)} attribute.
* @return The new element.
*/
@@ -209,7 +209,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Bdi} element.
- *
+ *
* @return The new element.
*/
public static final Bdi bdi() {
@@ -218,7 +218,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Bdi} element with the specified {@link Bdi#text(Object)} node.
- *
+ *
* @param text The {@link Bdi#text(Object)} node.
* @return The new element.
*/
@@ -228,7 +228,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Bdo} element.
- *
+ *
* @return The new element.
*/
public static final Bdo bdo() {
@@ -237,7 +237,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Bdo} element with the specified {@link Bdo#dir(String)} attribute and child nodes.
- *
+ *
* @param dir The {@link Bdo#dir(String)} attribute.
* @param children The child nodes.
* @return The new element.
@@ -248,7 +248,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Blockquote} element.
- *
+ *
* @return The new element.
*/
public static final Blockquote blockquote() {
@@ -257,7 +257,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Blockquote} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -267,7 +267,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Body} element.
- *
+ *
* @return The new element.
*/
public static final Body body() {
@@ -276,7 +276,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Body} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -286,7 +286,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Br} element.
- *
+ *
* @return The new element.
*/
public static final Br br() {
@@ -295,7 +295,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Button} element.
- *
+ *
* @return The new element.
*/
public static final Button button() {
@@ -304,7 +304,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Button} element with the specified {@link Button#type(String)} attribute.
- *
+ *
* @param type The {@link Button#type(String)} attribute.
* @return The new element.
*/
@@ -315,7 +315,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Button} element with the specified {@link Button#type(String)} attribute and
* {@link Button#children(Object[])} nodes.
- *
+ *
* @param type The {@link Button#type(String)} attribute.
* @param children The {@link Button#children(Object[])} nodes.
* @return The new element.
@@ -335,7 +335,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Canvas} element with the specified {@link Canvas#width(Object)} and
* {@link Canvas#height(Object)} attributes.
- *
+ *
* @param width The {@link Canvas#width(Object)} attribute.
* @param height The {@link Canvas#height(Object)} attribute.
* @return The new element.
@@ -346,7 +346,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Caption} element.
- *
+ *
* @return The new element.
*/
public static final Caption caption() {
@@ -355,7 +355,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Caption} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -365,7 +365,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Cite} element.
- *
+ *
* @return The new element.
*/
public static final Cite cite() {
@@ -374,7 +374,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Cite} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -384,7 +384,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Code} element.
- *
+ *
* @return The new element.
*/
public static final Code code() {
@@ -393,7 +393,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Code} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -403,9 +403,9 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Col} element.
- *
+ *
* @return The new element.
- *
+ *
*/
public static final Col col() {
return new Col();
@@ -413,7 +413,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Col} element with the specified {@link Col#span(Object)} attribute.
- *
+ *
* @param span The {@link Col#span(Object)} attribute.
* @return The new element.
*/
@@ -423,7 +423,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Colgroup} element.
- *
+ *
* @return The new element.
*/
public static final Colgroup colgroup() {
@@ -432,7 +432,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Colgroup} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -442,7 +442,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Data} element.
- *
+ *
* @return The new element.
*/
public static final Data data() {
@@ -451,7 +451,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Data} element with the specified {@link Data#value(Object)} attribute and child node.
- *
+ *
* @param value The {@link Data#value(Object)} attribute.
* @param child The child node.
* @return The new element.
@@ -462,7 +462,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Datalist} element.
- *
+ *
* @return The new element.
*/
public static final Datalist datalist() {
@@ -471,7 +471,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Datalist} element with the specified {@link Datalist#id(String)} attribute and child nodes.
- *
+ *
* @param id The {@link Datalist#id(String)} attribute.
* @param children The child nodes.
* @return The new element.
@@ -482,7 +482,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Dd} element.
- *
+ *
* @return The new element.
*/
public static final Dd dd() {
@@ -491,7 +491,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Dd} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -501,7 +501,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Del} element.
- *
+ *
* @return The new element.
*/
public static final Del del() {
@@ -510,7 +510,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Del} element with the specified {@link Del#children(Object[])} node.
- *
+ *
* @param children The {@link Del#children(Object[])} node.
* @return The new element.
*/
@@ -520,7 +520,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Dfn} element.
- *
+ *
* @return The new element.
*/
public static final Dfn dfn() {
@@ -529,7 +529,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Dfn} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -539,7 +539,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Div} element.
- *
+ *
* @return The new element.
*/
public static final Div div() {
@@ -548,7 +548,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Div} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -558,7 +558,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Dl} element.
- *
+ *
* @return The new element.
*/
public static final Dl dl() {
@@ -567,7 +567,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Dl} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -577,7 +577,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Dt} element.
- *
+ *
* @return The new element.
*/
public static final Dt dt() {
@@ -586,7 +586,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Dt} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -596,7 +596,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Em} element.
- *
+ *
* @return The new element.
*/
public static final Em em() {
@@ -605,7 +605,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Em} element with the specified {@link Em#children(Object[])} nodes.
- *
+ *
* @param children The {@link Em#children(Object[])} nodes.
* @return The new element.
*/
@@ -615,7 +615,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Embed} element.
- *
+ *
* @return The new element.
*/
public static final Embed embed() {
@@ -624,7 +624,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Embed} element with the specified {@link Embed#src(Object)} attribute.
- *
+ *
* @param src The {@link Embed#src(Object)} attribute.
* @return The new element.
*/
@@ -634,7 +634,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Fieldset} element.
- *
+ *
* @return The new element.
*/
public static final Fieldset fieldset() {
@@ -643,7 +643,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Fieldset} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -653,7 +653,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Figcaption} element.
- *
+ *
* @return The new element.
*/
public static final Figcaption figcaption() {
@@ -662,7 +662,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Figcaption} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -672,7 +672,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Figure} element.
- *
+ *
* @return The new element.
*/
public static final Figure figure() {
@@ -681,7 +681,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Figure} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -691,7 +691,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Footer} element.
- *
+ *
* @return The new element.
*/
public static final Footer footer() {
@@ -700,7 +700,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Footer} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -710,7 +710,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Form} element.
- *
+ *
* @return The new element.
*/
public static final Form form() {
@@ -719,7 +719,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Form} element with the specified {@link Form#action(String)} attribute.
- *
+ *
* @param action The {@link Form#action(String)} attribute.
* @return The new element.
*/
@@ -729,7 +729,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Form} element with the specified {@link Form#action(String)} attribute and child nodes.
- *
+ *
* @param action The {@link Form#action(String)} attribute.
* @param children The child nodes.
* @return The new element.
@@ -740,7 +740,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link H1} element.
- *
+ *
* @return The new element.
*/
public static final H1 h1() {
@@ -749,7 +749,7 @@ public class HtmlBuilder {
/**
* Creates an {@link H1} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -759,7 +759,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link H2} element.
- *
+ *
* @return The new element.
*/
public static final H2 h2() {
@@ -768,7 +768,7 @@ public class HtmlBuilder {
/**
* Creates an {@link H2} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -778,7 +778,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link H3} element.
- *
+ *
* @return The new element.
*/
public static final H3 h3() {
@@ -787,7 +787,7 @@ public class HtmlBuilder {
/**
* Creates an {@link H3} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -797,7 +797,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link H4} element.
- *
+ *
* @return The new element.
*/
public static final H4 h4() {
@@ -806,7 +806,7 @@ public class HtmlBuilder {
/**
* Creates an {@link H4} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -816,7 +816,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link H5} element.
- *
+ *
* @return The new element.
*/
public static final H5 h5() {
@@ -825,7 +825,7 @@ public class HtmlBuilder {
/**
* Creates an {@link H5} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -843,7 +843,7 @@ public class HtmlBuilder {
/**
* Creates an {@link H6} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -853,7 +853,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Head} element.
- *
+ *
* @return The new element.
*/
public static final Head head() {
@@ -862,7 +862,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Head} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -872,7 +872,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Header} element.
- *
+ *
* @return The new element.
*/
public static final Header header() {
@@ -881,7 +881,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Header} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -891,7 +891,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Hr} element.
- *
+ *
* @return The new element.
*/
public static final Hr hr() {
@@ -900,7 +900,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Html} element.
- *
+ *
* @return The new element.
*/
public static final Html html() {
@@ -909,7 +909,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Html} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -919,7 +919,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link I} element.
- *
+ *
* @return The new element.
*/
public static final I i() {
@@ -928,7 +928,7 @@ public class HtmlBuilder {
/**
* Creates an {@link I} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -938,7 +938,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Iframe} element.
- *
+ *
* @return The new element.
*/
public static final Iframe iframe() {
@@ -947,7 +947,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Iframe} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -957,7 +957,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Img} element.
- *
+ *
* @return The new element.
*/
public static final Img img() {
@@ -966,7 +966,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Img} element with the specified {@link Img#src(Object)} attribute.
- *
+ *
* @param src The {@link Img#src(Object)} attribute.
* @return The new element.
*/
@@ -976,7 +976,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Input} element.
- *
+ *
* @return The new element.
*/
public static final Input input() {
@@ -985,7 +985,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Input} element with the specified {@link Input#type(String)} attribute.
- *
+ *
* @param type The {@link Input#type(String)} attribute.
* @return The new element.
*/
@@ -995,7 +995,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Ins} element.
- *
+ *
* @return The new element.
*/
public static final Ins ins() {
@@ -1004,7 +1004,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Ins} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1014,7 +1014,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Kbd} element.
- *
+ *
* @return The new element.
*/
public static final Kbd kbd() {
@@ -1023,7 +1023,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Kbd} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1033,7 +1033,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Keygen} element.
- *
+ *
* @return The new element.
*/
public static final Keygen keygen() {
@@ -1042,7 +1042,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Label} element.
- *
+ *
* @return The new element.
*/
public static final Label label() {
@@ -1051,7 +1051,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Label} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1061,7 +1061,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Legend} element.
- *
+ *
* @return The new element.
*/
public static final Legend legend() {
@@ -1070,7 +1070,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Legend} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1080,7 +1080,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Li} element.
- *
+ *
* @return The new element.
*/
public static final Li li() {
@@ -1089,7 +1089,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Li} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1099,7 +1099,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Link} element.
- *
+ *
* @return The new element.
*/
public static final Link link() {
@@ -1108,7 +1108,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Link} element with the specified {@link Link#href(Object)} attribute.
- *
+ *
* @param href The {@link Link#href(Object)} attribute.
* @return The new element.
*/
@@ -1118,7 +1118,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Main} element.
- *
+ *
* @return The new element.
*/
public static final Main main() {
@@ -1127,7 +1127,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Main} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1137,7 +1137,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Map} element.
- *
+ *
* @return The new element.
*/
public static final Map map() {
@@ -1146,7 +1146,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Map} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1156,7 +1156,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Mark} element.
- *
+ *
* @return The new element.
*/
public static final Mark mark() {
@@ -1165,7 +1165,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Mark} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1175,7 +1175,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Meta} element.
- *
+ *
* @return The new element.
*/
public static final Meta meta() {
@@ -1184,7 +1184,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Meter} element.
- *
+ *
* @return The new element.
*/
public static final Meter meter() {
@@ -1193,7 +1193,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Meter} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1203,7 +1203,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Nav} element.
- *
+ *
* @return The new element.
*/
public static final Nav nav() {
@@ -1212,7 +1212,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Nav} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1222,7 +1222,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Noscript} element.
- *
+ *
* @return The new element.
*/
public static final Noscript noscript() {
@@ -1231,7 +1231,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Noscript} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1241,7 +1241,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Object2} element.
- *
+ *
* @return The new element.
*/
public static final Object2 object() {
@@ -1250,7 +1250,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Object2} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1260,7 +1260,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Ol} element.
- *
+ *
* @return The new element.
*/
public static final Ol ol() {
@@ -1269,7 +1269,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Ol} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1279,7 +1279,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Optgroup} element.
- *
+ *
* @return The new element.
*/
public static final Optgroup optgroup() {
@@ -1288,7 +1288,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Optgroup} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1298,7 +1298,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Option} element.
- *
+ *
* @return The new element.
*/
public static final Option option() {
@@ -1307,7 +1307,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Option} element with the specified {@link Option#text(Object)} attribute.
- *
+ *
* @param text The {@link Option#text(Object)} attribute.
* @return The new element.
*/
@@ -1318,7 +1318,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Option} element with the specified {@link Option#value(Object)} attribute and
* {@link Option#text(Object)} node.
- *
+ *
* @param value The {@link Option#value(Object)} attribute.
* @param text The {@link Option#text(Object)} node.
* @return The new element.
@@ -1329,7 +1329,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Output} element.
- *
+ *
* @return The new element.
*/
public static final Output output() {
@@ -1338,7 +1338,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Output} element with the specified {@link Output#name(String)} attribute.
- *
+ *
* @param name The {@link Output#name(String)} attribute.
* @return The new element.
*/
@@ -1348,7 +1348,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link P} element.
- *
+ *
* @return The new element.
*/
public static final P p() {
@@ -1357,7 +1357,7 @@ public class HtmlBuilder {
/**
* Creates a {@link P} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1367,7 +1367,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Param} element.
- *
+ *
* @return The new element.
*/
public static final Param param() {
@@ -1377,7 +1377,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Param} element with the specified {@link Param#name(String)} and {@link Param#value(Object)}
* attributes.
- *
+ *
* @param name The {@link Param#name(String)} attribute.
* @param value The {@link Param#value(Object)} attribute.
* @return The new element.
@@ -1388,7 +1388,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Pre} element.
- *
+ *
* @return The new element.
*/
public static final Pre pre() {
@@ -1397,7 +1397,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Pre} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1407,7 +1407,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Progress} element.
- *
+ *
* @return The new element.
*/
public static final Progress progress() {
@@ -1416,7 +1416,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Progress} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1426,7 +1426,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Q} element.
- *
+ *
* @return The new element.
*/
public static final Q q() {
@@ -1435,7 +1435,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Q} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1445,7 +1445,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Rb} element.
- *
+ *
* @return The new element.
*/
public static final Rb rb() {
@@ -1454,7 +1454,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Rb} element with the specified {@link Rb#children(Object[])} nodes.
- *
+ *
* @param children The {@link Rb#children(Object[])} nodes.
* @return The new element.
*/
@@ -1464,7 +1464,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Rp} element.
- *
+ *
* @return The new element.
*/
public static final Rp rp() {
@@ -1473,7 +1473,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Rp} element with the specified {@link Rp#children(Object[])} nodes.
- *
+ *
* @param children The {@link Rp#children(Object[])} nodes.
* @return The new element.
*/
@@ -1483,7 +1483,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Rt} element.
- *
+ *
* @return The new element.
*/
public static final Rt rt() {
@@ -1492,7 +1492,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Rt} element with the specified {@link Rt#children(Object[])} nodes.
- *
+ *
* @param children The {@link Rt#children(Object[])} nodes.
* @return The new element.
*/
@@ -1502,7 +1502,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Rtc} element.
- *
+ *
* @return The new element.
*/
public static final Rtc rtc() {
@@ -1511,7 +1511,7 @@ public class HtmlBuilder {
/**
* Creates an {@link Rtc} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1521,7 +1521,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Ruby} element.
- *
+ *
* @return The new element.
*/
public static final Ruby ruby() {
@@ -1530,7 +1530,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Ruby} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1540,7 +1540,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link S} element.
- *
+ *
* @return The new element.
*/
public static final S s() {
@@ -1549,7 +1549,7 @@ public class HtmlBuilder {
/**
* Creates an {@link S} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1559,7 +1559,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Samp} element.
- *
+ *
* @return The new element.
*/
public static final Samp samp() {
@@ -1568,7 +1568,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Samp} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1578,7 +1578,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Script} element.
- *
+ *
* @return The new element.
*/
public static final Script script() {
@@ -1588,7 +1588,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Script} element with the specified {@link Script#type(String)} attribute and
* {@link Script#text(Object)} node.
- *
+ *
* @param type The {@link Script#type(String)} attribute.
* @param text The child text node.
* @return The new element.
@@ -1599,7 +1599,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Section} element.
- *
+ *
* @return The new element.
*/
public static final Section section() {
@@ -1608,7 +1608,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Section} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1618,7 +1618,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Select} element.
- *
+ *
* @return The new element.
*/
public static final Select select() {
@@ -1627,7 +1627,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Select} element with the specified {@link Select#name(String)} attribute and child nodes.
- *
+ *
* @param name The {@link Select#name(String)} attribute.
* @param children The child nodes.
* @return The new element.
@@ -1638,7 +1638,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Small} element.
- *
+ *
* @return The new element.
*/
public static final Small small() {
@@ -1647,7 +1647,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Small} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1657,7 +1657,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Source} element.
- *
+ *
* @return The new element.
*/
public static final Source source() {
@@ -1667,7 +1667,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Source} element with the specified {@link Source#src(Object)} and {@link Source#type(String)}
* attributes.
- *
+ *
* @param src The {@link Source#src(Object)} attribute.
* @param type The {@link Source#type(String)} attribute.
* @return The new element.
@@ -1678,7 +1678,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Span} element.
- *
+ *
* @return The new element.
*/
public static final Span span() {
@@ -1687,7 +1687,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Span} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1697,7 +1697,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Strong} element.
- *
+ *
* @return The new element.
*/
public static final Strong strong() {
@@ -1706,7 +1706,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Strong} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1716,7 +1716,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Style} element.
- *
+ *
* @return The new element.
*/
public static final Style style() {
@@ -1725,7 +1725,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Style} element with the specified {@link Style#text(Object)} node.
- *
+ *
* @param text The {@link Style#text(Object)} node.
* @return The new element.
*/
@@ -1735,7 +1735,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Sub} element.
- *
+ *
* @return The new element.
*/
public static final Sub sub() {
@@ -1744,7 +1744,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Sub} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1754,7 +1754,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Sup} element.
- *
+ *
* @return The new element.
*/
public static final Sup sup() {
@@ -1763,7 +1763,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Sup} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1773,7 +1773,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Table} element.
- *
+ *
* @return The new element.
*/
public static final Table table() {
@@ -1782,7 +1782,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Table} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1792,7 +1792,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Tbody} element.
- *
+ *
* @return The new element.
*/
public static final Tbody tbody() {
@@ -1801,7 +1801,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Tbody} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1811,7 +1811,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Td} element.
- *
+ *
* @return The new element.
*/
public static final Td td() {
@@ -1820,7 +1820,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Td} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1830,7 +1830,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Template} element.
- *
+ *
* @return The new element.
*/
public static final Template template() {
@@ -1839,7 +1839,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Template} element with the specified {@link Template#id(String)} attribute and child nodes.
- *
+ *
* @param id The {@link Template#id(String)} attribute.
* @param children The child nodes.
* @return The new element.
@@ -1850,7 +1850,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Textarea} element.
- *
+ *
* @return The new element.
*/
public static final Textarea textarea() {
@@ -1860,7 +1860,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Textarea} element with the specified {@link Textarea#name(String)} attribute and
* {@link Textarea#text(Object)} node.
- *
+ *
* @param name The {@link Textarea#name(String)} attribute.
* @param text The {@link Textarea#text(Object)} node.
* @return The new element.
@@ -1871,7 +1871,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Tfoot} element.
- *
+ *
* @return The new element.
*/
public static final Tfoot tfoot() {
@@ -1880,7 +1880,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Tfoot} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1890,7 +1890,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Th} element.
- *
+ *
* @return The new element.
*/
public static final Th th() {
@@ -1899,7 +1899,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Th} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1909,7 +1909,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Thead} element.
- *
+ *
* @return The new element.
*/
public static final Thead thead() {
@@ -1918,7 +1918,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Thead} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1928,7 +1928,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Time} element.
- *
+ *
* @return The new element.
*/
public static final Time time() {
@@ -1937,7 +1937,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Time} element with the specified {@link Time#children(Object[])} nodes.
- *
+ *
* @param children The {@link Time#children(Object[])} nodes.
* @return The new element.
*/
@@ -1947,7 +1947,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Title} element.
- *
+ *
* @return The new element.
*/
public static final Title title() {
@@ -1956,7 +1956,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Title} element with the specified {@link Title#text(Object)} node.
- *
+ *
* @param text The {@link Title#text(Object)} node.
* @return The new element.
*/
@@ -1966,7 +1966,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Tr} element.
- *
+ *
* @return The new element.
*/
public static final Tr tr() {
@@ -1975,7 +1975,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Tr} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -1985,7 +1985,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Track} element.
- *
+ *
* @return The new element.
*/
public static final Track track() {
@@ -1995,7 +1995,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Track} element with the specified {@link Track#src(Object)} and {@link Track#kind(String)}
* attributes.
- *
+ *
* @param src The {@link Track#src(Object)} attribute.
* @param kind The {@link Track#kind(String)} attribute.
* @return The new element.
@@ -2006,7 +2006,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link U} element.
- *
+ *
* @return The new element.
*/
public static final U u() {
@@ -2015,7 +2015,7 @@ public class HtmlBuilder {
/**
* Creates a {@link U} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -2025,7 +2025,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Ul} element.
- *
+ *
* @return The new element.
*/
public static final Ul ul() {
@@ -2034,7 +2034,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Ul} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -2044,7 +2044,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Var} element.
- *
+ *
* @return The new element.
*/
public static final Var var() {
@@ -2053,7 +2053,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Var} element with the specified child nodes.
- *
+ *
* @param children The child nodes.
* @return The new element.
*/
@@ -2063,7 +2063,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Video} element.
- *
+ *
* @return The new element.
*/
public static final Video video() {
@@ -2072,7 +2072,7 @@ public class HtmlBuilder {
/**
* Creates a {@link Video} element with the specified {@link Video#src(Object)} attribute.
- *
+ *
* @param src The {@link Video#src(Object)} attribute.
* @return The new element.
*/
@@ -2082,7 +2082,7 @@ public class HtmlBuilder {
/**
* Creates an empty {@link Wbr} element.
- *
+ *
* @return The new element.
*/
public static final Wbr wbr() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
index 1f93e87..1ce5ccd 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
@@ -27,10 +27,10 @@ import org.apache.juneau.xml.annotation.*;
/**
* Superclass for all HTML elements.
- *
+ *
* <p>
* These are beans that when serialized using {@link HtmlSerializer} generate valid HTML5 elements.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -40,7 +40,7 @@ import org.apache.juneau.xml.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@org.apache.juneau.html.annotation.Html(asXml=true)
@@ -50,7 +50,7 @@ public abstract class HtmlElement {
/**
* The attributes of this element.
- *
+ *
* @return The attributes of this element.
*/
@Xml(format=ATTRS)
@@ -61,7 +61,7 @@ public abstract class HtmlElement {
/**
* Sets the attributes for this element.
- *
+ *
* @param attrs The new attributes for this element.
* @return This object (for method chaining).
*/
@@ -78,7 +78,7 @@ public abstract class HtmlElement {
/**
* Adds an arbitrary attribute to this element.
- *
+ *
* @param key The attribute name.
* @param val The attribute value.
* @return This object (for method chaining).
@@ -94,18 +94,18 @@ public abstract class HtmlElement {
/**
* Adds an arbitrary URI attribute to this element.
- *
+ *
* <p>
* Same as {@link #attr(String, Object)}, except if the value is a string that appears to be a URI
* (e.g. <js>"servlet:/xxx"</js>).
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param key The attribute name.
* @param val The attribute value.
* @return This object (for method chaining).
@@ -119,7 +119,7 @@ public abstract class HtmlElement {
/**
* Returns the attribute with the specified name.
- *
+ *
* @param key The attribute name.
* @return The attribute value, or <jk>null</jk> if the named attribute does not exist.
*/
@@ -129,7 +129,7 @@ public abstract class HtmlElement {
/**
* Returns the attribute with the specified name converted to the specified class type.
- *
+ *
* @param type
* The class type to convert this class to.
* See {@link ObjectUtils} for a list of supported conversion types.
@@ -143,7 +143,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/editing.html#the-accesskey-attribute">accesskey</a>
* attribute.
- *
+ *
* @param accesskey The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -154,7 +154,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#classes">class</a> attribute.
- *
+ *
* @param _class The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -166,7 +166,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/editing.html#attr-contenteditable">contenteditable</a>
* attribute.
- *
+ *
* @param contenteditable The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -178,7 +178,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#the-dir-attribute">dir</a> attribute.
- *
+ *
* @param dir The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -189,7 +189,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/editing.html#the-hidden-attribute">hidden</a> attribute.
- *
+ *
* @param hidden
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -202,7 +202,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#the-id-attribute">id</a> attribute.
- *
+ *
* @param id The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -213,7 +213,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#attr-lang">lang</a> attribute.
- *
+ *
* @param lang The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -224,7 +224,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onabort">onabort</a> attribute.
- *
+ *
* @param onabort The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -235,7 +235,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onblur">onblur</a> attribute.
- *
+ *
* @param onblur The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -246,7 +246,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oncancel">oncancel</a> attribute.
- *
+ *
* @param oncancel The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -257,7 +257,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oncanplay">oncanplay</a> attribute.
- *
+ *
* @param oncanplay The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -269,7 +269,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oncanplaythrough">oncanplaythrough</a>
* attribute.
- *
+ *
* @param oncanplaythrough The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -280,7 +280,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onchange">onchange</a> attribute.
- *
+ *
* @param onchange The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -291,7 +291,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onclick">onclick</a> attribute.
- *
+ *
* @param onclick The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -303,7 +303,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oncuechange">oncuechange</a>
* attribute.
- *
+ *
* @param oncuechange The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -314,7 +314,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-ondblclick">ondblclick</a> attribute.
- *
+ *
* @param ondblclick The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -326,7 +326,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-ondurationchange">ondurationchange</a>
* attribute.
- *
+ *
* @param ondurationchange The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -337,7 +337,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onemptied">onemptied</a> attribute.
- *
+ *
* @param onemptied The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -348,7 +348,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onended">onended</a> attribute.
- *
+ *
* @param onended The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -359,7 +359,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onerror">onerror</a> attribute.
- *
+ *
* @param onerror The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -370,7 +370,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onfocus">onfocus</a> attribute.
- *
+ *
* @param onfocus The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -381,7 +381,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oninput">oninput</a> attribute.
- *
+ *
* @param oninput The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -392,7 +392,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-oninvalid">oninvalid</a> attribute.
- *
+ *
* @param oninvalid The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -403,7 +403,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onkeydown">onkeydown</a> attribute.
- *
+ *
* @param onkeydown The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -414,7 +414,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onkeypress">onkeypress</a> attribute.
- *
+ *
* @param onkeypress The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -425,7 +425,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onkeyup">onkeyup</a> attribute.
- *
+ *
* @param onkeyup The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -436,7 +436,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onload">onload</a> attribute.
- *
+ *
* @param onload The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -448,7 +448,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onloadeddata">onloadeddata</a>
* attribute.
- *
+ *
* @param onloadeddata The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -460,7 +460,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onloadedmetadata">onloadedmetadata</a>
* attribute.
- *
+ *
* @param onloadedmetadata The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -472,7 +472,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onloadstart">onloadstart</a>
* attribute.
- *
+ *
* @param onloadstart The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -484,7 +484,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmousedown">onmousedown</a>
* attribute.
- *
+ *
* @param onmousedown The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -495,7 +495,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmouseenter">onmouseenter</a> attribute.
- *
+ *
* @param onmouseenter The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -507,7 +507,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmouseleave">onmouseleave</a>
* attribute.
- *
+ *
* @param onmouseleave The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -519,7 +519,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmousemove">onmousemove</a>
* attribute.
- *
+ *
* @param onmousemove The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -530,7 +530,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmouseout">onmouseout</a> attribute.
- *
+ *
* @param onmouseout The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -542,7 +542,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmouseover">onmouseover</a>
* attribute.
- *
+ *
* @param onmouseover The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -553,7 +553,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmouseup">onmouseup</a> attribute.
- *
+ *
* @param onmouseup The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -565,7 +565,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onmousewheel">onmousewheel</a>
* attribute.
- *
+ *
* @param onmousewheel The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -576,7 +576,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onpause">onpause</a> attribute.
- *
+ *
* @param onpause The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -587,7 +587,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onplay">onplay</a> attribute.
- *
+ *
* @param onplay The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -598,7 +598,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onplaying">onplaying</a> attribute.
- *
+ *
* @param onplaying The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -609,7 +609,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onprogress">onprogress</a> attribute.
- *
+ *
* @param onprogress The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -621,7 +621,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onratechange">onratechange</a>
* attribute.
- *
+ *
* @param onratechange The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -632,7 +632,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onreset">onreset</a> attribute.
- *
+ *
* @param onreset The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -643,7 +643,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onresize">onresize</a> attribute.
- *
+ *
* @param onresize The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -654,7 +654,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onscroll">onscroll</a> attribute.
- *
+ *
* @param onscroll The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -665,7 +665,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onseeked">onseeked</a> attribute.
- *
+ *
* @param onseeked The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -676,7 +676,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onseeking">onseeking</a> attribute.
- *
+ *
* @param onseeking The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -687,7 +687,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onselect">onselect</a> attribute.
- *
+ *
* @param onselect The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -698,7 +698,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onshow">onshow</a> attribute.
- *
+ *
* @param onshow The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -709,7 +709,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onstalled">onstalled</a> attribute.
- *
+ *
* @param onstalled The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -720,7 +720,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onsubmit">onsubmit</a> attribute.
- *
+ *
* @param onsubmit The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -731,7 +731,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onsuspend">onsuspend</a> attribute.
- *
+ *
* @param onsuspend The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -743,7 +743,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-ontimeupdate">ontimeupdate</a>
* attribute.
- *
+ *
* @param ontimeupdate The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -754,7 +754,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-ontoggle">ontoggle</a> attribute.
- *
+ *
* @param ontoggle The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -766,7 +766,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onvolumechange">onvolumechange</a>
* attribute.
- *
+ *
* @param onvolumechange The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -777,7 +777,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-onwaiting">onwaiting</a> attribute.
- *
+ *
* @param onwaiting The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -788,7 +788,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/editing.html#attr-spellcheck">spellcheck</a> attribute.
- *
+ *
* @param spellcheck
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -801,7 +801,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#the-style-attribute">style</a> attribute.
- *
+ *
* @param style The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -812,7 +812,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/editing.html#attr-tabindex">tabindex</a> attribute.
- *
+ *
* @param tabindex
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -825,7 +825,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#attr-title">title</a> attribute.
- *
+ *
* @param title The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -836,7 +836,7 @@ public abstract class HtmlElement {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/dom.html#attr-translate">translate</a> attribute.
- *
+ *
* @param translate
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
index d504dbd..bae530d 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
@@ -23,7 +23,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* A subclass of HTML elements that contain only other elements, not text.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -33,7 +33,7 @@ import org.apache.juneau.xml.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
public class HtmlElementContainer extends HtmlElement {
@@ -42,7 +42,7 @@ public class HtmlElementContainer extends HtmlElement {
/**
* The children of this element.
- *
+ *
* @return The children of this element.
*/
@Xml(format=ELEMENTS)
@@ -53,7 +53,7 @@ public class HtmlElementContainer extends HtmlElement {
/**
* Sets the children for this container.
- *
+ *
* @param children The new children for this container.
* @return This object (for method chaining).
*/
@@ -65,7 +65,7 @@ public class HtmlElementContainer extends HtmlElement {
/**
* Returns the child node at the specified index.
- *
+ *
* @param index The index of the node in the list of children.
* @return The child node, or <jk>null</jk> if it doesn't exist.
*/
@@ -75,13 +75,13 @@ public class HtmlElementContainer extends HtmlElement {
/**
* Returns the child node at the specified address.
- *
+ *
* <p>
* Indexes are zero-indexed.
- *
+ *
* <p>
* For example, calling <code>getChild(1,2,3);</code> will return the 4th child of the 3rd child of the 2nd child.
- *
+ *
* @param index The child indexes.
* @return The child node, or <jk>null</jk> if it doesn't point to a valid child.
*/
@@ -104,7 +104,7 @@ public class HtmlElementContainer extends HtmlElement {
/**
* Returns the child node at the specified index.
- *
+ *
* @param type The class type of the node.
* @param index The index of the node in the list of children.
* @return The child node, or <jk>null</jk> if it doesn't exist.
@@ -119,7 +119,7 @@ public class HtmlElementContainer extends HtmlElement {
/**
* Adds one or more child elements to this element.
- *
+ *
* @param children The children to add as child elements.
* @return This object (for method chaining).
*/
@@ -135,7 +135,7 @@ public class HtmlElementContainer extends HtmlElement {
/**
* Adds a child element to this element.
- *
+ *
* @param child The child to add as a child element.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
index 7c3a0fb..d717973 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
@@ -23,7 +23,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* A subclass of HTML elements that contain mixed content (elements and text).
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -33,7 +33,7 @@ import org.apache.juneau.xml.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
public class HtmlElementMixed extends HtmlElement {
@@ -42,7 +42,7 @@ public class HtmlElementMixed extends HtmlElement {
/**
* The children of this element.
- *
+ *
* @return The children of this element.
*/
@Xml(format=MIXED)
@@ -53,7 +53,7 @@ public class HtmlElementMixed extends HtmlElement {
/**
* Sets the children of this element.
- *
+ *
* @param children The new children of this element.
* @return This object (for method chaining).
*/
@@ -65,7 +65,7 @@ public class HtmlElementMixed extends HtmlElement {
/**
* Returns the child node at the specified index.
- *
+ *
* @param index The index of the node in the list of children.
* @return The child node, or <jk>null</jk> if it doesn't exist.
*/
@@ -75,13 +75,13 @@ public class HtmlElementMixed extends HtmlElement {
/**
* Returns the child node at the specified address.
- *
+ *
* <p>
* Indexes are zero-indexed.
- *
+ *
* <p>
* For example, calling <code>getChild(1,2,3);</code> will return the 4th child of the 3rd child of the 2nd child.
- *
+ *
* @param index The child indexes.
* @return The child node, or <jk>null</jk> if it doesn't point to a valid child.
*/
@@ -104,7 +104,7 @@ public class HtmlElementMixed extends HtmlElement {
/**
* Returns the child node at the specified index.
- *
+ *
* @param type The class type of the node.
* @param index The index of the node in the list of children.
* @return The child node, or <jk>null</jk> if it doesn't exist.
@@ -120,7 +120,7 @@ public class HtmlElementMixed extends HtmlElement {
/**
* Adds one or more child elements to this element.
- *
+ *
* @param children
* The children to add as child elements.
* Can be a mixture of strings and {@link HtmlElement} objects.
@@ -136,7 +136,7 @@ public class HtmlElementMixed extends HtmlElement {
/**
* Adds a child element to this element.
- *
+ *
* @param child
* The child to add as a child element.
* Can be a string or {@link HtmlElement}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java
index eb0c239..ff2bdc8 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementRawText.java
@@ -18,7 +18,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* A subclass of HTML elements that contain <a href="https://www.w3.org/TR/html51/syntax.html#raw-text">raw text</a>
* only.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -28,7 +28,7 @@ import org.apache.juneau.xml.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
public class HtmlElementRawText extends HtmlElement {
@@ -37,7 +37,7 @@ public class HtmlElementRawText extends HtmlElement {
/**
* Returns the inner text of this element.
- *
+ *
* @return The inner text of this element, or <jk>null</jk> if no text is set.
*/
@Xml(format=XmlFormat.TEXT_PWS)
@@ -48,7 +48,7 @@ public class HtmlElementRawText extends HtmlElement {
/**
* Sets the inner text of this element.
- *
+ *
* @param text The inner text of this element, or <jk>null</jk> if no text is set.
* @return This object (for method chaining).
*/
@@ -60,7 +60,7 @@ public class HtmlElementRawText extends HtmlElement {
/**
* Sets the text node on this element.
- *
+ *
* @param text The text node to add to this element.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
index e403656..8b41d14 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
@@ -17,7 +17,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* A subclass of HTML elements that contain text only.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.xml.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
public class HtmlElementText extends HtmlElement {
@@ -36,7 +36,7 @@ public class HtmlElementText extends HtmlElement {
/**
* Returns the inner text of this element.
- *
+ *
* @return The inner text of this element, or <jk>null</jk> if no text is set.
*/
@Xml(format=XmlFormat.TEXT)
@@ -47,7 +47,7 @@ public class HtmlElementText extends HtmlElement {
/**
* Sets the inner text of this element.
- *
+ *
* @param text The inner text of this element, or <jk>null</jk> if no text is set.
* @return This object (for method chaining).
*/
@@ -59,7 +59,7 @@ public class HtmlElementText extends HtmlElement {
/**
* Sets the text node on this element.
- *
+ *
* @param text The text node to add to this element.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
index 25bf964..a320550 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
@@ -18,10 +18,10 @@ import org.apache.juneau.xml.annotation.*;
/**
* A subclass of HTML elements that have no content or end tags.
- *
+ *
* <p>
* See <a href="https://www.w3.org/TR/html51/syntax.html#void-elements">void elements</a>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.xml.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Xml(format=VOID)
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/I.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/I.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/I.java
index fa9399c..ea864e1 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/I.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/I.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="i")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Iframe.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Iframe.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Iframe.java
index f0add3f..cf09aec 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Iframe.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Iframe.java
@@ -21,7 +21,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="iframe")
@@ -40,10 +40,10 @@ public class Iframe extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
* attribute.
- *
+ *
* <p>
* Vertical dimension.
- *
+ *
* @param height
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -56,10 +56,10 @@ public class Iframe extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-iframe-name">name</a> attribute.
- *
+ *
* <p>
* Name of nested browsing context.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -71,10 +71,10 @@ public class Iframe extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-iframe-sandbox">sandbox</a>
* attribute.
- *
+ *
* <p>
* Security rules for nested content.
- *
+ *
* @param sandbox The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -85,17 +85,17 @@ public class Iframe extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-iframe-src">src</a> attribute.
- *
+ *
* <p>
* Address of the resource.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param src
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
@@ -109,10 +109,10 @@ public class Iframe extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-iframe-srcdoc">srcdoc</a>
* attribute.
- *
+ *
* <p>
* A document to render in the iframe.
- *
+ *
* @param srcdoc The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -123,10 +123,10 @@ public class Iframe extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
- *
+ *
* <p>
* Horizontal dimension.
- *
+ *
* @param width
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Img.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Img.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Img.java
index 0a78701..e022d73 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Img.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Img.java
@@ -21,7 +21,7 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-img-element"><img></a>
* element.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="img")
@@ -39,10 +39,10 @@ public class Img extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-img-alt">alt</a> attribute.
- *
+ *
* <p>
* Replacement text for use when images are not available.
- *
+ *
* @param alt The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -54,10 +54,10 @@ public class Img extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-img-crossorigin">crossorigin</a>
* attribute.
- *
+ *
* <p>
* How the element handles cross-origin requests.
- *
+ *
* @param crossorigin The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -69,10 +69,10 @@ public class Img extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
* attribute.
- *
+ *
* <p>
* Vertical dimension.
- *
+ *
* @param height
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -85,10 +85,10 @@ public class Img extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-img-ismap">ismap</a> attribute.
- *
+ *
* <p>
* Whether the image is a server-side image map.
- *
+ *
* @param ismap
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -101,17 +101,17 @@ public class Img extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-img-src">src</a> attribute.
- *
+ *
* <p>
* Address of the resource.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param src
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
@@ -125,10 +125,10 @@ public class Img extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-hyperlink-usemap">usemap</a>
* attribute.
- *
+ *
* <p>
* Name of image map to use.
- *
+ *
* @param usemap The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -139,10 +139,10 @@ public class Img extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
- *
+ *
* <p>
* Horizontal dimension.
- *
+ *
* @param width
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
[30/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Article.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Article.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Article.java
index 519e4b0..30d944d 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Article.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Article.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="article")
@@ -35,7 +35,7 @@ public class Article extends HtmlElementMixed {
/**
* Adds a header node to this element.
- *
+ *
* @param children The children inside the header node.
* @return This object (for method chaining).
*/
@@ -46,7 +46,7 @@ public class Article extends HtmlElementMixed {
/**
* Adds a footer node to this element.
- *
+ *
* @param children The children inside the footer node.
* @return This object (for method chaining).
*/
@@ -57,7 +57,7 @@ public class Article extends HtmlElementMixed {
/**
* Adds a link node to this element.
- *
+ *
* @param link The link node to add to this article.
* @return This object (for method chaining).
*/
@@ -68,7 +68,7 @@ public class Article extends HtmlElementMixed {
/**
* Adds a section node to this element.
- *
+ *
* @param section The section node to add to this article.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Aside.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Aside.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Aside.java
index ca5cf08..a6e783c 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Aside.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Aside.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="aside")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Audio.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Audio.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Audio.java
index 1acd391..0e23c18 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Audio.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Audio.java
@@ -21,7 +21,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="audio")
@@ -40,10 +40,10 @@ public class Audio extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-autoplay">autoplay</a>
* attribute.
- *
+ *
* <p>
* Hint that the media resource can be started automatically when the page is loaded.
- *
+ *
* @param autoplay
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -57,10 +57,10 @@ public class Audio extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-controls">controls</a>
* attribute.
- *
+ *
* <p>
* Show user agent controls.
- *
+ *
* @param controls
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -74,10 +74,10 @@ public class Audio extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-crossorigin">crossorigin</a>
* attribute.
- *
+ *
* <p>
* How the element handles cross-origin requests.
- *
+ *
* @param crossorigin The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -88,10 +88,10 @@ public class Audio extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-loop">loop</a> attribute.
- *
+ *
* <p>
* Whether to loop the media resource.
- *
+ *
* @param loop
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -105,10 +105,10 @@ public class Audio extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-mediagroup">mediagroup</a>
* attribute.
- *
+ *
* <p>
* Groups media elements together with an implicit MediaController.
- *
+ *
* @param mediagroup The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -120,10 +120,10 @@ public class Audio extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-muted">muted</a>
* attribute.
- *
+ *
* <p>
* Whether to mute the media resource by default.
- *
+ *
* @param muted
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -137,10 +137,10 @@ public class Audio extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-preload">preload</a>
* attribute.
- *
+ *
* <p>
* Hints how much buffering the media resource will likely need.
- *
+ *
* @param preload The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -151,17 +151,17 @@ public class Audio extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-src">src</a> attribute.
- *
+ *
* <p>
* Address of the resource.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param src
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/B.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/B.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/B.java
index d4beaba..1c49111 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/B.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/B.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="b")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Base.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Base.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Base.java
index 253be94..67ab9aa 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Base.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Base.java
@@ -21,7 +21,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="base")
@@ -39,17 +39,17 @@ public class Base extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-base-href">href</a> attribute.
- *
+ *
* <p>
* Document base URL.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param href
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
@@ -63,10 +63,10 @@ public class Base extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-base-target">target</a>
* attribute.
- *
+ *
* <p>
* Default browsing context for hyperlink navigation and form submission.
- *
+ *
* @param target The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Bdi.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Bdi.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Bdi.java
index bba51e5..2c7675f 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Bdi.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Bdi.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="bdi")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Bdo.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Bdo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Bdo.java
index b8c6acf..b97ba90 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Bdo.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Bdo.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="bdo")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Blockquote.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
index bcaa2db..7bd24b9 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="blockquote")
@@ -36,10 +36,10 @@ public class Blockquote extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-blockquote-cite">cite</a>
* attribute.
- *
+ *
* <p>
* Link to the source of the quotation.
- *
+ *
* @param cite The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Body.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Body.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Body.java
index 8bd8b3f..05d09c8 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Body.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Body.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="body")
@@ -36,7 +36,7 @@ public class Body extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onafterprint">onafterprint</a>
* attribute.
- *
+ *
* @param onafterprint The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -48,7 +48,7 @@ public class Body extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onbeforeunload">onbeforeunload</a>
* attribute.
- *
+ *
* @param onbeforeunload The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -60,7 +60,7 @@ public class Body extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onmessage">onmessage</a>
* attribute.
- *
+ *
* @param onmessage The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -72,7 +72,7 @@ public class Body extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-ononline">ononline</a>
* attribute.
- *
+ *
* @param ononline The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -84,7 +84,7 @@ public class Body extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onpageshow">onpageshow</a>
* attribute.
- *
+ *
* @param onpageshow The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -96,7 +96,7 @@ public class Body extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onstorage">onstorage</a>
* attribute.
- *
+ *
* @param onstorage The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Br.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Br.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Br.java
index e7eba5e..5fbfbb5 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Br.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Br.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="br")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Button.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Button.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Button.java
index f2afd66..e12955d 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Button.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Button.java
@@ -21,7 +21,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="button")
@@ -39,10 +39,10 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autofocus">autofocus</a> attribute.
- *
+ *
* <p>
* Automatically focus the form control when the page is loaded.
- *
+ *
* @param autofocus
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -55,10 +55,10 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-disabled">disabled</a> attribute.
- *
+ *
* <p>
* Whether the form control is disabled.
- *
+ *
* @param disabled
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -71,10 +71,10 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
- *
+ *
* <p>
* Associates the control with a form element.
- *
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -85,17 +85,17 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formaction">formaction</a> attribute.
- *
+ *
* <p>
* URL to use for form submission.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param formaction The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -106,10 +106,10 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formenctype">formenctype</a> attribute.
- *
+ *
* <p>
* Form data set encoding type to use for form submission.
- *
+ *
* @param formenctype The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -120,10 +120,10 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formmethod">formmethod</a> attribute.
- *
+ *
* <p>
* HTTP method to use for form submission.
- *
+ *
* @param formmethod The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -135,10 +135,10 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formnovalidate">formnovalidate</a>
* attribute.
- *
+ *
* <p>
* Bypass form control validation for form submission.
- *
+ *
* @param formnovalidate The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -149,10 +149,10 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formtarget">formtarget</a> attribute.
- *
+ *
* <p>
* Browsing context for form submission.
- *
+ *
* @param formtarget The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -163,10 +163,10 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-menu">menu</a> attribute.
- *
+ *
* <p>
* Specifies the element's designated pop-up menu.
- *
+ *
* @param menu The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -177,10 +177,10 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
- *
+ *
* <p>
* Name of form control to use for form submission and in the form.elements API.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -191,10 +191,10 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-button-type">type</a> attribute.
- *
+ *
* <p>
* Type of button.
- *
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -205,10 +205,10 @@ public class Button extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-button-value">value</a> attribute.
- *
+ *
* <p>
* Value to be used for form submission.
- *
+ *
* @param value
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Canvas.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Canvas.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Canvas.java
index 4881e63..4def2e3 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Canvas.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Canvas.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="canvas")
@@ -35,10 +35,10 @@ public class Canvas extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-canvas-height">height</a> attribute.
- *
+ *
* <p>
* Vertical dimension.
- *
+ *
* @param height
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -51,10 +51,10 @@ public class Canvas extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-canvas-width">width</a> attribute.
- *
+ *
* <p>
* Horizontal dimension.
- *
+ *
* @param width
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Caption.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Caption.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Caption.java
index 518b281..c821f8b 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Caption.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Caption.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="caption")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Cite.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Cite.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Cite.java
index 4e745ea..634ce26 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Cite.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Cite.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="cite")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Code.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Code.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Code.java
index 6b5bb01..058bb2c 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Code.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Code.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="code")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Col.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Col.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Col.java
index 935bcc2..9933040 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Col.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Col.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="col")
@@ -35,10 +35,10 @@ public class Col extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-col-span">span</a> attribute.
- *
+ *
* <p>
* Number of columns spanned by the element.
- *
+ *
* @param span
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Colgroup.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
index d4ebd5f..9642a31 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="colgroup")
@@ -35,10 +35,10 @@ public class Colgroup extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-colgroup-span">span</a> attribute.
- *
+ *
* <p>
* Number of columns spanned by the element.
- *
+ *
* @param span
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Data.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Data.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Data.java
index 078d3f3..b1e9bc1 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Data.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Data.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="data")
@@ -36,10 +36,10 @@ public class Data extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#attr-data-value">value</a>
* attribute.
- *
+ *
* <p>
* Machine-readable value.
- *
+ *
* @param value
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Datalist.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Datalist.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Datalist.java
index d39ebde..5484f56 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Datalist.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Datalist.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="datalist")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dd.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dd.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dd.java
index e8f9b27..ceb1551 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dd.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dd.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="dd")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Del.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Del.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Del.java
index ac90b9e..6a5be90 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Del.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Del.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="del")
@@ -35,10 +35,10 @@ public class Del extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/edits.html#attr-mod-cite">cite</a> attribute.
- *
+ *
* <p>
* Link to the source of the quotation or more information about the edit.
- *
+ *
* @param cite The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -49,10 +49,10 @@ public class Del extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/edits.html#attr-mod-datetime">datetime</a> attribute.
- *
+ *
* <p>
* Date and (optionally) time of the change.
- *
+ *
* @param datetime The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dfn.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dfn.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dfn.java
index 554bf44..a8b93c0 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dfn.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dfn.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="dfn")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Div.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Div.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Div.java
index e8e7619..71f5c43 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Div.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Div.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="div")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dl.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dl.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dl.java
index f516c35..6a4828b 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dl.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dl.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="dl")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dt.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dt.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dt.java
index 661de22..d49f6dc 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dt.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Dt.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="dt")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Em.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Em.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Em.java
index 6f1fd66..8756565 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Em.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Em.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="em")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Embed.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Embed.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Embed.java
index 8980a89..f345023 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Embed.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Embed.java
@@ -21,7 +21,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="embed")
@@ -40,10 +40,10 @@ public class Embed extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
* attribute.
- *
+ *
* <p>
* Vertical dimension.
- *
+ *
* @param height
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -56,17 +56,17 @@ public class Embed extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-embed-src">src</a> attribute.
- *
+ *
* <p>
* Address of the resource.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param src
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
@@ -79,10 +79,10 @@ public class Embed extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-embed-type">type</a> attribute.
- *
+ *
* <p>
* Type of embedded resource.
- *
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -93,10 +93,10 @@ public class Embed extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
- *
+ *
* <p>
* Horizontal dimension.
- *
+ *
* @param width
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Fieldset.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
index 461ec5d..d9b3a8f 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="fieldset")
@@ -35,10 +35,10 @@ public class Fieldset extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fieldset-disabled">disabled</a> attribute.
- *
+ *
* <p>
* Whether the form control is disabled.
- *
+ *
* @param disabled
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -51,10 +51,10 @@ public class Fieldset extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
- *
+ *
* <p>
* Associates the control with a form element.
- *
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -65,10 +65,10 @@ public class Fieldset extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
- *
+ *
* <p>
* Name of form control to use for form submission and in the form.elements API.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Figcaption.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
index 8bfad50..67fc141 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="figcaption")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Figure.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Figure.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Figure.java
index 2ef5f19..259fbc7 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Figure.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Figure.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="figure")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Footer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Footer.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Footer.java
index 018ba97..a32051d 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Footer.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Footer.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="footer")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Form.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Form.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Form.java
index ba992d7..205f930 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Form.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Form.java
@@ -21,7 +21,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="form")
@@ -40,10 +40,10 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-form-accept-charset">accept-charset</a>
* attribute.
- *
+ *
* <p>
* Character encodings to use for form submission.
- *
+ *
* @param acceptcharset The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -54,17 +54,17 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-action">action</a> attribute.
- *
+ *
* <p>
* URL to use for form submission.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param action The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -76,10 +76,10 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-form-autocomplete">autocomplete</a>
* attribute.
- *
+ *
* <p>
* Default setting for auto-fill feature for controls in the form.
- *
+ *
* @param autocomplete The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -90,10 +90,10 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-enctype">enctype</a> attribute.
- *
+ *
* <p>
* Form data set encoding type to use for form submission.
- *
+ *
* @param enctype The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -104,10 +104,10 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-method">method</a> attribute.
- *
+ *
* <p>
* HTTP method to use for form submission.
- *
+ *
* @param method The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -118,10 +118,10 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-form-name">name</a> attribute.
- *
+ *
* <p>
* Name of form to use in the document.forms API.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -132,10 +132,10 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-novalidate">novalidate</a> attribute.
- *
+ *
* <p>
* Bypass form control validation for form submission.
- *
+ *
* @param novalidate The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
@@ -147,10 +147,10 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-target">target</a> attribute.
- *
+ *
* <p>
* Browsing context for form submission.
- *
+ *
* @param target The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H1.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H1.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H1.java
index feefdf9..8cd6f5d 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H1.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H1.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="h1")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H2.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H2.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H2.java
index 1133301..08d9c46 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H2.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H2.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="h2")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H3.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H3.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H3.java
index a83617b..2fc4cf5 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H3.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H3.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="h3")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H4.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H4.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H4.java
index 5dc961b..0739eac 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H4.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H4.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="h4")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H5.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H5.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H5.java
index ad62d13..da709be 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H5.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H5.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="h5")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H6.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H6.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H6.java
index b4148a0..b550787 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H6.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/H6.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="h6")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Head.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Head.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Head.java
index 2f4879f..ae43db2 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Head.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Head.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="head")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Header.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Header.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Header.java
index ae47b12..b8f88bb 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Header.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Header.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="header")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Hr.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Hr.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Hr.java
index aba0ab1..181ffe9 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Hr.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Hr.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="hr")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Html.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Html.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Html.java
index 9216e98..393e384 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Html.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Html.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="html")
@@ -35,10 +35,10 @@ public class Html extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/semantics.html#attr-html-manifest">manifest</a> attribute.
- *
+ *
* <p>
* Application cache manifest.
- *
+ *
* @param manifest The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java
index 1313ebf..7c0aff1 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/HtmlBeanDictionary.java
@@ -16,7 +16,7 @@ import org.apache.juneau.*;
/**
* Defines the Java classes that make up the HTML DTO type dictionary.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -26,7 +26,7 @@ import org.apache.juneau.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
public class HtmlBeanDictionary extends BeanDictionaryList {
[12/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/WriterSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/WriterSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/WriterSerializerSession.java
index a9cab63..da68cfc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/WriterSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/WriterSerializerSession.java
@@ -16,16 +16,17 @@ import java.io.*;
/**
* Subclass of {@link SerializerSession} for character-based serializers.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* This class is typically the parent class of all character-based serializers.
* <br>It has 1 abstract method to implement...
* <ul class='spaced-list'>
* <li>
* {@link #doSerialize(SerializerPipe, Object)}
* </ul>
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -34,7 +35,7 @@ public abstract class WriterSerializerSession extends SerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -50,7 +51,7 @@ public abstract class WriterSerializerSession extends SerializerSession {
/**
* Constructor for sessions that don't require context.
- *
+ *
* @param args
* Runtime session arguments.
*/
@@ -65,7 +66,7 @@ public abstract class WriterSerializerSession extends SerializerSession {
/**
* Convenience method for serializing an object to a <code>String</code>.
- *
+ *
* @param o The object to serialize.
* @return The output serialized to a string.
* @throws SerializeException If a problem occurred trying to convert the output.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializer.java
index e910294..289d8de 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializer.java
@@ -18,16 +18,17 @@ import org.apache.juneau.xml.*;
/**
* Serializes POJOs to HTTP responses as XML+SOAP.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/xml+soap</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/xml+soap</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/xml+soap</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/xml+soap</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Essentially the same output as {@link XmlDocSerializer}, except wrapped in a standard SOAP envelope.
*/
public final class SoapXmlSerializer extends XmlSerializer {
@@ -40,7 +41,7 @@ public final class SoapXmlSerializer extends XmlSerializer {
/**
* Configuration property: The <code>SOAPAction</code> HTTP header value to set on responses.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"SoapXmlSerializer.SOAPAction.s"</js>
@@ -63,7 +64,7 @@ public final class SoapXmlSerializer extends XmlSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public SoapXmlSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java
index bb27c48..dd63769 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializerBuilder.java
@@ -35,7 +35,7 @@ public class SoapXmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public SoapXmlSerializerBuilder(PropertyStore ps) {
@@ -54,7 +54,7 @@ public class SoapXmlSerializerBuilder extends XmlSerializerBuilder {
/**
* Configuration property: The <code>SOAPAction</code> HTTP header value to set on responses.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link SoapXmlSerializer#SOAPXML_SOAPAction}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializerSession.java
index 2f469e3..1a1353b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/soap/SoapXmlSerializerSession.java
@@ -22,7 +22,7 @@ import org.apache.juneau.xml.*;
/**
* Session object that lives for the duration of a single use of {@link SoapXmlSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -33,7 +33,7 @@ public class SoapXmlSerializerSession extends XmlSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/AnnotationBeanFilterBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/AnnotationBeanFilterBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/AnnotationBeanFilterBuilder.java
index b583756..920cae7 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/AnnotationBeanFilterBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/AnnotationBeanFilterBuilder.java
@@ -21,7 +21,7 @@ import org.apache.juneau.annotation.*;
/**
* Bean filter builder initialized from the contents of a {@link Bean @Bean} annotation found on a class.
- *
+ *
* <p>
* <b>*** Internal class - Not intended for external use ***</b>
*
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/BeanFilter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/BeanFilter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/BeanFilter.java
index 6225581..7ee7bf8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/BeanFilter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/BeanFilter.java
@@ -20,18 +20,19 @@ import org.apache.juneau.internal.*;
/**
* Parent class for all bean filters.
- *
+ *
* <p>
* Bean filters are used to control aspects of how beans are handled during serialization and parsing.
- *
+ *
* <p>
* Bean filters are created by {@link BeanFilterBuilder} which is the programmatic equivalent to the {@link Bean @Bean}
* annotation.
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanFilters">Overview > BeanFilters</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanFilters">Overview > BeanFilters</a>
+ * </ul>
*/
public final class BeanFilter {
@@ -68,7 +69,7 @@ public final class BeanFilter {
/**
* Returns the bean class that this filter applies to.
- *
+ *
* @return The bean class that this filter applies to.
*/
public Class<?> getBeanClass() {
@@ -77,7 +78,7 @@ public final class BeanFilter {
/**
* Returns the dictionary name associated with this bean.
- *
+ *
* @return The dictionary name associated with this bean, or <jk>null</jk> if no name is defined.
*/
public String getTypeName() {
@@ -86,7 +87,7 @@ public final class BeanFilter {
/**
* Returns the set and order of names of properties associated with a bean class.
- *
+ *
* @return
* The name of the properties associated with a bean class, or <jk>null</jk> if all bean properties should
* be used.
@@ -97,7 +98,7 @@ public final class BeanFilter {
/**
* Returns the bean dictionary defined on this bean.
- *
+ *
* @return The bean dictionary defined on this bean, or <jk>null</jk> if no bean dictionary is defined.
*/
public Class<?>[] getBeanDictionary() {
@@ -106,11 +107,11 @@ public final class BeanFilter {
/**
* Returns <jk>true</jk> if the properties defined on this bean class should be ordered alphabetically.
- *
+ *
* <p>
* This method is only used when the {@link #getProperties()} method returns <jk>null</jk>.
* Otherwise, the ordering of the properties in the returned value is used.
- *
+ *
* @return <jk>true</jk> if bean properties should be sorted.
*/
public boolean isSortProperties() {
@@ -119,7 +120,7 @@ public final class BeanFilter {
/**
* Returns the list of properties to ignore on a bean.
- *
+ *
* @return The name of the properties to ignore on a bean, or <jk>null</jk> to not ignore any properties.
*/
public String[] getExcludeProperties() {
@@ -128,7 +129,7 @@ public final class BeanFilter {
/**
* Returns the {@link PropertyNamer} associated with the bean to tailor the names of bean properties.
- *
+ *
* @return The property namer class, or <jk>null</jk> if no property namer is associated with this bean property.
*/
public PropertyNamer getPropertyNamer() {
@@ -137,7 +138,7 @@ public final class BeanFilter {
/**
* Returns the interface class associated with this class.
- *
+ *
* @return The interface class associated with this class, or <jk>null</jk> if no interface class is associated.
*/
public Class<?> getInterfaceClass() {
@@ -146,7 +147,7 @@ public final class BeanFilter {
/**
* Returns the stop class associated with this class.
- *
+ *
* @return The stop class associated with this class, or <jk>null</jk> if no stop class is associated.
*/
public Class<?> getStopClass() {
@@ -155,7 +156,7 @@ public final class BeanFilter {
/**
* Calls the {@link PropertyFilter#readProperty(Object, String, Object)} method on the registered property filters.
- *
+ *
* @param bean The bean from which the property was read.
* @param name The property name.
* @param value The value just extracted from calling the bean getter.
@@ -167,7 +168,7 @@ public final class BeanFilter {
/**
* Calls the {@link PropertyFilter#writeProperty(Object, String, Object)} method on the registered property filters.
- *
+ *
* @param bean The bean from which the property was read.
* @param name The property name.
* @param value The value just parsed.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/BeanFilterBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/BeanFilterBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/BeanFilterBuilder.java
index 54288a6..941cd26 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/BeanFilterBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/BeanFilterBuilder.java
@@ -48,12 +48,13 @@ import org.apache.juneau.annotation.*;
* .beanFilters(MyFilter.<jk>class</jk>)
* .build();
* </p>
- *
- * <h6 class='topic'>Documentation</h6>
+ *
+ *
+ * <h5 class='topic'>Documentation</h5>
* <ul>
*. <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanFilters">Overview > BeanFilters</a>
*.</ul>
- *
+ *
* @param <T> The bean type that this filter applies to.
*/
public class BeanFilterBuilder<T> {
@@ -79,7 +80,7 @@ public class BeanFilterBuilder<T> {
/**
* Constructor.
- *
+ *
* @param beanClass The bean class that this filter applies to.
*/
protected BeanFilterBuilder(Class<?> beanClass) {
@@ -91,7 +92,7 @@ public class BeanFilterBuilder<T> {
*
* <p>
* Specifies the dictionary type name for this bean.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Define our filter.</jc>
@@ -167,7 +168,7 @@ public class BeanFilterBuilder<T> {
/**
* Configuration property: Bean property excludes.
- *
+ *
* <p>
* Specifies properties to exclude from the bean class.
*
@@ -208,31 +209,31 @@ public class BeanFilterBuilder<T> {
/**
* Configuration property: Bean interface class.
- *
+ *
* Identifies a class to be used as the interface class for this and all subclasses.
- *
+ *
* <p>
* When specified, only the list of properties defined on the interface class will be used during serialization.
* <br>Additional properties on subclasses will be ignored.
- *
+ *
* <p class='bcode'>
* <jc>// Parent class</jc>
* <jk>public abstract class</jk> A {
* <jk>public</jk> String <jf>f0</jf> = <js>"f0"</js>;
* }
- *
+ *
* <jc>// Sub class</jc>
* <jk>public class</jk> A1 <jk>extends</jk> A {
* <jk>public</jk> String <jf>f1</jf> = <js>"f1"</js>;
* }
- *
+ *
* <jc>// Define our filter.</jc>
* <jk>public class</jk> AFilter <jk>extends</jk> BeanFilterBuilder<A> {
* <jk>public</jk> AFilter() {
* interfaceClass(A.<jk>class</jk>);
* }
* }
- *
+ *
* <jc>// Register it with a serializer.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
@@ -244,11 +245,11 @@ public class BeanFilterBuilder<T> {
* String r = s.serialize(a1);
* <jsm>assertEquals</jsm>(<js>"{f0:'f0'}"</js>, r); <jc>// Note f1 is not serialized</jc>
* </p>
- *
+ *
* <p>
* Note that this filter can be used on the parent class so that it filters to all child classes, or can be set
* individually on the child classes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='ja'>{@link Bean#interfaceClass()}
@@ -268,25 +269,25 @@ public class BeanFilterBuilder<T> {
*
* <p>
* Identifies a stop class for this class and all subclasses.
- *
+ *
* <p>
* Identical in purpose to the stop class specified by {@link Introspector#getBeanInfo(Class, Class)}.
* <br>Any properties in the stop class or in its base classes will be ignored during analysis.
- *
+ *
* <p>
* For example, in the following class hierarchy, instances of <code>C3</code> will include property <code>p3</code>,
* but not <code>p1</code> or <code>p2</code>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> C1 {
* <jk>public int</jk> getP1();
* }
- *
+ *
* <jk>public class</jk> C2 <jk>extends</jk> C1 {
* <jk>public int</jk> getP2();
* }
- *
+ *
* <jk>public class</jk> C3 <jk>extends</jk> C2 {
* <jk>public int</jk> getP3();
* }
@@ -307,7 +308,7 @@ public class BeanFilterBuilder<T> {
* <jc>// Serializes property 'p3', but NOT 'p1' or 'p2'.</jc>
* String json = s.serialize(<jk>new</jk> C3());
* </p>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='ja'>{@link Bean#stopClass()}
@@ -323,11 +324,11 @@ public class BeanFilterBuilder<T> {
/**
* Configuration property: Sort bean properties.
- *
+ *
* <p>
* When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order.
* <br>Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Define our filter.</jc>
@@ -365,10 +366,10 @@ public class BeanFilterBuilder<T> {
/**
* Configuration property: Sort bean properties.
- *
+ *
* <p>
* Shortcut for calling <code>sortProperties(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='ja'>{@link Bean#sort()}
@@ -384,7 +385,7 @@ public class BeanFilterBuilder<T> {
/**
* Configuration property: Bean property namer
- *
+ *
* <p>
* The class to use for calculating bean property names.
*
@@ -428,7 +429,7 @@ public class BeanFilterBuilder<T> {
/**
* Configuration property: Bean dictionary.
- *
+ *
* <p>
* Adds to the list of classes that make up the bean dictionary for this bean.
*
@@ -475,7 +476,7 @@ public class BeanFilterBuilder<T> {
*
* <p>
* The property filter to use for intercepting and altering getter and setter calls.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Define our filter.</jc>
@@ -485,14 +486,14 @@ public class BeanFilterBuilder<T> {
* propertyFilter(AddressPropertyFilter.<jk>class</jk>);
* }
* }
- *
+ *
* <jc>// Register it with a serializer or parser.</jc>
* WriterSerializer s = JsonSerializer
* .<jsm>create</jsm>()
* .beanFilters(MyFilter.<jk>class</jk>)
* .build();
* </p>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='ja'>{@link Bean#propertyFilter()}
@@ -511,7 +512,7 @@ public class BeanFilterBuilder<T> {
/**
* Creates a {@link BeanFilter} with settings in this builder class.
- *
+ *
* @return A new {@link BeanFilter} instance.
*/
public BeanFilter build() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/InterfaceBeanFilterBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/InterfaceBeanFilterBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/InterfaceBeanFilterBuilder.java
index 6faff41..83d8431 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/InterfaceBeanFilterBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/InterfaceBeanFilterBuilder.java
@@ -22,7 +22,7 @@ import org.apache.juneau.internal.*;
/**
* Simple bean filter that simply identifies a class to be used as an interface class for all child classes.
- *
+ *
* <p>
* These objects are created when you pass in non-<code>BeanFilterBuilder</code> classes to
* {@link BeanContextBuilder#beanFilters(Class...)}, and are equivalent to adding a
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/MapSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/MapSwap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/MapSwap.java
index a2f1904..bd58e20 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/MapSwap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/MapSwap.java
@@ -16,8 +16,8 @@ import org.apache.juneau.*;
/**
* Abstract subclass for POJO swaps that swap objects for object maps.
- *
- * <h6 class='topic'>Example</h6>
+ *
+ * <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// A swap that converts beans into generic maps.</jc>
* <jk>public class</jk> MyBeanSwap <jk>extends</jk> MapSwap<<jk>byte</jk>[]> {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/PojoSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/PojoSwap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/PojoSwap.java
index 4f46c6c..f90e89b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/PojoSwap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/PojoSwap.java
@@ -25,9 +25,10 @@ import org.apache.juneau.serializer.*;
/**
* Used to swap out non-serializable objects with serializable replacements during serialization, and vis-versa during
* parsing.
- *
+ *
+ *
* <h5 class='topic'>Description</h5>
- *
+ *
* <p>
* <code>PojoSwaps</code> are used to extend the functionality of the serializers and parsers to be able to handle
* POJOs that aren't automatically handled by the serializers or parsers.
@@ -35,10 +36,10 @@ import org.apache.juneau.serializer.*;
* By defining a special {@code Date} swap and associating it with a serializer and parser, you can convert a
* {@code Date} object to a {@code String} during serialization, and convert that {@code String} object back into a
* {@code Date} object during parsing.
- *
+ *
* <p>
* Swaps MUST declare a public no-arg constructor so that the bean context can instantiate them.
- *
+ *
* <p>
* <code>PojoSwaps</code> are associated with serializers and parsers through the following:
* <ul>
@@ -49,7 +50,7 @@ import org.apache.juneau.serializer.*;
* <li class='jm'>{@link BeanContextBuilder#pojoSwaps(boolean, Object...)}
* <li class='jm'>{@link BeanContextBuilder#pojoSwapsRemove(Object...)}
* </ul>
- *
+ *
* <p>
* <code>PojoSwaps</code> have two parameters:
* <ol>
@@ -60,10 +61,10 @@ import org.apache.juneau.serializer.*;
* {@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
* {@link BeanMap#put(String,Object)}.
- *
- *
+ *
+ *
* <h6 class='topic'>Swap Class Type {@code <S>}</h6>
- *
+ *
* <p>
* The swapped object representation of an object must be an object type that the serializers can natively convert to
* JSON (or language-specific equivalent).
@@ -84,20 +85,20 @@ import org.apache.juneau.serializer.*;
* <li>
* An array of anything on this list.
* </ul>
- *
- *
+ *
+ *
* <h6 class='topic'>Normal Class Type {@code <T>}</h6>
- *
+ *
* <p>
* The normal object representation of an object.
- *
- *
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.PojoSwaps">Overview > PojoSwaps</a>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview > @Swap Annotation</a>
- * </ul>
- *
+ *
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.PojoSwaps">Overview > PojoSwaps</a>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview > @Swap Annotation</a>
+ * </ul>
+ *
* @param <T> The normal form of the class.
* @param <S> The swapped form of the class.
*/
@@ -131,7 +132,7 @@ public abstract class PojoSwap<T,S> {
/**
* Constructor for when the normal and transformed classes are already known.
- *
+ *
* @param normalClass The normal class (cannot be serialized).
* @param swapClass The transformed class (serializable).
*/
@@ -144,13 +145,13 @@ public abstract class PojoSwap<T,S> {
/**
* Returns the media types that this swap is applicable to.
- *
+ *
* <p>
* This method can be overridden to programmatically specify what media types it applies to.
- *
+ *
* <p>
* This method is the programmatic equivalent to the {@link Swap#mediaTypes() @Swap.mediaTypes()} annotation.
- *
+ *
* <h6 class='topic'>Documentation</h6>
* <ul>
* <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.PerMediaTypePojoSwaps">Overview > Per-media-type PojoSwaps</a>
@@ -163,21 +164,21 @@ public abstract class PojoSwap<T,S> {
/**
* Returns additional context information for this swap.
- *
+ *
* <p>
* Typically this is going to be used to specify a template name, such as a FreeMarker template file name.
- *
+ *
* <p>
* This method can be overridden to programmatically specify a template value.
- *
+ *
* <p>
* This method is the programmatic equivalent to the {@link Swap#template() @Swap.template()} annotation.
- *
+ *
* <h5 class='section'>Documentation:</h5>
* <ul>
* <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.TemplatedSwaps">Overview > Templated Swaps</a>
* </ul>
- *
+ *
* @return Additional context information, or <jk>null</jk> if not specified.
*/
public String withTemplate() {
@@ -186,12 +187,12 @@ public abstract class PojoSwap<T,S> {
/**
* Sets the media types that this swap is associated with.
- *
+ *
* <h6 class='topic'>Documentation</h6>
* <ul>
* <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.PerMediaTypePojoSwaps">Overview > Per-media-type PojoSwaps</a>
* </ul>
- *
+ *
* @param mediaTypes The media types that this swap is associated with.
* @return This object (for method chaining).
*/
@@ -202,12 +203,12 @@ public abstract class PojoSwap<T,S> {
/**
* Sets the template string on this swap.
- *
+ *
* <h5 class='section'>Documentation:</h5>
* <ul>
* <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.TemplatedSwaps">Overview > Templated Swaps</a>
* </ul>
- *
+ *
* @param template The template string on this swap.
* @return This object (for method chaining).
*/
@@ -218,15 +219,15 @@ public abstract class PojoSwap<T,S> {
/**
* Returns a number indicating how well this swap matches the specified session.
- *
+ *
* <p>
* Uses the {@link MediaType#match(MediaType, boolean)} method algorithm to produce a number whereby a
* larger value indicates a "better match".
* The idea being that if multiple swaps are associated with a given POJO, we want to pick the best one.
- *
+ *
* <p>
* For example, if the session media type is <js>"text/json"</js>, then the match values are shown below:
- *
+ *
* <ul>
* <li><js>"text/json"</js> = <code>100,000</code>
* <li><js>"*/json"</js> = <code>5,100</code>
@@ -234,7 +235,7 @@ public abstract class PojoSwap<T,S> {
* <li>No media types specified on swap = <code>1</code>
* <li><js>"text/xml"</js> = <code>0</code>
* </ul>
- *
+ *
* @param session The bean session.
* @return Zero if swap doesn't match the session, or a positive number if it does.
*/
@@ -251,7 +252,7 @@ public abstract class PojoSwap<T,S> {
/**
* If this transform is to be used to serialize non-serializable POJOs, it must implement this method.
- *
+ *
* <p>
* The object must be converted into one of the following serializable types:
* <ul class='spaced-list'>
@@ -270,7 +271,7 @@ public abstract class PojoSwap<T,S> {
* <li>
* An array of anything on this list.
* </ul>
- *
+ *
* @param session
* The bean session to use to get the class meta.
* This is always going to be the same bean context that created this swap.
@@ -284,7 +285,7 @@ public abstract class PojoSwap<T,S> {
/**
* Same as {@link #swap(BeanSession, Object)}, but can be used if your swap has a template associated with it.
- *
+ *
* @param session
* The bean session to use to get the class meta.
* This is always going to be the same bean context that created this swap.
@@ -300,7 +301,7 @@ public abstract class PojoSwap<T,S> {
/**
* If this transform is to be used to reconstitute POJOs that aren't true Java beans, it must implement this method.
- *
+ *
* @param session
* The bean session to use to get the class meta.
* This is always going to be the same bean context that created this swap.
@@ -319,7 +320,7 @@ public abstract class PojoSwap<T,S> {
/**
* Same as {@link #unswap(BeanSession, Object, ClassMeta)}, but can be used if your swap has a template associated with it.
- *
+ *
* @param session
* The bean session to use to get the class meta.
* This is always going to be the same bean context that created this swap.
@@ -340,7 +341,7 @@ public abstract class PojoSwap<T,S> {
/**
* Returns the T class, the normalized form of the class.
- *
+ *
* @return The normal form of this class.
*/
public Class<T> getNormalClass() {
@@ -349,11 +350,11 @@ public abstract class PojoSwap<T,S> {
/**
* Returns the G class, the generalized form of the class.
- *
+ *
* <p>
* Subclasses must override this method if the generalized class is {@code Object}, meaning it can produce multiple
* generalized forms.
- *
+ *
* @return The transformed form of this class.
*/
public Class<?> getSwapClass() {
@@ -362,10 +363,10 @@ public abstract class PojoSwap<T,S> {
/**
* Returns the {@link ClassMeta} of the transformed class type.
- *
+ *
* <p>
* This value is cached for quick lookup.
- *
+ *
* @param session
* The bean context to use to get the class meta.
* This is always going to be the same bean context that created this swap.
@@ -379,7 +380,7 @@ public abstract class PojoSwap<T,S> {
/**
* Checks if the specified object is an instance of the normal class defined on this swap.
- *
+ *
* @param o The object to check.
* @return
* <jk>true</jk> if the specified object is a subclass of the normal class defined on this transform.
@@ -393,7 +394,7 @@ public abstract class PojoSwap<T,S> {
/**
* Checks if the specified object is an instance of the swap class defined on this swap.
- *
+ *
* @param o The object to check.
* @return
* <jk>true</jk> if the specified object is a subclass of the transformed class defined on this transform.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/PropertyFilter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/PropertyFilter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/PropertyFilter.java
index 16c641b..722f4e4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/PropertyFilter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/PropertyFilter.java
@@ -21,58 +21,58 @@ package org.apache.juneau.transform;
* <p>
* Property filters can be used to intercept calls to getters and setters and alter their values in transit.
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
- * <jc>// Property filter that strips out sensitive information on Address beans.</jc>
- * <jk>public class</jk> AddressPropertyFilter <jk>extends</jk> PropertyFilter {
- *
- * <ja>@Override</ja>
- * <jk>public</jk> Object readProperty(Object bean, String name, Object value) {
- * <jk>if</jk> (<js>"taxInfo"</js>.equals(name))
- * <jk>return</jk> <js>"redacted"</js>;
- * <jk>return</jk> value;
- * }
- *
- * <ja>@Override</ja>
- * <jk>public</jk> Object writeProperty(Object bean, String name, Object value) {
- * AddressBook a = (Address)bean;
- * <jk>if</jk> (<js>"taxInfo"</js>.equals(name) && <js>"redacted"</js>.equals(value))
- * <jk>return</jk> TaxInfoUtils.<jsm>lookup</jsm>(a.getStreet(), a.getCity(), a.getState());
- * <jk>return</jk> value;
- * }
- * }
- * </p>
- *
- * <p>
- * Property filters are registered in the following ways:
- * <ul>
- * <li class='ja'>{@link org.apache.juneau.annotation.Bean#propertyFilter() @Bean.propertyFilter()}
- * <li class='jm'>{@link org.apache.juneau.transform.BeanFilterBuilder#propertyFilter(Class)}
- * </ul>
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
+ * <jc>// Property filter that strips out sensitive information on Address beans.</jc>
+ * <jk>public class</jk> AddressPropertyFilter <jk>extends</jk> PropertyFilter {
*
- * <h5 class='section'>Example:</h5>
- * <p class='bcode'>
- * <jc>// Register filter on bean class.</jc>
- * <ja>@Bean</ja>(propertyFilter=AddressPropertyFilter.<jk>class</jk>)
- * <jk>public class</jk> Address {
- * <jk>public</jk> String getTaxInfo() {...}
- * <jk>public void</jk> setTaxInfo(String s) {...}
- * }
- *
- * <jc>// Or define a bean filter.</jc>
- * <jk>public class</jk> MyFilter <jk>extends</jk> BeanFilterBuilder<Address> {
- * <jk>public</jk> MyFilter() {
- * <jc>// Our bean contains generic collections of Foo and Bar objects.</jc>
- * propertyFilter(AddressPropertyFilter.<jk>class</jk>);
- * }
- * }
- *
- * <jc>// Register filter on serializer or parser.</jc>
- * WriterSerializer s = JsonSerializer
- * .<jsm>create</jsm>()
- * .beanFilters(MyFilter.<jk>class</jk>)
- * .build();
- * </p>
+ * <ja>@Override</ja>
+ * <jk>public</jk> Object readProperty(Object bean, String name, Object value) {
+ * <jk>if</jk> (<js>"taxInfo"</js>.equals(name))
+ * <jk>return</jk> <js>"redacted"</js>;
+ * <jk>return</jk> value;
+ * }
+ *
+ * <ja>@Override</ja>
+ * <jk>public</jk> Object writeProperty(Object bean, String name, Object value) {
+ * AddressBook a = (Address)bean;
+ * <jk>if</jk> (<js>"taxInfo"</js>.equals(name) && <js>"redacted"</js>.equals(value))
+ * <jk>return</jk> TaxInfoUtils.<jsm>lookup</jsm>(a.getStreet(), a.getCity(), a.getState());
+ * <jk>return</jk> value;
+ * }
+ * }
+ * </p>
+ *
+ * <p>
+ * Property filters are registered in the following ways:
+ * <ul>
+ * <li class='ja'>{@link org.apache.juneau.annotation.Bean#propertyFilter() @Bean.propertyFilter()}
+ * <li class='jm'>{@link org.apache.juneau.transform.BeanFilterBuilder#propertyFilter(Class)}
+ * </ul>
+ *
+ * <h5 class='section'>Example:</h5>
+ * <p class='bcode'>
+ * <jc>// Register filter on bean class.</jc>
+ * <ja>@Bean</ja>(propertyFilter=AddressPropertyFilter.<jk>class</jk>)
+ * <jk>public class</jk> Address {
+ * <jk>public</jk> String getTaxInfo() {...}
+ * <jk>public void</jk> setTaxInfo(String s) {...}
+ * }
+ *
+ * <jc>// Or define a bean filter.</jc>
+ * <jk>public class</jk> MyFilter <jk>extends</jk> BeanFilterBuilder<Address> {
+ * <jk>public</jk> MyFilter() {
+ * <jc>// Our bean contains generic collections of Foo and Bar objects.</jc>
+ * propertyFilter(AddressPropertyFilter.<jk>class</jk>);
+ * }
+ * }
+ *
+ * <jc>// Register filter on serializer or parser.</jc>
+ * WriterSerializer s = JsonSerializer
+ * .<jsm>create</jsm>()
+ * .beanFilters(MyFilter.<jk>class</jk>)
+ * .build();
+ * </p>
*/
public class PropertyFilter {
@@ -91,7 +91,7 @@ public class PropertyFilter {
* <p class='bcode'>
* <jc>// Address filter that strips out sensitive information.</jc>
* <jk>public class</jk> AddressPropertyFilter <jk>extends</jk> PropertyFilter {
- *
+ *
* <jk>public</jk> Object readProperty(Object bean, String name, Object value) {
* <jk>if</jk> (<js>"taxInfo"</js>.equals(name))
* <jk>return</jk> <js>"redacted"</js>;
@@ -99,7 +99,7 @@ public class PropertyFilter {
* }
* }
* </p>
- *
+ *
* @param bean The bean from which the property was read.
* @param name The property name.
* @param value The value just extracted from calling the bean getter.
@@ -115,12 +115,12 @@ public class PropertyFilter {
* <p>
* Subclasses can override this property to convert property values to some other object just before calling the
* bean setter.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Address filter that strips out sensitive information.</jc>
* <jk>public class</jk> AddressPropertyFilter <jk>extends</jk> PropertyFilter {
- *
+ *
* <jk>public</jk> Object writeProperty(Object bean, String name, Object value) {
* AddressBook a = (Address)bean;
* <jk>if</jk> (<js>"taxInfo"</js>.equals(name) && <js>"redacted"</js>.equals(value))
@@ -129,7 +129,7 @@ public class PropertyFilter {
* }
* }
* </p>
- *
+ *
* @param bean The bean from which the property was read.
* @param name The property name.
* @param value The value just parsed.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/StringSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/StringSwap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/StringSwap.java
index 4980a00..a677844 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/StringSwap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/StringSwap.java
@@ -16,8 +16,8 @@ import org.apache.juneau.*;
/**
* Abstract subclass for POJO swaps that swap objects for strings.
- *
- * <h6 class='topic'>Example</h6>
+ *
+ * <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// A swap that converts byte arrays to BASE64-encoded strings.</jc>
* <jk>public class</jk> ByteArrayBase64Swap <jk>extends</jk> StringSwap<<jk>byte</jk>[]> {
@@ -37,7 +37,7 @@ import org.apache.juneau.*;
* WriterSerializer s = JsonSerializer.<jsm>create</jsm>().simple().pojoSwaps(ByteArrayBase64Swap.<jk>class</jk>).build();
* String json = s.serialize(<jk>new byte</jk>[] {1,2,3}); <jc>// Produces "'AQID'"</jc>
* </p>
- *
+ *
* @param <T> The normal form of the class.
*/
public abstract class StringSwap<T> extends PojoSwap<T,String> {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/Surrogate.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/Surrogate.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/Surrogate.java
index aaf7e40..cda9667 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/Surrogate.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/Surrogate.java
@@ -16,27 +16,27 @@ import org.apache.juneau.*;
/**
* Identifies a class as being a surrogate class.
- *
+ *
* <p>
* Surrogate classes are used in place of other classes during serialization.
* For example, you may want to use a surrogate class to change the names or order of bean properties on a bean.
- *
+ *
* <p>
* This interface has no methods to implement.
* It's simply used by the framework to identify the class as a surrogate class when specified as a swap.
- *
+ *
* <p>
* The following is an example of a surrogate class change changes a property name:
* <p class='bcode'>
* <jk>public class</jk> MySurrogate <jk>implements</jk> Surrogate {
* <jk>public</jk> String surrogateField; <jc>// New bean property</jc>
- *
+ *
* <jk>public</jk> MySurrogate(NormalClass normalClass) {
* <jk>this</jk>.surrogateField = normalClass.normalField;
* }
* }
* </p>
- *
+ *
* <p>
* Optionally, a public static method can be used to un-transform a class during parsing:
* <p class='bcode'>
@@ -47,7 +47,7 @@ import org.apache.juneau.*;
* }
* }
* </p>
- *
+ *
* <p>
* Surrogate classes must conform to the following:
* <ul class='spaced-list'>
@@ -65,7 +65,7 @@ import org.apache.juneau.*;
* transformed class can be instantiated by the parser before being converted into the normal class by the
* un-transform method).
* </ul>
- *
+ *
* <p>
* Surrogate classes are associated with serializers and parsers using the {@link BeanContextBuilder#pojoSwaps(Class...)}
* method.
@@ -76,37 +76,37 @@ import org.apache.juneau.*;
* JsonParser p = JsonParser.<jsm>create</jsm>().pojoSwaps(MySurrogate.<jk>class</jk>).build();
* String r;
* Normal n = Normal.<jsm>create</jsm>();
- *
+ *
* r = s.serialize(n);
* assertEquals(<js>"{f2:'f1'}"</js>, r);
- *
+ *
* n = p.parse(r, Normal.<jk>class</jk>);
* assertEquals(<js>"f1"</js>, n.f1);
* }
- *
+ *
* <jc>// The normal class</jc>
* <jk>public class</jk> Normal {
* <jk>public</jk> String f1;
- *
+ *
* <jk>public static</jk> Normal <jsm>create</jsm>() {
* Normal n = <jk>new</jk> Normal();
* n.f1 = <js>"f1"</js>;
* <jk>return</jk> n;
* }
* }
- *
+ *
* <jc>// The surrogate class</jc>
* <jk>public class</jk> MySurrogate <jk>implements</jk> Surrogate {
* <jk>public</jk> String f2;
- *
+ *
* <jc>// Surrogate constructor</jc>
* <jk>public</jk> MySurrogate(Normal n) {
* f2 = n.f1;
* }
- *
+ *
* <jc>// Constructor used during parsing (only needed if un-transform method specified)</jc>
* <jk>public</jk> MySurrogate() {}
- *
+ *
* <jc>// Un-transform method (optional)</jc>
* <jk>public static</jk> Normal <jsm>toNormal</jsm>(Surrogate f) {
* Normal n = <jk>new</jk> Normal();
@@ -115,7 +115,7 @@ import org.apache.juneau.*;
* }
* }
* </p>
- *
+ *
* <p>
* It should be noted that a surrogate class is functionally equivalent to the following {@link PojoSwap}
* implementation:
@@ -129,6 +129,6 @@ import org.apache.juneau.*;
* }
* }
* </p>
- *
+ *
*/
public interface Surrogate {}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/SurrogateSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/SurrogateSwap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/SurrogateSwap.java
index b3d2b56..5a0785e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/SurrogateSwap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transform/SurrogateSwap.java
@@ -22,7 +22,7 @@ import org.apache.juneau.serializer.*;
/**
* Specialized {@link PojoSwap} for {@link Surrogate} classes.
- *
+ *
* @param <T> The class type that this transform applies to.
* @param <F> The transformed class type.
*/
@@ -33,7 +33,7 @@ public class SurrogateSwap<T,F> extends PojoSwap<T,F> {
/**
* Constructor.
- *
+ *
* @param forClass The normal class.
* @param constructor The constructor on the surrogate class that takes the normal class as a parameter.
* @param untransformMethod The static method that converts surrogate objects into normal objects.
@@ -46,11 +46,11 @@ public class SurrogateSwap<T,F> extends PojoSwap<T,F> {
/**
* Given the specified surrogate class, return the list of POJO swaps.
- *
+ *
* <p>
* A transform is returned for each public 1-arg constructor found.
* Returns an empty list if no public 1-arg constructors are found.
- *
+ *
* @param c The surrogate class.
* @return The list of POJO swaps that apply to this class.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java
index 9f49c73..907ff75 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/BeanStringSwap.java
@@ -17,17 +17,17 @@ import org.apache.juneau.transform.*;
/**
* Transforms beans into {@link String Strings} by simply calling the {@link Object#toString()} method.
- *
+ *
* <p>
* Allows you to specify classes that should just be converted to {@code Strings} instead of potentially
* being turned into Maps by the {@link BeanContext} (or worse, throwing
* {@link BeanRuntimeException BeanRuntimeExceptions}).
- *
+ *
* <p>
* This is usually a one-way transform.
* Beans serialized as strings cannot be reconstituted using a parser unless it is a
* <a class="doclink" href="../../../../overview-summary.html#juneau-marshall.PojoCategories">Type 5 POJO</a>.
- *
+ *
* @param <T> The class type of the bean.
*/
public class BeanStringSwap<T> extends StringSwap<T> {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/CalendarSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/CalendarSwap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/CalendarSwap.java
index 24585ba..e679581 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/CalendarSwap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/CalendarSwap.java
@@ -24,9 +24,9 @@ import org.apache.juneau.utils.*;
/**
* Transforms {@link Calendar Calendars} to {@link String Strings}.
- *
+ *
* <h6 class='topic'>Behavior-specific subclasses</h6>
- *
+ *
* The following direct subclasses are provided for convenience to the following formats:
* <ul>
* <li>{@link ToString} - To {@link String Strings} using the {@code Date.toString()} method.
@@ -58,7 +58,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link String Strings} using the {@code Date.toString()} method.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Wed Jul 04 15:30:45 EST 2001"</js>
@@ -79,13 +79,13 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to ISO8601 date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"2001-07-04T15:30:45-05:00"</js>
* <li><js>"2001-07-04T15:30:45Z"</js>
* </ul>
- *
+ *
* <h6 class='topic'>Example input:</h6>
* <ul>
* <li><js>"2001-07-04T15:30:45-05:00"</js>
@@ -112,12 +112,12 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to ISO8601 date-time-local strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"2001-07-04T15:30:45"</js>
* </ul>
- *
+ *
* <h6 class='topic'>Example input:</h6>
* <ul>
* <li><js>"2001-07-04T15:30:45"</js>
@@ -143,7 +143,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Same as {@link ISO8601DT}, except always serializes in GMT.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <js>"2001-07-04T15:30:45Z"</js>
*/
@@ -162,7 +162,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Same as {@link ISO8601DT} except serializes to millisecond precision.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <js>"2001-07-04T15:30:45.123Z"</js>
*/
@@ -176,7 +176,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Same as {@link ISO8601DTZ} except serializes to millisecond precision.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <js>"2001-07-04T15:30:45.123"</js>
*/
@@ -190,7 +190,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* ISO8601 date only.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <js>"2001-07-04"</js>
*/
@@ -209,7 +209,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to RFC2822 date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Sat, 03 Mar 2001 10:11:12 +0000"</js> <jc>// en_US</jc>
@@ -232,7 +232,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Same as {@link RFC2822DT}, except always serializes in GMT.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Sat, 03 Mar 2001 10:11:12 GMT"</js> <jc>// en_US</jc>
@@ -255,7 +255,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to RFC2822 date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"03 Mar 2001"</js> <jc>// en_US</jc>
@@ -278,7 +278,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to simple <js>"yyyy/MM/dd HH:mm:ss"</js> date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"2001/03/03 10:11:12"</js>
@@ -299,7 +299,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to simple <js>"yyyy/MM/dd"</js> date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"2001/03/03"</js>
@@ -320,7 +320,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to simple <js>"HH:mm:ss"</js> time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11:12"</js>
@@ -341,7 +341,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link DateFormat#FULL} date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Saturday, March 3, 2001"</js> <jc>// en_US</jc>
@@ -364,7 +364,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link DateFormat#LONG} date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"March 3, 2001"</js> <jc>// en_US</jc>
@@ -387,7 +387,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link DateFormat#MEDIUM} date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Mar 3, 2001"</js> <jc>// en_US</jc>
@@ -410,7 +410,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link DateFormat#SHORT} date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"3/3/01"</js> <jc>// en_US</jc>
@@ -433,7 +433,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link DateFormat#FULL} time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11:12 AM GMT"</js> <jc>// en_US</jc>
@@ -456,7 +456,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link DateFormat#LONG} time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11:12 AM GMT"</js> <jc>// en_US</jc>
@@ -479,7 +479,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link DateFormat#MEDIUM} time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11:12 AM"</js> <jc>// en_US</jc>
@@ -502,7 +502,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link DateFormat#SHORT} time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11 AM"</js> <jc>// en_US</jc>
@@ -525,7 +525,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link DateFormat#FULL} date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Saturday, March 3, 2001 10:11:12 AM GMT"</js> <jc>// en_US</jc>
@@ -548,7 +548,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link DateFormat#LONG} date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"March 3, 2001 10:11:12 AM GMT"</js> <jc>// en_US</jc>
@@ -571,7 +571,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link DateFormat#MEDIUM} date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Mar 3, 2001 10:11:12 AM"</js> <jc>// en_US</jc>
@@ -594,7 +594,7 @@ public class CalendarSwap extends StringSwap<Calendar> {
/**
* Transforms {@link Calendar Calendars} to {@link DateFormat#SHORT} date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"3/3/01 10:11 AM"</js> <jc>// en_US</jc>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/DateSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/DateSwap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/DateSwap.java
index 0b9aea0..28022da 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/DateSwap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/DateSwap.java
@@ -24,9 +24,9 @@ import org.apache.juneau.utils.*;
/**
* Transforms {@link Date Dates} to {@link String Strings}.
- *
+ *
* <h6 class='topic'>Behavior-specific subclasses</h6>
- *
+ *
* The following direct subclasses are provided for convenience to the following formats:
* <ul>
* <li>{@link ToString} - To {@link String Strings} using the {@code Date.toString()} method.
@@ -58,7 +58,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link String Strings} using the {@code Date.toString()} method.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Wed Jul 04 15:30:45 EST 2001"</js>
@@ -79,13 +79,13 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Calendar Calendars} to ISO8601 date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"2001-07-04T15:30:45-05:00"</js>
* <li><js>"2001-07-04T15:30:45Z"</js>
* </ul>
- *
+ *
* <h6 class='topic'>Example input:</h6>
* <ul>
* <li><js>"2001-07-04T15:30:45-05:00"</js>
@@ -112,12 +112,12 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to ISO8601 date-time-local strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"2001-07-04T15:30:45"</js>
* </ul>
- *
+ *
* <h6 class='topic'>Example input:</h6>
* <ul>
* <li><js>"2001-07-04T15:30:45"</js>
@@ -143,7 +143,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Same as {@link ISO8601DT}, except always serializes in GMT.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <js>"2001-07-04T15:30:45Z"</js>
*/
@@ -162,7 +162,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Same as {@link CalendarSwap.ISO8601DT} except serializes to millisecond precision.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <js>"2001-07-04T15:30:45.123Z"</js>
*/
@@ -176,7 +176,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Same as {@link CalendarSwap.ISO8601DTZ} except serializes to millisecond precision.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <js>"2001-07-04T15:30:45.123"</js>
*/
@@ -190,7 +190,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* ISO8601 date only.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <js>"2001-07-04"</js>
*/
@@ -209,7 +209,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to RFC2822 date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Sat, 03 Mar 2001 10:11:12 +0000"</js> <jc>// en_US</jc>
@@ -232,7 +232,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Same as {@link DateSwap.RFC2822DT}, except always serializes in GMT.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Sat, 03 Mar 2001 10:11:12 GMT"</js> <jc>// en_US</jc>
@@ -255,7 +255,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to RFC2822 date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"03 Mar 2001"</js> <jc>// en_US</jc>
@@ -278,7 +278,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to simple <js>"yyyy/MM/dd HH:mm:ss"</js> date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"2001/03/03 10:11:12"</js>
@@ -299,7 +299,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to simple <js>"yyyy/MM/dd"</js> date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"2001/03/03"</js>
@@ -320,7 +320,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to simple <js>"HH:mm:ss"</js> time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11:12"</js>
@@ -341,7 +341,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link DateFormat#FULL} date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Saturday, March 3, 2001"</js> <jc>// en_US</jc>
@@ -364,7 +364,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link DateFormat#LONG} date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"March 3, 2001"</js> <jc>// en_US</jc>
@@ -387,7 +387,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link DateFormat#MEDIUM} date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Mar 3, 2001"</js> <jc>// en_US</jc>
@@ -410,7 +410,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link DateFormat#SHORT} date strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"3/3/01"</js> <jc>// en_US</jc>
@@ -433,7 +433,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link DateFormat#FULL} time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11:12 AM GMT"</js> <jc>// en_US</jc>
@@ -456,7 +456,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link DateFormat#LONG} time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11:12 AM GMT"</js> <jc>// en_US</jc>
@@ -479,7 +479,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link DateFormat#MEDIUM} time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11:12 AM"</js> <jc>// en_US</jc>
@@ -502,7 +502,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link DateFormat#SHORT} time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"10:11 AM"</js> <jc>// en_US</jc>
@@ -525,7 +525,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link DateFormat#FULL} date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Saturday, March 3, 2001 10:11:12 AM GMT"</js> <jc>// en_US</jc>
@@ -548,7 +548,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link DateFormat#LONG} date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"March 3, 2001 10:11:12 AM GMT"</js> <jc>// en_US</jc>
@@ -571,7 +571,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link DateFormat#MEDIUM} date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"Mar 3, 2001 10:11:12 AM"</js> <jc>// en_US</jc>
@@ -594,7 +594,7 @@ public class DateSwap extends StringSwap<Date> {
/**
* Transforms {@link Date Dates} to {@link DateFormat#SHORT} date-time strings.
- *
+ *
* <h5 class='section'>Example output:</h5>
* <ul>
* <li><js>"3/3/01 10:11 AM"</js> <jc>// en_US</jc>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/IteratorSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/IteratorSwap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/IteratorSwap.java
index 219baec..74fa31c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/IteratorSwap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/IteratorSwap.java
@@ -19,7 +19,7 @@ import org.apache.juneau.transform.*;
/**
* Transforms {@link Iterator Iterators} to {@code List<Object>} objects.
- *
+ *
* <p>
* This is a one-way transform, since {@code Iterators} cannot be reconstituted.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/ReaderSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/ReaderSwap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/ReaderSwap.java
index c2b3199..31b8955 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/ReaderSwap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/ReaderSwap.java
@@ -27,20 +27,21 @@ import org.apache.juneau.xml.*;
/**
* Transforms the contents of a {@link Reader} into an {@code Object}.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* The {@code Reader} must contain JSON, Juneau-generated XML (output from {@link XmlSerializer}), or Juneau-generated
* HTML (output from {@link JsonSerializer}) in order to be parsed correctly.
- *
+ *
* <p>
* Useful for serializing models that contain {@code Readers} created by {@code RestCall} instances.
- *
+ *
* <p>
* This is a one-way transform, since {@code Readers} cannot be reconstituted.
- *
+ *
* <h6 class='topic'>Behavior-specific subclasses</h6>
- *
+ *
* The following direct subclasses are provided for convenience:
* <ul>
* <li>{@link Json} - Parses JSON text.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/StringFormatSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/StringFormatSwap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/StringFormatSwap.java
index 24c0ab0..291064a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/StringFormatSwap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/StringFormatSwap.java
@@ -25,7 +25,7 @@ public class StringFormatSwap extends StringSwap<Object> {
/**
* Constructor.
- *
+ *
* @param format The string format string.
*/
public StringFormatSwap(String format) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/XMLGregorianCalendarSwap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/XMLGregorianCalendarSwap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/XMLGregorianCalendarSwap.java
index 446e150..e887753 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/XMLGregorianCalendarSwap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/transforms/XMLGregorianCalendarSwap.java
@@ -21,10 +21,10 @@ import org.apache.juneau.transform.*;
/**
* Transforms {@link XMLGregorianCalendar XMLGregorianCalendars} to ISO8601 date-time {@link String Strings}.
- *
+ *
* <p>
* Objects are converted to strings using {@link XMLGregorianCalendar#toXMLFormat()}.
- *
+ *
* <p>
* Strings are converted to objects using {@link DatatypeFactory#newXMLGregorianCalendar(String)}.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/ParamFormat.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/ParamFormat.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/ParamFormat.java
index 9b3d642..592831f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/ParamFormat.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/ParamFormat.java
@@ -19,10 +19,10 @@ public enum ParamFormat {
/**
* Use UON notation for values.
- *
+ *
* <p>
* String values such as <js>"(foo='bar')"</js> will end up being quoted and escaped to <js>"'(foo=bar~'baz~')'"</js>.
- *
+ *
* <p>
* 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>.
@@ -31,11 +31,11 @@ public enum ParamFormat {
/**
* Serialize as plain text.
- *
+ *
* <p>
* Strings will never be quoted or escaped.
* <br>Maps and array constructs (<js>"(...)"</js>, <js>"@(...)"</js>) will never be used.
- *
+ *
* <p>
* 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.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParser.java
index 7bd3fc9..b378faf 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParser.java
@@ -18,13 +18,15 @@ import org.apache.juneau.urlencoding.*;
/**
* Parses UON (a notation for URL-encoded query parameter values) text into POJO models.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Content-Type</code> types: <code>text/uon</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Content-Type</code> types: <code><b>text/uon</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* This parser uses a state machine, which makes it very fast and efficient.
*/
public class UonParser extends ReaderParser {
@@ -37,7 +39,7 @@ public class UonParser extends ReaderParser {
/**
* Configuration property: Decode <js>"%xx"</js> sequences.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"UonParser.decoding.b"</js>
@@ -50,7 +52,7 @@ public class UonParser extends ReaderParser {
* <li class='jm'>{@link UonParserBuilder#decoding()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specify <jk>true</jk> if URI encoded characters should be decoded, <jk>false</jk> if they've already been decoded
@@ -70,7 +72,7 @@ public class UonParser extends ReaderParser {
* .set(<jsf>UON_decoding</jsf>, <jk>true</jk>)
* .build();
*
- * <jc>// Produces: ["foo bar", "baz quz"].</jc>
+ * <jc>// Produces: ["foo bar", "baz quz"].</jc>
* String[] foo = p.parse(<js>"@(foo%20bar,baz%20qux)"</js>, String[].<jk>class</jk>);
* </p>
*/
@@ -97,7 +99,7 @@ public class UonParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Decoding(PropertyStore ps) {
@@ -115,7 +117,7 @@ public class UonParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -125,7 +127,7 @@ public class UonParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param consumes
@@ -159,7 +161,7 @@ public class UonParser extends ReaderParser {
/**
* Create a UON parser session for parsing parameter values.
- *
+ *
* @return A new parser session.
*/
protected final UonParserSession createParameterSession() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParserBuilder.java
index ccb6cab..9dd292a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParserBuilder.java
@@ -35,7 +35,7 @@ public class UonParserBuilder extends ParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public UonParserBuilder(PropertyStore ps) {
@@ -54,11 +54,11 @@ public class UonParserBuilder extends ParserBuilder {
/**
* Configuration property: Decode <js>"%xx"</js> sequences.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UonParser#UON_decoding}
@@ -78,7 +78,7 @@ public class UonParserBuilder extends ParserBuilder {
*
* <p>
* Shortcut for calling <code>decodeChars(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UonParser#UON_decoding}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParserSession.java
index 029197b..95ebad8 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonParserSession.java
@@ -26,7 +26,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link UonParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -44,7 +44,7 @@ public class UonParserSession extends ReaderParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -66,11 +66,11 @@ public class UonParserSession extends ReaderParserSession {
/**
* Create a specialized parser session for parsing URL parameters.
- *
+ *
* <p>
* The main difference is that characters are never decoded, and the {@link UonParser#UON_decoding}
* property is always ignored.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -113,7 +113,7 @@ public class UonParserSession extends ReaderParserSession {
/**
* Workhorse method.
- *
+ *
* @param eType The class type being parsed, or <jk>null</jk> if unknown.
* @param r The reader being parsed.
* @param outer The outer object (for constructing nested inner classes).
@@ -547,7 +547,7 @@ public class UonParserSession extends ReaderParserSession {
/**
* Convenience method for parsing an attribute from the specified parser.
- *
+ *
* @param r
* @param encoded
* @return The parsed object
@@ -561,7 +561,7 @@ public class UonParserSession extends ReaderParserSession {
/**
* Parses an attribute name from the specified reader.
- *
+ *
* @param r
* @param encoded
* @return The parsed attribute name.
@@ -631,7 +631,7 @@ public class UonParserSession extends ReaderParserSession {
/**
* Parses a string value from the specified reader.
- *
+ *
* @param r
* @param isUrlParamValue
* @return The parsed string.
@@ -749,7 +749,7 @@ public class UonParserSession extends ReaderParserSession {
/**
* Returns a map identifying the current parse location.
- *
+ *
* @param r The reader being read from.
* @return A map identifying the current parse location.
*/
@@ -759,7 +759,7 @@ public class UonParserSession extends ReaderParserSession {
/**
* Creates a {@link UonReader} from the specified parser pipe.
- *
+ *
* @param pipe The parser input.
* @param decodeChars Whether the reader should automatically decode URL-encoded characters.
* @return A new {@link UonReader} object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonReader.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonReader.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonReader.java
index 3037ad3..37819b7 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonReader.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonReader.java
@@ -18,10 +18,10 @@ import org.apache.juneau.parser.*;
/**
* Same functionality as {@link ParserReader} except automatically decoded <code>%xx</code> escape sequences.
- *
+ *
* <p>
* Escape sequences are assumed to be encoded UTF-8. Extended Unicode (>\u10000) is supported.
- *
+ *
* <p>
* If decoding is enabled, the following character replacements occur so that boundaries are not lost:
* <ul>
@@ -40,7 +40,7 @@ public final class UonReader extends ParserReader {
/**
* Constructor.
- *
+ *
* @param pipe The parser input.
* @param decodeChars Whether the input is URL-encoded.
* @throws Exception
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializer.java
index 60d6808..bc449f6 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializer.java
@@ -18,20 +18,21 @@ import org.apache.juneau.urlencoding.*;
/**
* Serializes POJO models to UON (a notation for URL-encoded query parameter values).
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/uon</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/uon</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/uon</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/uon</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* This serializer provides several serialization options.
* Typically, one of the predefined DEFAULT serializers will be sufficient.
* However, custom serializers can be constructed to fine-tune behavior.
- *
+ *
* <p>
* The following shows a sample object defined in Javascript:
* <p class='bcode'>
@@ -56,7 +57,7 @@ import org.apache.juneau.urlencoding.*;
* ]
* }
* </p>
- *
+ *
* <p>
* Using the "strict" syntax defined in this document, the equivalent UON notation would be as follows:
* <p class='bcode'>
@@ -81,16 +82,16 @@ import org.apache.juneau.urlencoding.*;
* )
* )
* </p>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Serialize a Map</jc>
* Map m = <jk>new</jk> ObjectMap(<js>"{a:'b',c:1,d:false,e:['f',1,false],g:{h:'i'}}"</js>);
- *
+ *
* <jc>// Serialize to value equivalent to JSON.</jc>
* <jc>// Produces "(a=b,c=1,d=false,e=@(f,1,false),g=(h=i))"</jc>
* String s = UonSerializer.<jsf>DEFAULT</jsf>.serialize(s);
- *
+ *
* <jc>// Serialize a bean</jc>
* <jk>public class</jk> Person {
* <jk>public</jk> Person(String s);
@@ -99,17 +100,17 @@ import org.apache.juneau.urlencoding.*;
* <jk>public</jk> Address getAddress();
* <jk>public boolean</jk> deceased;
* }
- *
+ *
* <jk>public class</jk> Address {
* <jk>public</jk> String getStreet();
* <jk>public</jk> String getCity();
* <jk>public</jk> String getState();
* <jk>public int</jk> getZip();
* }
- *
+ *
* Person p = <jk>new</jk> Person(<js>"John Doe"</js>, 23, <js>"123 Main St"</js>, <js>"Anywhere"</js>,
* <js>"NY"</js>, 12345, <jk>false</jk>);
- *
+ *
* <jc>// Produces "(name='John Doe',age=23,address=(street='123 Main St',city=Anywhere,state=NY,zip=12345),deceased=false)"</jc>
* String s = UonSerializer.<jsf>DEFAULT</jsf>.serialize(s);
* </p>
@@ -124,7 +125,7 @@ public class UonSerializer extends WriterSerializer {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"UonSerializer.addBeanTypeProperties.b"</js>
@@ -136,12 +137,12 @@ public class UonSerializer extends WriterSerializer {
* <li class='jm'>{@link UonSerializerBuilder#addBeanTypeProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
* through reflection.
- *
+ *
* <p>
* When present, this value overrides the {@link #SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -150,7 +151,7 @@ public class UonSerializer extends WriterSerializer {
/**
* Configuration property: Encode non-valid URI characters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"UonSerializer.encoding.b"</js>
@@ -163,11 +164,11 @@ public class UonSerializer extends WriterSerializer {
* <li class='jm'>{@link UonSerializerBuilder#encoding()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Encode non-valid URI characters with <js>"%xx"</js> constructs.
- *
+ *
* <p>
* If <jk>true</jk>, non-valid URI characters will be converted to <js>"%xx"</js> sequences.
* <br>Set to <jk>false</jk> if parameter value is being passed to some other code that will already perform
@@ -199,7 +200,7 @@ public class UonSerializer extends WriterSerializer {
/**
* Configuration property: Format to use for query/form-data/header values.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"UrlEncodingSerializer.paramFormat.s"</js>
@@ -212,7 +213,7 @@ public class UonSerializer extends WriterSerializer {
* <li class='jm'>{@link UonSerializerBuilder#paramFormatPlain()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies the format to use for URL GET parameter keys and values.
@@ -276,7 +277,7 @@ public class UonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Readable(PropertyStore ps) {
@@ -291,7 +292,7 @@ public class UonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Encoding(PropertyStore ps) {
@@ -313,7 +314,7 @@ public class UonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -323,7 +324,7 @@ public class UonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java
index ff4b0d8..b605b7b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerBuilder.java
@@ -34,7 +34,7 @@ public class UonSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public UonSerializerBuilder(PropertyStore ps) {
@@ -53,10 +53,10 @@ public class UonSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Encode non-valid URI characters.
- *
+ *
* <p>
* Encode non-valid URI characters with <js>"%xx"</js> constructs.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UonSerializer#UON_encoding}
@@ -73,15 +73,15 @@ public class UonSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Encode non-valid URI characters.
- *
+ *
* <p>
* Shortcut for calling <code>encoding(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UonSerializer#UON_encoding}
* </ul>
- *
+ *
* @return This object (for method chaining).
*/
public UonSerializerBuilder encoding() {
@@ -90,15 +90,15 @@ public class UonSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Format to use for query/form-data/header values.
- *
+ *
* <p>
* Specifies the format to use for URL GET parameter keys and values.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UonSerializer#UON_paramFormat}
* </ul>
- *
+ *
* @param value
* The new value for this property.
* <br>The default value is {@link ParamFormat#UON}.
@@ -110,15 +110,15 @@ public class UonSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Format to use for query/form-data/header values.
- *
+ *
* <p>
* Shortcut for calling <code>paramFormat(<jsf>PLAINTEXT</jsf>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UonSerializer#UON_paramFormat}
* </ul>
- *
+ *
* @return This object (for method chaining).
*/
public UonSerializerBuilder paramFormatPlain() {
[04/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java
index b56e816..58098a9 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContext.java
@@ -50,7 +50,7 @@ import org.apache.juneau.utils.*;
/**
* Contains all the configuration on a REST resource and the entry points for handling REST calls.
- *
+ *
* <p>
* See {@link PropertyStore} for more information about context properties.
*/
@@ -64,7 +64,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Allow body URL parameter.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.allowBodyParam.b"</js>
@@ -80,7 +80,7 @@ public final class RestContext extends BeanContext {
* <li>{@link RestContextBuilder#allowBodyParam(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* When enabled, the HTTP body content on PUT and POST requests can be passed in as text using the <js>"body"</js>
@@ -98,7 +98,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Allowed method parameters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.allowedMethodParams.s"</js>
@@ -114,21 +114,21 @@ public final class RestContext extends BeanContext {
* <li class='jm'>{@link RestContextBuilder#allowedMethodParams(String...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* When specified, the HTTP method can be overridden by passing in a <js>"method"</js> URL parameter on a regular
* GET request.
* <br>
* For example: <js>"?method=OPTIONS"</js>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>Format is a comma-delimited list of HTTP method names that can be passed in as a method parameter.
* <li>Parameter name is case-insensitive.
* <li>Use <js>"*"</js> to represent all methods.
* </ul>
- *
+ *
* <p>
* Note that per the <a class="doclink"
* href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html">HTTP specification</a>, special care should
@@ -138,7 +138,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Allow header URL parameters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.allowHeaderParams.b"</js>
@@ -154,7 +154,7 @@ public final class RestContext extends BeanContext {
* <li class='jm'>{@link RestContextBuilder#allowHeaderParams(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* When enabled, headers such as <js>"Accept"</js> and <js>"Content-Type"</js> to be passed in as URL query
@@ -172,7 +172,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: REST call handler.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.callHandler.o"</js>
@@ -199,7 +199,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Children.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.children.lo"</js>
@@ -221,7 +221,7 @@ public final class RestContext extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* Defines children of this resource.
- *
+ *
* <p>
* A REST child resource is simply another servlet or object that is initialized as part of the parent resource and has a
* servlet path directly under the parent servlet path.
@@ -229,14 +229,14 @@ public final class RestContext extends BeanContext {
* <code>web.xml</code> file of the web application.
* <br>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 RestResource#path() @RestResource.path()} that identifies the subpath of the child resource
* relative to the parent path.
- *
+ *
* <p>
* Child resources can be nested arbitrarily deep using this technique (i.e. children can also have children).
- *
+ *
* <dl>
* <dt>Servlet initialization:</dt>
* <dd>
@@ -271,7 +271,7 @@ public final class RestContext extends BeanContext {
* <li><code><jk>public</jk> T()</code>
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Documentation:</h5>
* <ul>
* <li><a class="doclink" href="package-summary.html#RestResources.Children">org.apache.juneau.rest > Children</a>
@@ -281,7 +281,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Classpath resource finder.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.classpathResourceFinder.o"</js>
@@ -317,7 +317,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Client version header.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.clientVersionHeader.s"</js>
@@ -337,7 +337,7 @@ public final class RestContext extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* Specifies the name of the header used to denote the client version on HTTP requests.
- *
+ *
* <p>
* The client version is used to support backwards compatibility for breaking REST interface changes.
* <br>Used in conjunction with {@link RestMethod#clientVersion() @RestMethod.clientVersion()} annotation.
@@ -346,7 +346,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Resource context path.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.contextPath.s"</js>
@@ -366,7 +366,7 @@ public final class RestContext extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* Overrides the context path value for this resource and any child resources.
- *
+ *
* <p>
* This setting is useful if you want to use <js>"context:/child/path"</js> URLs in child resource POJOs but
* the context path is not actually specified on the servlet container.
@@ -377,7 +377,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Class-level response converters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.converters.lo"</js>
@@ -401,10 +401,10 @@ public final class RestContext extends BeanContext {
* 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.
- *
+ *
* <p>
* Can be used for performing post-processing on the response object before serialization.
- *
+ *
* <h5 class='section'>Documentation:</h5>
* <ul>
* <li><a class="doclink" href="package-summary.html#RestResources.Converters">org.apache.juneau.rest > Converters</a>
@@ -414,7 +414,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Default character encoding.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.defaultCharset.s"</js>
@@ -431,7 +431,7 @@ public final class RestContext extends BeanContext {
* <li class='jm'>{@link RestContextBuilder#defaultCharset(String)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* The default character encoding for the request and response if not specified on the request.
@@ -440,7 +440,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Default request headers.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.defaultRequestHeaders.smo"</js>
@@ -462,7 +462,7 @@ public final class RestContext extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* Specifies default values for request headers.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>Affects values returned by {@link RestRequest#getHeader(String)} when the header is not present on the request.
@@ -474,7 +474,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Default response headers.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.defaultResponseHeaders.omo"</js>
@@ -495,7 +495,7 @@ public final class RestContext extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* Specifies default values for response headers.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>This is equivalent to calling {@link RestResponse#setHeader(String, String)} programmatically in each of
@@ -507,7 +507,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Compression encoders.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.encoders.o"</js>
@@ -529,7 +529,7 @@ public final class RestContext extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Servlet with automated support for GZIP compression</jc>
@@ -550,7 +550,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Class-level guards.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.guards.lo"</js>
@@ -568,16 +568,16 @@ public final class RestContext extends BeanContext {
* <li class='jm'>{@link RestContextBuilder#guards(RestGuard...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* 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.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>{@link RestGuard} classes must have either a no-arg or {@link PropertyStore} argument constructors.
@@ -587,7 +587,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: REST info provider.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.infoProvider.o"</js>
@@ -608,7 +608,7 @@ public final class RestContext extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* Class used to retrieve title/description/swagger information about a resource.
- *
+ *
* <p>
* Subclasses can be used to customize the documentation on a resource.
*/
@@ -649,7 +649,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: The maximum allowed input size (in bytes) on HTTP requests.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.maxInput.s"</js>
@@ -666,7 +666,7 @@ public final class RestContext extends BeanContext {
* <li class='jm'>{@link RestContextBuilder#maxInput(String)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Useful for alleviating DoS attacks by throwing an exception when too much input is received instead of resulting
@@ -684,7 +684,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Messages.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.messages.lo"</js>
@@ -706,17 +706,17 @@ public final class RestContext extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* Identifies the location of the resource bundle for this class.
- *
+ *
* <p>
* This annotation is used to provide localized messages for the following methods:
* <ul>
* <li>{@link RestRequest#getMessage(String, Object...)}
* <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.
- *
+ *
* <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
@@ -731,7 +731,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: MIME types.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.mimeTypes.ss"</js>
@@ -774,7 +774,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Java method parameter resolvers.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.paramResolvers.lo"</js>
@@ -790,25 +790,25 @@ public final class RestContext extends BeanContext {
* <li class='jm'>{@link RestContextBuilder#paramResolvers(RestParam...)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* By default, the Juneau framework will automatically Java method parameters of various types (e.g.
* <code>RestRequest</code>, <code>Accept</code>, <code>Reader</code>).
* This setting allows you to provide your own resolvers for your own class types that you want resolved.
- *
+ *
* <p>
* For example, if you want to pass in instances of <code>MySpecialObject</code> to your Java method, define
* the following resolver:
* <p class='bcode'>
* <jk>public class</jk> MyRestParam <jk>extends</jk> RestParam {
- *
+ *
* <jc>// Must have no-arg constructor!</jc>
* <jk>public</jk> MyRestParam() {
* <jc>// First two parameters help with Swagger doc generation.</jc>
* <jk>super</jk>(<jsf>QUERY</jsf>, <js>"myparam"</js>, MySpecialObject.<jk>class</jk>);
* }
- *
+ *
* <jc>// The method that creates our object.
* // In this case, we're taking in a query parameter and converting it to our object.</jc>
* <jk>public</jk> Object resolve(RestRequest req, RestResponse res) <jk>throws</jk> Exception {
@@ -816,7 +816,7 @@ public final class RestContext extends BeanContext {
* }
* }
* </p>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>{@link RestParam} classes must have either a no-arg or {@link PropertyStore} argument constructors.
@@ -826,7 +826,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Parsers.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.parsers.lo"</js>
@@ -855,7 +855,7 @@ public final class RestContext extends BeanContext {
* <li>When defined as a class, properties/transforms defined on the resource/method are inherited.
* <li>When defined as an instance, properties/transforms defined on the resource/method are NOT inherited.
* </ul>
- *
+ *
* <h5 class='section'>Documentation:</h5>
* <ul>
* <li><a class="doclink" href="package-summary.html#RestResources.Parsers">org.apache.juneau.rest > Parsers</a>
@@ -865,7 +865,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: HTTP part parser.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.partParser.o"</js>
@@ -897,7 +897,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: HTTP part serializer.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.partSerializer.o"</js>
@@ -918,7 +918,7 @@ public final class RestContext extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* Specifies the {@link HttpPartSerializer} to use for serializing headers, query/form parameters, and URI parts.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>When defined as a class, properties/transforms defined on the resource/method are inherited.
@@ -929,7 +929,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Resource path.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.path.s"</js>
@@ -949,7 +949,7 @@ public final class RestContext extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* Identifies the URL subpath relative to the parent resource.
- *
+ *
* <p>
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -964,7 +964,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Render response stack traces in responses.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.renderResponseStackTraces.b"</js>
@@ -981,11 +981,11 @@ public final class RestContext extends BeanContext {
* <li class='jm'>{@link RestContextBuilder#renderResponseStackTraces()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Render stack traces in HTTP response bodies when errors occur.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>Useful for debugging, although allowing stack traces to be rendered may cause security concerns so use
@@ -996,7 +996,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: REST resource resolver.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.resourceResolver.o"</js>
@@ -1020,7 +1020,7 @@ public final class RestContext extends BeanContext {
*
* <p>
* Can be used to provide customized resolution of REST resource class instances (e.g. resources retrieve from Spring).
- *
+ *
* <p>
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
@@ -1031,7 +1031,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Response handlers.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.responseHandlers.lo"</js>
@@ -1053,7 +1053,7 @@ public final class RestContext extends BeanContext {
* <p>
* 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>
* By default, the following response handlers are provided out-of-the-box:
* <ul>
@@ -1075,7 +1075,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Serializers.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.serializers.lo"</js>
@@ -1104,7 +1104,7 @@ public final class RestContext extends BeanContext {
* <li>When defined as a class, properties/transforms defined on the resource/method are inherited.
* <li>When defined as an instance, properties/transforms defined on the resource/method are NOT inherited.
* </ul>
- *
+ *
* <h5 class='section'>Documentation:</h5>
* <ul>
* <li><a class="doclink" href="package-summary.html#RestResources.Serializers">org.apache.juneau.rest > Serializers</a>
@@ -1114,7 +1114,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Static file response headers.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.staticFileResponseHeaders.omo"</js>
@@ -1141,7 +1141,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Static file mappings.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.staticFiles.lo"</js>
@@ -1206,7 +1206,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Supported accept media types.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.supportedAcceptTypes.ls"</js>
@@ -1237,7 +1237,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Supported content media types.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.supportedContentTypes.ls"</js>
@@ -1259,7 +1259,7 @@ public final class RestContext extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* Overrides the media types inferred from the parsers that identify what media types can be consumed by the resource.
- *
+ *
* <p>
* This affects the values returned by {@link RestRequest#getSupportedContentTypes()} and the supported content
* types shown in {@link RestInfoProvider#getSwagger(RestRequest)}.
@@ -1268,7 +1268,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Use classpath resource caching.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.useClasspathResourceCaching.b"</js>
@@ -1294,7 +1294,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: Use stack trace hashes.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.useStackTraceHashes.b"</js>
@@ -1310,7 +1310,7 @@ public final class RestContext extends BeanContext {
* <li class='jm'>{@link RestContextBuilder#useStackTraceHashes(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* When enabled, the number of times an exception has occurred will be determined based on stack trace hashsums,
@@ -1320,7 +1320,7 @@ public final class RestContext extends BeanContext {
/**
* Configuration property: HTML Widgets.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestContext.widgets.lo"</js>
@@ -1354,11 +1354,11 @@ public final class RestContext extends BeanContext {
* <br>The styles contents are automatically inserted into the <xt><head/style></xt> section
* in the HTML page.
* </ul>
- *
+ *
* <p>
* The following examples shows how to associate a widget with a REST method and then have it rendered in the links
* and aside section of the page:
- *
+ *
* <p class='bcode'>
* <ja>@RestMethod</ja>(
* widgets={
@@ -1469,7 +1469,7 @@ public final class RestContext extends BeanContext {
/**
* Constructor.
- *
+ *
* @param builder The servlet configuration object.
* @throws Exception If any initialization problems were encountered.
*/
@@ -1834,16 +1834,16 @@ public final class RestContext extends BeanContext {
/**
* Returns the resource resolver associated with this context.
- *
+ *
* <p>
* The resource resolver is used for instantiating child resource classes.
- *
+ *
* <p>
* Unless overridden via the {@link RestResource#resourceResolver() @RestResource.resourceResolver()} annotation or the {@link RestContextBuilder#resourceResolver(Class)}
* method, this value is always inherited from parent to child.
* This allows a single resource resolver to be passed in to the top-level servlet to handle instantiation of all
* child resources.
- *
+ *
* @return The resource resolver associated with this context.
*/
protected RestResourceResolver getResourceResolver() {
@@ -1852,12 +1852,12 @@ public final class RestContext extends BeanContext {
/**
* Returns the variable resolver for this servlet.
- *
+ *
* <p>
* Variable resolvers are used to replace variables in property values.
* They can be nested arbitrarily deep.
* They can also return values that themselves contain other variables.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -1873,7 +1873,7 @@ public final class RestContext extends BeanContext {
* )
* <jk>public class</jk> MyRestResource <jk>extends</jk> RestServletDefault {
* </p>
- *
+ *
* <p>
* A typical usage pattern involves using variables inside the {@link HtmlDoc @HtmlDoc} annotation:
* <p class='bcode'>
@@ -1895,7 +1895,7 @@ public final class RestContext extends BeanContext {
* )
* <jk>public</jk> LoggerEntry getLogger(RestRequest req, <ja>@Path</ja> String name) <jk>throws</jk> Exception {
* </p>
- *
+ *
* <p>
* The following is the default list of supported variables:
* <ul>
@@ -1920,12 +1920,12 @@ public final class RestContext extends BeanContext {
* <li><code>$UE{uriPart}</code> - URL-Encoder. See {@link UrlEncodeVar}.
* <li><code>$W{widgetName}</code> - HTML widget variable. See {@link WidgetVar}.
* </ul>
- *
+ *
* <p>
* The list of variables can be extended using the {@link RestContextBuilder#vars(Class...)} method.
* For example, this is used to add support for the Args and Manifest-File variables in the microservice
* <code>Resource</code> class.
- *
+ *
* @return The var resolver in use by this resource.
*/
public VarResolver getVarResolver() {
@@ -1934,14 +1934,14 @@ public final class RestContext extends BeanContext {
/**
* Returns the config file associated with this servlet.
- *
+ *
* <p>
* The config file is identified via one of the following:
* <ul>
* <li>{@link RestResource#config() @RestResource.config()} annotation.
* <li>{@link RestContextBuilder#configFile(ConfigFile)} method.
* </ul>
- *
+ *
* @return The resolving config file associated with this servlet. Never <jk>null</jk>.
*/
public ConfigFile getConfigFile() {
@@ -1950,14 +1950,14 @@ public final class RestContext extends BeanContext {
/**
* Resolve a static resource file.
- *
+ *
* <p>
* The location of static resources are defined via one of the following:
* <ul>
* <li>{@link RestResource#staticFiles() @RestResource.staticFiles()} annotation.
* <li>{@link RestContextBuilder#staticFiles(Class, String)} method.
* </ul>
- *
+ *
* @param pathInfo The unencoded path info.
* @return The resource, or <jk>null</jk> if the resource could not be resolved.
* @throws IOException
@@ -1993,10 +1993,10 @@ public final class RestContext extends BeanContext {
/**
* 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.
- *
+ *
* <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
@@ -2006,7 +2006,7 @@ public final class RestContext extends BeanContext {
* <li><js>"MyResource_ja.txt"</js>
* <li><js>"MyResource.txt"</js>
* </ol>
- *
+ *
* @param name The resource name.
* @param locale Optional locale.
* @return An input stream of the resource, or <jk>null</jk> if the resource could not be found.
@@ -2019,7 +2019,7 @@ public final class RestContext extends BeanContext {
/**
* Same as {@link #getClasspathResource(String, Locale)}, but allows you to override the class used for looking
* up the classpath resource.
- *
+ *
* @param baseClass
* Overrides the default class to use for retrieving the classpath resource.
* <br>If <jk>null<jk>, uses the REST resource class.
@@ -2034,7 +2034,7 @@ public final class RestContext extends BeanContext {
/**
* Reads the input stream from {@link #getClasspathResource(String, Locale)} into a String.
- *
+ *
* @param name The resource name.
* @param locale Optional locale.
* @return The contents of the stream as a string, or <jk>null</jk> if the resource could not be found.
@@ -2047,7 +2047,7 @@ public final class RestContext extends BeanContext {
/**
* Same as {@link #getClasspathResourceAsString(String, Locale)}, but allows you to override the class used for looking
* up the classpath resource.
- *
+ *
* @param baseClass
* Overrides the default class to use for retrieving the classpath resource.
* <br>If <jk>null<jk>, uses the REST resource class.
@@ -2063,10 +2063,10 @@ public final class RestContext extends BeanContext {
/**
* Reads the input stream from {@link #getClasspathResource(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.
- *
+ *
* @param c The class type of the POJO to create.
* @param mediaType The media type of the data in the stream (e.g. <js>"text/json"</js>)
* @param name The resource name (e.g. "htdocs/styles.css").
@@ -2118,13 +2118,13 @@ public final class RestContext extends BeanContext {
/**
* Returns the path for this resource as defined by the {@link RestResource#path() @RestResource.path()} annotation or
* {@link RestContextBuilder#path(String)} method concatenated with those on all parent classes.
- *
+ *
* <p>
* If path is not specified, returns <js>"/"</js>.
- *
+ *
* <p>
* Path always starts with <js>"/"</js>.
- *
+ *
* @return The servlet path.
*/
public String getPath() {
@@ -2133,10 +2133,10 @@ public final class RestContext extends BeanContext {
/**
* The widgets used for resolving <js>"$W{...}"<js> variables.
- *
+ *
* <p>
* Defined by the {@link HtmlDoc#widgets() @HtmlDoc.widgets()} annotation or {@link RestContextBuilder#widgets(Class...)} method.
- *
+ *
* @return The var resolver widgets as a map with keys being the name returned by {@link Widget#getName()}.
*/
public Map<String,Widget> getWidgets() {
@@ -2145,14 +2145,14 @@ public final class RestContext extends BeanContext {
/**
* Returns the logger to use for this resource.
- *
+ *
* <p>
* The logger for a resource is defined via one of the following:
* <ul>
* <li>{@link RestResource#logger() @RestResource.logger()} annotation.
* <li>{@link RestContextBuilder#logger(Class)}/{@link RestContextBuilder#logger(RestLogger)} methods.
* </ul>
- *
+ *
* @return The logger to use for this resource. Never <jk>null</jk>.
*/
public RestLogger getLogger() {
@@ -2161,13 +2161,13 @@ public final class RestContext extends BeanContext {
/**
* Returns the resource bundle used by this resource.
- *
+ *
* <p>
* The resource bundle is defined via one of the following:
* <ul>
* <li>{@link RestResource#messages() @RestResource.messages()} annotation.
* </ul>
- *
+ *
* @return The resource bundle for this resource. Never <jk>null</jk>.
*/
public MessageBundle getMessages() {
@@ -2176,14 +2176,14 @@ public final class RestContext extends BeanContext {
/**
* Returns the REST information provider used by this resource.
- *
+ *
* <p>
* The information provider is defined via one of the following:
* <ul>
* <li>{@link RestResource#infoProvider() @RestResource.infoProvider()} annotation.
* <li>{@link RestContextBuilder#infoProvider(Class)}/{@link RestContextBuilder#infoProvider(RestInfoProvider)} methods.
* </ul>
- *
+ *
* @return The information provider for this resource. Never <jk>null</jk>.
*/
public RestInfoProvider getInfoProvider() {
@@ -2192,14 +2192,14 @@ public final class RestContext extends BeanContext {
/**
* Returns the REST call handler used by this resource.
- *
+ *
* <p>
* The call handler is defined via one of the following:
* <ul>
* <li>{@link RestResource#callHandler() @RestResource.callHandler()} annotation.
* <li>{@link RestContextBuilder#callHandler(Class)}/{@link RestContextBuilder#callHandler(RestCallHandler)} methods.
* </ul>
- *
+ *
* @return The call handler for this resource. Never <jk>null</jk>.
*/
protected RestCallHandler getCallHandler() {
@@ -2208,7 +2208,7 @@ public final class RestContext extends BeanContext {
/**
* Returns a map of HTTP method names to call routers.
- *
+ *
* @return A map with HTTP method names upper-cased as the keys, and call routers as the values.
*/
protected Map<String,RestCallRouter> getCallRouters() {
@@ -2217,11 +2217,11 @@ public final class RestContext extends BeanContext {
/**
* Returns the resource object.
- *
+ *
* <p>
* This is the instance of the class annotated with the {@link RestResource @RestResource} annotation, usually
* an instance of {@link RestServlet}.
- *
+ *
* @return The resource object. Never <jk>null</jk>.
*/
public Object getResource() {
@@ -2230,7 +2230,7 @@ public final class RestContext extends BeanContext {
/**
* Returns the resource object as a {@link RestServlet}.
- *
+ *
* @return
* The resource object cast to {@link RestServlet}, or <jk>null</jk> if the resource doesn't subclass from
* {@link RestServlet}
@@ -2241,7 +2241,7 @@ public final class RestContext extends BeanContext {
/**
* Throws a {@link RestException} if an exception occurred in the constructor of this object.
- *
+ *
* @throws RestException The initialization exception wrapped in a {@link RestException}.
*/
protected void checkForInitException() throws RestException {
@@ -2251,11 +2251,11 @@ public final class RestContext extends BeanContext {
/**
* 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()}
- *
+ *
* @return The parent resource context, or <jk>null</jk> if there is no parent context.
*/
public RestContext getParentContext() {
@@ -2264,7 +2264,7 @@ public final class RestContext extends BeanContext {
/**
* Returns the {@link BeanContext} object used for parsing path variables and header values.
- *
+ *
* @return The bean context used for parsing path variables and header values.
*/
public BeanContext getBeanContext() {
@@ -2273,20 +2273,20 @@ public final class RestContext extends BeanContext {
/**
* Returns the class-level properties associated with this servlet.
- *
+ *
* <p>
* Properties at the class level are defined via one of the following:
* <ul>
* <li>{@link RestResource#properties() @RestResource.properties()} annotation.
* <li>{@link RestContextBuilder#setProperty(String, Object)}/{@link RestContextBuilder#setProperties(Map)} methods.
* </ul>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>The returned {@code Map} is mutable. Therefore, subclasses are free to override
* or set additional initialization parameters in their {@code init()} method.
* </ul>
- *
+ *
* @return The resource properties as an {@link ObjectMap}.
*/
public ObjectMap getProperties() {
@@ -2295,14 +2295,14 @@ public final class RestContext extends BeanContext {
/**
* Returns the serializers registered with this resource.
- *
+ *
* <p>
* Serializers at the class level are defined via one of the following:
* <ul>
* <li>{@link RestResource#serializers() @RestResource.serializers()} annotation.
* <li>{@link RestContextBuilder#serializers(Class...)}/{@link RestContextBuilder#serializers(Object...)} methods.
* </ul>
- *
+ *
* @return The serializers registered with this resource.
*/
public SerializerGroup getSerializers() {
@@ -2311,14 +2311,14 @@ public final class RestContext extends BeanContext {
/**
* Returns the parsers registered with this resource.
- *
+ *
* <p>
* Parsers at the class level are defined via one of the following:
* <ul>
* <li>{@link RestResource#parsers() @RestResource.parsers()} annotation.
* <li>{@link RestContextBuilder#parsers(Class...)}/{@link RestContextBuilder#parsers(Object...)} methods.
* </ul>
- *
+ *
* @return The parsers registered with this resource.
*/
public ParserGroup getParsers() {
@@ -2327,7 +2327,7 @@ public final class RestContext extends BeanContext {
/**
* Returns the servlet init parameter returned by {@link ServletConfig#getInitParameter(String)}.
- *
+ *
* @param name The init parameter name.
* @return The servlet init parameter, or <jk>null</jk> if not found.
*/
@@ -2337,7 +2337,7 @@ public final class RestContext extends BeanContext {
/**
* Returns the child resources associated with this servlet.
- *
+ *
* @return
* An unmodifiable map of child resources.
* Keys are the {@link RestResource#path() @RestResource.path()} annotation defined on the child resource.
@@ -2348,7 +2348,7 @@ public final class RestContext extends BeanContext {
/**
* Returns the number of times this exception was thrown based on a hash of its stacktrace.
- *
+ *
* @param e The exception to check.
* @return
* The number of times this exception was thrown, or <code>0</code> if <code>stackTraceHashes</code>
@@ -2364,7 +2364,7 @@ public final class RestContext extends BeanContext {
/**
* TODO
- *
+ *
* @return TODO
*/
protected boolean isRenderResponseStackTraces() {
@@ -2373,7 +2373,7 @@ public final class RestContext extends BeanContext {
/**
* TODO
- *
+ *
* @return TODO
*/
protected boolean isAllowHeaderParams() {
@@ -2382,7 +2382,7 @@ public final class RestContext extends BeanContext {
/**
* TODO
- *
+ *
* @return TODO
*/
protected boolean isAllowBodyParam() {
@@ -2391,7 +2391,7 @@ public final class RestContext extends BeanContext {
/**
* TODO
- *
+ *
* @return TODO
*/
protected String getDefaultCharset() {
@@ -2400,7 +2400,7 @@ public final class RestContext extends BeanContext {
/**
* TODO
- *
+ *
* @return TODO
*/
protected long getMaxInput() {
@@ -2409,16 +2409,16 @@ public final class RestContext extends BeanContext {
/**
* Returns the name of the client version header name used by this resource.
- *
+ *
* <p>
* The client version header is the name of the HTTP header on requests that identify a client version.
- *
+ *
* <p>
* The client version header is defined via one of the following:
* <ul>
* <li>{@link RestResource#clientVersionHeader() @RestResource.clientVersion()} annotation.
* </ul>
- *
+ *
* @return The name of the client version header used by this resource. Never <jk>null</jk>.
*/
protected String getClientVersionHeader() {
@@ -2428,7 +2428,7 @@ public final class RestContext extends BeanContext {
/**
* 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, upper-cased.
* @return <jk>true</jk> if this resource allows the specified method to be overridden.
*/
@@ -2438,7 +2438,7 @@ public final class RestContext extends BeanContext {
/**
* Finds the {@link RestParam} instances to handle resolving objects on the calls to the specified Java method.
- *
+ *
* @param method The Java method being called.
* @param pathPattern The parsed URL path pattern.
* @param isPreOrPost Whether this is a <ja>@RestMethodPre</ja> or <ja>@RestMethodPost</ja>.
@@ -2642,7 +2642,7 @@ public final class RestContext extends BeanContext {
/**
* Returns the HTTP-part parser associated with this resource.
- *
+ *
* @return The HTTP-part parser associated with this resource. Never <jk>null</jk>.
*/
protected HttpPartParser getPartParser() {
@@ -2651,7 +2651,7 @@ public final class RestContext extends BeanContext {
/**
* Returns the HTTP-part serializer associated with this resource.
- *
+ *
* @return The HTTP-part serializer associated with this resource. Never <jk>null</jk>.
*/
protected HttpPartSerializer getPartSerializer() {
@@ -2660,10 +2660,10 @@ public final class RestContext extends BeanContext {
/**
* Returns the encoders associated with this resource.
- *
+ *
* <p>
* Encoders are used to provide various types of encoding such as <code>gzip</code> encoding.
- *
+ *
* <p>
* Encoders at the class level are defined via one of the following:
* <ul>
@@ -2671,7 +2671,7 @@ public final class RestContext extends BeanContext {
* <li>{@link RestContextBuilder#encoders(Class...)}/{@link RestContextBuilder#encoders(org.apache.juneau.encoders.Encoder...)}
* methods.
* </ul>
- *
+ *
* @return The encoders associated with this resource. Never <jk>null</jk>.
*/
protected EncoderGroup getEncoders() {
@@ -2680,12 +2680,12 @@ public final class RestContext extends BeanContext {
/**
* 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 RestContextBuilder#supportedAcceptTypes(boolean,MediaType...)}/{@link RestContextBuilder#supportedAcceptTypes(boolean,String...)}
* methods.
- *
+ *
* @return The supported <code>Accept</code> header values for this resource. Never <jk>null</jk>.
*/
protected List<MediaType> getSupportedAcceptTypes() {
@@ -2694,12 +2694,12 @@ public final class RestContext extends BeanContext {
/**
* 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 RestContextBuilder#supportedContentTypes(boolean,MediaType...)}/{@link RestContextBuilder#supportedContentTypes(boolean,String...)}
* methods.
- *
+ *
* @return The supported <code>Content-Type</code> header values for this resource. Never <jk>null</jk>.
*/
protected List<MediaType> getSupportedContentTypes() {
@@ -2708,17 +2708,17 @@ public final class RestContext extends BeanContext {
/**
* Returns the default request headers for this resource.
- *
+ *
* <p>
* These are headers automatically added to requests if not present.
- *
+ *
* <p>
* Default request headers are defined via one of the following:
* <ul>
* <li>{@link RestResource#defaultRequestHeaders() @RestResource.defaultRequestHeaders()} annotation.
* <li>{@link RestContextBuilder#defaultRequestHeader(String, Object)}/{@link RestContextBuilder#defaultRequestHeaders(String...)} methods.
* </ul>
- *
+ *
* @return The default request headers for this resource. Never <jk>null</jk>.
*/
protected Map<String,Object> getDefaultRequestHeaders() {
@@ -2727,10 +2727,10 @@ public final class RestContext extends BeanContext {
/**
* Returns the default response headers for this resource.
- *
+ *
* <p>
* These are headers automatically added to responses if not otherwise specified during the request.
- *
+ *
* <p>
* Default response headers are defined via one of the following:
* <ul>
@@ -2738,7 +2738,7 @@ public final class RestContext extends BeanContext {
* <li>{@link RestContextBuilder#defaultResponseHeader(String, Object)}/{@link RestContextBuilder#defaultResponseHeaders(String...)}
* methods.
* </ul>
- *
+ *
* @return The default response headers for this resource. Never <jk>null</jk>.
*/
public Map<String,Object> getDefaultResponseHeaders() {
@@ -2747,17 +2747,17 @@ public final class RestContext extends BeanContext {
/**
* Returns the converters associated with this resource at the class level.
- *
+ *
* <p>
* Converters are used to 'convert' POJOs from one form to another before being passed of to the response handlers.
- *
+ *
* <p>
* Converters at the class level are defined via one of the following:
* <ul>
* <li>{@link RestResource#converters() @RestResource.converters()} annotation.
* <li>{@link RestContextBuilder#converters(Class...)}/{@link RestContextBuilder#converters(RestConverter...)} methods.
* </ul>
- *
+ *
* @return The converters associated with this resource. Never <jk>null</jk>.
*/
protected RestConverter[] getConverters() {
@@ -2766,17 +2766,17 @@ public final class RestContext extends BeanContext {
/**
* Returns the guards associated with this resource at the class level.
- *
+ *
* <p>
* Guards are used to restrict access to resources.
- *
+ *
* <p>
* Guards at the class level are defined via one of the following:
* <ul>
* <li>{@link RestResource#guards() @RestResource.guards()} annotation.
* <li>{@link RestContextBuilder#guards(Class...)}/{@link RestContextBuilder#guards(RestGuard...)} methods.
* </ul>
- *
+ *
* @return The guards associated with this resource. Never <jk>null</jk>.
*/
protected RestGuard[] getGuards() {
@@ -2785,10 +2785,10 @@ public final class RestContext extends BeanContext {
/**
* Returns the response handlers associated with this resource.
- *
+ *
* <p>
* Response handlers are used to convert POJOs returned by REST Java methods into actual HTTP responses.
- *
+ *
* <p>
* Response handlers are defined via one of the following:
* <ul>
@@ -2796,7 +2796,7 @@ public final class RestContext extends BeanContext {
* <li>{@link RestContextBuilder#responseHandlers(Class...)}/{@link RestContextBuilder#responseHandlers(ResponseHandler...)}
* methods.
* </ul>
- *
+ *
* @return The response handlers associated with this resource. Never <jk>null</jk>.
*/
protected ResponseHandler[] getResponseHandlers() {
@@ -2805,11 +2805,11 @@ public final class RestContext extends BeanContext {
/**
* Returns the media type for the specified file name.
- *
+ *
* <p>
* The list of MIME-type mappings can be augmented through the {@link RestContextBuilder#mimeTypes(String...)} method.
* See that method for a description of predefined MIME-type mappings.
- *
+ *
* @param name The file name.
* @return The MIME-type, or <jk>null</jk> if it could not be determined.
*/
@@ -2819,17 +2819,17 @@ public final class RestContext extends BeanContext {
/**
* Returns <jk>true</jk> if the specified path refers to a static file.
- *
+ *
* <p>
* Static files are files pulled from the classpath and served up directly to the browser.
- *
+ *
* <p>
* Static files are defined via one of the following:
* <ul>
* <li>{@link RestResource#staticFiles() @RestResource.staticFiles()} annotation.
* <li>{@link RestContextBuilder#staticFiles(Class, String)} method.
* </ul>
- *
+ *
* @param p The URL path remainder after the servlet match.
* @return <jk>true</jk> if the specified path refers to a static file.
*/
@@ -2839,10 +2839,10 @@ public final class RestContext extends BeanContext {
/**
* Returns the REST Java methods defined in this resource.
- *
+ *
* <p>
* These are the methods annotated with the {@link RestMethod @RestMethod} annotation.
- *
+ *
* @return A map of Java method names to call method objects.
*/
protected Map<String,RestJavaMethod> getCallMethods() {
@@ -2870,7 +2870,7 @@ public final class RestContext extends BeanContext {
/**
* 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() {
@@ -2879,7 +2879,7 @@ public final class RestContext extends BeanContext {
/**
* Returns the context of the child resource associated with the specified path.
- *
+ *
* @param path The path of the child resource to resolve.
* @return The resolved context, or <jk>null</jk> if it could not be resolved.
*/
@@ -2889,7 +2889,7 @@ public final class RestContext extends BeanContext {
/**
* TODO
- *
+ *
* @return TODO
*/
protected String getContextPath() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java
index 87105a5..268a9db 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java
@@ -43,10 +43,10 @@ import org.apache.juneau.utils.*;
/**
* Defines the initial configuration of a <code>RestServlet</code> or <code>@RestResource</code> annotated object.
- *
+ *
* <p>
* An extension of the {@link ServletConfig} object used during servlet initialization.
- *
+ *
* <p>
* Provides access to the following initialized resources:
* <ul>
@@ -54,12 +54,12 @@ import org.apache.juneau.utils.*;
* <li>{@link #getProperties()} - The modifiable configuration properties for this resource.
* <li>{@link #getVarResolverBuilder()} - The variable resolver for this resource.
* </ul>
- *
+ *
* <p>
* Methods are provided for overriding or augmenting the information provided by the <ja>@RestResource</ja> annotation.
* In general, most information provided in the <ja>@RestResource</ja> annotation can be specified programmatically
* through calls on this object.
- *
+ *
* <p>
* To interact with this object, simply implement the following init method in your resource class:
* <p class='bcode'>
@@ -70,11 +70,11 @@ import org.apache.juneau.utils.*;
* <jk>super</jk>.init(builder); <jc>// Make sure this is the last line! (or just leave it out entirely)</jc>
* }
* </p>
- *
+ *
* <p>
* Note that this method is identical to {@link HttpServlet#init(ServletConfig)} except you get access to
* this object instead. Also, this method can throw any exception, not just a {@link ServletException}.
- *
+ *
* <p>
* The parent <code>init(RestServletConfig)</code> method will construct a read-only {@link RestContext} object
* that contains a snapshot of these settings. If you call <code><jk>super</jk>.init(RestServletConfig)</code> before
@@ -103,10 +103,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Constructor for top-level servlets when using dependency injection.
- *
+ *
* <p>
* Work-in-progress.
- *
+ *
* @param config
* The servlet config object we're extending.
* @param resourceClass
@@ -119,7 +119,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Constructor.
- *
+ *
* @param config The servlet config passed into the servlet by the servlet container.
* @param resource The class annotated with <ja>@RestResource</ja>.
* @throws ServletException Something bad happened.
@@ -320,14 +320,14 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Adds the specified {@link Var} classes to this config.
- *
+ *
* <p>
* These variables affect the variable resolver returned by {@link RestRequest#getVarResolverSession()} which is
* used to resolve string variables of the form <js>"$X{...}"</js>.
- *
+ *
* <p>
* See {@link RestContext#getVarResolver()} for a list of predefined variables.
- *
+ *
* @param vars The {@link Var} classes to add to this config.
* @return This object (for method chaining).
*/
@@ -338,11 +338,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* 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.
- *
+ *
* <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
@@ -351,7 +351,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p class='bcode'>
* config.addVarContextObject(<jsf>SESSION_config</jsf>, configFile);
* </p>
- *
+ *
* @param name The context object key (i.e. the name that the Var class looks for).
* @param object The context object.
* @return This object (for method chaining).
@@ -363,12 +363,12 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* 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.
* This method allows you to programmatically override it with your own custom config file.
- *
+ *
* @param configFile The new config file.
* @return This object (for method chaining).
*/
@@ -379,10 +379,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Sets a property on this resource.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link RestResource#properties() @RestResource.properties()} annotation.
- *
+ *
* @param key The property name.
* @param value The property value.
* @return This object (for method chaining).
@@ -394,13 +394,13 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Sets multiple properties on this resource.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link RestResource#properties() @RestResource.properties()} annotation.
- *
+ *
* <p>
* Values in the map are added to the existing properties and are overwritten if duplicates are found.
- *
+ *
* @param properties The new properties to add to this config.
* @return This object (for method chaining).
*/
@@ -420,7 +420,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Creates a new {@link PropertyStore} object initialized with the properties defined in this config.
- *
+ *
* @return A new property store.
*/
protected PropertyStoreBuilder createPropertyStore() {
@@ -434,20 +434,20 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* 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.
- *
+ *
* <p>
* The config file can be programmatically overridden by adding the following method to your resource:
* <p class='bcode'>
* <jk>public</jk> ConfigFile createConfigFile(ServletConfig servletConfig) <jk>throws</jk> ServletException;
* </p>
- *
+ *
* <p>
* If a config file is not set up, then an empty config file will be returned that is not backed by any file.
- *
+ *
* @return The external config file for this resource. Never <jk>null</jk>.
*/
public ConfigFile getConfigFile() {
@@ -456,20 +456,20 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Returns the configuration properties for this resource.
- *
+ *
* <p>
* The configuration properties are determined via the {@link RestResource#properties() @RestResource.properties()} annotation on the resource.
- *
+ *
* <p>
* The configuration properties can be augmented programmatically by adding the following method to your resource:
* <p class='bcode'>
* <jk>public</jk> ObjectMap createProperties(ServletConfig servletConfig) <jk>throws</jk> ServletException;
* </p>
- *
+ *
* <p>
* These properties can be modified during servlet initialization.
* However, any modifications made after {@link RestServlet#init(ServletConfig)} has been called will have no effect.
- *
+ *
* @return The configuration properties for this resource. Never <jk>null</jk>.
*/
public ObjectMap getProperties() {
@@ -478,7 +478,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Creates the variable resolver for this resource.
- *
+ *
* <p>
* The variable resolver returned by this method can resolve the following variables:
* <ul>
@@ -488,11 +488,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <li>{@link IfVar}
* <li>{@link SwitchVar}
* </ul>
- *
+ *
* <p>
* 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>.
*/
public VarResolverBuilder getVarResolverBuilder() {
@@ -506,7 +506,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Allow body URL parameter.
- *
+ *
* <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.
@@ -529,7 +529,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Allowed method parameters.
- *
+ *
* <p>
* When specified, the HTTP method can be overridden by passing in a <js>"method"</js> URL parameter on a regular
* GET request.
@@ -552,7 +552,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Allow header URL parameters.
- *
+ *
* <p>
* When enabled, headers such as <js>"Accept"</js> and <js>"Content-Type"</js> to be passed in as URL query
* parameters.
@@ -574,7 +574,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: REST call handler.
- *
+ *
* <p>
* This class handles the basic lifecycle of an HTTP REST call.
* <br>Subclasses can be used to customize how these HTTP calls are handled.
@@ -595,7 +595,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: REST call handler.
- *
+ *
* <p>
* Same as {@link #callHandler(Class)} except input is a pre-constructed instance.
*
@@ -615,10 +615,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Children.
- *
+ *
* <p>
* 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.
@@ -655,7 +655,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Children.
- *
+ *
* <p>
* Shortcut for adding a single child to this resource.
*
@@ -717,10 +717,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Client version header.
- *
+ *
* <p>
* Specifies the name of the header used to denote the client version on HTTP requests.
- *
+ *
* <p>
* The client version is used to support backwards compatibility for breaking REST interface changes.
* <br>Used in conjunction with {@link RestMethod#clientVersion() @RestMethod.clientVersion()} annotation.
@@ -741,10 +741,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Resource context path.
- *
+ *
* <p>
* Overrides the context path value for this resource and any child resources.
- *
+ *
* <p>
* This setting is useful if you want to use <js>"context:/child/path"</js> URLs in child resource POJOs but
* the context path is not actually specified on the servlet container.
@@ -767,12 +767,12 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Class-level response 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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_converters}
@@ -787,10 +787,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Response converters.
- *
+ *
* <p>
* Same as {@link #converters(Class...)} except input is pre-constructed instances.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_converters}
@@ -808,7 +808,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
*
* <p>
* The default character encoding for the request and response if not specified on the request.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_defaultCharset}
@@ -825,10 +825,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Default request headers.
- *
+ *
* <p>
* Adds class-level default HTTP request headers to this resource.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_defaultRequestHeaders}
@@ -850,10 +850,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Default request headers.
- *
+ *
* <p>
* Same as {@link #defaultRequestHeaders(String...)} but adds a single header name/value pair.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_defaultRequestHeaders}
@@ -869,10 +869,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Default response headers.
- *
+ *
* <p>
* Specifies default values for response headers.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_defaultResponseHeaders}
@@ -894,10 +894,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Default response headers.
- *
+ *
* <p>
* Same as {@link #defaultResponseHeaders(String...)} but adds a single header name/value pair.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_defaultResponseHeaders}
@@ -913,10 +913,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Compression encoders.
- *
+ *
* <p>
* These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_encoders}
@@ -931,10 +931,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Compression encoders.
- *
+ *
* <p>
* Same as {@link #encoders(Class...)} except input a pre-constructed instances.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_encoders}
@@ -949,15 +949,15 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Class-level guards.
- *
+ *
* <p>
* 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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_guards}
@@ -972,10 +972,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Class-level guards.
- *
+ *
* <p>
* Same as {@link #guards(Class...)} except input is pre-constructed instances.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_guards}
@@ -990,10 +990,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: REST info provider.
- *
+ *
* <p>
* Class used to retrieve title/description/swagger information about a resource.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_infoProvider}
@@ -1010,10 +1010,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: REST info provider.
- *
+ *
* <p>
* Same as {@link #infoProvider(Class)} except input is a pre-constructed instance.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_infoProvider}
@@ -1033,7 +1033,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
*
* <p>
* Specifies the logger to use for logging.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_logger}
@@ -1054,7 +1054,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
*
* <p>
* Same as {@link #logger(Class)} except input is a pre-constructed instance.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_logger}
@@ -1072,11 +1072,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: The maximum allowed input size (in bytes) on HTTP requests.
- *
+ *
* <p>
* Useful for alleviating DoS attacks by throwing an exception when too much input is received instead of resulting
* in out-of-memory errors which could affect system stability.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_maxInput}
@@ -1093,10 +1093,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Messages.
- *
+ *
* <p>
* Identifies the location of the resource bundle for this class.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_messages}
@@ -1111,7 +1111,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Messages.
- *
+ *
* <p>
* Same as {@link #messages(MessageBundleLocation...)} except allows you to pass in the base class and bundle
* path separately.
@@ -1133,7 +1133,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Messages.
- *
+ *
* <p>
* Same as {@link #messages(Class,String)} except assumes the base class is the resource class itself.
*
@@ -1151,7 +1151,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: MIME types.
- *
+ *
* <p>
* Defines MIME-type file type mappings.
*
@@ -1169,12 +1169,12 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Java method parameter resolvers.
- *
+ *
* <p>
* By default, the Juneau framework will automatically Java method parameters of various types (e.g.
* <code>RestRequest</code>, <code>Accept</code>, <code>Reader</code>).
* This annotation allows you to provide your own resolvers for your own class types that you want resolved.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_paramResolvers}
@@ -1190,10 +1190,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Java method parameter resolvers.
- *
+ *
* <p>
* Same as {@link #paramResolvers(Class...)} except input is pre-constructed instances.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_paramResolvers}
@@ -1211,7 +1211,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
*
* <p>
* Specifies the parser listener class to use for listening to non-fatal parsing errors.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_listener}
@@ -1226,7 +1226,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Parsers.
- *
+ *
* <p>
* Adds class-level parsers to this resource.
*
@@ -1244,7 +1244,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Parsers.
- *
+ *
* <p>
* Same as {@link #parsers(Class...)} except allows you to overwrite the previous value.
*
@@ -1264,7 +1264,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Parsers.
- *
+ *
* <p>
* Same as {@link #parsers(Class...)} except input is pre-constructed instances.
*
@@ -1286,7 +1286,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: HTTP part parser.
- *
+ *
* <p>
* Specifies the {@link HttpPartParser} to use for parsing headers, query/form parameters, and URI parts.
*
@@ -1306,10 +1306,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: HTTP part parser.
- *
+ *
* <p>
* Same as {@link #partParser(Class)} except input is a pre-constructed instance.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_partParser}
@@ -1326,7 +1326,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: HTTP part serializer.
- *
+ *
* <p>
* Specifies the {@link HttpPartSerializer} to use for serializing headers, query/form parameters, and URI parts.
*
@@ -1346,10 +1346,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: HTTP part serializer.
- *
+ *
* <p>
* Same as {@link #partSerializer(Class)} except input is a pre-constructed instance.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_partSerializer}
@@ -1366,7 +1366,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Resource path.
- *
+ *
* <p>
* Identifies the URL subpath relative to the parent resource.
*
@@ -1387,7 +1387,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Render response stack traces in responses.
- *
+ *
* <p>
* Render stack traces in HTTP response bodies when errors occur.
*
@@ -1407,7 +1407,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Render response stack traces in responses.
- *
+ *
* <p>
* Shortcut for calling <code>renderResponseStackTraces(<jk>true</jk>)<code>.
*
@@ -1450,7 +1450,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
*
* <p>
* Same as {@link #resourceResolver(Class)} except input is a pre-constructed instance.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_resourceResolver}
@@ -1467,7 +1467,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Response handlers.
- *
+ *
* <p>
* 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.
@@ -1486,10 +1486,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Response handlers.
- *
+ *
* <p>
* Same as {@link #responseHandlers(Class...)} except input is pre-constructed instances.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_responseHandlers}
@@ -1507,7 +1507,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
*
* <p>
* Specifies the serializer listener class to use for listening to non-fatal serialization errors.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_listener}
@@ -1522,7 +1522,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Serializers.
- *
+ *
* <p>
* Adds class-level serializers to this resource.
*
@@ -1540,7 +1540,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Serializers.
- *
+ *
* <p>
* Same as {@link #serializers(Class...)} except allows you to overwrite the previous value.
*
@@ -1560,7 +1560,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Serializers.
- *
+ *
* <p>
* Same as {@link #serializers(Class...)} except input is pre-constructed instances.
*
@@ -1582,7 +1582,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Static file response headers.
- *
+ *
* <p>
* Used to customize the headers on responses returned for statically-served files.
*
@@ -1604,7 +1604,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Static file response headers.
- *
+ *
* <p>
* Same as {@link #staticFileResponseHeaders(boolean, Map)} with append=<jk>true</jk> except headers are strings
* composed of key/value pairs.
@@ -1630,7 +1630,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Static file response headers.
- *
+ *
* <p>
* Same as {@link #staticFileResponseHeaders(String...)} except header is broken into name/value pair.
*
@@ -1649,7 +1649,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Static file mappings.
- *
+ *
* <p>
* Used to define paths and locations of statically-served files such as images or HTML documents.
*
@@ -1667,7 +1667,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Static file mappings.
- *
+ *
* <p>
* Same as {@link #staticFiles(StaticFileMapping...)} except input is in the form of a mapping string.
*
@@ -1692,7 +1692,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Static file mappings.
- *
+ *
* <p>
* Same as {@link #staticFiles(String)} except overrides the base class for retrieving the resource.
*
@@ -1720,7 +1720,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Static file mappings.
- *
+ *
* <p>
* Same as {@link #staticFiles(String)} except path and location are already split values.
*
@@ -1743,7 +1743,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Static file mappings.
- *
+ *
* <p>
* Same as {@link #staticFiles(String,String)} except overrides the base class for retrieving the resource.
*
@@ -1769,7 +1769,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Supported accept media types.
- *
+ *
* <p>
* Overrides the media types inferred from the serializers that identify what media types can be produced by the resource.
*
@@ -1789,10 +1789,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Supported accept media types.
- *
+ *
* <p>
* Same as {@link #supportedAcceptTypes(boolean, String...)} except input is {@link MediaType} instances.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_supportedAcceptTypes}
@@ -1809,10 +1809,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Supported content media types.
- *
+ *
* <p>
* Overrides the media types inferred from the parsers that identify what media types can be consumed by the resource.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_supportedContentTypes}
@@ -1829,10 +1829,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Supported content media types.
- *
+ *
* <p>
* Same as {@link #supportedContentTypes(boolean, String...)} except input is {@link MediaType} instances.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_supportedContentTypes}
@@ -1849,7 +1849,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Use classpath resource caching.
- *
+ *
* <p>
* When enabled, resources retrieved via {@link RestContext#getClasspathResource(String, Locale)} (and related
* methods) will be cached in memory to speed subsequent lookups.
@@ -1870,11 +1870,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: Use stack trace hashes.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_useStackTraceHashes}
@@ -1891,7 +1891,7 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
/**
* Configuration property: HTML Widgets.
- *
+ *
* <p>
* Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly
* generate arbitrary replacement text.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestConverter.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestConverter.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestConverter.java
index 3803b2e..78e12a9 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestConverter.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestConverter.java
@@ -19,18 +19,18 @@ 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.
- *
+ *
* <p>
* Converters are associated with REST methods through the {@link RestMethod#converters() @RestMethod.converters()} annotation.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> RequestEchoResource <jk>extends</jk> RestServlet {
- *
+ *
* <jc>// GET request handler</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/*"</js>, converters={Queryable.<jk>class</jk>,Traversable.<jk>class</jk>})
* <jk>public</jk> HttpServletRequest doGet(RestRequest req) {
@@ -39,17 +39,17 @@ import org.apache.juneau.serializer.*;
* }
* }
* </p>
- *
+ *
* <p>
* Converters can also be associated at the servlet level using the {@link RestResource#converters() @RestResource.converters()} annotation.
* Applying converters at the resource level is equivalent to applying converters to each resource method individually.
- *
+ *
* <h6 class='topic'>How to implement</h6>
- *
+ *
* 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>
* Subclasses must implement one of the following constructors:
* <ul>
@@ -59,9 +59,9 @@ import org.apache.juneau.serializer.*;
*
* <p>
* Subclasses can also be defined as inner classes of the resource class.
- *
+ *
* <h6 class='topic'>Predefined converters</h6>
- *
+ *
* The following converters are available by default.
* <ul class='spaced-list'>
* <li>
@@ -76,7 +76,7 @@ public interface RestConverter {
/**
* Performs post-call conversion on the specified response object.
- *
+ *
* @param req The servlet request.
* @param res The response object set by the REST method through the {@link RestResponse#setOutput(Object)} method.
* @param cm
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestException.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestException.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestException.java
index ad942f7..bdf453b 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestException.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestException.java
@@ -22,7 +22,7 @@ import org.apache.juneau.rest.annotation.*;
/**
* 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.
@@ -36,7 +36,7 @@ public class RestException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param status The HTTP status code.
* @param msg The status message.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -48,7 +48,7 @@ public class RestException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param status The HTTP status code.
* @param cause The root exception.
*/
@@ -60,7 +60,7 @@ public class RestException extends FormattedRuntimeException {
/**
* Sets the inner cause for this exception.
- *
+ *
* @param cause The inner cause.
* @return This object (for method chaining).
*/
@@ -72,14 +72,14 @@ public class RestException extends FormattedRuntimeException {
/**
* Returns the root cause of this exception.
- *
+ *
* <p>
* The root cause is the first exception in the init-cause parent chain that's not one of the following:
* <ul>
* <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() {
@@ -94,11 +94,11 @@ public class RestException extends FormattedRuntimeException {
/**
* Returns all error messages from all errors in this stack.
- *
+ *
* <p>
* Typically useful if you want to render all the error messages in the stack, but don't want to render all the
* stack traces too.
- *
+ *
* @param scrubForXssVulnerabilities
* If <jk>true</jk>, replaces <js>'<'</js>, <js>'>'</js>, and <js>'&'</js> characters with spaces.
* @return All error messages from all errors in this stack.
@@ -144,7 +144,7 @@ public class RestException extends FormattedRuntimeException {
/**
* Returns the number of times this exception occurred on this servlet.
- *
+ *
* @return
* The occurrence number if {@link RestResource#useStackTraceHashes() @RestResource.useStackTraceHashes()} is enabled, or <code>0</code> otherwise.
*/
@@ -154,7 +154,7 @@ public class RestException extends FormattedRuntimeException {
/**
* Returns the HTTP status code.
- *
+ *
* @return The HTTP status code.
*/
public int getStatus() {
[18/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Date.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Date.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Date.java
index 3b5be3e..6334c58 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Date.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Date.java
@@ -14,30 +14,30 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Date</l> HTTP request/response header.
- *
+ *
* <p>
* The date and time that the message was sent (in "HTTP-date" format as defined by RFC 7231).
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Date: Tue, 15 Nov 1994 08:12:31 GMT
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Date general-header field represents the date and time at which the message was originated, having the same
* semantics as orig-date in RFC 822.
* The field value is an HTTP-date, as described in section 3.3.1; it MUST be sent in RFC 1123 [8]-date format.
* <p class='bcode'>
* Date = "Date" ":" HTTP-date
* </p>
- *
+ *
* <p>
* An example is...
* <p class='bcode'>
* Date: Tue, 15 Nov 1994 08:12:31 GMT
* </p>
- *
+ *
* <p>
* Origin servers MUST include a Date header field in all responses, except in these cases:
* <ol>
@@ -49,19 +49,19 @@ package org.apache.juneau.http;
* responses MUST NOT include a Date header field.
* In this case, the rules in section 14.18.1 MUST be followed.
* </ol>
- *
+ *
* <p>
* A received message that does not have a Date header field MUST be assigned one by the recipient if the message will
* be cached by that recipient or gatewayed via a protocol which requires a Date.
* An HTTP implementation without a clock MUST NOT cache responses without revalidating them on every use.
* An HTTP cache, especially a shared cache, SHOULD use a mechanism, such as NTP, to synchronize its clock with a
* reliable external standard.
- *
+ *
* <p>
* Clients SHOULD only send a Date header field in messages that include an entity-body, as in the case of the PUT and
* POST requests, and even then it is optional.
* A client without a clock MUST NOT send a Date header field in a request.
- *
+ *
* <p>
* The HTTP-date sent in a Date header SHOULD NOT represent a date and time subsequent to the generation of the message.
* It SHOULD represent the best available approximation of the date and time of message generation, unless the
@@ -69,7 +69,7 @@ package org.apache.juneau.http;
* In theory, the date ought to represent the moment just before the entity is generated.
* In practice, the date can be generated at any time during the message origination without affecting its semantic
* value.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -83,7 +83,7 @@ public final class Date extends HeaderDate {
/**
* Returns a parsed <code>Date</code> header.
- *
+ *
* @param value The <code>Date</code> header string.
* @return The parsed <code>Date</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ETag.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ETag.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ETag.java
index 23a41df..2c050c7 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ETag.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ETag.java
@@ -14,25 +14,25 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>ETag</l> HTTP response header.
- *
+ *
* <p>
* An identifier for a specific version of a resource, often a message digest.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* ETag: "737060cd8c284d8af7ad3082f209582d"
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The ETag response-header field provides the current value of the entity tag for the requested variant.
* The headers used with entity tags are described in sections 14.24, 14.26 and 14.44.
* The entity tag MAY be used for comparison with other entities from the same resource (see section 13.3.3).
- *
+ *
* <p class='bcode'>
* ETag = "ETag" ":" entity-tag
* </p>
- *
+ *
* <p>
* Examples:
* <p class='bcode'>
@@ -40,7 +40,7 @@ package org.apache.juneau.http;
* ETag: W/"xyzzy"
* ETag: ""
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -54,7 +54,7 @@ public final class ETag extends HeaderString {
/**
* Returns a parsed <code>ETag</code> header.
- *
+ *
* @param value The <code>ETag</code> header string.
* @return The parsed <code>ETag</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/EntityValidator.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/EntityValidator.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/EntityValidator.java
index e4a3439..72980a4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/EntityValidator.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/EntityValidator.java
@@ -14,14 +14,14 @@ package org.apache.juneau.http;
/**
* Represents a validator value.
- *
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* ETag: "123456789" – A strong ETag validator
* ETag: W/"123456789" – A weak ETag validator
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -38,7 +38,7 @@ public class EntityValidator {
/**
* Constructor.
- *
+ *
* @param value The validator string value.
*/
protected EntityValidator(String value) {
@@ -53,7 +53,7 @@ public class EntityValidator {
/**
* Returns the validator value stripped of quotes and weak tag.
- *
+ *
* @return The validator value.
*/
public String asString() {
@@ -62,7 +62,7 @@ public class EntityValidator {
/**
* Returns <jk>true</jk> if the weak flag is present in the value.
- *
+ *
* @return <jk>true</jk> if the weak flag is present in the value.
*/
public boolean isWeak() {
@@ -71,7 +71,7 @@ public class EntityValidator {
/**
* Returns <jk>true</jk> if the validator string value is <code>*</code>.
- *
+ *
* @return <jk>true</jk> if the validator string value is <code>*</code>.
*/
public boolean isAny() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Expect.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Expect.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Expect.java
index 6fa204b..4976a6f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Expect.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Expect.java
@@ -14,17 +14,17 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Expect</l> HTTP request header.
- *
+ *
* <p>
* Indicates that particular server behaviors are required by the client.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Expect: 100-continue
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Expect request-header field is used to indicate that particular server behaviors are required by the client.
* <p class='bcode'>
* Expect = "Expect" ":" 1#expectation
@@ -33,33 +33,33 @@ package org.apache.juneau.http;
* *expect-params ]
* expect-params = ";" token [ "=" ( token | quoted-string ) ]
* </p>
- *
+ *
* <p>
* A server that does not understand or is unable to comply with any of the expectation values in the Expect field of a
* request MUST respond with appropriate error status.
* The server MUST respond with a 417 (Expectation Failed) status if any of the expectations cannot be met or, if there
* are other problems with the request, some other 4xx status.
- *
+ *
* <p>
* This header field is defined with extensible syntax to allow for future extensions.
* If a server receives a request containing an Expect field that includes an expectation-extension that it does not
* support, it MUST respond with a 417 (Expectation Failed) status.
- *
+ *
* <p>
* Comparison of expectation values is case-insensitive for unquoted tokens (including the 100-continue token), and is
* case-sensitive for quoted-string expectation-extensions.
- *
+ *
* <p>
* The Expect mechanism is hop-by-hop: that is, an HTTP/1.1 proxy MUST return a 417 (Expectation Failed) status if it
* receives a request with an expectation that it cannot meet.
* However, the Expect request-header itself is end-to-end; it MUST be forwarded if the request is forwarded.
- *
+ *
* <p>
* Many older HTTP/1.0 and HTTP/1.1 applications do not understand the Expect header.
- *
+ *
* <p>
* See section 8.2.3 for the use of the 100 (continue) status.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -73,7 +73,7 @@ public final class Expect extends HeaderString {
/**
* Returns a parsed <code>Expect</code> header.
- *
+ *
* @param value The <code>Expect</code> header string.
* @return The parsed <code>Expect</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Expires.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Expires.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Expires.java
index cce726d..8116f5e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Expires.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Expires.java
@@ -14,63 +14,63 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Expires</l> HTTP response header.
- *
+ *
* <p>
* Gives the date/time after which the response is considered stale (in "HTTP-date" format as defined by RFC 7231).
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Expires: Thu, 01 Dec 1994 16:00:00 GMT
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Expires entity-header field gives the date/time after which the response is considered stale.
* A stale cache entry may not normally be returned by a cache (either a proxy cache or a user agent cache) unless it is
* first validated with the origin server
* (or with an intermediate cache that has a fresh copy of the entity).
* See section 13.2 for further discussion of the expiration model.
- *
+ *
* <p>
* The presence of an Expires field does not imply that the original resource will change or cease to exist at, before,
* or after that time.
- *
+ *
* <p>
* The format is an absolute date and time as defined by HTTP-date in section 3.3.1; it MUST be in RFC 1123 date format:
- *
+ *
* <p class='bcode'>
* Expires = "Expires" ":" HTTP-date
* </p>
- *
+ *
* <p>
* An example of its use is...
* <p class='bcode'>
* Expires: Thu, 01 Dec 1994 16:00:00 GMT
* </p>
- *
+ *
* <p>
* Note: if a response includes a Cache-Control field with the max-age directive (see section 14.9.3), that directive
* overrides the Expires field.
- *
+ *
* <p>
* HTTP/1.1 clients and caches MUST treat other invalid date formats, especially including the value "0", as in the past
* (i.e., "already expired").
- *
+ *
* <p>
* To mark a response as "already expired," an origin server sends an Expires date that is equal to the Date header
* value.
* (See the rules for expiration calculations in section 13.2.4.)
- *
+ *
* <p>
* To mark a response as "never expires," an origin server sends an Expires date approximately one year from the time
* the response is sent.
* HTTP/1.1 servers SHOULD NOT send Expires dates more than one year in the future.
- *
+ *
* <p>
* The presence of an Expires header field with a date value of some time in the future on a response that otherwise
* would by default be non-cacheable indicates that the response is cacheable, unless indicated otherwise by a
* Cache-Control header field (section 14.9).
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -84,7 +84,7 @@ public final class Expires extends HeaderDate {
/**
* Returns a parsed <code>Expires</code> header.
- *
+ *
* @param value The <code>Expires</code> header string.
* @return The parsed <code>Expires</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/From.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/From.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/From.java
index 7a3706f..d261e0e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/From.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/From.java
@@ -14,31 +14,31 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>From</l> HTTP request header.
- *
+ *
* <p>
* The email address of the user making the request.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* From: user@example.com
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The From request-header field, if given, SHOULD contain an Internet e-mail address for the human user who controls
* the requesting user agent.
* The address SHOULD be machine-usable, as defined by "mailbox" in RFC 822 [9] as updated by RFC 1123 [8]:
- *
+ *
* <p class='bcode'>
* From = "From" ":" mailbox
* </p>
- *
+ *
* <p>
* An example is:
* <p class='bcode'>
* From: webmaster@w3.org
* </p>
- *
+ *
* <p>
* This header field MAY be used for logging purposes and as a means for identifying the source of invalid or unwanted
* requests.
@@ -47,17 +47,17 @@ package org.apache.juneau.http;
* responsibility for the method performed.
* In particular, robot agents SHOULD include this header so that the person responsible for running the robot can be
* contacted if problems occur on the receiving end.
- *
+ *
* <p>
* The Internet e-mail address in this field MAY be separate from the Internet host which issued the request.
* For example, when a request is passed through a proxy the original issuer's address SHOULD be used.
- *
+ *
* <p>
* The client SHOULD NOT send the From header field without the user's approval, as it might conflict with the user's
* privacy interests or their site's security policy.
* It is strongly recommended that the user be able to disable, enable, and modify the value of this field at any time
* prior to a request.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -71,7 +71,7 @@ public final class From extends HeaderString {
/**
* Returns a parsed <code>From</code> header.
- *
+ *
* @param value The <code>From</code> header string.
* @return The parsed <code>From</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderDate.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderDate.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderDate.java
index 1a1ad66..d668bc2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderDate.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderDate.java
@@ -16,13 +16,13 @@ import org.apache.juneau.internal.*;
/**
* Category of headers that consist of a single HTTP-date.
- *
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* If-Modified-Since: Sat, 29 Oct 1994 19:43:31 GMT
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -39,7 +39,7 @@ public class HeaderDate {
/**
* Constructor.
- *
+ *
* @param raw The raw header value.
*/
protected HeaderDate(String raw) {
@@ -49,7 +49,7 @@ public class HeaderDate {
/**
* Returns this header value as a {@link java.util.Date}.
- *
+ *
* @return This header value as a {@link java.util.Date}, or <jk>null</jk> if the header could not be parsed.
*/
public java.util.Date asDate() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
index d1b1cc4..91642da 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
@@ -14,13 +14,13 @@ package org.apache.juneau.http;
/**
* Category of headers that consist of a single entity validator value.
- *
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* ETag: "xyzzy"
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -36,7 +36,7 @@ public class HeaderEntityValidator {
/**
* Constructor.
- *
+ *
* @param value The raw header value.
*/
protected HeaderEntityValidator(String value) {
@@ -45,7 +45,7 @@ public class HeaderEntityValidator {
/**
* Returns this header value as a {@link EntityValidator} object.
- *
+ *
* @return this header value as a {@link EntityValidator} object.
*/
public EntityValidator asValidator() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
index b8675c1..05cc7b1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
@@ -16,7 +16,7 @@ import org.apache.juneau.internal.*;
/**
* Category of headers that consist of a comma-delimited list of entity validator values.
- *
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
@@ -24,7 +24,7 @@ import org.apache.juneau.internal.*;
* If-Match: "xyzzy", "r2d2xxxx", "c3piozzzz"
* If-Match: *
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -40,7 +40,7 @@ public class HeaderEntityValidatorArray {
/**
* Constructor.
- *
+ *
* @param value The raw header value.
*/
protected HeaderEntityValidatorArray(String value) {
@@ -53,7 +53,7 @@ public class HeaderEntityValidatorArray {
/**
* Returns this header value as an array of {@link EntityValidator} objects.
- *
+ *
* @return this header value as an array of {@link EntityValidator} objects.
*/
public EntityValidator[] asValidators() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEnum.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEnum.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEnum.java
index 56a202f..0704f6e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEnum.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderEnum.java
@@ -14,13 +14,13 @@ package org.apache.juneau.http;
/**
* Category of headers that consist of a single enum value.
- *
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept-Ranges: bytes
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -29,7 +29,7 @@ package org.apache.juneau.http;
* <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>> {
@@ -39,7 +39,7 @@ public class HeaderEnum<E extends Enum<E>> {
/**
* Constructor.
- *
+ *
* @param value The raw header value.
* @param enumClass The enum class.
* @param def The default enum value if the value could not be parsed.
@@ -57,7 +57,7 @@ public class HeaderEnum<E extends Enum<E>> {
/**
* Returns <jk>true</jk> if the specified value is the same using {@link String#equalsIgnoreCase(String)}.
- *
+ *
* @return <jk>true</jk> if the specified value is the same.
*/
public E asEnum() {
@@ -66,10 +66,10 @@ public class HeaderEnum<E extends Enum<E>> {
/**
* Returns this header as a simple string value.
- *
+ *
* <p>
* Functionally equivalent to calling {@link #toString()}.
- *
+ *
* @return This header as a simple string.
*/
public String asString() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderInteger.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderInteger.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderInteger.java
index 2e58b32..5b1cf97 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderInteger.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderInteger.java
@@ -14,13 +14,13 @@ package org.apache.juneau.http;
/**
* Category of headers that consist of a single integer value.
- *
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Age: 300
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -36,7 +36,7 @@ public class HeaderInteger {
/**
* Constructor.
- *
+ *
* @param value The raw header value.
*/
protected HeaderInteger(String value) {
@@ -54,10 +54,10 @@ public class HeaderInteger {
/**
* Returns this header as a simple string value.
- *
+ *
* <p>
* Functionally equivalent to calling {@link #toString()}.
- *
+ *
* @return This header as a simple string.
*/
public int asInt() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderRangeArray.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
index 8567ca4..6e3f9c0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
@@ -18,13 +18,13 @@ import org.apache.juneau.internal.*;
/**
* Category of headers that consist of simple comma-delimited lists of strings with q-values.
- *
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept-Encoding: compress;q=0.5, gzip;q=1.0
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -41,7 +41,7 @@ public class HeaderRangeArray {
/**
* Constructor.
- *
+ *
* @param value The raw header value.
*/
protected HeaderRangeArray(String value) {
@@ -51,7 +51,7 @@ public class HeaderRangeArray {
/**
* Given a list of type values, returns the best match for this header.
- *
+ *
* @param types The 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.
*/
@@ -69,10 +69,10 @@ public class HeaderRangeArray {
/**
* Returns the list of the types ranges that make up this header.
- *
+ *
* <p>
* The types ranges in the list are sorted by their q-value in descending order.
- *
+ *
* @return An unmodifiable list of type ranges.
*/
public List<StringRange> asSimpleRanges() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderString.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderString.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderString.java
index 659300c..8efa2e1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderString.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderString.java
@@ -16,13 +16,13 @@ import org.apache.juneau.internal.*;
/**
* Category of headers that consist of a single string value.
- *
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Accept-Ranges: bytes
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -38,7 +38,7 @@ public class HeaderString {
/**
* Constructor.
- *
+ *
* @param value The raw header value.
*/
protected HeaderString(String value) {
@@ -47,7 +47,7 @@ public class HeaderString {
/**
* Returns <jk>true</jk> if the specified value is the same using {@link String#equalsIgnoreCase(String)}.
- *
+ *
* @param compare The value to compare against.
* @return <jk>true</jk> if the specified value is the same.
*/
@@ -57,7 +57,7 @@ public class HeaderString {
/**
* Returns <jk>true</jk> if the specified value is the same using {@link String#equals(Object)}.
- *
+ *
* @param compare The value to compare against.
* @return <jk>true</jk> if the specified value is the same.
*/
@@ -67,10 +67,10 @@ public class HeaderString {
/**
* Returns this header as a simple string value.
- *
+ *
* <p>
* Functionally equivalent to calling {@link #toString()}.
- *
+ *
* @return This header as a simple string.
*/
public String asString() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderStringArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderStringArray.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderStringArray.java
index ca07d3c..99fb5bf 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderStringArray.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderStringArray.java
@@ -16,13 +16,13 @@ import org.apache.juneau.internal.*;
/**
* Category of headers that consist of a comma-delimited list of string values.
- *
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Allow: GET, PUT
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -38,7 +38,7 @@ public class HeaderStringArray {
/**
* Constructor.
- *
+ *
* @param value The raw header value.
*/
protected HeaderStringArray(String value) {
@@ -47,10 +47,10 @@ public class HeaderStringArray {
/**
* Returns this header as a simple string value.
- *
+ *
* <p>
* Functionally equivalent to calling {@link #toString()}.
- *
+ *
* @return This header as a simple string.
*/
public String asString() {
@@ -59,7 +59,7 @@ public class HeaderStringArray {
/**
* Returns <jk>true</jk> if this header contains the specified value.
- *
+ *
* @param val The value to check for.
* @return <jk>true</jk> if this header contains the specified value.
*/
@@ -73,7 +73,7 @@ public class HeaderStringArray {
/**
* Returns <jk>true</jk> if this header contains the specified value using {@link String#equalsIgnoreCase(String)}.
- *
+ *
* @param val The value to check for.
* @return <jk>true</jk> if this header contains the specified value.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderUri.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderUri.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderUri.java
index feae45d..106fa27 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderUri.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HeaderUri.java
@@ -18,13 +18,13 @@ import org.apache.juneau.internal.*;
/**
* Category of headers that consist of a single URL value.
- *
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Location: http://www.w3.org/pub/WWW/People.html
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -40,7 +40,7 @@ public class HeaderUri{
/**
* Constructor.
- *
+ *
* @param value The raw header value.
*/
protected HeaderUri(String value) {
@@ -49,7 +49,7 @@ public class HeaderUri{
/**
* Returns this header as a {@link URI}.
- *
+ *
* @return This header as a {@link URI}.
*/
public URI asURI() {
@@ -58,10 +58,10 @@ public class HeaderUri{
/**
* Returns this header as a simple string value.
- *
+ *
* <p>
* Functionally equivalent to calling {@link #toString()}.
- *
+ *
* @return This header as a simple string.
*/
public String asString() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Host.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Host.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Host.java
index cc548da..f3e058e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Host.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Host.java
@@ -14,31 +14,31 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Host</l> HTTP request header.
- *
+ *
* <p>
* The domain name of the server (for virtual hosting), and the TCP port number on which the server is listening.
* The port number may be omitted if the port is the standard port for the service requested.
* Mandatory since HTTP/1.1.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Host: en.wikipedia.org:8080
* Host: en.wikipedia.org
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Host request-header field specifies the Internet host and port number of the resource being requested, as
* obtained from the original URI given by the user or referring resource (generally an HTTP URL, as described in
* section 3.2.2).
* The Host field value MUST represent the naming authority of the origin server or gateway given by the original URL.
* This allows the origin server or gateway to differentiate between internally-ambiguous URLs, such as the root "/" URL
* of a server for multiple host names on a single IP address.
- *
+ *
* <p class='bcode'>
* Host = "Host" ":" host [ ":" port ] ; Section 3.2.2
* </p>
- *
+ *
* <p>
* A "host" without any trailing port information implies the default port for the service requested (e.g., "80" for an
* HTTP URL).
@@ -47,7 +47,7 @@ package org.apache.juneau.http;
* GET /pub/WWW/ HTTP/1.1
* Host: www.w3.org
* </p>
- *
+ *
* <p>
* A client MUST include a Host header field in all HTTP/1.1 request messages.
* If the requested URI does not include an Internet host name for the service being requested, then the Host header
@@ -56,10 +56,10 @@ package org.apache.juneau.http;
* identifies the service being requested by the proxy.
* All Internet-based HTTP/1.1 servers MUST respond with a 400 (Bad Request) status code to any HTTP/1.1 request
* message which lacks a Host header field.
- *
+ *
* <p>
* See sections 5.2 and 19.6.1.1 for other requirements relating to Host.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -73,7 +73,7 @@ public final class Host extends HeaderString {
/**
* Returns a parsed <code>Host</code> header.
- *
+ *
* @param value The <code>Host</code> header string.
* @return The parsed <code>Host</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpMethod.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpMethod.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpMethod.java
index 285a698..1fc3335 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpMethod.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpMethod.java
@@ -16,7 +16,7 @@ import java.util.*;
/**
* Represents valid HTTP 1.1 method names per the RFC 2616 spec.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -69,10 +69,10 @@ public enum HttpMethod {
/**
* Returns the enum for the specified key.
- *
+ *
* <p>
* Case is ignored.
- *
+ *
* @param key The HTTP method name.
* @return The HttpMethod enum, or {@link #OTHER} if it's not a standard method name.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpMethodName.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpMethodName.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpMethodName.java
index 73f64df..6eff6fc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpMethodName.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/HttpMethodName.java
@@ -14,7 +14,7 @@ package org.apache.juneau.http;
/**
* Represents valid HTTP 1.1 method name static strings per the RFC 2616 spec.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='extlink'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfMatch.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfMatch.java
index a2d5b02..a466dda 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfMatch.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfMatch.java
@@ -14,19 +14,19 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>If-Match</l> HTTP request header.
- *
+ *
* <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.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* If-Match: "737060cd8c284d8af7ad3082f209582d"
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The If-Match request-header field is used with a method to make it conditional.
* A client that has one or more entities previously obtained from the resource can verify that one of those entities
* is current by including a list of their associated entity tags in the If-Match header field.
@@ -35,41 +35,41 @@ package org.apache.juneau.http;
* overhead.
* It is also used, on updating requests, to prevent inadvertent modification of the wrong version of a resource.
* As a special case, the value "*" matches any current entity of the resource.
- *
+ *
* <p class='bcode'>
* If-Match = "If-Match" ":" ( "*" | 1#entity-tag )
* </p>
- *
+ *
* <p>
* If any of the entity tags match the entity tag of the entity that would have been returned in the response to a
* similar GET request (without the If-Match header) on that resource, or if "*" is given and any current entity exists
* for that resource, then the server MAY perform the requested method as if the If-Match header field did not exist.
- *
+ *
* <p>
* A server MUST use the strong comparison function (see section 13.3.3) to compare the entity tags in If-Match.
- *
+ *
* <p>
* If none of the entity tags match, or if "*" is given and no current entity exists, the server MUST NOT perform the
* requested method, and MUST return a 412 (Precondition Failed) response.
* This behavior is most useful when the client wants to prevent an updating method, such as PUT, from modifying a
* resource that has changed since the client last retrieved it.
- *
+ *
* <p>
* If the request would, without the If-Match header field, result in anything other than a 2xx or 412 status, then the
* If-Match header MUST be ignored.
- *
+ *
* <p>
* The meaning of "If-Match: *" is that the method SHOULD be performed if the representation selected by the origin
* server (or by a cache, possibly using the Vary mechanism, see section 14.44) exists, and MUST NOT be performed if the
* representation does not exist.
- *
+ *
* <p>
* A request intended to update a resource (e.g., a PUT) MAY include an If-Match header field to signal that the request
* method MUST NOT be applied if the entity corresponding to the If-Match value (a single entity tag) is no longer a
* representation of that resource.
* This allows the user to indicate that they do not wish the request to be successful if the resource has been changed
* without their knowledge.
- *
+ *
* <p>
* Examples:
* <p class='bcode'>
@@ -77,11 +77,11 @@ package org.apache.juneau.http;
* If-Match: "xyzzy", "r2d2xxxx", "c3piozzzz"
* If-Match: *
* </p>
- *
+ *
* <p>
* The result of a request having both an If-Match header field and either an If-None-Match or an If-Modified-Since
* header fields is undefined by this specification.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -95,7 +95,7 @@ public final class IfMatch extends HeaderEntityValidatorArray {
/**
* Returns a parsed <code>If-Match</code> header.
- *
+ *
* @param value The <code>If-Match</code> header string.
* @return The parsed <code>If-Match</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfModifiedSince.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfModifiedSince.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfModifiedSince.java
index 5deef37..8261ea2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfModifiedSince.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfModifiedSince.java
@@ -14,31 +14,31 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>If-Modified-Since</l> HTTP request header.
- *
+ *
* <p>
* Allows a 304 Not Modified to be returned if content is unchanged.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* If-Modified-Since: Sat, 29 Oct 1994 19:43:31 GMT
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The If-Modified-Since request-header field is used with a method to make it conditional:
* if the requested variant has not been modified since the time specified in this field, an entity will not be returned
* from the server; instead, a 304 (not modified) response will be returned without any message-body.
- *
+ *
* <p class='bcode'>
* If-Modified-Since = "If-Modified-Since" ":" HTTP-date
* </p>
- *
+ *
* <p>
* An example of the field is:
* <p class='bcode'>
* If-Modified-Since: Sat, 29 Oct 1994 19:43:31 GMT
* </p>
- *
+ *
* <p>
* A GET method with an If-Modified-Since header and no Range header requests that the identified entity be transferred
* only if it has been modified since the date given by the If-Modified-Since header.
@@ -52,23 +52,23 @@ package org.apache.juneau.http;
* <li>If the variant has not been modified since a valid If-Modified-Since date, the server SHOULD return a 304
* (Not Modified) response.
* </ol>
- *
+ *
* <p>
* The purpose of this feature is to allow efficient updates of cached information with a minimum amount of transaction
* overhead.
- *
+ *
* <p>
* Note: The Range request-header field modifies the meaning of If-Modified-Since; see section 14.35 for full details.
- *
+ *
* <p>
* Note: If-Modified-Since times are interpreted by the server, whose clock might not be synchronized with the client.
- *
+ *
* <p>
* Note: When handling an If-Modified-Since header field, some servers will use an exact date comparison function,
* rather than a less-than function, for deciding whether to send a 304 (Not Modified) response.
* To get best results when sending an If-Modified-Since header field for cache validation, clients are
* advised to use the exact date string received in a previous Last-Modified header field whenever possible.
- *
+ *
* <p>
* Note: If a client uses an arbitrary date in the If-Modified-Since header instead of a date taken from the
* Last-Modified header for the same request, the client should be aware of the fact that this date is interpreted in
@@ -81,7 +81,7 @@ package org.apache.juneau.http;
* Corrections for different time bases between client and server are at best approximate due to network latency.
* The result of a request having both an If-Modified-Since header field and either an If-Match or an
* If-Unmodified-Since header fields is undefined by this specification.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -95,7 +95,7 @@ public final class IfModifiedSince extends HeaderDate {
/**
* Returns a parsed <code>If-Modified-Since</code> header.
- *
+ *
* @param value The <code>If-Modified-Since</code> header string.
* @return The parsed <code>If-Modified-Since</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfNoneMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfNoneMatch.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfNoneMatch.java
index 81c00fa..8ee1c06 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfNoneMatch.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfNoneMatch.java
@@ -14,17 +14,17 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>If-None-Match</l> HTTP request header.
- *
+ *
* <p>
* Allows a 304 Not Modified to be returned if content is unchanged.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* If-None-Match: "737060cd8c284d8af7ad3082f209582d"
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The If-None-Match request-header field is used with a method to make it conditional.
* A client that has one or more entities previously obtained from the resource can verify that none of those entities
* is current by including a list of their associated entity tags in the If-None-Match header field.
@@ -32,14 +32,14 @@ package org.apache.juneau.http;
* overhead.
* It is also used to prevent a method (e.g. PUT) from inadvertently modifying an existing resource when the client
* believes that the resource does not exist.
- *
+ *
* <p>
* As a special case, the value "*" matches any current entity of the resource.
- *
+ *
* <p class='bcode'>
* If-None-Match = "If-None-Match" ":" ( "*" | 1#entity-tag )
* </p>
- *
+ *
* <p>
* If any of the entity tags match the entity tag of the entity that would have been returned in the response to a
* similar GET request (without the If-None-Match header) on that resource, or if "*" is given
@@ -49,28 +49,28 @@ package org.apache.juneau.http;
* Instead, if the request method was GET or HEAD, the server SHOULD respond with a 304 (Not Modified) response,
* including the cache- related header fields (particularly ETag) of one of the entities that matched.
* For all other request methods, the server MUST respond with a status of 412 (Precondition Failed).
- *
+ *
* <p>
* See section 13.3.3 for rules on how to determine if two entities tags match.
* The weak comparison function can only be used with GET or HEAD requests.
- *
+ *
* <p>
* If none of the entity tags match, then the server MAY perform the requested method as if the If-None-Match header
* field did not exist, but MUST also ignore any If-Modified-Since header field(s) in the request.
* That is, if no entity tags match, then the server MUST NOT return a 304 (Not Modified) response.
- *
+ *
* <p>
* If the request would, without the If-None-Match header field, result in anything other than a 2xx or 304 status,
* then the If-None-Match header MUST be ignored.
* (See section 13.3.4 for a discussion of server behavior when both If-Modified-Since and If-None-Match appear in the
* same request.)
- *
+ *
* <p>
* The meaning of "If-None-Match: *" is that the method MUST NOT be performed if the representation selected by the
* origin server (or by a cache, possibly using the Vary mechanism, see section 14.44) exists, and SHOULD be performed
* if the representation does not exist.
* This feature is intended to be useful in preventing races between PUT operations.
- *
+ *
* <p>
* Examples:
* <p class='bcode'>
@@ -80,11 +80,11 @@ package org.apache.juneau.http;
* If-None-Match: W/"xyzzy", W/"r2d2xxxx", W/"c3piozzzz"
* If-None-Match: *
* </p>
- *
+ *
* <p>
* The result of a request having both an If-None-Match header field and either an If-Match or an If-Unmodified-Since
* header fields is undefined by this specification.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -98,7 +98,7 @@ public final class IfNoneMatch extends HeaderEntityValidatorArray {
/**
* Returns a parsed <code>If-None-Match</code> header.
- *
+ *
* @param value The <code>If-None-Match</code> header string.
* @return The parsed <code>If-None-Match</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfRange.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfRange.java
index b941b2b..c5bf5be 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfRange.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfRange.java
@@ -18,23 +18,23 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>If-Range</l> HTTP request header.
- *
+ *
* <p>
* If the entity is unchanged, send me the part(s) that I am missing; otherwise, send me the entire new entity.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* If-Range: "737060cd8c284d8af7ad3082f209582d"
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* If a client has a partial copy of an entity in its cache, and wishes to have an up-to-date copy of the entire entity
* in its cache, it could use the Range request-header with a conditional GET (using either or both of
* If-Unmodified-Since and If-Match.)
* However, if the condition fails because the entity has been modified, the client would then have to make a second
* request to obtain the entire current entity-body.
- *
+ *
* <p>
* The If-Range header allows a client to "short-circuit" the second request.
* Informally, its meaning is `if the entity is unchanged, send me the part(s) that I am missing; otherwise, send me
@@ -42,7 +42,7 @@ import org.apache.juneau.internal.*;
* <p class='bcode'>
* If-Range = "If-Range" ":" ( entity-tag | HTTP-date )
* </p>
- *
+ *
* <p>
* If the client has no entity tag for an entity, but does have a Last- Modified date, it MAY use that date in an
* If-Range header.
@@ -50,12 +50,12 @@ import org.apache.juneau.internal.*;
* characters.)
* The If-Range header SHOULD only be used together with a Range header, and MUST be ignored if the request does not
* include a Range header, or if the server does not support the sub-range operation.
- *
+ *
* <p>
* If the entity tag given in the If-Range header matches the current entity tag for the entity, then the server SHOULD
* provide the specified sub-range of the entity using a 206 (Partial content) response.
* If the entity tag does not match, then the server SHOULD return the entire entity using a 200 (OK) response.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -69,7 +69,7 @@ public final class IfRange extends HeaderString {
/**
* Returns a parsed <code>If-Range</code> header.
- *
+ *
* @param value The <code>If-Range</code> header string.
* @return The parsed <code>If-Range</code> header, or <jk>null</jk> if the string was null.
*/
@@ -85,7 +85,7 @@ public final class IfRange extends HeaderString {
/**
* Returns this header value as a {@link java.util.Date} object.
- *
+ *
* @return This header value as a {@link java.util.Date} object, or <jk>null</jk> if the value is not a date.
*/
public java.util.Date asDate() {
@@ -97,7 +97,7 @@ public final class IfRange extends HeaderString {
/**
* Returns this header value as an {@link EntityValidator} object.
- *
+ *
* @return
* This header value as a {@link EntityValidator} object, or <jk>null</jk> if the value is not an entity
* validator.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
index 5d1f74f..b6c2428 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
@@ -14,46 +14,46 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>If-Unmodified-Since</l> HTTP request header.
- *
+ *
* <p>
* Only send the response if the entity has not been modified since a specific time.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* If-Unmodified-Since: Sat, 29 Oct 1994 19:43:31 GMT
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The If-Unmodified-Since request-header field is used with a method to make it conditional.
* If the requested resource has not been modified since the time specified in this field, the server SHOULD perform the
* requested operation as if the If-Unmodified-Since header were not present.
- *
+ *
* <p>
* If the requested variant has been modified since the specified time, the server MUST NOT perform the requested
* operation, and MUST return a 412 (Precondition Failed).
- *
+ *
* <p class='bcode'>
* If-Unmodified-Since = "If-Unmodified-Since" ":" HTTP-date
* </p>
- *
+ *
* <p>
* An example of the field is:
* <p class='bcode'>
* If-Unmodified-Since: Sat, 29 Oct 1994 19:43:31 GMT
* </p>
- *
+ *
* <p>
* If the request normally (i.e., without the If-Unmodified-Since header) would result in anything other than a 2xx or
* 412 status, the If-Unmodified-Since header SHOULD be ignored.
- *
+ *
* <p>
* If the specified date is invalid, the header is ignored.
- *
+ *
* <p>
* The result of a request having both an If-Unmodified-Since header field and either an If-None-Match or an
* If-Modified-Since header fields is undefined by this specification.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -67,7 +67,7 @@ public final class IfUnmodifiedSince extends HeaderDate {
/**
* Returns a parsed <code>If-Unmodified-Since</code> header.
- *
+ *
* @param value The <code>If-Unmodified-Since</code> header string.
* @return The parsed <code>If-Unmodified-Since</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/LastModified.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/LastModified.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/LastModified.java
index 94d543a..796e078 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/LastModified.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/LastModified.java
@@ -14,30 +14,30 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Last-Modified</l> HTTP response header.
- *
+ *
* <p>
* The last modified date for the requested object (in "HTTP-date" format as defined by RFC 7231).
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Last-Modified: Tue, 15 Nov 1994 12:45:26 GMT
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Last-Modified entity-header field indicates the date and time at which the origin server believes the variant was
* last modified.
- *
+ *
* <p class='bcode'>
* Last-Modified = "Last-Modified" ":" HTTP-date
* </p>
- *
+ *
* <p>
* An example of its use is...
* <p class='bcode'>
* Last-Modified: Tue, 15 Nov 1994 12:45:26 GMT
* </p>
- *
+ *
* <p>
* The exact meaning of this header field depends on the implementation of the origin server and the nature of the
* original resource.
@@ -46,21 +46,21 @@ package org.apache.juneau.http;
* component parts.
* For database gateways, it may be the last-update time stamp of the record.
* For virtual objects, it may be the last time the internal state changed.
- *
+ *
* <p>
* An origin server MUST NOT send a Last-Modified date which is later than the server's time of message origination.
* In such cases, where the resource's last modification would indicate some time in the future, the server MUST replace
* that date with the message origination date.
- *
+ *
* <p>
* An origin server SHOULD obtain the Last-Modified value of the entity as close as possible to the time that it
* generates the Date value of its response.
* This allows a recipient to make an accurate assessment of the entity's modification time, especially if the entity
* changes near the time that the response is generated.
- *
+ *
* <p>
* HTTP/1.1 servers SHOULD send Last-Modified whenever feasible.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -74,7 +74,7 @@ public final class LastModified extends HeaderDate {
/**
* Returns a parsed <code>Last-Modified</code> header.
- *
+ *
* @param value The <code>Last-Modified</code> header string.
* @return The parsed <code>Last-Modified</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Location.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Location.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Location.java
index 8734aaf..33b46a9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Location.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Location.java
@@ -14,39 +14,39 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Location</l> HTTP response header.
- *
+ *
* <p>
* Used in redirection, or when a new resource has been created.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Location: http://www.w3.org/pub/WWW/People.html
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Location response-header field is used to redirect the recipient to a location other than the Request-URI for
* completion of the request or identification of a new resource.
* For 201 (Created) responses, the Location is that of the new resource which was created by the request.
* For 3xx responses, the location SHOULD indicate the server's preferred URI for automatic redirection to the resource.
* The field value consists of a single absolute URI.
- *
+ *
* <p class='bcode'>
* Location = "Location" ":" absoluteURI
* </p>
- *
+ *
* <p>
* An example is:
* <p class='bcode'>
* Location: http://www.w3.org/pub/WWW/People.html
* </p>
- *
+ *
* <p>
* Note: The Content-Location header field (section 14.14) differs from Location in that the Content-Location identifies
* the original location of the entity enclosed in the request.
* It is therefore possible for a response to contain header fields for both Location and Content-Location.
* Also see section 13.10 for cache requirements of some methods.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -60,7 +60,7 @@ public final class Location extends HeaderUri {
/**
* Returns a parsed <code>Location</code> header.
- *
+ *
* @param value The <code>Location</code> header string.
* @return The parsed <code>Location</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MaxForwards.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MaxForwards.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MaxForwards.java
index fa8dc07..3fd3ecb 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MaxForwards.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MaxForwards.java
@@ -14,30 +14,30 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Max-Forwards</l> HTTP request header.
- *
+ *
* <p>
* Limit the number of times the message can be forwarded through proxies or gateways.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Max-Forwards: 10
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Max-Forwards request-header field provides a mechanism with the TRACE (section 9.8) and OPTIONS (section 9.2)
* methods to limit the number of proxies or gateways that can forward the request to the next inbound server.
* This can be useful when the client is attempting to trace a request chain which appears to be failing or looping in
* mid-chain.
- *
+ *
* <p class='bcode'>
* Max-Forwards = "Max-Forwards" ":" 1*DIGIT
* </p>
- *
+ *
* <p>
* The Max-Forwards value is a decimal integer indicating the remaining number of times this request message may be
* forwarded.
- *
+ *
* <p>
* Each proxy or gateway recipient of a TRACE or OPTIONS request containing a Max-Forwards header field MUST check and
* update its value prior to forwarding the request.
@@ -45,11 +45,11 @@ package org.apache.juneau.http;
* recipient.
* If the received Max-Forwards value is greater than zero, then the forwarded message MUST contain an updated
* Max-Forwards field with a value decremented by one (1).
- *
+ *
* <p>
* The Max-Forwards header field MAY be ignored for all other methods defined by this specification and for any
* extension methods for which it is not explicitly referred to as part of that method definition.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -63,7 +63,7 @@ public final class MaxForwards extends HeaderInteger {
/**
* Returns a parsed <code>Max-Forwards</code> header.
- *
+ *
* @param value The <code>Max-Forwards</code> header string.
* @return The parsed <code>Max-Forwards</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MediaType.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MediaType.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MediaType.java
index c4a6c92..8e1ca2a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MediaType.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MediaType.java
@@ -25,7 +25,7 @@ import org.apache.juneau.json.*;
/**
* Describes a single media type used in content negotiation between an HTTP client and server, as described in
* Section 14.1 and 14.7 of RFC2616 (the HTTP/1.1 specification).
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -74,7 +74,7 @@ public class MediaType implements Comparable<MediaType> {
* Returns the media type for the specified string.
* The same media type strings always return the same objects so that these objects
* can be compared for equality using '=='.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>
@@ -85,7 +85,7 @@ public class MediaType implements Comparable<MediaType> {
* <li>
* Anything including and following the <js>';'</js> character is ignored (e.g. <js>";charset=X"</js>).
* </ul>
- *
+ *
* @param s
* The media type string.
* Will be lowercased.
@@ -108,7 +108,7 @@ public class MediaType implements Comparable<MediaType> {
/**
* Same as {@link #forString(String)} but allows you to construct an array of <code>MediaTypes</code> from an
* array of strings.
- *
+ *
* @param s
* The media type strings.
* @return
@@ -179,7 +179,7 @@ public class MediaType implements Comparable<MediaType> {
/**
* Returns the <js>'type'</js> fragment of the <js>'type/subType'</js> string.
- *
+ *
* @return The media type.
*/
public final String getType() {
@@ -188,7 +188,7 @@ public class MediaType implements Comparable<MediaType> {
/**
* Returns the <js>'subType'</js> fragment of the <js>'type/subType'</js> string.
- *
+ *
* @return The media subtype.
*/
public final String getSubType() {
@@ -197,7 +197,7 @@ public class MediaType implements Comparable<MediaType> {
/**
* Returns <jk>true</jk> if the subtype contains the specified <js>'+'</js> delimited subtype value.
- *
+ *
* @param st
* The subtype string.
* Case is ignored.
@@ -213,11 +213,11 @@ public class MediaType implements Comparable<MediaType> {
/**
* Returns the subtypes broken down by fragments delimited by <js>"'"</js>.
- *
+ *
* <P>
* For example, the media type <js>"text/foo+bar"</js> will return a list of
* <code>[<js>'foo'</js>,<js>'bar'</js>]</code>
- *
+ *
* @return An unmodifiable list of subtype fragments. Never <jk>null</jk>.
*/
public final List<String> getSubTypes() {
@@ -226,7 +226,7 @@ public class MediaType implements Comparable<MediaType> {
/**
* Returns <jk>true</jk> if this media type contains the <js>'*'</js> meta character.
- *
+ *
* @return <jk>true</jk> if this media type contains the <js>'*'</js> meta character.
*/
public final boolean isMeta() {
@@ -235,11 +235,11 @@ public class MediaType implements Comparable<MediaType> {
/**
* Returns a match metric against the specified media type where a larger number represents a better match.
- *
+ *
* <p>
* This media type can contain <js>'*'</js> metacharacters.
* <br>The comparison media type must not.
- *
+ *
* <ul>
* <li>Exact matches (e.g. <js>"text/json"<js>/</js>"text/json"</js>) should match
* better than meta-character matches (e.g. <js>"text/*"<js>/</js>"text/json"</js>)
@@ -254,7 +254,7 @@ public class MediaType implements Comparable<MediaType> {
* </ul>
* More token matches should result in a higher match number.
* </ul>
- *
+ *
* The formula is as follows for <code>type/subTypes</code>:
* <ul>
* <li>An exact match is <code>100,000</code>.
@@ -270,7 +270,7 @@ public class MediaType implements Comparable<MediaType> {
* <li><code>10</code> for a subtype entry meta match (e.g. <js>"*"</js>/<js>"json"</js> or <js>"json+*"</js>/<js>"json+foo"</js>)
* </ul>
* </ul>
- *
+ *
* @param o The media type to compare with.
* @param allowExtraSubTypes If <jk>true</jk>,
* @return <jk>true</jk> if the media types match.
@@ -323,11 +323,11 @@ public class MediaType implements Comparable<MediaType> {
/**
* Returns the additional parameters on this media type.
- *
+ *
* <p>
* For example, given the media type string <js>"text/html;level=1"</js>, will return a map
* with the single entry <code>{level:[<js>'1'</js>]}</code>.
- *
+ *
* @return The map of additional parameters, or an empty map if there are no parameters.
*/
public final Map<String,Set<String>> getParameters() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MediaTypeRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MediaTypeRange.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MediaTypeRange.java
index 18e6971..98bf611 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MediaTypeRange.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/MediaTypeRange.java
@@ -21,7 +21,7 @@ import org.apache.juneau.internal.*;
/**
* Describes a single type used in content negotiation between an HTTP client and server, as described in
* Section 14.1 and 14.7 of RFC2616 (the HTTP/1.1 specification).
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -42,18 +42,18 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
/**
* Parses an <code>Accept</code> header value into an array of media ranges.
- *
+ *
* <p>
* The returned media ranges are sorted such that the most acceptable media is available at ordinal position
* <js>'0'</js>, and the least acceptable at position n-1.
- *
+ *
* <p>
* The syntax expected to be found in the referenced <code>value</code> complies with the syntax described in
* RFC2616, Section 14.1, as described below:
* <p class='bcode'>
* Accept = "Accept" ":"
* #( media-range [ accept-params ] )
- *
+ *
* media-range = ( "*\/*"
* | ( type "/" "*" )
* | ( type "/" subtype )
@@ -61,7 +61,7 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
* accept-params = ";" "q" "=" qvalue *( accept-extension )
* accept-extension = ";" token [ "=" ( token | quoted-string ) ]
* </p>
- *
+ *
* @param value
* The value to parse.
* If <jk>null</jk> or empty, returns a single <code>MediaTypeRange</code> is returned that represents all types.
@@ -144,14 +144,14 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
/**
* Returns the media type enclosed by this media range.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <ul>
* <li><js>"text/html"</js>
* <li><js>"text/*"</js>
* <li><js>"*\/*"</js>
* </ul>
- *
+ *
* @return The media type of this media range, lowercased, never <jk>null</jk>.
*/
public MediaType getMediaType() {
@@ -160,14 +160,14 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
/**
* Returns the <js>'q'</js> (quality) value for this type, as described in Section 3.9 of RFC2616.
- *
+ *
* <p>
* The quality value is a float between <code>0.0</code> (unacceptable) and <code>1.0</code> (most acceptable).
- *
+ *
* <p>
* If 'q' value doesn't make sense for the context (e.g. this range was extracted from a <js>"content-*"</js>
* header, as opposed to <js>"accept-*"</js> header, its value will always be <js>"1"</js>.
- *
+ *
* @return The 'q' value for this type, never <jk>null</jk>.
*/
public Float getQValue() {
@@ -176,10 +176,10 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
/**
* Returns the optional set of custom extensions defined for this type.
- *
+ *
* <p>
* Values are lowercase and never <jk>null</jk>.
- *
+ *
* @return The optional list of extensions, never <jk>null</jk>.
*/
public Map<String,Set<String>> getExtensions() {
@@ -188,10 +188,10 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
/**
* Provides a string representation of this media range, suitable for use as an <code>Accept</code> header value.
- *
+ *
* <p>
* The literal text generated will be all lowercase.
- *
+ *
* @return A media range suitable for use as an Accept header value, never <code>null</code>.
*/
@Override /* Object */
@@ -222,7 +222,7 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
/**
* Returns <jk>true</jk> if the specified object is also a <code>MediaType</code>, and has the same qValue, type,
* parameters, and extensions.
- *
+ *
* @return <jk>true</jk> if object is equivalent.
*/
@Override /* Object */
@@ -242,7 +242,7 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
/**
* Returns a hash based on this instance's <code>media-type</code>.
- *
+ *
* @return A hash based on this instance's <code>media-type</code>.
*/
@Override /* Object */
@@ -252,7 +252,7 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
/**
* Compares two MediaRanges for equality.
- *
+ *
* <p>
* The values are first compared according to <code>qValue</code> values.
* Should those values be equal, the <code>type</code> is then lexicographically compared (case-insensitive) in
@@ -261,7 +261,7 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
* promoted over the 'wildcard' subtype.
* <code>MediaRanges</code> with the same types but with extensions are promoted over those same types with no
* extensions.
- *
+ *
* @param o The range to compare to. Never <jk>null</jk>.
*/
@Override /* Comparable */
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Pragma.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Pragma.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Pragma.java
index e95b1cc..bc1c682 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Pragma.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Pragma.java
@@ -14,28 +14,28 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Pragma</l> HTTP request/response header.
- *
+ *
* <p>
* Implementation-specific fields that may have various effects anywhere along the request-response chain.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Pragma: no-cache
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Pragma general-header field is used to include implementation- specific directives that might apply to any
* recipient along the request/response chain.
* All pragma directives specify optional behavior from the viewpoint of the protocol; however, some systems MAY
* require that behavior be consistent with the directives.
- *
+ *
* <p class='bcode'>
* Pragma = "Pragma" ":" 1#pragma-directive
* pragma-directive = "no-cache" | extension-pragma
* extension-pragma = token [ "=" ( token | quoted-string ) ]
* </p>
- *
+ *
* <p>
* When the no-cache directive is present in a request message, an application SHOULD forward the request toward the
* origin server even if it has a cached copy of what is being requested.
@@ -43,21 +43,21 @@ package org.apache.juneau.http;
* for backward compatibility with HTTP/1.0.
* Clients SHOULD include both header fields when a no-cache request is sent to a server not known to be HTTP/1.1
* compliant.
- *
+ *
* <p>
* Pragma directives MUST be passed through by a proxy or gateway application, regardless of their significance to that
* application, since the directives might be applicable to all recipients along the request/response chain.
* It is not possible to specify a pragma for a specific recipient; however, any pragma directive not relevant to a
* recipient SHOULD be ignored by that recipient.
- *
+ *
* <p>
* HTTP/1.1 caches SHOULD treat "Pragma: no-cache" as if the client had sent "Cache-Control: no-cache".
* No new Pragma directives will be defined in HTTP.
- *
+ *
* <p>
* Note: because the meaning of "Pragma: no-cache as a response header field is not actually specified, it does not
* provide a reliable replacement for "Cache-Control: no-cache" in a response.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -71,7 +71,7 @@ public final class Pragma extends HeaderString {
/**
* Returns a parsed <code>Pragma</code> header.
- *
+ *
* @param value The <code>Pragma</code> header string.
* @return The parsed <code>Pragma</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java
index fc5da1c..91c28fa 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java
@@ -14,33 +14,33 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l> Proxy-Authenticate</l> HTTP response header.
- *
+ *
* <p>
* Request authentication to access the proxy.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Proxy-Authenticate: Basic
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Proxy-Authenticate response-header field MUST be included as part of a 407 (Proxy Authentication Required)
* response.
* The field value consists of a challenge that indicates the authentication scheme and parameters applicable to the
* proxy for this Request-URI.
- *
+ *
* <p class='bcode'>
* Proxy-Authenticate = "Proxy-Authenticate" ":" 1#challenge
* </p>
- *
+ *
* <p>
* The HTTP access authentication process is described in "HTTP Authentication: Basic and Digest Access Authentication".
* Unlike WWW-Authenticate, the Proxy-Authenticate header field applies only to the current connection and SHOULD NOT
* be passed on to downstream clients.
* However, an intermediate proxy might need to obtain its own credentials by requesting them from the downstream
* client, which in some circumstances will appear as if the proxy is forwarding the Proxy-Authenticate header field.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -54,7 +54,7 @@ public final class ProxyAuthenticate extends HeaderString {
/**
* Returns a parsed <code>Proxy-Authenticate</code> header.
- *
+ *
* @param value The <code>Proxy-Authenticate</code> header string.
* @return The parsed <code>Proxy-Authenticate</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ProxyAuthorization.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ProxyAuthorization.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ProxyAuthorization.java
index f6bb7ab..cf80d43 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ProxyAuthorization.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/ProxyAuthorization.java
@@ -14,26 +14,26 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Proxy-Authorization</l> HTTP request header.
- *
+ *
* <p>
* Authorization credentials for connecting to a proxy.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Proxy-Authorization request-header field allows the client to identify itself (or its user) to a proxy which
* requires authentication.
* The Proxy-Authorization field value consists of credentials containing the authentication information of the user
* agent for the proxy and/or realm of the resource being requested.
- *
+ *
* <p class='bcode'>
* Proxy-Authorization = "Proxy-Authorization" ":" credentials
* </p>
- *
+ *
* <p>
* The HTTP access authentication process is described in "HTTP Authentication: Basic and Digest Access Authentication".
* Unlike Authorization, the Proxy-Authorization header field applies only to the next outbound proxy that demanded
@@ -42,7 +42,7 @@ package org.apache.juneau.http;
* proxy that was expecting to receive credentials.
* A proxy MAY relay the credentials from the client request to the next proxy if that is the mechanism by which the
* proxies cooperatively authenticate a given request.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -56,7 +56,7 @@ public final class ProxyAuthorization extends HeaderString {
/**
* Returns a parsed <code>Proxy-Authorization</code> header.
- *
+ *
* @param value The <code>Proxy-Authorization</code> header string.
* @return The parsed <code>Proxy-Authorization</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Range.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Range.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Range.java
index 2c105fe..b1916b1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Range.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Range.java
@@ -14,25 +14,25 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Range</l> HTTP request header.
- *
+ *
* <p>
* Request only part of an entity. Bytes are numbered from 0.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Range: bytes=500-999
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* Since all HTTP entities are represented in HTTP messages as sequences of bytes, the concept of a byte range is
* meaningful for any HTTP entity.
* (However, not all clients and servers need to support byte- range operations.)
- *
+ *
* <p>
* Byte range specifications in HTTP apply to the sequence of bytes in the entity-body (not necessarily the same as the
* message-body).
- *
+ *
* <p>
* A byte range operation MAY specify a single range of bytes, or a set of ranges within a single entity.
* <p class='bcode'>
@@ -43,23 +43,23 @@ package org.apache.juneau.http;
* first-byte-pos = 1*DIGIT
* last-byte-pos = 1*DIGIT
* </p>
- *
+ *
* <p>
* The first-byte-pos value in a byte-range-spec gives the byte-offset of the first byte in a range.
* The last-byte-pos value gives the byte-offset of the last byte in the range; that is, the byte positions specified
* are inclusive.
* Byte offsets start at zero.
- *
+ *
* <p>
* If the last-byte-pos value is present, it MUST be greater than or equal to the first-byte-pos in that
* byte-range-spec, or the byte- range-spec is syntactically invalid.
* The recipient of a byte-range- set that includes one or more syntactically invalid byte-range-spec values MUST
* ignore the header field that includes that byte-range-set.
- *
+ *
* <p>
* If the last-byte-pos value is absent, or if the value is greater than or equal to the current length of the
* entity-body, last-byte-pos is taken to be equal to one less than the current length of the entity-body in bytes.
- *
+ *
* <p>
* By its choice of last-byte-pos, a client can limit the number of bytes retrieved without knowing the size of the
* entity.
@@ -67,13 +67,13 @@ package org.apache.juneau.http;
* suffix-byte-range-spec = "-" suffix-length
* suffix-length = 1*DIGIT
* </p>
- *
+ *
* <p>
* A suffix-byte-range-spec is used to specify the suffix of the entity-body, of a length given by the suffix-length
* value.
* (That is, this form specifies the last N bytes of an entity-body.)
* If the entity is shorter than the specified suffix-length, the entire entity-body is used.
- *
+ *
* <p>
* If a syntactically valid byte-range-set includes at least one byte- range-spec whose first-byte-pos is less than the
* current length of the entity-body, or at least one suffix-byte-range-spec with a non-zero suffix-length, then the
@@ -83,7 +83,7 @@ package org.apache.juneau.http;
* not satisfiable).
* Otherwise, the server SHOULD return a response with a status of 206 (Partial Content) containing the satisfiable
* ranges of the entity-body.
- *
+ *
* <p>
* Examples of byte-ranges-specifier values (assuming an entity-body of length 10000):
* <p class='bcode'>
@@ -96,22 +96,22 @@ package org.apache.juneau.http;
* bytes=500-600,601-999
* bytes=500-700,601-999
* </p>
- *
+ *
* <p>
* HTTP retrieval requests using conditional or unconditional GET methods MAY request one or more sub-ranges of the
* entity, instead of the entire entity, using the Range request header, which applies to the entity returned as the
* result of the request:
- *
+ *
* <p class='bcode'>
* Range = "Range" ":" ranges-specifier
* </p>
- *
+ *
* <p>
* A server MAY ignore the Range header.
* However, HTTP/1.1 origin servers and intermediate caches ought to support byte ranges when possible, since Range
* supports efficient recovery from partially failed transfers, and supports efficient partial retrieval of large
* entities.
- *
+ *
* <p>
* If the server supports the Range header and the specified range or ranges are appropriate for the entity:
* <ul>
@@ -123,16 +123,16 @@ package org.apache.juneau.http;
* otherwise successful and the condition is true. It does not affect the 304 (Not Modified) response returned if
* the conditional is false.
* </ul>
- *
+ *
* <p>
* In some cases, it might be more appropriate to use the If-Range header (see section 14.27) in addition to the Range
* header.
- *
+ *
* <p>
* If a proxy that supports ranges receives a Range request, forwards the request to an inbound server, and receives an
* entire entity in reply, it SHOULD only return the requested range to its client.
* It SHOULD store the entire received response in its cache if that is consistent with its cache allocation policies.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -146,7 +146,7 @@ public final class Range extends HeaderString {
/**
* Returns a parsed <code>Range</code> header.
- *
+ *
* @param value The <code>Range</code> header string.
* @return The parsed <code>Range</code> header, or <jk>null</jk> if the string was null.
*/
[06/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
index f0f5c77..36c4df7 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
@@ -95,19 +95,19 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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.
- *
+ *
* <p>
* 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()}.
- *
+ *
* @return The HTTP client to use.
* @throws Exception
*/
@@ -120,17 +120,17 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
* <li>Lax redirect strategy.
* <li>The connection manager returned by {@link #createConnectionManager()}.
* </ul>
- *
+ *
* @return The HTTP client builder to use to create the HTTP client.
*/
protected HttpClientBuilder createHttpClientBuilder() {
@@ -141,13 +141,13 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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}.
- *
+ *
* @return The HTTP client builder to use to create the HTTP client.
*/
@SuppressWarnings("resource")
@@ -186,7 +186,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Enable SSL support on this client.
- *
+ *
* @param opts
* The SSL configuration options.
* See {@link SSLOpts} for details.
@@ -202,10 +202,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Enable LAX SSL support.
- *
+ *
* <p>
* Certificate chain validation and hostname verification is disabled.
- *
+ *
* @return This object (for method chaining).
* @throws KeyStoreException
* @throws NoSuchAlgorithmException
@@ -216,7 +216,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the client version by setting the value for the <js>"X-Client-Version"</js> header.
- *
+ *
* @param version The version string (e.g. <js>"1.2.3"</js>)
* @return This object (for method chaining).
*/
@@ -226,7 +226,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Adds a {@link RestCallLogger} to the list of interceptors on this class.
- *
+ *
* @param level The log level to log messages at.
* @param log The logger to log messages to.
* @return This object (for method chaining).
@@ -238,7 +238,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* When called, the {@link #createConnectionManager()} method will return a {@link PoolingHttpClientConnectionManager}
* instead of a {@link BasicHttpClientConnectionManager}.
- *
+ *
* @return This object (for method chaining).
*/
public RestClientBuilder pooled() {
@@ -248,7 +248,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Set up this client to use BASIC auth.
- *
+ *
* @param host The auth scope hostname.
* @param port The auth scope port.
* @param user The username.
@@ -266,7 +266,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the internal {@link HttpClient} to use for handling HTTP communications.
- *
+ *
* @param httpClient The HTTP client.
* @param keepHttpClientOpen Don't close this client when the {@link RestClient#close()} method is called.
* @return This object (for method chaining).
@@ -284,11 +284,11 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -298,10 +298,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -311,10 +311,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -324,10 +324,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -337,10 +337,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Authorization</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Authorization"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -350,10 +350,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -363,10 +363,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Connection</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Connection"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -376,10 +376,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -389,11 +389,11 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -403,10 +403,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Date</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Date"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -416,10 +416,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Expect</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Expect"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -429,10 +429,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Forwarded</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Forwarded"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -442,10 +442,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>From</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"From"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -455,10 +455,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Host</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Host"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -468,10 +468,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -481,10 +481,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -494,10 +494,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -507,10 +507,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -520,10 +520,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -533,10 +533,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -546,12 +546,12 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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.
- *
+ *
* @return This object (for method chaining).
*/
public RestClientBuilder noTrace() {
@@ -560,10 +560,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Origin</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Origin"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -573,10 +573,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Pragma</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Pragma"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -586,10 +586,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -599,10 +599,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Range</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Range"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -612,10 +612,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Referer</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Referer"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -625,10 +625,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>TE</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"TE"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -638,10 +638,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -651,10 +651,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Upgrade</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Upgrade"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -664,10 +664,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Via</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Via"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -677,10 +677,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Warning</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Warning"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -698,7 +698,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* 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>
@@ -707,11 +707,11 @@ public class RestClientBuilder extends BeanContextBuilder {
* <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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_executorService}
@@ -730,7 +730,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Request headers.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_headers}
@@ -746,10 +746,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Keep HttpClient open.
- *
+ *
* <p>
* Don't close this client when the {@link RestClient#close()} method is called.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_keepHttpClientOpen}
@@ -769,7 +769,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Adds an interceptor that gets called immediately after a connection is made.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_interceptors}
@@ -787,7 +787,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* The parser to use for parsing POJOs in response bodies.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_parser}
@@ -807,7 +807,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Same as {@link #parser(Parser)} except takes in a parser instance.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_parser}
@@ -824,10 +824,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Part serializer.
- *
+ *
* <p>
* The serializer to use for serializing POJOs in form data, query parameters, headers, and path variables.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_partSerializer}
@@ -844,10 +844,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Part serializer.
- *
+ *
* <p>
* Same as {@link #partSerializer(Class)} but takes in a parser instance.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_partSerializer}
@@ -864,7 +864,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Make HTTP calls retryable if an error response (>=400) is received.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_retries}
@@ -888,12 +888,12 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Root URI.
- *
+ *
* <p>
* When set, relative URL strings passed in through the various rest call methods (e.g. {@link RestClient#doGet(Object)}
* will be prefixed with the specified root.
* <br>This root URL is ignored on those methods if you pass in a {@link URL}, {@link URI}, or an absolute URL string.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_rootUri}
@@ -911,7 +911,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Request query parameters.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_query}
@@ -927,10 +927,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Serializer.
- *
+ *
* <p>
* The serializer to use for serializing POJOs in request bodies.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_serializer}
@@ -947,10 +947,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Serializer.
- *
+ *
* <p>
* Same as {@link #serializer(Class)} but takes in a serializer instance.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_serializer}
@@ -967,11 +967,11 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Abridged output.
- *
+ *
* <p>
* When enabled, it is assumed that the parser knows the exact Java POJO type being parsed, and therefore top-level
* type information that might normally be included to determine the data type will not be serialized.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_abridged}
@@ -988,10 +988,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Abridged output.
- *
+ *
* <p>
* Shortcut for calling <code>abridged(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_abridged}
@@ -1005,11 +1005,11 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
* through reflection.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_addBeanTypeProperties}
@@ -1026,15 +1026,15 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Automatically detect POJO recursions.
- *
+ *
* <p>
* Specifies that recursions should be checked for during serialization.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Checking for recursion can cause a small performance penalty.
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_detectRecursions}
@@ -1051,10 +1051,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Automatically detect POJO recursions.
- *
+ *
* <p>
* Shortcut for calling <code>detectRecursions(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_detectRecursions}
@@ -1068,16 +1068,16 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Ignore recursion errors.
- *
+ *
* <p>
* 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.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Checking for recursion can cause a small performance penalty.
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_ignoreRecursions}
@@ -1094,10 +1094,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Ignore recursion errors.
- *
+ *
* <p>
* Shortcut for calling <code>ignoreRecursions(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_ignoreRecursions}
@@ -1111,10 +1111,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Initial depth.
- *
+ *
* <p>
* The initial indentation level at the root.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_initialDepth}
@@ -1131,10 +1131,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Serializer listener.
- *
+ *
* <p>
* Class used to listen for errors and warnings that occur during serialization.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_listener}
@@ -1150,12 +1150,12 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Max serialization depth.
- *
+ *
* <p>
* Abort serialization if specified depth is reached in the POJO tree.
* <br>If this depth is exceeded, an exception is thrown.
* <br>This prevents stack overflows from occurring when trying to serialize models with recursive references.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_maxDepth}
@@ -1172,10 +1172,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Maximum indentation.
- *
+ *
* <p>
* Specifies the maximum indentation level in the serialized document.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_maxIndent}
@@ -1192,10 +1192,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Quote character.
- *
+ *
* <p>
* This is the character used for quoting attributes and values.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_quoteChar}
@@ -1215,7 +1215,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>quoteChar(<js>'\''</js>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_quoteChar}
@@ -1229,10 +1229,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Sort arrays and collections alphabetically.
- *
+ *
* <p>
* Copies and sorts the contents of arrays and collections before serializing them.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortCollections}
@@ -1252,7 +1252,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>sortCollections(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortCollections}
@@ -1266,10 +1266,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the {@link Serializer#SERIALIZER_sortMaps} property on all serializers in this group.
- *
+ *
* <p>
* Copies and sorts the contents of maps before serializing them.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortMaps}
@@ -1287,7 +1287,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>sortMaps(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortMaps}
@@ -1301,10 +1301,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty lists and arrays.
- *
+ *
* <p>
* If <jk>true</jk>, empty list values will not be serialized to the output.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyCollections}
@@ -1321,10 +1321,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty lists and arrays.
- *
+ *
* <p>
* Shortcut for calling <code>trimEmptyCollections(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyCollections}
@@ -1338,10 +1338,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty maps.
- *
+ *
* <p>
* If <jk>true</jk>, empty map values will not be serialized to the output.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyMaps}
@@ -1358,10 +1358,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty maps.
- *
+ *
* <p>
* Shortcut for calling <code>trimEmptyMaps(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyMaps}
@@ -1375,10 +1375,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim null bean property values.
- *
+ *
* <p>
* If <jk>true</jk>, null bean values will not be serialized to the output.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimNullProperties}
@@ -1395,10 +1395,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim strings.
- *
+ *
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being serialized.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimStrings}
@@ -1415,10 +1415,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim strings.
- *
+ *
* <p>
* Shortcut for calling <code>trimStrings(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimStrings}
@@ -1432,10 +1432,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: URI context bean.
- *
+ *
* <p>
* Bean used for resolution of URIs to absolute or root-relative form.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriContext}
@@ -1450,10 +1450,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: URI relativity.
- *
+ *
* <p>
* Defines what relative URIs are relative to when serializing URI/URL objects.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriRelativity}
@@ -1470,10 +1470,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: URI resolution.
- *
+ *
* <p>
* Defines the resolution level for URIs when serializing URI/URL objects.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriResolution}
@@ -1490,10 +1490,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Use whitespace.
- *
+ *
* <p>
* If <jk>true</jk>, newlines and indentation and spaces are added to the output to improve readability.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_useWhitespace}
@@ -1510,7 +1510,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Use whitespace.
- *
+ *
* <p>
* Shortcut for calling <code>useWhitespace(<jk>true</jk>)</code>.
*
@@ -1526,10 +1526,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Use whitespace.
- *
+ *
* <p>
* Shortcut for calling <code>useWhitespace(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_useWhitespace}
@@ -1543,10 +1543,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: File charset.
- *
+ *
* <p>
* The character set to use for reading <code>Files</code> from the file system.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_fileCharset}
@@ -1563,10 +1563,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Input stream charset.
- *
+ *
* <p>
* The character set to use for converting <code>InputStreams</code> and byte arrays to readers.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_inputStreamCharset}
@@ -1583,10 +1583,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Parser listener.
- *
+ *
* <p>
* Class used to listen for errors and warnings that occur during parsing.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_listener}
@@ -1601,10 +1601,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Strict mode.
- *
+ *
* <p>
* If <jk>true</jk>, strict mode for the parser is enabled.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_strict}
@@ -1624,7 +1624,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>strict(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_strict}
@@ -1638,11 +1638,11 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
@@ -1659,10 +1659,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <p>
* Shortcut for calling <code>trimStrings(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
@@ -1676,7 +1676,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* TODO
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UonSerializer#UON_paramFormat}
@@ -1691,7 +1691,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* TODO
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UonSerializer#UON_paramFormat}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java
index 46adfaf..83c919c 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java
@@ -32,7 +32,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/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java
index 31e56af..30908fc 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java
@@ -16,7 +16,7 @@ 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.
@@ -45,7 +45,7 @@ public abstract class RetryOn {
/**
* Subclasses should override this method to determine whether the HTTP response is retryable.
- *
+ *
* @param response The HTTP response object. May be <jk>null</jk> if a connection could not be made.
* @return <jk>true</jk> if the specified response code is retryable.
*/
@@ -55,7 +55,7 @@ public abstract class RetryOn {
/**
* Subclasses should override this method to determine whether the HTTP response is retryable.
- *
+ *
* @param httpResponseCode The HTTP response code. <code>-1</code> if a connection could not be made.
* @return <jk>true</jk> if the specified response code is retryable.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java
index e00fa48..1728c74 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java
@@ -40,7 +40,7 @@ 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()}.
@@ -57,16 +57,16 @@ 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>.
- *
+ *
* <p>
* 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.
- *
+ *
* @return The comma-delimited list of supported protocols.
*/
protected String getDefaultProtocols() {
@@ -83,7 +83,7 @@ public class SSLOpts {
/**
* Bean property getter: <property>protocols</property>.
- *
+ *
* @return The value of the <property>protocols</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getProtocols() {
@@ -92,7 +92,7 @@ public class SSLOpts {
/**
* Bean property setter: <property>protocols</property>.
- *
+ *
* @param protocols The new value for the <property>protocols</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -103,7 +103,7 @@ public class SSLOpts {
/**
* Bean property getter: <property>certValidate</property>.
- *
+ *
* @return The value of the <property>certValidate</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public CertValidate getCertValidate() {
@@ -112,7 +112,7 @@ public class SSLOpts {
/**
* Bean property setter: <property>certValidate</property>.
- *
+ *
* @param certValidate The new value for the <property>certValidate</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -123,7 +123,7 @@ public class SSLOpts {
/**
* Bean property getter: <property>hostVerify</property>.
- *
+ *
* @return The value of the <property>hostVerify</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public HostVerify getHostVerify() {
@@ -132,7 +132,7 @@ public class SSLOpts {
/**
* Bean property setter: <property>hostVerify</property>.
- *
+ *
* @param hostVerify The new value for the <property>hostVerify</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -148,7 +148,7 @@ public class SSLOpts {
/**
* Certificate validation options.
- *
+ *
* <p>
* Used as enum for {@link SSLOpts#getCertValidate()} property.
*/
@@ -167,7 +167,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/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java
index 8fbe329..0cf3796 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java
@@ -19,7 +19,7 @@ import org.apache.juneau.urlencoding.*;
/**
* Subclass of {@link NameValuePair} for serializing POJOs as URL-encoded form post entries using the
* {@link UrlEncodingSerializer class}.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* NameValuePairs params = <jk>new</jk> NameValuePairs()
@@ -35,7 +35,7 @@ public final class SerializedNameValuePair implements NameValuePair {
/**
* Constructor.
- *
+ *
* @param name The parameter name.
* @param value The POJO to serialize to the parameter value.
* @param serializer The serializer to use to convert the value to a string.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java
index d4a0671..66cd38c 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java
@@ -26,7 +26,7 @@ public final class SimpleX509TrustManager implements X509TrustManager {
/**
* Constructor.
- *
+ *
* @param lax If <jk>true</jk>, allow self-signed and expired certificates.
* @throws KeyStoreException
* @throws NoSuchAlgorithmException
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java b/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java
index c7cd4e8..1a9d20d 100644
--- a/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java
+++ b/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java
@@ -76,7 +76,7 @@ public class BaseProvider implements MessageBodyReader<Object>, MessageBodyWrite
* Returns properties defined on the specified method through the {@link RestMethod#properties() @RestMethod.properties()}
* annotation specified on the method and the {@link JuneauProvider#properties()} annotation specified on the
* provider class.
- *
+ *
* @param a All annotations defined on the method.
* @return A map of all properties define on the method.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java b/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java
index d84ecd1..fdd69d2 100644
--- a/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java
+++ b/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java
@@ -28,8 +28,9 @@ import org.apache.juneau.xml.*;
/**
* Annotations applicable to subclasses of {@link BaseProvider}.
- *
- * <h5 class='section'>Description:</h5>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
*
* Used to associate serializers, parsers, filters, and properties with instances of {@link BaseProvider}.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java
index 6d340bd..e323a0f 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java
@@ -19,7 +19,7 @@ import org.apache.juneau.rest.annotation.*;
/**
* Specialized matcher for matching client versions.
- *
+ *
* <p>
* See {@link RestResource#clientVersionHeader} and {@link RestMethod#clientVersion} for more info.
*/
@@ -30,7 +30,7 @@ public class ClientVersionMatcher extends RestMatcher {
/**
* Constructor.
- *
+ *
* @param clientVersionHeader
* The HTTP request header name containing the client version.
* If <jk>null</jk> or an empty string, uses <js>"X-Client-Version"</js>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/HtmlDocBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/HtmlDocBuilder.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/HtmlDocBuilder.java
index 54ebb1b..ce1731e 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/HtmlDocBuilder.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/HtmlDocBuilder.java
@@ -25,11 +25,11 @@ import org.apache.juneau.utils.*;
/**
* Programmatic interface for setting properties used by the HtmlDoc serializer.
- *
+ *
* <p>
* Basically just a convenience wrapper around the servlet or method level properties for setting properties defined
* by the {@link HtmlDocSerializer} class.
- *
+ *
* <p>
* This class is instantiated through the following methods.
* <ul>
@@ -74,25 +74,25 @@ public class HtmlDocBuilder {
/**
* Sets the HTML header section contents.
- *
+ *
* <p>
* 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>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* 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()}.
@@ -110,28 +110,28 @@ public class HtmlDocBuilder {
/**
* 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.
- *
+ *
* <p>
* The page links are positioned immediately under the title and text.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This field can also use URIs of any support type in {@link UriResolver}.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#navlinks() @HtmlDoc.navlinks()} annotation.
- *
+ *
* @param value
* The HTML nav section links links.
* <p>
@@ -148,30 +148,30 @@ public class HtmlDocBuilder {
/**
* Sets the HTML nav section contents.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* The nav section of the page contains the links.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* When a value is specified, the {@link #navlinks(Object[])} value will be ignored.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* 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()}.
@@ -189,24 +189,24 @@ public class HtmlDocBuilder {
/**
* Sets the HTML aside section contents.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* The aside section typically floats on the right side of the page.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* 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()}.
@@ -224,24 +224,24 @@ public class HtmlDocBuilder {
/**
* Sets the HTML footer section contents.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* The footer section typically floats on the bottom of the page.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* 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()}.
@@ -259,21 +259,21 @@ public class HtmlDocBuilder {
/**
* Sets the HTML CSS style section contents.
- *
+ *
* <p>
* The format of this value is CSS.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#style() @HtmlDoc.style()} annotation.
- *
+ *
* @param value
* The HTML CSS style section contents.
* Object will be converted to a string using {@link Object#toString()}.
@@ -291,24 +291,24 @@ public class HtmlDocBuilder {
/**
* Sets the CSS URL in the HTML CSS style section.
- *
+ *
* <p>
* The format of this value is a comma-delimited list of URLs.
- *
+ *
* <p>
* 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>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols defined
* by {@link UriResolver}.
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#stylesheet() @HtmlDoc.stylesheet()} annotation.
- *
+ *
* @param value
* The CSS URL in the HTML CSS style section.
* Object will be converted to a string using {@link Object#toString()}.
@@ -326,21 +326,21 @@ public class HtmlDocBuilder {
/**
* Sets the HTML script section contents.
- *
+ *
* <p>
* The format of this value is Javascript.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#script() @HtmlDoc.script()} annotation.
- *
+ *
* @param value
* The HTML script section contents.
* Object will be converted to a string using {@link Object#toString()}.
@@ -358,21 +358,21 @@ public class HtmlDocBuilder {
/**
* Sets the HTML head section contents.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#head() @HtmlDoc.head()} annotation.
- *
+ *
* @param value
* The HTML head section contents.
* <p>
@@ -389,10 +389,10 @@ public class HtmlDocBuilder {
/**
* Shorthand method for forcing the rendered HTML content to be no-wrap.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#nowrap() @HtmlDoc.nowrap()} annotation.
- *
+ *
* @param value The new nowrap setting.
* @return This object (for method chaining).
*/
@@ -402,11 +402,11 @@ public class HtmlDocBuilder {
/**
* 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.
- *
+ *
* @param value The text to display when serializing an empty array or collection.
* @return This object (for method chaining).
*/
@@ -416,14 +416,14 @@ public class HtmlDocBuilder {
/**
* 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.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.
- *
+ *
* @param value The HTML page template to use to render the HTML page.
* @return This object (for method chaining).
*/
@@ -433,14 +433,14 @@ public class HtmlDocBuilder {
/**
* 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.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.
- *
+ *
* @param value The HTML page template to use to render the HTML page.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ReaderResource.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ReaderResource.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ReaderResource.java
index c187616..d9762f9 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ReaderResource.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ReaderResource.java
@@ -27,7 +27,7 @@ import org.apache.juneau.svl.*;
/**
* Represents the contents of a text file with convenience methods for resolving {@link Parameter @Parameter} variables and adding
* HTTP response headers.
- *
+ *
* <p>
* This class is handled special by the {@link WritableHandler} class.
*/
@@ -40,7 +40,7 @@ public class ReaderResource implements Writable {
/**
* Constructor.
- *
+ *
* @param mediaType The HTTP media type.
* @param contents
* The contents of this resource.
@@ -59,7 +59,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.
@@ -114,7 +114,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).
*/
@@ -125,7 +125,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).
*/
@@ -136,10 +136,10 @@ public class ReaderResource implements Writable {
/**
* Specifies the contents for this resource.
- *
+ *
* <p>
* This method can be called multiple times to add more content.
- *
+ *
* @param contents
* The resource contents.
* <br>If multiple contents are specified, the results will be concatenated.
@@ -159,7 +159,7 @@ public class ReaderResource implements Writable {
/**
* Specifies an HTTP response header value.
- *
+ *
* @param name The HTTP header name.
* @param value
* The HTTP header value.
@@ -173,7 +173,7 @@ public class ReaderResource implements Writable {
/**
* Specifies HTTP response header values.
- *
+ *
* @param headers
* The HTTP headers.
* Values will be converted to <code>Strings</code> using {@link Object#toString()}.
@@ -187,7 +187,7 @@ public class ReaderResource implements Writable {
/**
* Specifies the variable resolver to use for this resource.
- *
+ *
* @param varResolver The variable resolver.
* @return This object (for method chaining).
*/
@@ -198,7 +198,7 @@ public class ReaderResource implements Writable {
/**
* Create a new {@link ReaderResource} using values in this builder.
- *
+ *
* @return A new immutable {@link ReaderResource} object.
* @throws IOException
*/
@@ -209,7 +209,7 @@ public class ReaderResource implements Writable {
/**
* Get the HTTP response headers.
- *
+ *
* @return The HTTP response headers.
*/
public Map<String,String> getHeaders() {
@@ -246,10 +246,10 @@ public class ReaderResource implements Writable {
/**
* Same as {@link #toString()} but strips comments from the text before returning it.
- *
+ *
* <p>
* Supports stripping comments from the following media types: HTML, XHTML, XML, JSON, Javascript, CSS.
- *
+ *
* @return The resource contents stripped of any comments.
*/
public String toCommentStrippedString() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/Redirect.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/Redirect.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/Redirect.java
index 451f2c7..6f50c27 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/Redirect.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/Redirect.java
@@ -21,26 +21,26 @@ 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.
* <p class='bcode'>
* <jc>// Redirect to "/contextPath/servletPath/foobar"</jc>
- *
+ *
* <jc>// Using RestRequest and RestResponse</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/example1"</js>)
* <jk>public void</jk> example1(RestRequest req, RestResponse res) <jk>throws</jk> IOException {
* res.sendRedirect(req.getServletURI() + <js>"/foobar"</js>);
* }
- *
+ *
* <jc>// Using Redirect</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/example2"</js>)
* <jk>public</jk> Redirect example2() {
* <jk>return new</jk> Redirect(<js>"foobar"</js>);
* }
* </p>
- *
+ *
* <p>
* The constructor can use a {@link MessageFormat}-style pattern with multiple arguments:
* <p class='bcode'>
@@ -49,12 +49,12 @@ import org.apache.juneau.urlencoding.*;
* <jk>return new</jk> Redirect(<js>"foo/{0}/bar/{1}"</js>, id1, id2);
* }
* </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 will also be automatically URL-encoded.
- *
+ *
* <p>
* Redirecting to the servlet root can be accomplished by simply using the no-arg constructor.
* <p class='bcode'>
@@ -65,7 +65,7 @@ import org.apache.juneau.urlencoding.*;
* <jk>return new</jk> Redirect();
* }
* </p>
- *
+ *
* <p>
* This class is handled by {@link org.apache.juneau.rest.response.RedirectHandler}, a built-in default response
* handler created in {@link RestContextBuilder}.
@@ -77,10 +77,10 @@ public final class Redirect {
/**
* Redirect to the specified URL.
- *
+ *
* <p>
* Relative paths are interpreted as relative to the servlet path.
- *
+ *
* @param uri
* The URL to redirect to.
* <br>Can be any of the following:
@@ -97,10 +97,10 @@ public final class Redirect {
/**
* Convenience method for redirecting to instance of {@link URL} and {@link URI}.
- *
+ *
* <p>
* Same as calling <code>toString()</code> on the object and using the other constructor.
- *
+ *
* @param uri
* The URL to redirect to.
* <br>Can be any of the following:
@@ -116,10 +116,10 @@ public final class Redirect {
/**
* Redirect to the specified URL.
- *
+ *
* <p>
* Relative paths are interpreted as relative to the servlet path.
- *
+ *
* @param httpResponseCode The HTTP response code.
* @param url
* The URL to redirect to.
@@ -147,7 +147,7 @@ public final class Redirect {
/**
* Returns the response code passed in through the constructor.
- *
+ *
* @return The response code passed in through the constructor, or <code>0</code> if response code wasn't specified.
*/
public int getHttpResponseCode() {
@@ -156,7 +156,7 @@ public final class Redirect {
/**
* Returns the URI to redirect to.
- *
+ *
* @return The URI to redirect to.
*/
public URI getURI() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestBody.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestBody.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestBody.java
index 03b1251..51117b0 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestBody.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestBody.java
@@ -84,11 +84,11 @@ public class RequestBody {
/**
* Reads the input from the HTTP request as JSON, XML, or HTML and converts the input to a POJO.
- *
+ *
* <p>
* If {@code allowHeaderParams} init parameter is <jk>true</jk>, then first looks for {@code &body=xxx} in the URL
* query string.
- *
+ *
* <p>
* If type is <jk>null</jk> or <code>Object.<jk>class</jk></code>, then the actual type will be determined
* automatically based on the following input:
@@ -131,29 +131,29 @@ public class RequestBody {
* <td><jk>null</jk></td>
* </tr>
* </table>
- *
+ *
* <p>
* Refer to <a class="doclink" href="../../../../overview-summary.html#juneau-marshall.PojoCategories">POJO Categories</a> for
* a complete definition of supported POJOs.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into an integer.</jc>
* <jk>int</jk> body = req.getBody().asType(<jk>int</jk>.<jk>class</jk>);
- *
+ *
* <jc>// Parse into an int array.</jc>
* <jk>int</jk>[] body = req.getBody().asType(<jk>int</jk>[].<jk>class</jk>);
* <jc>// Parse into a bean.</jc>
* MyBean body = req.getBody().asType(MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of objects.</jc>
* List body = req.getBody().asType(LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of object keys/values.</jc>
* Map body = req.getBody().asType(TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* @param type The class type to instantiate.
* @param <T> The class type to instantiate.
* @return The input parsed to a POJO.
@@ -168,22 +168,22 @@ public class RequestBody {
/**
* Reads the input from the HTTP request as JSON, XML, or HTML and converts the input to a POJO.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into a linked-list of strings.</jc>
* List<String> body = req.getBody().asType(LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of linked-lists of strings.</jc>
* List<List<String>> body = req.getBody().asType(LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of string keys/values.</jc>
* Map<String,String> body = req.getBody().asType(TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map containing string keys and values of lists containing beans.</jc>
* Map<String,List<MyBean>> body = req.getBody().asType(TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);
* </p>
- *
+ *
* @param type
* The type of object to create.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
@@ -202,11 +202,11 @@ public class RequestBody {
/**
* Returns the HTTP body content as a plain string.
- *
+ *
* <p>
* If {@code allowHeaderParams} init parameter is true, then first looks for {@code &body=xxx} in the URL query
* string.
- *
+ *
* @return The incoming input from the connection as a plain string.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -218,7 +218,7 @@ public class RequestBody {
/**
* Returns the HTTP body content as a simple hexadecimal character string.
- *
+ *
* @return The incoming input from the connection as a plain string.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -230,7 +230,7 @@ public class RequestBody {
/**
* Returns the HTTP body content as a simple space-delimited hexadecimal character string.
- *
+ *
* @return The incoming input from the connection as a plain string.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -242,14 +242,14 @@ public class RequestBody {
/**
* 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.
- *
+ *
* <p>
* Automatically handles GZipped input streams.
- *
+ *
* @return The body contents as a reader.
* @throws IOException
*/
@@ -264,7 +264,7 @@ public class RequestBody {
/**
* Same as {@link #getReader()}, but doesn't encapsulate the result in a {@link BufferedReader};
- *
+ *
* @return An unbuffered reader.
* @throws IOException
*/
@@ -276,10 +276,10 @@ public class RequestBody {
/**
* Returns the HTTP body content as an {@link InputStream}.
- *
+ *
* <p>
* 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.
*/
@@ -298,7 +298,7 @@ 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.
@@ -317,7 +317,7 @@ 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.
@@ -329,7 +329,7 @@ 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.
@@ -410,7 +410,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/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java
index 4549870..0fda7cb 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java
@@ -45,10 +45,10 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Adds default entries to these form-data parameters.
- *
+ *
* <p>
* This includes the default form-data parameters defined on the servlet and method levels.
- *
+ *
* @param defaultEntries The default entries. Can be <jk>null</jk>.
* @return This object (for method chaining).
*/
@@ -67,7 +67,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Sets a request form data parameter value.
- *
+ *
* @param name The parameter name.
* @param value The parameter value.
*/
@@ -77,10 +77,10 @@ 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).
- *
+ *
* <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
@@ -95,7 +95,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
* <li><js>"foo~~bar"</js> => <js>"foo~bar"</js>
* </ul>
* </ul>
- *
+ *
* @param name The form data parameter name.
* @return The parameter value, or <jk>null</jk> if parameter does not exist.
*/
@@ -115,7 +115,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getString(String)} except returns a default value if <jk>null</jk> or empty.
- *
+ *
* @param name The form data parameter name.
* @param def The default value.
* @return The parameter value, or the default value if parameter does not exist or is <jk>null</jk> or empty.
@@ -127,7 +127,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getString(String)} but converts the value to an integer.
- *
+ *
* @param name The form data parameter name.
* @return The parameter value, or <code>0</code> if parameter does not exist or is <jk>null</jk> or empty.
*/
@@ -137,7 +137,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getString(String,String)} but converts the value to an integer.
- *
+ *
* @param name The form data parameter name.
* @param def The default value.
* @return The parameter value, or the default value if parameter does not exist or is <jk>null</jk> or empty.
@@ -149,7 +149,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getString(String)} but converts the value to a boolean.
- *
+ *
* @param name The form data parameter name.
* @return The parameter value, or <jk>false</jk> if parameter does not exist or is <jk>null</jk> or empty.
*/
@@ -159,7 +159,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getString(String,String)} but converts the value to a boolean.
- *
+ *
* @param name The form data parameter name.
* @param def The default value.
* @return The parameter value, or the default value if parameter does not exist or is <jk>null</jk> or empty.
@@ -172,31 +172,31 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Returns the specified form data parameter value converted to a POJO using the {@link HttpPartParser}
* registered with this servlet.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into an integer.</jc>
* <jk>int</jk> myparam = req.getFormDataParameter(<js>"myparam"</js>, <jk>int</jk>.<jk>class</jk>);
- *
+ *
* <jc>// Parse into an int array.</jc>
* <jk>int</jk>[] myparam = req.getFormDataParameter(<js>"myparam"</js>, <jk>int</jk>[].<jk>class</jk>);
* <jc>// Parse into a bean.</jc>
* MyBean myparam = req.getFormDataParameter(<js>"myparam"</js>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of objects.</jc>
* List myparam = req.getFormDataParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of object keys/values.</jc>
* Map myparam = req.getFormDataParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>);
* </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.
* </ul>
- *
+ *
* @param name The parameter name.
* @param type The class type to convert the parameter value to.
* @param <T> The class type to convert the parameter value to.
@@ -209,7 +209,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Object, Class)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -225,7 +225,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Class)} except returns a default value if not specified.
- *
+ *
* @param name The parameter name.
* @param def The default value if the parameter was not specified or is <jk>null</jk>.
* @param type The class type to convert the parameter value to.
@@ -239,7 +239,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Object, Class)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -257,10 +257,10 @@ 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>)
- *
+ *
* <p>
* This method must only be called when parsing into classes of type Collection or array.
- *
+ *
* @param name The parameter name.
* @param type The class type to convert the parameter value to.
* @return The parameter value converted to the specified class type.
@@ -272,10 +272,10 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getAll(String, Class)} but allows you to override the part parser.
- *
+ *
* <p>
* This method must only be called when parsing into classes of type Collection or array.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -291,29 +291,29 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Returns the specified form data parameter value converted to a POJO using the {@link HttpPartParser}
* 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>Use this method if you want to parse into a parameterized <code>Map</code>/<code>Collection</code> object.
* </ul>
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into a linked-list of strings.</jc>
* List<String> myparam = req.getFormDataParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of linked-lists of strings.</jc>
* List<List<String>> myparam = req.getFormDataParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of string keys/values.</jc>
* Map<String,String> myparam = req.getFormDataParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map containing string keys and values of lists containing beans.</jc>
* Map<String,List<MyBean>> myparam = req.getFormDataParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);
* </p>
- *
+ *
* @param name The parameter name.
* @param type
* The type of object to create.
@@ -333,7 +333,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Type, Type...)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -357,10 +357,10 @@ 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>)
- *
+ *
* <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.
@@ -380,7 +380,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getAll(String, Type, Type...)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -459,7 +459,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Converts the form data parameters to a readable string.
- *
+ *
* @param sorted Sort the form data parameters by name.
* @return A JSON string containing the contents of the form data parameters.
*/
[02/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HookEvent.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HookEvent.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HookEvent.java
index dd6146e..7051963 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HookEvent.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HookEvent.java
@@ -36,10 +36,10 @@ public enum HookEvent {
/**
* Identifies a method that should be called immediately after the <code>HttpServlet.service(HttpServletRequest, HttpServletResponse)</code>
* method is called.
- *
+ *
* <p>
* Note that you only have access to the raw request and response objects at this point.
- *
+ *
* <p>
* The list of valid parameter types are as follows:
* <ul>
@@ -49,12 +49,12 @@ public enum HookEvent {
* <li>{@link HttpServletResponse}
* </ul>
* </ul>
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <ja>@RestResource</ja>(...)
* <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {
- *
+ *
* <jc>// Add a request attribute to all incoming requests.</jc>
* <ja>@RestHook</ja>(<jsf>START_CALL</jsf>)
* <jk>public void</jk> onStartCall(HttpServletRequest req) {
@@ -62,7 +62,7 @@ public enum HookEvent {
* }
* }
* </p>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>The method should return <jk>void</jk> although if it does return any value, the value will be ignored.
@@ -83,11 +83,11 @@ public enum HookEvent {
/**
* Identifies a method that gets called immediately before the <ja>@RestMethod</ja> annotated method gets called.
- *
+ *
* <p>
* At this point, the {@link RestRequest} object has been fully initialized, and all {@link RestGuard} and
* {@link RestMatcher} objects have been called.
- *
+ *
* <p>
* The list of valid parameter types are as follows:
* <ul>
@@ -160,12 +160,12 @@ public enum HookEvent {
* <li>{@link UriResolver}
* </ul>
* </ul>
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <ja>@RestResource</ja>(...)
* <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {
- *
+ *
* <jc>// Log the incoming request.</jc>
* <ja>@RestHook</ja>(<jsf>PRE_CALL</jsf>)
* <jk>public void</jk> onPreCall(Accept accept, Logger logger) {
@@ -173,7 +173,7 @@ public enum HookEvent {
* }
* }
* </p>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>The method should return <jk>void</jk> although if it does return any value, the value will be ignored.
@@ -196,19 +196,19 @@ public enum HookEvent {
/**
* Identifies a method that gets called immediately after the <ja>@RestMethod</ja> annotated method gets called.
- *
+ *
* <p>
* At this point, the output object returned by the method call has been set on the response, but
* {@link RestConverter RestConverters} have not yet been executed and the response has not yet been written.
- *
+ *
* <p>
* The list of valid parameter types are the same as {@link #PRE_CALL}.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <ja>@RestResource</ja>(...)
* <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {
- *
+ *
* <jc>// Log the result of the request.</jc>
* <ja>@RestHook</ja>(<jsf>POST_CALL</jsf>)
* <jk>public void</jk> onPostCall(RestResponse res, Logger logger) {
@@ -216,7 +216,7 @@ public enum HookEvent {
* }
* }
* </p>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>The method should return <jk>void</jk> although if it does return any value, the value will be ignored.
@@ -235,10 +235,10 @@ public enum HookEvent {
/**
* Identifies a method that gets called right before we exit the servlet service method.
- *
+ *
* <p>
* At this point, the output has been written and flushed.
- *
+ *
* <p>
* The list of valid parameter types are as follows:
* <ul>
@@ -248,19 +248,19 @@ public enum HookEvent {
* <li>{@link HttpServletResponse}
* </ul>
* </ul>
- *
+ *
* <p>
* The following attributes are set on the {@link HttpServletRequest} object that can be useful for logging purposes:
* <ul>
* <li><js>"Exception"</js> - Any exceptions thrown during the request.
* <li><js>"ExecTime"</js> - Execution time of the request.
* </ul>
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <ja>@RestResource</ja>(...)
* <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {
- *
+ *
* <jc>// Log the time it took to execute the request.</jc>
* <ja>@RestHook</ja>(<jsf>END_CALL</jsf>)
* <jk>public void</jk> onEndCall(HttpServletRequest req, Logger logger) {
@@ -273,7 +273,7 @@ public enum HookEvent {
* }
* }
* </p>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>The method should return <jk>void</jk> although if it does return any value, the value will be ignored.
@@ -292,27 +292,27 @@ public enum HookEvent {
/**
* Identifies a method that gets called during servlet initialization.
- *
+ *
* <p>
* This method is called from within the {@link Servlet#init(ServletConfig)} method after the {@link RestContextBuilder}
* object has been created and initialized with the annotations defined on the class, but before the
* {@link RestContext} object has been created.
- *
+ *
* <p>
* The only valid parameter type for this method is {@link RestContextBuilder} which can be used to configure the servlet.
- *
+ *
* <p>
* An example of this is the <code>PetStoreResource</code> class that uses an init method to perform initialization
* of an internal data structure.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <ja>@RestResource</ja>(...)
* <jk>public class</jk> PetStoreResource <jk>extends</jk> ResourceJena {
- *
+ *
* <jc>// Our database.</jc>
* <jk>private</jk> Map<Integer,Pet> <jf>petDB</jf>;
- *
+ *
* <ja>@RestHook</ja>(<jsf>INIT</jsf>)
* <jk>public void</jk> onInit(RestContextBuilder builder) <jk>throws</jk> Exception {
* <jc>// Load our database from a local JSON file.</jc>
@@ -320,7 +320,7 @@ public enum HookEvent {
* }
* }
* </p>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>The method should return <jk>void</jk> although if it does return any value, the value will be ignored.
@@ -339,15 +339,15 @@ public enum HookEvent {
/**
* Identifies a method that gets called immediately after servlet initialization.
- *
+ *
* <p>
* This method is called from within the {@link Servlet#init(ServletConfig)} method after the {@link RestContext}
* object has been created.
- *
+ *
* <p>
* The only valid parameter type for this method is {@link RestContext} which can be used to retrieve information
* about the servlet.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>The method should return <jk>void</jk> although if it does return any value, the value will be ignored.
@@ -366,18 +366,18 @@ public enum HookEvent {
/**
* Identical to {@link #POST_INIT} except the order of execution is child-resources first.
- *
+ *
* <p>
* Use this annotation if you need to perform any kind of initialization on child resources before the parent resource.
- *
+ *
* <p>
* This method is called from within the {@link Servlet#init(ServletConfig)} method after the {@link RestContext}
* object has been created and after the {@link #POST_INIT} methods have been called.
- *
+ *
* <p>
* The only valid parameter type for this method is {@link RestContext} which can be used to retrieve information
* about the servlet.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>The method should return <jk>void</jk> although if it does return any value, the value will be ignored.
@@ -393,29 +393,29 @@ public enum HookEvent {
/**
* Identifies a method that gets called during servlet destroy.
- *
+ *
* <p>
* This method is called from within the {@link Servlet#destroy()}.
- *
+ *
* <p>
* The only valid parameter type for this method is {@link RestContext}, although typically no arguments will
* be specified.
- *
+ *
* <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* <ja>@RestResource</ja>(...)
* <jk>public class</jk> PetStoreResource <jk>extends</jk> ResourceJena {
- *
+ *
* <jc>// Our database.</jc>
* <jk>private</jk> Map<Integer,Pet> <jf>petDB</jf>;
- *
+ *
* <ja>@RestHook</ja>(<jsf>DESTROY</jsf>)
* <jk>public void</jk> onDestroy() {
* <jf>petDB</jf> = <jk>null</jk>;
* }
* }
* </p>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul class='spaced-list'>
* <li>The method should return <jk>void</jk> although if it does return any value, the value will be ignored.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HtmlDoc.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HtmlDoc.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HtmlDoc.java
index 587ea5a..bd4e47c 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HtmlDoc.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HtmlDoc.java
@@ -19,15 +19,15 @@ import org.apache.juneau.rest.widget.*;
/**
* Contains all the configurable annotations for the {@link HtmlDocSerializer}.
- *
+ *
* <p>
* Used with {@link RestResource#htmldoc() @RestResource.htmldoc()} and {@link RestMethod#htmldoc() @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.
- *
+ *
* <p>
* For example, the following two methods for defining the HTML document title are considered equivalent:
* <p class='bcode'>
@@ -36,14 +36,14 @@ import org.apache.juneau.rest.widget.*;
* <ja>@Property</ja>(name=<jsf>HTMLDOC_title</jsf>, value=<js>"My Resource Page"</js>)
* }
* )
- *
+ *
* <ja>@RestResource</ja>(
* htmldoc=<ja>@HtmlDoc</ja>(
* title=<js>"My Resource Page"</js>
* )
* )
* </p>
- *
+ *
* <p>
* The purpose of these annotation is to populate the HTML document view which by default consists of the following
* structure:
@@ -78,13 +78,13 @@ public @interface HtmlDoc {
/**
* Sets the HTML aside section contents.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* The aside section typically floats on the right side of the page.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -95,7 +95,7 @@ public @interface HtmlDoc {
* )
* )
* </p>
- *
+ *
* <h6 class='topic'>Other Notes</h6>
* <ul class='spaced-list'>
* <li>
@@ -120,13 +120,13 @@ public @interface HtmlDoc {
/**
* Sets the HTML footer section contents.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* The footer section typically floats on the bottom of the page.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -137,7 +137,7 @@ public @interface HtmlDoc {
* )
* )
* </p>
- *
+ *
* <h6 class='topic'>Other Notes</h6>
* <ul class='spaced-list'>
* <li>
@@ -162,10 +162,10 @@ public @interface HtmlDoc {
/**
* Adds arbitrary content to the HTML <xt><head></xt> element on the page.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -173,14 +173,14 @@ public @interface HtmlDoc {
* head={
* <jc>// Add a shortcut link in the browser tab</jc>
* <js>"<link rel='icon' href='$U{servlet:/htdocs/mypageicon.ico}'>"</js>,
- *
+ *
* <jc>// Reload the page every 5 seconds </jc>
* <js>"<meta http-equiv='refresh' content='5'>"</js>
* }
* )
* )
* </p>
- *
+ *
* <h6 class='topic'>Other Notes</h6>
* <ul class='spaced-list'>
* <li>
@@ -203,14 +203,14 @@ public @interface HtmlDoc {
/**
* Sets the HTML header section contents.
- *
+ *
* <p>
* 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -221,7 +221,7 @@ public @interface HtmlDoc {
* )
* )
* </p>
- *
+ *
* <h6 class='topic'>Other Notes</h6>
* <ul class='spaced-list'>
* <li>
@@ -246,16 +246,16 @@ public @interface HtmlDoc {
/**
* Sets the HTML nav section contents.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* The nav section of the page contains the links.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -266,7 +266,7 @@ public @interface HtmlDoc {
* )
* )
* </p>
- *
+ *
* <h6 class='topic'>Other Notes</h6>
* <ul class='spaced-list'>
* <li>
@@ -293,7 +293,7 @@ public @interface HtmlDoc {
/**
* Sets the links in the HTML nav section.
- *
+ *
* <p>
* The value is an array of strings with two possible values:
* <ul>
@@ -301,10 +301,10 @@ public @interface HtmlDoc {
* <br><js>"google: http://google.com"</js>
* <li>Arbitrary HTML.
* </ul>
- *
+ *
* <p>
* The page links are positioned immediately under the title and text.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -316,7 +316,7 @@ public @interface HtmlDoc {
* )
* )
* </p>
- *
+ *
* <h6 class='topic'>Other Notes</h6>
* <ul class='spaced-list'>
* <li>
@@ -348,7 +348,7 @@ public @interface HtmlDoc {
/**
* Shorthand method for forcing the rendered HTML content to be no-wrap.
- *
+ *
* <p>
* This only applies to the rendered data portion of the page.
*/
@@ -356,10 +356,10 @@ public @interface HtmlDoc {
/**
* Sets the HTML script section contents.
- *
+ *
* <p>
* The format of this value is Javascript.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -370,7 +370,7 @@ public @interface HtmlDoc {
* )
* )
* </p>
- *
+ *
* <h6 class='topic'>Other Notes</h6>
* <ul class='spaced-list'>
* <li>
@@ -395,10 +395,10 @@ public @interface HtmlDoc {
/**
* Sets the HTML CSS style section contents.
- *
+ *
* <p>
* The format of this value is CSS.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -410,7 +410,7 @@ public @interface HtmlDoc {
* )
* )
* </p>
- *
+ *
* <h6 class='topic'>Other Notes</h6>
* <ul class='spaced-list'>
* <li>
@@ -435,16 +435,16 @@ public @interface HtmlDoc {
/**
* Sets the CSS URL in the HTML CSS style section.
- *
+ *
* <p>
* The format of this value is a URL.
- *
+ *
* <p>
* 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -453,7 +453,7 @@ public @interface HtmlDoc {
* )
* )
* </p>
- *
+ *
* <h6 class='topic'>Other Notes</h6>
* <ul class='spaced-list'>
* <li>
@@ -473,11 +473,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.
- *
+ *
* <h6 class='topic'>Other Notes</h6>
* <ul class='spaced-list'>
* <li>
@@ -493,7 +493,7 @@ public @interface HtmlDoc {
/**
* Configuration property: HTML Widgets.
- *
+ *
* <p>
* Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly
* generate arbitrary replacement text.
@@ -508,11 +508,11 @@ public @interface HtmlDoc {
* <br>The styles contents are automatically inserted into the <xt><head/style></xt> section
* in the HTML page.
* </ul>
- *
+ *
* <p>
* The following examples shows how to associate a widget with a REST method and then have it rendered in the links
* and aside section of the page:
- *
+ *
* <p class='bcode'>
* <ja>@RestMethod</ja>(
* widgets={
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Messages.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Messages.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Messages.java
index 413ccdf..6bf6043 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Messages.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Messages.java
@@ -23,10 +23,10 @@ import org.apache.juneau.utils.*;
/**
* Annotation that can be applied to a parameter of a {@link RestMethod @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}.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>)
@@ -34,7 +34,7 @@ import org.apache.juneau.utils.*;
* <jk>return</jk> messages.getString(<js>"myLocalizedMessage"</js>);
* }
* </p>
- *
+ *
* <p>
* This is functionally equivalent to the following code...
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Method.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Method.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Method.java
index 06effcd..75b4702 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Method.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Method.java
@@ -20,10 +20,10 @@ import java.lang.annotation.*;
/**
* Annotation that can be applied to a parameter of a {@link RestMethod @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).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"*"</js>)
@@ -31,7 +31,7 @@ import java.lang.annotation.*;
* ...
* }
* </p>
- *
+ *
* <p>
* This is functionally equivalent to the following code...
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java
index 19fb015..e495760 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/MethodSwagger.java
@@ -21,15 +21,15 @@ public @interface MethodSwagger {
/**
* Optional deprecated flag for the exposed API.
- *
+ *
* <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>).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -38,11 +38,11 @@ public @interface MethodSwagger {
* )
* )
* </p>
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* Corresponds to the swagger field <code>/paths/{path}/{method}/deprecated</code>.
*/
@@ -50,10 +50,10 @@ public @interface MethodSwagger {
/**
* Optional external documentation information for the exposed API.
- *
+ *
* <p>
* Used to populate the Swagger external documentation field.
- *
+ *
* <p>
* A simplified JSON string with the following fields:
* <p class='bcode'>
@@ -62,13 +62,13 @@ public @interface MethodSwagger {
* url: string
* }
* </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>).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -77,11 +77,11 @@ public @interface MethodSwagger {
* )
* )
* </p>
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* Corresponds to the swagger field <code>/paths/{path}/{method}/externalDocs</code>.
*/
@@ -89,11 +89,11 @@ 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -109,7 +109,7 @@ public @interface MethodSwagger {
* )
* )
* </p>
- *
+ *
* <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.
@@ -120,15 +120,15 @@ 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>
- *
+ *
* <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.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* Corresponds to the swagger field <code>/paths/{path}/{method}/parameters</code>.
*/
@@ -136,11 +136,11 @@ 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -159,7 +159,7 @@ public @interface MethodSwagger {
* )
* )
* </p>
- *
+ *
* <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.
@@ -168,11 +168,11 @@ public @interface MethodSwagger {
* <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>
- *
+ *
* <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.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
@@ -181,19 +181,19 @@ public @interface MethodSwagger {
/**
* Optional tagging information for the exposed API.
- *
+ *
* <p>
* Used to populate the Swagger tags field.
- *
+ *
* <p>
* 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>).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -202,11 +202,11 @@ public @interface MethodSwagger {
* )
* )
* </p>
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* Corresponds to the swagger field <code>/paths/{path}/{method}/tags</code>.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Parameter.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
index 80ab366..ed8cdb0 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
@@ -20,7 +20,7 @@ import java.lang.annotation.*;
/**
* Annotation used in conjunction with {@link MethodSwagger#parameters() @MethodSwagger.parameters()} to identify
* content and header descriptions on specific method requests.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -44,7 +44,7 @@ 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.
@@ -57,7 +57,7 @@ public @interface Parameter {
/**
* 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.
@@ -67,7 +67,7 @@ public @interface Parameter {
/**
* Determines the format of the array if type array is used.
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -85,13 +85,13 @@ public @interface Parameter {
/**
* Parameter description (e.g. <js>"Indicates the range returned when Range header is present in the request"</js>).
- *
+ *
* <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.
- *
+ *
* <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
@@ -101,7 +101,7 @@ public @interface Parameter {
/**
* 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.
@@ -110,7 +110,7 @@ public @interface Parameter {
/**
* The location of the parameter.
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -125,10 +125,10 @@ public @interface Parameter {
/**
* Required if <code>type</code> is <js>"array"</js>.
- *
+ *
* <p>
* Describes the type of items in the array.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -142,7 +142,7 @@ public @interface Parameter {
* )
* <jk>public void</jk> doAnything() {
* </p>
- *
+ *
* <p>
* See <a class="doclink" href="http://swagger.io/specification/#itemsObject">Items Object</a> for further details.
*/
@@ -150,7 +150,7 @@ 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
@@ -164,7 +164,7 @@ public @interface Parameter {
/**
* Determines whether this parameter is mandatory.
- *
+ *
* <p>
* If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be <jk>true</jk>.
* Otherwise, the property MAY be included and its default value is <jk>false</jk>.
@@ -173,13 +173,13 @@ public @interface Parameter {
/**
* The schema defining the type used for the body 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>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -197,7 +197,7 @@ 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>.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Path.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Path.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Path.java
index b3dc143..da72d23 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Path.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Path.java
@@ -22,7 +22,7 @@ import org.apache.juneau.httppart.*;
/**
* Annotation that can be applied to a parameter of a {@link RestMethod @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'>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/myurl/{foo}/{bar}/{baz}/*"</js>)
@@ -31,7 +31,7 @@ import org.apache.juneau.httppart.*;
* ...
* }
* </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
@@ -44,7 +44,7 @@ import org.apache.juneau.httppart.*;
* ...
* }
* </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).
@@ -57,7 +57,7 @@ import org.apache.juneau.httppart.*;
* ...
* }
* </p>
- *
+ *
* <p>
* You can also use <code>{#}</code> notation to specify path parameters without specifying names.
* <p class='bcode'>
@@ -76,7 +76,7 @@ public @interface Path {
/**
* URL path variable name.
- *
+ *
* <p>
* Optional if the attributes are specified in the same order as in the URL path pattern.
*/
@@ -84,7 +84,7 @@ public @interface Path {
/**
* Specifies the {@link HttpPartParser} class used for parsing values from strings.
- *
+ *
* <p>
* The default value for this parser is inherited from the servlet/method which defaults to {@link UonPartParser}.
* <br>You can use {@link SimplePartParser} to parse POJOs that are directly convertible from <code>Strings</code>.
@@ -93,7 +93,7 @@ public @interface Path {
/**
* A synonym for {@link #name()}.
- *
+ *
* <p>
* Allows you to use shortened notation if you're only specifying the name.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java
index 377c166..375cb75 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java
@@ -20,7 +20,7 @@ import java.lang.annotation.*;
/**
* Annotation that can be applied to a parameter of a {@link RestMethod @RestMethod} annotated method to identify it as the URL
* parameter remainder after a path pattern match.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/foo/*"</js>)
@@ -28,7 +28,7 @@ import java.lang.annotation.*;
* ...
* }
* </p>
- *
+ *
* <p>
* This is functionally equivalent to the following code...
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Properties.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Properties.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Properties.java
index 018d5fe..92d5049 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Properties.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Properties.java
@@ -22,7 +22,7 @@ import org.apache.juneau.*;
/**
* Annotation that can be applied to a parameter of a {@link RestMethod @RestMethod} annotated method to identify the
* request-duration properties object for the current request.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>)
@@ -31,7 +31,7 @@ import org.apache.juneau.*;
* ...
* }
* </p>
- *
+ *
* <p>
* This is functionally equivalent to the following code...
* <p class='bcode'>
@@ -42,7 +42,7 @@ import org.apache.juneau.*;
* ...
* }
* </p>
- *
+ *
* <p>
* ...or this...
* <p class='bcode'>
@@ -52,7 +52,7 @@ import org.apache.juneau.*;
* ...
* }
* </p>
- *
+ *
* <p>
* The parameter type can be one of the following:
* <ul>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Property.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Property.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Property.java
index 8c4e150..7f49fbc 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Property.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Property.java
@@ -19,14 +19,14 @@ import java.lang.annotation.*;
/**
* Property name/value pair used in the {@link RestResource#properties() @RestResource.properties()} annotation.
- *
+ *
* <p>
* Any of the properties defined on any of the serializers or parsers can be defined.
- *
+ *
* <p>
* 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/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Query.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Query.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Query.java
index 3f10875..a210030 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Query.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Query.java
@@ -23,13 +23,13 @@ import org.apache.juneau.rest.*;
/**
* 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>)
@@ -38,7 +38,7 @@ import org.apache.juneau.rest.*;
* ...
* }
* </p>
- *
+ *
* <p>
* This is functionally equivalent to the following code...
* <p class='bcode'>
@@ -64,13 +64,13 @@ 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>.
* This annotation allows the use of multi-part parameters to represent collections
* (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.
*/
@@ -83,7 +83,7 @@ public @interface Query {
/**
* Specifies the {@link HttpPartParser} class used for parsing values from strings.
- *
+ *
* <p>
* The default value for this parser is inherited from the servlet/method which defaults to {@link UonPartParser}.
* <br>You can use {@link SimplePartParser} to parse POJOs that are directly convertible from <code>Strings</code>.
@@ -92,7 +92,7 @@ public @interface Query {
/**
* A synonym for {@link #name()}.
- *
+ *
* <p>
* Allows you to use shortened notation if you're only specifying the name.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java
index f536ba2..0709af4 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/ResourceSwagger.java
@@ -21,10 +21,10 @@ public @interface ResourceSwagger {
/**
* Optional contact information for the exposed API.
- *
+ *
* <p>
* It is used to populate the Swagger contact field and to display on HTML pages.
- *
+ *
* <p>
* A simplified JSON string with the following fields:
* <p class='bcode'>
@@ -34,12 +34,12 @@ public @interface ResourceSwagger {
* email: string
* }
* </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>).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -48,14 +48,14 @@ public @interface ResourceSwagger {
* )
* )
* </p>
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* Corresponds to the swagger field <code>/info/contact</code>.
- *
+ *
* <p>
* The programmatic equivalent to this annotation is the {@link RestInfoProvider#getContact(RestRequest)} method.
*/
@@ -63,10 +63,10 @@ public @interface ResourceSwagger {
/**
* Optional external documentation information for the exposed API.
- *
+ *
* <p>
* It is used to populate the Swagger external documentation field and to display on HTML pages.
- *
+ *
* <p>
* A simplified JSON string with the following fields:
* <p class='bcode'>
@@ -75,12 +75,12 @@ public @interface ResourceSwagger {
* url: string
* }
* </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>).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -89,14 +89,14 @@ public @interface ResourceSwagger {
* )
* )
* </p>
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* Corresponds to the swagger field <code>/tags</code>.
- *
+ *
* <p>
* The programmatic equivalent to this annotation is the {@link RestInfoProvider#getExternalDocs(RestRequest)}
* method.
@@ -105,10 +105,10 @@ public @interface ResourceSwagger {
/**
* Optional license information for the exposed API.
- *
+ *
* <p>
* It is used to populate the Swagger license field and to display on HTML pages.
- *
+ *
* <p>
* A simplified JSON string with the following fields:
* <p class='bcode'>
@@ -117,12 +117,12 @@ public @interface ResourceSwagger {
* url: string
* }
* </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>).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -131,14 +131,14 @@ public @interface ResourceSwagger {
* )
* )
* </p>
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* Corresponds to the swagger field <code>/info/license</code>.
- *
+ *
* <p>
* The programmatic equivalent to this annotation is the {@link RestInfoProvider#getLicense(RestRequest)} method.
*/
@@ -146,10 +146,10 @@ public @interface ResourceSwagger {
/**
* Optional tagging information for the exposed API.
- *
+ *
* <p>
* It is used to populate the Swagger tags field and to display on HTML pages.
- *
+ *
* <p>
* A simplified JSON string with the following fields:
* <p class='bcode'>
@@ -164,12 +164,12 @@ 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>).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -178,14 +178,14 @@ public @interface ResourceSwagger {
* )
* )
* </p>
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* Corresponds to the swagger field <code>/tags</code>.
- *
+ *
* <p>
* The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTags(RestRequest)} method.
*/
@@ -193,21 +193,21 @@ public @interface ResourceSwagger {
/**
* Optional servlet terms-of-service for this API.
- *
+ *
* <p>
* 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>).
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* Corresponds to the swagger field <code>/info/termsOfService</code>.
- *
+ *
* <p>
* The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTermsOfService(RestRequest)}
* method.
@@ -216,21 +216,21 @@ public @interface ResourceSwagger {
/**
* Provides the version of the application API (not to be confused with the specification version).
- *
+ *
* <p>
* 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>).
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* Corresponds to the swagger field <code>/info/version</code>.
- *
+ *
* <p>
* The programmatic equivalent to this annotation is the {@link RestInfoProvider#getVersion(RestRequest)} method.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Response.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Response.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Response.java
index 9ef71ad..e9dd934 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Response.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Response.java
@@ -21,7 +21,7 @@ import org.apache.juneau.rest.*;
/**
* Annotation used in conjunction with {@link MethodSwagger#responses() @MethodSwagger.responses()} to identify possible responses by the method.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -47,16 +47,16 @@ 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>).
- *
+ *
* <p>
* This field can contain variables (e.g. "$L{my.localized.variable}").
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* Corresponds to the swagger field <code>/paths/{path}/{method}/responses/{code}/description</code>.
*/
@@ -64,7 +64,7 @@ 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
@@ -74,14 +74,14 @@ public @interface Response {
/**
* A definition of the response structure.
- *
+ *
* <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>.
* This SHOULD be accompanied by a relevant produces mime-type.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestHook.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestHook.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestHook.java
index c3bb713..b1556cd 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestHook.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestHook.java
@@ -20,29 +20,29 @@ import java.lang.annotation.*;
/**
* Identifies Java methods on a resource/servlet class that get invoked during particular lifecycle events of
* the servlet or REST call.
- *
+ *
* <p>
* For example, if you want to add an initialization method to your resource:
* <p class='bcode'>
* <ja>@RestResource</ja>(...)
* <jk>public class</jk> MyResource {
- *
+ *
* <jc>// Our database.</jc>
* <jk>private</jk> Map<Integer,Object> <jf>myDatabase</jf>;
- *
+ *
* <ja>@RestHook</ja>(<jsf>INIT</jsf>)
* <jk>public void</jk> initMyDatabase(RestContextBuilder builder) <jk>throws</jk> Exception {
* <jf>myDatabase</jf> = <jk>new</jk> LinkedHashMap<>();
* }
* }
* </p>
- *
+ *
* <p>
* Or if you want to intercept REST calls:
* <p class='bcode'>
* <ja>@RestResource</ja>(...)
* <jk>public class</jk> MyResource {
- *
+ *
* <jc>// Add a request attribute to all incoming requests.</jc>
* <ja>@RestHook</ja>(<jsf>PRE_CALL</jsf>)
* <jk>public void</jk> onPreCall(RestRequest req) {
@@ -50,7 +50,7 @@ import java.lang.annotation.*;
* }
* }
* </p>
- *
+ *
* <p>
* The hook events can be broken down into two categories:
* <ul class='spaced-list'>
@@ -69,7 +69,7 @@ import java.lang.annotation.*;
* <li>{@link HookEvent#END_CALL END_CALL} - At the end of the REST call after the response has been flushed.
* </ul>
* </ul>
- *
+ *
* <p>
* See the {@link HookEvent} class for information about individual event types.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
index c933f68..d1b35bb 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
@@ -50,41 +50,41 @@ 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.
- *
+ *
* <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:
* <p class='bcode'>
* <jc>// Our bean</jc>
* <jk>public class</jk> MyBean {
- *
+ *
* <jc>// Summary properties</jc>
* <ja>@Html</ja>(link=<js>"servlet:/mybeans/{id}"</js>)
* <jk>public</jk> String <jf>id</jf>;
- *
+ *
* <jc>// Detail properties</jc>
* <jk>public</jk> String <jf>a</jf>, <jf>b</jf>;
* }
- *
+ *
* <jc>// Only render "id" property.</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/mybeans"</js>, bpi=<js>"MyBean: id"</js>)
* <jk>public</jk> List<MyBean> getBeanSummary();
- *
+ *
* <jc>// Only render "a" and "b" properties.</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/mybeans/{id}"</js>, bpi=<js>"MyBean: a,b"</js>)
* <jk>public</jk> MyBean getBeanDetails(<ja>@Path</ja> String id);
* </p>
- *
+ *
* <p>
* The format of each value is: <js>"Key: comma-delimited-tokens"</js>.
* <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.
- *
+ *
* <p>
* Semicolons can be used as an additional separator for multiple values:
* <p class='bcode'>
@@ -102,40 +102,40 @@ public @interface RestMethod {
/**
* Shortcut for specifying the {@link BeanContext#BEAN_excludeProperties} property on all serializers.
- *
+ *
* <p>
* Same as {@link #bpi()} except you specify a list of bean property names that you want to exclude from
* serialization.
- *
+ *
* <p>
* In the example below, our 'summary' view is a list of beans where we want to exclude some properties:
* <p class='bcode'>
* <jc>// Our bean</jc>
* <jk>public class</jk> MyBean {
- *
+ *
* <jc>// Summary properties</jc>
* <ja>@Html</ja>(link=<js>"servlet:/mybeans/{id}"</js>)
* <jk>public</jk> String <jf>id</jf>;
- *
+ *
* <jc>// Detail properties</jc>
* <jk>public</jk> String <jf>a</jf>, <jf>b</jf>;
* }
- *
+ *
* <jc>// Don't show "a" and "b" properties.</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/mybeans"</js>, bpx=<js>"MyBean: a,b"</js>)
* <jk>public</jk> List<MyBean> getBeanSummary();
- *
+ *
* <jc>// Render all properties.</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/mybeans/{id}"</js>)
* <jk>public</jk> MyBean getBeanDetails(<ja>@Path</ja> String id);
* </p>
- *
+ *
* <p>
* The format of each value is: <js>"Key: comma-delimited-tokens"</js>.
* <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.
- *
+ *
* <p>
* Semicolons can be used as an additional separator for multiple values:
* <p class='bcode'>
@@ -153,18 +153,18 @@ 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() @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.
- *
+ *
* <p>
* The format of the client version range is similar to that of OSGi versions.
- *
+ *
* <p>
* In the following example, the Java methods are mapped to the same HTTP method and URL <js>"/foobar"</js>.
* <p class='bcode'>
@@ -174,20 +174,20 @@ public @interface RestMethod {
* <jk>public</jk> Object method1() {
* ...
* }
- *
+ *
* <jc>// Call this method if X-Client-Version is at least 1.1, but less than 2.0.</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/foobar"</js>, clientVersion=<js>"[1.1,2.0)"</js>)
* <jk>public</jk> Object method2() {
* ...
* }
- *
+ *
* <jc>// Call this method if X-Client-Version is less than 1.1.</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/foobar"</js>, clientVersion=<js>"[0,1.1)"</js>)
* <jk>public</jk> Object method3() {
* ...
* }
* </p>
- *
+ *
* <p>
* It's common to combine the client version with transforms that will convert new POJOs into older POJOs for
* backwards compatibility.
@@ -197,13 +197,13 @@ public @interface RestMethod {
* <jk>public</jk> NewPojo newMethod() {
* ...
* }
- *
+ *
* <jc>// Call this method if X-Client-Version is at least 1.1, but less than 2.0.</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/foobar"</js>, clientVersion=<js>"[1.1,2.0)"</js>, transforms={NewToOldPojoSwap.<jk>class</jk>})
* <jk>public</jk> NewPojo oldMethod() {
* <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.
@@ -219,7 +219,7 @@ public @interface RestMethod {
/**
* Class-level response converters.
- *
+ *
* <p>
* Associates one or more {@link RestConverter converters} with this method.
*
@@ -235,7 +235,7 @@ public @interface RestMethod {
*
* <p>
* The default character encoding for the request and response if not specified on the request.
- *
+ *
* <p>
* Value can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -255,14 +255,14 @@ public @interface RestMethod {
/**
* Specifies default values for form-data parameters.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<jsf>POST</jsf>, path=<js>"/*"</js>, defaultFormData={<js>"foo=bar"</js>})
@@ -270,7 +270,7 @@ public @interface RestMethod {
* ...
* }
* </p>
- *
+ *
* <p>
* You can use either <js>':'</js> or <js>'='</js> as the key/value delimiter.
* Key and value is trimmed of whitespace.
@@ -289,13 +289,13 @@ public @interface RestMethod {
/**
* Specifies default values for query parameters.
- *
+ *
* <p>
* Strings are of the format <js>"name=value"</js>.
- *
+ *
* <p>
* Affects values returned by {@link RestRequest#getQuery(String)} when the parameter is not present on the request.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/*"</js>, defaultQuery={<js>"foo=bar"</js>})
@@ -303,7 +303,7 @@ public @interface RestMethod {
* ...
* }
* </p>
- *
+ *
* <p>
* You can use either <js>':'</js> or <js>'='</js> as the key/value delimiter.
* Key and value is trimmed of whitespace.
@@ -325,7 +325,7 @@ public @interface RestMethod {
*
* <p>
* Specifies default values for request headers.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Assume "text/json" Accept value when Accept not specified</jc>
@@ -356,7 +356,7 @@ public @interface RestMethod {
/**
* Optional description for the exposed API.
- *
+ *
* <p>
* This description is used in the following locations:
* <ul class='spaced-list'>
@@ -367,12 +367,12 @@ public @interface RestMethod {
* <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>).
- *
+ *
* <p>
* Value can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -403,7 +403,7 @@ public @interface RestMethod {
/**
* Compression encoders.
- *
+ *
* <p>
* Use this annotation when the list of encoders assigned to a method differs from the list of encoders assigned at
* the servlet level.
@@ -423,7 +423,7 @@ public @interface RestMethod {
/**
* Shortcut for setting {@link #properties()} of simple boolean types.
- *
+ *
* <p>
* Setting a flag is equivalent to setting the same property to <js>"true"</js>.
*/
@@ -431,7 +431,7 @@ public @interface RestMethod {
/**
* Method-level guards.
- *
+ *
* <p>
* Associates one or more {@link RestGuard RestGuards} with this method.
*
@@ -444,7 +444,7 @@ public @interface RestMethod {
/**
* Provides HTML-doc-specific metadata on this method.
- *
+ *
* <p>
* Information provided here overrides information provided in the servlet-level annotation.
*/
@@ -463,7 +463,7 @@ public @interface RestMethod {
* <li>"ENCODERS" - Inherit class-level encoders.
* <li>"*" - Inherit everything.
* </ul>
- *
+ *
* <p>
* For example, to inherit all parsers, properties, and transforms from the servlet class:
* <p class='bcode'>
@@ -478,14 +478,14 @@ public @interface RestMethod {
/**
* Method matchers.
- *
+ *
* <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.
- *
+ *
* <p>
* See {@link RestMatcher} for more information.
*/
@@ -493,7 +493,7 @@ public @interface RestMethod {
/**
* The maximum allowed input size (in bytes) on HTTP requests.
- *
+ *
* <p>
* Useful for alleviating DoS attacks by throwing an exception when too much input is received instead of resulting
* in out-of-memory errors which could affect system stability.
@@ -524,16 +524,16 @@ public @interface RestMethod {
/**
* REST method name.
- *
+ *
* <p>
* Typically <js>"GET"</js>, <js>"PUT"</js>, <js>"POST"</js>, <js>"DELETE"</js>, or <js>"OPTIONS"</js>.
- *
+ *
* <p>
* Method names are case-insensitive (always folded to upper-case).
- *
+ *
* <p>
* Note that you can use {@link org.apache.juneau.http.HttpMethodName} for constant values.
- *
+ *
* <p>
* Besides the standard HTTP method names, the following can also be specified:
* <ul class='spaced-list'>
@@ -570,20 +570,20 @@ public @interface RestMethod {
/**
* Parsers.
- *
+ *
* <p>
* 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.
- *
+ *
* <p>
* To append to the list of parsers assigned at the servlet level, use <code>inherit=<js>"PARSERS"</js></code>.
- *
+ *
* <p class='bcode'>
* <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {
- *
+ *
* <ja>@RestMethod</ja>(
* name=<jsf>PUT</jsf>,
* path=<js>"/foo"</js>,
@@ -605,22 +605,22 @@ 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.
- *
+ *
* <p>
* The path can contain variables that get resolved to {@link Path @Path} parameters:
* <p class='bcode'>
* <jc>// Example 1</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/myurl/{foo}/{bar}/{baz}/*"</js>)
- *
+ *
* <jc>// Example 2</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/myurl/{0}/{1}/{2}/*"</js>)
* </p>
- *
+ *
* <p>
* Refer to {@link Path @Path} on how path variables get resolved.
*/
@@ -638,10 +638,10 @@ public @interface RestMethod {
/**
* URL path pattern priority.
- *
+ *
* <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.
*/
@@ -649,7 +649,7 @@ public @interface RestMethod {
/**
* Same as {@link RestResource#properties() @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.
@@ -658,21 +658,21 @@ public @interface RestMethod {
/**
* Serializers.
- *
+ *
* <p>
* 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.
*
* <p>
* To append to the list of serializers assigned at the servlet level, use <code>inherit=<js>"SERIALIZERS"</js></code>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {
- *
+ *
* <ja>@RestMethod</ja>(
* name=<jsf>GET</jsf>,
* path=<js>"/foo"</js>,
@@ -694,7 +694,7 @@ public @interface RestMethod {
/**
* Optional summary for the exposed API.
- *
+ *
* <p>
* This summary is used in the following locations:
* <ul class='spaced-list'>
@@ -705,11 +705,11 @@ public @interface RestMethod {
* <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>).
- *
+ *
* <p>
* Value can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -732,7 +732,7 @@ public @interface RestMethod {
* {@link UrlVar $U}
* {@link UrlEncodeVar $UE}
* {@link WidgetVar $W}
- *
+ *
* <p>
* Corresponds to the swagger field <code>/paths/{path}/{method}/summary</code>.
*/
@@ -740,7 +740,7 @@ public @interface RestMethod {
/**
* Supported accept media types.
- *
+ *
* <p>
* Overrides the media types inferred from the serializers that identify what media types can be produced by the resource.
*
@@ -763,7 +763,7 @@ public @interface RestMethod {
/**
* Supported content media types.
- *
+ *
* <p>
* Overrides the media types inferred from the parsers that identify what media types can be consumed by the resource.
*
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
index c127d2b..6b829a9 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestResource.java
@@ -30,11 +30,11 @@ import org.apache.juneau.utils.*;
/**
* 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.
- *
+ *
* Refer to <a class='doclink' href='../package-summary.html#TOC'>org.apache.juneau.rest</a> doc for information on
* using this class.
*/
@@ -46,7 +46,7 @@ public @interface RestResource {
/**
* Allow body URL parameter.
- *
+ *
* <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.
@@ -72,13 +72,13 @@ public @interface RestResource {
/**
* Allowed method parameters.
- *
+ *
* <p>
* When specified, the HTTP method can be overridden by passing in a <js>"method"</js> URL parameter on a regular
* GET request.
* <br>
* For example: <js>"?method=OPTIONS"</js>
- *
+ *
* <p>
* Value can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -98,7 +98,7 @@ public @interface RestResource {
/**
* Allow header URL parameters.
- *
+ *
* <p>
* When enabled, headers such as <js>"Accept"</js> and <js>"Content-Type"</js> to be passed in as URL query
* parameters.
@@ -123,7 +123,7 @@ public @interface RestResource {
/**
* Class-level bean filters.
- *
+ *
* <p>
* Shortcut to add bean filters to the bean contexts of the objects returned by the following methods:
* <ul>
@@ -131,7 +131,7 @@ public @interface RestResource {
* <li>{@link RestContext#getSerializers()}
* <li>{@link RestContext#getParsers()}
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanFilters}
@@ -141,7 +141,7 @@ public @interface RestResource {
/**
* REST call handler.
- *
+ *
* <p>
* This class handles the basic lifecycle of an HTTP REST call.
*
@@ -154,10 +154,10 @@ public @interface RestResource {
/**
* Children.
- *
+ *
* <p>
* Defines children of this resource.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_children}
@@ -167,7 +167,7 @@ public @interface RestResource {
/**
* Classpath resource finder.
- *
+ *
* <p>
* Used to retrieve localized files from the classpath.
*
@@ -180,7 +180,7 @@ public @interface RestResource {
/**
* Client version header.
- *
+ *
* <p>
* Specifies the name of the header used to denote the client version on HTTP requests.
*
@@ -193,7 +193,7 @@ public @interface RestResource {
* {@link IfVar $IF}
* {@link SystemPropertiesVar $S}
* {@link SwitchVar $SW}
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_clientVersionHeader}
@@ -203,10 +203,10 @@ public @interface RestResource {
/**
* Optional location of configuration file for this servlet.
- *
+ *
* <p>
* The configuration file .
- *
+ *
* <p>
* Value can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -216,7 +216,7 @@ public @interface RestResource {
* {@link IfVar $IF}
* {@link SystemPropertiesVar $S}
* {@link SwitchVar $SW}
- *
+ *
* <p>
* The programmatic equivalent to this annotation is the {@link RestContextBuilder#configFile(ConfigFile)} method.
*/
@@ -247,12 +247,12 @@ public @interface RestResource {
/**
* Class-level response 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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_converters}
@@ -275,7 +275,7 @@ public @interface RestResource {
* {@link IfVar $IF}
* {@link SystemPropertiesVar $S}
* {@link SwitchVar $SW}
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_defaultCharset}
@@ -288,7 +288,7 @@ public @interface RestResource {
*
* <p>
* Specifies default values for request headers.
- *
+ *
* <p>
* Values can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -308,10 +308,10 @@ public @interface RestResource {
/**
* Default response headers.
- *
+ *
* <p>
* Specifies default values for response headers.
- *
+ *
* <p>
* Values can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -331,15 +331,15 @@ public @interface RestResource {
/**
* Optional servlet description.
- *
+ *
* <p>
* It is used to populate the Swagger description field.
* 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>).
- *
+ *
* <p>
* Value can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -362,10 +362,10 @@ public @interface RestResource {
* {@link UrlVar $U}
* {@link UrlEncodeVar $UE}
* {@link WidgetVar $W}
- *
+ *
* <p>
* Corresponds to the swagger field <code>/info/description</code>.
- *
+ *
* <p>
* The programmatic equivalent to this annotation is the {@link RestInfoProvider#getDescription(RestRequest)} method.
*/
@@ -373,10 +373,10 @@ public @interface RestResource {
/**
* Compression encoders.
- *
+ *
* <p>
* These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_encoders}
@@ -386,7 +386,7 @@ public @interface RestResource {
/**
* Shortcut for setting {@link #properties()} of simple boolean types.
- *
+ *
* <p>
* Values can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -404,11 +404,11 @@ public @interface RestResource {
/**
* Class-level guards.
- *
+ *
* <p>
* 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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_guards}
@@ -418,13 +418,13 @@ public @interface RestResource {
/**
* Provides HTML-doc-specific metadata on this method.
- *
+ *
* <p>
* Used to customize the output from the HTML Doc serializer.
* <p class='bcode'>
* <ja>@RestResource</ja>(
* path=<js>"/addressBook"</js>,
- *
+ *
* <jc>// Links on the HTML rendition page.
* // "request:/..." URIs are relative to the request URI.
* // "servlet:/..." URIs are relative to the servlet URI.
@@ -465,7 +465,7 @@ public @interface RestResource {
*
* <p>
* Class used to retrieve title/description/swagger information about a resource.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_infoProvider}
@@ -478,7 +478,7 @@ public @interface RestResource {
*
* <p>
* Specifies the logger to use for logging.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_logger}
@@ -488,7 +488,7 @@ public @interface RestResource {
/**
* The maximum allowed input size (in bytes) on HTTP requests.
- *
+ *
* <p>
* Useful for alleviating DoS attacks by throwing an exception when too much input is received instead of resulting
* in out-of-memory errors which could affect system stability.
@@ -514,7 +514,7 @@ public @interface RestResource {
* Messages.
*
* Identifies the location of the resource bundle for this class.
- *
+ *
* <p>
* Value can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -534,7 +534,7 @@ public @interface RestResource {
/**
* Configuration property: MIME types.
- *
+ *
* <p>
* Defines MIME-type file type mappings.
*
@@ -557,12 +557,12 @@ public @interface RestResource {
/**
* Java method parameter resolvers.
- *
+ *
* <p>
* By default, the Juneau framework will automatically Java method parameters of various types (e.g.
* <code>RestRequest</code>, <code>Accept</code>, <code>Reader</code>).
* This setting allows you to provide your own resolvers for your own class types that you want resolved.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_paramResolvers}
@@ -575,7 +575,7 @@ public @interface RestResource {
*
* <p>
* Specifies the parser listener class to use for listening to non-fatal parsing errors.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_listener}
@@ -585,7 +585,7 @@ public @interface RestResource {
/**
* Parsers.
- *
+ *
* <p>
* Adds class-level parsers to this resource.
*
@@ -598,7 +598,7 @@ public @interface RestResource {
/**
* HTTP part parser.
- *
+ *
* <p>
* Specifies the {@link HttpPartParser} to use for parsing headers, query/form parameters, and URI parts.
*
@@ -611,10 +611,10 @@ public @interface RestResource {
/**
* HTTP part serializer.
- *
+ *
* <p>
* Specifies the {@link HttpPartSerializer} to use for serializing headers, query/form parameters, and URI parts.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_partSerializer}
@@ -624,10 +624,10 @@ public @interface RestResource {
/**
* Resource path.
- *
+ *
* <p>
* Identifies the URL subpath relative to the parent resource.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_path}
@@ -637,7 +637,7 @@ public @interface RestResource {
/**
* Class-level POJO swaps.
- *
+ *
* <p>
* Shortcut to add POJO swaps to the bean contexts of the objects returned by the following methods:
* <ul>
@@ -645,7 +645,7 @@ public @interface RestResource {
* <li>{@link RestContext#getSerializers()}
* <li>{@link RestContext#getParsers()}
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
@@ -655,7 +655,7 @@ public @interface RestResource {
/**
* Class-level properties.
- *
+ *
* <p>
* Shortcut for specifying class-level properties on this servlet to the objects returned by the following methods:
* <ul>
@@ -665,15 +665,15 @@ public @interface RestResource {
* </ul>
* <p>
* Any of the properties defined on {@link RestContext} or any of the serializers and parsers can be specified.
- *
+ *
* <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.
- *
+ *
* <p>
* Values can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -692,7 +692,7 @@ public @interface RestResource {
/**
* Render response stack traces in responses.
- *
+ *
* <p>
* Render stack traces in HTTP response bodies when errors occur.
*
@@ -705,7 +705,7 @@ public @interface RestResource {
* {@link IfVar $IF}
* {@link SystemPropertiesVar $S}
* {@link SwitchVar $SW}
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_renderResponseStackTraces}
@@ -728,11 +728,11 @@ public @interface RestResource {
/**
* Response handlers.
- *
+ *
* <p>
* 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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_responseHandlers}
@@ -745,7 +745,7 @@ public @interface RestResource {
*
* <p>
* Specifies the serializer listener class to use for listening to non-fatal serialization errors.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_listener}
@@ -755,7 +755,7 @@ public @interface RestResource {
/**
* Serializers.
- *
+ *
* <p>
* Adds class-level serializers to this resource.
*
@@ -768,13 +768,13 @@ public @interface RestResource {
/**
* Optional site name.
- *
+ *
* <p>
* The site name is intended to be a title that can be applied to the entire site.
- *
+ *
* <p>
* This value can be retrieved programmatically through the {@link RestRequest#getSiteName()} method.
- *
+ *
* <p>
* One possible use is if you want to add the same title to the top of all pages by defining a header on a
* common parent class like so:
@@ -786,7 +786,7 @@ public @interface RestResource {
* }
* )
* </p>
- *
+ *
* <p>
* Value can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -817,7 +817,7 @@ public @interface RestResource {
/**
* Static file response headers.
- *
+ *
* <p>
* Used to customize the headers on responses returned for statically-served files.
*
@@ -840,7 +840,7 @@ public @interface RestResource {
/**
* Static file mappings.
- *
+ *
* <p>
* Used to define paths and locations of statically-served files such as images or HTML documents.
*
@@ -863,7 +863,7 @@ public @interface RestResource {
/**
* Supported accept media types.
- *
+ *
* <p>
* Overrides the media types inferred from the serializers that identify what media types can be produced by the resource.
*
@@ -886,10 +886,10 @@ public @interface RestResource {
/**
* Supported content media types.
- *
+ *
* <p>
* Overrides the media types inferred from the parsers that identify what media types can be consumed by the resource.
- *
+ *
* <p>
* Values can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -909,15 +909,15 @@ public @interface RestResource {
/**
* Provides swagger-specific metadata on this resource.
- *
+ *
* <p>
* Used to populate the auto-generated OPTIONS swagger documentation.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
* path=<js>"/addressBook"</js>,
- *
+ *
* <jc>// Swagger info.</jc>
* swagger=<ja>@ResourceSwagger</ja>(
* contact=<js>"{name:'John Smith',email:'john@smith.com'}"</js>,
@@ -934,15 +934,15 @@ public @interface RestResource {
/**
* Optional servlet title.
- *
+ *
* <p>
* It is used to populate the Swagger title field.
* 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>).
- *
+ *
* <p>
* Value can contain any of the following variables:
* {@link ConfigFileVar $C}
@@ -965,10 +965,10 @@ public @interface RestResource {
* {@link UrlVar $U}
* {@link UrlEncodeVar $UE}
* {@link WidgetVar $W}
- *
+ *
* <p>
* Corresponds to the swagger field <code>/info/title</code>.
- *
+ *
* <p>
* The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTitle(RestRequest)} method.
*/
@@ -976,7 +976,7 @@ public @interface RestResource {
/**
* Configuration property: Use classpath resource caching.
- *
+ *
* <p>
* When enabled, resources retrieved via {@link RestRequest#getClasspathReaderResource(String, boolean)} (and related
* methods) will be cached in memory to speed subsequent lookups.
@@ -1000,7 +1000,7 @@ public @interface RestResource {
/**
* Use stack trace hashes.
- *
+ *
* <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.
@@ -1014,7 +1014,7 @@ public @interface RestResource {
* {@link IfVar $IF}
* {@link SystemPropertiesVar $S}
* {@link SwitchVar $SW}
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestContext#REST_useStackTraceHashes}
[03/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestGuard.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestGuard.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestGuard.java
index c68b563..e762d8d 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestGuard.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestGuard.java
@@ -18,47 +18,48 @@ import org.apache.juneau.rest.annotation.*;
/**
* REST method guard.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* 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() @RestResource.guards()} or
* {@link RestMethod#guards() @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>
- *
+ *
* 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.
- *
+ *
* <p>
* Guards must implement a no-args constructor.
- *
+ *
* <h6 class='topic'>Example usage:</h6>
* <p class='bcode'>
* <jk>public</jk> MyResource <jk>extends</jk> RestServlet {
- *
+ *
* <jc>// Delete method with guard that only allows Billy to call it.</jc>
* <ja>@RestMethod</ja>(name=<jsf>DELETE</jsf>, guards=BillyGuard.<jk>class</jk>)
* <jk>public</jk> doDelete(RestRequest req, RestResponse res) <jk>throws</jk> Exception {...}
* }
* </p>
- *
+ *
* <h6 class='topic'>Example implementation:</h6>
* <p class='bcode'>
* <jc>// Define a guard that only lets Billy make a request</jc>
* <jk>public</jk> BillyGuard <jk>extends</jk> RestGuard {
- *
+ *
* <ja>@Override</ja>
* <jk>public boolean</jk> isRequestAllowed(RestRequest req) {
* return req.getUserPrincipal().getName().contains(<js>"Billy"</js>);
@@ -70,14 +71,14 @@ public abstract class RestGuard {
/**
* 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>.
- *
+ *
* <p>
* 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.
* @throws RestException Thrown to abort processing on current request.
@@ -93,7 +94,7 @@ public abstract class RestGuard {
/**
* Returns <jk>true</jk> if the specified request can pass through this guard.
- *
+ *
* @param req The servlet request.
* @return <jk>true</jk> if the specified request can pass through this guard.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestInfoProvider.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestInfoProvider.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestInfoProvider.java
index 5bef97b..d1f14a1 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestInfoProvider.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestInfoProvider.java
@@ -28,11 +28,11 @@ import org.apache.juneau.svl.*;
/**
* Class that provides documentation and other related information about a REST resource.
- *
+ *
* <p>
* Subclasses can override these methods to tailor how HTTP REST resources are documented.
* Subclasses MUST implement a public constructor that takes in a {@link RestContext} object.
- *
+ *
* <p>
* RestInfoProviders are associated with servlets/resources in one of the following ways:
* <ul>
@@ -57,7 +57,7 @@ public class RestInfoProvider {
/**
* Constructor.
- *
+ *
* @param context The resource context.
*/
public RestInfoProvider(RestContext context) {
@@ -117,7 +117,7 @@ public class RestInfoProvider {
/**
* Returns the localized swagger for this REST resource.
- *
+ *
* @param req The incoming HTTP request.
* @return A new Swagger instance.
* @throws RestException
@@ -161,14 +161,14 @@ public class RestInfoProvider {
/**
* 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.
- *
+ *
* <p>
* Returned objects are cached for later quick-lookup.
- *
+ *
* @param locale The locale of the swagger.
* @return The parsed swagger object, or <jk>null</jk> if the swagger file could not be found.
* @throws RestException
@@ -188,10 +188,10 @@ public class RestInfoProvider {
/**
* Returns the localized summary of the specified java method on this servlet.
- *
+ *
* <p>
* Subclasses can override this method to provide their own summary.
- *
+ *
* <p>
* The default implementation returns the summary from the following locations (whichever matches first):
* <ol>
@@ -201,7 +201,7 @@ public class RestInfoProvider {
* <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.
* @param req The current request.
* @return The localized summary of the method, or a blank string if no summary was found.
@@ -215,10 +215,10 @@ public class RestInfoProvider {
/**
* Returns the localized summary of the java method invoked on the specified request.
- *
+ *
* <p>
* Subclasses can override this method to provide their own summary.
- *
+ *
* <p>
* The default implementation returns the summary from the following locations (whichever matches first):
* <ol>
@@ -228,7 +228,7 @@ public class RestInfoProvider {
* <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 req The current request.
* @return The localized summary of the method, or a blank string if no summary was found.
*/
@@ -238,10 +238,10 @@ public class RestInfoProvider {
/**
* Returns the localized description of the specified java method on this servlet.
- *
+ *
* <p>
* Subclasses can override this method to provide their own description.
- *
+ *
* <p>
* The default implementation returns the description from the following locations (whichever matches first):
* <ol>
@@ -251,7 +251,7 @@ public class RestInfoProvider {
* <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.
* @param req The current request.
* @return The localized description of the method, or a blank string if no description was found.
@@ -265,10 +265,10 @@ public class RestInfoProvider {
/**
* Returns the localized description of the invoked java method on the specified request.
- *
+ *
* <p>
* Subclasses can override this method to provide their own description.
- *
+ *
* <p>
* The default implementation returns the description from the following locations (whichever matches first):
* <ol>
@@ -278,7 +278,7 @@ public class RestInfoProvider {
* <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 req The current request.
* @return The localized description of the method, or a blank string if no description was found.
*/
@@ -288,10 +288,10 @@ public class RestInfoProvider {
/**
* Returns the localized site name of this REST resource.
- *
+ *
* <p>
* Subclasses can override this method to provide their own site name.
- *
+ *
* <p>
* The default implementation returns the description from the following locations (whichever matches first):
* <ol>
@@ -302,7 +302,7 @@ public class RestInfoProvider {
* <li><ck>siteName</ck> in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}
* annotation for this class, then any parent classes.
* </ol>
- *
+ *
* @param req The current request.
* @return The localized description of this REST resource, or <jk>null</jk> if no resource description was found.
*/
@@ -318,10 +318,10 @@ public class RestInfoProvider {
/**
* Returns the localized title of this REST resource.
- *
+ *
* <p>
* Subclasses can override this method to provide their own title.
- *
+ *
* <p>
* The default implementation returns the description from the following locations (whichever matches first):
* <ol>
@@ -333,7 +333,7 @@ public class RestInfoProvider {
* annotation for this class, then any parent classes.
* <li><ck>/info/title</ck> entry in swagger file.
* </ol>
- *
+ *
* @param req The current request.
* @return The localized description of this REST resource, or <jk>null</jk> if no resource description was found.
*/
@@ -352,10 +352,10 @@ public class RestInfoProvider {
/**
* Returns the localized description of this REST resource.
- *
+ *
* <p>
* Subclasses can override this method to provide their own description.
- *
+ *
* <p>
* The default implementation returns the description from the following locations (whichever matches first):
* <ol>
@@ -367,7 +367,7 @@ public class RestInfoProvider {
* {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.
* <li><ck>/info/description</ck> entry in swagger file.
* </ol>
- *
+ *
* @param req The current request.
* @return The localized description of this REST resource, or <jk>null</jk> if no resource description was found.
*/
@@ -386,10 +386,10 @@ public class RestInfoProvider {
/**
* Returns the localized contact information of this REST resource.
- *
+ *
* <p>
* Subclasses can override this method to provide their own contact information.
- *
+ *
* <p>
* The default implementation returns the contact information from the following locations (whichever matches first):
* <ol>
@@ -401,7 +401,7 @@ public class RestInfoProvider {
* {@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.
@@ -426,10 +426,10 @@ public class RestInfoProvider {
/**
* Returns the localized license information of this REST resource.
- *
+ *
* <p>
* Subclasses can override this method to provide their own license information.
- *
+ *
* <p>
* The default implementation returns the license information from the following locations (whichever matches first):
* <ol>
@@ -441,7 +441,7 @@ public class RestInfoProvider {
* {@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.
@@ -466,10 +466,10 @@ public class RestInfoProvider {
/**
* Returns the terms-of-service information of this REST resource.
- *
+ *
* <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):
@@ -482,7 +482,7 @@ public class RestInfoProvider {
* {@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.
@@ -502,10 +502,10 @@ public class RestInfoProvider {
/**
* Returns the version information of this REST resource.
- *
+ *
* <p>
* Subclasses can override this method to provide their own version information.
- *
+ *
* <p>
* The default implementation returns the version information from the following locations (whichever matches first):
* <ol>
@@ -517,7 +517,7 @@ public class RestInfoProvider {
* {@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.
@@ -537,10 +537,10 @@ public class RestInfoProvider {
/**
* Returns the version information of this REST resource.
- *
+ *
* <p>
* Subclasses can override this method to provide their own version information.
- *
+ *
* <p>
* The default implementation returns the version information from the following locations (whichever matches first):
* <ol>
@@ -552,7 +552,7 @@ public class RestInfoProvider {
* {@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.
@@ -577,10 +577,10 @@ public class RestInfoProvider {
/**
* Returns the version information of this REST resource.
- *
+ *
* <p>
* Subclasses can override this method to provide their own version information.
- *
+ *
* <p>
* The default implementation returns the version information from the following locations (whichever matches first):
* <ol>
@@ -592,7 +592,7 @@ public class RestInfoProvider {
* {@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.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestJavaMethod.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestJavaMethod.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestJavaMethod.java
index 660f770..0ef6f63 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestJavaMethod.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestJavaMethod.java
@@ -780,7 +780,7 @@ public class RestJavaMethod implements Comparable<RestJavaMethod> {
/**
* Workhorse method.
- *
+ *
* @param pathInfo The value of {@link HttpServletRequest#getPathInfo()} (sorta)
* @return The HTTP response code.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestLogger.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestLogger.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestLogger.java
index 1952210..6e1ec6c 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestLogger.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestLogger.java
@@ -26,11 +26,11 @@ import org.apache.juneau.rest.annotation.*;
/**
* Logging utility class.
- *
+ *
* <p>
* Subclasses can override these methods to tailor logging of HTTP requests.
* Subclasses MUST implement a no-arg public constructor.
- *
+ *
* <p>
* RestLoggers are associated with servlets/resources in one of the following ways:
* <ul>
@@ -42,22 +42,22 @@ public abstract class RestLogger {
/**
* Returns the Java logger used for logging.
- *
+ *
* <p>
* Subclasses can provide their own logger.
* The default implementation returns the logger created using <code>Logger.getLogger(getClass())</code>.
- *
+ *
* @return The logger used for logging.
*/
protected abstract Logger getLogger();
/**
* 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).
- *
+ *
* @param level The log level.
* @param cause The cause.
* @param msg The message to log.
@@ -67,10 +67,10 @@ public abstract class RestLogger {
/**
* Log a message.
- *
+ *
* <p>
* Equivalent to calling <code>log(level, <jk>null</jk>, msg, args);</code>
- *
+ *
* @param level The log level.
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -81,16 +81,16 @@ public abstract class RestLogger {
/**
* 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* logObjects(<jsf>DEBUG</jsf>, <js>"Pojo contents:\n{0}"</js>, myPojo);
* </p>
- *
+ *
* @param level The log level.
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -103,13 +103,13 @@ public abstract class RestLogger {
/**
* Callback method for logging errors during HTTP requests.
- *
+ *
* <p>
* Typically, subclasses will override this method and log errors themselves.
- *
+ *
* <p>
* The default implementation simply logs errors to the <code>RestServlet</code> logger.
- *
+ *
* <p>
* Here's a typical implementation showing how stack trace hashing can be used to reduce log file sizes...
* <p class='bcode'>
@@ -117,23 +117,23 @@ public abstract class RestLogger {
* String qs = req.getQueryString();
* String msg = <js>"HTTP "</js> + req.getMethod() + <js>" "</js> + e.getStatus() + <js>" "</js> + req.getRequestURI() + (qs == <jk>null</jk> ? <js>""</js> : <js>"?"</js> + qs);
* <jk>int</jk> c = e.getOccurrence();
- *
+ *
* <jc>// REST_useStackTraceHashes is disabled, so we have to log the exception every time.</jc>
* <jk>if</jk> (c == 0)
* myLogger.log(Level.<jsf>WARNING</jsf>, <jsm>format</jsm>(<js>"[%s] %s"</js>, e.getStatus(), msg), e);
- *
+ *
* <jc>// This is the first time we've countered this error, so log a stack trace
* // unless ?noTrace was passed in as a URL parameter.</jc>
* <jk>else if</jk> (c == 1 && ! noTrace)
* myLogger.log(Level.<jsf>WARNING</jsf>, <jsm>format</jsm>(<js>"[%h.%s.%s] %s"</js>, e.hashCode(), e.getStatus(), c, msg), e);
- *
+ *
* <jc>// This error occurred before.
* // Only log the message, not the stack trace.</jc>
* <jk>else</jk>
* myLogger.log(Level.<jsf>WARNING</jsf>, <jsm>format</jsm>(<js>"[%h.%s.%s] %s, %s"</js>, e.hashCode(), e.getStatus(), c, msg, e.getLocalizedMessage()));
* }
* </p>
- *
+ *
* @param req The servlet request object.
* @param res The servlet response object.
* @param e Exception indicating what error occurred.
@@ -155,14 +155,14 @@ public abstract class RestLogger {
/**
* Returns <jk>true</jk> if the specified exception should be logged.
- *
+ *
* <p>
* 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.
- *
+ *
* @param req The HTTP request.
* @param res The HTTP response.
* @param e The exception.
@@ -176,10 +176,10 @@ public abstract class RestLogger {
/**
* Returns <jk>true</jk> if a stack trace should be logged for this exception.
- *
+ *
* <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:
@@ -188,7 +188,7 @@ public abstract class RestLogger {
* <li>{@link HttpServletResponse#SC_FORBIDDEN}
* <li>{@link HttpServletResponse#SC_NOT_FOUND}
* </ul>
- *
+ *
* @param req The HTTP request.
* @param res The HTTP response.
* @param e The exception.
@@ -216,10 +216,10 @@ public abstract class RestLogger {
/**
* NO-OP logger.
- *
+ *
* <p>
* Disables all logging.
- *
+ *
* @author James Bognar (james.bognar@salesforce.com)
*/
public static class NoOp extends RestLogger {
@@ -235,7 +235,7 @@ public abstract class RestLogger {
/**
* Default logger.
- *
+ *
* <p>
* Logs all messages to the logger returned by <code>Logger.<jsm>getLogger</jsm>(getClass().getName())</code>
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestMatcher.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestMatcher.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestMatcher.java
index 3e1daf0..5bf108d 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestMatcher.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestMatcher.java
@@ -16,37 +16,37 @@ import org.apache.juneau.rest.annotation.*;
/**
* Class used for defining method-level matchers using the {@link RestMethod#matchers() @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.
- *
+ *
* <p>
* 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() @RestMethod.guards()} annotation, where all guards are required to match in order to
* execute the method.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {
- *
+ *
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/foo"</js>, matchers=IsDNT.<jk>class</jk>)
* <jk>public</jk> Object doGetWithDNT() {
* <jc>// Handle request with Do-Not-Track specified</jc>
* }
- *
+ *
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/foo"</js>)
* <jk>public</jk> Object doGetWithoutDNT() {
* <jc>// Handle request without Do-Not-Track specified</jc>
* }
* }
- *
+ *
* <jk>public class</jk> IsDNT <jk>extends</jk> RestMatcher {
* <ja>@Override</ja>
* <jk>public boolean</jk> matches(RestRequest req) {
@@ -67,7 +67,7 @@ public abstract class RestMatcher {
/**
* Returns <jk>true</jk> if the specified request matches this matcher.
- *
+ *
* @param req The servlet request.
* @return <jk>true</jk> if the specified request matches this matcher.
*/
@@ -75,10 +75,10 @@ public abstract class RestMatcher {
/**
* Returns <jk>true</jk> if this matcher is required to match in order for the method to be invoked.
- *
+ *
* <p>
* If <jk>false</jk>, then only one of the matchers must match.
- *
+ *
* @return <jk>true</jk> if this matcher is required to match in order for the method to be invoked.
*/
public boolean mustMatch() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestParam.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestParam.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestParam.java
index 95b6c27..c95a6da 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestParam.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestParam.java
@@ -18,10 +18,10 @@ import org.apache.juneau.rest.annotation.*;
/**
* REST java method parameter resolver.
- *
+ *
* <p>
* Used to resolve instances of classes being passed to Java REST methods.
- *
+ *
* <p>
* This class is associated with REST classes via the {@link RestResource#paramResolvers() @RestResource.paramResolvers()} annotation and
* {@link RestContextBuilder#paramResolvers(Class...)} method.
@@ -34,7 +34,7 @@ public abstract class RestParam {
/**
* Constructor.
- *
+ *
* @param paramType The Swagger parameter type.
* @param name
* The parameter name.
@@ -49,7 +49,7 @@ public abstract class RestParam {
/**
* Resolves the parameter object.
- *
+ *
* @param req The rest request.
* @param res The rest response.
* @return The resolved object.
@@ -59,7 +59,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() {
@@ -70,7 +70,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() {
@@ -79,7 +79,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() {
@@ -88,7 +88,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/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestRequest.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestRequest.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestRequest.java
index 2723e3d..c36e432 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestRequest.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestRequest.java
@@ -43,10 +43,10 @@ import org.apache.juneau.utils.*;
/**
* Represents an HTTP request for a REST resource.
- *
+ *
* <p>
* 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....
@@ -60,7 +60,7 @@ import org.apache.juneau.utils.*;
* <tr><td>{@code getRequestURL()}</td><td>{@code http://localhost:9080/contextRoot/servletPath/foo}</td></tr>
* <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.
@@ -195,7 +195,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns a string of the form <js>"HTTP method-name full-url"</js>
- *
+ *
* @return A description of the request.
*/
public String getDescription() {
@@ -205,7 +205,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Same as {@link #getAttribute(String)} but returns a default value if not found.
- *
+ *
* @param name The request attribute name.
* @param def The default value if the attribute doesn't exist.
* @return The request attribute value.
@@ -217,7 +217,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Shorthand method for calling {@link #setAttribute(String, Object)} fluently.
- *
+ *
* @param name The request attribute name.
* @param value The request attribute value.
* @return This object (for method chaining).
@@ -234,10 +234,10 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Retrieve the properties active for this request.
- *
+ *
* <p>
* These properties can be modified by the request.
- *
+ *
* @return The properties active for this request.
*/
public ObjectMap getProperties() {
@@ -246,7 +246,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Shortcut for calling <code>getProperties().append(name, value);</code> fluently.
- *
+ *
* @param name The property name.
* @param value The property value.
* @return This object (for method chaining).
@@ -263,7 +263,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the headers on this request.
- *
+ *
* @return The headers on this request. Never <jk>null</jk>.
*/
public RequestHeaders getHeaders() {
@@ -285,7 +285,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the media types that are valid for <code>Accept</code> headers on the request.
- *
+ *
* @return The set of media types registered in the serializer group of this request.
*/
public List<MediaType> getSupportedAcceptTypes() {
@@ -294,7 +294,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the media types that are valid for <code>Content-Type</code> headers on the request.
- *
+ *
* @return The set of media types registered in the parser group of this request.
*/
public List<MediaType> getSupportedContentTypes() {
@@ -365,14 +365,14 @@ 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.
- *
+ *
* <p>
* This object is modifiable.
- *
+ *
* @return The query parameters as a modifiable map.
*/
public RequestQuery getQuery() {
@@ -381,7 +381,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.
*/
@@ -396,7 +396,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Retrieves the URL-encoded form data from the request if the body has already been cached locally.
- *
+ *
* @return The URL-encoded form data from the request.
*/
public RequestFormData getFormData() {
@@ -423,7 +423,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.
*/
@@ -438,7 +438,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Retrieves the URL-encoded form data from the request if the body has already been cached locally.
- *
+ *
* @return The URL-encoded form data from the request.
*/
public RequestPathMatch getPathMatch() {
@@ -447,7 +447,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Shortcut for calling <code>getPathMatch().get(name)</code>.
- *
+ *
* @param name The path variable name.
* @return The path variable value, or <jk>null<jk> if not found.
*/
@@ -461,7 +461,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the body of this HTTP request.
- *
+ *
* @return The body of this HTTP request.
*/
public RequestBody getBody() {
@@ -470,11 +470,11 @@ 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.
- *
+ *
* <p>
* Automatically handles GZipped input streams.
*/
@@ -485,10 +485,10 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the HTTP body content as an {@link InputStream}.
- *
+ *
* <p>
* 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.
*/
@@ -521,11 +521,11 @@ 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...
- *
+ *
* @return The URI context of the request.
*/
public UriContext getUriContext() {
@@ -542,7 +542,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* 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.
* @return The URI resolver for this request.
@@ -554,7 +554,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Shortcut for calling {@link #getUriResolver()} using {@link UriResolution#ROOT_RELATIVE} and
* {@link UriRelativity#RESOURCE}
- *
+ *
* @return The URI resolver for this request.
*/
public UriResolver getUriResolver() {
@@ -563,12 +563,12 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the URI for this request.
- *
+ *
* <p>
* Similar to {@link #getRequestURI()} but returns the value as a {@link URI}.
* It also gives you the capability to override the query parameters (e.g. add new query parameters to the existing
* URI).
- *
+ *
* @param includeQuery If <jk>true</jk> include the query parameters on the request.
* @param addQueryParams Augment the request URI with the specified query parameters.
* @return A new URI.
@@ -608,10 +608,10 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the localized site name.
- *
+ *
* <p>
* The site name is intended to be a title that can be applied to the entire site.
- *
+ *
* <p>
* One possible use is if you want to add the same title to the top of all pages by defining a header on a
* common parent class like so:
@@ -623,10 +623,10 @@ public final class RestRequest extends HttpServletRequestWrapper {
* }
* )
* </p>
- *
+ *
* <p>
* Equivalent to calling {@link RestInfoProvider#getSiteName(RestRequest)} with this object.
- *
+ *
* @return The localized servlet label.
*/
public String getSiteName() {
@@ -635,10 +635,10 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the localized servlet title.
- *
+ *
* <p>
* Equivalent to calling {@link RestInfoProvider#getTitle(RestRequest)} with this object.
- *
+ *
* @return The localized servlet label.
*/
public String getServletTitle() {
@@ -647,10 +647,10 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the localized servlet description.
- *
+ *
* <p>
* Equivalent to calling {@link RestInfoProvider#getDescription(RestRequest)} with this object.
- *
+ *
* @return The localized servlet description.
*/
public String getServletDescription() {
@@ -659,10 +659,10 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the localized method summary.
- *
+ *
* <p>
* Equivalent to calling {@link RestInfoProvider#getMethodSummary(String, RestRequest)} with this object.
- *
+ *
* @return The localized method description.
*/
public String getMethodSummary() {
@@ -671,10 +671,10 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the localized method description.
- *
+ *
* <p>
* Equivalent to calling {@link RestInfoProvider#getMethodDescription(String, RestRequest)} with this object.
- *
+ *
* @return The localized method description.
*/
public String getMethodDescription() {
@@ -687,7 +687,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the serializers associated with this request.
- *
+ *
* @return The serializers associated with this request.
*/
public SerializerGroup getSerializerGroup() {
@@ -696,7 +696,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the parsers associated with this request.
- *
+ *
* @return The parsers associated with this request.
*/
public ParserGroup getParserGroup() {
@@ -706,7 +706,7 @@ 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.
@@ -718,10 +718,10 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the HTTP 1.1 method name of the request as an enum.
- *
+ *
* <p>
* Note that non-RFC2616 method names resolve as {@link HttpMethod#OTHER}.
- *
+ *
* @return The HTTP method.
*/
public HttpMethod getHttpMethod() {
@@ -739,14 +739,14 @@ 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.
- *
+ *
* <p>
* This feature is useful for debugging.
- *
+ *
* @return <jk>true</jk> if {@code &plainText=true} was specified as a URL parameter
*/
public boolean isPlainText() {
@@ -755,7 +755,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Shortcut method for calling {@link MessageBundle#getString(Locale, String, Object...)} based on the request locale.
- *
+ *
* @param key The message key.
* @param args Optional {@link MessageFormat}-style arguments.
* @return The localized message.
@@ -766,7 +766,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the resource bundle for the request locale.
- *
+ *
* @return The resource bundle. Never <jk>null</jk>.
*/
public MessageBundle getResourceBundle() {
@@ -775,11 +775,11 @@ 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)}..
- *
+ *
* @return The servlet handling the request.
*/
public RestContext getContext() {
@@ -788,17 +788,17 @@ 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)}.
- *
+ *
* <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.
* </ul>
- *
+ *
* @return The Java method handling the request, or <code>null</code> if the method has not yet been resolved.
*/
public Method getJavaMethod() {
@@ -807,7 +807,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the {@link BeanSession} associated with this request.
- *
+ *
* @return The request bean session.
*/
public BeanSession getBeanSession() {
@@ -817,10 +817,10 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Returns the variable resolver session for this request using session objects created by
* {@link RestCallHandler#getSessionObjects(RestRequest)}.
- *
+ *
* <p>
* See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* @return The variable resolver for this request.
*/
public VarResolverSession getVarResolverSession() {
@@ -831,7 +831,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Shortcut for calling <code>getVarResolverSession().resolve(input)</code>.
- *
+ *
* @param input The input string to resolve variables in.
* @return The string with variables resolved, or <jk>null</jk> if input is null.
*/
@@ -841,7 +841,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Shortcut for calling {@link #resolveVars(String[])} on all elements in the array.
- *
+ *
* @param input The input strings to resolve variables in.
* @return A copy of the array with variables resolved.
*/
@@ -852,7 +852,7 @@ 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.
- *
+ *
* @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 @Parameter} variables will be
@@ -875,7 +875,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Same as {@link #getClasspathReaderResource(String, boolean, MediaType)} except uses the resource mime-type map
* constructed using {@link RestContextBuilder#mimeTypes(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 @Parameter} variables will be
@@ -890,7 +890,7 @@ public final class RestRequest extends HttpServletRequestWrapper {
/**
* Same as {@link #getClasspathReaderResource(String, boolean)} with <code>resolveVars == <jk>false</jk></code>
- *
+ *
* @param name The name of the resource (i.e. the value normally passed to {@link Class#getResourceAsStream(String)}.
* @return A new reader resource, or <jk>null</jk> if resource could not be found.
* @throws IOException
@@ -901,7 +901,7 @@ 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.
@@ -914,7 +914,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>.
@@ -927,7 +927,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>.
@@ -938,14 +938,14 @@ 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.
- *
+ *
* <p>
* Returned objects are cached for later quick-lookup.
- *
+ *
* @return The parsed swagger object, or <jk>null</jk> if the swagger file could not be found.
*/
protected Swagger getSwaggerFromFile() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResourceResolver.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResourceResolver.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResourceResolver.java
index ce256c6..893ef7d 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResourceResolver.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResourceResolver.java
@@ -16,10 +16,10 @@ import org.apache.juneau.rest.annotation.*;
/**
* Class used to resolve {@link Class} objects to instances.
- *
+ *
* <p>
* Used to convert classes defined via {@link RestResource#children() @RestResource.children()} into child instances.
- *
+ *
* <p>
* Subclasses can be created to provide customized resource resolution.
* These can be associated with REST resources in one of the following ways:
@@ -39,10 +39,10 @@ public interface RestResourceResolver {
/**
* Resolves the specified class to a resource object.
- *
+ *
* <p>
* Subclasses can override this method to provide their own custom resolution.
- *
+ *
* <p>
* The default implementation simply creates a new class instance using {@link Class#newInstance()}.
*
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResourceResolverSimple.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResourceResolverSimple.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResourceResolverSimple.java
index 0121558..3d63597 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResourceResolverSimple.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResourceResolverSimple.java
@@ -16,13 +16,13 @@ import org.apache.juneau.internal.*;
/**
* Denotes the default resolver for child resources.
- *
+ *
* The default implementation simply instantiates the class using one of the following constructors:
* <ul>
* <li><code><jk>public</jk> T(RestContextBuilder)</code>
* <li><code><jk>public</jk> T()</code>
* </ul>
- *
+ *
* <p>
* The former constructor can be used to get access to the {@link RestContextBuilder} object to get access to the
* config file and initialization information or make programmatic modifications to the resource before
@@ -30,14 +30,14 @@ import org.apache.juneau.internal.*;
*
* <p>
* Child classes can also be defined as inner-classes of the parent resource class.
- *
+ *
* <p>
* Non-<code>RestServlet</code> classes can also add the following method to get access to the {@link RestContextBuilder}
* object:
* <ul>
* <li><code><jk>public void</jk> init(RestContextBuilder);</code>
* </ul>
- *
+ *
*/
public class RestResourceResolverSimple implements RestResourceResolver {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResponse.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResponse.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResponse.java
index 15d58da..0b5c6ae 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResponse.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestResponse.java
@@ -28,15 +28,15 @@ import org.apache.juneau.serializer.*;
/**
* 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.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>)
@@ -45,7 +45,7 @@ import org.apache.juneau.serializer.*;
* .setOutput(<js>"Simple string response"</js>);
* }
* </p>
- *
+ *
* <p>
* Refer to <a class="doclink" href="package-summary.html#TOC">REST Servlet API</a> for information about using this
* class.
@@ -115,7 +115,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Gets the serializer group for the response.
- *
+ *
* @return The serializer group for the response.
*/
public SerializerGroup getSerializerGroup() {
@@ -124,7 +124,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Returns the media types that are valid for <code>Accept</code> headers on the request.
- *
+ *
* @return The set of media types registered in the parser group of this request.
*/
public List<MediaType> getSupportedMediaTypes() {
@@ -134,7 +134,7 @@ 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.
- *
+ *
* @return The set of media types registered in the parser group of this request.
* @throws RestServletException
*/
@@ -144,10 +144,10 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Sets the HTTP output on the response.
- *
+ *
* <p>
* Calling this method is functionally equivalent to returning the object in the REST Java method.
- *
+ *
* <p>
* Can be of any of the following types:
* <ul>
@@ -156,11 +156,11 @@ public final class RestResponse extends HttpServletResponseWrapper {
* <li> Any serializable type defined in <a class="doclink"
* href="../../../../overview-summary.html#juneau-marshall.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.
- *
+ *
* @param output The output to serialize to the connection.
* @return This object (for method chaining).
*/
@@ -172,7 +172,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Returns a programmatic interface for setting properties for the HTML doc view.
- *
+ *
* @return A new programmatic interface for setting properties for the HTML doc view.
*/
public HtmlDocBuilder getHtmlDocBuilder() {
@@ -183,10 +183,10 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Add a serializer property to send to the serializers to override a default value.
- *
+ *
* <p>
* Can be any value specified on any of the serializers or parsers.
- *
+ *
* @param key The setting name.
* @param value The setting value.
* @return This object (for method chaining).
@@ -198,7 +198,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Returns the properties set via {@link #setProperty(String, Object)}.
- *
+ *
* @return A map of all the property values set.
*/
public ObjectMap getProperties() {
@@ -207,16 +207,16 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Shortcut method that allows you to use var-args to simplify setting array output.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Instead of...</jc>
* response.setOutput(<jk>new</jk> Object[]{x,y,z});
- *
+ *
* <jc>// ...call this...</jc>
* response.setOutput(x,y,z);
* </p>
- *
+ *
* @param output The output to serialize to the connection.
* @return This object (for method chaining).
*/
@@ -227,7 +227,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Returns the output that was set by calling {@link #setOutput(Object)}.
- *
+ *
* @return The output object.
*/
public Object getOutput() {
@@ -236,7 +236,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Returns <jk>true</jk> if this response has any output associated with it.
- *
+ *
* @return <jk>true</jk> if {@code setInput()} has been called.
*/
public boolean hasOutput() {
@@ -245,7 +245,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Sets the output to a plain-text message regardless of the content type.
- *
+ *
* @param text The output text to send.
* @return This object (for method chaining).
* @throws IOException If a problem occurred trying to write to the writer.
@@ -259,7 +259,7 @@ 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.
- *
+ *
* @return A negotiated output stream.
* @throws IOException
*/
@@ -332,7 +332,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Returns <jk>true</jk> if {@link #getOutputStream()} has been called.
- *
+ *
* @return <jk>true</jk> if {@link #getOutputStream()} has been called.
*/
public boolean getOutputStreamCalled() {
@@ -341,7 +341,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Returns the writer to the response body.
- *
+ *
* <p>
* This methods bypasses any specified encoders and returns a regular unbuffered writer.
* Use the {@link #getNegotiatedWriter()} method if you want to use the matched encoder (if any).
@@ -353,11 +353,11 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Convenience method meant to be used when rendering directly to a browser with no buffering.
- *
+ *
* <p>
* 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.
* @throws IOException
@@ -372,7 +372,7 @@ 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.
- *
+ *
* @return The negotiated writer.
* @throws IOException
*/
@@ -401,7 +401,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Returns the <code>Content-Type</code> header stripped of the charset attribute if present.
- *
+ *
* @return The <code>media-type</code> portion of the <code>Content-Type</code> header.
*/
public MediaType getMediaType() {
@@ -410,7 +410,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.
@@ -425,7 +425,7 @@ public final class RestResponse extends HttpServletResponseWrapper {
/**
* Returns the HTTP-part serializer associated with this response.
- *
+ *
* @return The HTTP-part serializer associated with this response.
*/
public HttpPartSerializer getPartSerializer() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServlet.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServlet.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServlet.java
index e30ea16..b1b26bd 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServlet.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServlet.java
@@ -28,7 +28,7 @@ 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.
@@ -101,18 +101,18 @@ 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(ServletConfig)} 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:
* <p class='bcode'>
* <jk>public void</jk> init(RestServletContext context) <jk>throws</jk> Exception;
* </p>
- *
+ *
* @return The context information on this servlet.
*/
protected synchronized RestContext getContext() {
@@ -122,13 +122,13 @@ public abstract class RestServlet extends HttpServlet {
/**
* Convenience method if you want to perform initialization on your resource after all configuration settings
* have been made.
- *
+ *
* <p>
* This allows you to get access to the {@link RestContext} object during initialization.
- *
+ *
* <p>
* The default implementation does nothing.
- *
+ *
* @param context The servlet context containing all the set-in-stone configurations for this resource.
* @throws Exception Any exception can be thrown to signal an initialization failure.
*/
@@ -141,7 +141,7 @@ public abstract class RestServlet extends HttpServlet {
/**
* The main service method.
- *
+ *
* <p>
* Subclasses can optionally override this method if they want to tailor the behavior of requests.
*/
@@ -169,7 +169,7 @@ public abstract class RestServlet extends HttpServlet {
/**
* Convenience method for calling <code>getContext().getLogger().log(level, msg, args);</code>
- *
+ *
* @param level The log level.
* @param msg The message to log.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -181,7 +181,7 @@ public abstract class RestServlet extends HttpServlet {
/**
* Convenience method for calling <code>getContext().getLogger().log(level, cause, msg, args);</code>
- *
+ *
* @param level The log level.
* @param cause The cause.
* @param msg The message to log.
@@ -207,7 +207,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()
*/
@@ -217,7 +217,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()
*/
@@ -227,7 +227,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()
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletDefault.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletDefault.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletDefault.java
index 900ac77..f0afb45 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletDefault.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletDefault.java
@@ -29,7 +29,7 @@ import org.apache.juneau.xml.*;
/**
* Subclass of {@link RestServlet} with default serializers and parsers defined.
- *
+ *
* <p>
* Supports the following request <code>Accept</code> header values with the resulting response <code>Content-Type</code>:
* <table class='styled'>
@@ -127,25 +127,25 @@ import org.apache.juneau.xml.*;
* <td>{@link PlainTextParser}</td>
* </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 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.
- *
+ *
* <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.
* <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>
@@ -209,7 +209,7 @@ public abstract class RestServletDefault extends RestServlet {
/**
* [OPTIONS /*] - Show resource options.
- *
+ *
* @param req The HTTP request.
* @return A bean containing the contents for the OPTIONS page.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletException.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletException.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletException.java
index 7e9735d..6e39551 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletException.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletException.java
@@ -27,7 +27,7 @@ public class RestServletException extends ServletException {
/**
* Constructor.
- *
+ *
* @param message The detailed message.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -37,7 +37,7 @@ public class RestServletException extends ServletException {
/**
* 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/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletGroupDefault.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletGroupDefault.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletGroupDefault.java
index 86efd72..b0d7fda 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletGroupDefault.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestServletGroupDefault.java
@@ -19,11 +19,11 @@ import org.apache.juneau.rest.labels.*;
/**
* Specialized subclass of {@link RestServletDefault} for showing "group" pages.
- *
+ *
* <p>
* Group pages consist of simple lists of child resource URLs and their labels.
* They're meant to be used as jumping-off points for child resources.
- *
+ *
* <p>
* Child resources are specified using the {@link RestResource#children() @RestResource.children()} annotation.
*/
@@ -33,7 +33,7 @@ public abstract class RestServletGroupDefault extends RestServletDefault {
/**
* [GET /] - Get child resources.
- *
+ *
* @param req The HTTP request.
* @return The bean containing links to the child resources.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestUtils.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestUtils.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestUtils.java
index 3932b4e..cfc2351 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestUtils.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestUtils.java
@@ -32,7 +32,7 @@ public final class RestUtils {
/**
* Returns readable text for an HTTP response code.
- *
+ *
* @param rc The HTTP response code.
* @return Readable text for an HTTP response code, or <jk>null</jk> if it's an invalid code.
*/
@@ -81,7 +81,7 @@ public final class RestUtils {
/**
* Identical to {@link HttpServletRequest#getPathInfo()} but doesn't decode encoded characters.
- *
+ *
* @param req The HTTP request
* @return The un-decoded path info.
*/
@@ -97,10 +97,10 @@ public final class RestUtils {
/**
* Efficiently trims the path info part from a request URI.
- *
+ *
* <p>
* The result is the URI of the servlet itself.
- *
+ *
* @param requestURI The value returned by {@link HttpServletRequest#getRequestURL()}
* @param contextPath The value returned by {@link HttpServletRequest#getContextPath()}
* @param servletPath The value returned by {@link HttpServletRequest#getServletPath()}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/StaticFileMapping.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/StaticFileMapping.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/StaticFileMapping.java
index 84fd164..e769d1f 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/StaticFileMapping.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/StaticFileMapping.java
@@ -50,7 +50,8 @@ import org.apache.juneau.utils.*;
* <li><l>[working-dir]/docs</l> directory.
* </ol>
*
- * <h5 class='section'>Notes:</h5>
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul class='spaced-list'>
* <li>
* Mappings are cumulative from parent to child. Child resources can override mappings made on parent resources.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/StreamResource.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/StreamResource.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/StreamResource.java
index bb76623..bbe29c7 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/StreamResource.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/StreamResource.java
@@ -24,12 +24,12 @@ 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.
* Therefore, this object is designed to be reused and thread-safe.
- *
+ *
* <p>
* This class is handled special by the {@link StreamableHandler} class.
* This allows these objects to be returned as responses by REST methods.
@@ -42,7 +42,7 @@ public class StreamResource implements Streamable {
/**
* Constructor.
- *
+ *
* @param mediaType The resource media type.
* @param contents
* The resource contents.
@@ -63,7 +63,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
@@ -118,7 +118,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).
*/
@@ -129,7 +129,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).
*/
@@ -140,10 +140,10 @@ public class StreamResource implements Streamable {
/**
* Specifies the contents for this resource.
- *
+ *
* <p>
* This method can be called multiple times to add more content.
- *
+ *
* @param contents
* The resource contents.
* <br>If multiple contents are specified, the results will be concatenated.
@@ -164,7 +164,7 @@ public class StreamResource implements Streamable {
/**
* Specifies an HTTP response header value.
- *
+ *
* @param name The HTTP header name.
* @param value The HTTP header value. Will be converted to a <code>String</code> using {@link Object#toString()}.
* @return This object (for method chaining).
@@ -176,7 +176,7 @@ public class StreamResource implements Streamable {
/**
* Specifies HTTP response header values.
- *
+ *
* @param headers The HTTP headers. Values will be converted to <code>Strings</code> using {@link Object#toString()}.
* @return This object (for method chaining).
*/
@@ -188,7 +188,7 @@ public class StreamResource implements Streamable {
/**
* Create a new {@link StreamResource} using values in this builder.
- *
+ *
* @return A new immutable {@link StreamResource} object.
* @throws IOException
*/
@@ -199,7 +199,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/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/UrlPathPattern.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/UrlPathPattern.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/UrlPathPattern.java
index a362f67..01b7cca 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/UrlPathPattern.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/UrlPathPattern.java
@@ -21,7 +21,7 @@ import org.apache.juneau.rest.annotation.*;
/**
* A parsed path pattern constructed from a {@link RestMethod#path() @RestMethod.path()} value.
- *
+ *
* <p>
* Handles aspects of matching and precedence ordering.
*/
@@ -34,7 +34,7 @@ public final class UrlPathPattern implements Comparable<UrlPathPattern> {
/**
* Constructor.
- *
+ *
* @param patternString The raw pattern string from the {@link RestMethod#path() @RestMethod.path()} annotation.
*/
public UrlPathPattern(String patternString) {
@@ -75,7 +75,7 @@ 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
@@ -117,7 +117,7 @@ public final class UrlPathPattern implements Comparable<UrlPathPattern> {
/**
* Comparator for this object.
- *
+ *
* <p>
* The comparator is designed to order URL pattern from most-specific to least-specific.
* For example, the following patterns would be ordered as follows:
@@ -169,10 +169,10 @@ public final class UrlPathPattern implements Comparable<UrlPathPattern> {
/**
* Returns this path pattern as the compiled regular expression.
- *
+ *
* <p>
* Useful for debugging.
- *
+ *
* @return The path pattern.
*/
public String toRegEx() {
@@ -181,7 +181,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() {
@@ -190,7 +190,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/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Body.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Body.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Body.java
index 3276c8c..33f3c61 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Body.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Body.java
@@ -21,7 +21,7 @@ import java.lang.annotation.*;
/**
* Annotation that can be applied to a parameter of a {@link RestMethod @RestMethod} annotated method to identify it as the HTTP
* request body converted to a POJO.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
@@ -29,7 +29,7 @@ import java.lang.annotation.*;
* ...
* }
* </p>
- *
+ *
* <p>
* This is functionally equivalent to the following code...
* <p class='bcode'>
@@ -39,7 +39,7 @@ import java.lang.annotation.*;
* ...
* }
* </p>
- *
+ *
* <p>
* {@link Reader Readers} and {@link InputStream InputStreams} can also be specified as content parameters.
* When specified, any registered parsers are bypassed.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/FormData.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/FormData.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/FormData.java
index 4548d4b..dadbf85 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/FormData.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/FormData.java
@@ -23,7 +23,7 @@ import org.apache.juneau.rest.*;
/**
* Annotation that can be applied to a parameter of a {@link RestMethod @RestMethod} annotated method to identify it as a form post
* entry converted to a POJO.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
@@ -32,7 +32,7 @@ import org.apache.juneau.rest.*;
* ...
* }
* </p>
- *
+ *
* <p>
* This is functionally equivalent to the following code...
* <p class='bcode'>
@@ -44,13 +44,13 @@ import org.apache.juneau.rest.*;
* ...
* }
* </p>
- *
+ *
* <h6 class='topic'>Important note concerning FORM posts</h6>
- *
+ *
* 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.
- *
+ *
* <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.
@@ -68,13 +68,13 @@ public @interface FormData {
/**
* 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>.
* This annotation allows the use of multi-part parameters to represent collections (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.
*/
@@ -87,7 +87,7 @@ public @interface FormData {
/**
* Specifies the {@link HttpPartParser} class used for parsing values from strings.
- *
+ *
* <p>
* The default value for this parser is inherited from the servlet/method which defaults to {@link UonPartParser}.
* <br>You can use {@link SimplePartParser} to parse POJOs that are directly convertible from <code>Strings</code>.
@@ -96,7 +96,7 @@ public @interface FormData {
/**
* A synonym for {@link #name()}.
- *
+ *
* <p>
* Allows you to use shortened notation if you're only specifying the name.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java
index 6e2846a..021d189 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java
@@ -22,10 +22,10 @@ import org.apache.juneau.rest.*;
/**
* Annotation that can be applied to a parameter of a {@link RestMethod @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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<jsf>POST</jsf>)
@@ -33,7 +33,7 @@ import org.apache.juneau.rest.*;
* ...
* }
* </p>
- *
+ *
* <p>
* This is functionally equivalent to the following code...
* <p class='bcode'>
@@ -43,7 +43,7 @@ import org.apache.juneau.rest.*;
* ...
* }
* </p>
- *
+ *
* <p>
* The following table shows the behavioral differences between <code>@HasFormData</code> and <code>@FormData</code>...
* <table class='styled'>
@@ -73,13 +73,13 @@ import org.apache.juneau.rest.*;
* <td><jk>null</jk></td>
* </tr>
* </table>
- *
+ *
* <h6 class='topic'>Important note concerning FORM posts</h6>
- *
+ *
* 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.
- *
+ *
* <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.
@@ -97,7 +97,7 @@ public @interface HasFormData {
/**
* A synonym for {@link #name()}.
- *
+ *
* <p>
* Allows you to use shortened notation if you're only specifying the name.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java
index d7dc349..98b724e 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java
@@ -22,13 +22,13 @@ 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.
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>)
@@ -36,7 +36,7 @@ import org.apache.juneau.rest.*;
* ...
* }
* </p>
- *
+ *
* <p>
* This is functionally equivalent to the following code...
* <p class='bcode'>
@@ -60,7 +60,7 @@ public @interface HasQuery {
/**
* A synonym for {@link #name()}.
- *
+ *
* <p>
* Allows you to use shortened notation if you're only specifying the name.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Header.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Header.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Header.java
index 0ee9a8b..936fd1a 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Header.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/Header.java
@@ -22,7 +22,7 @@ import org.apache.juneau.httppart.*;
/**
* Annotation that can be applied to a parameter of a {@link RestMethod @RestMethod} annotated method to identify it as a HTTP
* request header converted to a POJO.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>)
@@ -30,7 +30,7 @@ import org.apache.juneau.httppart.*;
* ...
* }
* </p>
- *
+ *
* <p>
* This is functionally equivalent to the following code...
* <p class='bcode'>
@@ -59,7 +59,7 @@ public @interface Header {
/**
* Specifies the {@link HttpPartParser} class used for parsing values from strings.
- *
+ *
* <p>
* The default value for this parser is inherited from the servlet/method which defaults to {@link UonPartParser}.
* <br>You can use {@link SimplePartParser} to parse POJOs that are directly convertible from <code>Strings</code>.
@@ -68,7 +68,7 @@ public @interface Header {
/**
* A synonym for {@link #name()}.
- *
+ *
* <p>
* Allows you to use shortened notation if you're only specifying the name.
*/
[20/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Bean.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Bean.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Bean.java
index adf0d7f..13faf8a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Bean.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Bean.java
@@ -23,14 +23,15 @@ import org.apache.juneau.transform.*;
/**
* Used to tailor how beans get interpreted by the framework.
- *
+ *
* <p>
* This annotation can be applied to classes and interfaces.
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanAnnotation">Overview > @Bean Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanAnnotation">Overview > @Bean Annotation</a>
+ * </ul>
*/
@Documented
@Target(TYPE)
@@ -40,7 +41,7 @@ public @interface Bean {
/**
* Bean dictionary.
- *
+ *
* <p>
* The list of classes that make up the bean dictionary for all properties in this class and all subclasses.
*
@@ -53,7 +54,7 @@ public @interface Bean {
/**
* Specifies a list of properties that should be excluded from {@link BeanMap#entrySet()}.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Exclude the 'city' and 'state' properties from the Address class.</jc>
@@ -70,18 +71,18 @@ public @interface Bean {
/**
* Identifies a class to be used as the interface class for this and all subclasses.
- *
+ *
* <p>
* When specified, only the list of properties defined on the interface class will be used during serialization.
* Additional properties on subclasses will be ignored.
- *
+ *
* <p class='bcode'>
* <jc>// Parent class</jc>
* <ja>@Bean</ja>(interfaceClass=A.<jk>class</jk>)
* <jk>public abstract class</jk> A {
* <jk>public</jk> String <jf>f0</jf> = <js>"f0"</js>;
* }
- *
+ *
* <jc>// Sub class</jc>
* <jk>public class</jk> A1 <jk>extends</jk> A {
* <jk>public</jk> String <jf>f1</jf> = <js>"f1"</js>;
@@ -90,11 +91,11 @@ public @interface Bean {
* <jc>// Produces "{f0:'f0'}"</jc>
* String json = JsonSerializer.<jsf>DEFAULT_LAX</jsf>.serialize(<jk>new</jk> A1());
* </p>
- *
+ *
* <p>
* Note that this annotation can be used on the parent class so that it filters to all child classes,
* or can be set individually on the child classes.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanFilters}
@@ -104,11 +105,11 @@ public @interface Bean {
/**
* The set and order of names of properties associated with a bean class.
- *
+ *
* <p>
* The order specified is the same order that the entries will be returned by the {@link BeanMap#entrySet()} and
* related methods.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Address class with only street/city/state properties (in that order).</jc>
@@ -138,10 +139,10 @@ public @interface Bean {
/**
* Associates a {@link PropertyNamer} with this bean to tailor the names of the bean properties.
- *
+ *
* <p>
* Property namers are used to transform bean property names from standard form to some other form.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Define a class with dashed-lowercase property names.</jc>
@@ -158,11 +159,11 @@ public @interface Bean {
/**
* Sort bean properties in alphabetical order.
- *
+ *
* <p>
* When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order.
* <br>Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Sort bean properties alphabetically during serialization.</jc>
@@ -179,11 +180,11 @@ public @interface Bean {
/**
* Identifies a stop class for the annotated class.
- *
+ *
* <p>
* Identical in purpose to the stop class specified by {@link Introspector#getBeanInfo(Class, Class)}.
* Any properties in the stop class or in its base classes will be ignored during analysis.
- *
+ *
* <p>
* For example, in the following class hierarchy, instances of <code>C3</code> will include property <code>p3</code>,
* but not <code>p1</code> or <code>p2</code>.
@@ -191,11 +192,11 @@ public @interface Bean {
* <jk>public class</jk> C1 {
* <jk>public int</jk> getP1();
* }
- *
+ *
* <jk>public class</jk> C2 <jk>extends</jk> C1 {
* <jk>public int</jk> getP2();
* }
- *
+ *
* <ja>@Bean</ja>(stopClass=C2.<jk>class</jk>)
* <jk>public class</jk> C3 <jk>extends</jk> C2 {
* <jk>public int</jk> getP3();
@@ -206,7 +207,7 @@ public @interface Bean {
/**
* An identifying name for this class.
- *
+ *
* <p>
* The name is used to identify the class type during parsing when it cannot be inferred through reflection.
* <br>For example, if a bean property is of type <code>Object</code>, then the serializer will add the name to the
@@ -221,7 +222,7 @@ public @interface Bean {
* <ja>@Bean</ja>(typeName=<js>"mybean"</js>)
* <jk>public class</jk> MyBean {...}
* </p>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanDictionary}
@@ -231,10 +232,10 @@ public @interface Bean {
/**
* The property name to use for representing the type name.
- *
+ *
* <p>
* This can be used to override the name used for the <js>"_type"</js> property used by the {@link #typeName()} setting.
- *
+ *
* <p>
* The default value if not specified is <js>"_type"</js> .
*
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanConstructor.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
index ae4efe5..1a46a4c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
@@ -21,31 +21,32 @@ import org.apache.juneau.*;
/**
* Maps constructor arguments to property names on beans with read-only properties.
- *
+ *
* <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
* are available at runtime.
- *
+ *
* <p>
* This annotation can only be applied to constructors and can only be applied to one constructor per class.
- *
+ *
* <p>
* When 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.
- *
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanConstructorAnnotation">Overview > @BeanConstructor Annotation</a>
- * </ul>
+ *
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanConstructorAnnotation">Overview > @BeanConstructor Annotation</a>
+ * </ul>
*/
@Documented
@Target(CONSTRUCTOR)
@@ -55,7 +56,7 @@ public @interface BeanConstructor {
/**
* The names of the properties of the constructor arguments.
- *
+ *
* <p>
* The number of properties listed must match the number of arguments in the constructor.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanIgnore.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
index 910ed00..6fe9a38 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
@@ -19,22 +19,23 @@ import java.lang.annotation.*;
/**
* Ignore classes, fields, and methods from being interpreted as bean or bean components.
- *
+ *
* <p>
* Applied to classes that may look like beans, but you want to be treated as non-beans.
* For example, if you want to force a bean to be converted to a string using the <code>toString()</code> method, use
* this annotation on the class.
- *
+ *
* <p>
* Applies to fields that should not be interpreted as bean property fields.
- *
+ *
* <p>
* Applies to getters or setters that should not be interpreted as bean property getters or setters.
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanIgnoreAnnotation">Overview > @BeanIgnore Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanIgnoreAnnotation">Overview > @BeanIgnore Annotation</a>
+ * </ul>
*/
@Documented
@Target({FIELD,METHOD,TYPE})
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanProperty.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanProperty.java
index d57bb52..db5c7d0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanProperty.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanProperty.java
@@ -21,14 +21,15 @@ import org.apache.juneau.*;
/**
* Used tailor how bean properties get interpreted by the framework.
- *
+ *
* <p>
* This annotation is applied to public fields and public getter/setter methods of beans.
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanPropertyAnnotation">Overview > @BeanProperty Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanPropertyAnnotation">Overview > @BeanProperty Annotation</a>
+ * </ul>
*/
@Documented
@Target({FIELD,METHOD})
@@ -38,16 +39,16 @@ public @interface BeanProperty {
/**
* Identifies the name of the property.
- *
+ *
* <p>
* Normally, this is automatically inferred from the field name or getter method name of the property.
* However, this property can be used to assign a different property name from the automatically inferred value.
- *
+ *
* <p>
* 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.
- *
+ *
* <h6 class='topic'>Dynamic beans</h6>
* <p>
* The bean property named <js>"*"</js> is the designated "dynamic property" which allows for "extra" bean
@@ -55,69 +56,69 @@ public @interface BeanProperty {
* This is similar in concept to the Jackson <ja>@JsonGetterAll</ja> and <ja>@JsonSetterAll</ja> annotations.
* The primary purpose is for backwards compatibility in parsing newer streams with addition information into older
* beans.
- *
+ *
* <p>
* The following examples show how to define dynamic bean properties.
* <p class='bcode'>
* <jc>// Option #1 - A simple public Map field.
* // The field name can be anything.</jc>
* <jk>public class</jk> BeanWithDynaField {
- *
+ *
* <ja>@BeanProperty</ja>(name=<js>"*"</js>)
* <jk>public</jk> Map<String,Object> extraStuff = <jk>new</jk> LinkedHashMap<String,Object>();
* }
- *
+ *
* <jc>// Option #2 - Getters and setters.
* // Method names can be anything.
* // Getter must return a Map with String keys.
* // Setter must take in two arguments.</jc>
* <jk>public class</jk> BeanWithDynaMethods {
- *
+ *
* <ja>@BeanProperty</ja>(name=<js>"*"</js>)
* <jk>public</jk> Map<String,Object> getMyExtraStuff() {
* ...
* }
- *
+ *
* <ja>@BeanProperty</ja>(name=<js>"*"</js>)
* <jk>public void</jk> setAnExtraField(String name, Object value) {
* ...
* }
* }
- *
+ *
* <jc>// Option #3 - Getter only.
* // Properties will be added through the getter.</jc>
* <jk>public class</jk> BeanWithDynaGetterOnly {
- *
+ *
* <ja>@BeanProperty</ja>(name=<js>"*"</js>)
* <jk>public</jk> Map<String,Object> getMyExtraStuff() {
* ...
* }
* }
* </p>
- *
+ *
*<p>
* Similar rules apply for value types and swaps.
* The property values optionally can be any serializable type or use swaps.
* <p class='bcode'>
* <jc>// A serializable type other than Object.</jc>
* <jk>public class</jk> BeanWithDynaFieldWithListValues {
- *
+ *
* <ja>@BeanProperty</ja>(name=<js>"*"</js>)
* <jk>public</jk> Map<String,List<String>> getMyExtraStuff() {
* ...
* }
* }
- *
+ *
* <jc>// A swapped value.</jc>
* <jk>public class</jk> BeanWithDynaFieldWithSwappedValues {
- *
+ *
* <ja>@BeanProperty</ja>(name=<js>"*"</js>, swap=CalendarSwap.<jsf>ISO8601DTZ</jsf>.<jk>class</jk>)
* <jk>public</jk> Map<String,Calendar> getMyExtraStuff() {
* ...
* }
* }
* </p>
- *
+ *
* <ul class='doctree'>
* <li class='info'>
* Note that if you're not interested in these additional properties, you can also use the
@@ -129,13 +130,13 @@ public @interface BeanProperty {
/**
* A synonym for {@link #name()}.
- *
+ *
* <p>
* The following annotations are equivalent:
- *
+ *
* <p class='bcode'>
* <ja>@BeanProperty</ja>(name=<js>"foo"</js>)
- *
+ *
* <ja>@BeanProperty</ja>(<js>"foo"</js>)
* </p>
*/
@@ -143,20 +144,20 @@ public @interface BeanProperty {
/**
* Identifies a specialized class type for the property.
- *
+ *
* <p>
* Normally this can be inferred through reflection of the field type or getter return type.
* However, you'll want to specify this value if you're parsing beans where the bean property class is an interface
* or abstract class to identify the bean type to instantiate.
* Otherwise, you may cause an {@link InstantiationException} when trying to set these fields.
- *
+ *
* <p>
* This property must denote a concrete bean class with a no-arg constructor.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> MyBean {
- *
+ *
* <jc>// Identify concrete map type.</jc>
* <ja>@BeanProperty</ja>(type=HashMap.<jk>class</jk>)
* <jk>public</jk> Map <jf>p1</jf>;
@@ -168,11 +169,11 @@ public @interface BeanProperty {
/**
* For bean properties of maps and collections, this annotation can be used to identify the class types of the
* contents of the bean property object when the generic parameter types are interfaces or abstract classes.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> MyBean {
- *
+ *
* <jc>// Identify concrete map type with String keys and Integer values.</jc>
* <ja>@BeanProperty</ja>(type=HashMap.<jk>class</jk>, params={String.<jk>class</jk>,Integer.<jk>class</jk>})
* <jk>public</jk> Map <jf>p1</jf>;
@@ -183,7 +184,7 @@ public @interface BeanProperty {
/**
* Used to limit which child properties are rendered by the serializers.
- *
+ *
* <p>
* Can be used on any of the following bean property types:
* <ul class='spaced-list'>
@@ -192,21 +193,21 @@ public @interface BeanProperty {
* <li>Bean/Map arrays - Same, but applied to each element in the array.
* <li>Bean/Map collections - Same, but applied to each element in the collection.
* </ul>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> MyClass {
- *
+ *
* <jc>// Only render 'f1' when serializing this bean property.</jc>
* <ja>@BeanProperty</ja>(properties=<js>"f1"</js>)
* <jk>public</jk> MyChildClass x1 = <jk>new</jk> MyChildClass();
* }
- *
+ *
* <jk>public class</jk> MyChildClass {
* <jk>public int</jk> f1 = 1;
* <jk>public int</jk> f2 = 2;
* }
- *
+ *
* <jc>// Renders "{x1:{f1:1}}"</jc>
* String json = JsonSerializer.<jsf>DEFAULT</jsf>.serialize(<jk>new</jk> MyClass());
* </p>
@@ -215,7 +216,7 @@ public @interface BeanProperty {
/**
* Bean dictionary.
- *
+ *
* <p>
* The list of classes that make up the bean dictionary this bean property.
*
@@ -228,14 +229,14 @@ public @interface BeanProperty {
/**
* Specifies a String format for converting the bean property value to a formatted string.
- *
+ *
* <p>
* Note that this is usually a one-way conversion during serialization.
- *
+ *
* <p>
* During parsing, we will attempt to convert the value to the original form by using the
* {@link BeanSession#convertToType(Object, Class)} but there is no guarantee that this will succeed.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@BeanProperty</ja>(format=<js>"$%.2f"</js>)
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/NameProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/NameProperty.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/NameProperty.java
index e48f870..70236b4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/NameProperty.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/NameProperty.java
@@ -19,16 +19,18 @@ import java.lang.annotation.*;
/**
* Identifies a setter as a method for setting the name of a POJO as it's known by its parent object.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>The annotated field or method does not need to be public.
* </ul>
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.NamePropertyAnnotation">Overview > @NameProperty Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.NamePropertyAnnotation">Overview > @NameProperty Annotation</a>
+ * </ul>
*/
@Target({METHOD,FIELD})
@Retention(RUNTIME)
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/ParentProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/ParentProperty.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/ParentProperty.java
index 9c3e1e6..94fd8df 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/ParentProperty.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/ParentProperty.java
@@ -19,19 +19,21 @@ import java.lang.annotation.*;
/**
* Identifies a setter as a method for adding a parent reference to a child object.
- *
+ *
* <p>
* Used by the parsers to add references to parent objects in child objects.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>The annotated field or method does not need to be public.
* </ul>
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.NamePropertyAnnotation">Overview > @NameProperty Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.NamePropertyAnnotation">Overview > @NameProperty Annotation</a>
+ * </ul>
*/
@Target({METHOD,FIELD})
@Retention(RUNTIME)
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swap.java
index f51f2ce..ab55d39 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swap.java
@@ -21,7 +21,7 @@ import org.apache.juneau.transform.*;
/**
* Associates {@link PojoSwap} and {@link Surrogate} classes with POJOs and bean properties.
- *
+ *
* <p>
* This annotation can be used in the following locations:
* <ul>
@@ -30,10 +30,11 @@ import org.apache.juneau.transform.*;
* <li>Inside the {@link Swaps @Swaps} annotation.
* </ul>
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview > @Swap Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview > @Swap Annotation</a>
+ * </ul>
*/
@Documented
@Target({TYPE,ANNOTATION_TYPE,FIELD,METHOD})
@@ -43,7 +44,7 @@ public @interface Swap {
/**
* The {@link PojoSwap} and {@link Surrogate} class.
- *
+ *
* <p>
* A synonym for {@link #value()}.
*/
@@ -51,14 +52,14 @@ public @interface Swap {
/**
* Identifies the media types that this swap is applicable for.
- *
+ *
* <p>
* In the following example, the swap is only invoked by the JSON serializer:
- *
+ *
* <p class='bcode'>
* <ja>@Swap</ja>(impl=ToStringSwap.<jk>class</jk>, mediaTypes=<js>"*/json"</js>)
* <jk>public class</jk> MyBean { ... }
- *
+ *
* <jk>public class</jk> ToStringSwap <jk>extends</jk> PojoSwap<Object,String> {
* <jk>public</jk> String swap(BeanSession session, Object o) <jk>throws</jk> Exception {
* <jk>return</jk> o.toString();
@@ -75,24 +76,24 @@ public @interface Swap {
/**
* Identifies a template string along with this swap.
- *
+ *
* <p>
* Template strings are arbitrary strings associated with swaps that help provide additional context information
* for the swap class.
* They're called 'templates' because their primary purpose is for providing template names, such as Apache FreeMarker
* template names.
- *
+ *
* <p>
* The following is an example of a templated swap class used to serialize POJOs to HTML using FreeMarker:
- *
+ *
* <p class='bcode'>
* <jc>// Our templated swap class.</jc>
* <jk>public class</jk> FreeMarkerSwap <jk>extends</jk> PojoSwap<Object,Reader> {
- *
+ *
* <jk>public</jk> MediaType[] forMediaTypes() {
* <jk>return</jk> MediaType.<jsm>forStrings</jsm>(<js>"*/html"</js>);
* }
- *
+ *
* <jk>public</jk> Reader swap(BeanSession session, Object o, String template) <jk>throws</jk> Exception {
* <jk>return</jk> getFreeMarkerReader(template, o); <jc>// Some method that creates raw HTML.</jc>
* }
@@ -112,7 +113,7 @@ public @interface Swap {
/**
* The {@link PojoSwap} and {@link Surrogate} class.
- *
+ *
* <p>
* A synonym for {@link #impl()}.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swaps.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swaps.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swaps.java
index 3ed934f..eac2a0b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swaps.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swaps.java
@@ -19,7 +19,7 @@ import java.lang.annotation.*;
/**
* Used to associate multiple swaps with the same POJO class.
- *
+ *
* <p class='bcode'>
* <ja>@Swaps</ja>(
* {
@@ -31,10 +31,11 @@ import java.lang.annotation.*;
* <jk>public class</jk> MyPojo {}
* </p>
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview > @Swap Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview > @Swap Annotation</a>
+ * </ul>
*/
@Documented
@Target({TYPE})
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/URI.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/URI.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/URI.java
index 985790b..28b497d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/URI.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/URI.java
@@ -19,15 +19,16 @@ import java.lang.annotation.*;
/**
* Used to identify a class or bean property as a URI.
- *
+ *
* <p>
* This annotation allows you to identify other classes that return URIs via <code>toString()</code> as URI objects.
- *
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.URIAnnotation">Overview > @URI Annotation</a>
- * </ul>
+ *
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.URIAnnotation">Overview > @URI Annotation</a>
+ * </ul>
*/
@Documented
@Target({TYPE,FIELD,METHOD})
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParser.java
index 5bc8e66..f64daea 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParser.java
@@ -34,7 +34,7 @@ public class CsvParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public CsvParser(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java
index 9a8eeea..cfbd62c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java
@@ -32,7 +32,7 @@ public class CsvParserBuilder extends ParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public CsvParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserSession.java
index e1a866d..44fbc41 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserSession.java
@@ -17,7 +17,7 @@ import org.apache.juneau.parser.*;
/**
* Session object that lives for the duration of a single use of {@link CsvParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -26,7 +26,7 @@ public final class CsvParserSession extends ReaderParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializer.java
index 1bc274c..5239dfc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializer.java
@@ -34,7 +34,7 @@ public final class CsvSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public CsvSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java
index b1b3984..12c0ff9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java
@@ -32,7 +32,7 @@ public class CsvSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public CsvSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
index 2207228..fcac49a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
@@ -20,7 +20,7 @@ import org.apache.juneau.serializer.*;
/**
* Session object that lives for the duration of a single use of {@link CsvSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -29,7 +29,7 @@ public final class CsvSerializerSession extends WriterSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/Encoder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/Encoder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/Encoder.java
index 35ca3d8..05992db 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/Encoder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/Encoder.java
@@ -16,11 +16,12 @@ import java.io.*;
/**
* Used for enabling decompression on requests and compression on responses, such as support for GZIP compression.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Used to wrap input and output streams within compression/decompression streams.
- *
+ *
* <p>
* Encoders are registered with <code>RestServlets</code> through the <ja>@RestResource.encoders()</ja> annotation.
*/
@@ -28,7 +29,7 @@ public abstract class Encoder {
/**
* Converts the specified compressed input stream into an uncompressed stream.
- *
+ *
* @param is The compressed stream.
* @return The uncompressed stream.
* @throws IOException If any errors occur, such as on a stream that's not a valid GZIP input stream.
@@ -37,7 +38,7 @@ public abstract class Encoder {
/**
* Converts the specified uncompressed output stream into an uncompressed stream.
- *
+ *
* @param os The uncompressed stream.
* @return The compressed stream stream.
* @throws IOException If any errors occur.
@@ -47,7 +48,7 @@ public abstract class Encoder {
/**
* Returns the codings in <code>Content-Encoding</code> and <code>Accept-Encoding</code> headers that this encoder
* handles (e.g. <js>"gzip"</js>).
- *
+ *
* @return The codings that this encoder handles.
*/
public abstract String[] getCodings();
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroup.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
index f7570ae..fca6e77 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
@@ -19,35 +19,36 @@ import org.apache.juneau.http.*;
/**
* Represents the group of {@link Encoder encoders} keyed by codings.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Maintains a set of encoders and the codings that they can handle.
- *
+ *
* <p>
* The {@link #getEncoderMatch(String)} and {@link #getEncoder(String)} methods are then used to find appropriate
* encoders for specific <code>Accept-Encoding</code> and <code>Content-Encoding</code> header values.
- *
+ *
* <h6 class='topic'>Match ordering</h6>
- *
+ *
* Encoders are matched against <code>Accept-Encoding</code> strings in the order they exist in this group.
- *
+ *
* <p>
* Adding new entries will cause the entries to be prepended to the group.
* This allows for previous encoders to be overridden through subsequent calls.
- *
+ *
* <p>
* For example, calling <code>groupBuilder.append(E1.<jk>class</jk>,E2.<jk>class</jk>).append(E3.<jk>class</jk>,
* E4.<jk>class</jk>)</code> will result in the order <code>E3, E4, E1, E2</code>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create an encoder group with support for gzip compression.</jc>
* EncoderGroup g = EncoderGroup.<jsm>create</jsm>().append(GzipEncoder.<jk>class</jk>).build();
- *
+ *
* <jc>// Should return "gzip"</jc>
* String matchedCoding = g.findMatch(<js>"compress;q=1.0, gzip;q=0.8, identity;q=0.5, *;q=0"</js>);
- *
+ *
* <jc>// Get the encoder</jc>
* IEncoder encoder = g.getEncoder(matchedCoding);
* </p>
@@ -85,7 +86,7 @@ public final class EncoderGroup {
/**
* Constructor
- *
+ *
* @param encoders The encoders to add to this group.
*/
public EncoderGroup(Encoder[] encoders) {
@@ -108,13 +109,13 @@ public final class EncoderGroup {
/**
* Returns the coding string for the matching encoder that can handle the specified <code>Accept-Encoding</code>
* or <code>Content-Encoding</code> header value.
- *
+ *
* <p>
* Returns <jk>null</jk> if no encoders can handle it.
- *
+ *
* <p>
* This method is fully compliant with the RFC2616/14.3 and 14.11 specifications.
- *
+ *
* @param acceptEncoding The <code>Accept-Encoding</code> or <code>Content-Encoding</code> value.
* @return The coding value (e.g. <js>"gzip"</js>).
*/
@@ -136,7 +137,7 @@ public final class EncoderGroup {
/**
* Returns the encoder registered with the specified coding (e.g. <js>"gzip"</js>).
- *
+ *
* @param encoding The coding string.
* @return The encoder, or <jk>null</jk> if encoder isn't registered with that coding.
*/
@@ -147,7 +148,7 @@ public final class EncoderGroup {
/**
* Returns the set of codings supported by all encoders in this group.
- *
+ *
* @return An unmodifiable list of codings supported by all encoders in this group. Never <jk>null</jk>.
*/
public List<String> getSupportedEncodings() {
@@ -156,7 +157,7 @@ public final class EncoderGroup {
/**
* Returns the encoders in this group.
- *
+ *
* @return An unmodifiable list of encoders in this group.
*/
public List<Encoder> getEncoders() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
index a055a98..e00ab46 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
@@ -36,7 +36,7 @@ public class EncoderGroupBuilder {
/**
* Clone an existing encoder group builder.
- *
+ *
* @param copyFrom The encoder group that we're copying settings and encoders from.
*/
public EncoderGroupBuilder(EncoderGroup copyFrom) {
@@ -46,7 +46,7 @@ public class EncoderGroupBuilder {
/**
* Registers the specified encoders with this group.
- *
+ *
* @param e The encoders to append to this group.
* @return This object (for method chaining).
*/
@@ -58,7 +58,7 @@ public class EncoderGroupBuilder {
/**
* Registers the specified encoders with this group.
- *
+ *
* @param e The encoders to append to this group.
* @return This object (for method chaining).
*/
@@ -69,7 +69,7 @@ public class EncoderGroupBuilder {
/**
* Registers the specified encoders with this group.
- *
+ *
* @param e The encoders to append to this group.
* @return This object (for method chaining).
*/
@@ -80,7 +80,7 @@ public class EncoderGroupBuilder {
/**
* Registers the encoders in the specified group with this group.
- *
+ *
* @param eg The encoders to append to this group.
* @return This object (for method chaining).
*/
@@ -91,10 +91,10 @@ public class EncoderGroupBuilder {
/**
* Creates a new {@link EncoderGroup} object using a snapshot of the settings defined in this builder.
- *
+ *
* <p>
* This method can be called multiple times to produce multiple encoder groups.
- *
+ *
* @return A new {@link EncoderGroup} object.
*/
public EncoderGroup build() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderMatch.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderMatch.java
index f5ecb3d..9ba9e45 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderMatch.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderMatch.java
@@ -27,7 +27,7 @@ public final class EncoderMatch {
/**
* Returns the encoding of the encoder that matched the HTTP <code>Accept-Encoding</code> header value.
- *
+ *
* @return The encoding of the match.
*/
public String getEncoding() {
@@ -36,7 +36,7 @@ public final class EncoderMatch {
/**
* Returns the encoder that matched the HTTP <code>Accept-Encoding</code> header value.
- *
+ *
* @return The encoder of the match.
*/
public Encoder getEncoder() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/AnchorText.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/AnchorText.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/AnchorText.java
index 3fa31b4..d70f544 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/AnchorText.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/AnchorText.java
@@ -39,7 +39,7 @@ public enum AnchorText {
/**
* Set to the anchor of the URL.
- *
+ *
* <p>
* (e.g. <js>"http://localhost:9080/foobar#anchorTextHere"</js>)
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
index 8779d51..991927e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
@@ -28,7 +28,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Constructor.
- *
+ *
* @param bpm The metadata of the bean property of this additional metadata.
* @throws Exception If render class could not be instantiated.
*/
@@ -78,7 +78,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should be serialized as XML instead of HTML.
- *
+ *
* @return <jk>true</jk> if the the {@link Html @Html} annotation is specified, and {@link Html#asXml() @Html.asXml()} is <jk>true</jk>.
*/
protected boolean isAsXml() {
@@ -87,7 +87,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should be serialized as plain text instead of HTML.
- *
+ *
* @return
* <jk>true</jk> if the the {@link Html @Html} annotation is specified, and {@link Html#asPlainText() @Html.asPlainText()} is
* <jk>true</jk>.
@@ -98,7 +98,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should not be serialized as an HTML table.
- *
+ *
* @return
* <jk>true</jk> if the the {@link Html @Html} annotation is specified, and {@link Html#noTables() @Html.noTables()} is
* <jk>true</jk>.
@@ -109,7 +109,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should not include table headers when serialized as an HTML table.
- *
+ *
* @return
* <jk>true</jk> if the the {@link Html @Html} annotation is specified, and {@link Html#noTableHeaders() @Html.noTableHeaders()} is
* <jk>true</jk>.
@@ -120,10 +120,10 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns the render class for rendering the style and contents of this property value in HTML.
- *
+ *
* <p>
* This value is specified via the {@link Html#render() @Html.render()} annotation.
- *
+ *
* @return The render class, never <jk>null</jk>.
*/
public HtmlRender getRender() {
@@ -132,10 +132,10 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Adds a hyperlink to this value in HTML.
- *
+ *
* <p>
* This value is specified via the {@link Html#link() @Html.link()} annotation.
- *
+ *
* @return The link string, or <jk>null</jk> if not specified.
*/
public String getLink() {
@@ -144,10 +144,10 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Specifies the anchor text for this property.
- *
+ *
* <p>
* This value is specified via the {@link Html#anchorText() @Html.anchorText()} annotation.
- *
+ *
* @return The link string, or <jk>null</jk> if not specified.
*/
public String getAnchorText() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlClassMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlClassMeta.java
index fa1a016..a396958 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlClassMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlClassMeta.java
@@ -28,7 +28,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Constructor.
- *
+ *
* @param cm The class that this annotation is defined on.
*/
public HtmlClassMeta(ClassMeta<?> cm) {
@@ -51,7 +51,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Html @Html} annotation defined on the class.
- *
+ *
* @return The value of the annotation, or <jk>null</jk> if not specified.
*/
protected Html getAnnotation() {
@@ -60,7 +60,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Html#asXml() @Html.asXml()} annotation defined on the class.
- *
+ *
* @return The value of the annotation.
*/
protected boolean isAsXml() {
@@ -69,7 +69,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Html#asPlainText() @Html.asPlainText()} annotation defined on the class.
- *
+ *
* @return The value of the annotation.
*/
protected boolean isAsPlainText() {
@@ -78,7 +78,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Html#noTables() @Html.noTables()} annotation defined on the class.
- *
+ *
* @return The value of the annotation.
*/
protected boolean isNoTables() {
@@ -87,7 +87,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Html#noTableHeaders() @Html.noTableHeaders()} annotation defined on the class.
- *
+ *
* @return The value of the annotation.
*/
public boolean isNoTableHeaders() {
@@ -96,7 +96,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Html#render() @Html.render()} annotation defined on the class.
- *
+ *
* @return The value of the annotation.
*/
public HtmlRender<?> getRender() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java
index 13306ad..467fe5e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java
@@ -17,22 +17,24 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJOs to HTTP responses as HTML documents.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/html</code>
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/html</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/html</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/html</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Same as {@link HtmlSerializer}, except wraps the response in <code><xt><html></code>,
* <code><xt><head></code>, and <code><xt><body></code> tags so that it can be rendered in a browser.
- *
+ *
* <p>
* Configurable properties are typically specified via <ja>@RestResource.properties()</ja> and <ja>@RestMethod.properties()</ja>
* annotations, although they can also be set programmatically via the <code>RestResponse.setProperty()</code> method.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -45,7 +47,7 @@ import org.apache.juneau.serializer.*;
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
- *
+ *
* <p>
* Note that shortcut annotations are also provided for these particular settings:
* <p class='bcode'>
@@ -61,7 +63,7 @@ import org.apache.juneau.serializer.*;
* )
* )
* </p>
- *
+ *
* <p>
* The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the
* <code>messages</code> annotation.
@@ -78,7 +80,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Aside section contents.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.aside.ls"</js>
@@ -86,16 +88,16 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Allows you to specify the contents of the aside section on the HTML page.
* The aside section floats on the right of the page for providing content supporting the serialized content of
* the page.
- *
+ *
* <p>
* By default, the aside section is empty.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -115,7 +117,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Footer section contents.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.footer.ls"</js>
@@ -123,14 +125,14 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Allows you to specify the contents of the footer section on the HTML page.
- *
+ *
* <p>
* By default, the footer section is empty.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -146,7 +148,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Additional head section content.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.head.ls"</js>
@@ -154,11 +156,11 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Adds the specified HTML content to the head section of the page.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -168,7 +170,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* }
* )
* </p>
- *
+ *
* <p>
* A shortcut on <ja>@RestResource</ja> is also provided for this setting:
* <p class='bcode'>
@@ -185,7 +187,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Header section contents.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.ls"</js>
@@ -193,12 +195,12 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -214,7 +216,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Nav section contents.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.nav.ls"</js>
@@ -222,12 +224,12 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -238,7 +240,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* )
* )
* </p>
- *
+ *
* <p>
* When this property is specified, the {@link #HTMLDOC_navlinks} property is ignored.
*/
@@ -246,7 +248,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Page navigation links.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.navlinks.ls"</js>
@@ -254,14 +256,14 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Adds a list of hyperlinks immediately under the title and description but above the content of the page.
- *
+ *
* <p>
* This can be used to provide convenient hyperlinks when viewing the REST interface from a browser.
- *
+ *
* <p>
* The value is an array of strings with two possible values:
* <ul>
@@ -269,7 +271,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <br><js>"google: http://google.com"</js>
* <li>Arbitrary HTML.
* </ul>
- *
+ *
* <p>
* Relative URLs are considered relative to the servlet path.
* For example, if the servlet path is <js>"http://localhost/myContext/myServlet"</js>, and the
@@ -277,7 +279,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* Absolute (<js>"/myOtherContext/foo"</js>) and fully-qualified (<js>"http://localhost2/foo"</js>) URLs
* can also be used in addition to various other protocols specified by {@link UriResolver} such as
* <js>"servlet:/..."</js>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p>
* The <code>AddressBookResource</code> sample class uses this property...
@@ -290,11 +292,11 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
- *
+ *
* <p>
* ...to produce this list of links on the HTML page...
* <img class='bordered' src='doc-files/HTML_LINKS.png'>
- *
+ *
* <p>
* A shortcut on <ja>@RestResource</ja> is also provided for this setting:
* <p class='bcode'>
@@ -318,7 +320,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: No-results message.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.noResultsMessage.s"</js>
@@ -326,11 +328,11 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> <js>"<p>no results</p>"</js>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Allows you to specify the string message used when trying to serialize an empty array or empty list.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -339,7 +341,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* )
* )
* </p>
- *
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -347,7 +349,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Prevent word wrap on page.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.nowrap.b"</js>
@@ -355,7 +357,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Adds <js>"* {white-space:nowrap}"</js> to the CSS instructions on the page to prevent word wrapping.
@@ -364,7 +366,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Javascript code.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.script.ls"</js>
@@ -372,11 +374,11 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Adds the specified Javascript code to the HTML page.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -386,7 +388,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* }
* )
* </p>
- *
+ *
* <p>
* A shortcut on <ja>@RestResource</ja> is also provided for this setting:
* <p class='bcode'>
@@ -408,7 +410,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: CSS style code.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.style.ls"</js>
@@ -416,11 +418,11 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Adds the specified CSS instructions to the HTML page.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -430,7 +432,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* }
* )
* </p>
- *
+ *
* <p>
* A shortcut on <ja>@RestResource</ja> is also provided for this setting:
* <p class='bcode'>
@@ -453,7 +455,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Stylesheet import URLs.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.stylesheet.ls"</js>
@@ -461,11 +463,11 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Adds a link to the specified stylesheet URL.
- *
+ *
* <p>
* Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation.
*/
@@ -478,7 +480,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: HTML document template.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.template.c"</js>
@@ -486,15 +488,15 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> <code>HtmlDocTemplateBasic.<jk>class</jk></code>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies the template to use for serializing the page.
- *
+ *
* <p>
* By default, the {@link HtmlDocTemplateBasic} class is used to construct the contents of the HTML page, but
* can be overridden with your own custom implementation class.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -526,7 +528,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public HtmlDocSerializer(PropertyStore ps) {
@@ -535,7 +537,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
index 2d8fcfc..f152d07 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
@@ -21,10 +21,10 @@ import org.apache.juneau.serializer.*;
/**
* Context object that lives for the duration of a single serialization of {@link HtmlSerializer} and its subclasses.
- *
+ *
* <p>
* See {@link Serializer} for details.
- *
+ *
* <p>
* This class is NOT thread safe. It is meant to be discarded after one-time use.
*/
@@ -38,7 +38,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -85,7 +85,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_style} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_style} setting value in this context.
* An empty array if not specified.
@@ -97,7 +97,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_stylesheet} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_stylesheet} setting value in this context.
* An empty array if not specified.
@@ -109,7 +109,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_script} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_script} setting value in this context.
* An empty array if not specified.
@@ -121,7 +121,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_head} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_head} setting value in this context.
* An empty array if not specified.
@@ -133,7 +133,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_nowrap} setting value in this context.
- *
+ *
* @return The {@link HtmlDocSerializer#HTMLDOC_nowrap} setting value in this context.
*/
public final boolean isNoWrap() {
@@ -142,7 +142,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_header} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_header} setting value in this context.
* <jk>null</jk> if not specified.
@@ -154,7 +154,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_navlinks} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_navlinks} setting value in this context.
* <jk>null</jk> if not specified.
@@ -166,7 +166,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the template to use for generating the HTML page.
- *
+ *
* @return
* The HTML page generator.
* Never <jk>null</jk>.
@@ -177,7 +177,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_nav} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_nav} setting value in this context.
* <jk>null</jk> if not specified.
@@ -189,7 +189,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_aside} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_aside} setting value in this context.
* <jk>null</jk> if not specified.
@@ -201,7 +201,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_footer} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_footer} setting value in this context.
* <jk>null</jk> if not specified.
@@ -213,7 +213,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_noResultsMessage} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_noResultsMessage} setting value in this context.
* <jk>null</jk> if not specified.
@@ -242,7 +242,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Calls the parent {@link #doSerialize(SerializerPipe, Object)} method which invokes just the HTML serializer.
- *
+ *
* @param out
* Where to send the output from the serializer.
* @param o The object being serialized.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
index 562bac9..dc50c51 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
@@ -15,7 +15,7 @@ package org.apache.juneau.html;
/**
* Defines the interface for rendering the contents of an HTML page produced by the {@link HtmlDocSerializer}
* serializer.
- *
+ *
* <p>
* The HTML doc serializer produces the following document structure with the typical contents:
* <p class='bcode'>
@@ -49,7 +49,7 @@ package org.apache.juneau.html;
* </body>
* </html></xt>
* </p>
- *
+ *
* <p>
* This interface allows you to control how these sections get rendered.
*/
@@ -57,7 +57,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><head></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -67,7 +67,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><head></xt>/<xt><style></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -77,7 +77,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><head></xt>/<xt><script></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -87,7 +87,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -97,7 +97,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><header></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -107,7 +107,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><nav></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -117,7 +117,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><article></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -127,7 +127,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><aside></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -137,7 +137,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><footer></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -147,7 +147,7 @@ public interface HtmlDocTemplate {
/**
* Returns <jk>true</jk> if this page should render a <code><xt><head></xt>/<xt><style></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
@@ -155,7 +155,7 @@ public interface HtmlDocTemplate {
/**
* Returns <jk>true</jk> if this page should render a <code><xt><head></xt>/<xt><script></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
@@ -164,7 +164,7 @@ public interface HtmlDocTemplate {
/**
* Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><header></xt></code>
* element.
- *
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
@@ -173,7 +173,7 @@ public interface HtmlDocTemplate {
/**
* Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><nav></xt></code>
* element.
- *
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
@@ -182,7 +182,7 @@ public interface HtmlDocTemplate {
/**
* Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><aside></xt></code>
* element.
- *
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
@@ -191,7 +191,7 @@ public interface HtmlDocTemplate {
/**
* Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><footer></xt></code>
* element.
- *
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
index 1869306..596f758 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
@@ -16,7 +16,7 @@ import org.apache.juneau.internal.*;
/**
* A basic template for the HTML doc serializer.
- *
+ *
* <p>
* This class can be subclassed to customize page rendering.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlLink.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlLink.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlLink.java
index 39fba6f..716ff0a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlLink.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlLink.java
@@ -19,13 +19,13 @@ import java.lang.annotation.*;
/**
* Used in conjunction with the {@link HtmlSerializer} class to define hyperlinks.
- *
+ *
* <p>
* This annotation is applied to classes.
- *
+ *
* <p>
* Annotation that can be used to specify that a class has a URL associated with it.
- *
+ *
* <p>
* When rendered using the {@link org.apache.juneau.html.HtmlSerializer HtmlSerializer} class, this class will get
* rendered as a hyperlink like so...
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParser.java
index 48356e3..1a23296 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParser.java
@@ -18,13 +18,15 @@ import org.apache.juneau.xml.*;
/**
* Parses text generated by the {@link HtmlSerializer} class back into a POJO model.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Content-Type</code> types: <code>text/html</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Content-Type</code> types: <code><b>text/html</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* See the {@link HtmlSerializer} class for a description of the HTML generated.
* <p>
* This class is used primarily for automated testing of the {@link HtmlSerializer} class.
@@ -45,7 +47,7 @@ public class HtmlParser extends XmlParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public HtmlParser(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java
index 6966fa4..d5d4dad 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java
@@ -36,7 +36,7 @@ public class HtmlParserBuilder extends XmlParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public HtmlParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserSession.java
index 61c532e..f7d5d84 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserSession.java
@@ -28,7 +28,7 @@ import org.apache.juneau.xml.*;
/**
* Session object that lives for the duration of a single use of {@link HtmlParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -44,7 +44,7 @@ public final class HtmlParserSession extends XmlParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -520,7 +520,7 @@ public final class HtmlParserSession extends XmlParserSession {
* <p>
* Precondition: Pointing to opening tag.
* Postcondition: Pointing to next opening tag.
- *
+ *
* @param r The stream being read from.
* @throws XMLStreamException
*/
@@ -573,11 +573,11 @@ public final class HtmlParserSession extends XmlParserSession {
/**
* Parses CHARACTERS data.
- *
+ *
* <p>
* Precondition: Pointing to event immediately following opening tag.
* Postcondition: Pointing to closing tag.
- *
+ *
* @param r The stream being read from.
* @return The parsed string.
* @throws XMLStreamException
@@ -664,11 +664,11 @@ public final class HtmlParserSession extends XmlParserSession {
/**
* Identical to {@link #parseText(XmlReader)} except assumes the current event is the opening tag.
- *
+ *
* <p>
* Precondition: Pointing to opening tag.
* Postcondition: Pointing to closing tag.
- *
+ *
* @param r The stream being read from.
* @return The parsed string.
* @throws XMLStreamException
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlRender.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlRender.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlRender.java
index 90e9898..d7ffa0c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlRender.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlRender.java
@@ -17,51 +17,51 @@ import org.apache.juneau.serializer.*;
/**
* Allows custom rendering of bean property values when serialized as HTML.
- *
+ *
* <p>
* Associated with bean properties using the {@link Html#render() @Html.render()} annotation.
- *
+ *
* <p>
* Using this class, you can alter the CSS style and HTML content of the bean property.
- *
+ *
* <p>
* The following example shows two render classes that customize the appearance of the <code>pctFull</code> and
* <code>status</code> columns shown below:
- *
+ *
* <p>
* <img class='bordered' src='doc-files/HtmlRender_1.png'>
- *
+ *
* <p class='bcode'>
* <jc>// Our bean class</jc>
* <jk>public class</jk> FileSpace {
- *
+ *
* <jk>private final</jk> String <jf>drive</jf>;
* <jk>private final long</jk> <jf>total</jf>, <jf>available</jf>;
- *
+ *
* <jk>public</jk> FileSpace(String drive, <jk>long</jk> total, <jk>long</jk> available) {
* <jk>this</jk>.<jf>drive</jf> = drive;
* <jk>this</jk>.<jf>total</jf> = total;
* <jk>this</jk>.<jf>available</jf> = available;
* }
- *
+ *
* <ja>@Html</ja>(link=<js>"drive/{drive}"</js>)
* <jk>public</jk> String getDrive() {
* <jk>return</jk> <jf>drive</jf>;
* }
- *
+ *
* <jk>public long</jk> getTotal() {
* <jk>return</jk> <jf>total</jf>;
* }
- *
+ *
* <jk>public long</jk> getAvailable() {
* <jk>return</jk> <jf>available</jf>;
* }
- *
+ *
* <ja>@Html</ja>(render=FileSpacePctRender.<jk>class</jk>)
* <jk>public float</jk> getPctFull() {
* <jk>return</jk> ((100 * <jf>available</jf>) / <jf>total</jf>);
* }
- *
+ *
* <ja>@Html</ja>(render=FileSpaceStatusRender.<jk>class</jk>)
* <jk>public</jk> FileSpaceStatus getStatus() {
* <jk>float</jk> pf = getPctFull();
@@ -72,15 +72,15 @@ import org.apache.juneau.serializer.*;
* <jk>return</jk> FileSpaceStatus.<jsf>SEVERE</jsf>;
* }
* }
- *
+ *
* <jc>// Possible values for the getStatus() method</jc>
* <jk>public static enum</jk> FileSpaceStatus {
* <jsf>OK</jsf>, <jsf>WARNING</jsf>, <jsf>SEVERE</jsf>;
* }
- *
+ *
* <jc>// Custom render for getPctFull() method</jc>
* <jk>public static class</jk> FileSpacePctRender <jk>extends</jk> HtmlRender<Float> {
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> String getStyle(SerializerSession session, Float value) {
* <jk>if</jk> (value < 80)
@@ -89,7 +89,7 @@ import org.apache.juneau.serializer.*;
* <jk>return</jk> <js>"background-color:yellow;text-align:center"</js>;
* <jk>return</jk> <js>"background-color:red;text-align:center;border:;animation:color_change 0.5s infinite alternate"</js>;
* }
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> Object getContent(SerializerSession session, Float value) {
* <jk>if</jk> (value >= 90)
@@ -100,15 +100,15 @@ import org.apache.juneau.serializer.*;
* <jk>return</jk> String.<jsm>format</jsm>(<js>"%.0f%%"</js>, value);
* }
* }
- *
+ *
* <jc>// Custom render for getStatus() method</jc>
* <jk>public static class</jk> FileSpaceStatusRender <jk>extends</jk> HtmlRender<FileSpaceStatus> {
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> String getStyle(SerializerSession session, FileSpaceStatus value) {
* <jk>return</jk> <js>"text-align:center"</js>;
* }
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> Object getContent(SerializerSession session, FileSpaceStatus value) {
* <jk>switch</jk> (value) {
@@ -119,14 +119,14 @@ import org.apache.juneau.serializer.*;
* }
* }
* </p>
- *
+ *
* @param <T> The bean property type.
*/
public abstract class HtmlRender<T> {
/**
* Returns the CSS style of the element containing the bean property value.
- *
+ *
* @param session
* The current serializer session.
* Can be used to retrieve properties and session-level information.
@@ -139,11 +139,11 @@ public abstract class HtmlRender<T> {
/**
* Returns the delegate value for the specified bean property value.
- *
+ *
* <p>
* The default implementation simply returns the same value.
* A typical use is to return an HTML element using one of the HTML5 DOM beans.
- *
+ *
* @param session
* The current serializer session.
* Can be used to retrieve properties and session-level information.
[24/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Swagger.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
index 1476cd5..9ec40da 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
@@ -21,7 +21,7 @@ import org.apache.juneau.utils.*;
/**
* This is the root document object for the API specification.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -60,14 +60,14 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>swagger</property>.
- *
+ *
* <p>
* Required. Specifies the Swagger Specification version being used.
- *
+ *
* <p>
* It can be used by the Swagger UI and other clients to interpret the API listing.
* The value MUST be <js>"2.0"</js>.
- *
+ *
* @return The value of the <property>swagger</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getSwagger() {
@@ -76,14 +76,14 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>swagger</property>.
- *
+ *
* <p>
* Required. Specifies the Swagger Specification version being used.
- *
+ *
* <p>
* It can be used by the Swagger UI and other clients to interpret the API listing.
* The value MUST be <js>"2.0"</js>.
- *
+ *
* @param swagger The new value for the <property>swagger</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -94,7 +94,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #setSwagger(String)}.
- *
+ *
* @param swagger The new value for the <property>swagger</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -104,13 +104,13 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>info</property>.
- *
+ *
* <p>
* Required. Provides metadata about the API.
- *
+ *
* <p>
* The metadata can be used by the clients if needed.
- *
+ *
* @return The value of the <property>info</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Info getInfo() {
@@ -119,13 +119,13 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>info</property>.
- *
+ *
* <p>
* Required. Provides metadata about the API.
- *
+ *
* <p>
* The metadata can be used by the clients if needed.
- *
+ *
* @param info The new value for the <property>info</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -136,7 +136,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #setInfo(Info)}.
- *
+ *
* @param info The new value for the <property>info</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -146,17 +146,17 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>host</property>.
- *
+ *
* <p>
* The host (name or IP) serving the API.
- *
+ *
* <p>
* This MUST be the host only and does not include the scheme nor sub-paths.
* It MAY include a port.
* If the host is not included, the host serving the documentation is to be used (including the port).
* The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">
* path templating</a>.
- *
+ *
* @return The value of the <property>host</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getHost() {
@@ -165,17 +165,17 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>host</property>.
- *
+ *
* <p>
* The host (name or IP) serving the API.
- *
+ *
* <p>
* This MUST be the host only and does not include the scheme nor sub-paths.
* It MAY include a port.
* If the host is not included, the host serving the documentation is to be used (including the port).
* The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">
* path templating</a>.
- *
+ *
* @param host The new value for the <property>host</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -186,7 +186,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #setHost(String)}.
- *
+ *
* @param host The new value for the <property>host</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -196,16 +196,16 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>basePath</property>.
- *
+ *
* <p>
* The base path on which the API is served, which is relative to the <code>host</code>.
- *
+ *
* <p>
* If it is not included, the API is served directly under the <code>host</code>.
* The value MUST start with a leading slash (/).
* The <code>basePath</code> does not support <a class="doclink"
* href="http://swagger.io/specification/#pathTemplating">path templating</a>.
- *
+ *
* @return The value of the <property>basePath</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getBasePath() {
@@ -214,16 +214,16 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>basePath</property>.
- *
+ *
* <p>
* The base path on which the API is served, which is relative to the <code>host</code>.
- *
+ *
* <p>
* If it is not included, the API is served directly under the <code>host</code>.
* The value MUST start with a leading slash (/).
* The <code>basePath</code> does not support <a class="doclink"
* href="http://swagger.io/specification/#pathTemplating">path templating</a>.
- *
+ *
* @param basePath The new value for the <property>basePath</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -234,7 +234,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #setBasePath(String)}.
- *
+ *
* @param basePath The new value for the <property>basePath</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -244,15 +244,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>schemes</property>.
- *
+ *
* <p>
* The transfer protocol of the API.
- *
+ *
* <p>
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
* If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
* definition itself.
- *
+ *
* @return The value of the <property>schemes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<String> getSchemes() {
@@ -261,15 +261,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>schemes</property>.
- *
+ *
* <p>
* The transfer protocol of the API.
- *
+ *
* <p>
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
* If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
* definition itself.
- *
+ *
* @param schemes The new value for the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -280,15 +280,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>schemes</property>.
- *
+ *
* <p>
* The transfer protocol of the API.
- *
+ *
* <p>
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
* If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
* definition itself.
- *
+ *
* @param schemes The values to add for the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -298,15 +298,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>schemes</property>.
- *
+ *
* <p>
* The transfer protocol of the API.
- *
+ *
* <p>
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
* If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
* definition itself.
- *
+ *
* @param schemes The values to add for the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -321,7 +321,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #addSchemes(String...)}.
- *
+ *
* @param schemes The values to add for the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -331,15 +331,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>consumes</property>.
- *
+ *
* <p>
* A list of MIME types the APIs can consume.
- *
+ *
* <p>
* This is global to all APIs but can be overridden on specific API calls.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
* Mime Types</a>.
- *
+ *
* @return The value of the <property>consumes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<MediaType> getConsumes() {
@@ -348,15 +348,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>consumes</property>.
- *
+ *
* <p>
* A list of MIME types the APIs can consume.
- *
+ *
* <p>
* This is global to all APIs but can be overridden on specific API calls.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
* Mime Types</a>.
- *
+ *
* @param consumes The new value for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -367,15 +367,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>consumes</property>.
- *
+ *
* <p>
* A list of MIME types the APIs can consume.
- *
+ *
* <p>
* This is global to all APIs but can be overridden on specific API calls.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
* Mime Types</a>.
- *
+ *
* @param consumes The values to add for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -385,15 +385,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>consumes</property>.
- *
+ *
* <p>
* A list of MIME types the APIs can consume.
- *
+ *
* <p>
* This is global to all APIs but can be overridden on specific API calls.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
* Mime Types</a>.
- *
+ *
* @param consumes The values to add for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -408,7 +408,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #addConsumes(MediaType...)}.
- *
+ *
* @param consumes The values to add for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -418,7 +418,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #addConsumes(Collection)}.
- *
+ *
* @param consumes The values to add for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -428,15 +428,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>produces</property>.
- *
+ *
* <p>
* A list of MIME types the APIs can produce.
- *
+ *
* <p>
* This is global to all APIs but can be overridden on specific API calls.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
* Mime Types</a>.
- *
+ *
* @return The value of the <property>produces</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<MediaType> getProduces() {
@@ -445,15 +445,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>produces</property>.
- *
+ *
* <p>
* A list of MIME types the APIs can produce.
- *
+ *
* <p>
* This is global to all APIs but can be overridden on specific API calls.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
* Mime Types</a>.
- *
+ *
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -464,15 +464,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>produces</property>.
- *
+ *
* <p>
* A list of MIME types the APIs can produce.
- *
+ *
* <p>
* This is global to all APIs but can be overridden on specific API calls.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
* Mime Types</a>.
- *
+ *
* @param produces The values to add for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -482,15 +482,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>produces</property>.
- *
+ *
* <p>
* A list of MIME types the APIs can produce.
- *
+ *
* <p>
* This is global to all APIs but can be overridden on specific API calls.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
* Mime Types</a>.
- *
+ *
* @param produces The values to add for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -505,7 +505,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #addProduces(MediaType...)}.
- *
+ *
* @param produces The values to add for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -515,7 +515,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #addProduces(Collection)}.
- *
+ *
* @param produces The values to add for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -525,10 +525,10 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>paths</property>.
- *
+ *
* <p>
* Required. The available paths and operations for the API.
- *
+ *
* @return The value of the <property>paths</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,Map<String,Operation>> getPaths() {
@@ -537,10 +537,10 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>paths</property>.
- *
+ *
* <p>
* Required. The available paths and operations for the API.
- *
+ *
* @param paths The new value for the <property>paths</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -551,10 +551,10 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>paths</property>.
- *
+ *
* <p>
* Required. The available paths and operations for the API.
- *
+ *
* @param path The path template.
* @param methodName The HTTP method name.
* @param operation The operation that describes the path.
@@ -574,7 +574,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #path(String,String,Operation)}.
- *
+ *
* @param path The path template.
* @param methodName The HTTP method name.
* @param operation The operation that describes the path.
@@ -586,10 +586,10 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>definitions</property>.
- *
+ *
* <p>
* An object to hold data types produced and consumed by operations.
- *
+ *
* @return
* The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -599,10 +599,10 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>definitions</property>.
- *
+ *
* <p>
* An object to hold data types produced and consumed by operations.
- *
+ *
* @param definitions The new value for the <property>definitions</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -613,10 +613,10 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>definitions</property>.
- *
+ *
* <p>
* An object to hold data types produced and consumed by operations.
- *
+ *
* @param name A definition name.
* @param schema The schema that the name defines.
* @return This object (for method chaining).
@@ -630,7 +630,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #addDefinition(String,SchemaInfo)}.
- *
+ *
* @param name A definition name.
* @param schema The schema that the name defines.
* @return This object (for method chaining).
@@ -641,13 +641,13 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>parameters</property>.
- *
+ *
* <p>
* An object to hold parameters that can be used across operations.
- *
+ *
* <p>
* This property does not define global parameters for all operations.
- *
+ *
* @return The value of the <property>parameters</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,ParameterInfo> getParameters() {
@@ -656,13 +656,13 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>parameters</property>.
- *
+ *
* <p>
* An object to hold parameters that can be used across operations.
- *
+ *
* <p>
* This property does not define global parameters for all operations.
- *
+ *
* @param parameters The new value for the <property>parameters</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -673,13 +673,13 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>parameters</property>.
- *
+ *
* <p>
* An object to hold parameters that can be used across operations.
- *
+ *
* <p>
* This property does not define global parameters for all operations.
- *
+ *
* @param name The parameter name.
* @param parameter The parameter definition.
* @return This object (for method chaining).
@@ -693,7 +693,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #addParameter(String,ParameterInfo)}.
- *
+ *
* @param name The parameter name.
* @param parameter The parameter definition.
* @return This object (for method chaining).
@@ -704,13 +704,13 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>responses</property>.
- *
+ *
* <p>
* An object to hold responses that can be used across operations.
- *
+ *
* <p>
* This property does not define global responses for all operations.
- *
+ *
* @return The value of the <property>responses</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,ResponseInfo> getResponses() {
@@ -719,13 +719,13 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>responses</property>.
- *
+ *
* <p>
* An object to hold responses that can be used across operations.
- *
+ *
* <p>
* This property does not define global responses for all operations.
- *
+ *
* @param responses The new value for the <property>responses</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -736,13 +736,13 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>responses</property>.
- *
+ *
* <p>
* An object to hold responses that can be used across operations.
- *
+ *
* <p>
* This property does not define global responses for all operations.
- *
+ *
* @param name The response name.
* @param response The response definition.
* @return This object (for method chaining).
@@ -756,7 +756,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #addResponse(String,ResponseInfo)}.
- *
+ *
* @param name The response name.
* @param response The response definition.
* @return This object (for method chaining).
@@ -767,10 +767,10 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>securityDefinitions</property>.
- *
+ *
* <p>
* Security scheme definitions that can be used across the specification.
- *
+ *
* @return
* The value of the <property>securityDefinitions</property> property on this bean, or <jk>null</jk> if it
* is not set.
@@ -781,10 +781,10 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>securityDefinitions</property>.
- *
+ *
* <p>
* Security scheme definitions that can be used across the specification.
- *
+ *
* @param securityDefinitions The new value for the <property>securityDefinitions</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -795,10 +795,10 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>securityDefinitions</property>.
- *
+ *
* <p>
* Security scheme definitions that can be used across the specification.
- *
+ *
* @param name A security name.
* @param securityScheme A security schema.
* @return This object (for method chaining).
@@ -812,7 +812,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #addSecurityDefinition(String,SecurityScheme)}.
- *
+ *
* @param name A security name.
* @param securityScheme A security schema.
* @return This object (for method chaining).
@@ -823,15 +823,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>security</property>.
- *
+ *
* <p>
* A declaration of which security schemes are applied for the API as a whole.
- *
+ *
* <p>
* The list of values describes alternative security schemes that can be used (that is, there is a logical OR
* between the security requirements).
* Individual operations can override this definition.
- *
+ *
* @return The value of the <property>security</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Map<String,List<String>>> getSecurity() {
@@ -840,15 +840,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>security</property>.
- *
+ *
* <p>
* A declaration of which security schemes are applied for the API as a whole.
- *
+ *
* <p>
* The list of values describes alternative security schemes that can be used (that is, there is a logical OR
* between the security requirements).
* Individual operations can override this definition.
- *
+ *
* @param security The new value for the <property>security</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -859,15 +859,15 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>security</property>.
- *
+ *
* <p>
* A declaration of which security schemes are applied for the API as a whole.
- *
+ *
* <p>
* The list of values describes alternative security schemes that can be used (that is, there is a logical OR
* between the security requirements).
* Individual operations can override this definition.
- *
+ *
* @param security The value to add for the <property>security</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -880,7 +880,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #addSecurity(Map)}.
- *
+ *
* @param scheme The security scheme that applies to this operation
* @param alternatives The list of values describes alternative security schemes that can be used (that is, there
* is a logical OR between the security requirements).
@@ -894,17 +894,17 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>tags</property>.
- *
+ *
* <p>
* A list of tags used by the specification with additional metadata.
- *
+ *
* <p>
* The order of the tags can be used to reflect on their order by the parsing tools.
* Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">
* Operation Object</a> must be declared.
* The tags that are not declared may be organized randomly or based on the tools' logic.
* Each tag name in the list MUST be unique.
- *
+ *
* @return The value of the <property>tags</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Tag> getTags() {
@@ -913,17 +913,17 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>tags</property>.
- *
+ *
* <p>
* A list of tags used by the specification with additional metadata.
- *
+ *
* <p>
* The order of the tags can be used to reflect on their order by the parsing tools.
* Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">
* Operation Object</a> must be declared.
* The tags that are not declared may be organized randomly or based on the tools' logic.
* Each tag name in the list MUST be unique.
- *
+ *
* @param tags The new value for the <property>tags</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -934,17 +934,17 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>tags</property>.
- *
+ *
* <p>
* A list of tags used by the specification with additional metadata.
- *
+ *
* <p>
* The order of the tags can be used to reflect on their order by the parsing tools.
* Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">
* Operation Object</a> must be declared.
* The tags that are not declared may be organized randomly or based on the tools' logic.
* Each tag name in the list MUST be unique.
- *
+ *
* @param tags The values to add for the <property>tags</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -957,7 +957,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #addTags(Tag...)}.
- *
+ *
* @param tags The values to add for the <property>tags</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -967,7 +967,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #setTags(List)}.
- *
+ *
* @param tags The values to add for the <property>tags</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -977,10 +977,10 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>externalDocs</property>.
- *
+ *
* <p>
* Additional external documentation.
- *
+ *
* @return
* The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -991,10 +991,10 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>externalDocs</property>.
- *
+ *
* <p>
* Additional external documentation.
- *
+ *
* @param externalDocs The new value for the <property>externalDocs</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1005,7 +1005,7 @@ public class Swagger extends SwaggerElement {
/**
* Synonym for {@link #setExternalDocs(ExternalDocumentation)}.
- *
+ *
* @param externalDocs The new value for the <property>externalDocs</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
index 9e96614..2791c09 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
@@ -18,7 +18,7 @@ import org.apache.juneau.*;
/**
* Various useful static methods for creating Swagger elements.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -38,7 +38,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Contact} element.
- *
+ *
* @return The new element.
*/
public static final Contact contact() {
@@ -47,7 +47,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Contact} element with the specified {@link Contact#name(String)} attribute.
- *
+ *
* @param name The {@link Contact#name(String)} attribute.
* @return The new element.
*/
@@ -58,7 +58,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Contact} element with the specified {@link Contact#name(String)}, {@link Contact#url(Object)},
* and {@link Contact#email(String)}, attributes.
- *
+ *
* @param name The {@link Contact#name(String)} attribute.
* @param url
* The {@link Contact#url(Object)} attribute.
@@ -74,7 +74,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link ExternalDocumentation} element.
- *
+ *
* @return The new element.
*/
public static final ExternalDocumentation externalDocumentation() {
@@ -84,7 +84,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link ExternalDocumentation} element with the specified {@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}.
@@ -99,7 +99,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link ExternalDocumentation} element with the specified {@link ExternalDocumentation#url(Object)}
* and {@link ExternalDocumentation#description(String)} attributes.
- *
+ *
* @param url
* The {@link ExternalDocumentation#url(Object)} attribute.
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
@@ -114,7 +114,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link HeaderInfo} element.
- *
+ *
* @return The new element.
*/
public static final HeaderInfo headerInfo() {
@@ -123,7 +123,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link HeaderInfo} element with the specified {@link HeaderInfo#type(String)} attribute.
- *
+ *
* @param type The {@link HeaderInfo#type(String)} attribute.
* @return The new element.
*/
@@ -133,7 +133,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link HeaderInfo} element with the specified {@link HeaderInfo#type(String)} attribute.
- *
+ *
* @param type The {@link HeaderInfo#type(String)} attribute.
* @return The new element.
*/
@@ -143,7 +143,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Info} element.
- *
+ *
* @return The new element.
*/
public static final Info info() {
@@ -153,7 +153,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Info} element with the specified {@link Info#title(String)} and {@link Info#version(String)}
* attributes.
- *
+ *
* @param title The {@link Info#title(String)} attribute.
* @param version The {@link Info#version(String)} attribute.
* @return The new element.
@@ -164,7 +164,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Items} element.
- *
+ *
* @return The new element.
*/
public static final Items items() {
@@ -173,7 +173,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Items} element with the specified {@link Items#type(String)} attribute.
- *
+ *
* @param type The {@link Items#type(String)} attribute.
* @return The new element.
*/
@@ -183,7 +183,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Items} element with the specified {@link Items#type(String)} attribute.
- *
+ *
* @param type The {@link Items#type(String)} attribute.
* @return The new element.
*/
@@ -193,7 +193,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link License} element.
- *
+ *
* @return The new element.
*/
public static final License license() {
@@ -202,7 +202,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link License} element with the specified {@link License#name(String)} attribute.
- *
+ *
* @param name The {@link License#name(String)} attribute.
* @return The new element.
*/
@@ -212,7 +212,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Operation} element.
- *
+ *
* @return The new element.
*/
public static final Operation operation() {
@@ -221,7 +221,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link ParameterInfo} element.
- *
+ *
* @return The new element.
*/
public static final ParameterInfo parameterInfo() {
@@ -231,7 +231,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link ParameterInfo} element with the specified {@link ParameterInfo#in(String)} and
* {@link ParameterInfo#name(String)} attributes.
- *
+ *
* @param in The {@link ParameterInfo#in(String)} attribute.
* @param name The {@link ParameterInfo#name(String)} attribute.
* @return The new element.
@@ -243,7 +243,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link ParameterInfo} element with the specified {@link ParameterInfo#in(String)} and
* {@link ParameterInfo#name(String)} attributes.
- *
+ *
* @param in The {@link ParameterInfo#in(String)} attribute.
* @param name The {@link ParameterInfo#name(String)} attribute.
* @return The new element.
@@ -254,7 +254,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link ResponseInfo} element.
- *
+ *
* @return The new element.
*/
public static final ResponseInfo responseInfo() {
@@ -263,7 +263,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link ResponseInfo} element with the specified {@link ResponseInfo#description(String)} attribute.
- *
+ *
* @param description The {@link ResponseInfo#description(String)} attribute.
* @return The new element.
*/
@@ -273,7 +273,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link SchemaInfo} element.
- *
+ *
* @return The new element.
*/
public static final SchemaInfo schemaInfo() {
@@ -282,7 +282,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link SecurityScheme} element.
- *
+ *
* @return The new element.
*/
public static final SecurityScheme securityScheme() {
@@ -291,7 +291,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link SecurityScheme} element with the specified {@link SecurityScheme#type(String)} attribute.
- *
+ *
* @param type The {@link SecurityScheme#type(String)} attribute.
* @return The new element.
*/
@@ -301,7 +301,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link SecurityScheme} element with the specified {@link SecurityScheme#type(String)} attribute.
- *
+ *
* @param type The {@link SecurityScheme#type(String)} attribute.
* @return The new element.
*/
@@ -311,7 +311,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Swagger} element.
- *
+ *
* @return The new element.
*/
public static final Swagger swagger() {
@@ -320,7 +320,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Swagger} element with the specified {@link Swagger#info(Info)} attribute.
- *
+ *
* @param info The {@link Swagger#info(Info)} attribute.
* @return The new element.
*/
@@ -330,7 +330,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Tag} element.
- *
+ *
* @return The new element.
*/
public static final Tag tag() {
@@ -339,7 +339,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Tag} element with the specified {@link Tag#name(String)} attribute.
- *
+ *
* @param name The {@link Tag#name(String)} attribute.
* @return The new element.
*/
@@ -349,7 +349,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Xml} element.
- *
+ *
* @return The new element.
*/
public static final Xml xml() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
index ed41bdd..9738a38 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
@@ -14,7 +14,7 @@ package org.apache.juneau.dto.swagger;
/**
* Root class for all Swagger beans.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -36,7 +36,7 @@ public class SwaggerElement {
/**
* Returns <jk>true</jk> if contents should be validated per the Swagger spec.
- *
+ *
* @return <jk>true</jk> if contents should be validated per the Swagger spec.
*/
protected boolean isStrict() {
@@ -45,7 +45,7 @@ public class SwaggerElement {
/**
* Sets strict mode on this bean.
- *
+ *
* @return This object (for method chaining).
*/
protected SwaggerElement strict() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Tag.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Tag.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Tag.java
index b659bbf..e1dc5c5 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Tag.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Tag.java
@@ -16,10 +16,10 @@ import org.apache.juneau.annotation.*;
/**
* Allows adding meta data to a single tag that is used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a>.
- *
+ *
* <p>
* It is not mandatory to have a Tag Object per tag used there.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <js>"description"</js>: <js>"Pets operations"</js>
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -52,10 +52,10 @@ public class Tag extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
- *
+ *
* <p>
* Required. The name of the tag.
- *
+ *
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getName() {
@@ -64,10 +64,10 @@ public class Tag extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
- *
+ *
* <p>
* Required. The name of the tag.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -78,7 +78,7 @@ public class Tag extends SwaggerElement {
/**
* Synonym for {@link #setName(String)}.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -88,14 +88,14 @@ public class Tag extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* A short description for the tag.
- *
+ *
* <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
- *
+ *
* @return
* The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -105,14 +105,14 @@ public class Tag extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* A short description for the tag.
- *
+ *
* <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -123,7 +123,7 @@ public class Tag extends SwaggerElement {
/**
* Synonym for {@link #setDescription(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -133,10 +133,10 @@ public class Tag extends SwaggerElement {
/**
* Bean property getter: <property>externalDocs</property>.
- *
+ *
* <p>
* Additional external documentation for this tag.
- *
+ *
* @return
* The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -146,10 +146,10 @@ public class Tag extends SwaggerElement {
/**
* Bean property setter: <property>externalDocs</property>.
- *
+ *
* <p>
* Additional external documentation for this tag.
- *
+ *
* @param externalDocs The new value for the <property>externalDocs</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -160,7 +160,7 @@ public class Tag extends SwaggerElement {
/**
* Synonym for {@link #setExternalDocs(ExternalDocumentation)}.
- *
+ *
* @param externalDocs The new value for the <property>externalDocs</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Xml.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Xml.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Xml.java
index 3e39b9c..c856b01 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Xml.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Xml.java
@@ -16,11 +16,11 @@ import org.apache.juneau.annotation.*;
/**
* A metadata object that allows for more fine-tuned XML model definitions.
- *
+ *
* <p>
* When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be
* used to add that information.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -47,17 +47,17 @@ public class Xml extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
- *
+ *
* <p>
* Replaces the name of the element/attribute used for the described schema property.
- *
+ *
* <p>
* When defined within the Items Object (<code>items</code>), it will affect the name of the individual XML elements
* within the list.
* When defined alongside <code>type</code> being array (outside the <code>items</code>), it will affect the
* wrapping element and only if wrapped is <jk>true</jk>.
* If wrapped is <jk>false</jk>, it will be ignored.
- *
+ *
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getName() {
@@ -66,17 +66,17 @@ public class Xml extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
- *
+ *
* <p>
* Replaces the name of the element/attribute used for the described schema property.
- *
+ *
* <p>
* When defined within the Items Object (<code>items</code>), it will affect the name of the individual XML elements
* within the list.
* When defined alongside <code>type</code> being array (outside the <code>items</code>), it will affect the
* wrapping element and only if wrapped is <jk>true</jk>.
* If wrapped is <jk>false</jk>, it will be ignored.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -87,7 +87,7 @@ public class Xml extends SwaggerElement {
/**
* Synonym for {@link #setName(String)}.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -97,10 +97,10 @@ public class Xml extends SwaggerElement {
/**
* Bean property getter: <property>namespace</property>.
- *
+ *
* <p>
* The URL of the namespace definition. Value SHOULD be in the form of a URL.
- *
+ *
* @return The value of the <property>namespace</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getNamespace() {
@@ -109,10 +109,10 @@ public class Xml extends SwaggerElement {
/**
* Bean property setter: <property>namespace</property>.
- *
+ *
* <p>
* The URL of the namespace definition. Value SHOULD be in the form of a URL.
- *
+ *
* @param namespace The new value for the <property>namespace</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -123,7 +123,7 @@ public class Xml extends SwaggerElement {
/**
* Synonym for {@link #setNamespace(String)}.
- *
+ *
* @param namespace The new value for the <property>namespace</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -133,10 +133,10 @@ public class Xml extends SwaggerElement {
/**
* Bean property getter: <property>prefix</property>.
- *
+ *
* <p>
* The prefix to be used for the name.
- *
+ *
* @return The value of the <property>prefix</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getPrefix() {
@@ -145,10 +145,10 @@ public class Xml extends SwaggerElement {
/**
* Bean property setter: <property>prefix</property>.
- *
+ *
* <p>
* The prefix to be used for the name.
- *
+ *
* @param prefix The new value for the <property>prefix</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -159,7 +159,7 @@ public class Xml extends SwaggerElement {
/**
* Synonym for {@link #setPrefix(String)}.
- *
+ *
* @param prefix The new value for the <property>prefix</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -169,13 +169,13 @@ public class Xml extends SwaggerElement {
/**
* Bean property getter: <property>attribute</property>.
- *
+ *
* <p>
* Declares whether the property definition translates to an attribute instead of an element.
- *
+ *
* <p>
* Default value is <jk>false</jk>.
- *
+ *
* @return The value of the <property>attribute</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Boolean getAttribute() {
@@ -184,13 +184,13 @@ public class Xml extends SwaggerElement {
/**
* Bean property setter: <property>attribute</property>.
- *
+ *
* <p>
* Declares whether the property definition translates to an attribute instead of an element.
- *
+ *
* <p>
* Default value is <jk>false</jk>.
- *
+ *
* @param attribute The new value for the <property>attribute</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -201,7 +201,7 @@ public class Xml extends SwaggerElement {
/**
* Synonym for {@link #setAttribute(Boolean)}.
- *
+ *
* @param attribute The new value for the <property>attribute</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -211,10 +211,10 @@ public class Xml extends SwaggerElement {
/**
* Bean property getter: <property>wrapped</property>.
- *
+ *
* <p>
* MAY be used only for an array definition.
- *
+ *
* <p>
* Signifies whether the array is wrapped (for example,
* <code><books><book/><book/><books></code>) or unwrapped
@@ -222,7 +222,7 @@ public class Xml extends SwaggerElement {
* Default value is <jk>false</jk>.
* The definition takes effect only when defined alongside <code>type</code> being <code>array</code>
* (outside the <code>items</code>).
- *
+ *
* @return The value of the <property>wrapped</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Boolean getWrapped() {
@@ -231,10 +231,10 @@ public class Xml extends SwaggerElement {
/**
* Bean property setter: <property>wrapped</property>.
- *
+ *
* <p>
* MAY be used only for an array definition.
- *
+ *
* <p>
* Signifies whether the array is wrapped (for example,
* <code><books><book/><book/><books></code>) or unwrapped
@@ -242,7 +242,7 @@ public class Xml extends SwaggerElement {
* Default value is <jk>false</jk>.
* The definition takes effect only when defined alongside <code>type</code> being <code>array</code>
* (outside the <code>items</code>).
- *
+ *
* @param wrapped The new value for the <property>wrapped</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -253,7 +253,7 @@ public class Xml extends SwaggerElement {
/**
* Synonym for {@link #setWrapped(Boolean)}.
- *
+ *
* @param wrapped The new value for the <property>wrapped</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfBeanMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfBeanMeta.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfBeanMeta.java
index 214af31..af69531 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfBeanMeta.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfBeanMeta.java
@@ -26,7 +26,7 @@ public class RdfBeanMeta extends BeanMetaExtended {
/**
* Constructor.
- *
+ *
* @param beanMeta The metadata on the bean that this metadata applies to.
*/
public RdfBeanMeta(BeanMeta<?> beanMeta) {
@@ -45,7 +45,7 @@ public class RdfBeanMeta extends BeanMetaExtended {
/**
* Returns <jk>true</jk> if one of the properties on this bean is annotated with {@link Rdf#beanUri() @Rdf.beanUri()} as
* <jk>true</jk>
- *
+ *
* @return <jk>true</jk> if there is a URI property associated with this bean.
*/
public boolean hasBeanUri() {
@@ -54,7 +54,7 @@ public class RdfBeanMeta extends BeanMetaExtended {
/**
* Returns the bean property marked as the URI for the bean (annotated with {@link Rdf#beanUri() @Rdf.beanUri()} as <jk>true</jk>).
- *
+ *
* @return The URI property, or <jk>null</jk> if no URI property exists on this bean.
*/
public BeanPropertyMeta getBeanUriProperty() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfBeanPropertyMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfBeanPropertyMeta.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfBeanPropertyMeta.java
index fac2f82..dd1de16 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfBeanPropertyMeta.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfBeanPropertyMeta.java
@@ -32,7 +32,7 @@ public class RdfBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Constructor.
- *
+ *
* @param bpm The metadata of the bean property of this additional metadata.
*/
public RdfBeanPropertyMeta(BeanPropertyMeta bpm) {
@@ -54,7 +54,7 @@ public class RdfBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns the RDF collection format of this property from the {@link Rdf#collectionFormat} annotation on this bean
* property.
- *
+ *
* @return The RDF collection format, or {@link RdfCollectionFormat#DEFAULT} if annotation not specified.
*/
protected RdfCollectionFormat getCollectionFormat() {
@@ -77,7 +77,7 @@ public class RdfBeanPropertyMeta extends BeanPropertyMetaExtended {
* <li>Bean interfaces.
* <li>Bean interface packages.
* </ol>
- *
+ *
* @return The namespace associated with this bean property, or <jk>null</jk> if no namespace is associated with it.
*/
public Namespace getNamespace() {
@@ -86,7 +86,7 @@ public class RdfBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns <jk>true</jk> if this bean property is marked with {@link Rdf#beanUri() @Rdf.beanUri()} as <jk>true</jk>.
- *
+ *
* @return <jk>true</jk> if this bean property annotation is <jk>true</jk>.
*/
public boolean isBeanUri() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfClassMeta.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfClassMeta.java
index b3a75ab..a7d4e0b 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfClassMeta.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfClassMeta.java
@@ -31,7 +31,7 @@ public class RdfClassMeta extends ClassMetaExtended {
/**
* Constructor.
- *
+ *
* @param cm The class that this annotation is defined on.
*/
public RdfClassMeta(ClassMeta<?> cm) {
@@ -50,7 +50,7 @@ public class RdfClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Rdf @Rdf} annotation defined on the class.
- *
+ *
* @return The value of the annotation, or <jk>null</jk> if annotation is not specified.
*/
protected Rdf getAnnotation() {
@@ -59,7 +59,7 @@ public class RdfClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Rdf#collectionFormat() @Rdf.collectionFormat()} annotation defined on the class.
- *
+ *
* @return The value of the annotation, or <jk>null</jk> if annotation is not
* specified.
*/
@@ -80,7 +80,7 @@ public class RdfClassMeta extends ClassMetaExtended {
* <li>Interfaces.
* <li>Interface packages.
* </ol>
- *
+ *
* @return The namespace associated with this class, or <jk>null</jk> if no namespace is associated with it.
*/
protected Namespace getNamespace() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfCommon.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfCommon.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfCommon.java
index bacfacd..a7dde06 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfCommon.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfCommon.java
@@ -725,25 +725,25 @@ public interface RdfCommon {
* <p>
* This setting is typically only useful if the beans being parsed into do not have a bean property
* annotated with {@link Rdf#beanUri @Rdf(beanUri=true)}.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* WriterSerializer s = RdfSerializer.<jsm>create</jsm>().xmlabbrev().looseCollections(<jk>true</jk>).build();
* ReaderParser p = RdfParser.<jsm>create</jsm>().xml().looseCollections(<jk>true</jk>).build();
- *
+ *
* List<MyBean> l = createListOfMyBeans();
- *
+ *
* <jc>// Serialize to RDF/XML as loose resources</jc>
* String rdfXml = s.serialize(l);
- *
+ *
* <jc>// Parse back into a Java collection</jc>
* l = p.parse(rdfXml, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);
- *
+ *
* MyBean[] b = createArrayOfMyBeans();
- *
+ *
* <jc>// Serialize to RDF/XML as loose resources</jc>
* String rdfXml = s.serialize(b);
- *
+ *
* <jc>// Parse back into a bean array</jc>
* b = p.parse(rdfXml, MyBean[].<jk>class</jk>);
* </p>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java
index 9f40dae..2d625af 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParser.java
@@ -22,7 +22,7 @@ import org.apache.juneau.xml.*;
/**
* Parses RDF into POJOs.
- *
+ *
* <h6 class='topic'>Behavior-specific subclasses</h6>
*
* The following direct subclasses are provided for language-specific parsers:
@@ -36,10 +36,12 @@ import org.apache.juneau.xml.*;
* <li>
* {@link RdfParser.N3} - N3.
* </ul>
- *
- * <h5 class='section'>Additional information:</h5>
*
- * See <a class="doclink" href="package-summary.html#TOC">RDF Overview</a> for an overview of RDF support in Juneau.
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="package-summary.html#TOC">org.apache.juneau.jena > RDF Overview</a>
+ * </ul>
*/
public class RdfParser extends ReaderParser implements RdfCommon {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java
index 2b46280..724c381 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserBuilder.java
@@ -109,7 +109,7 @@ public class RdfParserBuilder extends ParserBuilder {
* <ul>
* <li class='jf'>{@link RdfParser#RDF_juneauNs}
* </ul>
- *
+ *
* @param value
* The new value for this property.
* <br>The default is <code>{j:<js>'http://www.apache.org/juneau/'</js>}</code>.
@@ -156,7 +156,7 @@ public class RdfParserBuilder extends ParserBuilder {
* <ul>
* <li class='jf'>{@link RdfParser#RDF_language}
* </ul>
- *
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserSession.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserSession.java
index 1dc8dfb..bf43e7b 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserSession.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfParserSession.java
@@ -29,7 +29,7 @@ import com.hp.hpl.jena.util.iterator.*;
/**
* Session object that lives for the duration of a single use of {@link RdfParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -48,7 +48,7 @@ public class RdfParserSession extends ReaderParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializer.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializer.java
index 82312a6..c4ff2c0 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializer.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializer.java
@@ -23,7 +23,7 @@ import org.apache.juneau.xml.*;
/**
* Serializes POJOs to RDF.
- *
+ *
* <h6 class='topic'>Behavior-specific subclasses</h6>
*
* The following direct subclasses are provided for language-specific serializers:
@@ -34,10 +34,12 @@ import org.apache.juneau.xml.*;
* <li>{@link RdfSerializer.Turtle} - TURTLE.
* <li>{@link RdfSerializer.N3} - N3.
* </ul>
- *
- * <h5 class='section'>Additional information:</h5>
*
- * See <a class="doclink" href="package-summary.html#TOC">RDF Overview</a> for an overview of RDF support in Juneau.
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="package-summary.html#TOC">org.apache.juneau.jena > RDF Overview</a>
+ * </ul>
*/
public class RdfSerializer extends WriterSerializer implements RdfCommon {
@@ -310,7 +312,7 @@ public class RdfSerializer extends WriterSerializer implements RdfCommon {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
@@ -352,7 +354,7 @@ public class RdfSerializer extends WriterSerializer implements RdfCommon {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java
index fa17be7..25ea523 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerBuilder.java
@@ -95,7 +95,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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RdfSerializer#RDF_addRootProperty}
@@ -115,7 +115,7 @@ public class RdfSerializerBuilder extends SerializerBuilder {
*
* <p>
* Shortcut for calling <code>addRootProperty(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RdfSerializer#RDF_addRootProperty}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerSession.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerSession.java
index 1d758ea..146ce38 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerSession.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfSerializerSession.java
@@ -28,7 +28,7 @@ import com.hp.hpl.jena.rdf.model.*;
/**
* Session object that lives for the duration of a single use of {@link RdfSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -53,7 +53,7 @@ public final class RdfSerializerSession extends WriterSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -133,7 +133,7 @@ public final class RdfSerializerSession extends WriterSerializerSession {
/**
* Returns the {@link Serializer#SERIALIZER_addBeanTypeProperties} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_addBeanTypeProperties} setting value for this session.
*/
@Override /* SerializerSession */
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfUtils.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfUtils.java
index 7340c39..0d01121 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfUtils.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/RdfUtils.java
@@ -28,7 +28,7 @@ public class RdfUtils {
*
* <p>
* The annotations should be a child-to-parent ordering of annotations found on a class or method.
- *
+ *
* @param rdfs The <code>@Rdf</code> annotations to search.
* @param schemas The list of known RDF schemas.
* @return The resolved namespace, or <jk>null</jk> if the namespace could not be resolved.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/annotation/RdfSchema.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/annotation/RdfSchema.java b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/annotation/RdfSchema.java
index 3b7b0ba..9b16490 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/annotation/RdfSchema.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/annotation/RdfSchema.java
@@ -53,7 +53,7 @@ public @interface RdfSchema {
*
* <p>
* Inherited by child packages.
- *
+ *
* <h5 class='section'>Example:</h5>
*
* Contents of <code>package-info.java</code>...
@@ -75,14 +75,14 @@ public @interface RdfSchema {
* Class in package using defined namespaces...
* <p class='bcode'>
* <jk>package</jk> org.apache.juneau.examples.addressbook;
- *
+ *
* <jc>// Bean class, override "ab" namespace on package.</jc>
* <ja>@Rdf</ja>(prefix=<js>"addr"</js>)
* <jk>public class</jk> Address {
- *
+ *
* <jc>// Bean property, use "addr" namespace on class.</jc>
* <jk>public int</jk> <jf>id</jf>;
- *
+ *
* <jc>// Bean property, override with "mail" namespace.</jc>
* <ja>@Rdf</ja>(prefix=<js>"mail"</js>)
* <jk>public</jk> String <jf>street</jf>, <jf>city</jf>, <jf>state</jf>;
[15/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParser.java
index 15cb118..ab98319 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParser.java
@@ -17,16 +17,18 @@ import org.apache.juneau.parser.*;
/**
* Parses any valid JSON text into a POJO model.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Content-Type</code> types: <code>application/json, text/json</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Content-Type</code> types: <code><b>application/json, text/json</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* This parser uses a state machine, which makes it very fast and efficient. It parses JSON in about 70% of the
* time that it takes the built-in Java DOM parsers to parse equivalent XML.
- *
+ *
* <p>
* This parser handles all valid JSON syntax.
* In addition, when strict mode is disable, the parser also handles the following:
@@ -40,10 +42,10 @@ import org.apache.juneau.parser.*;
* <li>
* Unquoted attributes.
* </ul>
- *
+ *
* <p>
* 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'>
@@ -68,7 +70,7 @@ import org.apache.juneau.parser.*;
* <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'>
@@ -91,7 +93,7 @@ import org.apache.juneau.parser.*;
* <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
* {@link ObjectMap#ObjectMap(CharSequence) ObjectMap(CharSequence)} or {@link ObjectList#ObjectList(CharSequence)
@@ -120,7 +122,7 @@ public class JsonParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Strict(PropertyStore ps) {
@@ -135,7 +137,7 @@ public class JsonParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public JsonParser(PropertyStore ps) {
@@ -144,7 +146,7 @@ public class JsonParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
* @param consumes The list of media types that this parser consumes (e.g. <js>"application/json"</js>).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserBuilder.java
index 049436a..0c42db6 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserBuilder.java
@@ -32,7 +32,7 @@ public class JsonParserBuilder extends ParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public JsonParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserSession.java
index ede380d..6cf0932 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonParserSession.java
@@ -25,7 +25,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link JsonParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -37,7 +37,7 @@ public final class JsonParserSession extends ReaderParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -50,12 +50,12 @@ public final class JsonParserSession extends ReaderParserSession {
/**
* Returns <jk>true</jk> if the specified character is whitespace.
- *
+ *
* <p>
* The definition of whitespace is different for strict vs lax mode.
* Strict mode only interprets 0x20 (space), 0x09 (tab), 0x0A (line feed) and 0x0D (carriage return) as whitespace.
* Lax mode uses {@link Character#isWhitespace(int)} to make the determination.
- *
+ *
* @param cp The codepoint.
* @return <jk>true</jk> if the specified character is whitespace.
*/
@@ -67,7 +67,7 @@ public final class JsonParserSession extends ReaderParserSession {
/**
* Returns <jk>true</jk> if the specified character is whitespace or '/'.
- *
+ *
* @param cp The codepoint.
* @return <jk>true</jk> if the specified character is whitespace or '/'.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java
index e2aed0a..1f268d5 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java
@@ -17,22 +17,24 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO metadata to HTTP responses as JSON.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>application/json+schema, text/json+schema</code>
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>application/json+schema, text/json+schema</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>application/json</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>application/json</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Produces the JSON-schema for the JSON produced by the {@link JsonSerializer} class with the same properties.
*/
public final class JsonSchemaSerializer extends JsonSerializer {
/**
* Constructor.
- *
+ *
* @param ps Initialize with the specified config property store.
*/
public JsonSchemaSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java
index 8b8c744..545638c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerBuilder.java
@@ -32,7 +32,7 @@ public class JsonSchemaSerializerBuilder extends JsonSerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public JsonSchemaSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerSession.java
index 9f24afd..0054fbf 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSchemaSerializerSession.java
@@ -22,7 +22,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link JsonSchemaSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -31,7 +31,7 @@ public class JsonSchemaSerializerSession extends JsonSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -53,7 +53,7 @@ public class JsonSchemaSerializerSession extends JsonSerializerSession {
/*
* Creates a schema representation of the specified class type.
- *
+ *
* @param eType The class type to get the schema of.
* @param ctx Serialize context used to prevent infinite loops.
* @param attrName The name of the current attribute.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializer.java
index e237b57..27f2aa9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializer.java
@@ -19,15 +19,17 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO models to JSON.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>application/json, text/json</code>
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>application/json, text/json</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>application/json</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>application/json</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* The conversion is as follows...
* <ul class='spaced-list'>
* <li>
@@ -48,21 +50,21 @@ import org.apache.juneau.serializer.*;
* <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 into JSON-primitive object types through
* {@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated through the
* {@link BeanContextBuilder#pojoSwaps(Class...)} method.
* Several default transforms are provided for transforming Dates, Enums, Iterators, etc...
- *
+ *
* <p>
* This serializer provides several serialization options.
* Typically, one of the predefined DEFAULT serializers will be sufficient.
* However, custom serializers can be constructed to fine-tune behavior.
- *
+ *
* <h6 class='topic'>Behavior-specific subclasses</h6>
- *
+ *
* The following direct subclasses are provided for convenience:
* <ul class='spaced-list'>
* <li>
@@ -70,18 +72,18 @@ import org.apache.juneau.serializer.*;
* <li>
* {@link SimpleReadable} - Default serializer, single quotes, simple mode, with whitespace.
* </ul>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Use one of the default serializers to serialize a POJO</jc>
* String json = JsonSerializer.<jsf>DEFAULT</jsf>.serialize(someObject);
- *
+ *
* <jc>// Create a custom serializer for lax syntax using single quote characters</jc>
* JsonSerializer serializer = JsonSerializer.<jsm>create</jsm>().simple().sq().build();
- *
+ *
* <jc>// Clone an existing serializer and modify it to use single-quotes</jc>
* JsonSerializer serializer = JsonSerializer.<jsf>DEFAULT</jsf>.builder().sq().build();
- *
+ *
* <jc>// Serialize a POJO to JSON</jc>
* String json = serializer.serialize(someObject);
* </p>
@@ -96,7 +98,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"JsonSerializer.addBeanTypeProperties.b"</js>
@@ -108,12 +110,12 @@ public class JsonSerializer extends WriterSerializer {
* <li class='jm'>{@link JsonSerializerBuilder#addBeanTypeProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
* through reflection.
- *
+ *
* <p>
* When present, this value overrides the {@link #SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -122,7 +124,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Configuration property: Prefix solidus <js>'/'</js> characters with escapes.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"JsonSerializer.escapeSolidus.b"</js>
@@ -135,7 +137,7 @@ public class JsonSerializer extends WriterSerializer {
* <li class='jm'>{@link JsonSerializerBuilder#escapeSolidus()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, solidus (e.g. slash) characters should be escaped.
@@ -167,7 +169,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Configuration property: Simple JSON mode.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"JsonSerializer.simpleMode.b"</js>
@@ -181,7 +183,7 @@ public class JsonSerializer extends WriterSerializer {
* <li class='jm'>{@link JsonSerializerBuilder#ssq()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, JSON attribute names will only be quoted when necessary.
@@ -281,7 +283,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Readable(PropertyStore ps) {
@@ -296,7 +298,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public Simple(PropertyStore ps) {
@@ -316,7 +318,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public SimpleReadable(PropertyStore ps) {
@@ -338,7 +340,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public SimpleReadableSafe(PropertyStore ps) {
@@ -367,7 +369,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -377,7 +379,7 @@ public class JsonSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
@@ -427,7 +429,7 @@ public class JsonSerializer extends WriterSerializer {
* <p>
* Note that this method creates a builder initialized to all default settings, whereas {@link #builder()} copies
* the settings of the object called on.
- *
+ *
* @return The schema serializer.
*/
public JsonSchemaSerializer getSchemaSerializer() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
index ac70a1b..e535186 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerBuilder.java
@@ -34,7 +34,7 @@ public class JsonSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public JsonSerializerBuilder(PropertyStore ps) {
@@ -53,10 +53,10 @@ public class JsonSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Prefix solidus <js>'/'</js> characters with escapes.
- *
+ *
* <p>
* If <jk>true</jk>, solidus (e.g. slash) characters should be escaped.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link JsonSerializer#JSON_escapeSolidus}
@@ -73,10 +73,10 @@ public class JsonSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Prefix solidus <js>'/'</js> characters with escapes.
- *
+ *
* <p>
* Shortcut for calling <code>escapeSolidus(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link JsonSerializer#JSON_escapeSolidus}
@@ -90,11 +90,11 @@ public class JsonSerializerBuilder extends SerializerBuilder {
/**
* Configuration property: Simple JSON mode.
- *
+ *
* <p>
* If <jk>true</jk>, JSON attribute names will only be quoted when necessary.
* <br>Otherwise, they are always quoted.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link JsonSerializer#JSON_simpleMode}
@@ -114,7 +114,7 @@ public class JsonSerializerBuilder extends SerializerBuilder {
*
* <p>
* Shortcut for calling <code>simple(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link JsonSerializer#JSON_simpleMode}
@@ -131,7 +131,7 @@ public class JsonSerializerBuilder extends SerializerBuilder {
*
* <p>
* Shortcut for calling <code>simple().sq()</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link JsonSerializer#JSON_simpleMode}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerSession.java
index 1ea85b4..3396055 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonSerializerSession.java
@@ -23,7 +23,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link JsonSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -37,7 +37,7 @@ public class JsonSerializerSession extends WriterSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -235,7 +235,7 @@ public class JsonSerializerSession extends WriterSerializerSession {
/**
* Returns the {@link JsonSerializer#JSON_addBeanTypeProperties} setting value for this session.
- *
+ *
* @return The {@link JsonSerializer#JSON_addBeanTypeProperties} setting value for this session.
*/
@Override /* SerializerSession */
@@ -245,7 +245,7 @@ public class JsonSerializerSession extends WriterSerializerSession {
/**
* Converts the specified output target object to an {@link JsonWriter}.
- *
+ *
* @param out The output target object.
* @return The output target object wrapped in an {@link JsonWriter}.
* @throws Exception
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonWriter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonWriter.java
index 977cbcc..635aa0b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonWriter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/JsonWriter.java
@@ -20,8 +20,9 @@ import org.apache.juneau.serializer.*;
/**
* Specialized writer for serializing JSON.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>This class is not intended for external use.
* </ul>
@@ -55,7 +56,7 @@ public final class JsonWriter extends SerializerWriter {
/**
* Constructor.
- *
+ *
* @param out The writer being wrapped.
* @param useWhitespace If <jk>true</jk>, tabs and spaces will be used in output.
* @param maxIndent The maximum indentation level.
@@ -75,7 +76,7 @@ public final class JsonWriter extends SerializerWriter {
/**
* Serializes the specified object as a JSON string value.
- *
+ *
* @param s The object being serialized.
* @return This object (for method chaining).
* @throws IOException Should never happen.
@@ -122,7 +123,7 @@ public final class JsonWriter extends SerializerWriter {
/**
* Serializes the specified object as a JSON attribute name.
- *
+ *
* @param s The object being serialized.
* @return This object (for method chaining).
* @throws IOException Should never happen.
@@ -170,7 +171,7 @@ public final class JsonWriter extends SerializerWriter {
/**
* Appends a URI to the output.
- *
+ *
* @param uri The URI to append to the output.
* @return This object (for method chaining).
* @throws IOException
@@ -197,7 +198,7 @@ public final class JsonWriter extends SerializerWriter {
/**
* Performs an indentation only if we're currently past max indentation.
- *
+ *
* @param depth The current indentation depth.
* @return This object (for method chaining).
* @throws IOException
@@ -240,7 +241,7 @@ public final class JsonWriter extends SerializerWriter {
/**
* Adds a space only if the current indentation level is below maxIndent.
- *
+ *
* @param indent
* @return This object (for method chaining).
* @throws IOException
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/annotation/Json.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/annotation/Json.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/annotation/Json.java
index 6d91626..754158e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/annotation/Json.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/json/annotation/Json.java
@@ -19,10 +19,10 @@ import java.lang.annotation.*;
/**
* Annotation for specifying various JSON options for the JSON serializers and parsers.
- *
+ *
* <p>
* Can be applied to Java types.
- *
+ *
* <p>
* Can be used for the following:
* <ul class='spaced-list'>
@@ -38,13 +38,13 @@ public @interface Json {
/**
* Wraps beans in a JSON object with the specified attribute name.
- *
+ *
* <p>
* Applies only to {@link ElementType#TYPE}.
- *
+ *
* <p>
* This annotation can be applied to beans as well as other objects serialized to other types (e.g. strings).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Json</ja>(wrapperAttr=<js>"myWrapper"</js>)
@@ -52,7 +52,7 @@ public @interface Json {
* <jk>public int</jk> f1 = 123;
* }
* </p>
- *
+ *
* <p>
* Without the <ja>@Xml</ja> annotations, serializing this bean as JSON would have produced the following...
* <p class='bcode'>
@@ -60,7 +60,7 @@ public @interface Json {
* f1: 123
* }
* </p>
- *
+ *
* <p>
* With the annotations, serializing this bean as XML produces the following...
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java
index 44f5868..00fd66b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackInputStream.java
@@ -21,8 +21,9 @@ import org.apache.juneau.parser.*;
/**
* Specialized input stream for parsing MessagePack streams.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>This class is not intended for external use.
* </ul>
@@ -59,7 +60,7 @@ public final class MsgPackInputStream extends InputStream {
/**
* Constructor.
- *
+ *
* @param pipe The parser input.
* @throws Exception
*/
@@ -78,7 +79,7 @@ public final class MsgPackInputStream extends InputStream {
/**
* Reads the data type flag from the stream.
- *
+ *
* <p>
* This is the byte that indicates what kind of data follows.
*/
@@ -383,7 +384,7 @@ public final class MsgPackInputStream extends InputStream {
/**
* Returns the length value for the field.
- *
+ *
* <p>
* For ints/floats/bins/strings, this is the number of bytes that the field takes up (minus the data-type flag).
* For arrays, it's the number of array entries.
@@ -493,7 +494,7 @@ public final class MsgPackInputStream extends InputStream {
/**
* Returns the pipe that was passed into the constructor.
- *
+ *
* @return The pipe that was passed into the constructor.
*/
public ParserPipe getPipe() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java
index 1760da6..74b2d8b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackOutputStream.java
@@ -20,8 +20,9 @@ import java.util.concurrent.atomic.*;
/**
* Specialized output stream for serializing MessagePack streams.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>This class is not intended for external use.
* </ul>
@@ -32,7 +33,7 @@ public final class MsgPackOutputStream extends OutputStream {
/**
* Constructor.
- *
+ *
* @param os The output stream being wrapped.
*/
protected MsgPackOutputStream(OutputStream os) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java
index 48960f3..d622690 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java
@@ -17,10 +17,11 @@ import org.apache.juneau.parser.*;
/**
* Parses a MessagePack stream into a POJO model.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Content-Type</code> types: <code>octal/msgpack</code>
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Content-Type</code> types: <code><b>octal/msgpack</b></code>
*/
public class MsgPackParser extends InputStreamParser {
@@ -38,7 +39,7 @@ public class MsgPackParser extends InputStreamParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public MsgPackParser(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java
index 9cc1fd5..1c0d0b6 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserBuilder.java
@@ -32,7 +32,7 @@ public class MsgPackParserBuilder extends ParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public MsgPackParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java
index 10b880c..400818c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackParserSession.java
@@ -22,7 +22,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link MsgPackParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -32,7 +32,7 @@ public final class MsgPackParserSession extends InputStreamParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java
index c505a5a..b419cbf 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializer.java
@@ -17,13 +17,13 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJO models to MessagePack.
- *
+ *
+ *
* <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>octal/msgpack</code>
- *
+ *
+ * Handles <code>Accept</code> types: <code><b>octal/msgpack</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>octal/msgpack</code>
+ * Produces <code>Content-Type</code> types: <code><b>octal/msgpack</b></code>
*/
public class MsgPackSerializer extends OutputStreamSerializer {
@@ -35,7 +35,7 @@ public class MsgPackSerializer extends OutputStreamSerializer {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"MsgPackSerializer.addBeanTypeProperties.b"</js>
@@ -47,12 +47,12 @@ public class MsgPackSerializer extends OutputStreamSerializer {
* <li class='jm'>{@link MsgPackSerializerBuilder#addBeanTypeProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
* through reflection.
- *
+ *
* <p>
* When present, this value overrides the {@link #SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -77,7 +77,7 @@ public class MsgPackSerializer extends OutputStreamSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public MsgPackSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java
index a74949f..0360c95 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerBuilder.java
@@ -32,7 +32,7 @@ public class MsgPackSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public MsgPackSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java
index 13b542a..a836d8c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/msgpack/MsgPackSerializerSession.java
@@ -23,7 +23,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link MsgPackSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -35,7 +35,7 @@ public final class MsgPackSerializerSession extends OutputStreamSerializerSessio
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -60,7 +60,7 @@ public final class MsgPackSerializerSession extends OutputStreamSerializerSessio
/**
* Returns the {@link MsgPackSerializer#MSGPACK_addBeanTypeProperties} setting value for this session.
- *
+ *
* @return The {@link MsgPackSerializer#MSGPACK_addBeanTypeProperties} setting value for this session.
*/
@Override /* SerializerSession */
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParser.java
index 62518b9..6623e3b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParser.java
@@ -16,9 +16,10 @@ import org.apache.juneau.*;
/**
* Subclass of {@link Parser} for byte-based parsers.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* This class is typically the parent class of all byte-based parsers.
* It has 1 abstract method to implement...
* <ul>
@@ -29,7 +30,7 @@ public abstract class InputStreamParser extends Parser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
* @param consumes The list of media types that this parser consumes (e.g. <js>"application/json"</js>).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParserSession.java
index 7497193..c12376a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/InputStreamParserSession.java
@@ -14,7 +14,7 @@ package org.apache.juneau.parser;
/**
* Subclass of parser session objects for byte-based parsers.
- *
+ *
* <p>
* This class is NOT thread safe. It is typically discarded after one-time use.
*/
@@ -22,7 +22,7 @@ public abstract class InputStreamParserSession extends ParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -35,7 +35,7 @@ public abstract class InputStreamParserSession extends ParserSession {
/**
* Constructor for sessions that don't require context.
- *
+ *
* @param args
* Runtime session arguments.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParseException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParseException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParseException.java
index f90d497..1945dcd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParseException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParseException.java
@@ -27,7 +27,7 @@ public class ParseException extends FormattedException {
/**
* Constructor.
- *
+ *
* @param location The location of the parse exception.
* @param message The exception message containing {@link MessageFormat}-style arguments.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -38,7 +38,7 @@ public class ParseException extends FormattedException {
/**
* Constructor.
- *
+ *
* @param message The exception message containing {@link MessageFormat}-style arguments.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -48,7 +48,7 @@ public class ParseException extends FormattedException {
/**
* Constructor.
- *
+ *
* @param location The location of the parse exception.
* @param causedBy The inner exception.
*/
@@ -58,7 +58,7 @@ public class ParseException extends FormattedException {
/**
* Constructor.
- *
+ *
* @param causedBy The inner exception.
*/
public ParseException(Exception causedBy) {
@@ -76,10 +76,10 @@ public class ParseException extends FormattedException {
/**
* Returns the highest-level <code>ParseException</code> in the stack trace.
- *
+ *
* <p>
* Useful for JUnit testing of error conditions.
- *
+ *
* @return The root parse exception, or this exception if there isn't one.
*/
public ParseException getRootCause() {
@@ -91,7 +91,7 @@ public class ParseException extends FormattedException {
/**
* 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/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Parser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Parser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Parser.java
index de8900a..9d944c1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Parser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Parser.java
@@ -26,12 +26,12 @@ import org.apache.juneau.utils.*;
/**
* Parent class for all Juneau parsers.
- *
+ *
* <h6 class='topic'>Valid data conversions</h6>
- *
+ *
* Parsers can parse any parsable POJO types, as specified in the <a class="doclink"
* href="../../../../overview-summary.html#juneau-marshall.PojoCategories">POJO Categories</a>.
- *
+ *
* <p>
* Some examples of conversions are shown below...
* </p>
@@ -62,8 +62,8 @@ import org.apache.juneau.utils.*;
* <number></xt>2<xt></number>
* <number></xt>3<xt></number>
* </array></xt></td>
- * <td class='code'>List<Integer>, <jk>int</jk>[], Float[], Set<Person></td>
- * </tr>
+ * <td class='code'>List<Integer>, <jk>int</jk>[], Float[], Set<Person></td>
+ * </tr>
* <tr>
* <td>number</td>
* <td>Numbers</td>
@@ -86,11 +86,11 @@ import org.apache.juneau.utils.*;
* <td class='code'>String, StringBuilder</td>
* </tr>
* </table>
- *
+ *
* <p>
* In addition, any class types with {@link PojoSwap PojoSwaps} associated with them on the registered
* bean context can also be passed in.
- *
+ *
* <p>
* For example, if the {@link CalendarSwap} transform is used to generalize {@code Calendar} objects to {@code String}
* objects.
@@ -123,7 +123,7 @@ public abstract class Parser extends BeanContext {
/**
* Configuration property: File charset.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Parser.fileCharset.s"</js>
@@ -136,14 +136,14 @@ public abstract class Parser extends BeanContext {
* <li class='jm'>{@link ParserBuilder#fileCharset(Charset)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* The character set to use for reading <code>Files</code> from the file system.
- *
+ *
* <p>
* 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.
*
@@ -169,7 +169,7 @@ public abstract class Parser extends BeanContext {
/**
* Configuration property: Input stream charset.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Parser.inputStreamCharset.s"</js>
@@ -182,11 +182,11 @@ public abstract class Parser extends BeanContext {
* <li class='jm'>{@link ParserBuilder#inputStreamCharset(Charset)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* 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)}.
*
@@ -212,7 +212,7 @@ public abstract class Parser extends BeanContext {
/**
* Configuration property: Parser listener.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Parser.listener.c"</js>
@@ -224,7 +224,7 @@ public abstract class Parser extends BeanContext {
* <li class='jm'>{@link ParserBuilder#listener(Class)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Class used to listen for errors and warnings that occur during parsing.
@@ -275,7 +275,7 @@ public abstract class Parser extends BeanContext {
/**
* Configuration property: Strict mode.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Parser.strict.b"</js>
@@ -292,10 +292,10 @@ public abstract class Parser extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, strict mode for the parser is enabled.
- *
+ *
* <p>
* Strict mode can mean different things for different parsers.
- *
+ *
* <table class='styled'>
* <tr><th>Parser class</th><th>Strict behavior</th></tr>
* <tr>
@@ -348,7 +348,7 @@ public abstract class Parser extends BeanContext {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Parser.trimStrings.b"</js>
@@ -361,7 +361,7 @@ public abstract class Parser extends BeanContext {
* <li class='jm'>{@link ParserBuilder#trimStrings()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
@@ -450,7 +450,7 @@ public abstract class Parser extends BeanContext {
/**
* Returns <jk>true</jk> if this parser subclasses from {@link ReaderParser}.
- *
+ *
* @return <jk>true</jk> if this parser subclasses from {@link ReaderParser}.
*/
public boolean isReaderParser() {
@@ -459,11 +459,11 @@ public abstract class Parser extends BeanContext {
/**
* Create the session object that will be passed in to the parse method.
- *
+ *
* <p>
* It's up to implementers to decide what the session object looks like, although typically it's going to be a
* subclass of {@link ParserSession}.
- *
+ *
* @param args
* Runtime arguments.
* @return The new session.
@@ -477,44 +477,44 @@ public abstract class Parser extends BeanContext {
/**
* Parses input 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>
* <p class='bcode'>
* ReaderParser p = JsonParser.<jsf>DEFAULT</jsf>;
- *
+ *
* <jc>// Parse into a linked-list of strings.</jc>
* List l = p.parse(json, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of beans.</jc>
* List l = p.parse(json, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of linked-lists of strings.</jc>
* List l = p.parse(json, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of string keys/values.</jc>
* Map m = p.parse(json, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map containing string keys and values of lists containing beans.</jc>
* Map m = p.parse(json, 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.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Use the {@link #parse(Object, Class)} method instead if you don't need a parameterized map/collection.
* </ul>
- *
+ *
* @param <T> The class type of the object to create.
* @param input
* The input.
@@ -557,30 +557,30 @@ public abstract class Parser extends BeanContext {
/**
* 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>;
- *
+ *
* <jc>// Parse into a string.</jc>
* String s = p.parse(json, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a bean.</jc>
* MyBean b = p.parse(json, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a bean array.</jc>
* MyBean[] ba = p.parse(json, MyBean[].<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of objects.</jc>
* List l = p.parse(json, LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of object keys/values.</jc>
* Map m = p.parse(json, TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* @param <T> The class type of the object being created.
* @param input
* The input.
@@ -597,10 +597,10 @@ public abstract class Parser extends BeanContext {
/**
* Same as {@link #parse(Object, Type, Type...)} except the type has already been converted into a {@link ClassMeta}
* object.
- *
+ *
* <p>
* This is mostly an internal method used by the framework.
- *
+ *
* @param <T> The class type of the object being created.
* @param input
* The input.
@@ -630,10 +630,10 @@ public abstract class Parser extends BeanContext {
/**
* Parses the contents of the specified reader and loads the results into the specified map.
- *
+ *
* <p>
* Reader must contain something that serializes to a map (such as text containing a JSON object).
- *
+ *
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
@@ -641,7 +641,7 @@ public abstract class Parser extends BeanContext {
* The various character-based constructors in {@link ObjectMap} (e.g.
* {@link ObjectMap#ObjectMap(CharSequence,Parser)}).
* </ul>
- *
+ *
* @param <K> The key class type.
* @param <V> The value class type.
* @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.
@@ -658,7 +658,7 @@ public abstract class Parser extends BeanContext {
/**
* Parses the contents of the specified reader and loads the results into the specified collection.
- *
+ *
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
@@ -666,7 +666,7 @@ public abstract class Parser extends BeanContext {
* The various character-based constructors in {@link ObjectList} (e.g.
* {@link ObjectList#ObjectList(CharSequence,Parser)}.
* </ul>
- *
+ *
* @param <E> The element class type.
* @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.
* @param c The collection being loaded.
@@ -683,18 +683,18 @@ public abstract class Parser extends BeanContext {
/**
* Parses the specified array input with each entry in the object defined by the {@code argTypes}
* argument.
- *
+ *
* <p>
* Used for converting arrays (e.g. <js>"[arg1,arg2,...]"</js>) into an {@code Object[]} that can be passed
* to the {@code Method.invoke(target, args)} method.
- *
+ *
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
* <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.
* @param argTypes Specifies the type of objects to create for each entry in the array.
* @return An array of parsed objects.
@@ -714,7 +714,7 @@ public abstract class Parser extends BeanContext {
/**
* Returns the media types handled based on the values passed to the <code>consumes</code> constructor parameter.
- *
+ *
* @return The list of media types. Never <jk>null</jk>.
*/
public final MediaType[] getMediaTypes() {
@@ -723,7 +723,7 @@ public abstract class Parser extends BeanContext {
/**
* Returns the first media type handled based on the values passed to the <code>consumes</code> constructor parameter.
- *
+ *
* @return The media type.
*/
public final MediaType getPrimaryMediaType() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java
index 290270d..dc7ce0e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserBuilder.java
@@ -34,7 +34,7 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public ParserBuilder(PropertyStore ps) {
@@ -47,10 +47,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: File charset.
- *
+ *
* <p>
* The character set to use for reading <code>Files</code> from the file system.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_fileCharset}
@@ -67,10 +67,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: File charset.
- *
+ *
* <p>
* The character set to use for reading <code>Files</code> from the file system.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_fileCharset}
@@ -87,10 +87,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: Input stream charset.
- *
+ *
* <p>
* The character set to use for converting <code>InputStreams</code> and byte arrays to readers.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_inputStreamCharset}
@@ -107,10 +107,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: Input stream charset.
- *
+ *
* <p>
* The character set to use for converting <code>InputStreams</code> and byte arrays to readers.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_inputStreamCharset}
@@ -127,10 +127,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: Parser listener.
- *
+ *
* <p>
* Class used to listen for errors and warnings that occur during parsing.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_listener}
@@ -145,10 +145,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: Strict mode.
- *
+ *
* <p>
* If <jk>true</jk>, strict mode for the parser is enabled.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_strict}
@@ -168,7 +168,7 @@ public class ParserBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>strict(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_strict}
@@ -182,11 +182,11 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
@@ -203,10 +203,10 @@ public class ParserBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <p>
* Shortcut for calling <code>trimStrings(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroup.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroup.java
index 80b0e69..a25fae1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroup.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroup.java
@@ -20,9 +20,10 @@ import org.apache.juneau.http.*;
/**
* Represents a group of {@link Parser Parsers} that can be looked up by media type.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Provides the following features:
* <ul class='spaced-list'>
* <li>
@@ -34,36 +35,36 @@ import org.apache.juneau.http.*;
* <li>
* Clones existing groups and all parsers within the group in a single method call.
* </ul>
- *
+ *
* <h6 class='topic'>Match ordering</h6>
- *
+ *
* Parsers are matched against <code>Content-Type</code> strings in the order they exist in this group.
- *
+ *
* <p>
* Adding new entries will cause the entries to be prepended to the group.
* This allows for previous parsers to be overridden through subsequent calls.
- *
+ *
* <p>
* For example, calling <code>g.append(P1.<jk>class</jk>,P2.<jk>class</jk>).append(P3.<jk>class</jk>,P4.<jk>class</jk>)</code>
* will result in the order <code>P3, P4, P1, P2</code>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct a new parser group builder</jc>
* ParserGroupBuilder b = ParserGroup.<jsm>create</jsm>();
- *
+ *
* <jc>// Add some parsers to it</jc>
* b.append(JsonParser.<jk>class</jk>, XmlParser.<jk>class</jk>);
- *
+ *
* <jc>// Change settings on parsers simultaneously</jc>
* b.set(BeanContext.<jsf>BEAN_beansRequireSerializable</jsf>, <jk>true</jk>)
* .pojoSwaps(CalendarSwap.ISO8601DT.<jk>class</jk>);
- *
+ *
* ParserGroup g = b.build();
- *
+ *
* <jc>// Find the appropriate parser by Content-Type</jc>
* ReaderParser p = (ReaderParser)g.getParser(<js>"text/json"</js>);
- *
+ *
* <jc>// Parse a bean from JSON</jc>
* String json = <js>"{...}"</js>;
* AddressBook addressBook = p.parse(json, AddressBook.<jk>class</jk>);
@@ -103,7 +104,7 @@ public final class ParserGroup extends BeanContext {
/**
* Constructor.
- *
+ *
* @param ps
* The modifiable properties that were used to initialize the parsers.
* A snapshot of these will be made so that we can clone and modify this group.
@@ -132,10 +133,10 @@ public final class ParserGroup extends BeanContext {
/**
* Searches the group for a parser that can handle the specified <l>Content-Type</l> header value.
- *
+ *
* <p>
* The returned object includes both the parser and media type that matched.
- *
+ *
* @param contentTypeHeader The HTTP <l>Content-Type</l> header value.
* @return The parser and media type that matched the content type header, or <jk>null</jk> if no match was made.
*/
@@ -157,7 +158,7 @@ public final class ParserGroup extends BeanContext {
/**
* Same as {@link #getParserMatch(String)} but matches using a {@link MediaType} instance.
- *
+ *
* @param mediaType The HTTP <l>Content-Type</l> header value as a media type.
* @return The parser and media type that matched the media type, or <jk>null</jk> if no match was made.
*/
@@ -167,7 +168,7 @@ public final class ParserGroup extends BeanContext {
/**
* Same as {@link #getParserMatch(String)} but returns just the matched parser.
- *
+ *
* @param contentTypeHeader The HTTP <l>Content-Type</l> header string.
* @return The parser that matched the content type header, or <jk>null</jk> if no match was made.
*/
@@ -178,7 +179,7 @@ public final class ParserGroup extends BeanContext {
/**
* Same as {@link #getParserMatch(MediaType)} but returns just the matched parser.
- *
+ *
* @param mediaType The HTTP media type.
* @return The parser that matched the media type, or <jk>null</jk> if no match was made.
*/
@@ -189,10 +190,10 @@ public final class ParserGroup extends BeanContext {
/**
* Returns the media types that all parsers in this group can handle
- *
+ *
* <p>
* Entries are ordered in the same order as the parsers in the group.
- *
+ *
* @return An unmodifiable list of media types.
*/
public List<MediaType> getSupportedMediaTypes() {
@@ -201,7 +202,7 @@ public final class ParserGroup extends BeanContext {
/**
* Returns the parsers in this group.
- *
+ *
* @return An unmodifiable list of parsers in this group.
*/
public List<Parser> getParsers() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java
index b7a967d..39f40dd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserGroupBuilder.java
@@ -37,7 +37,7 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Clone an existing parser group builder.
- *
+ *
* @param copyFrom The parser group that we're copying settings and parsers from.
*/
public ParserGroupBuilder(ParserGroup copyFrom) {
@@ -48,7 +48,7 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Registers the specified parsers with this group.
- *
+ *
* @param p The parsers to append to this group.
* @return This object (for method chaining).
*/
@@ -63,7 +63,7 @@ public class ParserGroupBuilder extends BeanContextBuilder {
* <p>
* When passing in pre-instantiated parsers to this group, applying properties and transforms to the group
* do not affect them.
- *
+ *
* @param p The parsers to append to this group.
* @return This object (for method chaining).
*/
@@ -77,7 +77,7 @@ public class ParserGroupBuilder extends BeanContextBuilder {
*
* <p>
* Objects can either be instances of parsers or parser classes.
- *
+ *
* @param p The parsers to append to this group.
* @return This object (for method chaining).
*/
@@ -91,7 +91,7 @@ public class ParserGroupBuilder extends BeanContextBuilder {
*
* <p>
* Objects can either be instances of parsers or parser classes.
- *
+ *
* @param p The parsers to append to this group.
* @return This object (for method chaining).
*/
@@ -102,10 +102,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Creates a new {@link ParserGroup} object using a snapshot of the settings defined in this builder.
- *
+ *
* <p>
* This method can be called multiple times to produce multiple parser groups.
- *
+ *
* @return A new {@link ParserGroup} object.
*/
@Override /* Context */
@@ -132,10 +132,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: File charset.
- *
+ *
* <p>
* The character set to use for reading <code>Files</code> from the file system.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_fileCharset}
@@ -152,10 +152,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Input stream charset.
- *
+ *
* <p>
* The character set to use for converting <code>InputStreams</code> and byte arrays to readers.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_inputStreamCharset}
@@ -172,10 +172,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Parser listener.
- *
+ *
* <p>
* Class used to listen for errors and warnings that occur during parsing.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_listener}
@@ -190,10 +190,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Strict mode.
- *
+ *
* <p>
* If <jk>true</jk>, strict mode for the parsers are enabled.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_strict}
@@ -210,10 +210,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Strict mode.
- *
+ *
* <p>
* Shortcut for calling <code>strict(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_strict}
@@ -227,11 +227,11 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
@@ -248,10 +248,10 @@ public class ParserGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <p>
* Shortcut for calling <code>trimStrings(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserListener.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserListener.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserListener.java
index 89586fd..4138e5a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserListener.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserListener.java
@@ -28,11 +28,11 @@ public class ParserListener {
/**
* Gets called when an unknown bean property is detected in a document.
- *
+ *
* <p>
* This method only gets called if {@link BeanContext#BEAN_ignoreUnknownBeanProperties} setting is <jk>true</jk>.
* Otherwise, the parser will throw a {@link ParseException}.
- *
+ *
* @param <T> The class type of the bean.
* @param session The parser session.
* @param pipe
@@ -56,7 +56,7 @@ public class ParserListener {
/**
* Called when an error occurs during parsing but is ignored.
- *
+ *
* @param session The parser session.
* @param pipe
* The parser input.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserMatch.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserMatch.java
index 64a8aec..c521b72 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserMatch.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserMatch.java
@@ -24,7 +24,7 @@ public final class ParserMatch {
/**
* Constructor.
- *
+ *
* @param mediaType The media type of the match.
* @param parser The parser that matched.
*/
@@ -35,7 +35,7 @@ public final class ParserMatch {
/**
* Returns the media type of the parser that matched the HTTP <code>Content-Type</code> header value.
- *
+ *
* @return The media type of the match.
*/
public MediaType getMediaType() {
@@ -44,7 +44,7 @@ public final class ParserMatch {
/**
* Returns the parser that matched the HTTP <code>Content-Type</code> header value.
- *
+ *
* @return The parser of the match.
*/
public Parser getParser() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserPipe.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserPipe.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserPipe.java
index 63dc64e..27a2c15 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserPipe.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserPipe.java
@@ -23,7 +23,7 @@ import org.apache.juneau.internal.*;
/**
* A wrapper around an object that a parser reads its input from.
- *
+ *
* <p>
* For character-based parsers, the input object can be any of the following:
* <ul>
@@ -34,7 +34,7 @@ import org.apache.juneau.internal.*;
* <li>{@link File}
* <li><code><jk>null</jk></code>
* </ul>
- *
+ *
* <p>
* For stream-based parsers, the input object can be any of the following:
* <ul>
@@ -44,7 +44,7 @@ import org.apache.juneau.internal.*;
* <li>{@link String} - Hex-encoded bytes. (not BASE-64!)
* <li><code><jk>null</jk></code>
* </ul>
- *
+ *
* <p>
* Note that Readers and InputStreams will NOT be automatically closed when {@link #close()} is called, but
* streams and readers created from other types (e.g. Files) WILL be automatically closed.
@@ -61,7 +61,7 @@ public final class ParserPipe implements Closeable {
/**
* Constructor.
- *
+ *
* @param input The parser input object.
* @param debug
* If <jk>true</jk>, the input contents will be copied locally and accessible via the {@link #getInputAsString()}
@@ -90,10 +90,10 @@ public final class ParserPipe implements Closeable {
/**
* Shortcut constructor, typically for straight string input.
- *
+ *
* <p>
* Equivalent to calling <code><jk>new</jk> ParserPipe(input, <jk>false</jk>, <jk>false</jk>, <jk>null</jk>, <jk>null</jk>);</code>
- *
+ *
* @param input The input object.
*/
public ParserPipe(Object input) {
@@ -102,10 +102,10 @@ public final class ParserPipe implements Closeable {
/**
* Wraps the specified input object inside an input stream.
- *
+ *
* <p>
* Subclasses can override this method to implement their own input streams.
- *
+ *
* @return The input object wrapped in an input stream, or <jk>null</jk> if the object is null.
* @throws IOException If object could not be converted to an input stream.
*/
@@ -146,10 +146,10 @@ public final class ParserPipe implements Closeable {
/**
* Wraps the specified input object inside a reader.
- *
+ *
* <p>
* Subclasses can override this method to implement their own readers.
- *
+ *
* @return The input object wrapped in a Reader, or <jk>null</jk> if the object is null.
* @throws IOException If object could not be converted to a reader.
*/
@@ -217,10 +217,10 @@ public final class ParserPipe implements Closeable {
/**
* Returns the contents of this pipe as a buffered reader.
- *
+ *
* <p>
* If the reader passed into this pipe is already a buffered reader, that reader will be returned.
- *
+ *
* @return The contents of this pipe as a buffered reader.
* @throws Exception
*/
@@ -230,10 +230,10 @@ public final class ParserPipe implements Closeable {
/**
* Returns the input to this parser as a plain string.
- *
+ *
* <p>
* This method only returns a value if {@link BeanContext#BEAN_debug} is enabled.
- *
+ *
* @return The input as a string, or <jk>null</jk> if debug mode not enabled.
*/
public String getInputAsString() {
@@ -242,7 +242,7 @@ public final class ParserPipe implements Closeable {
/**
* Converts this pipe into a {@link ParserReader}.
- *
+ *
* @return The converted pipe.
* @throws Exception
*/
@@ -258,7 +258,7 @@ public final class ParserPipe implements Closeable {
/**
* Returns <jk>true</jk> if the contents passed into this pipe was a {@link CharSequence}.
- *
+ *
* @return <jk>true</jk> if the contents passed into this pipe was a {@link CharSequence}.
*/
public boolean isString() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java
index 3c75e36..16c4e84 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java
@@ -19,14 +19,14 @@ import org.apache.juneau.internal.*;
/**
* Similar to a {@link java.io.PushbackReader} with a pushback buffer of 1 character.
- *
+ *
* <p>
* Code is optimized to work with a 1 character buffer.
- *
+ *
* <p>
* Additionally keeps track of current line and column number, and provides the ability to set mark points and capture
* characters from the previous mark point.
- *
+ *
* <p>
* <b>Warning:</b> Not thread safe.
*/
@@ -46,7 +46,7 @@ public class ParserReader extends Reader {
/**
* Constructor.
- *
+ *
* @param pipe The parser input.
* @throws IOException
*/
@@ -69,7 +69,7 @@ public class ParserReader extends Reader {
/**
* Returns the current line number position in this reader.
- *
+ *
* @return The current line number.
*/
public final int getLine() {
@@ -78,7 +78,7 @@ public class ParserReader extends Reader {
/**
* Returns the current column number position in this reader.
- *
+ *
* @return The current column number.
*/
public final int getColumn() {
@@ -87,12 +87,12 @@ public class ParserReader extends Reader {
/**
* Reads a single character.
- *
+ *
* <p>
* Note that this method does NOT process extended unicode characters (i.e. characters above 0x10000), but rather
* returns them as two <jk>char</jk>s.
* Use {@link #readCodePoint()} to ensure proper handling of extended unicode.
- *
+ *
* @return The character read, or -1 if the end of the stream has been reached.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -112,7 +112,7 @@ public class ParserReader extends Reader {
/**
* Same as {@link #read()} but skips over any whitespace characters.
- *
+ *
* @return The first non-whitespace character, or -1 if the end of stream reached.
* @throws IOException
*/
@@ -126,7 +126,7 @@ public class ParserReader extends Reader {
/**
* Same as {@link #read()} but detects and combines extended unicode characters (i.e. characters above 0x10000).
- *
+ *
* @return The character read, or -1 if the end of the stream has been reached.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -217,10 +217,10 @@ public class ParserReader extends Reader {
/**
* Peeks the next character in the stream.
- *
+ *
* <p>
* This is equivalent to doing a {@code read()} followed by an {@code unread()}.
- *
+ *
* @return The peeked character, or (char)-1 if the end of the stream has been reached.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -233,10 +233,10 @@ public class ParserReader extends Reader {
/**
* Same as {@link #peek()} but skips over any whitespace characters.
- *
+ *
* <p>
* This is equivalent to doing a {@code read()} followed by an {@code unread()}.
- *
+ *
* @return The peeked character, or (char)-1 if the end of the stream has been reached.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -253,7 +253,7 @@ public class ParserReader extends Reader {
/**
* Read the specified number of characters off the stream.
- *
+ *
* @param num The number of characters to read.
* @return The characters packaged as a String.
* @throws IOException If a problem occurred trying to read from the reader.
@@ -271,7 +271,7 @@ public class ParserReader extends Reader {
/**
* Pushes the last read character back into the stream.
- *
+ *
* @return This object (for method chaining).
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -285,7 +285,7 @@ public class ParserReader extends Reader {
/**
* Close this reader and the underlying reader.
- *
+ *
* @throws IOException If a problem occurred trying to read from the reader.
*/
@Override /* Reader */
@@ -296,7 +296,7 @@ public class ParserReader extends Reader {
/**
* Returns the contents of the reusable character buffer as a string, and resets the buffer for next usage.
- *
+ *
* @return The contents of the reusable character buffer as a string.
*/
public final String getMarked() {
@@ -305,13 +305,13 @@ public class ParserReader extends Reader {
/**
* Same as {@link #getMarked()} except allows you to specify offsets into the buffer.
- *
+ *
* <p>
* For example, to return the marked string, but trim the first and last characters, call the following:
* <p class='bcode'>
* getFromMarked(1, -1);
* </p>
- *
+ *
* @param offsetStart The offset of the start position.
* @param offsetEnd The offset of the end position.
* @return The contents of the reusable character buffer as a string.
@@ -338,10 +338,10 @@ public class ParserReader extends Reader {
/**
* Trims off the last character in the marking buffer.
- *
+ *
* <p>
* Useful for removing escape characters from sequences.
- *
+ *
* @return This object (for method chaining).
*/
public final ParserReader delete() {
@@ -351,7 +351,7 @@ public class ParserReader extends Reader {
/**
* Trims off the specified number of last characters in the marking buffer.
* Useful for removing escape characters from sequences.
- *
+ *
* @param count The number of characters to delete.
* @return This object (for method chaining).
*/
@@ -364,11 +364,11 @@ public class ParserReader extends Reader {
/**
* Replaces the last character in the marking buffer with the specified character.
- *
+ *
* <p>
* <code>offset</code> must be at least <code>1</code> for normal characters, and <code>2</code> for extended
* unicode characters in order for the replacement to fit into the buffer.
- *
+ *
* @param c The new character.
* @param offset The offset.
* @return This object (for method chaining).
@@ -396,7 +396,7 @@ public class ParserReader extends Reader {
/**
* Replace the last read character in the buffer with the specified character.
- *
+ *
* @param c The new character.
* @return This object (for method chaining).
* @throws IOException
@@ -407,7 +407,7 @@ public class ParserReader extends Reader {
/**
* Subclasses can override this method to provide additional filtering.
- *
+ *
* <p>
* Default implementation simply calls the same method on the underlying reader.
*/
@@ -418,7 +418,7 @@ public class ParserReader extends Reader {
/**
* Returns the combined location information on both this reader and the session.
- *
+ *
* @param session The session object to read the last location on.
* @return A new map describing the current parse location.
*/
@@ -428,7 +428,7 @@ public class ParserReader extends Reader {
/**
* Returns the pipe that was passed into the constructor.
- *
+ *
* @return The pipe that was passed into the constructor.
*/
public final ParserPipe getPipe() {
[27/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Td.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Td.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Td.java
index 32093c4..74234df 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Td.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Td.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="td")
@@ -35,10 +35,10 @@ public class Td extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-tdth-colspan">colspan</a> attribute.
- *
+ *
* <p>
* Number of columns that the cell is to span.
- *
+ *
* @param colspan
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -51,10 +51,10 @@ public class Td extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-tdth-headers">headers</a> attribute.
- *
+ *
* <p>
* The header cells for this cell.
- *
+ *
* @param headers The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -65,10 +65,10 @@ public class Td extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-tdth-rowspan">rowspan</a> attribute.
- *
+ *
* <p>
* Number of rows that the cell is to span.
- *
+ *
* @param rowspan
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Template.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Template.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Template.java
index f9c1a1a..885404c 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Template.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Template.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="template")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Textarea.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Textarea.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Textarea.java
index 8f08e65..4e31c35 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Textarea.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Textarea.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="textarea")
@@ -35,10 +35,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autocomplete">autocomplete</a> attribute.
- *
+ *
* <p>
* Hint for form auto-fill feature.
- *
+ *
* @param autocomplete The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -49,10 +49,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autofocus">autofocus</a> attribute.
- *
+ *
* <p>
* Automatically focus the form control when the page is loaded.
- *
+ *
* @param autofocus
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -65,10 +65,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-cols">cols</a> attribute.
- *
+ *
* <p>
* Maximum number of characters per line.
- *
+ *
* @param cols
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -81,10 +81,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-dirname">dirname</a> attribute.
- *
+ *
* <p>
* Name of form field to use for sending the element's directionality in form submission.
- *
+ *
* @param dirname The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -95,10 +95,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-disabled">disabled</a> attribute.
- *
+ *
* <p>
* Whether the form control is disabled.
- *
+ *
* @param disabled
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -111,10 +111,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form">form</a> attribute.
- *
+ *
* <p>
* Associates the control with a form element.
- *
+ *
* @param form The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -125,10 +125,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#inputmode">inputmode</a> attribute.
- *
+ *
* <p>
* Hint for selecting an input modality.
- *
+ *
* @param inputmode The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -139,10 +139,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-maxlength">maxlength</a> attribute.
- *
+ *
* <p>
* Maximum length of value.
- *
+ *
* @param maxlength
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -155,10 +155,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-minlength">minlength</a> attribute.
- *
+ *
* <p>
* Minimum length of value.
- *
+ *
* @param minlength
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -171,10 +171,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name">name</a> attribute.
- *
+ *
* <p>
* Name of form control to use for form submission and in the form.elements API.
- *
+ *
* @param name The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -186,10 +186,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-placeholder">placeholder</a>
* attribute.
- *
+ *
* <p>
* User-visible label to be placed within the form control.
- *
+ *
* @param placeholder The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -200,10 +200,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-readonly">readonly</a> attribute.
- *
+ *
* <p>
* Whether to allow the value to be edited by the user.
- *
+ *
* @param readonly
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -216,10 +216,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-required">required</a> attribute.
- *
+ *
* <p>
* Whether the control is required for form submission.
- *
+ *
* @param required
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -232,10 +232,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-rows">rows</a> attribute.
- *
+ *
* <p>
* Number of lines to show.
- *
+ *
* @param rows
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -248,10 +248,10 @@ public class Textarea extends HtmlElementRawText {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-textarea-wrap">wrap</a> attribute.
- *
+ *
* <p>
* How the value of the form control is to be wrapped for form submission.
- *
+ *
* @param wrap The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tfoot.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
index 26ab554..9020439 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="tfoot")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Th.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Th.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Th.java
index 9fe7daf..18a66db 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Th.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Th.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="th")
@@ -35,10 +35,10 @@ public class Th extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-th-abbr">abbr</a> attribute.
- *
+ *
* <p>
* Alternative label to use for the header cell when referencing the cell in other contexts.
- *
+ *
* @param abbr The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -49,10 +49,10 @@ public class Th extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-tdth-colspan">colspan</a> attribute.
- *
+ *
* <p>
* Number of columns that the cell is to span.
- *
+ *
* @param colspan
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -65,10 +65,10 @@ public class Th extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-tdth-headers">headers</a> attribute.
- *
+ *
* <p>
* The headers for this cell.
- *
+ *
* @param headers The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -79,10 +79,10 @@ public class Th extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-tdth-rowspan">rowspan</a> attribute.
- *
+ *
* <p>
* Number of rows that the cell is to span.
- *
+ *
* @param rowspan
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -95,10 +95,10 @@ public class Th extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#attr-th-scope">scope</a> attribute.
- *
+ *
* <p>
* Specifies which cells the header cell applies to.
- *
+ *
* @param scope The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -109,10 +109,10 @@ public class Th extends HtmlElementMixed {
/**
* <a class="doclink" href="-">sorted</a> attribute.
- *
+ *
* <p>
* Column sort direction and ordinality.
- *
+ *
* @param sorted The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Thead.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Thead.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Thead.java
index 6543101..d3ad9b3 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Thead.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Thead.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="thead")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Time.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Time.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Time.java
index 72715f9..5a1e9c0 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Time.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Time.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="time")
@@ -36,10 +36,10 @@ public class Time extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#attr-time-datetime">datetime</a>
* attribute.
- *
+ *
* <p>
* Machine-readable value.
- *
+ *
* @param datetime The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Title.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Title.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Title.java
index 2c15355..27e4264 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Title.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Title.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="title")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tr.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tr.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tr.java
index a848601..4cc6964 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tr.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Tr.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="tr")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Track.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Track.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Track.java
index 668efb6..d8e7c03 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Track.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Track.java
@@ -21,7 +21,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="track")
@@ -40,10 +40,10 @@ public class Track extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-track-default">default</a>
* attribute.
- *
+ *
* <p>
* Enable the track if no other text track is more suitable.
- *
+ *
* @param _default The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -54,10 +54,10 @@ public class Track extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-track-kind">kind</a> attribute.
- *
+ *
* <p>
* The type of text track.
- *
+ *
* @param kind The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -68,10 +68,10 @@ public class Track extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-track-label">label</a> attribute.
- *
+ *
* <p>
* User-visible label.
- *
+ *
* @param label The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -82,17 +82,17 @@ public class Track extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-track-src">src</a> attribute.
- *
+ *
* <p>
* Address of the resource.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param src
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
@@ -106,10 +106,10 @@ public class Track extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-track-srclang">srclang</a>
* attribute.
- *
+ *
* <p>
* Language of the text track.
- *
+ *
* @param srclang The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/U.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/U.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/U.java
index fbc66e2..c608d58 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/U.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/U.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="u")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ul.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ul.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ul.java
index aca14e3..1dddb34 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ul.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Ul.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="ul")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Var.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Var.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Var.java
index eee01de..736e850 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Var.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Var.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="var")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Video.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Video.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Video.java
index 8c36fac..74c4aa3 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Video.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Video.java
@@ -21,7 +21,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="video")
@@ -40,10 +40,10 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-autoplay">autoplay</a>
* attribute.
- *
+ *
* <p>
* Hint that the media resource can be started automatically when the page is loaded.
- *
+ *
* @param autoplay
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -57,10 +57,10 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-controls">controls</a>
* attribute.
- *
+ *
* <p>
* Show user agent controls.
- *
+ *
* @param controls
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -74,10 +74,10 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-crossorigin">crossorigin</a>
* attribute.
- *
+ *
* <p>
* How the element handles cross-origin requests.
- *
+ *
* @param crossorigin The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -89,10 +89,10 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-height">height</a>
* attribute.
- *
+ *
* <p>
* Vertical dimension.
- *
+ *
* @param height
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
@@ -105,10 +105,10 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-loop">loop</a> attribute.
- *
+ *
* <p>
* Whether to loop the media resource.
- *
+ *
* @param loop
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -122,10 +122,10 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-mediagroup">mediagroup</a>
* attribute.
- *
+ *
* <p>
* Groups media elements together with an implicit MediaController.
- *
+ *
* @param mediagroup The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -137,10 +137,10 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-muted">muted</a>
* attribute.
- *
+ *
* <p>
* Whether to mute the media resource by default.
- *
+ *
* @param muted
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -154,10 +154,10 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-video-poster">poster</a>
* attribute.
- *
+ *
* <p>
* Poster frame to show prior to video playback.
- *
+ *
* @param poster The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -169,10 +169,10 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-preload">preload</a>
* attribute.
- *
+ *
* <p>
* Hints how much buffering the media resource will likely need.
- *
+ *
* @param preload The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -183,17 +183,17 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-src">src</a> attribute.
- *
+ *
* <p>
* Address of the resource.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param src
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
@@ -206,10 +206,10 @@ public class Video extends HtmlElementContainer {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-dim-width">width</a> attribute.
- *
+ *
* <p>
* Horizontal dimension.
- *
+ *
* @param width
* The new value for this attribute.
* Typically a {@link Number} or {@link String}.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Wbr.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Wbr.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Wbr.java
index f99be21..874b951 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Wbr.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Wbr.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="wbr")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
index 805b234..1e21966 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
@@ -14,18 +14,18 @@ package org.apache.juneau.dto.jsonschema;
/**
* Represents possible JSON types in the JSON-Schema core specification.
- *
+ *
* <p>
* Implements custom <code>toString()</code> and <code>fromString(String)</code> methods that override the default
* serialization/parsing behavior of <code>Enum</code> types so that they are represented in lowercase form (as per the
* specification).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* // Produces 'number', not 'NUMBER'.
* String json = JsonSerializer.DEFAULT.serialize(JsonType.NUMBER);
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -83,7 +83,7 @@ public enum JsonType {
/**
* Converts the specified lowercase form of the enum back into an <code>Enum</code>.
- *
+ *
* @param value The lowercase form of the enum (e.g. <js>"array"</js>).
* @return The matching <code>Enum</code>, or <jk>null</jk> if no match found.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
index 8339594..df811f5 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
@@ -16,7 +16,7 @@ import java.util.*;
/**
* Represents a list of {@link JsonType} objects.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -43,7 +43,7 @@ public final class JsonTypeArray extends LinkedList<JsonType> {
/**
* Constructor with predefined types to add to this list.
- *
+ *
* @param types The list of types to add to the list.
*/
public JsonTypeArray(JsonType...types) {
@@ -52,7 +52,7 @@ public final class JsonTypeArray extends LinkedList<JsonType> {
/**
* Convenience method for adding one or more {@link JsonType} objects to this array.
- *
+ *
* @param types The {@link JsonType} objects to add to this array.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
index dc4b105..083cb61 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
@@ -27,7 +27,7 @@ import org.apache.juneau.transform.*;
/**
* Represents a top-level schema object bean in the JSON-Schema core specification.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -103,7 +103,7 @@ public class Schema {
/**
* Bean property getter: <property>name</property>.
- *
+ *
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@BeanIgnore
@@ -113,7 +113,7 @@ public class Schema {
/**
* Bean property setter: <property>name</property>.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -125,7 +125,7 @@ public class Schema {
/**
* Bean property getter: <property>id</property>.
- *
+ *
* @return The value of the <property>id</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public URI getId() {
@@ -134,14 +134,14 @@ public class Schema {
/**
* Bean property setter: <property>id</property>.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param id The new value for the <property>id</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -152,7 +152,7 @@ public class Schema {
/**
* Bean property getter: <property>$schema</property>.
- *
+ *
* @return The value of the <property>$schema</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@BeanProperty("$schema")
@@ -162,14 +162,14 @@ public class Schema {
/**
* Bean property setter: <property>$schema</property>.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param schemaVersion The new value for the <property>schemaVersion</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -181,7 +181,7 @@ public class Schema {
/**
* Bean property getter: <property>title</property>.
- *
+ *
* @return The value of the <property>title</property> property, or <jk>null</jk> if it is not set.
*/
public String getTitle() {
@@ -190,7 +190,7 @@ public class Schema {
/**
* Bean property setter: <property>title</property>.
- *
+ *
* @param title The new value for the <property>title</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -201,7 +201,7 @@ public class Schema {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* @return The value of the <property>description</property> property, or <jk>null</jk> if it is not set.
*/
public String getDescription() {
@@ -210,7 +210,7 @@ public class Schema {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -221,7 +221,7 @@ public class Schema {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* @return
* The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
* Can be either a {@link JsonType} or {@link JsonTypeArray} depending on what value was used to set it.
@@ -235,10 +235,10 @@ public class Schema {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* <p>
* Convenience method for returning the <property>type</property> property when it is a {@link JsonType} value.
- *
+ *
* @return
* The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link JsonTypeArray}.
*/
@@ -249,10 +249,10 @@ public class Schema {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* <p>
* Convenience method for returning the <property>type</property> property when it is a {@link JsonTypeArray} value.
- *
+ *
* @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link JsonType}.
*/
@BeanIgnore
@@ -262,7 +262,7 @@ public class Schema {
/**
* Bean property setter: <property>type</property>.
- *
+ *
* @param type
* The new value for the <property>type</property> property on this bean.
* This object must be of type {@link JsonType} or {@link JsonTypeArray}.
@@ -287,7 +287,7 @@ public class Schema {
/**
* Bean property appender: <property>type</property>.
- *
+ *
* @param types The list of items to append to the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -300,14 +300,14 @@ 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}.
* </ul>
- *
+ *
* <p>
* Serialization method is a no-op.
*/
@@ -331,7 +331,7 @@ public class Schema {
/**
* Bean property getter: <property>definitions</property>.
- *
+ *
* @return
* The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -341,7 +341,7 @@ public class Schema {
/**
* Bean property setter: <property>definitions</property>.
- *
+ *
* @param definitions The new value for the <property>definitions</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -354,7 +354,7 @@ public class Schema {
/**
* Bean property appender: <property>definitions</property>.
- *
+ *
* @param name The key in the definitions map entry.
* @param definition The value in the definitions map entry.
* @return This object (for method chaining).
@@ -369,7 +369,7 @@ public class Schema {
/**
* Bean property getter: <property>properties</property>.
- *
+ *
* @return The value of the <property>properties</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,Schema> getProperties() {
@@ -378,10 +378,10 @@ public class Schema {
/**
* Returns the property with the specified name.
- *
+ *
* <p>
* This is equivalent to calling <property>getProperty(name, <jk>false</jk>)</property>.
- *
+ *
* @param name The property name.
* @return The property with the specified name, or <jk>null</jk> if no property is specified.
*/
@@ -391,14 +391,14 @@ public class Schema {
/**
* Returns the property with the specified name.
- *
+ *
* <p>
* If <property>resolve</property> is <jk>true</jk>, the property object will automatically be resolved by calling
* {@link #resolve()}.
* Therefore, <property>getProperty(name, <jk>true</jk>)</property> is equivalent to calling
* <property>getProperty(name).resolve()</property>, except it's safe from a potential
* <property>NullPointerException</property>.
- *
+ *
* @param name The property name.
* @param resolve If <jk>true</jk>, calls {@link #resolve()} on object before returning.
* @return The property with the specified name, or <jk>null</jk> if no property is specified.
@@ -416,7 +416,7 @@ public class Schema {
/**
* Bean property setter: <property>properties</property>.
- *
+ *
* @param properties The new value for the <property>properties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -433,10 +433,10 @@ public class Schema {
/**
* Bean property appender: <property>properties</property>.
- *
+ *
* <p>
* Properties must have their <property>name</property> property set on them when using this method.
- *
+ *
* @param properties The list of items to append to the <property>properties</property> property on this bean.
* @return This object (for method chaining).
* @throws BeanRuntimeException If property is found without a set <property>name</property> property.
@@ -456,7 +456,7 @@ public class Schema {
/**
* Bean property getter: <property>patternProperties</property>.
- *
+ *
* @return
* The value of the <property>patternProperties</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -467,7 +467,7 @@ public class Schema {
/**
* Bean property setter: <property>patternProperties</property>.
- *
+ *
* @param patternProperties The new value for the <property>patternProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -484,10 +484,10 @@ public class Schema {
/**
* Bean property appender: <property>patternProperties</property>.
- *
+ *
* <p>
* Properties must have their <property>name</property> property set to the pattern string when using this method.
- *
+ *
* @param properties The list of items to append to the <property>patternProperties</property> property on this bean.
* @return This object (for method chaining).
* @throws BeanRuntimeException If property is found without a set <property>name</property> property.
@@ -507,7 +507,7 @@ public class Schema {
/**
* Bean property getter: <property>dependencies</property>.
- *
+ *
* @return
* The value of the <property>dependencies</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -517,7 +517,7 @@ public class Schema {
/**
* Bean property setter: <property>dependencies</property>.
- *
+ *
* @param dependencies The new value for the <property>dependencies</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -530,7 +530,7 @@ public class Schema {
/**
* Bean property appender: <property>dependencies</property>.
- *
+ *
* @param name The key of the entry in the dependencies map.
* @param dependency The value of the entry in the dependencies map.
* @return This object (for method chaining).
@@ -545,7 +545,7 @@ public class Schema {
/**
* Bean property getter: <property>items</property>.
- *
+ *
* @return
* The value of the <property>items</property> property on this bean, or <jk>null</jk> if it is not set.
* Can be either a {@link Schema} or {@link SchemaArray} depending on what value was used to set it.
@@ -559,10 +559,10 @@ public class Schema {
/**
* Bean property getter: <property>items</property>.
- *
+ *
* <p>
* Convenience method for returning the <property>items</property> property when it is a {@link Schema} value.
- *
+ *
* @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link SchemaArray}.
*/
@BeanIgnore
@@ -572,10 +572,10 @@ public class Schema {
/**
* Bean property getter: <property>items</property>.
- *
+ *
* <p>
* Convenience method for returning the <property>items</property> property when it is a {@link SchemaArray} value.
- *
+ *
* @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link Schema}.
*/
@BeanIgnore
@@ -585,14 +585,14 @@ 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}.
* </ul>
- *
+ *
* <p>
* Serialization method is a no-op.
*/
@@ -616,7 +616,7 @@ public class Schema {
/**
* Bean property setter: <property>items</property>.
- *
+ *
* @param
* items The new value for the <property>items</property> property on this bean.
* This object must be of type {@link Schema} or {@link SchemaArray}.
@@ -643,7 +643,7 @@ public class Schema {
/**
* Bean property appender: <property>items</property>.
- *
+ *
* @param items The list of items to append to the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -657,7 +657,7 @@ public class Schema {
/**
* Bean property getter: <property>multipleOf</property>.
- *
+ *
* @return The value of the <property>multipleOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMultipleOf() {
@@ -666,7 +666,7 @@ public class Schema {
/**
* Bean property setter: <property>multipleOf</property>.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -677,7 +677,7 @@ public class Schema {
/**
* Bean property getter: <property>maximum</property>.
- *
+ *
* @return The value of the <property>maximum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMaximum() {
@@ -686,7 +686,7 @@ public class Schema {
/**
* Bean property setter: <property>maximum</property>.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -697,7 +697,7 @@ public class Schema {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
- *
+ *
* @return
* The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -708,7 +708,7 @@ public class Schema {
/**
* Bean property setter: <property>exclusiveMaximum</property>.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -719,7 +719,7 @@ public class Schema {
/**
* Bean property getter: <property>minimum</property>.
- *
+ *
* @return The value of the <property>minimum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMinimum() {
@@ -728,7 +728,7 @@ public class Schema {
/**
* Bean property setter: <property>minimum</property>.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -739,7 +739,7 @@ public class Schema {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
- *
+ *
* @return
* The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -750,7 +750,7 @@ public class Schema {
/**
* Bean property setter: <property>exclusiveMinimum</property>.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -761,7 +761,7 @@ public class Schema {
/**
* Bean property getter: <property>maxLength</property>.
- *
+ *
* @return The value of the <property>maxLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxLength() {
@@ -770,7 +770,7 @@ public class Schema {
/**
* Bean property setter: <property>maxLength</property>.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -781,7 +781,7 @@ public class Schema {
/**
* Bean property getter: <property>minLength</property>.
- *
+ *
* @return The value of the <property>minLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinLength() {
@@ -790,7 +790,7 @@ public class Schema {
/**
* Bean property setter: <property>minLength</property>.
- *
+ *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -801,7 +801,7 @@ public class Schema {
/**
* Bean property getter: <property>pattern</property>.
- *
+ *
* @return The value of the <property>pattern</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getPattern() {
@@ -810,7 +810,7 @@ public class Schema {
/**
* Bean property setter: <property>pattern</property>.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -821,7 +821,7 @@ public class Schema {
/**
* Bean property getter: <property>additionalItems</property>.
- *
+ *
* @return
* The value of the <property>additionalItems</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -836,11 +836,11 @@ public class Schema {
/**
* Bean property getter: <property>additionalItems</property>.
- *
+ *
* <p>
* Convenience method for returning the <property>additionalItems</property> property when it is a {@link Boolean}
* value.
- *
+ *
* @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link SchemaArray}.
*/
@BeanIgnore
@@ -850,11 +850,11 @@ public class Schema {
/**
* Bean property getter: <property>additionalItems</property>.
- *
+ *
* <p>
* Convenience method for returning the <property>additionalItems</property> property when it is a
* {@link SchemaArray} value.
- *
+ *
* @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link Boolean}.
*/
@BeanIgnore
@@ -864,7 +864,7 @@ public class Schema {
/**
* Bean property setter: <property>additionalItems</property>.
- *
+ *
* @param additionalItems
* The new value for the <property>additionalItems</property> property on this bean.
* This object must be of type {@link Boolean} or {@link SchemaArray}.
@@ -890,7 +890,7 @@ public class Schema {
/**
* Bean property appender: <property>additionalItems</property>.
- *
+ *
* @param additionalItems
* The list of items to append to the <property>additionalItems</property> property on this bean.
* @return This object (for method chaining).
@@ -905,14 +905,14 @@ 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}.
* </ul>
- *
+ *
* <p>
* Serialization method is a no-op.
*/
@@ -936,7 +936,7 @@ public class Schema {
/**
* Bean property getter: <property>maxItems</property>.
- *
+ *
* @return The value of the <property>maxItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxItems() {
@@ -945,7 +945,7 @@ public class Schema {
/**
* Bean property setter: <property>maxItems</property>.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -956,7 +956,7 @@ public class Schema {
/**
* Bean property getter: <property>minItems</property>.
- *
+ *
* @return The value of the <property>minItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinItems() {
@@ -965,7 +965,7 @@ public class Schema {
/**
* Bean property setter: <property>minItems</property>.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -976,7 +976,7 @@ public class Schema {
/**
* Bean property getter: <property>uniqueItems</property>.
- *
+ *
* @return
* The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -986,7 +986,7 @@ public class Schema {
/**
* Bean property setter: <property>uniqueItems</property>.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -997,7 +997,7 @@ public class Schema {
/**
* Bean property getter: <property>maxProperties</property>.
- *
+ *
* @return
* The value of the <property>maxProperties</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -1007,7 +1007,7 @@ public class Schema {
/**
* Bean property setter: <property>maxProperties</property>.
- *
+ *
* @param maxProperties The new value for the <property>maxProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1018,7 +1018,7 @@ public class Schema {
/**
* Bean property getter: <property>minProperties</property>.
- *
+ *
* @return
* The value of the <property>minProperties</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -1028,7 +1028,7 @@ public class Schema {
/**
* Bean property setter: <property>minProperties</property>.
- *
+ *
* @param minProperties The new value for the <property>minProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1039,7 +1039,7 @@ public class Schema {
/**
* Bean property getter: <property>required</property>.
- *
+ *
* @return The value of the <property>required</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<String> getRequired() {
@@ -1048,7 +1048,7 @@ public class Schema {
/**
* Bean property setter: <property>required</property>.
- *
+ *
* @param required The new value for the <property>required</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1059,7 +1059,7 @@ public class Schema {
/**
* Bean property appender: <property>required</property>.
- *
+ *
* @param required The list of items to append to the <property>required</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1073,7 +1073,7 @@ public class Schema {
/**
* Bean property appender: <property>required</property>.
- *
+ *
* @param required The list of items to append to the <property>required</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1087,7 +1087,7 @@ public class Schema {
/**
* Bean property appender: <property>required</property>.
- *
+ *
* @param properties The list of items to append to the <property>required</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1101,7 +1101,7 @@ public class Schema {
/**
* Bean property getter: <property>additionalProperties</property>.
- *
+ *
* @return
* The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it
* is not set.
@@ -1116,11 +1116,11 @@ public class Schema {
/**
* Bean property getter: <property>additionalProperties</property>.
- *
+ *
* <p>
* Convenience method for returning the <property>additionalProperties</property> property when it is a
* {@link Boolean} value.
- *
+ *
* @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link Schema}.
*/
@BeanIgnore
@@ -1130,11 +1130,11 @@ public class Schema {
/**
* Bean property getter: <property>additionalProperties</property>.
- *
+ *
* <p>
* Convenience method for returning the <property>additionalProperties</property> property when it is a
* {@link Schema} value.
- *
+ *
* @return The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link Boolean}.
*/
@BeanIgnore
@@ -1144,7 +1144,7 @@ public class Schema {
/**
* Bean property setter: <property>additionalProperties</property>.
- *
+ *
* @param additionalProperties
* The new value for the <property>additionalProperties</property> property on this bean.
* This object must be of type {@link Boolean} or {@link Schema}.
@@ -1171,14 +1171,14 @@ 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}.
* </ul>
- *
+ *
* <p>
* Serialization method is a no-op.
*/
@@ -1202,7 +1202,7 @@ public class Schema {
/**
* Bean property getter: <property>enum</property>.
- *
+ *
* @return The value of the <property>enum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<String> getEnum() {
@@ -1211,7 +1211,7 @@ public class Schema {
/**
* Bean property setter: <property>enum</property>.
- *
+ *
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1222,7 +1222,7 @@ public class Schema {
/**
* Bean property appender: <property>enum</property>.
- *
+ *
* @param _enum The list of items to append to the <property>enum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1236,7 +1236,7 @@ public class Schema {
/**
* Bean property getter: <property>allOf</property>.
- *
+ *
* @return The value of the <property>allOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Schema> getAllOf() {
@@ -1245,7 +1245,7 @@ public class Schema {
/**
* Bean property setter: <property>allOf</property>.
- *
+ *
* @param allOf The new value for the <property>allOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1257,7 +1257,7 @@ public class Schema {
/**
* Bean property appender: <property>allOf</property>.
- *
+ *
* @param allOf The list of items to append to the <property>allOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1272,7 +1272,7 @@ public class Schema {
/**
* Bean property getter: <property>anyOf</property>.
- *
+ *
* @return The value of the <property>anyOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Schema> getAnyOf() {
@@ -1281,7 +1281,7 @@ public class Schema {
/**
* Bean property setter: <property>anyOf</property>.
- *
+ *
* @param anyOf The new value of the <property>anyOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1293,7 +1293,7 @@ public class Schema {
/**
* Bean property appender: <property>anyOf</property>.
- *
+ *
* @param anyOf The list of items to append to the <property>anyOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1308,7 +1308,7 @@ public class Schema {
/**
* Bean property getter: <property>oneOf</property>.
- *
+ *
* @return The value of the <property>oneOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Schema> getOneOf() {
@@ -1317,7 +1317,7 @@ public class Schema {
/**
* Bean property setter: <property>oneOf</property>.
- *
+ *
* @param oneOf The new value for the <property>oneOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1329,7 +1329,7 @@ public class Schema {
/**
* Bean property appender: <property>oneOf</property>.
- *
+ *
* @param oneOf The list of items to append to the <property>oneOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1344,7 +1344,7 @@ public class Schema {
/**
* Bean property getter: <property>not</property>.
- *
+ *
* @return The value of the <property>not</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Schema getNot() {
@@ -1353,7 +1353,7 @@ public class Schema {
/**
* Bean property setter: <property>not</property>.
- *
+ *
* @param not The new value for the <property>not</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1365,7 +1365,7 @@ public class Schema {
/**
* Bean property getter: <property>$ref</property>.
- *
+ *
* @return The value of the <property>$ref</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@BeanProperty("$ref")
@@ -1375,14 +1375,14 @@ public class Schema {
/**
* Bean property setter: <property>$ref</property>.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param ref The new value for the <property>$ref</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1417,11 +1417,11 @@ public class Schema {
/**
* Sets the master schema for this schema and all child schema objects.
- *
+ *
* <p>
* All child elements in a schema should point to a single "master" schema in order to locate registered SchemaMap
* objects for resolving external schemas.
- *
+ *
* @param master The master schema to associate on this and all children. Can be <jk>null</jk>.
*/
protected void setMaster(Schema master) {
@@ -1463,11 +1463,11 @@ public class Schema {
/**
* If this schema is a reference to another schema (i.e. has its <property>$ref</property> property set), this
* method will retrieve the referenced schema from the schema map registered with this schema.
- *
+ *
* <p>
* If this schema is not a reference, or no schema map is registered with this schema, this method is a no-op and
* simply returns this object.
- *
+ *
* @return The referenced schema, or <jk>null</jk>.
*/
public Schema resolve() {
@@ -1479,7 +1479,7 @@ public class Schema {
/**
* Associates a schema map with this schema for resolving other schemas identified through <property>$ref</property>
* properties.
- *
+ *
* @param schemaMap The schema map to associate with this schema. Can be <jk>null</jk>.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java
index dc48116..58cf9bb 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java
@@ -16,7 +16,7 @@ import java.util.*;
/**
* Represents a list of {@link Schema} objects.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -43,7 +43,7 @@ public class SchemaArray extends LinkedList<Schema> {
/**
* Constructor with predefined types to add to this list.
- *
+ *
* @param schemas The list of schemas in this array.
*/
public SchemaArray(Schema...schemas) {
@@ -52,7 +52,7 @@ public class SchemaArray extends LinkedList<Schema> {
/**
* Convenience method for adding one or more {@link Schema} objects to this array.
- *
+ *
* @param schemas The {@link Schema} objects to add to this array.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
index fe078b2..14332de 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
@@ -22,7 +22,7 @@ import org.apache.juneau.json.*;
/**
* A container for retrieving JSON {@link Schema} objects by URI.
- *
+ *
* <p>
* Subclasses must implement one of the following methods to load schemas from external sources:
* <ul class='spaced-list'>
@@ -31,7 +31,7 @@ import org.apache.juneau.json.*;
* <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'>
@@ -53,17 +53,17 @@ public abstract class SchemaMap extends ConcurrentHashMap<URI,Schema> {
/**
* Return the {@link Schema} object at the specified URI.
- *
+ *
* <p>
* If this schema object has not been loaded yet, calls {@link #load(URI)}.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param uri The URI of the schema to retrieve.
* @return The Schema, or <jk>null</jk> if schema was not located and could not be loaded.
*/
@@ -86,10 +86,10 @@ public abstract class SchemaMap extends ConcurrentHashMap<URI,Schema> {
/**
* Convenience method for pre-populating this map with the specified schemas.
- *
+ *
* <p>
* The schemas passed in through this method MUST have their ID properties set.
- *
+ *
* @param schemas The set of schemas to add to this map.
* @return This object (for method chaining).
* @throws RuntimeException If one or more schema objects did not have their ID property set.
@@ -106,15 +106,15 @@ public abstract class SchemaMap extends ConcurrentHashMap<URI,Schema> {
/**
* Subclasses must implement either this method or {@link #getReader(URI)} to load the schema with the specified URI.
- *
+ *
* <p>
* It's up to the implementer to decide where these come from.
- *
+ *
* <p>
* The default implementation calls {@link #getReader(URI)} and parses the schema document.
* If {@link #getReader(URI)} returns <jk>null</jk>, this method returns <jk>null</jk> indicating this is an
* unreachable document.
- *
+ *
* @param uri The URI to load the schema from.
* @return The parsed schema.
*/
@@ -130,13 +130,13 @@ public abstract class SchemaMap extends ConcurrentHashMap<URI,Schema> {
/**
* Subclasses must implement either this method or {@link #load(URI)} to load the schema with the specified URI.
- *
+ *
* <p>
* It's up to the implementer to decide where these come from.
- *
+ *
* <p>
* The default implementation returns <jk>null</jk>.
- *
+ *
* @param uri The URI to connect to and retrieve the contents.
* @return The reader from reading the specified URI.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java
index c0f1dc7..d30fb9c 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java
@@ -14,7 +14,7 @@ package org.apache.juneau.dto.jsonschema;
/**
* Represents a JSON property in the JSON-Schema core specification.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -39,7 +39,7 @@ public class SchemaProperty extends Schema {
/**
* Convenience constructor.
- *
+ *
* @param name The name of this property.
*/
public SchemaProperty(String name) {
@@ -48,7 +48,7 @@ public class SchemaProperty extends Schema {
/**
* Convenience constructor.
- *
+ *
* @param name The name of this property.
* @param type The JSON type of this property.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
index ced1eaf..66f5224 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
@@ -14,10 +14,10 @@ package org.apache.juneau.dto.jsonschema;
/**
* Convenience class for representing a property that's an array of simple types.
- *
+ *
* <p>
* An instance of this object is equivalent to calling...
- *
+ *
* <p class='bcode'>
* SchemaProperty p = <jk>new</jk> SchemaProperty(name)
* .setType(JsonType.<jsf>ARRAY</jsf>)
@@ -25,7 +25,7 @@ package org.apache.juneau.dto.jsonschema;
* <jk>new</jk> Schema().setType(elementType)
* );
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -45,7 +45,7 @@ public class SchemaPropertySimpleArray extends SchemaProperty {
/**
* Constructor.
- *
+ *
* @param name The name of the schema property.
* @param elementType The JSON type of the elements in the array.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
index 080cb52..c78d02a 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
@@ -18,14 +18,14 @@ import org.apache.juneau.*;
/**
* Convenience class for representing a schema reference such as <js>"{'$ref':'/url/to/ref'}"</js>.
- *
+ *
* <p>
* An instance of this object is equivalent to calling...
- *
+ *
* <p class='bcode'>
* Schema s = <jk>new</jk> Schema().setRef(uri);
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -45,14 +45,14 @@ public class SchemaRef extends Schema {
/**
* Constructor.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param uri The URI of the target reference. Can be <jk>null</jk>.
*/
public SchemaRef(Object uri) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Contact.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Contact.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Contact.java
index 7a419cb..e5fbc5b 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Contact.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Contact.java
@@ -22,7 +22,7 @@ import org.apache.juneau.annotation.*;
/**
* Contact information for the exposed API.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <js>"email"</js>: <js>"support@swagger.io"</js>
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -56,10 +56,10 @@ public class Contact extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
- *
+ *
* <p>
* The identifying name of the contact person/organization.
- *
+ *
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getName() {
@@ -68,10 +68,10 @@ public class Contact extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
- *
+ *
* <p>
* The identifying name of the contact person/organization.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -82,7 +82,7 @@ public class Contact extends SwaggerElement {
/**
* Synonym for {@link #setName(String)}.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -92,10 +92,10 @@ public class Contact extends SwaggerElement {
/**
* Bean property getter: <property>url</property>.
- *
+ *
* <p>
* The URL pointing to the contact information. MUST be in the format of a URL.
- *
+ *
* @return The value of the <property>url</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public URI getUrl() {
@@ -104,14 +104,14 @@ public class Contact extends SwaggerElement {
/**
* Bean property setter: <property>url</property>.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param url The new value for the <property>url</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -122,7 +122,7 @@ public class Contact extends SwaggerElement {
/**
* Synonym for {@link #setUrl(Object)}.
- *
+ *
* @param url The new value for the <property>url</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -132,10 +132,10 @@ public class Contact extends SwaggerElement {
/**
* Bean property getter: <property>email</property>.
- *
+ *
* <p>
* The email address of the contact person/organization. MUST be in the format of an email address.
- *
+ *
* @return The value of the <property>email</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getEmail() {
@@ -144,10 +144,10 @@ public class Contact extends SwaggerElement {
/**
* Bean property setter: <property>email</property>.
- *
+ *
* <p>
* The email address of the contact person/organization. MUST be in the format of an email address.
- *
+ *
* @param email The new value for the <property>email</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -158,7 +158,7 @@ public class Contact extends SwaggerElement {
/**
* Synonym for {@link #setEmail(String)}.
- *
+ *
* @param email The new value for the <property>email</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
index 4ab8c9d..f780486 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
@@ -22,7 +22,7 @@ import org.apache.juneau.annotation.*;
/**
* Allows referencing an external resource for extended documentation.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -30,7 +30,7 @@ import org.apache.juneau.annotation.*;
* <js>"url"</js>: <js>"https://swagger.io"</js>
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -54,10 +54,10 @@ public class ExternalDocumentation extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* A short description of the target documentation. GFM syntax can be used for rich text representation.
- *
+ *
* @return
* The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -67,10 +67,10 @@ public class ExternalDocumentation extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* A short description of the target documentation. GFM syntax can be used for rich text representation.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -81,7 +81,7 @@ public class ExternalDocumentation extends SwaggerElement {
/**
* Synonym for {@link #setDescription(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -91,17 +91,17 @@ public class ExternalDocumentation extends SwaggerElement {
/**
* Bean property getter: <property>url</property>.
- *
+ *
* <p>
* Required. The URL for the target documentation.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @return The value of the <property>url</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public URI getUrl() {
@@ -110,14 +110,14 @@ public class ExternalDocumentation extends SwaggerElement {
/**
* Bean property setter: <property>url</property>.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param url The new value for the <property>url</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -128,7 +128,7 @@ public class ExternalDocumentation extends SwaggerElement {
/**
* Synonym for {@link #setUrl(Object)}.
- *
+ *
* @param url The new value for the <property>url</property> property on this bean.
* @return This object (for method chaining).
*/
[13/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/Serializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/Serializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/Serializer.java
index a092a88..3e92cea 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/Serializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/Serializer.java
@@ -21,11 +21,12 @@ import org.apache.juneau.parser.*;
/**
* Parent class for all Juneau serializers.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Base serializer class that serves as the parent class for all serializers.
- *
+ *
* <p>
* The purpose of this class is:
* <ul>
@@ -33,7 +34,7 @@ import org.apache.juneau.parser.*;
* <li>Create session objects used for serializing POJOs (i.e. {@link SerializerSession}).
* <li>Provide convenience methods for serializing POJOs without having to construct session objects.
* </ul>
- *
+ *
* <p>
* Subclasses should extend directly from {@link OutputStreamSerializer} or {@link WriterSerializer} depending on
* whether it's a stream or character based serializer.
@@ -48,7 +49,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Abridged output.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.abridged.b"</js>
@@ -61,12 +62,12 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#abridged()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* When enabled, it is assumed that the parser knows the exact Java POJO type being parsed, and therefore top-level
* type information that might normally be included to determine the data type will not be serialized.
- *
+ *
* <p>
* For example, when serializing a top-level POJO with a {@link Bean#typeName() @Bean.typeName()} value, a
* <js>'_type'</js> attribute will only be added when this setting is enabled.
@@ -107,7 +108,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.addBeanTypeProperties.b"</js>
@@ -119,7 +120,7 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#addBeanTypeProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
@@ -167,7 +168,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Automatically detect POJO recursions.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.detectRecursions.b"</js>
@@ -180,19 +181,19 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#detectRecursions()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies that recursions should be checked for during serialization.
- *
+ *
* <p>
* Recursions can occur when serializing models that aren't true trees but rather contain loops.
* <br>In general, unchecked recursions cause stack-overflow-errors.
* <br>These show up as {@link ParseException ParseExceptions} with the message <js>"Depth too deep. Stack overflow occurred."</js>.
- *
+ *
* <p>
* The behavior when recursions are detected depends on the value for {@link #SERIALIZER_ignoreRecursions}.
- *
+ *
* <p>
* 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>...
@@ -200,7 +201,7 @@ public abstract class Serializer extends BeanContext {
* <p class='bcode'>
* {A:{B:{C:<jk>null</jk>}}}
* </p>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Checking for recursion can cause a small performance penalty.
@@ -237,7 +238,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Ignore recursion errors.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.ignoreRecursions.b"</js>
@@ -250,12 +251,12 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#ignoreRecursions()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Used in conjunction with {@link #SERIALIZER_detectRecursions}.
* <br>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>.
* <br>Otherwise, a {@link SerializeException} is thrown with the message <js>"Recursion occurred, stack=..."</js>.
@@ -264,7 +265,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Initial depth.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.initialDepth.i"</js>
@@ -276,7 +277,7 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#initialDepth(int)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* The initial indentation level at the root.
@@ -306,7 +307,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Serializer listener.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.listener.c"</js>
@@ -318,7 +319,7 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#listener(Class)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Class used to listen for errors and warnings that occur during serialization.
@@ -369,7 +370,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Max serialization depth.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.maxDepth.i"</js>
@@ -381,7 +382,7 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#maxDepth(int)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Abort serialization if specified depth is reached in the POJO tree.
@@ -406,7 +407,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Maximum indentation.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.maxIndent.i"</js>
@@ -418,11 +419,11 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#maxIndent(int)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies the maximum indentation level in the serialized document.
- *
+ *
* <p>
* This setting does not apply to the MessagePack or RDF serializers.
*
@@ -445,7 +446,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Quote character.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.quoteChar.s"</js>
@@ -458,11 +459,11 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#sq()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* This is the character used for quoting attributes and values.
- *
+ *
* <p>
* This setting does not apply to the MessagePack or RDF serializers.
*
@@ -485,7 +486,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Sort arrays and collections alphabetically.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.sortCollections.b"</js>
@@ -498,9 +499,9 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#sortCollections()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
- *
+ *
* <p>
* Copies and sorts the contents of arrays and collections before serializing them.
*
@@ -526,7 +527,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Sort maps alphabetically.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.sortMaps.b"</js>
@@ -539,9 +540,9 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#sortMaps()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
- *
+ *
* <p>
* Copies and sorts the contents of maps by their keys before serializing them.
*
@@ -567,7 +568,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Trim empty lists and arrays.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.trimEmptyCollections.b"</js>
@@ -580,12 +581,12 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#trimEmptyCollections()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
- *
+ *
* <p>
* If <jk>true</jk>, empty lists and arrays will not be serialized.
- *
+ *
* <p>
* Note that enabling this setting has the following effects on parsing:
* <ul class='spaced-list'>
@@ -614,7 +615,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Trim empty maps.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.trimEmptyMaps.b"</js>
@@ -627,11 +628,11 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#trimEmptyMaps()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, empty map values will not be serialized to the output.
- *
+ *
* <p>
* Note that enabling this setting has the following effects on parsing:
* <ul class='spaced-list'>
@@ -658,7 +659,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Trim null bean property values.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.trimNullProperties.b"</js>
@@ -670,11 +671,11 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#trimNullProperties(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, null bean values will not be serialized to the output.
- *
+ *
* <p>
* Note that enabling this setting has the following effects on parsing:
* <ul class='spaced-list'>
@@ -701,7 +702,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Trim strings.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.trimStrings.b"</js>
@@ -714,7 +715,7 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#trimStrings()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being serialized.
@@ -744,7 +745,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: URI context bean.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.uriContext.s"</js>
@@ -757,11 +758,11 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#uriContext(String)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Bean used for resolution of URIs to absolute or root-relative form.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Our URI contextual information.</jc>
@@ -807,7 +808,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: URI relativity.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.uriRelativity.s"</js>
@@ -820,7 +821,7 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#uriRelativity(String)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Defines what relative URIs are relative to when serializing any of the following:
@@ -829,7 +830,7 @@ public abstract class Serializer extends BeanContext {
* <li>{@link java.net.URL}
* <li>Properties and classes annotated with {@link org.apache.juneau.annotation.URI @URI}
* </ul>
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -859,7 +860,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: URI resolution.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.uriResolution.s"</js>
@@ -872,7 +873,7 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#uriResolution(String)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Defines the resolution level for URIs when serializing any of the following:
@@ -881,7 +882,7 @@ public abstract class Serializer extends BeanContext {
* <li>{@link java.net.URL}
* <li>Properties and classes annotated with {@link org.apache.juneau.annotation.URI @URI}
* </ul>
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -913,7 +914,7 @@ public abstract class Serializer extends BeanContext {
/**
* Configuration property: Use whitespace.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"Serializer.useWhitespace.b"</js>
@@ -927,11 +928,11 @@ public abstract class Serializer extends BeanContext {
* <li class='jm'>{@link SerializerBuilder#ws()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* If <jk>true</jk>, whitespace is added to the output to improve readability.
- *
+ *
* <p>
* This setting does not apply to the MessagePack serializer.
*
@@ -1035,7 +1036,7 @@ public abstract class Serializer extends BeanContext {
/**
* Returns <jk>true</jk> if this serializer subclasses from {@link WriterSerializer}.
- *
+ *
* @return <jk>true</jk> if this serializer subclasses from {@link WriterSerializer}.
*/
public boolean isWriterSerializer() {
@@ -1044,7 +1045,7 @@ public abstract class Serializer extends BeanContext {
/**
* Create the session object used for actual serialization of objects.
- *
+ *
* @param args
* Runtime arguments.
* These specify session-level information such as locale and URI context.
@@ -1072,10 +1073,10 @@ public abstract class Serializer extends BeanContext {
/**
* Serializes a POJO to the specified output stream or writer.
- *
+ *
* <p>
* Equivalent to calling <code>serializer.createSession().serialize(o, output);</code>
- *
+ *
* @param o The object to serialize.
* @param output
* The output object.
@@ -1100,7 +1101,7 @@ public abstract class Serializer extends BeanContext {
/**
* Shortcut method for serializing objects directly to either a <code>String</code> or <code><jk>byte</jk>[]</code>
* depending on the serializer type.
- *
+ *
* @param o The object to serialize.
* @return
* The serialized object.
@@ -1118,7 +1119,7 @@ public abstract class Serializer extends BeanContext {
/**
* Returns the media types handled based on the value of the <code>accept</code> parameter passed into the constructor.
- *
+ *
* @return The list of media types. Never <jk>null</jk>.
*/
public final MediaType[] getMediaTypes() {
@@ -1128,17 +1129,17 @@ public abstract class Serializer extends BeanContext {
/**
* Optional method that returns the response <code>Content-Type</code> for this serializer if it is different from
* the matched media type.
- *
+ *
* <p>
* This method is specified to override the content type for this serializer.
* For example, the {@link org.apache.juneau.json.JsonSerializer.Simple} class returns that it handles media type
* <js>"text/json+simple"</js>, but returns <js>"text/json"</js> as the actual content type.
* This allows clients to request specific 'flavors' of content using specialized <code>Accept</code> header values.
- *
+ *
* <p>
* This method is typically meaningless if the serializer is being used stand-alone (i.e. outside of a REST server
* or client).
- *
+ *
* @return The response content type. If <jk>null</jk>, then the matched media type is used.
*/
public final MediaType getResponseContentType() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java
index a0b090f..842508b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerBuilder.java
@@ -33,7 +33,7 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public SerializerBuilder(PropertyStore ps) {
@@ -47,11 +47,11 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Abridged output.
- *
+ *
* <p>
* When enabled, it is assumed that the parser knows the exact Java POJO type being parsed, and therefore top-level
* type information that might normally be included to determine the data type will not be serialized.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_abridged}
@@ -68,10 +68,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Abridged output.
- *
+ *
* <p>
* Shortcut for calling <code>abridged(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_abridged}
@@ -85,11 +85,11 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
* through reflection.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_addBeanTypeProperties}
@@ -106,15 +106,15 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Automatically detect POJO recursions.
- *
+ *
* <p>
* Specifies that recursions should be checked for during serialization.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Checking for recursion can cause a small performance penalty.
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_detectRecursions}
@@ -131,10 +131,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Automatically detect POJO recursions.
- *
+ *
* <p>
* Shortcut for calling <code>detectRecursions(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_detectRecursions}
@@ -148,16 +148,16 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Ignore recursion errors.
- *
+ *
* <p>
* 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.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Checking for recursion can cause a small performance penalty.
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_ignoreRecursions}
@@ -174,10 +174,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Ignore recursion errors.
- *
+ *
* <p>
* Shortcut for calling <code>ignoreRecursions(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_ignoreRecursions}
@@ -191,10 +191,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Initial depth.
- *
+ *
* <p>
* The initial indentation level at the root.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_initialDepth}
@@ -211,10 +211,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Serializer listener.
- *
+ *
* <p>
* Class used to listen for errors and warnings that occur during serialization.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_listener}
@@ -230,12 +230,12 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Max serialization depth.
- *
+ *
* <p>
* Abort serialization if specified depth is reached in the POJO tree.
* <br>If this depth is exceeded, an exception is thrown.
* <br>This prevents stack overflows from occurring when trying to serialize models with recursive references.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_maxDepth}
@@ -252,10 +252,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Maximum indentation.
- *
+ *
* <p>
* Specifies the maximum indentation level in the serialized document.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_maxIndent}
@@ -272,10 +272,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Quote character.
- *
+ *
* <p>
* This is the character used for quoting attributes and values.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_quoteChar}
@@ -292,10 +292,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Sort arrays and collections alphabetically.
- *
+ *
* <p>
* Copies and sorts the contents of arrays and collections before serializing them.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortCollections}
@@ -315,7 +315,7 @@ public class SerializerBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>sortCollections(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortCollections}
@@ -329,10 +329,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Sort maps alphabetically.
- *
+ *
* <p>
* Copies and sorts the contents of maps before serializing them.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortMaps}
@@ -352,7 +352,7 @@ public class SerializerBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>sortMaps(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortMaps}
@@ -369,7 +369,7 @@ public class SerializerBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>quoteChar(<js>'\''</js>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_quoteChar}
@@ -383,10 +383,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty lists and arrays.
- *
+ *
* <p>
* If <jk>true</jk>, empty list values will not be serialized to the output.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyCollections}
@@ -403,10 +403,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty lists and arrays.
- *
+ *
* <p>
* Shortcut for calling <code>trimEmptyCollections(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyCollections}
@@ -420,10 +420,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty maps.
- *
+ *
* <p>
* If <jk>true</jk>, empty map values will not be serialized to the output.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyMaps}
@@ -440,10 +440,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty maps.
- *
+ *
* <p>
* Shortcut for calling <code>trimEmptyMaps(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyMaps}
@@ -457,10 +457,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim null bean property values.
- *
+ *
* <p>
* If <jk>true</jk>, null bean values will not be serialized to the output.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimNullProperties}
@@ -477,10 +477,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim strings.
- *
+ *
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being serialized.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimStrings}
@@ -497,10 +497,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim strings.
- *
+ *
* <p>
* Shortcut for calling <code>trimStrings(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimStrings}
@@ -514,10 +514,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: URI context bean.
- *
+ *
* <p>
* Bean used for resolution of URIs to absolute or root-relative form.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriContext}
@@ -532,7 +532,7 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: URI context bean.
- *
+ *
* <p>
* Same as {@link #uriContext(UriContext)} but allows you to pass in a JSON string.
*
@@ -543,7 +543,7 @@ public class SerializerBuilder extends BeanContextBuilder {
* .uriContext(<js>"{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}"</js>)
* .build();
* </p>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriContext}
@@ -558,10 +558,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: URI relativity.
- *
+ *
* <p>
* Defines what relative URIs are relative to when serializing URI/URL objects.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriRelativity}
@@ -578,7 +578,7 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: URI relativity.
- *
+ *
* <p>
* Same as {@link #uriRelativity(UriRelativity)} but allows you to pass in a string.
*
@@ -589,7 +589,7 @@ public class SerializerBuilder extends BeanContextBuilder {
* .uriRelativity(<js>"PATH_INFO"</js>)
* .build();
* </p>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriRelativity}
@@ -606,10 +606,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: URI resolution.
- *
+ *
* <p>
* Defines the resolution level for URIs when serializing URI/URL objects.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriResolution}
@@ -626,7 +626,7 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: URI resolution.
- *
+ *
* <p>
* Same as {@link #uriResolution(UriResolution)} but allows you to pass in a string.
*
@@ -637,7 +637,7 @@ public class SerializerBuilder extends BeanContextBuilder {
* .uriResolution(<js>"ROOT_RELATIVE"</js>)
* .build();
* </p>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriResolution}
@@ -654,10 +654,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Use whitespace.
- *
+ *
* <p>
* If <jk>true</jk>, newlines and indentation and spaces are added to the output to improve readability.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_useWhitespace}
@@ -674,7 +674,7 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Use whitespace.
- *
+ *
* <p>
* Shortcut for calling <code>useWhitespace(<jk>true</jk>)</code>.
*
@@ -690,10 +690,10 @@ public class SerializerBuilder extends BeanContextBuilder {
/**
* Configuration property: Use whitespace.
- *
+ *
* <p>
* Shortcut for calling <code>useWhitespace(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_useWhitespace}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerGroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerGroup.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerGroup.java
index a32aaa2..0ec4a90 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerGroup.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerGroup.java
@@ -20,9 +20,10 @@ import org.apache.juneau.http.*;
/**
* Represents a group of {@link Serializer Serializers} that can be looked up by media type.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Provides the following features:
* <ul class='spaced-list'>
* <li>
@@ -32,19 +33,19 @@ import org.apache.juneau.http.*;
* <li>
* Clones existing groups and all serializers within the group in a single method call.
* </ul>
- *
+ *
* <h6 class='topic'>Match ordering</h6>
- *
+ *
* Serializers are matched against <code>Accept</code> strings in the order they exist in this group.
- *
+ *
* <p>
* Adding new entries will cause the entries to be prepended to the group.
* This allows for previous serializers to be overridden through subsequent calls.
- *
+ *
* <p>
* For example, calling <code>g.append(S1.<jk>class</jk>,S2.<jk>class</jk>).append(S3.<jk>class</jk>,S4.<jk>class</jk>)</code>
* will result in the order <code>S3, S4, S1, S2</code>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct a new serializer group</jc>
@@ -52,10 +53,10 @@ import org.apache.juneau.http.*;
* .append(JsonSerializer.<jk>class</jk>, XmlSerializer.<jk>class</jk>); <jc>// Add some serializers to it</jc>
* .ws().pojoSwaps(CalendarSwap.ISO8601DT.<jk>class</jk>) <jc>// Change settings for all serializers in the group.</jc>
* .build();
- *
+ *
* <jc>// Find the appropriate serializer by Accept type</jc>
* WriterSerializer s = g.getWriterSerializer(<js>"text/foo, text/json;q=0.8, text/*;q:0.6, *\/*;q=0.0"</js>);
- *
+ *
* <jc>// Serialize a bean to JSON text </jc>
* AddressBook addressBook = <jk>new</jk> AddressBook(); <jc>// Bean to serialize.</jc>
* String json = s.serialize(addressBook);
@@ -95,7 +96,7 @@ public final class SerializerGroup extends BeanContext {
/**
* Constructor.
- *
+ *
* @param ps
* The modifiable properties that were used to initialize the serializers.
* A snapshot of these will be made so that we can clone and modify this group.
@@ -124,13 +125,13 @@ public final class SerializerGroup extends BeanContext {
/**
* Searches the group for a serializer that can handle the specified <code>Accept</code> value.
- *
+ *
* <p>
* The <code>accept</code> value complies with the syntax described in RFC2616, Section 14.1, as described below:
* <p class='bcode'>
* Accept = "Accept" ":"
* #( media-range [ accept-params ] )
- *
+ *
* media-range = ( "*\/*"
* | ( type "/" "*" )
* | ( type "/" subtype )
@@ -138,10 +139,10 @@ public final class SerializerGroup extends BeanContext {
* accept-params = ";" "q" "=" qvalue *( accept-extension )
* accept-extension = ";" token [ "=" ( token | quoted-string ) ]
* </p>
- *
+ *
* <p>
* The returned object includes both the serializer and media type that matched.
- *
+ *
* @param acceptHeader The HTTP <l>Accept</l> header string.
* @return The serializer and media type that matched the accept header, or <jk>null</jk> if no match was made.
*/
@@ -162,7 +163,7 @@ public final class SerializerGroup extends BeanContext {
/**
* Same as {@link #getSerializerMatch(String)} but matches using a {@link MediaType} instance.
- *
+ *
* @param mediaType The HTTP media type.
* @return The serializer and media type that matched the media type, or <jk>null</jk> if no match was made.
*/
@@ -172,7 +173,7 @@ public final class SerializerGroup extends BeanContext {
/**
* Same as {@link #getSerializerMatch(String)} but returns just the matched serializer.
- *
+ *
* @param acceptHeader The HTTP <l>Accept</l> header string.
* @return The serializer that matched the accept header, or <jk>null</jk> if no match was made.
*/
@@ -183,7 +184,7 @@ public final class SerializerGroup extends BeanContext {
/**
* Same as {@link #getSerializerMatch(MediaType)} but returns just the matched serializer.
- *
+ *
* @param mediaType The HTTP media type.
* @return The serializer that matched the accept header, or <jk>null</jk> if no match was made.
*/
@@ -195,7 +196,7 @@ public final class SerializerGroup extends BeanContext {
/**
* Same as {@link #getSerializer(String)}, but casts it to a {@link WriterSerializer}.
- *
+ *
* @param acceptHeader The HTTP <l>Accept</l> header string.
* @return The serializer that matched the accept header, or <jk>null</jk> if no match was made.
*/
@@ -205,7 +206,7 @@ public final class SerializerGroup extends BeanContext {
/**
* Same as {@link #getSerializer(MediaType)}, but casts it to a {@link WriterSerializer}.
- *
+ *
* @param mediaType The HTTP media type.
* @return The serializer that matched the accept header, or <jk>null</jk> if no match was made.
*/
@@ -215,7 +216,7 @@ public final class SerializerGroup extends BeanContext {
/**
* Same as {@link #getSerializer(String)}, but casts it to an {@link OutputStreamSerializer}.
- *
+ *
* @param acceptHeader The HTTP <l>Accept</l> header string.
* @return The serializer that matched the accept header, or <jk>null</jk> if no match was made.
*/
@@ -225,7 +226,7 @@ public final class SerializerGroup extends BeanContext {
/**
* Same as {@link #getSerializer(MediaType)}, but casts it to a {@link OutputStreamSerializer}.
- *
+ *
* @param mediaType The HTTP media type.
* @return The serializer that matched the accept header, or <jk>null</jk> if no match was made.
*/
@@ -235,10 +236,10 @@ public final class SerializerGroup extends BeanContext {
/**
* Returns the media types that all serializers in this group can handle.
- *
+ *
* <p>
* Entries are ordered in the same order as the serializers in the group.
- *
+ *
* @return An unmodifiable list of media types.
*/
public List<MediaType> getSupportedMediaTypes() {
@@ -247,7 +248,7 @@ public final class SerializerGroup extends BeanContext {
/**
* Returns a copy of the serializers in this group.
- *
+ *
* @return An unmodifiable list of serializers in this group.
*/
public List<Serializer> getSerializers() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerGroupBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerGroupBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerGroupBuilder.java
index 3a96302..525743d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerGroupBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerGroupBuilder.java
@@ -37,7 +37,7 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Clone an existing serializer group builder.
- *
+ *
* @param copyFrom The serializer group that we're copying settings and serializers from.
*/
public SerializerGroupBuilder(SerializerGroup copyFrom) {
@@ -48,7 +48,7 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Registers the specified serializers with this group.
- *
+ *
* @param s The serializers to append to this group.
* @return This object (for method chaining).
*/
@@ -63,7 +63,7 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
* <p>
* When passing in pre-instantiated serializers to this group, applying properties and transforms to the group
* do not affect them.
- *
+ *
* @param s The serializers to append to this group.
* @return This object (for method chaining).
*/
@@ -77,7 +77,7 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
*
* <p>
* Objects can either be instances of serializers or serializer classes.
- *
+ *
* @param s The serializers to append to this group.
* @return This object (for method chaining).
*/
@@ -91,7 +91,7 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
*
* <p>
* Objects can either be instances of serializers or serializer classes.
- *
+ *
* @param s The serializers to append to this group.
* @return This object (for method chaining).
*/
@@ -102,10 +102,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Creates a new {@link SerializerGroup} object using a snapshot of the settings defined in this builder.
- *
+ *
* <p>
* This method can be called multiple times to produce multiple serializer groups.
- *
+ *
* @return A new {@link SerializerGroup} object.
*/
@Override /* ContextBuilder */
@@ -132,11 +132,11 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Abridged output.
- *
+ *
* <p>
* When enabled, it is assumed that the parser knows the exact Java POJO type being parsed, and therefore top-level
* type information that might normally be included to determine the data type will not be serialized.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_abridged}
@@ -153,10 +153,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Abridged output.
- *
+ *
* <p>
* Shortcut for calling <code>abridged(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_abridged}
@@ -170,11 +170,11 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
* through reflection.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_addBeanTypeProperties}
@@ -191,15 +191,15 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Automatically detect POJO recursions.
- *
+ *
* <p>
* Specifies that recursions should be checked for during serialization.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Checking for recursion can cause a small performance penalty.
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_detectRecursions}
@@ -216,10 +216,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Automatically detect POJO recursions.
- *
+ *
* <p>
* Shortcut for calling <code>detectRecursions(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_detectRecursions}
@@ -233,16 +233,16 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Ignore recursion errors.
- *
+ *
* <p>
* 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.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Checking for recursion can cause a small performance penalty.
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_ignoreRecursions}
@@ -259,10 +259,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Ignore recursion errors.
- *
+ *
* <p>
* Shortcut for calling <code>ignoreRecursions(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_ignoreRecursions}
@@ -276,10 +276,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Initial depth.
- *
+ *
* <p>
* The initial indentation level at the root.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_initialDepth}
@@ -296,10 +296,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Serializer listener.
- *
+ *
* <p>
* Class used to listen for errors and warnings that occur during serialization.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_listener}
@@ -315,12 +315,12 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Max serialization depth.
- *
+ *
* <p>
* Abort serialization if specified depth is reached in the POJO tree.
* <br>If this depth is exceeded, an exception is thrown.
* <br>This prevents stack overflows from occurring when trying to serialize models with recursive references.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_maxDepth}
@@ -337,10 +337,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Maximum indentation.
- *
+ *
* <p>
* Specifies the maximum indentation level in the serialized document.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_maxIndent}
@@ -357,10 +357,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Quote character.
- *
+ *
* <p>
* This is the character used for quoting attributes and values.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_quoteChar}
@@ -377,7 +377,7 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Sort arrays and collections alphabetically.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortCollections}
@@ -397,7 +397,7 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>sortCollections(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortCollections}
@@ -411,7 +411,7 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Sort maps alphabetically.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortMaps}
@@ -431,7 +431,7 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>sortMaps(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortMaps}
@@ -448,7 +448,7 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>quoteChar(<js>'\''</js>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_quoteChar}
@@ -462,10 +462,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty lists and arrays.
- *
+ *
* <p>
* If <jk>true</jk>, empty list values will not be serialized to the output.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyCollections}
@@ -482,10 +482,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty lists and arrays.
- *
+ *
* <p>
* Shortcut for calling <code>trimEmptyCollections(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyCollections}
@@ -499,10 +499,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty maps.
- *
+ *
* <p>
* If <jk>true</jk>, empty map values will not be serialized to the output.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyMaps}
@@ -519,10 +519,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty maps.
- *
+ *
* <p>
* Shortcut for calling <code>trimEmptyMaps(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyMaps}
@@ -536,10 +536,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim null bean property values.
- *
+ *
* <p>
* If <jk>true</jk>, null bean values will not be serialized to the output.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimNullProperties}
@@ -556,10 +556,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim strings.
- *
+ *
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being serialized.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimStrings}
@@ -576,10 +576,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim strings.
- *
+ *
* <p>
* Shortcut for calling <code>trimStrings(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimStrings}
@@ -593,10 +593,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: URI context bean.
- *
+ *
* <p>
* Bean used for resolution of URIs to absolute or root-relative form.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriContext}
@@ -611,10 +611,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: URI relativity.
- *
+ *
* <p>
* Defines what relative URIs are relative to when serializing URI/URL objects.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriRelativity}
@@ -631,10 +631,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: URI resolution.
- *
+ *
* <p>
* Defines the resolution level for URIs when serializing URI/URL objects.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriResolution}
@@ -651,10 +651,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Use whitespace.
- *
+ *
* <p>
* If <jk>true</jk>, newlines and indentation and spaces are added to the output to improve readability.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_useWhitespace}
@@ -671,7 +671,7 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Use whitespace.
- *
+ *
* <p>
* Shortcut for calling <code>useWhitespace(<jk>true</jk>)</code>.
*
@@ -687,10 +687,10 @@ public class SerializerGroupBuilder extends BeanContextBuilder {
/**
* Configuration property: Use whitespace.
- *
+ *
* <p>
* Shortcut for calling <code>useWhitespace(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_useWhitespace}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerListener.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerListener.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerListener.java
index 7b7f138..4d48eab 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerListener.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerListener.java
@@ -28,7 +28,7 @@ public class SerializerListener {
/**
* Called when an exception is thrown when trying to call a bean getter method.
- *
+ *
* @param session The serializer session.
* @param t The throwable that was thrown by the getter method.
* @param p The bean property we had an issue on.
@@ -40,7 +40,7 @@ public class SerializerListener {
/**
* Called when an error occurs during serialization but is ignored.
- *
+ *
* @param session The serializer session.
* @param t The throwable that was thrown by the getter method.
* @param msg The error message.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerMatch.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerMatch.java
index 19536eb..b12a98e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerMatch.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerMatch.java
@@ -29,7 +29,7 @@ public final class SerializerMatch {
/**
* Returns the media type of the serializers that matched the HTTP <code>Accept</code> header value.
- *
+ *
* @return The media type of the match.
*/
public MediaType getMediaType() {
@@ -38,7 +38,7 @@ public final class SerializerMatch {
/**
* Returns the serializer that matched the HTTP <code>Accept</code> header value.
- *
+ *
* @return The serializer of the match.
*/
public Serializer getSerializer() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerPipe.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerPipe.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerPipe.java
index 87f5d48..a7e12ce 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerPipe.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerPipe.java
@@ -21,7 +21,7 @@ import org.apache.juneau.internal.*;
/**
* A wrapper around an object that a serializer sends its output to.
- *
+ *
* <p>
* For character-based serializers, the output object can be any of the following:
* <ul>
@@ -30,7 +30,7 @@ import org.apache.juneau.internal.*;
* <li>{@link File} - Output will be written as system-default encoded stream.
* <li>{@link StringBuilder}
* </ul>
- *
+ *
* <p>
* For stream-based serializers, the output object can be any of the following:
* <ul>
@@ -48,7 +48,7 @@ public final class SerializerPipe implements Closeable {
/**
* Constructor.
- *
+ *
* @param output The object to pipe the serializer output to.
*/
SerializerPipe(Object output) {
@@ -58,10 +58,10 @@ public final class SerializerPipe implements Closeable {
/**
* Wraps the specified output object inside an output stream.
- *
+ *
* <p>
* Subclasses can override this method to implement their own specialized output streams.
- *
+ *
* <p>
* This method can be used if the output object is any of the following class types:
* <ul>
@@ -92,10 +92,10 @@ public final class SerializerPipe implements Closeable {
/**
* Wraps the specified output object inside a writer.
- *
+ *
* <p>
* Subclasses can override this method to implement their own specialized writers.
- *
+ *
* <p>
* This method can be used if the output object is any of the following class types:
* <ul>
@@ -103,7 +103,7 @@ public final class SerializerPipe implements Closeable {
* <li>{@link OutputStream} - Output will be written as UTF-8 encoded stream.
* <li>{@link File} - Output will be written as system-default encoded stream.
* </ul>
- *
+ *
* @return
* The output object wrapped in a writer.
* Calling {@link Writer#close()} on the returned object simply flushes the response and does not close
@@ -130,11 +130,11 @@ public final class SerializerPipe implements Closeable {
/**
* Overwrites the writer in this pipe.
- *
+ *
* <p>
* Used when wrapping the writer returned by {@link #getWriter()} so that the wrapped writer will be flushed
* and closed when {@link #close()} is called.
- *
+ *
* @param writer The wrapped writer.
*/
public void setWriter(Writer writer) {
@@ -143,11 +143,11 @@ public final class SerializerPipe implements Closeable {
/**
* Overwrites the output stream in this pipe.
- *
+ *
* <p>
* Used when wrapping the stream returned by {@link #getOutputStream()} so that the wrapped stream will be flushed
* when {@link #close()} is called.
- *
+ *
* @param outputStream The wrapped stream.
*/
public void setOutputStream(OutputStream outputStream) {
@@ -156,7 +156,7 @@ public final class SerializerPipe implements Closeable {
/**
* Returns the raw output object passed into this session.
- *
+ *
* @return The raw output object passed into this session.
*/
public Object getRawOutput() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerSession.java
index b55768b..49e4ecd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerSession.java
@@ -29,7 +29,7 @@ import org.apache.juneau.transform.*;
/**
* Serializer session that lives for the duration of a single use of {@link Serializer}.
- *
+ *
* <p>
* Used by serializers for the following purposes:
* <ul class='spaced-list'>
@@ -42,7 +42,7 @@ import org.apache.juneau.transform.*;
* <li>
* Allowing serializer properties to be overridden on method calls.
* </ul>
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -81,7 +81,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -169,7 +169,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Wraps the specified input object into a {@link ParserPipe} object so that it can be easily converted into
* a stream or reader.
- *
+ *
* @param output
* The output location.
* <br>For character-based serializers, this can be any of the following types:
@@ -198,10 +198,10 @@ public abstract class SerializerSession extends BeanSession {
/**
* Serializes a POJO to the specified output stream or writer.
- *
+ *
* <p>
* This method should NOT close the context object.
- *
+ *
* @param pipe Where to send the output from the serializer.
* @param o The object to serialize.
* @throws Exception If thrown from underlying stream, or if the input contains a syntax error or is malformed.
@@ -211,7 +211,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Shortcut method for serializing objects directly to either a <code>String</code> or <code><jk>byte</jk>[]</code>
* depending on the serializer type.
- *
+ *
* @param o The object to serialize.
* @return
* The serialized object.
@@ -223,7 +223,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns <jk>true</jk> if this serializer subclasses from {@link WriterSerializer}.
- *
+ *
* @return <jk>true</jk> if this serializer subclasses from {@link WriterSerializer}.
*/
public abstract boolean isWriterSerializer();
@@ -235,7 +235,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Serialize the specified object using the specified session.
- *
+ *
* @param out Where to send the output from the serializer.
* @param o The object to serialize.
* @throws SerializeException If a problem occurred trying to convert the output.
@@ -257,7 +257,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Sets the current bean property being serialized for proper error messages.
- *
+ *
* @param currentProperty The current property being serialized.
*/
protected final void setCurrentProperty(BeanPropertyMeta currentProperty) {
@@ -266,7 +266,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Sets the current class being serialized for proper error messages.
- *
+ *
* @param currentClass The current class being serialized.
*/
protected final void setCurrentClass(ClassMeta<?> currentClass) {
@@ -275,11 +275,11 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the Java method that invoked this serializer.
- *
+ *
* <p>
* When using the REST API, this is the Java method invoked by the REST call.
* Can be used to access annotations defined on the method or class.
- *
+ *
* @return The Java method that invoked this serializer.
*/
protected final Method getJavaMethod() {
@@ -288,7 +288,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the URI resolver.
- *
+ *
* @return The URI resolver.
*/
protected final UriResolver getUriResolver() {
@@ -297,7 +297,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_maxDepth} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_maxDepth} setting value for this session.
*/
protected final int getMaxDepth() {
@@ -306,7 +306,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_initialDepth} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_initialDepth} setting value for this session.
*/
protected final int getInitialDepth() {
@@ -315,7 +315,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_detectRecursions} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_detectRecursions} setting value for this session.
*/
protected final boolean isDetectRecursions() {
@@ -324,7 +324,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_ignoreRecursions} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_ignoreRecursions} setting value for this session.
*/
protected final boolean isIgnoreRecursions() {
@@ -333,7 +333,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_useWhitespace} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_useWhitespace} setting value for this session.
*/
protected boolean isUseWhitespace() {
@@ -342,7 +342,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_maxIndent} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_maxIndent} setting value for this session.
*/
protected int getMaxIndent() {
@@ -351,7 +351,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_addBeanTypeProperties} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_addBeanTypeProperties} setting value for this session.
*/
protected boolean isAddBeanTypeProperties() {
@@ -360,7 +360,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_quoteChar} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_quoteChar} setting value for this session.
*/
protected char getQuoteChar() {
@@ -369,7 +369,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_trimNullProperties} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_trimNullProperties} setting value for this session.
*/
protected final boolean isTrimNulls() {
@@ -378,7 +378,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_trimEmptyCollections} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_trimEmptyCollections} setting value for this session.
*/
protected final boolean isTrimEmptyCollections() {
@@ -387,7 +387,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_trimEmptyMaps} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_trimEmptyMaps} setting value for this session.
*/
protected final boolean isTrimEmptyMaps() {
@@ -396,7 +396,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_trimStrings} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_trimStrings} setting value for this session.
*/
protected boolean isTrimStrings() {
@@ -405,7 +405,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_sortCollections} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_sortCollections} setting value for this session.
*/
protected final boolean isSortCollections() {
@@ -414,7 +414,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the {@link Serializer#SERIALIZER_sortMaps} setting value for this session.
- *
+ *
* @return The {@link Serializer#SERIALIZER_sortMaps} setting value for this session.
*/
protected final boolean isSortMaps() {
@@ -423,7 +423,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Push the specified object onto the stack.
- *
+ *
* @param attrName The attribute name.
* @param o The current object being serialized.
* @param eType The expected class type.
@@ -458,7 +458,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns <jk>true</jk> if {@link Serializer#SERIALIZER_detectRecursions} is enabled, and the specified
* object is already higher up in the serialization chain.
- *
+ *
* @param attrName The bean property attribute name, or some other identifier.
* @param o The object to check for recursion.
* @param cm The metadata on the object class.
@@ -494,7 +494,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Specialized warning when an exception is thrown while executing a bean getter.
- *
+ *
* @param p The bean map entry representing the bean property.
* @param t The throwable that the bean getter threw.
*/
@@ -508,7 +508,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Logs a warning message.
- *
+ *
* @param t The throwable that was thrown (if there was one).
* @param msg The warning message.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -521,7 +521,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Trims the specified string if {@link SerializerSession#isTrimStrings()} returns <jk>true</jk>.
- *
+ *
* @param o The input string to trim.
* @return The trimmed string, or <jk>null</jk> if the input was <jk>null</jk>.
*/
@@ -536,7 +536,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Generalize the specified object if a POJO swap is associated with it.
- *
+ *
* @param o The object to generalize.
* @param type The type of object.
* @return The generalized object, or <jk>null</jk> if the object is <jk>null</jk>.
@@ -560,7 +560,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns <jk>true</jk> if the specified value should not be serialized.
- *
+ *
* @param cm The class type of the object being serialized.
* @param attrName The bean attribute name, or <jk>null</jk> if this isn't a bean attribute.
* @param value The object being serialized.
@@ -604,7 +604,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Sorts the specified map if {@link SerializerSession#isSortMaps()} returns <jk>true</jk>.
- *
+ *
* @param m The map being sorted.
* @return A new sorted {@link TreeMap}.
*/
@@ -616,7 +616,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Sorts the specified collection if {@link SerializerSession#isSortCollections()} returns <jk>true</jk>.
- *
+ *
* @param c The collection being sorted.
* @return A new sorted {@link TreeSet}.
*/
@@ -628,15 +628,15 @@ public abstract class SerializerSession extends BeanSession {
/**
* Converts the contents of the specified object array to a list.
- *
+ *
* <p>
* Works on both object and primitive arrays.
- *
+ *
* <p>
* In the case of multi-dimensional arrays, the outgoing list will contain elements of type n-1 dimension.
* i.e. if {@code type} is <code><jk>int</jk>[][]</code> then {@code list} will have entries of type
* <code><jk>int</jk>[]</code>.
- *
+ *
* @param type The type of array.
* @param array The array being converted.
* @return The array as a list.
@@ -655,7 +655,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Converts a String to an absolute URI based on the {@link UriContext} on this session.
- *
+ *
* @param uri
* The input URI.
* Can be any of the following:
@@ -686,10 +686,10 @@ public abstract class SerializerSession extends BeanSession {
/**
* Opposite of {@link #resolveUri(Object)}.
- *
+ *
* <p>
* Converts the URI to a value relative to the specified <code>relativeTo</code> parameter.
- *
+ *
* <p>
* Both parameters can be any of the following:
* <ul>
@@ -697,7 +697,7 @@ public abstract class SerializerSession extends BeanSession {
* <li>{@link java.net.URL}
* <li>{@link CharSequence}
* </ul>
- *
+ *
* <p>
* Both URIs can be any of the following forms:
* <ul>
@@ -713,7 +713,7 @@ public abstract class SerializerSession extends BeanSession {
* <li><js>"foo"</js> - Path-info-relative URI.
* <li><js>""</js> - Path-info URI.
* </ul>
- *
+ *
* @param relativeTo The URI to relativize against.
* @param uri The URI to relativize.
* @return The relativized URI.
@@ -731,7 +731,7 @@ public abstract class SerializerSession extends BeanSession {
* <li><code>Class</code> object is converted to a readable name. See {@link ClassUtils#getReadableClassName(Class)}.
* <li>Whitespace is trimmed if the trim-strings setting is enabled.
* </ul>
- *
+ *
* @param o The object to convert to a <code>String</code>.
* @return The object converted to a String, or <jk>null</jk> if the input was <jk>null</jk>.
*/
@@ -788,7 +788,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns information used to determine at what location in the parse a failure occurred.
- *
+ *
* @return A map, typically containing something like <code>{line:123,column:456,currentProperty:"foobar"}</code>
*/
protected final ObjectMap getLastLocation() {
@@ -804,7 +804,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Create a "_type" property that contains the dictionary name of the bean.
- *
+ *
* @param m The bean map to create a class property on.
* @param typeName The type name of the bean.
* @return A new bean property value.
@@ -816,7 +816,7 @@ public abstract class SerializerSession extends BeanSession {
/**
* Resolves the dictionary name for the actual type.
- *
+ *
* @param eType The expected type of the bean property.
* @param aType The actual type of the bean property.
* @param pMeta The current bean property being serialized.
@@ -867,12 +867,12 @@ public abstract class SerializerSession extends BeanSession {
/**
* Returns the parser-side expected type for the object.
- *
+ *
* <p>
* The return value depends on the {@link Serializer#SERIALIZER_abridged} setting.
* When enabled, the parser already knows the Java POJO type being parsed, so there is
* no reason to add <js>"_type"</js> attributes to the root-level object.
- *
+ *
* @param o The object to get the expected type on.
* @return The expected type.
*/
@@ -882,14 +882,14 @@ public abstract class SerializerSession extends BeanSession {
/**
* Optional method that specifies HTTP request headers for this serializer.
- *
+ *
* <p>
* For example, {@link SoapXmlSerializer} needs to set a <code>SOAPAction</code> header.
- *
+ *
* <p>
* This method is typically meaningless if the serializer is being used stand-alone (i.e. outside of a REST server
* or client).
- *
+ *
* @return
* The HTTP headers to set on HTTP requests.
* Never <jk>null</jk>.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerSessionArgs.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerSessionArgs.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerSessionArgs.java
index 3edf746..d78f25f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerSessionArgs.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerSessionArgs.java
@@ -20,7 +20,7 @@ import org.apache.juneau.http.*;
/**
* Runtime arguments common to all serializer sessions.
- *
+ *
* <p>
* This object specifies information such as session locale or URI context.
*/
@@ -36,7 +36,7 @@ public final class SerializerSessionArgs extends BeanSessionArgs {
/**
* Constructor.
- *
+ *
* @param properties
* Session-level properties.
* <br>These override context-level properties.
@@ -65,7 +65,7 @@ public final class SerializerSessionArgs extends BeanSessionArgs {
/**
* The java method that called this serializer, usually the method in a REST servlet.
- *
+ *
* @param javaMethod
* The java method that called this serializer, usually the method in a REST servlet.
* <br>Can be <jk>null</jk>.
@@ -78,7 +78,7 @@ public final class SerializerSessionArgs extends BeanSessionArgs {
/**
* The URI context.
- *
+ *
* @param uriContext
* The URI context.
* <br>Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerWriter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerWriter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerWriter.java
index 3cfef13..8697297 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerWriter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializerWriter.java
@@ -20,11 +20,11 @@ import org.apache.juneau.*;
/**
* Simple wrapper around a standard {@link Writer} with additional methods.
- *
+ *
* <p>
* Modeled after the Java ProcessBuilder class so that you can chain commands to reduce the need for string
* concatenation for performance reasons.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* writer.append(<js>"foo"</js>).nl().i(5).append(<js>"bar"</js>);
@@ -72,10 +72,10 @@ public class SerializerWriter extends Writer {
/**
* Performs a carriage return.
- *
+ *
* <p>
* Adds a newline and the specified number of tabs (if the {@code useWhitespace} setting is enabled) to the output.
- *
+ *
* @param depth The indentation.
* @throws IOException If a problem occurred trying to write to the writer.
* @return This object (for method chaining).
@@ -88,10 +88,10 @@ public class SerializerWriter extends Writer {
/**
* Performs a carriage return at the end of a line.
- *
+ *
* <p>
* Adds a newline and the specified number of tabs (if the {@code useWhitespace} setting is enabled) to the output.
- *
+ *
* @param depth The indentation.
* @throws IOException If a problem occurred trying to write to the writer.
* @return This object (for method chaining).
@@ -105,7 +105,7 @@ public class SerializerWriter extends Writer {
/**
* Writes an indent (if the {@code useWhitespace} setting is enabled), followed by text, followed by a newline
* (if the {@code useWhitespace} setting is enabled).
- *
+ *
* @param indent The number of tabs to indent.
* @param text The text to write.
* @throws IOException If a problem occurred trying to write to the writer.
@@ -117,7 +117,7 @@ public class SerializerWriter extends Writer {
/**
* Writes the specified text followed by a newline (if the {@code useWhitespace} setting is enabled).
- *
+ *
* @param text The text to write.
* @throws IOException If a problem occurred trying to write to the writer.
* @return This object.
@@ -128,7 +128,7 @@ public class SerializerWriter extends Writer {
/**
* Writes an indent (if the {@code useWhitespace} setting is enabled), followed by text.
- *
+ *
* @param indent The number of tabs to indent.
* @param text The text to write.
* @throws IOException If a problem occurred trying to write to the writer.
@@ -140,7 +140,7 @@ public class SerializerWriter extends Writer {
/**
* Writes an indent (if the {@code useWhitespace} setting is enabled), followed by text.
- *
+ *
* @param indent The number of tabs to indent.
* @param c The character to write.
* @throws IOException If a problem occurred trying to write to the writer.
@@ -153,7 +153,7 @@ public class SerializerWriter extends Writer {
/**
* Writes an indent (if the {@code useWhitespace} setting is enabled), followed by text, optionally followed by a
* newline (if the {@code useWhitespace} setting is enabled).
- *
+ *
* @param indent The number of tabs to indent.
* @param newline If <jk>true</jk>, then a newline is written.
* @param text The text to write.
@@ -180,16 +180,16 @@ public class SerializerWriter extends Writer {
/**
* Appends the specified object as a URI.
- *
+ *
* <p>
* Object is converted to a <code>String</code> using <code>toString()</code>, so this will work on {@link URL} or
* {@link URI} objects, or any other type that returns a URI via it's <code>toString()</code> method.
- *
+ *
* <p>
* The URI is resolved based on the {@link Serializer#SERIALIZER_uriRelativity} and
* {@link Serializer#SERIALIZER_uriResolution} settings and the {@link UriContext} that's part of the
* session.
- *
+ *
* @param uri The URI to serialize.
* @return This object (for method chaining).
* @throws IOException If a problem occurred trying to write to the writer.
@@ -201,7 +201,7 @@ public class SerializerWriter extends Writer {
/**
* Appends the specified characters to this writer.
- *
+ *
* @param characters The characters to append to this writer.
* @return This object (for method chaining).
* @throws IOException
@@ -214,7 +214,7 @@ public class SerializerWriter extends Writer {
/**
* Adds a whitespace character to the output if the {@code useWhitespace} setting is enabled.
- *
+ *
* @return This object (for method chaining).
* @throws IOException If a problem occurred trying to write to the writer.
*/
@@ -226,7 +226,7 @@ public class SerializerWriter extends Writer {
/**
* Adds the quote character specified by the {@code quoteChar} setting to the output.
- *
+ *
* @return This object (for method chaining).
* @throws IOException If a problem occurred trying to write to the writer.
*/
@@ -237,7 +237,7 @@ public class SerializerWriter extends Writer {
/**
* Writes an indent to the writer if the {@code useWhitespace} setting is enabled.
- *
+ *
* @param indent The number of tabs to indent.
* @throws IOException If a problem occurred trying to write to the writer.
* @return This object (for method chaining).
@@ -251,7 +251,7 @@ public class SerializerWriter extends Writer {
/**
* Writes an end-of-line indent to the writer if the {@code useWhitespace} setting is enabled.
- *
+ *
* @param indent The number of tabs to indent.
* @throws IOException If a problem occurred trying to write to the writer.
* @return This object (for method chaining).
@@ -265,7 +265,7 @@ public class SerializerWriter extends Writer {
/**
* Writes a newline to the writer if the {@code useWhitespace} setting is enabled.
- *
+ *
* @param indent The current indentation level.
* @throws IOException If a problem occurred trying to write to the writer.
* @return This object (for method chaining).
@@ -278,11 +278,11 @@ public class SerializerWriter extends Writer {
/**
* Writes a space if the boolean expression is <jk>true</jk> and {@code useWhitespace} is false.
- *
+ *
* <p>
* Intended for cases in XML where text should be separated by either a space or newline.
* This ensures the text is separated by a space if whitespace is disabled.
- *
+ *
* @param b The boolean flag.
* @return This object (for method chaining).
* @throws IOException If a problem occurred trying to write to the writer.
@@ -295,7 +295,7 @@ public class SerializerWriter extends Writer {
/**
* Writes a newline to the writer if the {@code useWhitespace} setting is enabled and the boolean flag is true.
- *
+ *
* @param b The boolean flag.
* @param indent The current indentation level.
* @return This object (for method chaining).
@@ -309,7 +309,7 @@ public class SerializerWriter extends Writer {
/**
* Writes the specified text to the writer.
- *
+ *
* @param text The text to write.
* @throws IOException If a problem occurred trying to write to the writer.
* @return This object (for method chaining).
@@ -321,7 +321,7 @@ public class SerializerWriter extends Writer {
/**
* Writes the specified text to the writer.
- *
+ *
* @param text The text to write.
* @throws IOException If a problem occurred trying to write to the writer.
* @return This object (for method chaining).
@@ -334,7 +334,7 @@ public class SerializerWriter extends Writer {
/**
* Writes the specified text to the writer if b is true.
- *
+ *
* @param b Boolean flag.
* @param text The text to write.
* @throws IOException If a problem occurred trying to write to the writer.
@@ -348,7 +348,7 @@ public class SerializerWriter extends Writer {
/**
* Writes the specified text to the writer if b is true.
- *
+ *
* @param b Boolean flag.
* @param c The text to write.
* @throws IOException If a problem occurred trying to write to the writer.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/WriterSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/WriterSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/WriterSerializer.java
index 4863b29..09ab6db 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/WriterSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/WriterSerializer.java
@@ -22,7 +22,7 @@ public abstract class WriterSerializer extends Serializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
@@ -65,7 +65,7 @@ public abstract class WriterSerializer extends Serializer {
/**
* Convenience method for serializing an object to a <code>String</code>.
- *
+ *
* @param o The object to serialize.
* @return The output serialized to a string.
* @throws SerializeException If a problem occurred trying to convert the output.
@@ -77,10 +77,10 @@ public abstract class WriterSerializer extends Serializer {
/**
* Identical to {@link #serialize(Object)} except throws a {@link RuntimeException} instead of a {@link SerializeException}.
- *
+ *
* <p>
* This is typically good enough for debugging purposes.
- *
+ *
* @param o The object to serialize.
* @return The serialized object.
*/
@@ -94,7 +94,7 @@ public abstract class WriterSerializer extends Serializer {
/**
* Wraps the specified object inside a {@link StringObject}.
- *
+ *
* @param o The object to wrap.
* @return The wrapped object.
*/
@@ -104,7 +104,7 @@ public abstract class WriterSerializer extends Serializer {
/**
* Convenience method for serializing an object and sending it to STDOUT.
- *
+ *
* @param o The object to serialize.
* @return This object (for method chaining).
*/
[14/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSession.java
index 2fa3b2b..485e709 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSession.java
@@ -26,7 +26,7 @@ import org.apache.juneau.utils.*;
/**
* Session object that lives for the duration of a single use of {@link Parser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -45,7 +45,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -93,7 +93,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Workhorse method. Subclasses are expected to implement this method.
- *
+ *
* @param pipe Where to get the input from.
* @param type
* The class type of the object to create.
@@ -108,7 +108,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Returns <jk>true</jk> if this parser subclasses from {@link ReaderParser}.
- *
+ *
* @return <jk>true</jk> if this parser subclasses from {@link ReaderParser}.
*/
public abstract boolean isReaderParser();
@@ -121,7 +121,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Wraps the specified input object into a {@link ParserPipe} object so that it can be easily converted into
* a stream or reader.
- *
+ *
* @param input
* The input.
* <br>For character-based parsers, this can be any of the following types:
@@ -152,7 +152,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Returns information used to determine at what location in the parse a failure occurred.
- *
+ *
* @return A map, typically containing something like <code>{line:123,column:456,currentProperty:"foobar"}</code>
*/
public final ObjectMap getLastLocation() {
@@ -166,11 +166,11 @@ public abstract class ParserSession extends BeanSession {
/**
* Returns the Java method that invoked this parser.
- *
+ *
* <p>
* When using the REST API, this is the Java method invoked by the REST call.
* Can be used to access annotations defined on the method or class.
- *
+ *
* @return The Java method that invoked this parser.
*/
protected final Method getJavaMethod() {
@@ -179,10 +179,10 @@ public abstract class ParserSession extends BeanSession {
/**
* Returns the outer object used for instantiating top-level non-static member classes.
- *
+ *
* <p>
* When using the REST API, this is the servlet object.
- *
+ *
* @return The outer object.
*/
protected final Object getOuter() {
@@ -191,7 +191,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Sets the current bean property being parsed for proper error messages.
- *
+ *
* @param currentProperty The current property being parsed.
*/
protected final void setCurrentProperty(BeanPropertyMeta currentProperty) {
@@ -200,7 +200,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Sets the current class being parsed for proper error messages.
- *
+ *
* @param currentClass The current class being parsed.
*/
protected final void setCurrentClass(ClassMeta<?> currentClass) {
@@ -209,7 +209,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Returns the {@link Parser#PARSER_trimStrings} setting value for this session.
- *
+ *
* @return The {@link Parser#PARSER_trimStrings} setting value for this session.
*/
protected final boolean isTrimStrings() {
@@ -218,7 +218,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Returns the {@link Parser#PARSER_strict} setting value for this session.
- *
+ *
* @return The {@link Parser#PARSER_strict} setting value for this session.
*/
protected final boolean isStrict() {
@@ -227,7 +227,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Trims the specified object if it's a <code>String</code> and {@link #isTrimStrings()} returns <jk>true</jk>.
- *
+ *
* @param o The object to trim.
* @return The trimmed string if it's a string.
*/
@@ -241,7 +241,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Trims the specified string if {@link ParserSession#isTrimStrings()} returns <jk>true</jk>.
- *
+ *
* @param s The input string to trim.
* @return The trimmed string, or <jk>null</jk> if the input was <jk>null</jk>.
*/
@@ -253,7 +253,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Converts the specified <code>ObjectMap</code> into a bean identified by the <js>"_type"</js> property in the map.
- *
+ *
* @param m The map to convert to a bean.
* @param pMeta The current bean property being parsed.
* @param eType The current expected type being parsed.
@@ -293,7 +293,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Give the specified dictionary name, resolve it to a class.
- *
+ *
* @param typeName The dictionary name to resolve.
* @param pMeta The bean property we're currently parsing.
* @param eType The expected type we're currently parsing.
@@ -323,7 +323,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Method that gets called when an unknown bean property name is encountered.
- *
+ *
* @param pipe The parser input.
* @param propertyName The unknown bean property name.
* @param beanMap The bean that doesn't have the expected property.
@@ -348,44 +348,44 @@ public abstract class ParserSession extends BeanSession {
/**
* Parses input 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>
* <p class='bcode'>
* ReaderParser p = JsonParser.<jsf>DEFAULT</jsf>;
- *
+ *
* <jc>// Parse into a linked-list of strings.</jc>
* List l = p.parse(json, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of beans.</jc>
* List l = p.parse(json, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of linked-lists of strings.</jc>
* List l = p.parse(json, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of string keys/values.</jc>
* Map m = p.parse(json, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map containing string keys and values of lists containing beans.</jc>
* Map m = p.parse(json, 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.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Use the {@link #parse(Object, Class)} method instead if you don't need a parameterized map/collection.
* </ul>
- *
+ *
* @param <T> The class type of the object to create.
* @param input
* The input.
@@ -431,30 +431,30 @@ public abstract class ParserSession extends BeanSession {
/**
* 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>;
- *
+ *
* <jc>// Parse into a string.</jc>
* String s = p.parse(json, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a bean.</jc>
* MyBean b = p.parse(json, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a bean array.</jc>
* MyBean[] ba = p.parse(json, MyBean[].<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of objects.</jc>
* List l = p.parse(json, LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of object keys/values.</jc>
* Map m = p.parse(json, TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* @param <T> The class type of the object being created.
* @param input
* The input.
@@ -473,10 +473,10 @@ public abstract class ParserSession extends BeanSession {
/**
* Same as {@link #parse(Object, Type, Type...)} except the type has already been converted into a {@link ClassMeta}
* object.
- *
+ *
* <p>
* This is mostly an internal method used by the framework.
- *
+ *
* @param <T> The class type of the object being created.
* @param input
* The input.
@@ -494,11 +494,11 @@ public abstract class ParserSession extends BeanSession {
/**
* Entry point for all parsing calls.
- *
+ *
* <p>
* Calls the {@link #doParse(ParserPipe, ClassMeta)} implementation class and catches/re-wraps any exceptions
* thrown.
- *
+ *
* @param pipe The parser input.
* @param type The class type of the object to create.
* @param <T> The class type of the object to create.
@@ -528,10 +528,10 @@ public abstract class ParserSession extends BeanSession {
/**
* Parses the contents of the specified reader and loads the results into the specified map.
- *
+ *
* <p>
* Reader must contain something that serializes to a map (such as text containing a JSON object).
- *
+ *
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
@@ -539,7 +539,7 @@ public abstract class ParserSession extends BeanSession {
* The various character-based constructors in {@link ObjectMap} (e.g.
* {@link ObjectMap#ObjectMap(CharSequence,Parser)}).
* </ul>
- *
+ *
* @param <K> The key class type.
* @param <V> The value class type.
* @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.
@@ -564,10 +564,10 @@ public abstract class ParserSession extends BeanSession {
/**
* Implementation method.
- *
+ *
* <p>
* Default implementation throws an {@link UnsupportedOperationException}.
- *
+ *
* @param pipe The parser input.
* @param m The map being loaded.
* @param keyType The class type of the keys, or <jk>null</jk> to default to <code>String.<jk>class</jk></code>.
@@ -581,7 +581,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Parses the contents of the specified reader and loads the results into the specified collection.
- *
+ *
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
@@ -589,7 +589,7 @@ public abstract class ParserSession extends BeanSession {
* The various character-based constructors in {@link ObjectList} (e.g.
* {@link ObjectList#ObjectList(CharSequence,Parser)}.
* </ul>
- *
+ *
* @param <E> The element class type.
* @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.
* @param c The collection being loaded.
@@ -619,10 +619,10 @@ public abstract class ParserSession extends BeanSession {
/**
* Implementation method.
- *
+ *
* <p>
* Default implementation throws an {@link UnsupportedOperationException}.
- *
+ *
* @param pipe The parser input.
* @param c The collection being loaded.
* @param elementType The class type of the elements, or <jk>null</jk> to default to whatever is being parsed.
@@ -636,18 +636,18 @@ public abstract class ParserSession extends BeanSession {
/**
* Parses the specified array input with each entry in the object defined by the {@code argTypes}
* argument.
- *
+ *
* <p>
* Used for converting arrays (e.g. <js>"[arg1,arg2,...]"</js>) into an {@code Object[]} that can be passed
* to the {@code Method.invoke(target, args)} method.
- *
+ *
* <p>
* Used in the following locations:
* <ul class='spaced-list'>
* <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.
* @param argTypes Specifies the type of objects to create for each entry in the array.
* @return An array of parsed objects.
@@ -674,7 +674,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Converts the specified string to the specified type.
- *
+ *
* @param outer
* The outer object if we're converting to an inner object that needs to be created within the context
* of an outer object.
@@ -720,7 +720,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Convenience method for calling the {@link ParentProperty @ParentProperty} method on the specified object if it
* exists.
- *
+ *
* @param cm The class type of the object.
* @param o The object.
* @param parent The parent to set.
@@ -734,7 +734,7 @@ public abstract class ParserSession extends BeanSession {
/**
* Convenience method for calling the {@link NameProperty @NameProperty} method on the specified object if it exists.
- *
+ *
* @param cm The class type of the object.
* @param o The object.
* @param name The name to set.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSessionArgs.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSessionArgs.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSessionArgs.java
index caa16b7..4c3200b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSessionArgs.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSessionArgs.java
@@ -33,7 +33,7 @@ public final class ParserSessionArgs extends BeanSessionArgs {
/**
* Constructor.
- *
+ *
* @param properties
* Session-level properties.
* <br>These override context-level properties.
@@ -62,7 +62,7 @@ public final class ParserSessionArgs extends BeanSessionArgs {
/**
* The java method that called this serializer, usually the method in a REST servlet.
- *
+ *
* @param javaMethod
* The java method that called this serializer, usually the method in a REST servlet.
* <br>Can be <jk>null</jk>.
@@ -75,7 +75,7 @@ public final class ParserSessionArgs extends BeanSessionArgs {
/**
* The outer object for instantiating top-level non-static inner classes.
- *
+ *
* @param outer
* The outer object for instantiating top-level non-static inner classes.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ReaderParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ReaderParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ReaderParser.java
index 693fc12..402fc7e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ReaderParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ReaderParser.java
@@ -16,9 +16,10 @@ import org.apache.juneau.*;
/**
* Subclass of {@link Parser} for characters-based parsers.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* This class is typically the parent class of all character-based parsers.
* It has 1 abstract method to implement...
* <ul>
@@ -29,7 +30,7 @@ public abstract class ReaderParser extends Parser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
* @param consumes The list of media types that this parser consumes (e.g. <js>"application/json"</js>, <js>"*​/json"</js>).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ReaderParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ReaderParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ReaderParserSession.java
index 088ea48..4dc3e0a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ReaderParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ReaderParserSession.java
@@ -14,7 +14,7 @@ package org.apache.juneau.parser;
/**
* Subclass of parser session objects for character-based parsers.
- *
+ *
* <p>
* This class is NOT thread safe. It is typically discarded after one-time use.
*/
@@ -22,7 +22,7 @@ public abstract class ReaderParserSession extends ParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The parser creating this session object.
* The parser contains all the configuration settings for this object.
@@ -35,7 +35,7 @@ public abstract class ReaderParserSession extends ParserSession {
/**
* Constructor for sessions that don't require context.
- *
+ *
* @param args
* Runtime session arguments.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParser.java
index c1156d0..efc4918 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParser.java
@@ -19,19 +19,20 @@ import org.apache.juneau.transform.*;
/**
* Parsers HTTP plain text request bodies into <a class="doclink" href="../../../../overview-summary.html#juneau-marshall.PojoCategories">Group 5</a>
* POJOs.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/plain</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/plain</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/plain</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/plain</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Essentially just converts plain text to POJOs via static <code>fromString()</code> or <code>valueOf()</code>, or
* through constructors that take a single string argument.
- *
+ *
* <p>
* Also parses objects using a transform if the object class has an {@link PojoSwap PojoSwap<?,String>} transform
* defined on it.
@@ -52,7 +53,7 @@ public class PlainTextParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public PlainTextParser(PropertyStore ps) {
@@ -61,7 +62,7 @@ public class PlainTextParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
* @param consumes The media types that this parser consumes.
* <p>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParserBuilder.java
index c49f8c9..d8b80ed 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParserBuilder.java
@@ -32,7 +32,7 @@ public class PlainTextParserBuilder extends ParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public PlainTextParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParserSession.java
index cc70042..277dda3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextParserSession.java
@@ -19,7 +19,7 @@ import org.apache.juneau.parser.*;
/**
* Session object that lives for the duration of a single use of {@link PlainTextParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java
index bf9c176..9a7fbe7 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializer.java
@@ -18,18 +18,19 @@ import org.apache.juneau.transform.*;
/**
* Serializes POJOs to plain text using just the <code>toString()</code> method on the serialized object.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/plain</code>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/plain</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/plain</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/plain</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Essentially converts POJOs to plain text using the <code>toString()</code> method.
- *
+ *
* <p>
* Also serializes objects using a transform if the object class has an {@link PojoSwap PojoSwap<?,String>}
* transform defined on it.
@@ -50,7 +51,7 @@ public class PlainTextSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
@@ -60,7 +61,7 @@ public class PlainTextSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerBuilder.java
index 002f891..29bf784 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerBuilder.java
@@ -32,7 +32,7 @@ public class PlainTextSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public PlainTextSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerSession.java
index 31b88a5..418770b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/plaintext/PlainTextSerializerSession.java
@@ -16,7 +16,7 @@ import org.apache.juneau.serializer.*;
/**
* Session object that lives for the duration of a single use of {@link PlainTextSerializer}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
@@ -25,7 +25,7 @@ public class PlainTextSerializerSession extends WriterSerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Body.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Body.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Body.java
index 1fd6673..85d992c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Body.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Body.java
@@ -22,17 +22,17 @@ 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)
* String myProxyMethod(<ja>@Body</ja> MyPojo pojo);
* }
* </p>
- *
+ *
* <p>
* The argument can be any of the following types:
* <ul class='spaced-list'>
@@ -48,26 +48,26 @@ import org.apache.juneau.serializer.*;
* <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}:
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)
* String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);
* }
- *
+ *
* <jk>public interface</jk> MyRequestBean {
* <ja>@Body</ja>
* MyPojo getMyPojo();
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/FormData.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/FormData.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/FormData.java
index 277e84c..bcf056b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/FormData.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/FormData.java
@@ -23,108 +23,108 @@ 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <jc>// Explicit names specified for form data parameters.</jc>
* <jc>// pojo will be converted to UON notation (unless plain-text parts enabled).</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod1"</js>)
* String myProxyMethod1(<ja>@FormData</ja>(<js>"foo"</js>)</ja> String foo,
* <ja>@FormData</ja>(<js>"bar"</js>)</ja> MyPojo pojo);
- *
+ *
* <jc>// Multiple values pulled from a NameValuePairs object.</jc>
* <jc>// Same as @FormData("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod2"</js>)
* String myProxyMethod2(<ja>@FormData</ja> NameValuePairs nameValuePairs);
- *
+ *
* <jc>// Multiple values pulled from a Map.</jc>
* <jc>// Same as @FormData("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod3"</js>)
* String myProxyMethod3(<ja>@FormData</ja> Map<String,Object> map);
- *
+ *
* <jc>// Multiple values pulled from a bean.</jc>
* <jc>// Same as @FormData("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod4"</js>)
* String myProxyMethod4(<ja>@FormData</ja> MyBean myBean);
- *
+ *
* <jc>// An entire form-data HTTP body as a String.</jc>
* <jc>// Same as @FormData("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod5"</js>)
* String myProxyMethod5(<ja>@FormData</ja> String string);
- *
+ *
* <jc>// An entire form-data HTTP body as a Reader.</jc>
* <jc>// Same as @FormData("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod6"</js>)
* String myProxyMethod6(<ja>@FormData</ja> Reader reader);
- *
+ *
* }
* </p>
- *
+ *
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
* {@link RequestBean @RequestBean}:
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)
* String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);
* }
- *
+ *
* <jk>public interface</jk> MyRequestBean {
- *
+ *
* <jc>// Name explicitly specified.</jc>
* <ja>@FormData</ja>(<js>"foo"</js>)
* String getX();
- *
+ *
* <jc>// Name inherited from bean property.</jc>
* <jc>// Same as @FormData("bar")</jc>
* <ja>@FormData</ja>
* String getBar();
- *
+ *
* <jc>// Name inherited from bean property.</jc>
* <jc>// Same as @FormData("baz")</jc>
* <ja>@FormData</ja>
* <ja>@BeanProperty</ja>(<js>"baz"</js>)
* String getY();
- *
+ *
* <jc>// Multiple values pulled from NameValuePairs object.</jc>
* <jc>// Same as @FormData("*")</jc>
* <ja>@FormData</ja>
* NameValuePairs getNameValuePairs();
- *
+ *
* <jc>// Multiple values pulled from Map.</jc>
* <jc>// Same as @FormData("*")</jc>
* <ja>@FormData</ja>
* Map<String,Object> getMap();
- *
+ *
* <jc>// Multiple values pulled from bean.</jc>
* <jc>// Same as @FormData("*")</jc>
* <ja>@FormData</ja>
* MyBean getMyBean();
- *
+ *
* <jc>// An entire form-data HTTP body as a Reader.</jc>
* <jc>// Same as @FormData("*")</jc>
* <ja>@FormData</ja>
* Reader getReader();
* }
* </p>
- *
+ *
* <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 class='bcode'>
* <ja>@FormData</ja>(name=<js>"foo"</js>)
- *
+ *
* <ja>@FormData</ja>(<js>"foo"</js>)
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -141,35 +141,35 @@ public @interface FormData {
/**
* The form post parameter name.
- *
+ *
* <p>
* Note that {@link #name()} and {@link #value()} are synonyms.
- *
+ *
* <p>
* The value should be either <js>"*"</js> to represent multiple name/value pairs, or a label that defines the
* form data parameter name.
- *
+ *
* <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,
* 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>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <jc>// Equivalent to @FormData("*")</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)
* String myProxyMethod1(<ja>@FormData</ja> Map<String,Object> formData);
* }
- *
+ *
* <jc>// When used on a request bean method</jc>
* <jk>public interface</jk> MyRequestBean {
- *
+ *
* <jc>// Equivalent to @FormData("*")</jc>
* <ja>@FormData</ja>
* Map<String,Object> getFoo();
@@ -178,11 +178,11 @@ public @interface FormData {
* </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 {
- *
+ *
* <jc>// Equivalent to @FormData("foo")</jc>
* <ja>@FormData</ja>
* String getFoo();
@@ -195,7 +195,7 @@ public @interface FormData {
/**
* A synonym for {@link #name()}.
- *
+ *
* <p>
* Allows you to use shortened notation if you're only specifying the name.
*/
@@ -203,7 +203,7 @@ public @interface FormData {
/**
* Skips this value if it's an empty string or empty collection/array.
- *
+ *
* <p>
* Note that <jk>null</jk> values are already ignored.
*/
@@ -211,11 +211,11 @@ public @interface FormData {
/**
* Specifies the {@link HttpPartSerializer} class used for serializing values to strings.
- *
+ *
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean @RequestBean} annotation,
* then on the client which by default is {@link UrlEncodingSerializer}.
- *
+ *
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java
index fb6c38d..1894361 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/FormDataIfNE.java
@@ -22,7 +22,7 @@ import org.apache.juneau.urlencoding.*;
/**
* Identical to {@link FormData @FormData} except skips values if they're null/blank.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -39,25 +39,25 @@ public @interface FormDataIfNE {
/**
* The form post parameter name.
- *
+ *
* @see FormData#name()
*/
String name() default "";
/**
* A synonym for {@link #name()}.
- *
+ *
* @see FormData#value()
*/
String value() default "";
/**
* Specifies the {@link HttpPartSerializer} class used for serializing values to strings.
- *
+ *
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean @RequestBean} annotation,
* then on the client which by default is {@link UrlEncodingSerializer}.
- *
+ *
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Header.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Header.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Header.java
index 8a45ca3..57eb65d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Header.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Header.java
@@ -23,92 +23,92 @@ 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <jc>// Explicit names specified for HTTP headers.</jc>
* <jc>// pojo will be converted to UON notation (unless plain-text parts enabled).</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod1"</js>)
* String myProxyMethod1(<ja>@Header</ja>(<js>"Foo"</js>)</ja> String foo,
* <ja>@Header</ja>(<js>"Bar"</js>)</ja> MyPojo pojo);
- *
+ *
* <jc>// Multiple values pulled from a NameValuePairs object.</jc>
* <jc>// Same as @Header("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod2"</js>)
* String myProxyMethod2(<ja>@Header</ja> NameValuePairs nameValuePairs);
- *
+ *
* <jc>// Multiple values pulled from a Map.</jc>
* <jc>// Same as @Header("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod3"</js>)
* String myProxyMethod3(<ja>@Header</ja> Map<String,Object> map);
- *
+ *
* <jc>// Multiple values pulled from a bean.</jc>
* <jc>// Same as @Header("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod4"</js>)
* String myProxyMethod4(<ja>@Header</ja> MyBean myBean);
* }
* </p>
- *
+ *
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
* {@link RequestBean @RequestBean}:
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)
* String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);
* }
- *
+ *
* <jk>public interface</jk> MyRequestBean {
- *
+ *
* <jc>// Name explicitly specified.</jc>
* <ja>@Header</ja>(<js>"Foo"</js>)
* String getX();
- *
+ *
* <jc>// Name inherited from bean property.</jc>
* <jc>// Same as @Header("bar")</jc>
* <ja>@Header</ja>
* String getBar();
- *
+ *
* <jc>// Name inherited from bean property.</jc>
* <jc>// Same as @Header("Baz")</jc>
* <ja>@Header</ja>
* <ja>@BeanProperty</ja>(<js>"Baz"</js>)
* String getY();
- *
+ *
* <jc>// Multiple values pulled from NameValuePairs object.</jc>
* <jc>// Same as @Header("*")</jc>
* <ja>@Header</ja>
* NameValuePairs getNameValuePairs();
- *
+ *
* <jc>// Multiple values pulled from Map.</jc>
* <jc>// Same as @Header("*")</jc>
* <ja>@Header</ja>
* Map<String,Object> getMap();
- *
+ *
* <jc>// Multiple values pulled from bean.</jc>
* <jc>// Same as @Header("*")</jc>
* <ja>@Header</ja>
* MyBean getBean();
* }
* </p>
- *
+ *
* <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:
* <p class='bcode'>
* <ja>@Header</ja>(name=<js>"Foo"</js>)
- *
+ *
* <ja>@Header</ja>(<js>"Foo"</js>)
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -125,35 +125,35 @@ public @interface Header {
/**
* The HTTP header name.
- *
+ *
* <p>
* A blank value (the default) indicates to reuse the bean property name when used on a request bean property.
- *
+ *
* <p>
* The value should be either <js>"*"</js> to represent multiple name/value pairs, or a label that defines the
* header name.
- *
+ *
* <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,
* 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>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <jc>// Equivalent to @Header("*")</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)
* String myProxyMethod1(<ja>@Header</ja> Map<String,Object> headers);
* }
- *
+ *
* <jc>// When used on a request bean method</jc>
* <jk>public interface</jk> MyRequestBean {
- *
+ *
* <jc>// Equivalent to @Header("*")</jc>
* <ja>@Header</ja>
* Map<String,Object> getFoo();
@@ -162,11 +162,11 @@ public @interface Header {
* </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 {
- *
+ *
* <jc>// Equivalent to @Header("Foo")</jc>
* <ja>@Header</ja>
* <ja>@BeanProperty</ja>(<js>"Foo"</js>)
@@ -180,7 +180,7 @@ public @interface Header {
/**
* A synonym for {@link #name()}.
- *
+ *
* <p>
* Allows you to use shortened notation if you're only specifying the name.
*/
@@ -188,7 +188,7 @@ public @interface Header {
/**
* Skips this value if it's an empty string or empty collection/array.
- *
+ *
* <p>
* Note that <jk>null</jk> values are already ignored.
*/
@@ -196,11 +196,11 @@ public @interface Header {
/**
* Specifies the {@link HttpPartSerializer} class used for serializing values to strings.
- *
+ *
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean @RequestBean} annotation,
* then on the client which by default is {@link UrlEncodingSerializer}.
- *
+ *
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java
index 7745266..cd6cab2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/HeaderIfNE.java
@@ -22,7 +22,7 @@ import org.apache.juneau.urlencoding.*;
/**
* Identical to {@link Header @Header} except skips values if they're null/blank.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -39,25 +39,25 @@ public @interface HeaderIfNE {
/**
* The HTTP header name.
- *
+ *
* @see Header#name()
*/
String name() default "";
/**
* A synonym for {@link #name()}.
- *
+ *
* @see Header#value()
*/
String value() default "";
/**
* Specifies the {@link HttpPartSerializer} class used for serializing values to strings.
- *
+ *
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean @RequestBean} annotation,
* then on the client which by default is {@link UrlEncodingSerializer}.
- *
+ *
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Path.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Path.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Path.java
index 4897780..05d0792 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Path.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Path.java
@@ -22,91 +22,91 @@ import org.apache.juneau.urlencoding.*;
/**
* Annotation applied to Java method arguments of interface proxies to denote that they are path variables on the request.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <jc>// Explicit names specified for path parameters.</jc>
* <jc>// pojo will be converted to UON notation (unless plain-text parts enabled).</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod1/{foo}/{bar}"</js>)
* String myProxyMethod1(<ja>@Path</ja>(<js>"foo"</js>)</ja> String foo, <ja>@Path</ja>(<js>"bar"</js>)</ja> MyPojo pojo);
- *
+ *
* <jc>// Multiple values pulled from a NameValuePairs object.</jc>
* <jc>// Same as @Path("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod2/{foo}/{bar}/{baz}"</js>)
* String myProxyMethod2(<ja>@Path</ja> NameValuePairs nameValuePairs);
- *
+ *
* <jc>// Multiple values pulled from a Map.</jc>
* <jc>// Same as @Path("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod3/{foo}/{bar}/{baz}"</js>)
* String myProxyMethod3(<ja>@Path</ja> Map<String,Object> map);
- *
+ *
* <jc>// Multiple values pulled from a bean.</jc>
* <jc>// Same as @Path("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod4/{foo}/{bar}/{baz}"</js>)
* String myProxyMethod4(<ja>@Path</ja> MyBean myBean);
* }
* </p>
- *
+ *
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
* {@link RequestBean @RequestBean}:
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod/{foo}/{bar}/{baz}"</js>)
* String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);
* }
- *
+ *
* <jk>public interface</jk> MyRequestBean {
- *
+ *
* <jc>// Name explicitly specified.</jc>
* <ja>@Path</ja>(<js>"foo"</js>)
* String getX();
- *
+ *
* <jc>// Name inherited from bean property.</jc>
* <jc>// Same as @Path("bar")</jc>
* <ja>@Path</ja>
* String getBar();
- *
+ *
* <jc>// Name inherited from bean property.</jc>
* <jc>// Same as @Path("baz")</jc>
* <ja>@Path</ja>
* <ja>@BeanProperty</ja>(<js>"baz"</js>)
* String getY();
- *
+ *
* <jc>// Multiple values pulled from NameValuePairs object.</jc>
* <jc>// Same as @Path("*")</jc>
* <ja>@Path</ja>
* NameValuePairs getNameValuePairs();
- *
+ *
* <jc>// Multiple values pulled from Map.</jc>
* <jc>// Same as @Path("*")</jc>
* <ja>@Path</ja>
* Map<String,Object> getMap();
- *
+ *
* <jc>// Multiple values pulled from bean.</jc>
* <jc>// Same as @Path("*")</jc>
* <ja>@Path</ja>
* MyBean getMyBean();
* }
* </p>
- *
+ *
* <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:
* <p class='bcode'>
* <ja>@Path</ja>(name=<js>"foo"</js>)
- *
+ *
* <ja>@Path</ja>(<js>"foo"</js>)
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -123,35 +123,35 @@ public @interface Path {
/**
* The path parameter name.
- *
+ *
* <p>
* Note that {@link #name()} and {@link #value()} are synonyms.
- *
+ *
* <p>
* The value should be either <js>"*"</js> to represent multiple name/value pairs, or a label that defines the
* path variable name.
- *
+ *
* <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,
* 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>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <jc>// Equivalent to @Path("*")</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod/{foo}/{bar}"</js>)
* String myProxyMethod1(<ja>@FormData</ja> Map<String,Object> pathVars);
* }
- *
+ *
* <jc>// When used on a request bean method</jc>
* <jk>public interface</jk> MyRequestBean {
- *
+ *
* <jc>// Equivalent to @Path("*")</jc>
* <ja>@Path</ja>
* Map<String,Object> getPathVars();
@@ -160,11 +160,11 @@ public @interface Path {
* </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 {
- *
+ *
* <jc>// Equivalent to @Path("foo")</jc>
* <ja>@Path</ja>
* String getFoo();
@@ -175,7 +175,7 @@ public @interface Path {
/**
* A synonym for {@link #name()}.
- *
+ *
* <p>
* Allows you to use shortened notation if you're only specifying the name.
*/
@@ -183,11 +183,11 @@ public @interface Path {
/**
* Specifies the {@link HttpPartSerializer} class used for serializing values to strings.
- *
+ *
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean @RequestBean} annotation,
* then on the client which by default is {@link UrlEncodingSerializer}.
- *
+ *
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Query.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Query.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Query.java
index b3d5beb..6aab794 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Query.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Query.java
@@ -23,107 +23,107 @@ import org.apache.juneau.urlencoding.*;
/**
* Annotation applied to Java method arguments of interface proxies to denote that they are QUERY parameters on the
* request.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <jc>// Explicit names specified for query parameters.</jc>
* <jc>// pojo will be converted to UON notation (unless plain-text parts enabled).</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod1"</js>)
* String myProxyMethod1(<ja>@Query</ja>(<js>"foo"</js>)</ja> String foo,
* <ja>@Query</ja>(<js>"bar"</js>)</ja> MyPojo pojo);
- *
+ *
* <jc>// Multiple values pulled from a NameValuePairs object.</jc>
* <jc>// Same as @Query("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod2"</js>)
* String myProxyMethod2(<ja>@Query</ja> NameValuePairs nameValuePairs);
- *
+ *
* <jc>// Multiple values pulled from a Map.</jc>
* <jc>// Same as @Query("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod3"</js>)
* String myProxyMethod3(<ja>@Query</ja> Map<String,Object> map);
- *
+ *
* <jc>// Multiple values pulled from a bean.</jc>
* <jc>// Same as @Query("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod4"</js>)
* String myProxyMethod4(<ja>@Query</ja> MyBean myBean);
- *
+ *
* <jc>// An entire query string as a String.</jc>
* <jc>// Same as @FQuery("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod5"</js>)
* String myProxyMethod5(<ja>@Query</ja> String string);
- *
+ *
* <jc>// An entire query string as a Reader.</jc>
* <jc>// Same as @Query("*").</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod6"</js>)
* String myProxyMethod6(<ja>@Query</ja> Reader reader);
* }
* </p>
- *
+ *
* <p>
* The annotation can also be applied to a bean property field or getter when the argument is annotated with
* {@link RequestBean @RequestBean}:
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)
* String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);
* }
- *
+ *
* <jk>public interface</jk> MyRequestBean {
- *
+ *
* <jc>// Name explicitly specified.</jc>
* <ja>@Query</ja>(<js>"foo"</js>)
* String getX();
- *
+ *
* <jc>// Name inherited from bean property.</jc>
* <jc>// Same as @Query("bar")</jc>
* <ja>@Query</ja>
* String getBar();
- *
+ *
* <jc>// Name inherited from bean property.</jc>
* <jc>// Same as @Query("baz")</jc>
* <ja>@Query</ja>
* <ja>@BeanProperty</ja>(<js>"baz"</js>)
* String getY();
- *
+ *
* <jc>// Multiple values pulled from NameValuePairs object.</jc>
* <jc>// Same as @Query("*")</jc>
* <ja>@Query</ja>
* NameValuePairs getNameValuePairs();
- *
+ *
* <jc>// Multiple values pulled from Map.</jc>
* <jc>// Same as @Query("*")</jc>
* <ja>@Query</ja>
* Map<String,Object> getMap();
- *
+ *
* <jc>// Multiple values pulled from bean.</jc>
* <jc>// Same as @Query("*")</jc>
* <ja>@Query</ja>
* MyBean getMyBean();
- *
+ *
* <jc>// An entire query string as a Reader.</jc>
* <jc>// Same as @Query("*")</jc>
* <ja>@Query</ja>
* Reader getReader();
* }
* </p>
- *
+ *
* <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 class='bcode'>
* <ja>@Query</ja>(name=<js>"foo"</js>)
- *
+ *
* <ja>@Query</ja>(<js>"foo"</js>)
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -140,35 +140,35 @@ public @interface Query {
/**
* The query parameter name.
- *
+ *
* <p>
* Note that {@link #name()} and {@link #value()} are synonyms.
- *
+ *
* <p>
* The value should be either <js>"*"</js> to represent multiple name/value pairs, or a label that defines the
* query parameter name.
- *
+ *
* <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,
* 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>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <jc>// Equivalent to @Query("*")</jc>
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)
* String myProxyMethod1(<ja>@Query</ja> Map<String,Object> formData);
* }
- *
+ *
* <jc>// When used on a request bean method</jc>
* <jk>public interface</jk> MyRequestBean {
- *
+ *
* <jc>// Equivalent to @Query("*")</jc>
* <ja>@Query</ja>
* Map<String,Object> getFoo();
@@ -177,11 +177,11 @@ public @interface Query {
* </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 {
- *
+ *
* <jc>// Equivalent to @Query("foo")</jc>
* <ja>@Query</ja>
* String getFoo();
@@ -194,7 +194,7 @@ public @interface Query {
/**
* A synonym for {@link #name()}.
- *
+ *
* <p>
* Allows you to use shortened notation if you're only specifying the name.
*/
@@ -202,7 +202,7 @@ public @interface Query {
/**
* Skips this value if it's an empty string or empty collection/array.
- *
+ *
* <p>
* Note that <jk>null</jk> values are already ignored.
*/
@@ -210,11 +210,11 @@ public @interface Query {
/**
* Specifies the {@link HttpPartSerializer} class used for serializing values to strings.
- *
+ *
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean @RequestBean} annotation,
* then on the client which by default is {@link UrlEncodingSerializer}.
- *
+ *
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java
index 01eeade..49b022e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/QueryIfNE.java
@@ -22,7 +22,7 @@ import org.apache.juneau.urlencoding.*;
/**
* Identical to {@link Query @Query} except skips values if they're null/blank.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -39,25 +39,25 @@ public @interface QueryIfNE {
/**
* The query parameter name.
- *
+ *
* @see Query#name()
*/
String name() default "";
/**
* A synonym for {@link #name()}.
- *
+ *
* @see Query#value()
*/
String value() default "";
/**
* Specifies the {@link HttpPartSerializer} class used for serializing values to strings.
- *
+ *
* <p>
* The default value defaults to the using the part serializer defined on the {@link RequestBean @RequestBean} annotation,
* then on the client which by default is {@link UrlEncodingSerializer}.
- *
+ *
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java
index dc6f6f5..cfa1af9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethod.java
@@ -20,7 +20,7 @@ import java.lang.annotation.*;
/**
* Annotation applied to Java methods on interface proxy classes.
- *
+ *
* <p>
* The return type on the Java method can be any of the following:
* <ul>
@@ -33,7 +33,7 @@ import java.lang.annotation.*;
* <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>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -50,7 +50,7 @@ public @interface RemoteMethod {
/**
* The path to the REST service for this Java method relative to the parent proxy interface URL.
- *
+ *
* <p>
* The default value is the Java method name (e.g. <js>"http://localhost/root-url/org.foo.MyInterface/myMethod"</js>)
* if {@link Remoteable#methodPaths() @Remoteable.methodPaths()} is <js>"NAME"</js>, or the Java method signature
@@ -61,14 +61,14 @@ public @interface RemoteMethod {
/**
* Defines the HTTP method to use for REST calls.
- *
+ *
* <p>
* Possible values:
* <ul>
* <li><jsf>POST</jsf> (default) - Parameters are serialized using the serializer registered with the RestClient.
* <li><jsf>GET</jsf> - Parameters are serialized using the UrlEncodingSerializer registered with the RestClient.
* </ul>
- *
+ *
* <p>
* The default value is <js>"POST"</js>.
*/
@@ -76,7 +76,7 @@ public @interface RemoteMethod {
/**
* The value the remoteable method returns.
- *
+ *
* <p>
* Possible values:
* <ul>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java
index b117b3a..4fb3903 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteMethodArg.java
@@ -19,7 +19,7 @@ import org.apache.juneau.urlencoding.*;
/**
* Represents the metadata about an annotated argument of a method on a remote proxy interface.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -44,7 +44,7 @@ public class RemoteMethodArg {
/**
* Constructor.
- *
+ *
* @param name The argument name pulled from name().
* @param name2 The argument name pulled from value().
* @param index The zero-based index of the argument on the Java method.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Remoteable.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Remoteable.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Remoteable.java
index e423ccc..e314ece 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Remoteable.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/Remoteable.java
@@ -19,7 +19,7 @@ import java.lang.annotation.*;
/**
* Identifies a remote proxy interface against a REST interface.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -38,11 +38,11 @@ public @interface Remoteable {
/**
* The absolute or relative path of the REST service.
- *
+ *
* <p>
* When a relative path is specified, it's relative to the root-url defined on the <code>RestClient</code> used
* to instantiate the interface.
- *
+ *
* <p>
* When no path is specified, the path is assumed to be the class name (e.g.
* <js>"http://localhost/root-url/org.foo.MyInterface"</js>)
@@ -51,7 +51,7 @@ public @interface Remoteable {
/**
* Identifies which methods on the interface should be exposed through the proxy.
- *
+ *
* <p>
* The options are:
* <ul>
@@ -66,7 +66,7 @@ public @interface Remoteable {
/**
* Defines the methodology to use for the path names of the methods when not explicitly defined via
* {@link RemoteMethod#path() @RemoteMethod.path()}.
- *
+ *
* <p>
* The options are:
* <ul>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java
index a97e418..c9c7b6e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMeta.java
@@ -21,11 +21,11 @@ import java.util.*;
/**
* Contains the meta-data about a remoteable interface.
- *
+ *
* <p>
* Captures the information in {@link Remoteable @Remoteable} and {@link RemoteMethod @RemoteMethod} annotations for
* caching and reuse.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -40,7 +40,7 @@ public class RemoteableMeta {
/**
* Constructor.
- *
+ *
* @param c The interface class annotated with a {@link Remoteable @Remoteable} annotation (optional).
* @param restUrl The absolute URL of the remote REST interface that implements this proxy interface.
*/
@@ -65,7 +65,7 @@ public class RemoteableMeta {
/**
* Returns the metadata about the specified method on this interface proxy.
- *
+ *
* @param m The method to look up.
* @return Metadata about the method, or <jk>null</jk> if no metadata was found.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMetadataException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMetadataException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMetadataException.java
index 384ef4f..117de01 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMetadataException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMetadataException.java
@@ -26,7 +26,7 @@ public class RemoteableMetadataException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param m The interface method that has an invalid definition.
* @param message The {@link MessageFormat}-style message.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -37,7 +37,7 @@ public class RemoteableMetadataException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param c The interface class that has an invalid definition.
* @param message The {@link MessageFormat}-style message.
* @param args Optional {@link MessageFormat}-style arguments.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java
index 5dd1949..d882f31 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RemoteableMethodMeta.java
@@ -21,10 +21,10 @@ import java.util.*;
/**
* Contains the meta-data about a Java method on a remoteable interface.
- *
+ *
* <p>
* Captures the information in {@link RemoteMethod @RemoteMethod} annotations for caching and reuse.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -44,7 +44,7 @@ public class RemoteableMethodMeta {
/**
* Constructor.
- *
+ *
* @param restUrl The absolute URL of the REST interface backing the interface proxy.
* @param m The Java method.
*/
@@ -149,7 +149,7 @@ public class RemoteableMethodMeta {
/**
* Returns the value of the {@link RemoteMethod#httpMethod() @RemoteMethod.httpMethod()} annotation on this Java method.
- *
+ *
* @return The value of the annotation, never <jk>null</jk>.
*/
public String getHttpMethod() {
@@ -158,7 +158,7 @@ public class RemoteableMethodMeta {
/**
* Returns the absolute URL of the REST interface invoked by this Java method.
- *
+ *
* @return The absolute URL of the REST interface, never <jk>null</jk>.
*/
public String getUrl() {
@@ -167,7 +167,7 @@ public class RemoteableMethodMeta {
/**
* Returns the {@link Path @Path} annotated arguments on this Java method.
- *
+ *
* @return A map of {@link Path#value() @Path.value()} names to zero-indexed argument indices.
*/
public RemoteMethodArg[] getPathArgs() {
@@ -176,7 +176,7 @@ public class RemoteableMethodMeta {
/**
* Returns the {@link Query @Query} annotated arguments on this Java method.
- *
+ *
* @return A map of {@link Query#value() @Query.value()} names to zero-indexed argument indices.
*/
public RemoteMethodArg[] getQueryArgs() {
@@ -185,7 +185,7 @@ public class RemoteableMethodMeta {
/**
* Returns the {@link FormData @FormData} annotated arguments on this Java method.
- *
+ *
* @return A map of {@link FormData#value() @FormData.value()} names to zero-indexed argument indices.
*/
public RemoteMethodArg[] getFormDataArgs() {
@@ -194,7 +194,7 @@ public class RemoteableMethodMeta {
/**
* Returns the {@link Header @Header} annotated arguments on this Java method.
- *
+ *
* @return A map of {@link Header#value() @Header.value()} names to zero-indexed argument indices.
*/
public RemoteMethodArg[] getHeaderArgs() {
@@ -203,7 +203,7 @@ public class RemoteableMethodMeta {
/**
* Returns the {@link RequestBean @RequestBean} annotated arguments on this Java method.
- *
+ *
* @return A list of zero-indexed argument indices.
*/
public RemoteMethodArg[] getRequestBeanArgs() {
@@ -212,7 +212,7 @@ public class RemoteableMethodMeta {
/**
* Returns the remaining non-annotated arguments on this Java method.
- *
+ *
* @return A list of zero-indexed argument indices.
*/
public Integer[] getOtherArgs() {
@@ -221,7 +221,7 @@ public class RemoteableMethodMeta {
/**
* Returns the argument annotated with {@link Body @Body}.
- *
+ *
* @return A index of the argument with the {@link Body @Body} annotation, or <jk>null</jk> if no argument exists.
*/
public Integer getBodyArg() {
@@ -230,7 +230,7 @@ public class RemoteableMethodMeta {
/**
* Returns whether the method returns the HTTP response body or status code.
- *
+ *
* @return Whether the method returns the HTTP response body or status code.
*/
public ReturnValue getReturns() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RequestBean.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RequestBean.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RequestBean.java
index b080bd2..0ff5905 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RequestBean.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/remoteable/RequestBean.java
@@ -22,65 +22,65 @@ import org.apache.juneau.urlencoding.*;
/**
* Annotation applied to Java method arguments of interface proxies to denote a bean with remoteable annotations.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)
* <jk>public interface</jk> MyProxy {
- *
+ *
* <ja>@RemoteMethod</ja>(path=<js>"/mymethod/{p1}/{p2}"</js>)
* String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);
* }
- *
+ *
* <jk>public interface</jk> MyRequestBean {
- *
+ *
* <ja>@Path</ja>
* String getP1();
- *
+ *
* <ja>@Path</ja>(<js>"p2"</js>)
* String getX();
- *
+ *
* <ja>@Query</ja>
* String getQ1();
- *
+ *
* <ja>@Query</ja>
* <ja>@BeanProperty</ja>(name=<js>"q2"</js>)
* String getQuery2();
- *
+ *
* <ja>@QueryIfNE</ja>(<js>"q3"</js>)
* String getQuery3();
- *
+ *
* <ja>@QueryIfNE</ja>
* Map<String,Object> getExtraQueries();
- *
+ *
* <ja>@FormData</ja>
* String getF1();
- *
+ *
* <ja>@FormData</ja>
* <ja>@BeanProperty</ja>(name=<js>"f2"</js>)
* String getFormData2();
- *
+ *
* <ja>@FormDataIfNE</ja>(<js>"f3"</js>)
* String getFormData3();
- *
+ *
* <ja>@FormDataIfNE</ja>
* Map<String,Object> getExtraFormData();
- *
+ *
* <ja>@Header</ja>
* String getH1();
- *
+ *
* <ja>@Header</ja>
* <ja>@BeanProperty</ja>(name=<js>"H2"</js>)
* String getHeader2();
- *
+ *
* <ja>@HeaderIfNE</ja>(<js>"H3"</js>)
* String getHeader3();
- *
+ *
* <ja>@HeaderIfNE</ja>
* Map<String,Object> getExtraHeaders();
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -97,11 +97,11 @@ public @interface RequestBean {
/**
* Specifies the {@link HttpPartSerializer} class used for serializing values to strings.
- *
+ *
* <p>
* The default value defaults to the using the part serializer defined on the client which by default is
* {@link UrlEncodingSerializer}.
- *
+ *
* <p>
* This annotation is provided to allow values to be custom serialized.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/OutputStreamSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/OutputStreamSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/OutputStreamSerializer.java
index 8e9d648..88e8d94 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/OutputStreamSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/OutputStreamSerializer.java
@@ -23,7 +23,7 @@ public abstract class OutputStreamSerializer extends Serializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
@@ -66,7 +66,7 @@ public abstract class OutputStreamSerializer extends Serializer {
/**
* Convenience method for serializing an object to a <code><jk>byte</jk></code>.
- *
+ *
* @param o The object to serialize.
* @return The output serialized to a byte array.
* @throws SerializeException If a problem occurred trying to convert the output.
@@ -78,7 +78,7 @@ public abstract class OutputStreamSerializer extends Serializer {
/**
* Convenience method for serializing an object to a hex-encoded String.
- *
+ *
* @param o The object to serialize.
* @return The output serialized to a hex-encoded string.
* @throws SerializeException If a problem occurred trying to convert the output.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/OutputStreamSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/OutputStreamSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/OutputStreamSerializerSession.java
index 46804bc..b4b14f1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/OutputStreamSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/OutputStreamSerializerSession.java
@@ -16,9 +16,10 @@ import java.io.*;
/**
* Subclass of {@link SerializerSession} for stream-based serializers.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* This class is the parent class of all byte-based serializers.
* <br>It has 1 abstract method to implement...
* <ul>
@@ -29,7 +30,7 @@ public abstract class OutputStreamSerializerSession extends SerializerSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -45,7 +46,7 @@ public abstract class OutputStreamSerializerSession extends SerializerSession {
/**
* Constructor for sessions that don't require context.
- *
+ *
* @param args
* Runtime session arguments.
*/
@@ -60,7 +61,7 @@ public abstract class OutputStreamSerializerSession extends SerializerSession {
/**
* Convenience method for serializing an object to a <code><jk>byte</jk></code>.
- *
+ *
* @param o The object to serialize.
* @return The output serialized to a byte array.
* @throws SerializeException If a problem occurred trying to convert the output.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializeException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializeException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializeException.java
index 9666d49..fa2ddac 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializeException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/SerializeException.java
@@ -29,7 +29,7 @@ public final class SerializeException extends FormattedException {
/**
* Constructor.
- *
+ *
* @param session The serializer session to extract information from.
* @param message The exception message containing {@link MessageFormat}-style arguments.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -40,7 +40,7 @@ public final class SerializeException extends FormattedException {
/**
* Constructor.
- *
+ *
* @param message The exception message containing {@link MessageFormat}-style arguments.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -50,7 +50,7 @@ public final class SerializeException extends FormattedException {
/**
* Constructor.
- *
+ *
* @param session The serializer session to extract information from.
* @param causedBy The inner exception.
*/
@@ -60,7 +60,7 @@ public final class SerializeException extends FormattedException {
/**
* Constructor.
- *
+ *
* @param causedBy The inner exception.
*/
public SerializeException(Exception causedBy) {
@@ -80,7 +80,7 @@ public final class SerializeException extends FormattedException {
/**
* Returns the highest-level <code>ParseException</code> in the stack trace.
* Useful for JUnit testing of error conditions.
- *
+ *
* @return The root parse exception, or this exception if there isn't one.
*/
public SerializeException getRootCause() {
@@ -92,7 +92,7 @@ public final class SerializeException extends FormattedException {
/**
* Sets the inner cause for this exception.
- *
+ *
* @param cause The inner cause.
* @return This object (for method chaining).
*/
[07/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
index b0e91e5..dba8902 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCall.java
@@ -44,10 +44,10 @@ 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...
@@ -56,16 +56,15 @@ import org.apache.juneau.utils.*;
* 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.
- *
- * <h5 class='section'>Additional information:</h5>
+ *
+ *
+ * <h5 class='topic'>Documentation</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>
* </ul>
*/
@SuppressWarnings({ "unchecked" })
@@ -99,7 +98,7 @@ public final class RestCall extends BeanSession {
/**
* Constructs a REST call with the specified method name.
- *
+ *
* @param client The client that created this request.
* @param request The wrapped Apache HTTP client request object.
* @param uri The URI for this call.
@@ -121,7 +120,7 @@ public final class RestCall extends BeanSession {
/**
* Sets the URI for this call.
- *
+ *
* <p>
* Can be any of the following types:
* <ul>
@@ -130,10 +129,10 @@ public final class RestCall extends BeanSession {
* <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.
@@ -152,7 +151,7 @@ public final class RestCall extends BeanSession {
/**
* Sets the URI scheme.
- *
+ *
* @param scheme The new URI host.
* @return This object (for method chaining).
*/
@@ -163,7 +162,7 @@ public final class RestCall extends BeanSession {
/**
* Sets the URI host.
- *
+ *
* @param host The new URI host.
* @return This object (for method chaining).
*/
@@ -174,7 +173,7 @@ public final class RestCall extends BeanSession {
/**
* Sets the URI port.
- *
+ *
* @param port The new URI port.
* @return This object (for method chaining).
*/
@@ -185,7 +184,7 @@ public final class RestCall extends BeanSession {
/**
* Adds a query parameter to the URI query.
- *
+ *
* @param name
* The parameter name.
* Can be null/blank/* if the value is a {@link Map}, {@link String}, {@link NameValuePairs}, or bean.
@@ -232,7 +231,7 @@ public final class RestCall extends BeanSession {
/**
* Adds a query parameter to the URI query.
- *
+ *
* @param name The parameter name.
* @param value The parameter value converted to a string using UON notation.
* @return This object (for method chaining).
@@ -244,7 +243,7 @@ public final class RestCall extends BeanSession {
/**
* Adds query parameters to the URI query.
- *
+ *
* @param params The parameters. Values are converted to a string using UON notation.
* @return This object (for method chaining).
* @throws RestCallException
@@ -255,10 +254,10 @@ public final class RestCall extends BeanSession {
/**
* 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"
- *
+ *
* @param name The parameter name.
* @param value The parameter value converted to a string using UON notation.
* @return This object (for method chaining).
@@ -270,10 +269,10 @@ public final class RestCall extends BeanSession {
/**
* Adds query parameters to the URI for any parameters that aren't null/empty.
- *
+ *
* <p>
* NE = "not empty"
- *
+ *
* @param params The parameters. Values are converted to a string using UON notation.
* @return This object (for method chaining).
* @throws RestCallException
@@ -284,7 +283,7 @@ public final class RestCall extends BeanSession {
/**
* Sets a custom URI query.
- *
+ *
* @param query The new URI query string.
* @return This object (for method chaining).
*/
@@ -295,7 +294,7 @@ public final class RestCall extends BeanSession {
/**
* 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}, {@link NameValuePairs}, or bean.
@@ -342,7 +341,7 @@ public final class RestCall extends BeanSession {
/**
* 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}.
@@ -358,7 +357,7 @@ public final class RestCall extends BeanSession {
/**
* Adds form data pairs to this request to perform a URL-encoded form post.
- *
+ *
* @param nameValuePairs The name-value pairs of the request.
* @return This object (for method chaining).
* @throws RestCallException
@@ -369,7 +368,7 @@ public final class RestCall extends BeanSession {
/**
* Adds form data pairs to this request to perform a URL-encoded form post.
- *
+ *
* @param params The parameters. Values are converted to a string using UON notation.
* @return This object (for method chaining).
* @throws RestCallException If name was null/blank and value wasn't a {@link Map} or {@link NameValuePairs}.
@@ -380,10 +379,10 @@ public final class RestCall extends BeanSession {
/**
* 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"
- *
+ *
* @param name The parameter name.
* @param value The parameter value converted to a string using UON notation.
* @return This object (for method chaining).
@@ -395,10 +394,10 @@ public final class RestCall extends BeanSession {
/**
* Adds form data parameters to the request for any parameters that aren't null/empty.
- *
+ *
* <p>
* NE = "not empty"
- *
+ *
* @param params The parameters. Values are converted to a string using UON notation.
* @return This object (for method chaining).
* @throws RestCallException
@@ -409,7 +408,7 @@ public final class RestCall extends BeanSession {
/**
* Replaces a variable of the form <js>"{name}"</js> in the URL path with the specified value.
- *
+ *
* @param name The path variable name.
* @param value The replacement value.
* @param partSerializer
@@ -444,7 +443,7 @@ public final class RestCall extends BeanSession {
/**
* Replaces a variable of the form <js>"{name}"</js> in the URL path with the specified value.
- *
+ *
* @param name The path variable name.
* @param value The replacement value.
* @return This object (for method chaining).
@@ -456,7 +455,7 @@ public final class RestCall extends BeanSession {
/**
* Sets the URI user info.
- *
+ *
* @param userInfo The new URI user info.
* @return This object (for method chaining).
*/
@@ -467,7 +466,7 @@ public final class RestCall extends BeanSession {
/**
* Sets the URI user info.
- *
+ *
* @param username The new URI username.
* @param password The new URI password.
* @return This object (for method chaining).
@@ -479,7 +478,7 @@ public final class RestCall extends BeanSession {
/**
* 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:
@@ -508,10 +507,10 @@ public final class RestCall extends BeanSession {
/**
* Specifies the serializer to use on this call.
- *
+ *
* <p>
* Overrides the serializer specified on the {@link RestClient}.
- *
+ *
* @param serializer The serializer used to serialize POJOs to the body of the HTTP request.
* @return This object (for method chaining).
*/
@@ -522,10 +521,10 @@ public final class RestCall extends BeanSession {
/**
* Specifies the parser to use on this call.
- *
+ *
* <p>
* Overrides the parser specified on the {@link RestClient}.
- *
+ *
* @param parser The parser used to parse POJOs from the body of the HTTP response.
* @return This object (for method chaining).
*/
@@ -541,7 +540,7 @@ public final class RestCall extends BeanSession {
/**
* Sets a header on the request.
- *
+ *
* @param name
* The header name.
* The name can be null/empty if the value is a {@link Map}.
@@ -576,7 +575,7 @@ public final class RestCall extends BeanSession {
/**
* Sets a header on the request.
- *
+ *
* @param name
* The header name.
* The name can be null/empty if the value is a {@link Map}.
@@ -590,7 +589,7 @@ public final class RestCall extends BeanSession {
/**
* Sets headers on the request.
- *
+ *
* @param values The header values.
* @return This object (for method chaining).
* @throws RestCallException
@@ -601,10 +600,10 @@ public final class RestCall extends BeanSession {
/**
* 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}.
@@ -618,10 +617,10 @@ public final class RestCall extends BeanSession {
/**
* Sets headers on the request if the values are not null/empty.
- *
+ *
* <p>
* NE = "not empty"
- *
+ *
* @param values The header values.
* @return This object (for method chaining).
* @throws RestCallException
@@ -632,11 +631,11 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -647,10 +646,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -661,10 +660,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -675,10 +674,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -689,10 +688,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Authorization</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Authorization"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -703,10 +702,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -717,10 +716,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Connection</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Connection"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -731,10 +730,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -745,11 +744,11 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -760,10 +759,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Date</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Date"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -774,10 +773,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Expect</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Expect"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -788,10 +787,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Forwarded</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Forwarded"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -802,10 +801,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>From</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"From"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -816,10 +815,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Host</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Host"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -830,10 +829,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -844,10 +843,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -858,10 +857,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -872,10 +871,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -886,10 +885,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -900,10 +899,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -914,10 +913,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Origin</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Origin"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -928,10 +927,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Pragma</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Pragma"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -942,10 +941,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -956,10 +955,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Range</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Range"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -970,10 +969,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Referer</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Referer"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -984,10 +983,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>TE</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"TE"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -998,10 +997,10 @@ public final class RestCall extends BeanSession {
/**
* 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>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -1012,10 +1011,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Upgrade</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Upgrade"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -1026,10 +1025,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Via</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Via"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -1040,10 +1039,10 @@ public final class RestCall extends BeanSession {
/**
* Sets the value for the <code>Warning</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Warning"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
* @throws RestCallException
@@ -1054,7 +1053,7 @@ public final class RestCall extends BeanSession {
/**
* Sets the client version by setting the value for the <js>"X-Client-Version"</js> header.
- *
+ *
* @param version The version string (e.g. <js>"1.2.3"</js>)
* @return This object (for method chaining).
* @throws RestCallException
@@ -1065,7 +1064,7 @@ public final class RestCall extends BeanSession {
/**
* Make this call retryable if an error response (>=400) is received.
- *
+ *
* @param retries The number of retries to attempt.
* @param interval The time in milliseconds between attempts.
* @param retryOn
@@ -1091,13 +1090,13 @@ public final class RestCall extends BeanSession {
/**
* 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.
- *
+ *
* @param b Redirect flag.
* @return This object (for method chaining).
*/
@@ -1108,7 +1107,7 @@ public final class RestCall extends BeanSession {
/**
* Specify the number of redirects to follow before throwing an exception.
- *
+ *
* @param maxAttempts Allow a redirect to occur this number of times.
* @return This object (for method chaining).
*/
@@ -1119,7 +1118,7 @@ public final class RestCall extends BeanSession {
/**
* Add an interceptor for this call only.
- *
+ *
* @param interceptor The interceptor to add to this call.
* @return This object (for method chaining).
*/
@@ -1131,13 +1130,13 @@ public final class RestCall extends BeanSession {
/**
* 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.
- *
+ *
* @param w The writer to pipe the output to.
* @return This object (for method chaining).
*/
@@ -1147,10 +1146,10 @@ public final class RestCall extends BeanSession {
/**
* 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.
- *
+ *
* @param w The writer to write the output to.
* @param close Close the writer when {@link #close()} is called.
* @return This object (for method chaining).
@@ -1162,10 +1161,10 @@ public final class RestCall extends BeanSession {
/**
* 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.
- *
+ *
* @param id A string identifier that can be used to retrieve the writer using {@link #getWriter(String)}
* @param w The writer to write the output to.
* @param close Close the writer when {@link #close()} is called.
@@ -1178,7 +1177,7 @@ public final class RestCall extends BeanSession {
/**
* Retrieves a writer associated with an ID via {@link #pipeTo(String, Writer, boolean)}
- *
+ *
* @param id A string identifier that can be used to retrieve the writer using {@link #getWriter(String)}
* @return The writer, or <jk>null</jk> if no writer is associated with that ID.
*/
@@ -1188,7 +1187,7 @@ public final class RestCall extends BeanSession {
/**
* When output is piped to writers, flush the writers after every line of output.
- *
+ *
* @return This object (for method chaining).
*/
public RestCall byLines() {
@@ -1198,13 +1197,13 @@ public final class RestCall extends BeanSession {
/**
* 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.
- *
+ *
* @param os The output stream to pipe the output to.
* @return This object (for method chaining).
*/
@@ -1214,10 +1213,10 @@ public final class RestCall extends BeanSession {
/**
* 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.
- *
+ *
* @param os The output stream to write the output to.
* @param close Close the output stream when {@link #close()} is called.
* @return This object (for method chaining).
@@ -1229,10 +1228,10 @@ public final class RestCall extends BeanSession {
/**
* 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.
- *
+ *
* @param id A string identifier that can be used to retrieve the output stream using {@link #getOutputStream(String)}
* @param os The output stream to write the output to.
* @param close Close the output stream when {@link #close()} is called.
@@ -1245,7 +1244,7 @@ public final class RestCall extends BeanSession {
/**
* Retrieves an output stream associated with an ID via {@link #pipeTo(String, OutputStream, boolean)}
- *
+ *
* @param id A string identifier that can be used to retrieve the writer using {@link #getWriter(String)}
* @return The writer, or <jk>null</jk> if no writer is associated with that ID.
*/
@@ -1255,7 +1254,7 @@ public final class RestCall extends BeanSession {
/**
* Prevent {@link RestCallException RestCallExceptions} from being thrown when HTTP status 400+ is encountered.
- *
+ *
* @return This object (for method chaining).
*/
public RestCall ignoreErrors() {
@@ -1265,10 +1264,10 @@ public final class RestCall extends BeanSession {
/**
* 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.
- *
+ *
* @return This object (for method chaining).
*/
public RestCall captureResponse() {
@@ -1282,14 +1281,14 @@ public final class RestCall extends BeanSession {
/**
* 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()}.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Throw a RestCallException if FAILURE or ERROR is found in the output.</jc>
@@ -1297,7 +1296,7 @@ public final class RestCall extends BeanSession {
* .failurePattern(<js>"FAILURE|ERROR"</js>)
* .run();
* </p>
- *
+ *
* @param errorPattern A regular expression to look for in the response output.
* @return This object (for method chaining).
*/
@@ -1315,14 +1314,14 @@ public final class RestCall extends BeanSession {
/**
* 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()}.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Throw a RestCallException if SUCCESS is not found in the output.</jc>
@@ -1330,7 +1329,7 @@ public final class RestCall extends BeanSession {
* .successPattern(<js>"SUCCESS"</js>)
* .run();
* </p>
- *
+ *
* @param successPattern A regular expression to look for in the response output.
* @return This object (for method chaining).
*/
@@ -1348,14 +1347,14 @@ public final class RestCall extends BeanSession {
/**
* 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()}.
- *
+ *
* @param responsePattern The response pattern finder.
* @return This object (for method chaining).
*/
@@ -1374,10 +1373,10 @@ public final class RestCall extends BeanSession {
/**
* Set configuration settings on this request.
- *
+ *
* <p>
* Use {@link RequestConfig#custom()} to create configuration parameters for the request.
- *
+ *
* @param config The new configuration settings for this request.
* @return This object (for method chaining).
*/
@@ -1398,11 +1397,11 @@ public final class RestCall extends BeanSession {
/**
* 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>try</jk> {
@@ -1413,7 +1412,7 @@ public final class RestCall extends BeanSession {
* <jc>// Failed!</jc>
* }
* </p>
- *
+ *
* @return The HTTP status code.
* @throws RestCallException If an exception or non-200 response code occurred during the connection attempt.
*/
@@ -1440,7 +1439,7 @@ public final class RestCall extends BeanSession {
/**
* Same as {@link #run()} but allows you to run the call asynchronously.
- *
+ *
* @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
@@ -1459,15 +1458,15 @@ public final class RestCall extends BeanSession {
/**
* 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.
- *
+ *
* @return This object (for method chaining).
* @throws RestCallException If an exception or <code>400+</code> HTTP status code occurred during the connection attempt.
*/
@@ -1584,17 +1583,17 @@ public final class RestCall extends BeanSession {
/**
* 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>).
- *
+ *
* <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).
@@ -1631,15 +1630,15 @@ public final class RestCall extends BeanSession {
/**
* 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.
- *
+ *
* <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()}.
- *
+ *
* @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.
*/
@@ -1653,7 +1652,7 @@ public final class RestCall extends BeanSession {
/**
* Returns the parser specified on the client to use for parsing HTTP response bodies.
- *
+ *
* @return The parser.
* @throws RestCallException If no parser was defined on the client.
*/
@@ -1665,7 +1664,7 @@ public final class RestCall extends BeanSession {
/**
* Returns the serializer specified on the client to use for serializing HTTP request bodies.
- *
+ *
* @return The serializer.
* @throws RestCallException If no serializer was defined on the client.
*/
@@ -1677,7 +1676,7 @@ public final class RestCall extends BeanSession {
/**
* Returns the value of the <code>Content-Length</code> header.
- *
+ *
* @return The value of the <code>Content-Length</code> header, or <code>-1</code> if header is not present.
* @throws IOException
*/
@@ -1695,14 +1694,14 @@ public final class RestCall extends BeanSession {
/**
* 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>).
- *
+ *
* <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).
@@ -1802,7 +1801,7 @@ public final class RestCall extends BeanSession {
/**
* Same as {@link #getResponse(Class)} but allows you to run the call asynchronously.
- *
+ *
* @return The response as a string.
* @throws RestCallException If the executor service was not defined.
* @see
@@ -1822,28 +1821,28 @@ public final class RestCall extends BeanSession {
/**
* 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>
* String s = restClient.doGet(url).getResponse(String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a bean.</jc>
* MyBean b = restClient.doGet(url).getResponse(MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a bean array.</jc>
* MyBean[] ba = restClient.doGet(url).getResponse(MyBean[].<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of objects.</jc>
* List l = restClient.doGet(url).getResponse(LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of object keys/values.</jc>
* Map m = restClient.doGet(url).getResponse(TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>
@@ -1854,7 +1853,7 @@ public final class RestCall extends BeanSession {
* <li>{@link InputStream} - Returns access to the raw input stream of the response.
* </ul>
* </ul>
- *
+ *
* @param <T>
* The class type of the object being created.
* See {@link #getResponse(Type, Type...)} for details.
@@ -1873,7 +1872,7 @@ public final class RestCall extends BeanSession {
/**
* 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.
@@ -1897,37 +1896,37 @@ public final class RestCall extends BeanSession {
/**
* 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>
* <p class='bcode'>
* <jc>// Parse into a linked-list of strings.</jc>
* List l = restClient.doGet(url).getResponse(LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of beans.</jc>
* List l = restClient.doGet(url).getResponse(LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of linked-lists of strings.</jc>
* List l = restClient.doGet(url).getResponse(LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of string keys/values.</jc>
* Map m = restClient.doGet(url).getResponse(TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <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.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>
@@ -1940,7 +1939,7 @@ public final class RestCall extends BeanSession {
* <li>{@link InputStream} - Returns access to the raw input stream of the response.
* </ul>
* </ul>
- *
+ *
* @param <T> The class type of the object to create.
* @param type
* The object type to create.
@@ -1964,7 +1963,7 @@ public final class RestCall extends BeanSession {
/**
* 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.
@@ -1996,10 +1995,10 @@ public final class RestCall extends BeanSession {
/**
* 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 wrapped in a {@link PojoRest}.
* @throws IOException If a connection error occurred.
@@ -2012,10 +2011,10 @@ public final class RestCall extends BeanSession {
/**
* 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 wrapped in a {@link PojoRest}.
* @throws IOException If a connection error occurred.
* @throws ParseException
@@ -2057,7 +2056,7 @@ public final class RestCall extends BeanSession {
/**
* Returns access to the {@link HttpUriRequest} passed to {@link HttpClient#execute(HttpUriRequest)}.
- *
+ *
* @return The {@link HttpUriRequest} object.
*/
public HttpUriRequest getRequest() {
@@ -2066,10 +2065,10 @@ public final class RestCall extends BeanSession {
/**
* 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.
* @throws IOException
*/
@@ -2080,7 +2079,7 @@ public final class RestCall extends BeanSession {
/**
* Shortcut for calling <code>getRequest().setHeader(header)</code>
- *
+ *
* @param header The header to set on the request.
* @return This object (for method chaining).
*/
@@ -2098,7 +2097,7 @@ public final class RestCall extends BeanSession {
/**
* Cleans up this HTTP call.
- *
+ *
* @return This object (for method chaining).
* @throws RestCallException Can be thrown by one of the {@link RestCallInterceptor#onClose(RestCall)} calls.
*/
@@ -2114,7 +2113,7 @@ public final class RestCall extends BeanSession {
/**
* Adds a {@link RestCallLogger} to the list of interceptors on this class.
- *
+ *
* @param level The log level to log events at.
* @param log The logger.
* @return This object (for method chaining).
@@ -2126,7 +2125,7 @@ public final class RestCall extends BeanSession {
/**
* Sets <code>Debug: value</code> header on this request.
- *
+ *
* @return This object (for method chaining).
* @throws RestCallException
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallException.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallException.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallException.java
index e2c3050..e127f6f 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallException.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallException.java
@@ -43,7 +43,7 @@ public final class RestCallException extends IOException {
/**
* Constructor.
- *
+ *
* @param msg The exception message.
*/
public RestCallException(String msg) {
@@ -52,7 +52,7 @@ public final class RestCallException extends IOException {
/**
* Constructor.
- *
+ *
* @param e The inner cause of the exception.
*/
public RestCallException(Exception e) {
@@ -70,7 +70,7 @@ public final class RestCallException extends IOException {
/**
* Create an exception with a simple message and the status code and body of the specified response.
- *
+ *
* @param msg The exception message.
* @param response The HTTP response object.
* @throws ParseException
@@ -82,7 +82,7 @@ public final class RestCallException extends IOException {
/**
* Constructor.
- *
+ *
* @param responseCode The response code.
* @param responseMsg The response message.
* @param method The HTTP method (for message purposes).
@@ -98,7 +98,7 @@ 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()}.
@@ -117,7 +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>
@@ -125,14 +125,14 @@ 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.
- *
+ *
* @param cl The classloader to use to resolve the throwable class name.
* @throws Throwable If the throwable could be reconstructed.
*/
@@ -159,7 +159,7 @@ public final class RestCallException extends IOException {
/**
* Sets the HTTP response object that caused this exception.
- *
+ *
* @param httpResponse The HTTP response object.
* @return This object (for method chaining).
*/
@@ -170,7 +170,7 @@ 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.
@@ -181,7 +181,7 @@ public final class RestCallException extends IOException {
/**
* Returns the HTTP response status code.
- *
+ *
* @return The response status code. If a connection could not be made at all, returns <code>0</code>.
*/
public int getResponseCode() {
@@ -190,7 +190,7 @@ public final class RestCallException extends IOException {
/**
* Returns the HTTP response message body text.
- *
+ *
* @return The response message body text.
*/
public String getResponseMessage() {
@@ -199,7 +199,7 @@ public final class RestCallException extends IOException {
/**
* Returns the response status message as a plain string.
- *
+ *
* @return The response status message.
*/
public String getResponseStatusMessage() {
@@ -208,7 +208,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/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallInterceptor.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallInterceptor.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallInterceptor.java
index 54f36b2..b59bdec 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallInterceptor.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallInterceptor.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <p>
* Useful if you want to prevent {@link RestCallException RestCallExceptions} from being thrown on error conditions.
*/
@@ -25,14 +25,14 @@ public abstract class RestCallInterceptor {
/**
* Called when {@link RestCall} object is created.
- *
+ *
* @param restCall The restCall object invoking this method.
*/
public void onInit(RestCall restCall) {}
/**
* Called immediately after an HTTP response has been received.
- *
+ *
* @param statusCode The HTTP status code received.
* @param restCall The restCall object invoking this method.
* @param req The HTTP request object.
@@ -42,7 +42,7 @@ public abstract class RestCallInterceptor {
/**
* Called if retry is going to be attempted.
- *
+ *
* @param statusCode The HTTP status code received.
* @param restCall The restCall object invoking this method.
* @param req The HTTP request object.
@@ -53,7 +53,7 @@ public abstract class RestCallInterceptor {
/**
* Called when {@link RestCall#close()} is called.
- *
+ *
* @param restCall The restCall object invoking this method.
* @throws RestCallException
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java
index b625231..00b3a51 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallLogger.java
@@ -23,11 +23,11 @@ import org.apache.http.util.*;
/**
* Specialized interceptor 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.
- *
+ *
* <p>
* Use the {@link RestClientBuilder#logTo(Level, Logger)} and {@link RestCall#logTo(Level, Logger)} methods to create
* instances of this class.
@@ -46,7 +46,7 @@ public class RestCallLogger extends RestCallInterceptor {
/**
* Constructor.
- *
+ *
* @param level The log level to log messages at.
* @param log The logger to log to.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
index ec38f8f..5b9c611 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
@@ -39,8 +39,9 @@ import org.apache.juneau.urlencoding.*;
/**
* Utility class for interfacing with remote REST interfaces.
- *
- * <h6 class='topic'>Features</h6>
+ *
+ *
+ * <h5 class='topic'>Features</h5>
* <ul class='spaced-list'>
* <li>
* Convert POJOs directly to HTTP request message bodies using {@link Serializer} class.
@@ -53,12 +54,11 @@ import org.apache.juneau.urlencoding.*;
* <li>
* API for interacting with remoteable services.
* </ul>
- *
- * <h5 class='section'>Additional information:</h5>
+ *
+ *
+ * <h5 class='topic'>Documentation</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>.
* </ul>
*/
@SuppressWarnings("rawtypes")
@@ -72,7 +72,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Debug.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.debug.b"</js>
@@ -83,7 +83,7 @@ public class RestClient extends BeanContext {
* <li class='jm'>{@link RestClientBuilder#debug()}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Enable debug mode.
@@ -92,7 +92,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Executor service.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.executorService.o"</js>
@@ -107,7 +107,7 @@ public class RestClient extends BeanContext {
* <h5 class='section'>Description:</h5>
* <p>
* 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>
@@ -116,7 +116,7 @@ public class RestClient extends BeanContext {
* <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.
@@ -125,7 +125,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Shut down executor service on close.</b>
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.executorServiceShutdownOnClose.b"</js>
@@ -136,7 +136,7 @@ public class RestClient extends BeanContext {
* <li class='jm'>{@link RestClientBuilder#executorService(ExecutorService, boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Call {@link ExecutorService#shutdown()} when {@link RestClient#close()} is called.
@@ -145,7 +145,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Request headers.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.requestHeader.sms"</js>
@@ -157,7 +157,7 @@ public class RestClient extends BeanContext {
* <li class='jm'>{@link RestClientBuilder#header(String, Object)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Headers to add to every request.
@@ -166,7 +166,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Call interceptors.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.interceptors.lo"</js>
@@ -191,7 +191,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Keep HttpClient open.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.keepHttpClientOpen.b"</js>
@@ -202,7 +202,7 @@ public class RestClient extends BeanContext {
* <li class='jm'>{@link RestClientBuilder#keepHttpClientOpen(boolean)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Don't close this client when the {@link RestClient#close()} method is called.
@@ -211,7 +211,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Parser.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.parser.o"</js>
@@ -232,7 +232,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Part serializer.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.urlEncodingSerializer.o"</js>
@@ -253,7 +253,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Request query parameters.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.query.sms"</js>
@@ -264,7 +264,7 @@ public class RestClient extends BeanContext {
* <li class='jm'>{@link RestClientBuilder#query(String, Object)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Query parameters to add to every request.
@@ -273,7 +273,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Number of retries to attempt.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.retries.i"</js>
@@ -284,7 +284,7 @@ public class RestClient extends BeanContext {
* <li class='jm'>{@link RestClientBuilder#retryable(int, int, RetryOn)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* The number of retries to attempt when the connection cannot be made or a <code>>400</code> response is received.
@@ -293,7 +293,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: The time in milliseconds between retry attempts.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.retryInterval.i"</js>
@@ -304,7 +304,7 @@ public class RestClient extends BeanContext {
* <li class='jm'>{@link RestClientBuilder#retryable(int, int, RetryOn)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* The time in milliseconds between retry attempts.
@@ -314,7 +314,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Retry-on determination object.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.retryOn.o"</js>
@@ -325,7 +325,7 @@ public class RestClient extends BeanContext {
* <li class='jm'>{@link RestClientBuilder#retryable(int, int, RetryOn)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Object used for determining whether a retry should be attempted.
@@ -334,7 +334,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Root URI.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.rootUri.s"</js>
@@ -345,7 +345,7 @@ public class RestClient extends BeanContext {
* <li class='jm'>{@link RestClientBuilder#rootUrl(Object)}
* </ul>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* When set, relative URL strings passed in through the various rest call methods (e.g. {@link RestClient#doGet(Object)}
@@ -357,7 +357,7 @@ public class RestClient extends BeanContext {
/**
* Configuration property: Serializer.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"RestClient.serializer.o"</js>
@@ -428,10 +428,10 @@ public class RestClient extends BeanContext {
/**
* Instantiates a new {@link RestClientBuilder} object using the specified serializer and parser.
*
- *
+ *
* <p>
* Shortcut for calling <code>RestClient.<jsm>create</jsm>().serializer(s).parser(p);</code>
- *
+ *
* @param s The serializer class to use for output.
* @param p The parser class to use for input.
* @return A new {@link RestClientBuilder} object.
@@ -498,10 +498,10 @@ public class RestClient extends BeanContext {
/**
* 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
*/
public void close() throws IOException {
@@ -531,10 +531,10 @@ public class RestClient extends BeanContext {
/**
* Execute the specified request.
- *
+ *
* <p>
* Subclasses can override this method to provide specialized handling.
- *
+ *
* @param req The HTTP request.
* @return The HTTP response.
* @throws Exception
@@ -545,7 +545,7 @@ public class RestClient extends BeanContext {
/**
* 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}.
@@ -560,7 +560,7 @@ public class RestClient extends BeanContext {
/**
* 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}.
@@ -589,11 +589,11 @@ public class RestClient extends BeanContext {
/**
* 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}.
@@ -608,7 +608,7 @@ public class RestClient extends BeanContext {
/**
* 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}.
@@ -636,11 +636,11 @@ public class RestClient extends BeanContext {
/**
* 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.
- *
+ *
* @param url
* The URL of the remote REST resource.
* Can be any of the following: {@link String}, {@link URI}, {@link URL}.
@@ -655,7 +655,7 @@ public class RestClient extends BeanContext {
/**
* 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}.
@@ -670,7 +670,7 @@ public class RestClient extends BeanContext {
/**
* 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}.
@@ -686,7 +686,7 @@ public class RestClient extends BeanContext {
/**
* 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}.
@@ -705,11 +705,11 @@ public class RestClient extends BeanContext {
/**
* 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'>
@@ -722,7 +722,7 @@ public class RestClient extends BeanContext {
* </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
@@ -778,7 +778,7 @@ public class RestClient extends BeanContext {
/**
* Perform a generic REST call.
- *
+ *
* @param method The HTTP method.
* @param url
* The URL of the remote REST resource.
@@ -814,7 +814,7 @@ public class RestClient extends BeanContext {
/**
* 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.
@@ -875,7 +875,7 @@ public class RestClient extends BeanContext {
/**
* Create a new proxy interface against a REST interface.
- *
+ *
* <p>
* The URL to the REST interface is based on the following values:
* <ul>
@@ -883,7 +883,7 @@ public class RestClient extends BeanContext {
* <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>
@@ -891,36 +891,36 @@ public class RestClient extends BeanContext {
* <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'>
* <jk>package</jk> org.apache.foo;
- *
+ *
* <ja>@Remoteable</ja>(path=<js>"http://hostname/resturl/myinterface1"</js>)
* <jk>public interface</jk> MyInterface1 { ... }
- *
+ *
* <ja>@Remoteable</ja>(path=<js>"/myinterface2"</js>)
* <jk>public interface</jk> MyInterface2 { ... }
- *
+ *
* <jk>public interface</jk> MyInterface3 { ... }
- *
+ *
* <jc>// Resolves to "http://localhost/resturl/myinterface1"</jc>
* MyInterface1 i1 = RestClient
* .<jsm>create</jsm>()
* .build()
* .getRemoteableProxy(MyInterface1.<jk>class</jk>);
- *
+ *
* <jc>// Resolves to "http://hostname/resturl/myinterface2"</jc>
* MyInterface2 i2 = RestClient
* .<jsm>create</jsm>()
* .rootUrl(<js>"http://hostname/resturl"</js>)
* .build()
* .getRemoteableProxy(MyInterface2.<jk>class</jk>);
- *
+ *
* <jc>// Resolves to "http://hostname/resturl/org.apache.foo.MyInterface3"</jc>
* MyInterface3 i3 = RestClient
* .<jsm>create</jsm>()
@@ -928,7 +928,7 @@ public class RestClient extends BeanContext {
* .build()
* .getRemoteableProxy(MyInterface3.<jk>class</jk>);
* </p>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>
@@ -937,7 +937,7 @@ public class RestClient extends BeanContext {
* 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.
* @return The new proxy interface.
* @throws RemoteableMetadataException If the REST URI cannot be determined based on the information given.
@@ -948,7 +948,7 @@ public class RestClient extends BeanContext {
/**
* Same as {@link #getRemoteableProxy(Class)} except explicitly specifies the URL of the REST interface.
- *
+ *
* @param interfaceClass The interface to create a proxy for.
* @param restUrl The URL of the REST interface.
* @return The new proxy interface.
@@ -959,7 +959,7 @@ public class RestClient extends BeanContext {
/**
* Same as {@link #getRemoteableProxy(Class, Object)} but allows you to override the serializer and parser used.
- *
+ *
* @param interfaceClass The interface to create a proxy for.
* @param restUrl The URL of the REST interface.
* @param serializer The serializer used to serialize POJOs to the body of the HTTP request.
[25/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
index 89004f9..01055c1 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
@@ -21,10 +21,10 @@ import org.apache.juneau.annotation.*;
/**
* Describes a single operation parameter.
- *
+ *
* <p>
* A unique parameter is defined by a combination of a name and location.
- *
+ *
* <p>
* There are five possible parameter types.
* <ul>
@@ -62,7 +62,7 @@ import org.apache.juneau.annotation.*;
* </ul>
* </li>
* </ul>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -117,10 +117,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
- *
+ *
* <p>
* Required. The name of the parameter.
- *
+ *
* <p>
* Parameter names are case sensitive.
* If <code>in</code> is <js>"path"</js>, the <code>name</code> field MUST correspond to the associated path segment
@@ -129,7 +129,7 @@ public class ParameterInfo extends SwaggerElement {
* 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.
- *
+ *
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getName() {
@@ -138,10 +138,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
- *
+ *
* <p>
* Required. The name of the parameter.
- *
+ *
* <p>
* Parameter names are case sensitive.
* If <code>in</code> is <js>"path"</js>, the <code>name</code> field MUST correspond to the associated path segment
@@ -150,7 +150,7 @@ public class ParameterInfo extends SwaggerElement {
* 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.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -162,7 +162,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setName(String)}.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -172,13 +172,13 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>in</property>.
- *
+ *
* <p>
* Required. The location of the parameter.
- *
+ *
* <p>
* Possible values are <js>"query"</js>, <js>"header"</js>, <js>"path"</js>, <js>"formData"</js> or <js>"body"</js>.
- *
+ *
* @return The value of the <property>in</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getIn() {
@@ -187,13 +187,13 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>in</property>.
- *
+ *
* <p>
* Required. The location of the parameter.
- *
+ *
* <p>
* Possible values are <js>"query"</js>, <js>"header"</js>, <js>"path"</js>, <js>"formData"</js> or <js>"body"</js>.
- *
+ *
* @param in The new value for the <property>in</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -211,7 +211,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setIn(String)}.
- *
+ *
* @param in The new value for the <property>in</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -221,15 +221,15 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* A brief description of the parameter.
- *
+ *
* <p>
* 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.
- *
+ *
* @return
* The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -239,15 +239,15 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* A brief description of the parameter.
- *
+ *
* <p>
* 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.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -258,7 +258,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setDescription(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -268,15 +268,15 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>required</property>.
- *
+ *
* <p>
* Determines whether this parameter is mandatory.
- *
+ *
* <p>
* If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be
* <jk>true</jk>.
* Otherwise, the property MAY be included and its default value is <jk>false</jk>.
- *
+ *
* @return The value of the <property>required</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Boolean getRequired() {
@@ -285,15 +285,15 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>required</property>.
- *
+ *
* <p>
* Determines whether this parameter is mandatory.
- *
+ *
* <p>
* If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be
* <jk>true</jk>.
* Otherwise, the property MAY be included and its default value is <jk>false</jk>.
- *
+ *
* @param required The new value for the <property>required</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -304,7 +304,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setRequired(Boolean)}.
- *
+ *
* @param required The new value for the <property>required</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -314,10 +314,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>schema</property>.
- *
+ *
* <p>
* Required. The schema defining the type used for the body parameter.
- *
+ *
* @return The value of the <property>schema</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public SchemaInfo getSchema() {
@@ -326,10 +326,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>schema</property>.
- *
+ *
* <p>
* Required. The schema defining the type used for the body parameter.
- *
+ *
* @param schema The new value for the <property>schema</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -340,7 +340,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setSchema(SchemaInfo)}.
- *
+ *
* @param schema The new value for the <property>schema</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -350,10 +350,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* <p>
* Required. The type of the parameter.
- *
+ *
* <p>
* Since the parameter is not located at the request body, it is limited to simple types (that is, not an object).
* The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>,
@@ -361,7 +361,7 @@ public class ParameterInfo extends SwaggerElement {
* If type is <js>"file"</js>, the <code>consumes</code> MUST be either <js>"multipart/form-data"</js>,
* <js>"application/x-www-form-urlencoded"</js> or both and the parameter MUST be <code>in</code>
* <js>"formData"</js>.
- *
+ *
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getType() {
@@ -370,10 +370,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
- *
+ *
* <p>
* Required. The type of the parameter.
- *
+ *
* <p>
* Since the parameter is not located at the request body, it is limited to simple types (that is, not an object).
* The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>,
@@ -381,7 +381,7 @@ public class ParameterInfo extends SwaggerElement {
* If type is <js>"file"</js>, the <code>consumes</code> MUST be either <js>"multipart/form-data"</js>,
* <js>"application/x-www-form-urlencoded"</js> or both and the parameter MUST be <code>in</code>
* <js>"formData"</js>.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -397,7 +397,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setType(String)}.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -407,14 +407,14 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
- *
+ *
* <p>
* The extending format for the previously mentioned type.
- *
+ *
* <p>
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
- *
+ *
* @return The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getFormat() {
@@ -423,14 +423,14 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
- *
+ *
* <p>
* The extending format for the previously mentioned type.
- *
+ *
* <p>
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
- *
+ *
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -441,7 +441,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setFormat(String)}.
- *
+ *
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -451,15 +451,15 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>allowEmptyValue</property>.
- *
+ *
* <p>
* 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.
* Default value is <jk>false</jk>.
- *
+ *
* @return The value of the <property>allowEmptyValue</property> property on this bean, or <jk>null</jk> if it is
* not set.
*/
@@ -469,15 +469,15 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>allowEmptyValue</property>.
- *
+ *
* <p>
* 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.
* Default value is <jk>false</jk>.
- *
+ *
* @param allowEmptyValue The new value for the <property>allowEmptyValue</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -488,7 +488,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setAllowEmptyValue(Boolean)}.
- *
+ *
* @param allowEmptyValue The new value for the <property>allowEmptyValue</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -498,13 +498,13 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>items</property>.
- *
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
- *
+ *
* <p>
* Describes the type of items in the array.
- *
+ *
* @return The value of the <property>items</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Items getItems() {
@@ -513,13 +513,13 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>items</property>.
- *
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
- *
+ *
* <p>
* Describes the type of items in the array.
- *
+ *
* @param items The new value for the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -530,7 +530,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setItems(Items)}.
- *
+ *
* @param items The new value for the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -540,10 +540,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>collectionFormat</property>.
- *
+ *
* <p>
* Determines the format of the array if type array is used.
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -555,10 +555,10 @@ public class ParameterInfo extends SwaggerElement {
* instance <code>foo=bar&foo=baz</code>.
* This is valid only for parameters <code>in</code> <js>"query"</js> or <js>"formData"</js>.
* </ul>
- *
+ *
* <p>
* Default value is <code>csv</code>.
- *
+ *
* @return
* The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -569,10 +569,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>collectionFormat</property>.
- *
+ *
* <p>
* Determines the format of the array if type array is used.
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -584,10 +584,10 @@ public class ParameterInfo extends SwaggerElement {
* instance <code>foo=bar&foo=baz</code>.
* This is valid only for parameters <code>in</code> <js>"query"</js> or <js>"formData"</js>.
* </ul>
- *
+ *
* <p>
* Default value is <code>csv</code>.
- *
+ *
* @param collectionFormat The new value for the <property>collectionFormat</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -603,7 +603,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setCollectionFormat(String)}.
- *
+ *
* @param collectionFormat The new value for the <property>collectionFormat</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -613,7 +613,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>default</property>.
- *
+ *
* <p>
* Declares the value of the parameter that the server will use if none is provided, for example a <js>"count"</js>
* to control the number of results per page might default to 100 if not supplied by the client in the request.
@@ -621,7 +621,7 @@ public class ParameterInfo extends SwaggerElement {
* 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.
- *
+ *
* @return The value of the <property>default</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Object getDefault() {
@@ -630,7 +630,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>default</property>.
- *
+ *
* <p>
* Declares the value of the parameter that the server will use if none is provided, for example a <js>"count"</js>
* to control the number of results per page might default to 100 if not supplied by the client in the request.
@@ -638,7 +638,7 @@ public class ParameterInfo extends SwaggerElement {
* 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.
- *
+ *
* @param _default The new value for the <property>default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -649,7 +649,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setDefault(Object)}.
- *
+ *
* @param _default The new value for the <property>default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -659,11 +659,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>maximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @return The value of the <property>maximum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMaximum() {
@@ -672,11 +672,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>maximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -687,7 +687,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaximum(Number)}.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -697,11 +697,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk>
* if it is not set.
*/
@@ -711,11 +711,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMaximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -726,7 +726,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setExclusiveMaximum(Boolean)}.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -736,11 +736,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>minimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @return The value of the <property>minimum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMinimum() {
@@ -749,11 +749,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>minimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -764,7 +764,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinimum(Number)}.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -774,11 +774,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
* not set.
*/
@@ -788,11 +788,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMinimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -803,7 +803,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setExclusiveMinimum(Boolean)}.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -813,11 +813,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
* http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
- *
+ *
* @return The value of the <property>maxLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxLength() {
@@ -826,11 +826,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
* http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -841,7 +841,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaxLength(Integer)}.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -851,11 +851,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>minLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
* http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
- *
+ *
* @return The value of the <property>minLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinLength() {
@@ -864,11 +864,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>minLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
* http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
- *
+ *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -879,7 +879,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinLength(Integer)}.
- *
+ *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -889,11 +889,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>pattern</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
* http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
- *
+ *
* @return The value of the <property>pattern</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getPattern() {
@@ -902,11 +902,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
* http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -917,7 +917,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setPattern(String)}.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -927,11 +927,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
* http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
- *
+ *
* @return The value of the <property>maxItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxItems() {
@@ -940,11 +940,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
* http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -955,7 +955,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaxItems(Integer)}.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -965,11 +965,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>minItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
* http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
- *
+ *
* @return The value of the <property>minItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinItems() {
@@ -978,11 +978,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>minItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
* http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -993,7 +993,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinItems(Integer)}.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1003,11 +1003,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>uniqueItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
* http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
- *
+ *
* @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not
* set.
*/
@@ -1017,11 +1017,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>uniqueItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
* http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1032,7 +1032,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setUniqueItems(Boolean)}.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1042,11 +1042,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>enum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
* http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
- *
+ *
* @return The value of the <property>enum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Object> getEnum() {
@@ -1055,11 +1055,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>enum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
* http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
- *
+ *
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1070,11 +1070,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
* http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
- *
+ *
* @param _enum
* The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -1098,7 +1098,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #addEnum(Object...)}.
- *
+ *
* @param _enum
* The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -1110,11 +1110,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>multipleOf</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
* http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
- *
+ *
* @return The value of the <property>multipleOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMultipleOf() {
@@ -1123,11 +1123,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>multipleOf</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
* http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1138,7 +1138,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #setMultipleOf(Number)}.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
index 71461a3..ddcba7f 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
@@ -18,7 +18,7 @@ import org.apache.juneau.annotation.*;
/**
* Describes a single response from an API Operation.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* }
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -57,14 +57,14 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* Required. A short description of the response.
- *
+ *
* <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for
* rich text representation.
- *
+ *
* @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getDescription() {
@@ -73,14 +73,14 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* Required. A short description of the response.
- *
+ *
* <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -91,7 +91,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Synonym for {@link #setDescription(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -101,17 +101,17 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>schema</property>.
- *
+ *
* <p>
* A definition of the response structure.
- *
+ *
* <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>.
* This SHOULD be accompanied by a relevant produces mime-type.
- *
+ *
* @return The value of the <property>schema</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public SchemaInfo getSchema() {
@@ -120,17 +120,17 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>schema</property>.
- *
+ *
* <p>
* A definition of the response structure.
- *
+ *
* <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>.
* This SHOULD be accompanied by a relevant produces mime-type.
- *
+ *
* @param schema The new value for the <property>schema</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -141,7 +141,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Synonym for {@link #setSchema(SchemaInfo)}.
- *
+ *
* @param schema The new value for the <property>schema</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -151,10 +151,10 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>headers</property>.
- *
+ *
* <p>
* A list of headers that are sent with the response.
- *
+ *
* @return The value of the <property>headers</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,HeaderInfo> getHeaders() {
@@ -163,10 +163,10 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>headers</property>.
- *
+ *
* <p>
* A list of headers that are sent with the response.
- *
+ *
* @param headers The new value for the <property>headers</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -177,10 +177,10 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property adder: <property>headers</property>.
- *
+ *
* <p>
* A list of headers that are sent with the response.
- *
+ *
* @param name The header name.
* @param header The header descriptions
* @return This object (for method chaining).
@@ -194,7 +194,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Synonym for {@link #addHeader(String,HeaderInfo)}.
- *
+ *
* @param name The header name.
* @param header The header descriptions
* @return This object (for method chaining).
@@ -205,13 +205,13 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>examples</property>.
- *
+ *
* <p>
* An example of the response message.
- *
+ *
* <p>
* Keys must be MIME-type strings.
- *
+ *
* @return The value of the <property>examples</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,Object> getExamples() {
@@ -220,13 +220,13 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>examples</property>.
- *
+ *
* <p>
* An example of the response message.
- *
+ *
* <p>
* Keys must be MIME-type strings.
- *
+ *
* @param examples The new value for the <property>examples</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -237,10 +237,10 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property adder: <property>examples</property>.
- *
+ *
* <p>
* An example of the response message.
- *
+ *
* @param mimeType The mimeType of the example.
* @param example The example output.
* @return This object (for method chaining).
@@ -254,7 +254,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Synonym for {@link #addExample(String,Object)}.
- *
+ *
* @param mimeType The mimeType of the example.
* @param example The example output.
* @return This object (for method chaining).
@@ -265,7 +265,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Synonym for {@link #setExamples(Map)}.
- *
+ *
* @param examples The new value for the <property>examples</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
index a2bc4c1..fe27eba 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
@@ -18,16 +18,16 @@ import org.apache.juneau.annotation.*;
/**
* The Schema Object allows the definition of input and output data types.
- *
+ *
* <p>
* These types can be objects, but also primitives and arrays.
* This object is based on the JSON Schema Specification Draft 4 and uses a predefined subset of it.
* On top of this subset, there are extensions provided by this specification to allow for more complete documentation.
- *
+ *
* <p>
* Further information about the properties can be found in JSON Schema Core and JSON Schema Validation.
* Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -79,11 +79,11 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
- *
+ *
* @return The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getFormat() {
@@ -92,11 +92,11 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
- *
+ *
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -107,7 +107,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setFormat(String)}.
- *
+ *
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -117,7 +117,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>title</property>.
- *
+ *
* @return The value of the <property>title</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getTitle() {
@@ -126,7 +126,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>title</property>.
- *
+ *
* @param title The new value for the <property>title</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -137,7 +137,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setTitle(String)}.
- *
+ *
* @param title The new value for the <property>title</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -147,11 +147,11 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
- *
+ *
* @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getDescription() {
@@ -160,11 +160,11 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -175,7 +175,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setDescription(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -185,10 +185,10 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>default</property>.
- *
+ *
* <p>
* Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.
- *
+ *
* @return The value of the <property>default</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Object getDefault() {
@@ -197,10 +197,10 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>default</property>.
- *
+ *
* <p>
* Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.
- *
+ *
* @param _default The new value for the <property>default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -211,7 +211,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setDefault(Object)}.
- *
+ *
* @param _default The new value for the <property>default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -221,7 +221,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>multipleOf</property>.
- *
+ *
* @return The value of the <property>multipleOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMultipleOf() {
@@ -230,7 +230,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>multipleOf</property>.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -241,7 +241,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMultipleOf(Number)}.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -251,7 +251,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>maximum</property>.
- *
+ *
* @return The value of the <property>maximum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMaximum() {
@@ -260,7 +260,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>maximum</property>.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -271,7 +271,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaximum(Number)}.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -281,7 +281,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
- *
+ *
* @return
* The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -292,7 +292,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMaximum</property>.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -303,7 +303,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setExclusiveMaximum(Boolean)}.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -313,7 +313,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>minimum</property>.
- *
+ *
* @return The value of the <property>minimum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMinimum() {
@@ -322,7 +322,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>minimum</property>.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -333,7 +333,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinimum(Number)}.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -343,7 +343,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
- *
+ *
* @return
* The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -354,7 +354,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMinimum</property>.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -365,7 +365,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setExclusiveMinimum(Boolean)}.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -375,7 +375,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxLength</property>.
- *
+ *
* @return The value of the <property>maxLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxLength() {
@@ -384,7 +384,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxLength</property>.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -395,7 +395,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaxLength(Integer)}.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -405,7 +405,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>minLength</property>.
- *
+ *
* @return The value of the <property>minLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinLength() {
@@ -414,7 +414,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>minLength</property>.
- *
+ *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -425,7 +425,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinLength(Integer)}.
- *
+ *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -435,7 +435,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>pattern</property>.
- *
+ *
* @return The value of the <property>pattern</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getPattern() {
@@ -444,7 +444,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -455,7 +455,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setPattern(String)}.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -465,7 +465,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxItems</property>.
- *
+ *
* @return The value of the <property>maxItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxItems() {
@@ -474,7 +474,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxItems</property>.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -485,7 +485,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaxItems(Integer)}.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -495,7 +495,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>minItems</property>.
- *
+ *
* @return The value of the <property>minItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinItems() {
@@ -504,7 +504,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>minItems</property>.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -515,7 +515,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinItems(Integer)}.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -525,7 +525,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>uniqueItems</property>.
- *
+ *
* @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not
* set.
*/
@@ -534,7 +534,7 @@ public class SchemaInfo extends SwaggerElement {
}
/**
* Bean property setter: <property>uniqueItems</property>.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -545,7 +545,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setUniqueItems(Boolean)}.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -555,7 +555,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxProperties</property>.
- *
+ *
* @return The value of the <property>maxProperties</property> property on this bean, or <jk>null</jk> if it is
* not set.
*/
@@ -565,7 +565,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxProperties</property>.
- *
+ *
* @param maxProperties The new value for the <property>maxProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -576,7 +576,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaxProperties(Integer)}.
- *
+ *
* @param maxProperties The new value for the <property>maxProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -586,7 +586,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>minProperties</property>.
- *
+ *
* @return The value of the <property>minProperties</property> property on this bean, or <jk>null</jk> if it is
* not set.
*/
@@ -596,7 +596,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>minProperties</property>.
- *
+ *
* @param minProperties The new value for the <property>minProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -607,7 +607,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinProperties(Integer)}.
- *
+ *
* @param minProperties The new value for the <property>minProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -617,7 +617,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>required</property>.
- *
+ *
* @return The value of the <property>required</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Boolean getRequired() {
@@ -626,7 +626,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>required</property>.
- *
+ *
* @param required The new value for the <property>required</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -637,7 +637,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setRequired(Boolean)}.
- *
+ *
* @param required The new value for the <property>required</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -647,7 +647,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>enum</property>.
- *
+ *
* @return The value of the <property>enum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Object> getEnum() {
@@ -656,7 +656,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>enum</property>.
- *
+ *
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -667,7 +667,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
- *
+ *
* @param _enum The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
* @return This object (for method chaining).
@@ -689,7 +689,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #addEnum(Object...)}.
- *
+ *
* @param _enum
* The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -701,7 +701,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getType() {
@@ -710,7 +710,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -721,7 +721,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setType(String)}.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -731,7 +731,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>items</property>.
- *
+ *
* @return The value of the <property>items</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Items getItems() {
@@ -740,7 +740,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>items</property>.
- *
+ *
* @param items The new value for the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -751,7 +751,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setItems(Items)}.
- *
+ *
* @param items The new value for the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -761,7 +761,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>allOf</property>.
- *
+ *
* @return The value of the <property>allOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Object> getAllOf() {
@@ -770,7 +770,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>allOf</property>.
- *
+ *
* @param allOf The new value for the <property>allOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -781,7 +781,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
- *
+ *
* @param allOf
* The new values to add to the <property>allOf</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -804,7 +804,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #addAllOf(Object...)}.
- *
+ *
* @param allOf
* The new values to add to the <property>allOf</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -816,7 +816,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>properties</property>.
- *
+ *
* @return The value of the <property>properties</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,Map<String,Object>> getProperties() {
@@ -825,7 +825,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>properties</property>.
- *
+ *
* @param properties The new value for the <property>properties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -836,7 +836,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>properties</property>.
- *
+ *
* @param name The property name.
* @param propertyProperties The properties of the property.
* @return This object (for method chaining).
@@ -850,7 +850,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #addProperty(String,Map)}.
- *
+ *
* @param name The property name.
* @param propertyProperties The properties of the property.
* @return This object (for method chaining).
@@ -866,7 +866,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>additionalProperties</property>.
- *
+ *
* @return
* The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it
* is not set.
@@ -877,7 +877,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>additionalProperties</property>.
- *
+ *
* @param additionalProperties The new value for the <property>additionalProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -888,7 +888,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setAdditionalProperties(Map)}.
- *
+ *
* @param additionalProperties The new value for the <property>additionalProperties</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -903,7 +903,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>discriminator</property>.
- *
+ *
* @return
* The value of the <property>discriminator</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -914,7 +914,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>discriminator</property>.
- *
+ *
* @param discriminator The new value for the <property>discriminator</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -925,7 +925,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setDiscriminator(String)}.
- *
+ *
* @param discriminator The new value for the <property>discriminator</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -935,7 +935,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>readOnly</property>.
- *
+ *
* @return The value of the <property>readOnly</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Boolean getReadOnly() {
@@ -944,7 +944,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>readOnly</property>.
- *
+ *
* @param readOnly The new value for the <property>readOnly</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -955,7 +955,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setReadOnly(Boolean)}.
- *
+ *
* @param readOnly The new value for the <property>readOnly</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -965,7 +965,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>xml</property>.
- *
+ *
* @return The value of the <property>xml</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Xml getXml() {
@@ -974,7 +974,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>xml</property>.
- *
+ *
* @param xml The new value for the <property>xml</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -985,7 +985,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setXml(Xml)}.
- *
+ *
* @param xml The new value for the <property>xml</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -995,7 +995,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>externalDocs</property>.
- *
+ *
* @return
* The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not
* set.
@@ -1006,7 +1006,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>externalDocs</property>.
- *
+ *
* @param externalDocs The new value for the <property>externalDocs</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1017,7 +1017,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setExternalDocs(ExternalDocumentation)}.
- *
+ *
* @param externalDocs The new value for the <property>externalDocs</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1027,7 +1027,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>example</property>.
- *
+ *
* @return The value of the <property>example</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Object getExample() {
@@ -1036,7 +1036,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>example</property>.
- *
+ *
* @param example The new value for the <property>example</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -1047,7 +1047,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #setExample(Object)}.
- *
+ *
* @param example The new value for the <property>example</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
index a7e2541..5ef3383 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
@@ -21,25 +21,25 @@ import org.apache.juneau.annotation.*;
/**
* Allows the definition of a security scheme that can be used by the operations.
- *
+ *
* <p>
* Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's
* common flows (implicit, password, application and access code).
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Basic authentication sample</jc>
* {
* <js>"type"</js>: <js>"basic"</js>
* }
- *
+ *
* <jc>// API key sample</jc>
* {
* <js>"type"</js>: <js>"apiKey"</js>,
* <js>"name"</js>: <js>"api_key"</js>,
* <js>"in"</js>: <js>"header"</js>
* }
- *
+ *
* <jc>// Implicit OAuth2 sample</jc>
* {
* <js>"type"</js>: <js>"oauth2"</js>,
@@ -51,7 +51,7 @@ import org.apache.juneau.annotation.*;
* }
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -89,13 +89,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* <p>
* Required. The type of the security scheme.
- *
+ *
* <p>
* Valid values are <js>"basic"</js>, <js>"apiKey"</js> or <js>"oauth2"</js>.
- *
+ *
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getType() {
@@ -104,13 +104,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
- *
+ *
* <p>
* Required. The type of the security scheme.
- *
+ *
* <p>
* Valid values are <js>"basic"</js>, <js>"apiKey"</js> or <js>"oauth2"</js>.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -126,7 +126,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setType(String)}.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -136,10 +136,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* A short description for security scheme.
- *
+ *
* @return
* The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -149,10 +149,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* A short description for security scheme.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -163,7 +163,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setDescription(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -173,10 +173,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
- *
+ *
* <p>
* The name of the header or query parameter to be used.
- *
+ *
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getName() {
@@ -185,10 +185,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
- *
+ *
* <p>
* The name of the header or query parameter to be used.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -199,7 +199,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setName(String)}.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -209,10 +209,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>in</property>.
- *
+ *
* <p>
* The location of the API key. Valid values are <js>"query"</js> or <js>"header"</js>.
- *
+ *
* @return The value of the <property>in</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getIn() {
@@ -221,10 +221,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>in</property>.
- *
+ *
* <p>
* The location of the API key. Valid values are <js>"query"</js> or <js>"header"</js>.
- *
+ *
* @param in The new value for the <property>in</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -235,7 +235,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setIn(String)}.
- *
+ *
* @param in The new value for the <property>in</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -245,13 +245,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>flow</property>.
- *
+ *
* <p>
* The flow used by the OAuth2 security scheme.
- *
+ *
* <p>
* Valid values are <js>"implicit"</js>, <js>"password"</js>, <js>"application"</js> or <js>"accessCode"</js>.
- *
+ *
* @return The value of the <property>flow</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getFlow() {
@@ -260,13 +260,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>flow</property>.
- *
+ *
* <p>
* The flow used by the OAuth2 security scheme.
- *
+ *
* <p>
* Valid values are <js>"implicit"</js>, <js>"password"</js>, <js>"application"</js> or <js>"accessCode"</js>.
- *
+ *
* @param flow The new value for the <property>flow</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -277,7 +277,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setFlow(String)}.
- *
+ *
* @param flow The new value for the <property>flow</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -287,13 +287,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>authorizationUrl</property>.
- *
+ *
* <p>
* The authorization URL to be used for this flow.
- *
+ *
* <p>
* This SHOULD be in the form of a URL.
- *
+ *
* @return
* The value of the <property>authorizationUrl</property> property on this bean, or <jk>null</jk> if it
* is not set.
@@ -304,13 +304,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>authorizationUrl</property>.
- *
+ *
* <p>
* The authorization URL to be used for this flow.
- *
+ *
* <p>
* This SHOULD be in the form of a URL.
- *
+ *
* @param authorizationUrl The new value for the <property>authorizationUrl</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -321,7 +321,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setAuthorizationUrl(String)}.
- *
+ *
* @param authorizationUrl The new value for the <property>authorizationUrl</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -331,13 +331,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>tokenUrl</property>.
- *
+ *
* <p>
* The token URL to be used for this flow.
- *
+ *
* <p>
* This SHOULD be in the form of a URL.
- *
+ *
* @return The value of the <property>tokenUrl</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getTokenUrl() {
@@ -346,13 +346,13 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>tokenUrl</property>.
- *
+ *
* <p>
* The token URL to be used for this flow.
- *
+ *
* <p>
* This SHOULD be in the form of a URL.
- *
+ *
* @param tokenUrl The new value for the <property>tokenUrl</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -363,7 +363,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #setTokenUrl(String)}.
- *
+ *
* @param tokenUrl The new value for the <property>tokenUrl</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -373,10 +373,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>scopes</property>.
- *
+ *
* <p>
* The available scopes for the OAuth2 security scheme.
- *
+ *
* @return The value of the <property>scopes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,String> getScopes() {
@@ -385,10 +385,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>scopes</property>.
- *
+ *
* <p>
* The available scopes for the OAuth2 security scheme.
- *
+ *
* @param scopes The new value for the <property>scopes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -399,10 +399,10 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property adder: <property>scopes</property>.
- *
+ *
* <p>
* The available scopes for the OAuth2 security scheme.
- *
+ *
* @param name The name of the scope.
* @param description A short description of the scope.
* @return This object (for method chaining).
@@ -416,7 +416,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Synonym for {@link #addScope(String,String)}.
- *
+ *
* @param name The name of the scope.
* @param description A short description of the scope.
* @return This object (for method chaining).
[31/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSource.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSource.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSource.java
index a8a337a..6897bfa 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSource.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSource.java
@@ -22,7 +22,7 @@ public abstract class ConfigSource {
/**
* Constructor.
- *
+ *
* @param settings
* The settings for this config source.
*/
@@ -32,7 +32,7 @@ public abstract class ConfigSource {
/**
* Returns the name of the config file.
- *
+ *
* @return The name of the config file.
*/
protected final ConfigSourceSettings getSettings() {
@@ -41,7 +41,7 @@ public abstract class ConfigSource {
/**
* Returns the contents of the configuration file.
- *
+ *
* @param name The config file name.
* @return The contents of the configuration file.
* @throws Exception
@@ -50,7 +50,7 @@ public abstract class ConfigSource {
/**
* Saves the contents of the configuration file if the underlying storage hasn't been modified.
- *
+ *
* @param name The config file name.
* @param contents The new contents of the configuration file.
* @return <jk>true</jk> if we successfully saved the new configuration file contents, or <jk>false</jk> if the
@@ -61,11 +61,11 @@ public abstract class ConfigSource {
/**
* Returns whether the underlying configuration contents have changed.
- *
+ *
* <p>
* For example, if the configuration source is a file, this method would return <jk>true</jk> if the
* file on the filesystem has been modified since the {@link #read(String)} method was called.
- *
+ *
* @param name The config file name.
* @return <jk>true</jk> if the persisted contents of the config file have changed.
* @throws Exception
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceFile.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceFile.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceFile.java
index 723c03b..2d6991f 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceFile.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceFile.java
@@ -29,7 +29,7 @@ public class ConfigSourceFile extends ConfigSource {
/**
* Constructor.
- *
+ *
* @param settings
* The settings for this config source.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceMemory.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceMemory.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceMemory.java
index aafc9c4..9d7aa28 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceMemory.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceMemory.java
@@ -27,7 +27,7 @@ public class ConfigSourceMemory extends ConfigSource {
/**
* Constructor.
- *
+ *
* @param settings
* The settings for this config source.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceSettings.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceSettings.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceSettings.java
index 2cac854..868bb01 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceSettings.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigSourceSettings.java
@@ -63,7 +63,7 @@ public class ConfigSourceSettings {
/**
* Returns the paths to search to find config files.
- *
+ *
* @return The paths to search to find config files.
*/
public List<String> getSearchPaths() {
@@ -72,7 +72,7 @@ public class ConfigSourceSettings {
/**
* Returns the charset of the config file.
- *
+ *
* @return The charset of the config file.
*/
public Charset getCharset() {
@@ -81,7 +81,7 @@ public class ConfigSourceSettings {
/**
* Specifies whether the config file should be opened in read-only mode.
- *
+ *
* @return <jk>true</jk> if the config file should be opened in read-only mode.
*/
public boolean isReadonly() {
@@ -90,10 +90,10 @@ public class ConfigSourceSettings {
/**
* Specifies whether config files should be created if they're not found in the search paths.
- *
+ *
* <p>
* Note that the first writable path will be used for the location of the file.
- *
+ *
* @return <jk>true</jk> if the config file should be created if not found.
*/
public boolean isCreateIfNotExists() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/Encoder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/Encoder.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/Encoder.java
index 9b73b25..5be664e 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/Encoder.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/Encoder.java
@@ -19,7 +19,7 @@ public interface Encoder {
/**
* Encode a string.
- *
+ *
* @param fieldName The field name being encoded.
* @param in The unencoded input string.
* @return The encoded output string.
@@ -28,7 +28,7 @@ public interface Encoder {
/**
* Decode a string.
- *
+ *
* @param fieldName The field name being decoded.
* @param in The encoded input string.
* @return The decoded output string.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/EntryListener.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/EntryListener.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/EntryListener.java
index 87526c1..a3c3346 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/EntryListener.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/EntryListener.java
@@ -16,7 +16,7 @@ import java.util.*;
/**
* Listener that can be used to listen for change events for a specific entry in a config file.
- *
+ *
* <p>
* Use the {@link ConfigFile#addListener(ConfigFileListener)} method to register listeners.
*/
@@ -26,7 +26,7 @@ public class EntryListener extends ConfigFileListener {
/**
* Constructor.
- *
+ *
* @param fullKey The key in the config file to listen for changes on.
*/
public EntryListener(String fullKey) {
@@ -41,7 +41,7 @@ public class EntryListener extends ConfigFileListener {
/**
* Signifies that the config file entry changed.
- *
+ *
* @param cf The config file being changed.
*/
public void onChange(ConfigFile cf) {}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/Section.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/Section.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/Section.java
index 20e5bad..4aabcd6 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/Section.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/Section.java
@@ -48,7 +48,7 @@ public final class Section implements Map<String,String> {
/**
* Constructor with predefined contents.
- *
+ *
* @param contents Predefined contents to copy into this section.
*/
public Section(Map<String,String> contents) {
@@ -64,7 +64,7 @@ public final class Section implements Map<String,String> {
/**
* Sets the config file that this section belongs to.
- *
+ *
* @param configFile The config file that this section belongs to.
* @return This object (for method chaining).
*/
@@ -76,7 +76,7 @@ public final class Section implements Map<String,String> {
/**
* Sets the section name
- *
+ *
* @param name The section name.
* @return This object (for method chaining).
*/
@@ -229,7 +229,7 @@ public final class Section implements Map<String,String> {
/**
* Sets the specified value in this section.
- *
+ *
* @param key The section key.
* @param value The new value.
* @param encoded Whether this value should be encoded during save.
@@ -311,7 +311,7 @@ public final class Section implements Map<String,String> {
/**
* Returns <jk>true</jk> if the specified entry is encoded.
- *
+ *
* @param key The key.
* @return <jk>true</jk> if the specified entry is encoded.
*/
@@ -330,7 +330,7 @@ public final class Section implements Map<String,String> {
/**
* Adds header comments to this section.
- *
+ *
* @see ConfigFile#addHeaderComments(String, String...) for a description.
* @param comments The comment lines to add to this section.
* @return This object (for method chaining).
@@ -365,7 +365,7 @@ public final class Section implements Map<String,String> {
/**
* Serialize this section.
- *
+ *
* @param out What to serialize to.
* @param format The format (e.g. INI, BATCH, SHELL).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/SectionListener.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/SectionListener.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/SectionListener.java
index aec28c1..5c6271b 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/SectionListener.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/SectionListener.java
@@ -18,7 +18,7 @@ import java.util.*;
/**
* Listener that can be used to listen for change events for a specific section in a config file.
- *
+ *
* <p>
* Use the {@link ConfigFile#addListener(ConfigFileListener)} method to register listeners.
*/
@@ -29,7 +29,7 @@ public class SectionListener extends ConfigFileListener {
/**
* Constructor.
- *
+ *
* @param section The name of the section in the config file to listen to.
*/
public SectionListener(String section) {
@@ -56,7 +56,7 @@ public class SectionListener extends ConfigFileListener {
/**
* Signifies that the config file entry changed.
- *
+ *
* @param cf The config file being modified.
*/
public void onChange(ConfigFile cf) {}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/XorEncoder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/XorEncoder.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/XorEncoder.java
index bbd6b3d..de810d3 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/XorEncoder.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/XorEncoder.java
@@ -17,7 +17,7 @@ import static org.apache.juneau.internal.IOUtils.*;
/**
* Simply XOR+Base64 encoder for obscuring passwords and other sensitive data in INI config files.
- *
+ *
* <p>
* This is not intended to be used as strong encryption.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/ComboInput.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/ComboInput.java b/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/ComboInput.java
index 3ee1389..d7ab88a 100644
--- a/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/ComboInput.java
+++ b/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/ComboInput.java
@@ -91,7 +91,7 @@ public class ComboInput<T> {
* Override this method if you want to do a post-parse verification on the object.
* <p>
* Note that a Function would be preferred here, but it's not available in Java 6.
- *
+ *
* @param o The object returned by the parser.
*/
public void verify(T o) {}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/TestUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/TestUtils.java b/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/TestUtils.java
index ef0c62c..5254707 100755
--- a/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/TestUtils.java
+++ b/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/TestUtils.java
@@ -453,7 +453,7 @@ public class TestUtils {
/**
* Temporarily sets the default system timezone to the specified timezone ID.
* Use {@link #unsetTimeZone()} to unset it.
- *
+ *
* @param name
*/
public static void setTimeZone(String name) {
@@ -468,7 +468,7 @@ public class TestUtils {
/**
* Temporarily sets the default system locale to the specified locale.
* Use {@link #unsetLocale()} to unset it.
- *
+ *
* @param name
*/
public static void setLocale(Locale locale) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/ini/ConfigFileBuilderTest.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/ini/ConfigFileBuilderTest.java b/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/ini/ConfigFileBuilderTest.java
index f780f64..bef71b5 100755
--- a/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/ini/ConfigFileBuilderTest.java
+++ b/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/ini/ConfigFileBuilderTest.java
@@ -42,7 +42,7 @@ public class ConfigFileBuilderTest {
}
/**
- *
+ *
* @throws Exception
*/
@Test
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/test/pojos/Constants.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/test/pojos/Constants.java b/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/test/pojos/Constants.java
index ccfef31..cb31a01 100644
--- a/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/test/pojos/Constants.java
+++ b/juneau-core/juneau-core-test/src/test/java/org/apache/juneau/test/pojos/Constants.java
@@ -15,7 +15,7 @@ package org.apache.juneau.test.pojos;
/**
* Description.
* <p>
- *
+ *
* @author James Bognar (james.bognar@salesforce.com)
*/
public class Constants {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/LinkString.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/LinkString.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/LinkString.java
index 8446db4..111665f 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/LinkString.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/LinkString.java
@@ -22,13 +22,13 @@ import org.apache.juneau.utils.*;
/**
* Simple bean that implements a hyperlink for the HTML serializer.
- *
+ *
* <p>
* The name and url properties correspond to the following parts of a hyperlink in an HTML document...
* <p class='bcode'>
* <xt><a</xt> <xa>href</xa>=<xs>'href'</xs><xt>></xt>name<xt></a></xt>
* </p>
- *
+ *
* <p>
* When encountered by the {@link HtmlSerializer} class, this object gets converted to a hyperlink.
* All other serializers simply convert it to a simple bean.
@@ -42,7 +42,7 @@ public class LinkString implements Comparable<LinkString> {
/**
* Constructor.
- *
+ *
* @param name Corresponds to the text inside of the <xt><A></xt> element.
* @param href Corresponds to the value of the <xa>href</xa> attribute of the <xt><A></xt> element.
* @param hrefArgs Optional arguments for {@link MessageFormat} style arguments in the href.
@@ -59,10 +59,10 @@ public class LinkString implements Comparable<LinkString> {
/**
* Bean property getter: <property>name</property>.
- *
+ *
* <p>
* Corresponds to the text inside of the <xt><A></xt> element.
- *
+ *
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getName() {
@@ -71,7 +71,7 @@ public class LinkString implements Comparable<LinkString> {
/**
* Bean property setter: <property>name</property>.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -82,10 +82,10 @@ public class LinkString implements Comparable<LinkString> {
/**
* Bean property getter: <property>href</property>.
- *
+ *
* <p>
* Corresponds to the value of the <xa>href</xa> attribute of the <xt><A></xt> element.
- *
+ *
* @return The value of the <property>href</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getHref() {
@@ -94,7 +94,7 @@ public class LinkString implements Comparable<LinkString> {
/**
* Bean property setter: <property>href</property>.
- *
+ *
* @param href The new value for the <property>href</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -105,10 +105,10 @@ public class LinkString implements Comparable<LinkString> {
/**
* Bean property setter: <property>href</property>.
- *
+ *
* <p>
* Same as {@link #setHref(String)} except allows for {@link MessageFormat} style arguments.
- *
+ *
* @param href The new href.
* @param args Optional {@link MessageFormat}-style arguments.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/ResultSetList.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/ResultSetList.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/ResultSetList.java
index 8fa21ff..202b70a 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/ResultSetList.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/ResultSetList.java
@@ -31,7 +31,7 @@ public final class ResultSetList extends LinkedList<Map<String,Object>> {
/**
* Constructor.
- *
+ *
* @param rs The result set to load into this DTO.
* @param pos The start position (zero-indexed).
* @param limit The maximum number of rows to retrieve.
@@ -76,10 +76,10 @@ public final class ResultSetList extends LinkedList<Map<String,Object>> {
/**
* Reads the specified column from the current row in the result set.
- *
+ *
* <p>
* Subclasses can override this method to handle specific data types in special ways.
- *
+ *
* @param rs The result set to read from.
* @param col The column number (indexed by 1).
* @param dataType The {@link Types type} of the entry.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
index 87c80e5..df9c121 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
@@ -19,12 +19,12 @@ import org.apache.juneau.*;
/**
* Various useful static methods for creating ATOM elements.
- *
+ *
* <p>
* Typically, you'll want to do a static import on this class and then call the methods like so...
* <p class='bcode'>
* <jk>import static</jk> org.apache.juneau.dto.atom.AtomBuilder.*;
- *
+ *
* Feed feed =
* <jsm>feed</jsm>(<js>"tag:juneau.sample.com,2013:1"</js>, <js>"Juneau ATOM specification"</js>,
* <js>"2013-05-08T12:29:29Z"</js>)
@@ -36,7 +36,8 @@ import org.apache.juneau.*;
* <jsm>link</jsm>(<js>"self"</js>, <js>"application/atom+xml"</js>, <js>"http://www.sample.com/feed.atom"</js>)
* );
* </p>
- *
+ *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -56,7 +57,7 @@ public class AtomBuilder {
/**
* Creates a {@link Category} element with the specified {@link Category#term(String)} attribute.
- *
+ *
* @param term The {@link Category#term(String)} attribute.
* @return The new element.
*/
@@ -66,7 +67,7 @@ public class AtomBuilder {
/**
* Creates a {@link Content} element with the specified {@link Content#type(String)} attribute.
- *
+ *
* @return The new element.
*/
public static final Content content() {
@@ -75,7 +76,7 @@ public class AtomBuilder {
/**
* Creates a {@link Content} element.
- *
+ *
* @param type The {@link Content#type(String)} attribute.
* @return The new element.
*/
@@ -86,7 +87,7 @@ public class AtomBuilder {
/**
* Creates an {@link Entry} element with the specified {@link Entry#id(Id)}, {@link Entry#title(Text)}, and
* {@link Entry#updated(Calendar)} attributes.
- *
+ *
* @param id The {@link Entry#id(Id)} attribute.
* @param title The {@link Entry#title(Text)} attribute.
* @param updated The {@link Entry#updated(Calendar)} attribute.
@@ -99,7 +100,7 @@ public class AtomBuilder {
/**
* Creates an {@link Entry} element with the specified {@link Entry#id(Id)}, {@link Entry#title(Text)}, and
* {@link Entry#updated(Calendar)} attributes.
- *
+ *
* @param id The {@link Entry#id(Id)} attribute.
* @param title The {@link Entry#title(Text)} attribute.
* @param updated The {@link Entry#updated(Calendar)} attribute.
@@ -112,7 +113,7 @@ public class AtomBuilder {
/**
* Creates a {@link Feed} element with the specified {@link Feed#id(Id)}, {@link Entry#title(Text)}, and
* {@link Feed#updated(Calendar)} attributes.
- *
+ *
* @param id The {@link Feed#id(Id)} attribute.
* @param title The {@link Feed#title(Text)} attribute.
* @param updated The {@link Feed#updated(Calendar)} attribute.
@@ -125,7 +126,7 @@ public class AtomBuilder {
/**
* Creates a {@link Feed} element with the specified {@link Feed#id(Id)}, {@link Entry#title(Text)}, and
* {@link Feed#updated(Calendar)} attributes.
- *
+ *
* @param id The {@link Feed#id(Id)} attribute.
* @param title The {@link Feed#title(Text)} attribute.
* @param updated The {@link Feed#updated(Calendar)} attribute.
@@ -137,7 +138,7 @@ public class AtomBuilder {
/**
* Creates a {@link Generator} element with the specified {@link Generator#text(String)} child node.
- *
+ *
* @param text The {@link Generator#text(String)} child node.
* @return The new element.
*/
@@ -147,14 +148,14 @@ public class AtomBuilder {
/**
* Creates an {@link Icon} element with the specified {@link Icon#uri(Object)} attribute.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param uri The {@link Icon#uri(Object)} attribute.
* @return The new element.
*/
@@ -164,7 +165,7 @@ public class AtomBuilder {
/**
* Creates an {@link Id} element with the specified {@link Id#text(String)} child node.
- *
+ *
* @param text The {@link Id#text(String)} child node.
* @return The new element.
*/
@@ -175,7 +176,7 @@ public class AtomBuilder {
/**
* Creates a {@link Link} element with the specified {@link Link#rel(String)}, {@link Link#type(String)}, and
* {@link Link#href(String)} attributes.
- *
+ *
* @param rel The {@link Link#rel(String)} attribute.
* @param type The {@link Link#type(String)} attribute.
* @param href The {@link Link#href(String)} attribute.
@@ -187,14 +188,14 @@ public class AtomBuilder {
/**
* Creates a {@link Logo} element with the specified {@link Logo#uri(Object)} attribute.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param uri The {@link Logo#uri(Object)} attribute.
* @return The new element.
*/
@@ -204,7 +205,7 @@ public class AtomBuilder {
/**
* Creates a {@link Person} element with the specified {@link Person#name(String)} attribute.
- *
+ *
* @param name The {@link Person#name(String)} attribute.
* @return The new element.
*/
@@ -214,7 +215,7 @@ public class AtomBuilder {
/**
* Creates a {@link Source} element.
- *
+ *
* @return The new element.
*/
public static final Source source() {
@@ -223,7 +224,7 @@ public class AtomBuilder {
/**
* Creates a {@link Text} element.
- *
+ *
* @return The new element.
*/
public static final Text text() {
@@ -232,7 +233,7 @@ public class AtomBuilder {
/**
* Creates a {@link Text} element with the specified {@link Text#type(String)} attribute.
- *
+ *
* @param type The {@link Text#type(String)} attribute.
* @return The new element.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Category.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Category.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Category.java
index a570d11..d65230f 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Category.java
+++ b/juneau-core/juneau-dto/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.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomCategory =
@@ -36,7 +36,7 @@ import org.apache.juneau.xml.annotation.*;
* undefinedContent
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -61,7 +61,7 @@ public class Category extends Common {
/**
* Normal constructor.
- *
+ *
* @param term The category term.
*/
public Category(String term) {
@@ -86,7 +86,7 @@ public class Category extends Common {
/**
* Sets the category term.
- *
+ *
* @param term The category term.
* @return This object (for method chaining).
*/
@@ -98,7 +98,7 @@ public class Category extends Common {
/**
* Returns the category scheme.
- *
+ *
* @return The category scheme.
*/
@Xml(format=ATTR)
@@ -108,14 +108,14 @@ public class Category extends Common {
/**
* Sets the category scheme.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param scheme The category scheme.
* @return This object (for method chaining).
*/
@@ -127,7 +127,7 @@ public class Category extends Common {
/**
* Returns the category label.
- *
+ *
* @return The category label.
*/
@Xml(format=ATTR)
@@ -137,7 +137,7 @@ public class Category extends Common {
/**
* Sets the category label.
- *
+ *
* @param label The category label.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Common.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Common.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Common.java
index 130bb87..3e6ced5 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Common.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Common.java
@@ -25,7 +25,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents an <code>atomCommonAttributes</code> construct in the RFC4287 specification.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomCommonAttributes =
@@ -33,7 +33,7 @@ import org.apache.juneau.xml.annotation.*;
* attribute xml:lang { atomLanguageTag }?,
* undefinedAttribute*
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -61,7 +61,7 @@ public abstract class Common {
/**
* Returns the uri base of this object.
- *
+ *
* @return The URI base of this object.
*/
@Xml(prefix="xml", format=ATTR)
@@ -71,14 +71,14 @@ public abstract class Common {
/**
* Sets the URI base of this object.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param base The URI base of this object.
* @return This object (for method chaining).
*/
@@ -90,7 +90,7 @@ public abstract class Common {
/**
* Returns the language of this object.
- *
+ *
* @return The language of this object.
*/
@Xml(prefix="xml", format=ATTR)
@@ -100,7 +100,7 @@ public abstract class Common {
/**
* Sets the language of this object.
- *
+ *
* @param lang The language of this object.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java
index e16fb5d..fa43882 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/CommonEntry.java
@@ -23,7 +23,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Parent class of {@link Entry}, {@link Feed}, and {@link Source}
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -53,7 +53,7 @@ public class CommonEntry extends Common {
/**
* Normal constructor.
- *
+ *
* @param id The ID of this object.
* @param title The title of this object.
* @param updated The updated timestamp of this object.
@@ -64,7 +64,7 @@ public class CommonEntry extends Common {
/**
* Normal constructor.
- *
+ *
* @param id The ID of this object.
* @param title The title of this object.
* @param updated The updated timestamp of this object.
@@ -83,7 +83,7 @@ public class CommonEntry extends Common {
/**
* Returns the list of authors for this object.
- *
+ *
* @return The list of authors for this object.
*/
@Xml(format=COLLAPSED, childName="author")
@@ -93,7 +93,7 @@ public class CommonEntry extends Common {
/**
* Sets the list of authors for this object.
- *
+ *
* @param authors The list of authors for this object.
* @return This object (for method chaining).
*/
@@ -105,7 +105,7 @@ public class CommonEntry extends Common {
/**
* Returns the list of categories of this object.
- *
+ *
* @return The list of categories of this object.
*/
@Xml(format=COLLAPSED, childName="category")
@@ -115,7 +115,7 @@ public class CommonEntry extends Common {
/**
* Sets the list of categories of this object.
- *
+ *
* @param categories The list of categories of this object.
* @return This object (for method chaining).
*/
@@ -127,7 +127,7 @@ public class CommonEntry extends Common {
/**
* Returns the list of contributors of this object.
- *
+ *
* @return The list of contributors of this object.
*/
@Xml(format=COLLAPSED, childName="contributor")
@@ -137,7 +137,7 @@ public class CommonEntry extends Common {
/**
* Sets the list of contributors of this object.
- *
+ *
* @param contributors The list of contributors of this object.
* @return This object (for method chaining).
*/
@@ -149,7 +149,7 @@ public class CommonEntry extends Common {
/**
* Returns the ID of this object.
- *
+ *
* @return The ID of this object.
*/
public Id getId() {
@@ -158,7 +158,7 @@ public class CommonEntry extends Common {
/**
* Sets the ID of this object.
- *
+ *
* @param id The ID of this object.
* @return This object (for method chaining).
*/
@@ -170,7 +170,7 @@ public class CommonEntry extends Common {
/**
* Sets the ID of this object.
- *
+ *
* @param id The ID of this object.
* @return This object (for method chaining).
*/
@@ -181,7 +181,7 @@ public class CommonEntry extends Common {
/**
* Returns the list of links of this object.
- *
+ *
* @return The list of links of this object.
*/
@Xml(format=COLLAPSED)
@@ -191,7 +191,7 @@ public class CommonEntry extends Common {
/**
* Sets the list of links of this object.
- *
+ *
* @param links The list of links of this object.
* @return This object (for method chaining).
*/
@@ -203,7 +203,7 @@ public class CommonEntry extends Common {
/**
* Returns the rights statement of this object.
- *
+ *
* @return The rights statement of this object.
*/
public Text getRights() {
@@ -212,7 +212,7 @@ public class CommonEntry extends Common {
/**
* Sets the rights statement of this object.
- *
+ *
* @param rights The rights statement of this object.
* @return This object (for method chaining).
*/
@@ -224,7 +224,7 @@ public class CommonEntry extends Common {
/**
* Sets the rights statement of this object.
- *
+ *
* @param rights The rights statement of this object.
* @return This object (for method chaining).
*/
@@ -235,7 +235,7 @@ public class CommonEntry extends Common {
/**
* Returns the title of this object.
- *
+ *
* @return The title of this object.
*/
public Text getTitle() {
@@ -244,7 +244,7 @@ public class CommonEntry extends Common {
/**
* Sets the title of this object.
- *
+ *
* @param title The title of this object.
* @return This object (for method chaining).
*/
@@ -256,7 +256,7 @@ public class CommonEntry extends Common {
/**
* Sets the title of this object.
- *
+ *
* @param title The title of this object.
* @return This object (for method chaining).
*/
@@ -267,7 +267,7 @@ public class CommonEntry extends Common {
/**
* Returns the update timestamp of this object.
- *
+ *
* @return The update timestamp of this object.
*/
@Swap(CalendarSwap.ISO8601DT.class)
@@ -277,7 +277,7 @@ public class CommonEntry extends Common {
/**
* Sets the update timestamp of this object.
- *
+ *
* @param updated The update timestamp of this object.
* @return This object (for method chaining).
*/
@@ -289,7 +289,7 @@ public class CommonEntry extends Common {
/**
* Sets the update timestamp of this object.
- *
+ *
* @param updated The update timestamp of this object in ISO8601 format.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Content.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Content.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Content.java
index 7b45c51..4ec67a9 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Content.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Content.java
@@ -24,35 +24,35 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents an <code>atomContent</code> construct in the RFC4287 specification.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomContent = atomInlineTextContent
* | atomInlineXHTMLContent
* | atomInlineOtherContent
* | atomOutOfLineContent
- *
+ *
* atomInlineTextContent =
* element atom:content {
* atomCommonAttributes,
* attribute type { "text" | "html" }?,
* (text)*
* }
- *
+ *
* atomInlineXHTMLContent =
* element atom:content {
* atomCommonAttributes,
* attribute type { "xhtml" },
* xhtmlDiv
* }
- *
+ *
* atomInlineOtherContent =
* element atom:content {
* atomCommonAttributes,
* attribute type { atomMediaType }?,
* (text|anyElement)*
* }
- *
+ *
* atomOutOfLineContent =
* element atom:content {
* atomCommonAttributes,
@@ -61,7 +61,7 @@ import org.apache.juneau.xml.annotation.*;
* empty
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -84,7 +84,7 @@ public class Content extends Text {
/**
* Normal content.
- *
+ *
* @param type The content type of this content.
*/
public Content(String type) {
@@ -105,7 +105,7 @@ public class Content extends Text {
/**
* Returns the source URI.
- *
+ *
* @return the source URI.
*/
@Xml(format=ATTR)
@@ -115,14 +115,14 @@ public class Content extends Text {
/**
* Sets the source URI.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param src The source URI.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Entry.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Entry.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Entry.java
index 60f1ec4..55e48eb 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Entry.java
+++ b/juneau-core/juneau-dto/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.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomEntry =
@@ -42,7 +42,7 @@ import org.apache.juneau.transforms.*;
* & extensionElement*)
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -68,7 +68,7 @@ public class Entry extends CommonEntry {
/**
* Normal constructor.
- *
+ *
* @param id The ID of this entry.
* @param title The title of this entry.
* @param updated The updated timestamp of this entry.
@@ -79,7 +79,7 @@ public class Entry extends CommonEntry {
/**
* Normal constructor.
- *
+ *
* @param id The ID of this entry.
* @param title The title of this entry.
* @param updated The updated timestamp of this entry.
@@ -98,7 +98,7 @@ public class Entry extends CommonEntry {
/**
* Returns the content of this entry.
- *
+ *
* @return The content of this entry.
*/
public Content getContent() {
@@ -107,7 +107,7 @@ public class Entry extends CommonEntry {
/**
* Sets the content of this entry.
- *
+ *
* @param content The content of this entry.
* @return This object (for method chaining).
*/
@@ -119,7 +119,7 @@ public class Entry extends CommonEntry {
/**
* Returns the publish timestamp of this entry.
- *
+ *
* @return The publish timestamp of this entry.
*/
@Swap(CalendarSwap.ISO8601DT.class)
@@ -129,7 +129,7 @@ public class Entry extends CommonEntry {
/**
* Sets the publish timestamp of this entry.
- *
+ *
* @param published The publish timestamp of this entry.
* @return This object (for method chaining).
*/
@@ -141,7 +141,7 @@ public class Entry extends CommonEntry {
/**
* Sets the publish timestamp of this entry.
- *
+ *
* @param published The publish timestamp of this entry in ISO8601 format.
* @return This object (for method chaining).
*/
@@ -153,7 +153,7 @@ public class Entry extends CommonEntry {
/**
* Returns the source of this entry.
- *
+ *
* @return The source of this entry.
*/
public Source getSource() {
@@ -162,7 +162,7 @@ public class Entry extends CommonEntry {
/**
* Sets the source of this entry.
- *
+ *
* @param source The source of this entry.
* @return This object (for method chaining).
*/
@@ -174,7 +174,7 @@ public class Entry extends CommonEntry {
/**
* Returns the summary of this entry.
- *
+ *
* @return The summary of this entry.
*/
public Text getSummary() {
@@ -183,7 +183,7 @@ public class Entry extends CommonEntry {
/**
* Sets the summary of this entry.
- *
+ *
* @param summary The summary of this entry.
* @return This object (for method chaining).
*/
@@ -195,7 +195,7 @@ public class Entry extends CommonEntry {
/**
* Sets the summary of this entry.
- *
+ *
* @param summary The summary of this entry.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Feed.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Feed.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Feed.java
index 6ea61e0..044e6dd 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Feed.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Feed.java
@@ -21,10 +21,10 @@ import org.apache.juneau.xml.annotation.*;
/**
* Top-level ATOM feed object.
- *
+ *
* <p>
* Represents an <code>atomFeed</code> construct in the RFC4287 specification.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomFeed =
@@ -46,7 +46,7 @@ import org.apache.juneau.xml.annotation.*;
* atomEntry*
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -73,7 +73,7 @@ public class Feed extends CommonEntry {
/**
* Normal constructor.
- *
+ *
* @param id The feed identifier.
* @param title The feed title.
* @param updated The feed updated timestamp.
@@ -84,7 +84,7 @@ public class Feed extends CommonEntry {
/**
* Normal constructor.
- *
+ *
* @param id The feed identifier.
* @param title The feed title.
* @param updated The feed updated timestamp.
@@ -103,7 +103,7 @@ public class Feed extends CommonEntry {
/**
* Returns generator information on this feed.
- *
+ *
* @return The generator information on this feed.
*/
public Generator getGenerator() {
@@ -112,7 +112,7 @@ public class Feed extends CommonEntry {
/**
* Sets the generator information on this feed.
- *
+ *
* @param generator The generator information on this feed.
* @return This object (for method chaining).
*/
@@ -124,7 +124,7 @@ public class Feed extends CommonEntry {
/**
* Returns the feed icon.
- *
+ *
* @return The feed icon.
*/
public Icon getIcon() {
@@ -133,7 +133,7 @@ public class Feed extends CommonEntry {
/**
* Sets the feed icon.
- *
+ *
* @param icon The feed icon.
* @return This object (for method chaining).
*/
@@ -145,7 +145,7 @@ public class Feed extends CommonEntry {
/**
* Returns the feed logo.
- *
+ *
* @return The feed logo.
*/
public Logo getLogo() {
@@ -154,7 +154,7 @@ public class Feed extends CommonEntry {
/**
* Sets the feed logo.
- *
+ *
* @param logo The feed logo.
* @return This object (for method chaining).
*/
@@ -166,7 +166,7 @@ public class Feed extends CommonEntry {
/**
* Returns the feed subtitle.
- *
+ *
* @return The feed subtitle.
*/
@BeanProperty("subtitle")
@@ -176,7 +176,7 @@ public class Feed extends CommonEntry {
/**
* Sets the feed subtitle.
- *
+ *
* @param subtitle The feed subtitle.
* @return This object (for method chaining).
*/
@@ -188,7 +188,7 @@ public class Feed extends CommonEntry {
/**
* Sets the feed subtitle.
- *
+ *
* @param subtitle The feed subtitle.
* @return This object (for method chaining).
*/
@@ -199,7 +199,7 @@ public class Feed extends CommonEntry {
/**
* Returns the entries in the feed.
- *
+ *
* @return The entries in the feed.
*/
@Xml(format=COLLAPSED)
@@ -209,7 +209,7 @@ public class Feed extends CommonEntry {
/**
* Sets the entries in the feed.
- *
+ *
* @param entries The entries in the feed.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Generator.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Generator.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Generator.java
index c5d680b..c38db92 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Generator.java
+++ b/juneau-core/juneau-dto/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.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomGenerator = element atom:generator {
@@ -34,7 +34,7 @@ import org.apache.juneau.xml.annotation.*;
* text
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -60,7 +60,7 @@ public class Generator extends Common {
/**
* Normal constructor.
- *
+ *
* @param text The generator statement content.
*/
public Generator(String text) {
@@ -77,7 +77,7 @@ public class Generator extends Common {
/**
* Returns the URI of this generator statement.
- *
+ *
* @return The URI of this generator statement.
*/
@Xml(format=ATTR)
@@ -87,14 +87,14 @@ public class Generator extends Common {
/**
* Sets the URI of this generator statement.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param uri The URI of this generator statement.
* @return This object (for method chaining).
*/
@@ -106,7 +106,7 @@ public class Generator extends Common {
/**
* Returns the version of this generator statement.
- *
+ *
* @return The version of this generator statement.
*/
@Xml(format=ATTR)
@@ -116,7 +116,7 @@ public class Generator extends Common {
/**
* Sets the version of this generator statement.
- *
+ *
* @param version The version of this generator statement.
* @return This object (for method chaining).
*/
@@ -128,7 +128,7 @@ public class Generator extends Common {
/**
* Returns the content of this generator statement.
- *
+ *
* @return The content of this generator statement.
*/
@Xml(format=TEXT)
@@ -138,7 +138,7 @@ public class Generator extends Common {
/**
* Sets the content of this generator statement.
- *
+ *
* @param text The content of this generator statement.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Icon.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Icon.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Icon.java
index 6db5a9e..5e60325 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Icon.java
+++ b/juneau-core/juneau-dto/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.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomIcon = element atom:icon {
@@ -32,7 +32,7 @@ import org.apache.juneau.xml.annotation.*;
* (atomUri)
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -56,14 +56,14 @@ public class Icon extends Common {
/**
* Normal constructor.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param uri The URI of the icon.
*/
public Icon(Object uri) {
@@ -80,7 +80,7 @@ public class Icon extends Common {
/**
* Returns the URI of this icon.
- *
+ *
* @return The URI of this icon.
*/
@Xml(format=ELEMENTS)
@@ -90,14 +90,14 @@ public class Icon extends Common {
/**
* Sets the URI of this icon.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param uri The URI of this icon.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Id.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Id.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Id.java
index 55e3abf..f784965 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Id.java
+++ b/juneau-core/juneau-dto/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.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomId = element atom:id {
@@ -27,7 +27,7 @@ import org.apache.juneau.xml.annotation.*;
* (atomUri)
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -50,7 +50,7 @@ public class Id extends Common {
/**
* Normal constructor.
- *
+ *
* @param text The id element contents.
*/
public Id(String text) {
@@ -67,7 +67,7 @@ public class Id extends Common {
/**
* Returns the content of this identifier.
- *
+ *
* @return The content of this identifier.
*/
@Xml(format=TEXT)
@@ -77,7 +77,7 @@ public class Id extends Common {
/**
* Sets the content of this identifier.
- *
+ *
* @param text The content of this identifier.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Link.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Link.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Link.java
index 890e609..8a6059d 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Link.java
+++ b/juneau-core/juneau-dto/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.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomLink =
@@ -34,7 +34,7 @@ import org.apache.juneau.xml.annotation.*;
* undefinedContent
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -63,7 +63,7 @@ public class Link extends Common {
/**
* Normal constructor.
- *
+ *
* @param rel The rel of the link.
* @param type The type of the link.
* @param href The URI of the link.
@@ -82,7 +82,7 @@ public class Link extends Common {
/**
* Returns the href of the target of this link.
- *
+ *
* @return The href of the target of this link.
*/
@Xml(format=ATTR)
@@ -92,7 +92,7 @@ public class Link extends Common {
/**
* Sets the href of the target of this link.
- *
+ *
* @param href The href of the target of this link.
* @return This object (for method chaining).
*/
@@ -104,7 +104,7 @@ public class Link extends Common {
/**
* Returns the rel of this link.
- *
+ *
* @return The rel of this link.
*/
@Xml(format=ATTR)
@@ -114,7 +114,7 @@ public class Link extends Common {
/**
* Sets the rel of this link.
- *
+ *
* @param rel The rel of this link.
* @return This object (for method chaining).
*/
@@ -126,7 +126,7 @@ public class Link extends Common {
/**
* Returns the content type of the target of this link.
- *
+ *
* @return The content type of the target of this link.
*/
@Xml(format=ATTR)
@@ -136,7 +136,7 @@ public class Link extends Common {
/**
* Sets the content type of the target of this link.
- *
+ *
* <p>
* Must be one of the following:
* <ul>
@@ -145,7 +145,7 @@ public class Link extends Common {
* <li><js>"xhtml"</js>
* <li><jk>null</jk> (defaults to <js>"text"</js>)
* </ul>
- *
+ *
* @param type The content type of the target of this link.
* @return This object (for method chaining).
*/
@@ -157,7 +157,7 @@ public class Link extends Common {
/**
* Returns the language of the target of this link.
- *
+ *
* @return The language of the target of this link.
*/
@Xml(format=ATTR)
@@ -167,7 +167,7 @@ public class Link extends Common {
/**
* Sets the language of the target of this link.
- *
+ *
* @param hreflang The language of the target of this link.
* @return This object (for method chaining).
*/
@@ -179,7 +179,7 @@ public class Link extends Common {
/**
* Returns the title of the target of this link.
- *
+ *
* @return The title of the target of this link.
*/
@Xml(format=ATTR)
@@ -189,7 +189,7 @@ public class Link extends Common {
/**
* Sets the title of the target of this link.
- *
+ *
* @param title The title of the target of this link.
* @return This object (for method chaining).
*/
@@ -201,7 +201,7 @@ public class Link extends Common {
/**
* Returns the length of the contents of the target of this link.
- *
+ *
* @return The length of the contents of the target of this link.
*/
@Xml(format=ATTR)
@@ -211,7 +211,7 @@ public class Link extends Common {
/**
* Sets the length of the contents of the target of this link.
- *
+ *
* @param length The length of the contents of the target of this link.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Logo.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Logo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Logo.java
index e639f35..996939e 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Logo.java
+++ b/juneau-core/juneau-dto/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.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomLogo = element atom:logo {
@@ -32,7 +32,7 @@ import org.apache.juneau.xml.annotation.*;
* (atomUri)
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -56,14 +56,14 @@ 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.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param uri The URI of the logo.
*/
public Logo(Object uri) {
@@ -80,7 +80,7 @@ public class Logo extends Common {
/**
* Returns the URI of the logo.
- *
+ *
* @return The URI of the logo.
*/
@Xml(format=ELEMENTS)
@@ -90,14 +90,14 @@ 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.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param uri The URI of the logo.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Person.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Person.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Person.java
index 54c3866..fd1c2ff 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Person.java
+++ b/juneau-core/juneau-dto/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.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomPersonConstruct =
@@ -33,7 +33,7 @@ import org.apache.juneau.annotation.*;
* & element atom:email { atomEmailAddress }?
* & extensionElement*)
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -58,7 +58,7 @@ public class Person extends Common {
/**
* Normal constructor.
- *
+ *
* @param name The name of the person.
*/
public Person(String name) {
@@ -75,7 +75,7 @@ public class Person extends Common {
/**
* Returns the name of the person.
- *
+ *
* @return The name of the person.
*/
public String getName() {
@@ -84,7 +84,7 @@ public class Person extends Common {
/**
* Sets the name of the person.
- *
+ *
* @param name The name of the person.
* @return This object (for method chaining).
*/
@@ -96,7 +96,7 @@ public class Person extends Common {
/**
* Returns the URI of the person.
- *
+ *
* @return The URI of the person.
*/
public URI getUri() {
@@ -105,14 +105,14 @@ public class Person extends Common {
/**
* Sets the URI of the person.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param uri The URI of the person.
* @return This object (for method chaining).
*/
@@ -124,7 +124,7 @@ public class Person extends Common {
/**
* Returns the email address of the person.
- *
+ *
* @return The email address of the person.
*/
public String getEmail() {
@@ -133,7 +133,7 @@ public class Person extends Common {
/**
* Sets the email address of the person.
- *
+ *
* @param email The email address of the person.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Source.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Source.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Source.java
index d82c7de..fede36e 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Source.java
+++ b/juneau-core/juneau-dto/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.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomSource =
@@ -39,7 +39,7 @@ import org.apache.juneau.annotation.*;
* & extensionElement*)
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -69,7 +69,7 @@ public class Source extends CommonEntry {
/**
* Returns the generator info of this source.
- *
+ *
* @return The generator info of this source.
*/
public Generator getGenerator() {
@@ -78,7 +78,7 @@ public class Source extends CommonEntry {
/**
* Sets the generator info of this source.
- *
+ *
* @param generator The generator info of this source.
* @return This object (for method chaining).
*/
@@ -90,7 +90,7 @@ public class Source extends CommonEntry {
/**
* Returns the icon of this source.
- *
+ *
* @return The icon of this source.
*/
public Icon getIcon() {
@@ -99,7 +99,7 @@ public class Source extends CommonEntry {
/**
* Sets the icon of this source.
- *
+ *
* @param icon The icon of this source.
* @return This object (for method chaining).
*/
@@ -111,7 +111,7 @@ public class Source extends CommonEntry {
/**
* Returns the logo of this source.
- *
+ *
* @return The logo of this source.
*/
public Logo getLogo() {
@@ -120,7 +120,7 @@ public class Source extends CommonEntry {
/**
* Sets the logo of this source.
- *
+ *
* @param logo The logo of this source.
* @return This object (for method chaining).
*/
@@ -132,7 +132,7 @@ public class Source extends CommonEntry {
/**
* Returns the subtitle of this source.
- *
+ *
* @return The subtitle of this source.
*/
public Text getSubtitle() {
@@ -141,7 +141,7 @@ public class Source extends CommonEntry {
/**
* Sets the subtitle of this source.
- *
+ *
* @param subtitle The subtitle of this source.
* @return This object (for method chaining).
*/
@@ -153,7 +153,7 @@ public class Source extends CommonEntry {
/**
* Sets the subtitle of this source.
- *
+ *
* @param subtitle The subtitle of this source.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Text.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Text.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Text.java
index 898ff06..72b7e6c 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Text.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Text.java
@@ -19,28 +19,28 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents an <code>atomTextConstruct</code> construct in the RFC4287 specification.
- *
+ *
* <h6 class='figure'>Schema</h6>
* <p class='bcode'>
* atomTextConstruct = atomPlainTextConstruct | atomXHTMLTextConstruct
- *
+ *
* atomPlainTextConstruct =
* atomCommonAttributes,
* attribute type { "text" | "html" }?,
* text
- *
+ *
* atomXHTMLTextConstruct =
* atomCommonAttributes,
* attribute type { "xhtml" },
* xhtmlDiv
- *
+ *
* xhtmlDiv = element xhtml:div {
* (attribute * { text }
* | text
* | anyXHTML)*
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -63,7 +63,7 @@ public class Text extends Common {
/**
* Normal content.
- *
+ *
* @param type The content type of this content.
*/
public Text(String type) {
@@ -80,7 +80,7 @@ public class Text extends Common {
/**
* Returns the content type of this content.
- *
+ *
* @return The content type of this content.
*/
@Xml(format=ATTR)
@@ -90,7 +90,7 @@ public class Text extends Common {
/**
* Sets the content type of this content.
- *
+ *
* <p>
* Must be one of the following:
* <ul>
@@ -99,7 +99,7 @@ public class Text extends Common {
* <li><js>"xhtml"</js>
* <li><jk>null</jk> (defaults to <js>"text"</js>)
* </ul>
- *
+ *
* @param type The content type of this content.
* @return This object (for method chaining).
*/
@@ -111,7 +111,7 @@ public class Text extends Common {
/**
* Returns the content of this content.
- *
+ *
* @return The content of this content.
*/
@Xml(format=XMLTEXT)
@@ -121,7 +121,7 @@ public class Text extends Common {
/**
* Sets the content of this content.
- *
+ *
* @param text The content of this content.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Utils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Utils.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Utils.java
index f42be90..67b0a92 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Utils.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/atom/Utils.java
@@ -18,7 +18,7 @@ import javax.xml.bind.*;
/**
* Static utility methods for ATOM marshalling code.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -38,7 +38,7 @@ class Utils {
/**
* Converts an ISO8601 date-time string to a {@link Calendar}.
- *
+ *
* @param lexicalXSDDateTime The ISO8601 date-time string.
* @return A new {@link Calendar} object.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/cognos/Column.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/cognos/Column.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/cognos/Column.java
index 251bdb6..a3fcee0 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/cognos/Column.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/cognos/Column.java
@@ -18,7 +18,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents a meta-data column in a Cognos dataset.
- *
+ *
* <p>
* When serialized to XML, creates the following construct:
* <p class='bcode'>
@@ -38,7 +38,7 @@ public class Column {
/**
* Constructor.
- *
+ *
* @param name The column name.
* @param type The column type (e.g. <js>"xs:String"</js>).
*/
@@ -48,7 +48,7 @@ public class Column {
/**
* Constructor.
- *
+ *
* @param name The column name.
* @param type The column type (e.g. <js>"xs:String"</js>).
* @param length The column length (e.g. <code>255</code>).
@@ -61,10 +61,10 @@ public class Column {
/**
* Associates a POJO swap with this column.
- *
+ *
* <p>
* Typically used to define columns that don't exist on the underlying beans being serialized.
- *
+ *
* <p>
* For example, the <code>AddressBookResource</code> sample defined the following POJO swap to define an additional
* <js>"numAddresses"</js> column even though no such property exists on the serialized beans.
@@ -79,7 +79,7 @@ public class Column {
* }
* );
* </p>
- *
+ *
* @param pojoSwap The POJO swap to associate with the column.
* @return This object (for method chaining).
*/
@@ -95,7 +95,7 @@ public class Column {
/**
* Bean property getter: <property>name</property>.
- *
+ *
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@Xml(format=XmlFormat.ATTR)
@@ -105,7 +105,7 @@ public class Column {
/**
* Bean property setter: <property>name</property>.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -116,7 +116,7 @@ public class Column {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@Xml(format=XmlFormat.ATTR)
@@ -126,7 +126,7 @@ public class Column {
/**
* Bean property setter: <property>type</property>.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -137,7 +137,7 @@ public class Column {
/**
* Bean property getter: <property>length</property>.
- *
+ *
* @return The value of the <property>length</property> property on this bean, or <jk>null</jk> if length is not
* applicable for the specified type.
*/
@@ -148,7 +148,7 @@ public class Column {
/**
* Bean property setter: <property>length</property>.
- *
+ *
* @param length The new value for the <property>length</property> property on this bean.
* Can be <jk>null</jk> if length is not applicable for the specified type.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/cognos/DataSet.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
index bf234ac..9bb8f71 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
@@ -20,7 +20,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Represents a Cognos dataset.
- *
+ *
* <p>
* When serialized to XML, creates the following construct (example pulled from <code>AddressBookResource</code>):
* <p class='bcode'>
@@ -46,12 +46,12 @@ import org.apache.juneau.xml.annotation.*;
* <xt></c:data></xt>
* <xt></c:dataset></xt>
* </p>
- *
+ *
* <p>
* Only 2-dimensional POJOs (arrays or collections of maps or beans) can be serialized to Cognos.
- *
+ *
* <h5 class='section'>Example:</h5>
- *
+ *
* The construct shown above is a serialized <code>AddressBook</code> object which is a subclass of
* <code>LinkedList<Person></code>.
* The code for generating the XML is as follows...
@@ -70,9 +70,9 @@ import org.apache.juneau.xml.annotation.*;
* }
* )
* };
- *
+ *
* DataSet ds = <jk>new</jk> DataSet(items, <jsf>addressBook</jsf>, BeanContext.<jsf>DEFAULT</jsf>);
- *
+ *
* String xml = XmlSerializer.<jsf>DEFAULT_SQ</jsf>.serialize(ds);
* </p>
*/
@@ -88,7 +88,7 @@ public class DataSet {
/**
* Constructor.
- *
+ *
* @param columns The meta-data that represents the columns in the dataset.
* @param o
* The POJO being serialized to Cognos.
@@ -127,7 +127,7 @@ public class DataSet {
/**
* Represents a row of data.
- *
+ *
* <p>
* When serialized to XML, creates the following construct (example pulled from <code>AddressBookResource</code>):
* <p class='bcode'>
@@ -148,7 +148,7 @@ public class DataSet {
/**
* Returns the values in this row.
- *
+ *
* @return The values in this row.
*/
@Xml(format=XmlFormat.COLLAPSED, childName="value")
@@ -164,7 +164,7 @@ public class DataSet {
/**
* Bean property getter: <property>metadata</property>.
- *
+ *
* @return The value of the <property>metadata</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@BeanProperty("metadata")
@@ -174,7 +174,7 @@ public class DataSet {
/**
* Bean property setter: <property>metadata</property>.
- *
+ *
* @param metaData The new value for the <property>metadata</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -186,7 +186,7 @@ public class DataSet {
/**
* Bean property getter: <property>data</property>.
- *
+ *
* @return The value of the <property>data</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@BeanProperty("data")
@@ -196,7 +196,7 @@ public class DataSet {
/**
* Bean property setter: <property>data</property>.
- *
+ *
* @param data The new value for the <property>data</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/A.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/A.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/A.java
index 5138fcc..fccfa95 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/A.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/A.java
@@ -21,7 +21,7 @@ import org.apache.juneau.annotation.*;
/**
* DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-a-element"><a></a>
* element.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="a")
@@ -39,10 +39,10 @@ public class A extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-download">download</a> attribute.
- *
+ *
* <p>
* Whether to download the resource instead of navigating to it, and its file name if so.
- *
+ *
* @param download
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -55,17 +55,17 @@ public class A extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-href">href</a> attribute.
- *
+ *
* <p>
* Address of the hyperlink.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param href
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
@@ -78,10 +78,10 @@ public class A extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-hreflang">hreflang</a> attribute.
- *
+ *
* <p>
* Language of the linked resource.
- *
+ *
* @param hreflang The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -92,10 +92,10 @@ public class A extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-rel">rel</a> attribute.
- *
+ *
* <p>
* Relationship between the document containing the hyperlink and the destination resource.
- *
+ *
* @param rel The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -106,10 +106,10 @@ public class A extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-target">target</a> attribute.
- *
+ *
* <p>
* Default browsing context for hyperlink navigation and form submission.
- *
+ *
* @param target The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -120,10 +120,10 @@ public class A extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-type">type</a> attribute.
- *
+ *
* <p>
* Hint for the type of the referenced resource.
- *
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Abbr.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Abbr.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Abbr.java
index 0e2c075..6db8add 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Abbr.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Abbr.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="abbr")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Address.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Address.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Address.java
index cd60484..6381ab3 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Address.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Address.java
@@ -17,7 +17,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -27,7 +27,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="address")
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Area.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Area.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Area.java
index 97a4463..99f28b3 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Area.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/html5/Area.java
@@ -21,7 +21,7 @@ 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.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -31,7 +31,7 @@ import org.apache.juneau.annotation.*;
* <li class='sublink'>
* <a class='doclink' href='../../../../../overview-summary.html#DTOs.HTML5'>HTML5</a>
* </ul>
- * </li>
+ * </li>
* </ul>
*/
@Bean(typeName="area")
@@ -39,10 +39,10 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-alt">alt</a> attribute.
- *
+ *
* <p>
* Replacement text for use when images are not available.
- *
+ *
* @param alt The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -54,10 +54,10 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-coords">coords</a>
* attribute.
- *
+ *
* <p>
* Coordinates for the shape to be created in an image map.
- *
+ *
* @param coords The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -68,10 +68,10 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-download">download</a> attribute.
- *
+ *
* <p>
* Whether to download the resource instead of navigating to it, and its file name if so.
- *
+ *
* @param download
* The new value for this attribute.
* Typically a {@link Boolean} or {@link String}.
@@ -84,17 +84,17 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-href">href</a> attribute.
- *
+ *
* <p>
* Address of the hyperlink.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param href
* The new value for this attribute.
* Typically a {@link URL} or {@link String}.
@@ -107,10 +107,10 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-hreflang">hreflang</a> attribute.
- *
+ *
* <p>
* Language of the linked resource.
- *
+ *
* @param hreflang The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -121,10 +121,10 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-rel">rel</a> attribute.
- *
+ *
* <p>
* Relationship between the document containing the hyperlink and the destination resource.
- *
+ *
* @param rel The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -135,10 +135,10 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-shape">shape</a> attribute.
- *
+ *
* <p>
* The kind of shape to be created in an image map.
- *
+ *
* @param shape The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -149,10 +149,10 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-target">target</a> attribute.
- *
+ *
* <p>
* Browsing context for hyperlink navigation.
- *
+ *
* @param target The new value for this attribute.
* @return This object (for method chaining).
*/
@@ -163,10 +163,10 @@ public class Area extends HtmlElementVoid {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-type">type</a> attribute.
- *
+ *
* <p>
* Hint for the type of the referenced resource.
- *
+ *
* @param type The new value for this attribute.
* @return This object (for method chaining).
*/
[32/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
Javadoc updates.
Project: http://git-wip-us.apache.org/repos/asf/juneau/repo
Commit: http://git-wip-us.apache.org/repos/asf/juneau/commit/5686b8d6
Tree: http://git-wip-us.apache.org/repos/asf/juneau/tree/5686b8d6
Diff: http://git-wip-us.apache.org/repos/asf/juneau/diff/5686b8d6
Branch: refs/heads/master
Commit: 5686b8d66af6595cb61941b628d712217940a75a
Parents: cd2b718
Author: JamesBognar <ja...@apache.org>
Authored: Sun Jan 14 11:01:58 2018 -0500
Committer: JamesBognar <ja...@apache.org>
Committed: Sun Jan 14 11:01:58 2018 -0500
----------------------------------------------------------------------
.../java/org/apache/juneau/ini/ConfigFile.java | 244 +++++------
.../apache/juneau/ini/ConfigFileBuilder.java | 52 +--
.../apache/juneau/ini/ConfigFileContext.java | 2 +-
.../org/apache/juneau/ini/ConfigFileImpl.java | 14 +-
.../apache/juneau/ini/ConfigFileListener.java | 8 +-
.../org/apache/juneau/ini/ConfigFileVar.java | 14 +-
.../apache/juneau/ini/ConfigFileWrapped.java | 4 +-
.../org/apache/juneau/ini/ConfigSource.java | 12 +-
.../org/apache/juneau/ini/ConfigSourceFile.java | 2 +-
.../apache/juneau/ini/ConfigSourceMemory.java | 2 +-
.../apache/juneau/ini/ConfigSourceSettings.java | 10 +-
.../java/org/apache/juneau/ini/Encoder.java | 4 +-
.../org/apache/juneau/ini/EntryListener.java | 6 +-
.../java/org/apache/juneau/ini/Section.java | 14 +-
.../org/apache/juneau/ini/SectionListener.java | 6 +-
.../java/org/apache/juneau/ini/XorEncoder.java | 2 +-
.../test/java/org/apache/juneau/ComboInput.java | 2 +-
.../test/java/org/apache/juneau/TestUtils.java | 4 +-
.../juneau/ini/ConfigFileBuilderTest.java | 2 +-
.../org/apache/juneau/test/pojos/Constants.java | 2 +-
.../java/org/apache/juneau/dto/LinkString.java | 22 +-
.../org/apache/juneau/dto/ResultSetList.java | 6 +-
.../org/apache/juneau/dto/atom/AtomBuilder.java | 47 +-
.../org/apache/juneau/dto/atom/Category.java | 20 +-
.../java/org/apache/juneau/dto/atom/Common.java | 16 +-
.../org/apache/juneau/dto/atom/CommonEntry.java | 46 +-
.../org/apache/juneau/dto/atom/Content.java | 22 +-
.../java/org/apache/juneau/dto/atom/Entry.java | 28 +-
.../java/org/apache/juneau/dto/atom/Feed.java | 32 +-
.../org/apache/juneau/dto/atom/Generator.java | 22 +-
.../java/org/apache/juneau/dto/atom/Icon.java | 18 +-
.../java/org/apache/juneau/dto/atom/Id.java | 10 +-
.../java/org/apache/juneau/dto/atom/Link.java | 32 +-
.../java/org/apache/juneau/dto/atom/Logo.java | 18 +-
.../java/org/apache/juneau/dto/atom/Person.java | 22 +-
.../java/org/apache/juneau/dto/atom/Source.java | 22 +-
.../java/org/apache/juneau/dto/atom/Text.java | 22 +-
.../java/org/apache/juneau/dto/atom/Utils.java | 4 +-
.../org/apache/juneau/dto/cognos/Column.java | 24 +-
.../org/apache/juneau/dto/cognos/DataSet.java | 26 +-
.../java/org/apache/juneau/dto/html5/A.java | 32 +-
.../java/org/apache/juneau/dto/html5/Abbr.java | 4 +-
.../org/apache/juneau/dto/html5/Address.java | 4 +-
.../java/org/apache/juneau/dto/html5/Area.java | 44 +-
.../org/apache/juneau/dto/html5/Article.java | 12 +-
.../java/org/apache/juneau/dto/html5/Aside.java | 4 +-
.../java/org/apache/juneau/dto/html5/Audio.java | 40 +-
.../java/org/apache/juneau/dto/html5/B.java | 4 +-
.../java/org/apache/juneau/dto/html5/Base.java | 16 +-
.../java/org/apache/juneau/dto/html5/Bdi.java | 4 +-
.../java/org/apache/juneau/dto/html5/Bdo.java | 4 +-
.../org/apache/juneau/dto/html5/Blockquote.java | 8 +-
.../java/org/apache/juneau/dto/html5/Body.java | 16 +-
.../java/org/apache/juneau/dto/html5/Br.java | 4 +-
.../org/apache/juneau/dto/html5/Button.java | 56 +--
.../org/apache/juneau/dto/html5/Canvas.java | 12 +-
.../org/apache/juneau/dto/html5/Caption.java | 4 +-
.../java/org/apache/juneau/dto/html5/Cite.java | 4 +-
.../java/org/apache/juneau/dto/html5/Code.java | 4 +-
.../java/org/apache/juneau/dto/html5/Col.java | 8 +-
.../org/apache/juneau/dto/html5/Colgroup.java | 8 +-
.../java/org/apache/juneau/dto/html5/Data.java | 8 +-
.../org/apache/juneau/dto/html5/Datalist.java | 4 +-
.../java/org/apache/juneau/dto/html5/Dd.java | 4 +-
.../java/org/apache/juneau/dto/html5/Del.java | 12 +-
.../java/org/apache/juneau/dto/html5/Dfn.java | 4 +-
.../java/org/apache/juneau/dto/html5/Div.java | 4 +-
.../java/org/apache/juneau/dto/html5/Dl.java | 4 +-
.../java/org/apache/juneau/dto/html5/Dt.java | 4 +-
.../java/org/apache/juneau/dto/html5/Em.java | 4 +-
.../java/org/apache/juneau/dto/html5/Embed.java | 24 +-
.../org/apache/juneau/dto/html5/Fieldset.java | 16 +-
.../org/apache/juneau/dto/html5/Figcaption.java | 4 +-
.../org/apache/juneau/dto/html5/Figure.java | 4 +-
.../org/apache/juneau/dto/html5/Footer.java | 4 +-
.../java/org/apache/juneau/dto/html5/Form.java | 40 +-
.../java/org/apache/juneau/dto/html5/H1.java | 4 +-
.../java/org/apache/juneau/dto/html5/H2.java | 4 +-
.../java/org/apache/juneau/dto/html5/H3.java | 4 +-
.../java/org/apache/juneau/dto/html5/H4.java | 4 +-
.../java/org/apache/juneau/dto/html5/H5.java | 4 +-
.../java/org/apache/juneau/dto/html5/H6.java | 4 +-
.../java/org/apache/juneau/dto/html5/Head.java | 4 +-
.../org/apache/juneau/dto/html5/Header.java | 4 +-
.../java/org/apache/juneau/dto/html5/Hr.java | 4 +-
.../java/org/apache/juneau/dto/html5/Html.java | 8 +-
.../juneau/dto/html5/HtmlBeanDictionary.java | 4 +-
.../apache/juneau/dto/html5/HtmlBuilder.java | 430 +++++++++----------
.../apache/juneau/dto/html5/HtmlElement.java | 148 +++----
.../juneau/dto/html5/HtmlElementContainer.java | 22 +-
.../juneau/dto/html5/HtmlElementMixed.java | 22 +-
.../juneau/dto/html5/HtmlElementRawText.java | 10 +-
.../juneau/dto/html5/HtmlElementText.java | 10 +-
.../juneau/dto/html5/HtmlElementVoid.java | 6 +-
.../java/org/apache/juneau/dto/html5/I.java | 4 +-
.../org/apache/juneau/dto/html5/Iframe.java | 32 +-
.../java/org/apache/juneau/dto/html5/Img.java | 36 +-
.../java/org/apache/juneau/dto/html5/Input.java | 132 +++---
.../java/org/apache/juneau/dto/html5/Ins.java | 12 +-
.../java/org/apache/juneau/dto/html5/Kbd.java | 4 +-
.../org/apache/juneau/dto/html5/Keygen.java | 28 +-
.../java/org/apache/juneau/dto/html5/Label.java | 12 +-
.../org/apache/juneau/dto/html5/Legend.java | 4 +-
.../java/org/apache/juneau/dto/html5/Li.java | 4 +-
.../java/org/apache/juneau/dto/html5/Link.java | 36 +-
.../java/org/apache/juneau/dto/html5/Main.java | 4 +-
.../java/org/apache/juneau/dto/html5/Map.java | 8 +-
.../java/org/apache/juneau/dto/html5/Mark.java | 4 +-
.../java/org/apache/juneau/dto/html5/Meta.java | 20 +-
.../java/org/apache/juneau/dto/html5/Meter.java | 28 +-
.../java/org/apache/juneau/dto/html5/Nav.java | 4 +-
.../org/apache/juneau/dto/html5/Noscript.java | 4 +-
.../org/apache/juneau/dto/html5/Object2.java | 36 +-
.../java/org/apache/juneau/dto/html5/Ol.java | 16 +-
.../org/apache/juneau/dto/html5/Optgroup.java | 12 +-
.../org/apache/juneau/dto/html5/Option.java | 20 +-
.../org/apache/juneau/dto/html5/Output.java | 16 +-
.../java/org/apache/juneau/dto/html5/P.java | 4 +-
.../java/org/apache/juneau/dto/html5/Param.java | 12 +-
.../java/org/apache/juneau/dto/html5/Pre.java | 4 +-
.../org/apache/juneau/dto/html5/Progress.java | 12 +-
.../java/org/apache/juneau/dto/html5/Q.java | 8 +-
.../java/org/apache/juneau/dto/html5/Rb.java | 4 +-
.../java/org/apache/juneau/dto/html5/Rp.java | 4 +-
.../java/org/apache/juneau/dto/html5/Rt.java | 4 +-
.../java/org/apache/juneau/dto/html5/Rtc.java | 4 +-
.../java/org/apache/juneau/dto/html5/Ruby.java | 4 +-
.../java/org/apache/juneau/dto/html5/S.java | 4 +-
.../java/org/apache/juneau/dto/html5/Samp.java | 4 +-
.../org/apache/juneau/dto/html5/Script.java | 32 +-
.../org/apache/juneau/dto/html5/Section.java | 4 +-
.../org/apache/juneau/dto/html5/Select.java | 32 +-
.../java/org/apache/juneau/dto/html5/Small.java | 4 +-
.../org/apache/juneau/dto/html5/Source.java | 16 +-
.../java/org/apache/juneau/dto/html5/Span.java | 4 +-
.../org/apache/juneau/dto/html5/Strong.java | 4 +-
.../java/org/apache/juneau/dto/html5/Style.java | 12 +-
.../java/org/apache/juneau/dto/html5/Sub.java | 4 +-
.../java/org/apache/juneau/dto/html5/Sup.java | 4 +-
.../java/org/apache/juneau/dto/html5/Table.java | 6 +-
.../java/org/apache/juneau/dto/html5/Tbody.java | 4 +-
.../java/org/apache/juneau/dto/html5/Td.java | 16 +-
.../org/apache/juneau/dto/html5/Template.java | 4 +-
.../org/apache/juneau/dto/html5/Textarea.java | 64 +--
.../java/org/apache/juneau/dto/html5/Tfoot.java | 4 +-
.../java/org/apache/juneau/dto/html5/Th.java | 28 +-
.../java/org/apache/juneau/dto/html5/Thead.java | 4 +-
.../java/org/apache/juneau/dto/html5/Time.java | 8 +-
.../java/org/apache/juneau/dto/html5/Title.java | 4 +-
.../java/org/apache/juneau/dto/html5/Tr.java | 4 +-
.../java/org/apache/juneau/dto/html5/Track.java | 28 +-
.../java/org/apache/juneau/dto/html5/U.java | 4 +-
.../java/org/apache/juneau/dto/html5/Ul.java | 4 +-
.../java/org/apache/juneau/dto/html5/Var.java | 4 +-
.../java/org/apache/juneau/dto/html5/Video.java | 52 +--
.../java/org/apache/juneau/dto/html5/Wbr.java | 4 +-
.../apache/juneau/dto/jsonschema/JsonType.java | 8 +-
.../juneau/dto/jsonschema/JsonTypeArray.java | 6 +-
.../apache/juneau/dto/jsonschema/Schema.java | 244 +++++------
.../juneau/dto/jsonschema/SchemaArray.java | 6 +-
.../apache/juneau/dto/jsonschema/SchemaMap.java | 28 +-
.../juneau/dto/jsonschema/SchemaProperty.java | 6 +-
.../jsonschema/SchemaPropertySimpleArray.java | 8 +-
.../apache/juneau/dto/jsonschema/SchemaRef.java | 12 +-
.../org/apache/juneau/dto/swagger/Contact.java | 36 +-
.../dto/swagger/ExternalDocumentation.java | 30 +-
.../apache/juneau/dto/swagger/HeaderInfo.java | 194 ++++-----
.../org/apache/juneau/dto/swagger/Info.java | 64 +--
.../org/apache/juneau/dto/swagger/Items.java | 186 ++++----
.../org/apache/juneau/dto/swagger/License.java | 30 +-
.../apache/juneau/dto/swagger/Operation.java | 178 ++++----
.../juneau/dto/swagger/ParameterInfo.java | 280 ++++++------
.../apache/juneau/dto/swagger/ResponseInfo.java | 66 +--
.../apache/juneau/dto/swagger/SchemaInfo.java | 198 ++++-----
.../juneau/dto/swagger/SecurityScheme.java | 110 ++---
.../org/apache/juneau/dto/swagger/Swagger.java | 274 ++++++------
.../juneau/dto/swagger/SwaggerBuilder.java | 64 +--
.../juneau/dto/swagger/SwaggerElement.java | 6 +-
.../java/org/apache/juneau/dto/swagger/Tag.java | 40 +-
.../java/org/apache/juneau/dto/swagger/Xml.java | 66 +--
.../org/apache/juneau/jena/RdfBeanMeta.java | 6 +-
.../apache/juneau/jena/RdfBeanPropertyMeta.java | 8 +-
.../org/apache/juneau/jena/RdfClassMeta.java | 8 +-
.../java/org/apache/juneau/jena/RdfCommon.java | 14 +-
.../java/org/apache/juneau/jena/RdfParser.java | 10 +-
.../apache/juneau/jena/RdfParserBuilder.java | 4 +-
.../apache/juneau/jena/RdfParserSession.java | 4 +-
.../org/apache/juneau/jena/RdfSerializer.java | 14 +-
.../juneau/jena/RdfSerializerBuilder.java | 4 +-
.../juneau/jena/RdfSerializerSession.java | 6 +-
.../java/org/apache/juneau/jena/RdfUtils.java | 2 +-
.../juneau/jena/annotation/RdfSchema.java | 8 +-
.../java/org/apache/juneau/BeanContext.java | 281 ++++++------
.../org/apache/juneau/BeanContextBuilder.java | 205 ++++-----
.../org/apache/juneau/BeanDictionaryList.java | 8 +-
.../org/apache/juneau/BeanDictionaryMap.java | 10 +-
.../main/java/org/apache/juneau/BeanMap.java | 99 ++---
.../java/org/apache/juneau/BeanMapEntry.java | 28 +-
.../main/java/org/apache/juneau/BeanMeta.java | 43 +-
.../org/apache/juneau/BeanMetaExtended.java | 6 +-
.../org/apache/juneau/BeanMetaFiltered.java | 6 +-
.../org/apache/juneau/BeanPropertyMeta.java | 62 +--
.../apache/juneau/BeanPropertyMetaExtended.java | 6 +-
.../org/apache/juneau/BeanPropertyValue.java | 12 +-
.../juneau/BeanProxyInvocationHandler.java | 6 +-
.../java/org/apache/juneau/BeanRegistry.java | 12 +-
.../org/apache/juneau/BeanRuntimeException.java | 10 +-
.../java/org/apache/juneau/BeanSession.java | 128 +++---
.../java/org/apache/juneau/BeanSessionArgs.java | 8 +-
.../main/java/org/apache/juneau/ClassMeta.java | 186 ++++----
.../org/apache/juneau/ClassMetaExtended.java | 8 +-
.../java/org/apache/juneau/ConfigException.java | 2 +-
.../main/java/org/apache/juneau/Context.java | 20 +-
.../java/org/apache/juneau/ContextBuilder.java | 20 +-
.../apache/juneau/ContextRuntimeException.java | 10 +-
.../main/java/org/apache/juneau/Delegate.java | 8 +-
.../org/apache/juneau/FormattedException.java | 6 +-
.../FormattedIllegalArgumentException.java | 4 +-
.../juneau/FormattedRuntimeException.java | 4 +-
.../juneau/InvalidDataConversionException.java | 2 +-
.../main/java/org/apache/juneau/ObjectList.java | 178 ++++----
.../main/java/org/apache/juneau/ObjectMap.java | 312 +++++++-------
.../java/org/apache/juneau/PropertyNamer.java | 6 +-
.../org/apache/juneau/PropertyNamerDLC.java | 4 +-
.../org/apache/juneau/PropertyNamerDefault.java | 6 +-
.../org/apache/juneau/PropertyNamerULC.java | 4 +-
.../java/org/apache/juneau/PropertyStore.java | 6 +-
.../org/apache/juneau/PropertyStoreBuilder.java | 16 +-
.../main/java/org/apache/juneau/Session.java | 26 +-
.../java/org/apache/juneau/SessionArgs.java | 2 +-
.../src/main/java/org/apache/juneau/Setter.java | 2 +-
.../main/java/org/apache/juneau/Streamable.java | 6 +-
.../main/java/org/apache/juneau/UriContext.java | 54 +--
.../java/org/apache/juneau/UriResolver.java | 18 +-
.../main/java/org/apache/juneau/Visibility.java | 32 +-
.../main/java/org/apache/juneau/Writable.java | 6 +-
.../java/org/apache/juneau/annotation/Bean.java | 53 +--
.../juneau/annotation/BeanConstructor.java | 21 +-
.../apache/juneau/annotation/BeanIgnore.java | 15 +-
.../apache/juneau/annotation/BeanProperty.java | 77 ++--
.../apache/juneau/annotation/NameProperty.java | 14 +-
.../juneau/annotation/ParentProperty.java | 16 +-
.../java/org/apache/juneau/annotation/Swap.java | 31 +-
.../org/apache/juneau/annotation/Swaps.java | 11 +-
.../java/org/apache/juneau/annotation/URI.java | 13 +-
.../java/org/apache/juneau/csv/CsvParser.java | 2 +-
.../org/apache/juneau/csv/CsvParserBuilder.java | 2 +-
.../org/apache/juneau/csv/CsvParserSession.java | 4 +-
.../org/apache/juneau/csv/CsvSerializer.java | 2 +-
.../apache/juneau/csv/CsvSerializerBuilder.java | 2 +-
.../apache/juneau/csv/CsvSerializerSession.java | 4 +-
.../org/apache/juneau/encoders/Encoder.java | 15 +-
.../apache/juneau/encoders/EncoderGroup.java | 37 +-
.../juneau/encoders/EncoderGroupBuilder.java | 14 +-
.../apache/juneau/encoders/EncoderMatch.java | 4 +-
.../java/org/apache/juneau/html/AnchorText.java | 2 +-
.../juneau/html/HtmlBeanPropertyMeta.java | 22 +-
.../org/apache/juneau/html/HtmlClassMeta.java | 14 +-
.../apache/juneau/html/HtmlDocSerializer.java | 126 +++---
.../juneau/html/HtmlDocSerializerSession.java | 32 +-
.../org/apache/juneau/html/HtmlDocTemplate.java | 34 +-
.../juneau/html/HtmlDocTemplateBasic.java | 2 +-
.../java/org/apache/juneau/html/HtmlLink.java | 6 +-
.../java/org/apache/juneau/html/HtmlParser.java | 18 +-
.../apache/juneau/html/HtmlParserBuilder.java | 2 +-
.../apache/juneau/html/HtmlParserSession.java | 14 +-
.../java/org/apache/juneau/html/HtmlRender.java | 46 +-
.../juneau/html/HtmlSchemaDocSerializer.java | 27 +-
.../html/HtmlSchemaDocSerializerSession.java | 6 +-
.../org/apache/juneau/html/HtmlSerializer.java | 81 ++--
.../juneau/html/HtmlSerializerBuilder.java | 22 +-
.../juneau/html/HtmlSerializerSession.java | 18 +-
.../juneau/html/HtmlStrippedDocSerializer.java | 23 +-
.../html/HtmlStrippedDocSerializerSession.java | 4 +-
.../java/org/apache/juneau/html/HtmlWriter.java | 4 +-
.../apache/juneau/html/SimpleHtmlWriter.java | 2 +-
.../org/apache/juneau/html/annotation/Html.java | 24 +-
.../java/org/apache/juneau/http/Accept.java | 52 +--
.../org/apache/juneau/http/AcceptCharset.java | 24 +-
.../org/apache/juneau/http/AcceptEncoding.java | 26 +-
.../org/apache/juneau/http/AcceptLanguage.java | 36 +-
.../org/apache/juneau/http/AcceptRanges.java | 20 +-
.../main/java/org/apache/juneau/http/Age.java | 22 +-
.../main/java/org/apache/juneau/http/Allow.java | 26 +-
.../org/apache/juneau/http/Authorization.java | 22 +-
.../org/apache/juneau/http/CacheControl.java | 22 +-
.../java/org/apache/juneau/http/Connection.java | 30 +-
.../java/org/apache/juneau/http/Constants.java | 2 +-
.../org/apache/juneau/http/ContentEncoding.java | 22 +-
.../apache/juneau/http/ContentEncodingEnum.java | 2 +-
.../org/apache/juneau/http/ContentLanguage.java | 22 +-
.../org/apache/juneau/http/ContentLength.java | 20 +-
.../org/apache/juneau/http/ContentLocation.java | 22 +-
.../org/apache/juneau/http/ContentRange.java | 36 +-
.../org/apache/juneau/http/ContentType.java | 18 +-
.../main/java/org/apache/juneau/http/Date.java | 22 +-
.../main/java/org/apache/juneau/http/ETag.java | 16 +-
.../org/apache/juneau/http/EntityValidator.java | 12 +-
.../java/org/apache/juneau/http/Expect.java | 24 +-
.../java/org/apache/juneau/http/Expires.java | 30 +-
.../main/java/org/apache/juneau/http/From.java | 22 +-
.../java/org/apache/juneau/http/HeaderDate.java | 8 +-
.../juneau/http/HeaderEntityValidator.java | 8 +-
.../juneau/http/HeaderEntityValidatorArray.java | 8 +-
.../java/org/apache/juneau/http/HeaderEnum.java | 14 +-
.../org/apache/juneau/http/HeaderInteger.java | 10 +-
.../apache/juneau/http/HeaderRangeArray.java | 12 +-
.../org/apache/juneau/http/HeaderString.java | 14 +-
.../apache/juneau/http/HeaderStringArray.java | 14 +-
.../java/org/apache/juneau/http/HeaderUri.java | 12 +-
.../main/java/org/apache/juneau/http/Host.java | 20 +-
.../java/org/apache/juneau/http/HttpMethod.java | 6 +-
.../org/apache/juneau/http/HttpMethodName.java | 2 +-
.../java/org/apache/juneau/http/IfMatch.java | 30 +-
.../org/apache/juneau/http/IfModifiedSince.java | 28 +-
.../org/apache/juneau/http/IfNoneMatch.java | 30 +-
.../java/org/apache/juneau/http/IfRange.java | 22 +-
.../apache/juneau/http/IfUnmodifiedSince.java | 24 +-
.../org/apache/juneau/http/LastModified.java | 24 +-
.../java/org/apache/juneau/http/Location.java | 18 +-
.../org/apache/juneau/http/MaxForwards.java | 20 +-
.../java/org/apache/juneau/http/MediaType.java | 32 +-
.../org/apache/juneau/http/MediaTypeRange.java | 36 +-
.../java/org/apache/juneau/http/Pragma.java | 22 +-
.../apache/juneau/http/ProxyAuthenticate.java | 16 +-
.../apache/juneau/http/ProxyAuthorization.java | 16 +-
.../main/java/org/apache/juneau/http/Range.java | 42 +-
.../java/org/apache/juneau/http/Referer.java | 18 +-
.../java/org/apache/juneau/http/RetryAfter.java | 22 +-
.../java/org/apache/juneau/http/Server.java | 20 +-
.../org/apache/juneau/http/StringRange.java | 42 +-
.../main/java/org/apache/juneau/http/TE.java | 24 +-
.../java/org/apache/juneau/http/Trailer.java | 20 +-
.../apache/juneau/http/TransferEncoding.java | 22 +-
.../java/org/apache/juneau/http/Upgrade.java | 26 +-
.../java/org/apache/juneau/http/UserAgent.java | 16 +-
.../main/java/org/apache/juneau/http/Vary.java | 20 +-
.../main/java/org/apache/juneau/http/Via.java | 36 +-
.../java/org/apache/juneau/http/Warning.java | 34 +-
.../org/apache/juneau/http/WwwAuthenticate.java | 16 +-
.../apache/juneau/httppart/HttpPartParser.java | 4 +-
.../juneau/httppart/HttpPartSerializer.java | 8 +-
.../httppart/SimpleUonPartSerializer.java | 2 +-
.../SimpleUonPartSerializerBuilder.java | 2 +-
.../apache/juneau/httppart/UonPartParser.java | 2 +-
.../juneau/httppart/UonPartParserBuilder.java | 2 +-
.../juneau/httppart/UonPartSerializer.java | 2 +-
.../httppart/UonPartSerializerBuilder.java | 2 +-
.../org/apache/juneau/internal/ArrayUtils.java | 50 +--
.../org/apache/juneau/internal/AsciiMap.java | 10 +-
.../org/apache/juneau/internal/AsciiSet.java | 8 +-
.../apache/juneau/internal/ByteArrayCache.java | 8 +-
.../juneau/internal/ByteArrayInOutStream.java | 2 +-
.../java/org/apache/juneau/internal/Cache.java | 10 +-
.../juneau/internal/CharSequenceReader.java | 2 +-
.../org/apache/juneau/internal/ClassUtils.java | 112 ++---
.../apache/juneau/internal/CollectionUtils.java | 12 +-
.../org/apache/juneau/internal/DateUtils.java | 26 +-
.../apache/juneau/internal/DelegateBeanMap.java | 12 +-
.../apache/juneau/internal/DelegateList.java | 4 +-
.../org/apache/juneau/internal/DelegateMap.java | 8 +-
.../org/apache/juneau/internal/FileUtils.java | 24 +-
.../org/apache/juneau/internal/FilteredMap.java | 4 +-
.../org/apache/juneau/internal/HashCode.java | 18 +-
.../org/apache/juneau/internal/IOUtils.java | 80 ++--
.../apache/juneau/internal/IdentityList.java | 9 +-
.../apache/juneau/internal/JuneauLogger.java | 36 +-
.../org/apache/juneau/internal/KeywordSet.java | 4 +-
.../apache/juneau/internal/MultiIterable.java | 6 +-
.../org/apache/juneau/internal/MultiSet.java | 8 +-
.../org/apache/juneau/internal/ObjectUtils.java | 16 +-
.../java/org/apache/juneau/internal/Pair.java | 8 +-
.../apache/juneau/internal/ReflectionUtils.java | 22 +-
.../org/apache/juneau/internal/SimpleMap.java | 8 +-
.../juneau/internal/StringBuilderWriter.java | 6 +-
.../org/apache/juneau/internal/StringUtils.java | 170 ++++----
.../org/apache/juneau/internal/SystemUtils.java | 6 +-
.../apache/juneau/internal/TeeOutputStream.java | 12 +-
.../org/apache/juneau/internal/TeeWriter.java | 12 +-
.../apache/juneau/internal/ThrowableUtils.java | 10 +-
.../java/org/apache/juneau/internal/Utils.java | 2 +-
.../org/apache/juneau/internal/Version.java | 16 +-
.../apache/juneau/internal/VersionRange.java | 6 +-
.../org/apache/juneau/internal/WrappedMap.java | 4 +-
.../java/org/apache/juneau/jso/JsoParser.java | 11 +-
.../org/apache/juneau/jso/JsoParserBuilder.java | 2 +-
.../org/apache/juneau/jso/JsoParserSession.java | 4 +-
.../org/apache/juneau/jso/JsoSerializer.java | 14 +-
.../apache/juneau/jso/JsoSerializerBuilder.java | 2 +-
.../apache/juneau/jso/JsoSerializerSession.java | 4 +-
.../org/apache/juneau/json/JsonClassMeta.java | 6 +-
.../java/org/apache/juneau/json/JsonParser.java | 32 +-
.../apache/juneau/json/JsonParserBuilder.java | 2 +-
.../apache/juneau/json/JsonParserSession.java | 10 +-
.../juneau/json/JsonSchemaSerializer.java | 20 +-
.../json/JsonSchemaSerializerBuilder.java | 2 +-
.../json/JsonSchemaSerializerSession.java | 6 +-
.../org/apache/juneau/json/JsonSerializer.java | 62 +--
.../juneau/json/JsonSerializerBuilder.java | 18 +-
.../juneau/json/JsonSerializerSession.java | 8 +-
.../java/org/apache/juneau/json/JsonWriter.java | 17 +-
.../org/apache/juneau/json/annotation/Json.java | 14 +-
.../juneau/msgpack/MsgPackInputStream.java | 13 +-
.../juneau/msgpack/MsgPackOutputStream.java | 7 +-
.../apache/juneau/msgpack/MsgPackParser.java | 11 +-
.../juneau/msgpack/MsgPackParserBuilder.java | 2 +-
.../juneau/msgpack/MsgPackParserSession.java | 4 +-
.../juneau/msgpack/MsgPackSerializer.java | 18 +-
.../msgpack/MsgPackSerializerBuilder.java | 2 +-
.../msgpack/MsgPackSerializerSession.java | 6 +-
.../apache/juneau/parser/InputStreamParser.java | 9 +-
.../juneau/parser/InputStreamParserSession.java | 6 +-
.../apache/juneau/parser/ParseException.java | 14 +-
.../java/org/apache/juneau/parser/Parser.java | 112 ++---
.../org/apache/juneau/parser/ParserBuilder.java | 36 +-
.../org/apache/juneau/parser/ParserGroup.java | 45 +-
.../juneau/parser/ParserGroupBuilder.java | 42 +-
.../apache/juneau/parser/ParserListener.java | 6 +-
.../org/apache/juneau/parser/ParserMatch.java | 6 +-
.../org/apache/juneau/parser/ParserPipe.java | 32 +-
.../org/apache/juneau/parser/ParserReader.java | 58 +--
.../org/apache/juneau/parser/ParserSession.java | 116 ++---
.../apache/juneau/parser/ParserSessionArgs.java | 6 +-
.../org/apache/juneau/parser/ReaderParser.java | 9 +-
.../juneau/parser/ReaderParserSession.java | 6 +-
.../juneau/plaintext/PlainTextParser.java | 25 +-
.../plaintext/PlainTextParserBuilder.java | 2 +-
.../plaintext/PlainTextParserSession.java | 2 +-
.../juneau/plaintext/PlainTextSerializer.java | 25 +-
.../plaintext/PlainTextSerializerBuilder.java | 2 +-
.../plaintext/PlainTextSerializerSession.java | 4 +-
.../java/org/apache/juneau/remoteable/Body.java | 16 +-
.../org/apache/juneau/remoteable/FormData.java | 70 +--
.../apache/juneau/remoteable/FormDataIfNE.java | 10 +-
.../org/apache/juneau/remoteable/Header.java | 62 +--
.../apache/juneau/remoteable/HeaderIfNE.java | 10 +-
.../java/org/apache/juneau/remoteable/Path.java | 60 +--
.../org/apache/juneau/remoteable/Query.java | 68 +--
.../org/apache/juneau/remoteable/QueryIfNE.java | 10 +-
.../apache/juneau/remoteable/RemoteMethod.java | 12 +-
.../juneau/remoteable/RemoteMethodArg.java | 4 +-
.../apache/juneau/remoteable/Remoteable.java | 10 +-
.../juneau/remoteable/RemoteableMeta.java | 8 +-
.../remoteable/RemoteableMetadataException.java | 4 +-
.../juneau/remoteable/RemoteableMethodMeta.java | 26 +-
.../apache/juneau/remoteable/RequestBean.java | 40 +-
.../serializer/OutputStreamSerializer.java | 6 +-
.../OutputStreamSerializerSession.java | 13 +-
.../juneau/serializer/SerializeException.java | 12 +-
.../apache/juneau/serializer/Serializer.java | 141 +++---
.../juneau/serializer/SerializerBuilder.java | 130 +++---
.../juneau/serializer/SerializerGroup.java | 51 +--
.../serializer/SerializerGroupBuilder.java | 126 +++---
.../juneau/serializer/SerializerListener.java | 4 +-
.../juneau/serializer/SerializerMatch.java | 4 +-
.../juneau/serializer/SerializerPipe.java | 26 +-
.../juneau/serializer/SerializerSession.java | 108 ++---
.../serializer/SerializerSessionArgs.java | 8 +-
.../juneau/serializer/SerializerWriter.java | 54 +--
.../juneau/serializer/WriterSerializer.java | 12 +-
.../serializer/WriterSerializerSession.java | 15 +-
.../apache/juneau/soap/SoapXmlSerializer.java | 23 +-
.../juneau/soap/SoapXmlSerializerBuilder.java | 4 +-
.../juneau/soap/SoapXmlSerializerSession.java | 4 +-
.../transform/AnnotationBeanFilterBuilder.java | 2 +-
.../org/apache/juneau/transform/BeanFilter.java | 37 +-
.../juneau/transform/BeanFilterBuilder.java | 61 +--
.../transform/InterfaceBeanFilterBuilder.java | 2 +-
.../org/apache/juneau/transform/MapSwap.java | 4 +-
.../org/apache/juneau/transform/PojoSwap.java | 97 ++---
.../apache/juneau/transform/PropertyFilter.java | 112 ++---
.../org/apache/juneau/transform/StringSwap.java | 6 +-
.../org/apache/juneau/transform/Surrogate.java | 34 +-
.../apache/juneau/transform/SurrogateSwap.java | 8 +-
.../juneau/transforms/BeanStringSwap.java | 6 +-
.../apache/juneau/transforms/CalendarSwap.java | 58 +--
.../org/apache/juneau/transforms/DateSwap.java | 58 +--
.../apache/juneau/transforms/IteratorSwap.java | 2 +-
.../apache/juneau/transforms/ReaderSwap.java | 15 +-
.../juneau/transforms/StringFormatSwap.java | 2 +-
.../transforms/XMLGregorianCalendarSwap.java | 4 +-
.../java/org/apache/juneau/uon/ParamFormat.java | 8 +-
.../java/org/apache/juneau/uon/UonParser.java | 30 +-
.../org/apache/juneau/uon/UonParserBuilder.java | 8 +-
.../org/apache/juneau/uon/UonParserSession.java | 20 +-
.../java/org/apache/juneau/uon/UonReader.java | 6 +-
.../org/apache/juneau/uon/UonSerializer.java | 59 +--
.../apache/juneau/uon/UonSerializerBuilder.java | 24 +-
.../apache/juneau/uon/UonSerializerSession.java | 8 +-
.../java/org/apache/juneau/uon/UonUtils.java | 4 +-
.../java/org/apache/juneau/uon/UonWriter.java | 15 +-
.../urlencoding/UrlEncodingClassMeta.java | 6 +-
.../juneau/urlencoding/UrlEncodingParser.java | 36 +-
.../urlencoding/UrlEncodingParserBuilder.java | 10 +-
.../urlencoding/UrlEncodingParserSession.java | 6 +-
.../urlencoding/UrlEncodingSerializer.java | 63 +--
.../UrlEncodingSerializerBuilder.java | 10 +-
.../UrlEncodingSerializerSession.java | 4 +-
.../urlencoding/annotation/UrlEncoding.java | 2 +-
.../java/org/apache/juneau/utils/AList.java | 8 +-
.../main/java/org/apache/juneau/utils/AMap.java | 6 +-
.../main/java/org/apache/juneau/utils/ASet.java | 8 +-
.../main/java/org/apache/juneau/utils/Args.java | 64 +--
.../org/apache/juneau/utils/CalendarUtils.java | 62 +--
.../utils/ClasspathResourceFinderBasic.java | 2 +-
.../utils/ClasspathResourceFinderSimple.java | 14 +-
.../juneau/utils/ClasspathResourceManager.java | 12 +-
.../java/org/apache/juneau/utils/IOPipe.java | 24 +-
.../org/apache/juneau/utils/ManifestFile.java | 8 +-
.../org/apache/juneau/utils/MessageBundle.java | 40 +-
.../org/apache/juneau/utils/MetadataMap.java | 6 +-
.../apache/juneau/utils/PojoIntrospector.java | 10 +-
.../java/org/apache/juneau/utils/PojoMerge.java | 35 +-
.../java/org/apache/juneau/utils/PojoQuery.java | 83 ++--
.../java/org/apache/juneau/utils/PojoRest.java | 192 ++++-----
.../apache/juneau/utils/PojoRestException.java | 10 +-
.../org/apache/juneau/utils/ProcBuilder.java | 68 +--
.../org/apache/juneau/utils/SearchArgs.java | 80 ++--
.../org/apache/juneau/utils/StringMessage.java | 4 +-
.../org/apache/juneau/utils/StringObject.java | 10 +-
.../org/apache/juneau/utils/ZipFileList.java | 16 +-
.../java/org/apache/juneau/xml/Namespace.java | 18 +-
.../java/org/apache/juneau/xml/XmlBeanMeta.java | 30 +-
.../apache/juneau/xml/XmlBeanPropertyMeta.java | 10 +-
.../org/apache/juneau/xml/XmlClassMeta.java | 12 +-
.../org/apache/juneau/xml/XmlDocSerializer.java | 25 +-
.../juneau/xml/XmlDocSerializerSession.java | 4 +-
.../apache/juneau/xml/XmlParseException.java | 2 +-
.../java/org/apache/juneau/xml/XmlParser.java | 43 +-
.../org/apache/juneau/xml/XmlParserBuilder.java | 30 +-
.../org/apache/juneau/xml/XmlParserSession.java | 28 +-
.../java/org/apache/juneau/xml/XmlReader.java | 6 +-
.../juneau/xml/XmlSchemaDocSerializer.java | 20 +-
.../xml/XmlSchemaDocSerializerSession.java | 4 +-
.../apache/juneau/xml/XmlSchemaSerializer.java | 20 +-
.../juneau/xml/XmlSchemaSerializerBuilder.java | 2 +-
.../juneau/xml/XmlSchemaSerializerSession.java | 6 +-
.../org/apache/juneau/xml/XmlSerializer.java | 85 ++--
.../apache/juneau/xml/XmlSerializerBuilder.java | 38 +-
.../apache/juneau/xml/XmlSerializerSession.java | 18 +-
.../java/org/apache/juneau/xml/XmlUtils.java | 30 +-
.../java/org/apache/juneau/xml/XmlWriter.java | 87 ++--
.../org/apache/juneau/xml/annotation/Xml.java | 30 +-
.../apache/juneau/xml/annotation/XmlFormat.java | 52 +--
.../org/apache/juneau/xml/annotation/XmlNs.java | 2 +-
.../apache/juneau/xml/annotation/XmlSchema.java | 18 +-
.../apache/juneau/yaml/proto/YamlClassMeta.java | 4 +-
.../apache/juneau/yaml/proto/YamlParser.java | 32 +-
.../juneau/yaml/proto/YamlParserBuilder.java | 2 +-
.../juneau/yaml/proto/YamlParserSession.java | 10 +-
.../juneau/yaml/proto/YamlSerializer.java | 48 ++-
.../yaml/proto/YamlSerializerBuilder.java | 12 +-
.../yaml/proto/YamlSerializerSession.java | 8 +-
.../apache/juneau/yaml/proto/YamlWriter.java | 17 +-
.../juneau/yaml/proto/annotation/Yaml.java | 4 +-
.../org/apache/juneau/svl/DefaultingVar.java | 8 +-
.../main/java/org/apache/juneau/svl/MapVar.java | 4 +-
.../juneau/svl/MultipartResolvingVar.java | 8 +-
.../org/apache/juneau/svl/MultipartVar.java | 8 +-
.../apache/juneau/svl/ResolvingObjectMap.java | 6 +-
.../java/org/apache/juneau/svl/SimpleVar.java | 8 +-
.../java/org/apache/juneau/svl/StreamedVar.java | 8 +-
.../main/java/org/apache/juneau/svl/Var.java | 24 +-
.../java/org/apache/juneau/svl/VarResolver.java | 67 +--
.../apache/juneau/svl/VarResolverBuilder.java | 16 +-
.../apache/juneau/svl/VarResolverContext.java | 14 +-
.../apache/juneau/svl/VarResolverSession.java | 32 +-
.../org/apache/juneau/svl/vars/ArgsVar.java | 14 +-
.../juneau/svl/vars/CoalesceAndRecurseVar.java | 2 +-
.../org/apache/juneau/svl/vars/CoalesceVar.java | 2 +-
.../apache/juneau/svl/vars/EnvVariablesVar.java | 10 +-
.../java/org/apache/juneau/svl/vars/IfVar.java | 12 +-
.../apache/juneau/svl/vars/ManifestFileVar.java | 14 +-
.../org/apache/juneau/svl/vars/SwitchVar.java | 10 +-
.../juneau/svl/vars/SystemPropertiesVar.java | 10 +-
.../core/json/JsonConfigurationExample.java | 4 +-
.../examples/core/json/JsonSimpleExample.java | 4 +-
.../apache/juneau/examples/core/pojo/Pojo.java | 4 +-
.../juneau/examples/core/rdf/RdfExample.java | 4 +-
.../juneau/examples/rest/RestTestcase.java | 2 +-
.../juneau/microservice/Microservice.java | 112 ++---
.../apache/juneau/microservice/Resource.java | 2 +-
.../juneau/microservice/RestMicroservice.java | 19 +-
.../microservice/resources/ConfigResource.java | 16 +-
.../resources/DirectoryResource.java | 12 +-
.../resources/LogEntryFormatter.java | 8 +-
.../microservice/resources/LogParser.java | 4 +-
.../microservice/resources/LogsResource.java | 10 +-
.../resources/ShutdownResource.java | 2 +-
.../juneau/rest/test/HtmlDocLinksResource.java | 2 +-
.../juneau/rest/test/pojos/Constants.java | 2 +-
.../org/apache/juneau/rest/test/GzipTest.java | 2 +-
.../apache/juneau/rest/test/RestTestcase.java | 2 +-
.../juneau/rest/client/AllowAllRedirects.java | 5 +-
.../apache/juneau/rest/client/DateHeader.java | 4 +-
.../apache/juneau/rest/client/HttpMethod.java | 2 +-
.../juneau/rest/client/NameValuePairs.java | 14 +-
.../juneau/rest/client/ResponsePattern.java | 20 +-
.../org/apache/juneau/rest/client/RestCall.java | 397 +++++++++--------
.../juneau/rest/client/RestCallException.java | 30 +-
.../juneau/rest/client/RestCallInterceptor.java | 10 +-
.../juneau/rest/client/RestCallLogger.java | 6 +-
.../apache/juneau/rest/client/RestClient.java | 134 +++---
.../juneau/rest/client/RestClientBuilder.java | 348 +++++++--------
.../juneau/rest/client/RestRequestEntity.java | 2 +-
.../org/apache/juneau/rest/client/RetryOn.java | 6 +-
.../org/apache/juneau/rest/client/SSLOpts.java | 24 +-
.../rest/client/SerializedNameValuePair.java | 4 +-
.../rest/client/SimpleX509TrustManager.java | 2 +-
.../apache/juneau/rest/jaxrs/BaseProvider.java | 2 +-
.../juneau/rest/jaxrs/JuneauProvider.java | 5 +-
.../juneau/rest/ClientVersionMatcher.java | 4 +-
.../org/apache/juneau/rest/HtmlDocBuilder.java | 132 +++---
.../org/apache/juneau/rest/ReaderResource.java | 28 +-
.../java/org/apache/juneau/rest/Redirect.java | 30 +-
.../org/apache/juneau/rest/RequestBody.java | 54 +--
.../org/apache/juneau/rest/RequestFormData.java | 70 +--
.../org/apache/juneau/rest/RequestHeaders.java | 224 +++++-----
.../apache/juneau/rest/RequestPathMatch.java | 40 +-
.../org/apache/juneau/rest/RequestQuery.java | 90 ++--
.../org/apache/juneau/rest/ResponseHandler.java | 16 +-
.../org/apache/juneau/rest/RestCallHandler.java | 44 +-
.../org/apache/juneau/rest/RestCallRouter.java | 6 +-
.../org/apache/juneau/rest/RestContext.java | 350 +++++++--------
.../apache/juneau/rest/RestContextBuilder.java | 250 +++++------
.../org/apache/juneau/rest/RestConverter.java | 22 +-
.../org/apache/juneau/rest/RestException.java | 20 +-
.../java/org/apache/juneau/rest/RestGuard.java | 35 +-
.../apache/juneau/rest/RestInfoProvider.java | 92 ++--
.../org/apache/juneau/rest/RestJavaMethod.java | 2 +-
.../java/org/apache/juneau/rest/RestLogger.java | 54 +--
.../org/apache/juneau/rest/RestMatcher.java | 20 +-
.../java/org/apache/juneau/rest/RestParam.java | 16 +-
.../org/apache/juneau/rest/RestRequest.java | 144 +++----
.../juneau/rest/RestResourceResolver.java | 8 +-
.../juneau/rest/RestResourceResolverSimple.java | 8 +-
.../org/apache/juneau/rest/RestResponse.java | 60 +--
.../org/apache/juneau/rest/RestServlet.java | 26 +-
.../apache/juneau/rest/RestServletDefault.java | 14 +-
.../juneau/rest/RestServletException.java | 4 +-
.../juneau/rest/RestServletGroupDefault.java | 6 +-
.../java/org/apache/juneau/rest/RestUtils.java | 8 +-
.../apache/juneau/rest/StaticFileMapping.java | 3 +-
.../org/apache/juneau/rest/StreamResource.java | 24 +-
.../org/apache/juneau/rest/UrlPathPattern.java | 16 +-
.../org/apache/juneau/rest/annotation/Body.java | 6 +-
.../apache/juneau/rest/annotation/FormData.java | 18 +-
.../juneau/rest/annotation/HasFormData.java | 16 +-
.../apache/juneau/rest/annotation/HasQuery.java | 8 +-
.../apache/juneau/rest/annotation/Header.java | 8 +-
.../juneau/rest/annotation/HookEvent.java | 82 ++--
.../apache/juneau/rest/annotation/HtmlDoc.java | 94 ++--
.../apache/juneau/rest/annotation/Messages.java | 6 +-
.../apache/juneau/rest/annotation/Method.java | 6 +-
.../juneau/rest/annotation/MethodSwagger.java | 56 +--
.../juneau/rest/annotation/Parameter.java | 34 +-
.../org/apache/juneau/rest/annotation/Path.java | 14 +-
.../juneau/rest/annotation/PathRemainder.java | 4 +-
.../juneau/rest/annotation/Properties.java | 8 +-
.../apache/juneau/rest/annotation/Property.java | 6 +-
.../apache/juneau/rest/annotation/Query.java | 14 +-
.../juneau/rest/annotation/ResourceSwagger.java | 76 ++--
.../apache/juneau/rest/annotation/Response.java | 14 +-
.../apache/juneau/rest/annotation/RestHook.java | 14 +-
.../juneau/rest/annotation/RestMethod.java | 148 +++----
.../juneau/rest/annotation/RestResource.java | 162 +++----
.../juneau/rest/converters/Introspectable.java | 8 +-
.../juneau/rest/converters/Queryable.java | 6 +-
.../juneau/rest/converters/Traversable.java | 8 +-
.../juneau/rest/labels/BeanDescription.java | 8 +-
.../rest/labels/ChildResourceDescriptions.java | 6 +-
.../juneau/rest/labels/NameDescription.java | 12 +-
.../juneau/rest/labels/ResourceDescription.java | 4 +-
.../remoteable/RemoteableServiceProperties.java | 8 +-
.../rest/remoteable/RemoteableServlet.java | 16 +-
.../juneau/rest/response/DefaultHandler.java | 6 +-
.../rest/response/InputStreamHandler.java | 4 +-
.../juneau/rest/response/ReaderHandler.java | 2 +-
.../juneau/rest/response/StreamableHandler.java | 2 +-
.../juneau/rest/response/WritableHandler.java | 2 +-
.../response/ZipFileListResponseHandler.java | 4 +-
.../org/apache/juneau/rest/vars/FileVar.java | 14 +-
.../juneau/rest/vars/LocalizationVar.java | 10 +-
.../juneau/rest/vars/RequestAttributeVar.java | 11 +-
.../juneau/rest/vars/RequestFormDataVar.java | 9 +-
.../juneau/rest/vars/RequestHeaderVar.java | 11 +-
.../apache/juneau/rest/vars/RequestPathVar.java | 11 +-
.../juneau/rest/vars/RequestQueryVar.java | 11 +-
.../org/apache/juneau/rest/vars/RequestVar.java | 11 +-
.../apache/juneau/rest/vars/RestInfoVar.java | 11 +-
.../rest/vars/SerializedRequestAttrVar.java | 8 +-
.../juneau/rest/vars/ServletInitParamVar.java | 10 +-
.../apache/juneau/rest/vars/UrlEncodeVar.java | 8 +-
.../org/apache/juneau/rest/vars/UrlVar.java | 10 +-
.../org/apache/juneau/rest/vars/WidgetVar.java | 8 +-
.../juneau/rest/widget/ContentTypeMenuItem.java | 6 +-
.../juneau/rest/widget/MenuItemWidget.java | 16 +-
.../juneau/rest/widget/PoweredByApache.java | 8 +-
.../juneau/rest/widget/PoweredByJuneau.java | 8 +-
.../juneau/rest/widget/QueryMenuItem.java | 12 +-
.../juneau/rest/widget/StyleMenuItem.java | 4 +-
.../org/apache/juneau/rest/widget/Tooltip.java | 10 +-
.../org/apache/juneau/rest/widget/Widget.java | 72 ++--
703 files changed, 9522 insertions(+), 9423 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFile.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFile.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFile.java
index 15fb302..8544360 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFile.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFile.java
@@ -32,7 +32,7 @@ import org.apache.juneau.svl.*;
/**
* Implements the API for accessing the contents of a config file.
- *
+ *
* <p>
* Refer to <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.ini</a> for usage information.
*/
@@ -57,7 +57,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Retrieves an entry value from this config file.
- *
+ *
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
* @return The value, or the default value if the section or value doesn't exist.
@@ -66,7 +66,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Sets an entry value in this config file.
- *
+ *
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
* @param value The new value.
@@ -85,7 +85,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Identical to {@link #put(String, String, Object, Serializer, boolean, boolean)} except used when the value is a
* simple string to avoid having to catch a {@link SerializeException}.
- *
+ *
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
* @param value The new value.
@@ -98,7 +98,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Removes an entry from this config file.
- *
+ *
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
* @return The previous value, or <jk>null</jk> if the section or key did not previously exist.
@@ -108,7 +108,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Returns the current set of keys in the specified section.
- *
+ *
* @param sectionName The section name. Must not be <jk>null</jk>.
* @return The list of keys in the specified section, or <jk>null</jk> if section does not exist.
* @throws UnsupportedOperationException If config file is read only.
@@ -117,7 +117,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Reloads this config file object from the persisted file contents if the modified timestamp on the file has changed.
- *
+ *
* @return This object (for method chaining).
* @throws IOException If file could not be read, or file is not associated with this object.
* @throws UnsupportedOperationException If config file is read only.
@@ -126,7 +126,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Loads this config file object from the persisted file contents.
- *
+ *
* @return This object (for method chaining).
* @throws IOException If file could not be read, or file is not associated with this object.
* @throws UnsupportedOperationException If config file is read only.
@@ -135,7 +135,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Loads this config file object from the specified reader.
- *
+ *
* @param r The reader to read from.
* @return This object (for method chaining).
* @throws IOException If file could not be read, or file is not associated with this object.
@@ -145,7 +145,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Adds arbitrary lines to the specified config file section.
- *
+ *
* <p>
* The lines can be any of the following....
* <ul class='spaced-list'>
@@ -156,10 +156,10 @@ public abstract class ConfigFile implements Map<String,Section> {
* <li>
* <js>" foobar "</js> - Anything else (interpreted as a comment).
* </ul>
- *
+ *
* <p>
* If the section does not exist, it will automatically be created.
- *
+ *
* @param section The name of the section to add lines to, or <jk>null</jk> to add to the beginning unnamed section.
* @param lines The lines to add to the section.
* @return This object (for method chaining).
@@ -169,12 +169,12 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Adds header comments to the specified section.
- *
+ *
* <p>
* Header comments are defined as lines that start with <jk>"#"</jk> immediately preceding a section header
* <jk>"[section]"</jk>.
* These are handled as part of the section itself instead of being interpreted as comments in the previous section.
- *
+ *
* <p>
* Header comments can be of the following formats...
* <ul class='spaced-list'>
@@ -183,10 +183,10 @@ public abstract class ConfigFile implements Map<String,Section> {
* <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.
- *
+ *
* @param section The name of the section to add lines to, or <jk>null</jk> to add to the default section.
* @param headerComments The comment lines to add to the section.
* @return This object (for method chaining).
@@ -196,7 +196,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Removes any header comments from the specified section.
- *
+ *
* @param section The name of the section to remove header comments from.
* @return This object (for method chaining).
* @throws UnsupportedOperationException If config file is read only.
@@ -205,24 +205,24 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Returns the reusable bean session associated with this config file.
- *
+ *
* <p>
* Used for performing simple datatype conversions.
- *
+ *
* @return The reusable bean session associated with this config file.
*/
protected abstract BeanSession getBeanSession();
/**
* Converts the specified object to a string.
- *
+ *
* <p>
* The serialized output is identical to LAX JSON (JSON with unquoted attributes) except for the following
* exceptions:
* <ul>
* <li>Top level strings are not quoted.
* </ul>
- *
+ *
* @param o The object to serialize.
* @param serializer
* The serializer to use for serializing the object.
@@ -235,7 +235,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Converts the specified string to an object of the specified type.
- *
+ *
* @param s The string to parse.
* @param parser
* The parser to use for parsing the object.
@@ -264,7 +264,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Returns the specified value as a string from the config file.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param def The default value if the section or value does not exist.
* @return The value, or the default value if the section or value doesn't exist.
@@ -277,7 +277,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Removes an entry with the specified key.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @return The previous value, or <jk>null</jk> if the section or key did not previously exist.
* @throws UnsupportedOperationException If config file is read only.
@@ -289,7 +289,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key and converts it to the specified value.
- *
+ *
* <p>
* The key can be in one of the following formats...
* <ul class='spaced-list'>
@@ -298,48 +298,48 @@ public abstract class ConfigFile implements Map<String,Section> {
* <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).
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* ConfigFile cf = ConfigFile.<jsm>create</jsm>().build(<js>"MyConfig.cfg"</js>);
- *
+ *
* <jc>// Parse into a linked-list of strings.</jc>
* List l = cf.getObject(<js>"MySection/myListOfStrings"</js>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of beans.</jc>
* List l = cf.getObject(<js>"MySection/myListOfBeans"</js>, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of linked-lists of strings.</jc>
* List l = cf.getObject(<js>"MySection/my2dListOfStrings"</js>, LinkedList.<jk>class</jk>,
* LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of string keys/values.</jc>
* Map m = cf.getObject(<js>"MySection/myMap"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>,
* String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map containing string keys and values of lists containing beans.</jc>
* Map m = cf.getObject(<js>"MySection/myMapOfListsOfBeans"</js>, 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.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Use the {@link #getObject(String, Class)} method instead if you don't need a parameterized map/collection.
* </ul>
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param type
* The object type to create.
@@ -359,7 +359,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Same as {@link #getObject(String, Type, Type...)} but allows you to specify the parser to use to parse the value.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param parser
* The parser to use for parsing the object.
@@ -384,30 +384,30 @@ 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 = ConfigFile.<jsm>create</jsm>().build(<js>"MyConfig.cfg"</js>);
- *
+ *
* <jc>// Parse into a string.</jc>
* String s = cf.getObject(<js>"MySection/mySimpleString"</js>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a bean.</jc>
* MyBean b = cf.getObject(<js>"MySection/myBean"</js>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a bean array.</jc>
* MyBean[] b = cf.getObject(<js>"MySection/myBeanArray"</js>, MyBean[].<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of objects.</jc>
* List l = cf.getObject(<js>"MySection/myList"</js>, LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of object keys/values.</jc>
* Map m = cf.getObject(<js>"MySection/myMap"</js>, TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* @param <T> The class type of the object being created.
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param type The object type to create.
@@ -422,7 +422,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Same as {@link #getObject(String, Class)} but allows you to specify the parser to use to parse the value.
- *
+ *
* @param <T> The class type of the object being created.
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param parser
@@ -442,10 +442,10 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key and converts it to the specified value.
- *
+ *
* <p>
* Same as {@link #getObject(String, Class)}, but with a default value.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param def The default value if section or key does not exist.
* @param type The class to convert the value to.
@@ -459,7 +459,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Same as {@link #getObjectWithDefault(String, Object, Class)} but allows you to specify the parser to use to parse
* the value.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param parser
* The parser to use for parsing the object.
@@ -478,10 +478,10 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key and converts it to the specified value.
- *
+ *
* <p>
* Same as {@link #getObject(String, Type, Type...)}, but with a default value.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param def The default value if section or key does not exist.
* @param type
@@ -503,7 +503,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Same as {@link #getObjectWithDefault(String, Object, Type, Type...)} but allows you to specify the parser to use
* to parse the value.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param parser
* The parser to use for parsing the object.
@@ -530,10 +530,10 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key and converts it to the specified value.
- *
+ *
* <p>
* Same as {@link #getObject(String, Class)}, but used when key is already broken into section/key.
- *
+ *
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
* @param c The class to convert the value to.
@@ -546,7 +546,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Same as {@link #getObject(String, String, Class)} but allows you to specify the parser to use to parse the value.
- *
+ *
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
* @param parser
@@ -564,10 +564,10 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key and converts it to the specified value.
- *
+ *
* <p>
* Same as {@link #getObject(String, Type, Type...)}, but used when key is already broken into section/key.
- *
+ *
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
* @param type
@@ -589,7 +589,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Same as {@link #getObject(String, String, Type, Type...)} but allows you to specify the parser to use to parse
* the value.
- *
+ *
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
* @param parser
@@ -616,7 +616,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key.
- *
+ *
* <p>
* The key can be in one of the following formats...
* <ul class='spaced-list'>
@@ -625,7 +625,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* <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.
* @return The value, or <jk>null</jk> if the section or key does not exist.
*/
@@ -635,7 +635,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key, splits the value on commas, and returns the values as trimmed strings.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @return The value, or an empty list if the section or key does not exist.
*/
@@ -645,7 +645,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Same as {@link #getStringArray(String)} but returns a default value if the value cannot be found.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param def The default value if section or key does not exist.
* @return The value, or an empty list if the section or key does not exist.
@@ -660,7 +660,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Convenience method for getting int config values.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @return The value, or <code>0</code> if the section or key does not exist or cannot be parsed as an integer.
*/
@@ -670,10 +670,10 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Convenience method for getting int config values.
- *
+ *
* <p>
* <js>"K"</js>, <js>"M"</js>, and <js>"G"</js> can be used to identify kilo, mega, and giga.
- *
+ *
* <h5 class='section'>Example:</h5>
* <ul class='spaced-list'>
* <li>
@@ -681,7 +681,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* <li>
* <code><js>"100M"</js> => 104857600</code>
* </ul>
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param def The default value if config file or value does not exist.
* @return The value, or the default value if the section or key does not exist or cannot be parsed as an integer.
@@ -695,7 +695,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Convenience method for getting long config values.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @return The value, or <code>0</code> if the section or key does not exist or cannot be parsed as a long.
*/
@@ -705,10 +705,10 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Convenience method for getting long config values.
- *
+ *
* <p>
* <js>"K"</js>, <js>"M"</js>, and <js>"G"</js> can be used to identify kilo, mega, and giga.
- *
+ *
* <h5 class='section'>Example:</h5>
* <ul class='spaced-list'>
* <li>
@@ -716,7 +716,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* <li>
* <code><js>"100M"</js> => 104857600</code>
* </ul>
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param def The default value if config file or value does not exist.
* @return The value, or the default value if the section or key does not exist or cannot be parsed as an integer.
@@ -730,7 +730,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Convenience method for getting boolean config values.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @return The value, or <jk>false</jk> if the section or key does not exist or cannot be parsed as a boolean.
*/
@@ -740,7 +740,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Convenience method for getting boolean config values.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param def The default value if config file or value does not exist.
* @return The value, or the default value if the section or key does not exist or cannot be parsed as a boolean.
@@ -753,10 +753,10 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Adds or replaces an entry with the specified key with a POJO serialized to a string using the registered
* serializer.
- *
+ *
* <p>
* Equivalent to calling <code>put(key, value, isEncoded(key))</code>.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param value The new value POJO.
* @return The previous value, or <jk>null</jk> if the section or key did not previously exist.
@@ -770,7 +770,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Same as {@link #put(String, Object)} but allows you to specify the serializer to use to serialize the value.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param value The new value POJO.
* @param serializer
@@ -787,7 +787,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Adds or replaces an entry with the specified key with the specified value.
- *
+ *
* <p>
* The format of the entry depends on the data type of the value.
* <ul class='spaced-list'>
@@ -802,7 +802,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* >Arrays and collections of other types are serialized as comma-delimited lists of serialized strings of
* each entry.
* </ul>
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param value The new value.
* @param encoded
@@ -819,7 +819,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Same as {@link #put(String, Object, boolean)} but allows you to specify the serializer to use to serialize the
* value.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param value The new value.
* @param serializer
@@ -841,7 +841,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Returns the specified section as a map of key/value pairs.
- *
+ *
* @param sectionName The section name to retrieve.
* @return A map of the section, or <jk>null</jk> if the section was not found.
*/
@@ -862,7 +862,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Copies the entries in a section to the specified bean by calling the public setters on that bean.
- *
+ *
* @param sectionName The section name to write from.
* @param bean The bean to set the properties on.
* @param ignoreUnknownProperties
@@ -913,7 +913,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Shortcut for calling <code>getSectionAsBean(sectionName, c, <jk>false</jk>)</code>.
- *
+ *
* @param sectionName The section name to write from.
* @param c The bean class to create.
* @return A new bean instance.
@@ -925,10 +925,10 @@ 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.
- *
+ *
* <h6 class='figure'>Example config file</h6>
* <p class='bcode'>
* <cs>[MyAddress]</cs>
@@ -938,7 +938,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* <ck>state</ck> = <cv>NY</cv>
* <ck>zip</ck> = <cv>12345</cv>
* </p>
- *
+ *
* <h6 class='figure'>Example bean</h6>
* <p class='bcode'>
* <jk>public class</jk> Address {
@@ -947,13 +947,13 @@ public abstract class ConfigFile implements Map<String,Section> {
* public int zip;
* }
* </p>
- *
+ *
* <h6 class='figure'>Example usage</h6>
* <p class='bcode'>
* ConfigFile cf = ConfigFile.<jsm>create</jsm>().build(<js>"MyConfig.cfg"</js>);
* Address myAddress = cf.getSectionAsBean(<js>"MySection"</js>, Address.<jk>class</jk>);
* </p>
- *
+ *
* @param sectionName The section name to write from.
* @param c The bean class to create.
* @param ignoreUnknownProperties
@@ -986,7 +986,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.
- *
+ *
* <h6 class='figure'>Example config file</h6>
* <p class='bcode'>
* <cs>[MySection]</cs>
@@ -997,44 +997,44 @@ public abstract class ConfigFile implements Map<String,Section> {
* <ck>int3dArray</ck> = <cv>[[[123,null],null],null]</cv>
* <ck>bean1d3dListMap</ck> = <cv>{key:[[[[{foo:'bar',baz:123}]]]]}</cv>
* </p>
- *
+ *
* <h6 class='figure'>Example interface</h6>
* <p class='bcode'>
* <jk>public interface</jk> MyConfigInterface {
- *
+ *
* String getString();
* <jk>void</jk> setString(String x);
- *
+ *
* <jk>int</jk> getInt();
* <jk>void</jk> setInt(<jk>int</jk> x);
- *
+ *
* MyEnum getEnum();
* <jk>void</jk> setEnum(MyEnum x);
- *
+ *
* MyBean getBean();
* <jk>void</jk> setBean(MyBean x);
- *
+ *
* <jk>int</jk>[][][] getInt3dArray();
* <jk>void</jk> setInt3dArray(<jk>int</jk>[][][] x);
- *
+ *
* Map<String,List<MyBean[][][]>> getBean1d3dListMap();
* <jk>void</jk> setBean1d3dListMap(Map<String,List<MyBean[][][]>> x);
* }
* </p>
- *
+ *
* <h6 class='figure'>Example usage</h6>
* <p class='bcode'>
* ConfigFile cf = ConfigFile.<jsm>create</jsm>().build(<js>"MyConfig.cfg"</js>);
- *
+ *
* MyConfigInterface ci = cf.getSectionAsInterface(<js>"MySection"</js>, MyConfigInterface.<jk>class</jk>);
- *
+ *
* <jk>int</jk> myInt = ci.getInt();
- *
+ *
* ci.setBean(<jk>new</jk> MyBean());
- *
+ *
* cf.save();
* </p>
- *
+ *
* @param sectionName The section name to retrieve as an interface proxy.
* @param c The proxy interface class.
* @return The proxy interface.
@@ -1067,7 +1067,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Returns <jk>true</jk> if this section contains the specified key and the key has a non-blank value.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @return <jk>true</jk> if this section contains the specified key and the key has a non-blank value.
*/
@@ -1077,7 +1077,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the section with the specified name.
- *
+ *
* @param name The section name.
* @return The section, or <jk>null</jk> if section does not exist.
*/
@@ -1085,7 +1085,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the section with the specified name and optionally creates it if it's not there.
- *
+ *
* @param name The section name.
* @param create Create the section if it's not there.
* @return The section, or <jk>null</jk> if section does not exist.
@@ -1096,10 +1096,10 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Appends a section to this config file if it does not already exist.
- *
+ *
* <p>
* Returns the existing section if it already exists.
- *
+ *
* @param name The section name, or <jk>null</jk> for the default section.
* @return The appended or existing section.
* @throws UnsupportedOperationException If config file is read only.
@@ -1108,7 +1108,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Creates or overwrites the specified section.
- *
+ *
* @param name The section name, or <jk>null</jk> for the default section.
* @param contents The contents of the new section.
* @return The appended or existing section.
@@ -1118,7 +1118,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Removes the section with the specified name.
- *
+ *
* @param name The name of the section to remove, or <jk>null</jk> for the default section.
* @return The removed section, or <jk>null</jk> if named section does not exist.
* @throws UnsupportedOperationException If config file is read only.
@@ -1127,7 +1127,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Returns <jk>true</jk> if the encoding flag is set on the specified entry.
- *
+ *
* @param key The key. See {@link #getString(String)} for a description of the key.
* @return <jk>true</jk> if the encoding flag is set on the specified entry.
*/
@@ -1135,7 +1135,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Saves this config file to disk.
- *
+ *
* @return This object (for method chaining).
* @throws IOException If a problem occurred trying to save file to disk, or file is not associated with this object.
* @throws UnsupportedOperationException If config file is read only.
@@ -1144,10 +1144,10 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Saves this config file to the specified writer as an INI file.
- *
+ *
* <p>
* The writer will automatically be closed.
- *
+ *
* @param out The writer to send the output to.
* @return This object (for method chaining).
* @throws IOException If a problem occurred trying to send contents to the writer.
@@ -1158,7 +1158,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Same as {@link #serializeTo(Writer)}, except allows you to explicitly specify a format.
- *
+ *
* @param out The writer to send the output to.
* @param format The {@link ConfigFileFormat} of the output.
* @return This object (for method chaining).
@@ -1168,7 +1168,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Add a listener to this config file to react to modification events.
- *
+ *
* @param listener The new listener to add.
* @return This object (for method chaining).
* @throws UnsupportedOperationException If config file is read only.
@@ -1177,11 +1177,11 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Merges the contents of the specified config file into this config file.
- *
+ *
* <p>
* Pretty much identical to just replacing this config file, but causes the
* {@link ConfigFileListener#onChange(ConfigFile, Set)} method to be invoked on differences between the file.
- *
+ *
* @param cf The config file whose values should be copied into this config file.
* @return This object (for method chaining).
* @throws UnsupportedOperationException If config file is read only.
@@ -1190,7 +1190,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Returns the config file contents as a string.
- *
+ *
* <p>
* The contents of the string are the same as the contents that would be serialized to disk.
*/
@@ -1200,7 +1200,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Returns a wrapped instance of this config file where calls to getters have their values first resolved by the
* specified {@link VarResolver}.
- *
+ *
* @param vr The {@link VarResolver} for resolving variables in values.
* @return This config file wrapped in an instance of {@link ConfigFileWrapped}.
*/
@@ -1209,7 +1209,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Returns a wrapped instance of this config file where calls to getters have their values first resolved by the
* specified {@link VarResolverSession}.
- *
+ *
* @param vs The {@link VarResolverSession} for resolving variables in values.
* @return This config file wrapped in an instance of {@link ConfigFileWrapped}.
*/
@@ -1218,7 +1218,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Returns a wrapped instance of this config file where calls to getters have their values first resolved by a
* default {@link VarResolver}.
- *
+ *
* The default {@link VarResolver} is registered with the following {@link Var StringVars}:
* <ul class='spaced-list'>
* <li>
@@ -1228,14 +1228,14 @@ public abstract class ConfigFile implements Map<String,Section> {
* <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.
*/
public abstract ConfigFile getResolving();
/**
* Wraps this config file in a {@link Writable} interface that renders it as plain text.
- *
+ *
* @return This config file wrapped in a {@link Writable}.
*/
public abstract Writable toWritable();
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java
index e58714e..8f573d8 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java
@@ -28,8 +28,8 @@ import org.apache.juneau.utils.*;
/**
* Builder for creating instances of {@link ConfigFile ConfigFiles}.
- *
- * <h5 class='topic'>Example</h5>
+ *
+ * <h5 class='section'>Example:</h5>
* <p class='bcode'>
* ConfigFile cf = ConfigFile.<jsm>create</jsm>().build(<js>"MyConfig.cfg"</js>);
* String setting = cf.get(<js>"MySection/mysetting"</js>);
@@ -46,10 +46,10 @@ public class ConfigFileBuilder {
/**
* Specify the encoder to use for encoded config file entries (e.g. <js>"mySecret*={...}"</js>).
- *
+ *
* <p>
* The default value for this setting is an instance of {@link XorEncoder}.
- *
+ *
* @param encoder The new value for this setting.
* @return This object (for method chaining).
*/
@@ -60,10 +60,10 @@ public class ConfigFileBuilder {
/**
* Specify the serializer to use for serializing POJOs when using {@link ConfigFile#put(String, Object)}.
- *
+ *
* <p>
* The default value for this setting is {@link JsonSerializer#DEFAULT_LAX}.
- *
+ *
* @param serializer The new value for this setting.
* @return This object (for method chaining).
*/
@@ -74,10 +74,10 @@ public class ConfigFileBuilder {
/**
* Specify the parser to use for parsing POJOs when using {@link ConfigFile#getObject(String,Class)}.
- *
+ *
* <p>
* The default value for this setting is {@link JsonParser#DEFAULT}
- *
+ *
* @param parser The new value for this setting.
* @return This object (for method chaining).
*/
@@ -88,10 +88,10 @@ public class ConfigFileBuilder {
/**
* Specify the config file character encoding.
- *
+ *
* <p>
* The default value for this setting is {@link Charset#defaultCharset()}.
- *
+ *
* @param charset The new value for this setting.
* @return This object (for method chaining).
*/
@@ -102,13 +102,13 @@ public class ConfigFileBuilder {
/**
* Specify the search paths for config files.
- *
+ *
* <p>
* Can contain relative or absolute paths.
- *
+ *
* <p>
* The default value for this setting is <code>[<js>"."</js>]</code>.
- *
+ *
* @param searchPaths The new value for this setting.
* @return This object (for method chaining).
*/
@@ -121,10 +121,10 @@ public class ConfigFileBuilder {
/**
* Make {@link ConfigFile ConfigFiles} read-only.
- *
+ *
* <p>
* The default value of this setting is <jk>false</jk>.
- *
+ *
* @return This object (for method chaining).
*/
public ConfigFileBuilder readOnly() {
@@ -134,10 +134,10 @@ public class ConfigFileBuilder {
/**
* Create config files if they cannot be found on the file system.
- *
+ *
* <p>
* The default value for this setting is <jk>false</jk>.
- *
+ *
* @return This object (for method chaining).
*/
public ConfigFileBuilder createIfNotExists() {
@@ -147,7 +147,7 @@ public class ConfigFileBuilder {
/**
* Returns the config file with the specified absolute or relative path.
- *
+ *
* @param path The absolute or relative path of the config file.
* @return The config file.
* @throws IOException If config file could not be parsed.
@@ -159,7 +159,7 @@ public class ConfigFileBuilder {
/**
* Create a new empty config file not backed by any file.
- *
+ *
* @return A new config file.
* @throws IOException
*/
@@ -169,10 +169,10 @@ public class ConfigFileBuilder {
/**
* Create a new config file backed by the specified file.
- *
+ *
* <p>
* This method is provided primarily for testing purposes.
- *
+ *
* @param f The file to create a config file from.
* @return A new config file.
* @throws IOException
@@ -183,7 +183,7 @@ public class ConfigFileBuilder {
/**
* Create a new config file not backed by a file.
- *
+ *
* @param r The reader containing an INI-formatted file to initialize the config file from.
* @return A new config file.
* @throws IOException
@@ -225,13 +225,13 @@ public class ConfigFileBuilder {
/**
* Implements command-line features for working with INI configuration files.
- *
+ *
* <p>
* Invoke as a normal Java program...
* <p class='bcode'>
* java org.apache.juneau.ini.ConfigFileBuilder [args]
* </p>
- *
+ *
* <p>
* Arguments can be any of the following...
* <ul class='spaced-list'>
@@ -252,7 +252,7 @@ public class ConfigFileBuilder {
* <code>setVals -configFile <configFile> -vals [var1=val1 [var2=val2...]] [-verbose]</code>
* Sets values in config files.
* </ul>
- *
+ *
* <p>
* For example, the following command will create the file <code>'MyConfig.bat'</code> from the contents of the
* file <code>'MyConfig.cfg'</code>.
@@ -260,7 +260,7 @@ public class ConfigFileBuilder {
* java org.apache.juneau.ini.ConfigFileBuilder createBatchEnvFile -configfile C:\foo\MyConfig.cfg
* -batchfile C:\foo\MyConfig.bat
* </p>
- *
+ *
* @param args Command-line arguments
*/
public static void main(String[] args) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileContext.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileContext.java
index 0484909..6425b4f 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileContext.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileContext.java
@@ -21,7 +21,7 @@ public class ConfigFileContext extends Context {
/**
* TODO
- *
+ *
* @param ps
*/
public ConfigFileContext(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java
index 5db7674..a504261 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java
@@ -56,13 +56,13 @@ public final class ConfigFileImpl extends ConfigFile {
/**
* Constructor.
- *
+ *
* <p>
* Loads the contents of the specified file into this config file.
- *
+ *
* <p>
* If file does not initially exist, this object will start off empty.
- *
+ *
* @param file
* The INI file on disk.
* If <jk>null</jk>, create an in-memory config file.
@@ -102,11 +102,11 @@ public final class ConfigFileImpl extends ConfigFile {
/**
* Constructor.
- *
+ *
* <p>
* Shortcut for calling <code><jk>new</jk> ConfigFileImpl(file, <jk>false</jk>, <jk>null</jk>, <jk>null</jk>,
* <jk>null</jk>, <jk>null</jk>);</code>
- *
+ *
* @param file The config file. Does not need to exist.
* @throws IOException
*/
@@ -116,11 +116,11 @@ public final class ConfigFileImpl extends ConfigFile {
/**
* Constructor.
- *
+ *
* <p>
* Shortcut for calling <code><jk>new</jk> ConfigFileImpl(<jk>null</jk>, <jk>false</jk>, <jk>null</jk>,
* <jk>null</jk>, <jk>null</jk>, <jk>null</jk>);</code>
- *
+ *
* @throws IOException
*/
public ConfigFileImpl() throws IOException {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileListener.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileListener.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileListener.java
index cfed21a..2cb5453 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileListener.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileListener.java
@@ -16,7 +16,7 @@ import java.util.*;
/**
* Listener that can be used to listen for change events in config files.
- *
+ *
* <p>
* Use the {@link ConfigFile#addListener(ConfigFileListener)} method to register listeners.
*/
@@ -24,21 +24,21 @@ public class ConfigFileListener {
/**
* Gets called immediately after a config file has been loaded.
- *
+ *
* @param cf The config file being loaded.
*/
public void onLoad(ConfigFile cf) {}
/**
* Gets called immediately after a config file has been saved.
- *
+ *
* @param cf The config file being saved.
*/
public void onSave(ConfigFile cf) {}
/**
* Signifies that the specified values have changed.
- *
+ *
* @param cf The config file being modified.
* @param changes The full keys (e.g. <js>"Section/key"</js>) of entries that have changed in the config file.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileVar.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileVar.java
index 52fe0ea..70406cc 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileVar.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileVar.java
@@ -16,32 +16,32 @@ import org.apache.juneau.svl.*;
/**
* Config file variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$C{key[,defaultValue]}"</js>.
* See {@link ConfigFile#getString(String)} for the format of the key.
- *
+ *
* <p>
* This variable resolver requires that a {@link ConfigFile} object be set as a context object on the resolver or a
* session object on the resolver session.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a config file object.</jc>
* ConfigFile configFile = new ConfigFileBuilder().build(<js>"MyConfig.cfg"</js>);
- *
+ *
* <jc>// Create a variable resolver that resolves config file entries (e.g. "$C{MySection/myKey}")</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(ConfigVar.<js>class</js>)
* .addContextObject(<jsf>SESSION_config</jsf>, configFile);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"Value for myKey in section MySection is $C{MySection/myKey}"</js>));
* </p>
- *
+ *
* <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.
- *
+ *
* @see org.apache.juneau.ini.ConfigFile
* @see org.apache.juneau.svl
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java
index 1454a18..a1db452 100644
--- a/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java
+++ b/juneau-core/juneau-config/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java
@@ -26,10 +26,10 @@ import org.apache.juneau.svl.*;
/**
* Wraps an instance of {@link ConfigFileImpl} in an interface that will automatically replace {@link VarResolver}
* variables.
- *
+ *
* <p>
* The {@link ConfigFile#getResolving(VarResolver)} returns an instance of this class.
- *
+ *
* <p>
* This class overrides the {@link #getString(String, String)} to resolve string variables.
* All other method calls are passed through to the inner config file.
[22/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyMeta.java
index 7e3019f..56f360d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyMeta.java
@@ -35,11 +35,11 @@ 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.
- *
+ *
* <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.
@@ -320,7 +320,7 @@ public final class BeanPropertyMeta {
/**
* Creates a new BeanPropertyMeta using the contents of the specified builder.
- *
+ *
* @param b The builder to copy fields from.
*/
protected BeanPropertyMeta(BeanPropertyMeta.Builder b) {
@@ -344,7 +344,7 @@ public final class BeanPropertyMeta {
/**
* Returns the name of this bean property.
- *
+ *
* @return The name of the bean property.
*/
public String getName() {
@@ -353,7 +353,7 @@ public final class BeanPropertyMeta {
/**
* Returns the bean meta that this property belongs to.
- *
+ *
* @return The bean meta that this property belongs to.
*/
@BeanIgnore
@@ -363,7 +363,7 @@ public final class BeanPropertyMeta {
/**
* Returns the getter method for this property.
- *
+ *
* @return The getter method for this bean property, or <jk>null</jk> if there is no getter method.
*/
public Method getGetter() {
@@ -372,7 +372,7 @@ public final class BeanPropertyMeta {
/**
* Returns the setter method for this property.
- *
+ *
* @return The setter method for this bean property, or <jk>null</jk> if there is no setter method.
*/
public Method getSetter() {
@@ -381,7 +381,7 @@ public final class BeanPropertyMeta {
/**
* Returns the field for this property.
- *
+ *
* @return The field for this bean property, or <jk>null</jk> if there is no field associated with this bean property.
*/
public Field getField() {
@@ -390,13 +390,13 @@ public final 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.
* This matches the class type that is used by the {@link #get(BeanMap,String)} and
* {@link #set(BeanMap,String,Object)} methods.
- *
+ *
* @return The {@link ClassMeta} of the class of this property.
*/
public ClassMeta<?> getClassMeta() {
@@ -405,14 +405,14 @@ public final 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() @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() {
@@ -421,7 +421,7 @@ public final 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>
@@ -429,7 +429,7 @@ public final class BeanPropertyMeta {
* <li>Property class type is annotated with {@link org.apache.juneau.annotation.URI @URI}.
* <li>Property getter, setter, or field is annotated with {@link org.apache.juneau.annotation.URI @URI}.
* </ul>
- *
+ *
* @return <jk>true</jk> if this bean property is a URI.
*/
public boolean isUri() {
@@ -438,7 +438,7 @@ public final 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() {
@@ -448,7 +448,7 @@ public final class BeanPropertyMeta {
/**
* Returns the override list of properties defined through a {@link BeanProperty#properties() @BeanProperty.properties()} annotation
* on this property.
- *
+ *
* @return The list of override properties, or <jk>null</jk> if annotation not specified.
*/
public String[] getProperties() {
@@ -457,7 +457,7 @@ public final class BeanPropertyMeta {
/**
* Returns the language-specified extended metadata on this bean property.
- *
+ *
* @param c The name of the metadata class to create.
* @return Extended metadata on this bean property. Never <jk>null</jk>.
*/
@@ -469,7 +469,7 @@ public final class BeanPropertyMeta {
/**
* Equivalent to calling {@link BeanMap#get(Object)}, but is faster since it avoids looking up the property meta.
- *
+ *
* @param m The bean map to get the transformed value from.
* @param pName The property name.
* @return The property value.
@@ -498,7 +498,7 @@ public final class BeanPropertyMeta {
/**
* Equivalent to calling {@link BeanMap#getRaw(Object)}, but is faster since it avoids looking up the property meta.
- *
+ *
* @param m The bean map to get the transformed value from.
* @param pName The property name.
* @return The raw property value.
@@ -559,7 +559,7 @@ public final class BeanPropertyMeta {
/**
* 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.
* @param value The value to set.
@@ -778,11 +778,11 @@ public final 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.
- *
+ *
* @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
@@ -804,10 +804,10 @@ public final 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.
* @param l The collection to use to set the array field.
* @throws IllegalArgumentException Thrown by method invocation.
@@ -821,11 +821,11 @@ public final class BeanPropertyMeta {
/**
* Adds a value to a {@link Collection} or array property.
- *
+ *
* <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.
* @param value The value to add to the field.
@@ -901,7 +901,7 @@ public final class BeanPropertyMeta {
/**
* Adds a value to a {@link Map} or bean property.
- *
+ *
* @param m The bean of the field being set.
* @param pName The property name.
* @param key The key to add to the field.
@@ -978,11 +978,11 @@ public final 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.
- *
+ *
* @param a The class to find annotations for.
* @return A list of annotations ordered in child-to-parent order. Never <jk>null</jk>.
*/
@@ -1007,11 +1007,11 @@ public final 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.
- *
+ *
* @param a The annotation to search for.
* @return The annotation, or <jk>null</jk> if it wasn't found.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java
index 43362f2..250c346 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java
@@ -14,7 +14,7 @@ package org.apache.juneau;
/**
* Defines extended language-specific metadata associated with a bean property.
- *
+ *
* <p>
* Serializers and parsers can implement their own language-specific metadata on a bean property and retrieve
* the metadata using the {@link BeanPropertyMeta#getExtendedMeta(Class)} method.
@@ -25,7 +25,7 @@ public class BeanPropertyMetaExtended {
/**
* Constructor.
- *
+ *
* @param bpm The metadata of the bean property we're extending.
* @throws BeanRuntimeException If any error occurred trying to construct the metadata.
*/
@@ -35,7 +35,7 @@ public class BeanPropertyMetaExtended {
/**
* Returns the bean property metadata that was passed into the constructor.
- *
+ *
* @return The bean property metadata that was passed into the constructor.
*/
protected BeanPropertyMeta getBeanPropertyMeta() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyValue.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyValue.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyValue.java
index 4e5812c..11ee15a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyValue.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanPropertyValue.java
@@ -24,7 +24,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Constructor.
- *
+ *
* @param pMeta The bean property metadata.
* @param name The bean property name.
* @param value The bean property value.
@@ -39,7 +39,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the bean property metadata.
- *
+ *
* @return The bean property metadata.
*/
public final BeanPropertyMeta getMeta() {
@@ -48,7 +48,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the bean property metadata.
- *
+ *
* @return The bean property metadata.
*/
public final ClassMeta<?> getClassMeta() {
@@ -57,7 +57,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the bean property name.
- *
+ *
* @return The bean property name.
*/
public final String getName() {
@@ -66,7 +66,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the bean property value.
- *
+ *
* @return The bean property value.
*/
public final Object getValue() {
@@ -75,7 +75,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the exception thrown by calling the property getter.
- *
+ *
* @return The exception thrown by calling the property getter.
*/
public final Throwable getThrown() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java
index 4379118..4b5626d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java
@@ -19,11 +19,11 @@ import org.apache.juneau.json.*;
/**
* Provides an {@link InvocationHandler} for creating beans from bean interfaces.
- *
+ *
* <p>
* If the {@code useInterfaceProxies} setting is enabled in {@link BeanContext}, this is the class that creates
* instances of beans from interfaces.
- *
+ *
* @param <T> The interface class
*/
public class BeanProxyInvocationHandler<T> implements InvocationHandler {
@@ -33,7 +33,7 @@ public class BeanProxyInvocationHandler<T> implements InvocationHandler {
/**
* Constructs with the specified {@link BeanMeta}.
- *
+ *
* @param meta The bean meta data.
*/
public BeanProxyInvocationHandler(BeanMeta<T> meta) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanRegistry.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanRegistry.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanRegistry.java
index d567f18..99fdc36 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanRegistry.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanRegistry.java
@@ -23,13 +23,13 @@ import org.apache.juneau.internal.*;
/**
* A lookup table for resolving bean types by name.
- *
+ *
* <p>
* In a nutshell, provides a simple mapping of bean class objects to identifying names.
- *
+ *
* <p>
* Class names are defined through the {@link Bean#typeName() @Bean.typeName()} annotation.
- *
+ *
* <p>
* The dictionary is used by the framework in the following ways:
* <ul>
@@ -118,7 +118,7 @@ public class BeanRegistry {
/**
* Gets the class metadata for the specified bean type name.
- *
+ *
* @param typeName
* The bean type name as defined by {@link Bean#typeName() @Bean.typeName()}.
* Can include multi-dimensional array type names (e.g. <js>"X^^"</js>).
@@ -145,7 +145,7 @@ public class BeanRegistry {
/**
* Given the specified class, return the dictionary name for it.
- *
+ *
* @param c The class to lookup in this registry.
* @return The dictionary name for the specified class in this registry, or <jk>null</jk> if not found.
*/
@@ -157,7 +157,7 @@ public class BeanRegistry {
/**
* Returns <jk>true</jk> if this dictionary has an entry for the specified type name.
- *
+ *
* @param typeName The bean type name.
* @return <jk>true</jk> if this dictionary has an entry for the specified type name.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanRuntimeException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanRuntimeException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanRuntimeException.java
index 0a92982..909c997 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanRuntimeException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanRuntimeException.java
@@ -21,7 +21,7 @@ public final class BeanRuntimeException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param message The error message.
*/
public BeanRuntimeException(String message) {
@@ -30,7 +30,7 @@ public final class BeanRuntimeException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param message The error message.
* @param args Arguments passed in to the {@code String.format()} method.
*/
@@ -40,7 +40,7 @@ public final class BeanRuntimeException extends FormattedRuntimeException {
/**
* Shortcut for calling <code><jk>new</jk> BeanRuntimeException(String.format(c.getName() + <js>": "</js> + message, args));</code>
- *
+ *
* @param c The class name of the bean that caused the exception.
* @param message The error message.
* @param args Arguments passed in to the {@code String.format()} method.
@@ -51,7 +51,7 @@ public final class BeanRuntimeException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param cause The initial cause of the exception.
*/
public BeanRuntimeException(Throwable cause) {
@@ -61,7 +61,7 @@ public final class BeanRuntimeException extends FormattedRuntimeException {
/**
* 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/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java
index 829e7a5..2b63b07 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java
@@ -30,7 +30,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link Serializer} or {@link Parser}.
- *
+ *
* <p>
* This class is NOT thread safe. It is meant to be discarded after one-time use.
*/
@@ -46,7 +46,7 @@ public class BeanSession extends Session {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -76,7 +76,7 @@ public class BeanSession extends Session {
/**
* Returns the locale defined on this session.
- *
+ *
* <p>
* The locale is determined in the following order:
* <ol>
@@ -85,7 +85,7 @@ public class BeanSession extends Session {
* <li>{@link BeanContext#BEAN_locale} setting on bean context.
* <li>Locale returned by {@link Locale#getDefault()}.
* </ol>
- *
+ *
* @return The session locale.
*/
public final Locale getLocale() {
@@ -94,7 +94,7 @@ public class BeanSession extends Session {
/**
* Returns the timezone defined on this session.
- *
+ *
* <p>
* The timezone is determined in the following order:
* <ol>
@@ -102,7 +102,7 @@ public class BeanSession extends Session {
* <li>{@link BeanContext#BEAN_timeZone} entry in parameter passed in through constructor.
* <li>{@link BeanContext#BEAN_timeZone} setting on bean context.
* </ol>
- *
+ *
* @return The session timezone, or <jk>null</jk> if timezone not specified.
*/
public final TimeZone getTimeZone() {
@@ -111,7 +111,7 @@ public class BeanSession extends Session {
/**
* Returns the {@link BeanContext#BEAN_debug} setting value for this session.
- *
+ *
* @return The {@link BeanContext#BEAN_debug} setting value for this session.
*/
public final boolean isDebug() {
@@ -120,10 +120,10 @@ public class BeanSession extends Session {
/**
* Bean property getter: <property>ignoreUnknownBeanProperties</property>.
- *
+ *
* <p>
* See {@link BeanContext#BEAN_ignoreUnknownBeanProperties}.
- *
+ *
* @return The value of the <property>ignoreUnknownBeanProperties</property> property on this bean.
*/
public final boolean isIgnoreUnknownBeanProperties() {
@@ -132,10 +132,10 @@ public class BeanSession extends Session {
/**
* Converts the specified value to the specified class type.
- *
+ *
* <p>
* See {@link #convertToType(Object, ClassMeta)} for the list of valid conversions.
- *
+ *
* @param <T> The class type to convert the value to.
* @param value The value to convert.
* @param type The class type to convert the value to.
@@ -152,7 +152,7 @@ public class BeanSession extends Session {
/**
* Same as {@link #convertToType(Object, Class)}, except used for instantiating inner member classes that must
* be instantiated within another class instance.
- *
+ *
* @param <T> The class type to convert the value to.
* @param outer
* If class is a member class, this is the instance of the containing class.
@@ -168,10 +168,10 @@ public class BeanSession extends Session {
/**
* Casts the specified value into the specified type.
- *
+ *
* <p>
* If the value isn't an instance of the specified type, then converts the value if possible.
- *
+ *
* <p>
* The following conversions are valid:
* <table class='styled'>
@@ -294,7 +294,7 @@ public class BeanSession extends Session {
* </td>
* </tr>
* </table>
- *
+ *
* @param <T> The class type to convert the value to.
* @param value The value to be converted.
* @param type The target object type.
@@ -307,7 +307,7 @@ public class BeanSession extends Session {
/**
* Same as {@link #convertToType(Object, Class)}, but allows for complex data types consisting of collections or maps.
- *
+ *
* @param <T> The class type to convert the value to.
* @param value The value to be converted.
* @param type The target object type.
@@ -322,7 +322,7 @@ public class BeanSession extends Session {
/**
* Same as {@link #convertToType(Object, ClassMeta)}, except used for instantiating inner member classes that must
* be instantiated within another class instance.
- *
+ *
* @param <T> The class type to convert the value to.
* @param outer
* If class is a member class, this is the instance of the containing class.
@@ -645,15 +645,15 @@ public class BeanSession extends Session {
/**
* Converts the contents of the specified list into an array.
- *
+ *
* <p>
* Works on both object and primitive arrays.
- *
+ *
* <p>
* In the case of multi-dimensional arrays, the incoming list must contain elements of type n-1 dimension.
* i.e. if {@code type} is <code><jk>int</jk>[][]</code> then {@code list} must have entries of type
* <code><jk>int</jk>[]</code>.
- *
+ *
* @param type The type to convert to. Must be an array type.
* @param list The contents to populate the array with.
* @return A new object or primitive array.
@@ -685,17 +685,17 @@ public class BeanSession extends Session {
/**
* Wraps an object inside a {@link BeanMap} object (i.e. a modifiable {@link Map}).
- *
+ *
* <p>
* If object is not a true bean, then throws a {@link BeanRuntimeException} with an explanation of why it's not a
* bean.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct a bean map around a bean instance</jc>
* BeanMap<Person> bm = BeanContext.<jsf>DEFAULT</jsf>.forBean(<jk>new</jk> Person());
* </p>
- *
+ *
* @param <T> The class of the object being wrapped.
* @param o The object to wrap in a map interface. Must not be null.
* @return The wrapped object.
@@ -706,7 +706,7 @@ public class BeanSession extends Session {
/**
* Determines whether the specified object matches the requirements on this context of being a bean.
- *
+ *
* @param o The object being tested.
* @return <jk>true</jk> if the specified object is considered a bean.
*/
@@ -718,7 +718,7 @@ public class BeanSession extends Session {
/**
* Determines whether the specified class matches the requirements on this context of being a bean.
- *
+ *
* @param c The class being tested.
* @return <jk>true</jk> if the specified class is considered a bean.
*/
@@ -729,19 +729,19 @@ public class BeanSession extends Session {
/**
* Wraps an object inside a {@link BeanMap} object (i.e.: a modifiable {@link Map}) defined as a bean for one of its
* class, a super class, or an implemented interface.
- *
+ *
* <p>
* If object is not a true bean, throws a {@link BeanRuntimeException} with an explanation of why it's not a bean.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct a bean map for new bean using only properties defined in a superclass</jc>
* BeanMap<MySubBean> bm = BeanContext.<jsf>DEFAULT</jsf>.forBean(<jk>new</jk> MySubBean(), MySuperBean.<jk>class</jk>);
- *
+ *
* <jc>// Construct a bean map for new bean using only properties defined in an interface</jc>
* BeanMap<MySubBean> bm = BeanContext.<jsf>DEFAULT</jsf>.forBean(<jk>new</jk> MySubBean(), MySuperInterface.<jk>class</jk>);
* </p>
- *
+ *
* @param <T> The class of the object being wrapped.
* @param o The object to wrap in a bean interface. Must not be null.
* @param c The superclass to narrow the bean properties to. Must not be null.
@@ -770,17 +770,17 @@ public class BeanSession extends Session {
/**
* Creates a new {@link BeanMap} object (i.e. a modifiable {@link Map}) of the given class with uninitialized
* property values.
- *
+ *
* <p>
* If object is not a true bean, then throws a {@link BeanRuntimeException} with an explanation of why it's not a
* bean.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct a new bean map wrapped around a new Person object</jc>
* BeanMap<Person> bm = BeanContext.<jsf>DEFAULT</jsf>.newBeanMap(Person.<jk>class</jk>);
* </p>
- *
+ *
* @param <T> The class of the object being wrapped.
* @param c The name of the class to create a new instance of.
* @return A new instance of the class.
@@ -792,7 +792,7 @@ public class BeanSession extends Session {
/**
* Same as {@link #newBeanMap(Class)}, except used for instantiating inner member classes that must be instantiated
* within another class instance.
- *
+ *
* @param <T> The class of the object being wrapped.
* @param c The name of the class to create a new instance of.
* @param outer
@@ -813,13 +813,13 @@ 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Construct a new instance of the specified bean class</jc>
* Person p = BeanContext.<jsf>DEFAULT</jsf>.newBean(Person.<jk>class</jk>);
* </p>
- *
+ *
* @param <T> The class type of the bean being created.
* @param c The class type of the bean being created.
* @return A new bean object.
@@ -832,7 +832,7 @@ public class BeanSession extends Session {
/**
* Same as {@link #newBean(Class)}, except used for instantiating inner member classes that must be instantiated
* within another class instance.
- *
+ *
* @param <T> The class type of the bean being created.
* @param c The class type of the bean being created.
* @param outer
@@ -860,7 +860,7 @@ public class BeanSession extends Session {
/**
* Returns the {@link BeanMeta} class for the specified class.
- *
+ *
* @param <T> The class type to get the meta-data on.
* @param c The class to get the meta-data on.
* @return
@@ -875,7 +875,7 @@ public class BeanSession extends Session {
/**
* Returns a {@code ClassMeta} wrapper around a {@link Class} object.
- *
+ *
* @param <T> The class type being wrapped.
* @param c The class being wrapped.
* @return The class meta object containing information about the class.
@@ -887,18 +887,18 @@ public class BeanSession extends Session {
/**
* 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.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <ul>
* <li><code>getClassMeta(String.<jk>class</jk>);</code> - A normal type.
@@ -914,7 +914,7 @@ public class BeanSession extends Session {
* <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);</code> -
* A map containing string keys and values of lists containing beans.
* </ul>
- *
+ *
* @param type
* The class to resolve.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
@@ -932,10 +932,10 @@ public class BeanSession extends Session {
/**
* Given an array of {@link Type} objects, returns a {@link ClassMeta} representing those arguments.
- *
+ *
* <p>
* Constructs a new meta on each call.
- *
+ *
* @param classes The array of classes to get class metas for.
* @return The args {@link ClassMeta} object corresponding to the classes. Never <jk>null</jk>.
*/
@@ -949,7 +949,7 @@ public class BeanSession extends Session {
/**
* Shortcut for calling {@code getClassMeta(o.getClass())}.
- *
+ *
* @param <T> The class of the object being passed in.
* @param o The class to find the class type for.
* @return The ClassMeta object, or <jk>null</jk> if {@code o} is <jk>null</jk>.
@@ -962,7 +962,7 @@ public class BeanSession extends Session {
/**
* Returns the type property name as defined by {@link BeanContext#BEAN_beanTypePropertyName}.
- *
+ *
* @param cm
* The class meta of the type we're trying to resolve the type name for.
* Can be <jk>null</jk>.
@@ -975,7 +975,7 @@ public class BeanSession extends Session {
/**
* Returns the bean registry defined in this bean context defined by {@link BeanContext#BEAN_beanDictionary}.
- *
+ *
* @return The bean registry defined in this bean context. Never <jk>null</jk>.
*/
public final BeanRegistry getBeanRegistry() {
@@ -984,7 +984,7 @@ public class BeanSession extends Session {
/**
* Creates an instance of the specified class.
- *
+ *
* @param c
* The class to cast to.
* @param c2
@@ -1001,7 +1001,7 @@ public class BeanSession extends Session {
/**
* Creates an instance of the specified class.
- *
+ *
* @param c
* The class to cast to.
* @param c2
@@ -1050,10 +1050,10 @@ public class BeanSession extends Session {
/**
* Creates a reusable {@link StringBuilder} object from an internal pool.
- *
+ *
* <p>
* String builders are returned to the pool by calling {@link #returnStringBuilder(StringBuilder)}.
- *
+ *
* @return A new or previously returned string builder.
*/
public final StringBuilder getStringBuilder() {
@@ -1064,7 +1064,7 @@ public class BeanSession extends Session {
/**
* Returns a {@link StringBuilder} object back into the internal reuse pool.
- *
+ *
* @param sb The string builder to return to the pool. No-op if <jk>null</jk>.
*/
public final void returnStringBuilder(StringBuilder sb) {
@@ -1076,14 +1076,14 @@ public class BeanSession extends Session {
/**
* 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.
- *
+ *
* <p>
* 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.
*/
public final ClassMeta<Object> object() {
@@ -1092,14 +1092,14 @@ public class BeanSession extends Session {
/**
* 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.
- *
+ *
* @return The {@link ClassMeta} object associated with the <code>String</code> class.
*/
public final ClassMeta<String> string() {
@@ -1108,14 +1108,14 @@ public class BeanSession extends Session {
/**
* 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.
- *
+ *
* @return The {@link ClassMeta} object associated with the <code>String</code> class.
*/
public final ClassMeta<Class> _class() {
@@ -1124,10 +1124,10 @@ public class BeanSession extends Session {
/**
* Returns the media type specified for this session.
- *
+ *
* <p>
* For example, <js>"application/json"</js>.
- *
+ *
* @return The media type for this session, or <jk>null</jk> if not specified.
*/
public final MediaType getMediaType() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSessionArgs.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSessionArgs.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSessionArgs.java
index b6debb8..765b1dd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSessionArgs.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSessionArgs.java
@@ -37,7 +37,7 @@ public class BeanSessionArgs extends SessionArgs {
/**
* Constructor.
- *
+ *
* @param properties
* Session-level properties.
* <br>These override context-level properties.
@@ -61,7 +61,7 @@ public class BeanSessionArgs extends SessionArgs {
/**
* The session locale.
- *
+ *
* @param locale
* The session locale.
* <br>If <jk>null</jk>, then the locale defined on the context is used.
@@ -74,7 +74,7 @@ public class BeanSessionArgs extends SessionArgs {
/**
* The session timezone.
- *
+ *
* @param timeZone
* The session timezone.
* <br>If <jk>null</jk>, then the timezone defined on the context is used.
@@ -87,7 +87,7 @@ public class BeanSessionArgs extends SessionArgs {
/**
* The session media type.
- *
+ *
* @param mediaType
* The session media type (e.g. <js>"application/json"</js>).
* <br>Can be <jk>null</jk>.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ClassMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ClassMeta.java
index f5c211b..be3a2d2 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ClassMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ClassMeta.java
@@ -37,10 +37,10 @@ import org.apache.juneau.utils.*;
/**
* A wrapper class around the {@link Class} object that provides cached information about that class.
- *
+ *
* <p>
* Instances of this class can be created through the {@link BeanContext#getClassMeta(Class)} method.
- *
+ *
* <p>
* The {@link BeanContext} class will cache and reuse instances of this class except for the following class types:
* <ul>
@@ -48,11 +48,11 @@ import org.apache.juneau.utils.*;
* <li>Maps with non-Object key/values.
* <li>Collections with non-Object key/values.
* </ul>
- *
+ *
* <p>
* This class is tied to the {@link BeanContext} class because it's that class that makes the determination of what is
* a bean.
- *
+ *
* @param <T> The class type of the wrapped class.
*/
@Bean(properties="innerClass,classCategory,elementType,keyType,valueType,notABeanReason,initException,beanMeta")
@@ -118,7 +118,7 @@ public final class ClassMeta<T> implements Type {
/**
* Construct a new {@code ClassMeta} based on the specified {@link Class}.
- *
+ *
* @param innerClass The class being wrapped.
* @param beanContext The bean context that created this object.
* @param implClass
@@ -202,7 +202,7 @@ public final class ClassMeta<T> implements Type {
/**
* Copy constructor.
- *
+ *
* <p>
* Used for creating Map and Collection class metas that shouldn't be cached.
*/
@@ -710,10 +710,10 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the type property name associated with this class and subclasses.
- *
+ *
* <p>
* If <jk>null</jk>, <js>"_type"</js> should be assumed.
- *
+ *
* @return
* The type property name associated with this bean class, or <jk>null</jk> if there is no explicit type
* property name defined or this isn't a bean.
@@ -724,10 +724,10 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the bean dictionary name associated with this class.
- *
+ *
* <p>
* The lexical name is defined by {@link Bean#typeName() @Bean.typeName()}.
- *
+ *
* @return
* The type name associated with this bean class, or <jk>null</jk> if there is no type name defined or this
* isn't a bean.
@@ -738,12 +738,12 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the bean registry for this class.
- *
+ *
* <p>
* This bean registry contains names specified in the {@link Bean#beanDictionary() @Bean.beanDictionary()} annotation
* defined on the class, regardless of whether the class is an actual bean.
* This allows interfaces to define subclasses with type names.
- *
+ *
* @return The bean registry for this class, or <jk>null</jk> if no bean registry is associated with it.
*/
public BeanRegistry getBeanRegistry() {
@@ -752,7 +752,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the category of this class.
- *
+ *
* @return The category of this class.
*/
public ClassCategory getClassCategory() {
@@ -761,7 +761,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a superclass of or the same as the specified class.
- *
+ *
* @param c The comparison class.
* @return <jk>true</jk> if this class is a superclass of or the same as the specified class.
*/
@@ -771,7 +771,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a subclass of or the same as the specified class.
- *
+ *
* @param c The comparison class.
* @return <jk>true</jk> if this class is a subclass of or the same as the specified class.
*/
@@ -781,11 +781,11 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class or any child classes has a {@link PojoSwap} associated with it.
- *
+ *
* <p>
* Used when transforming bean properties to prevent having to look up transforms if we know for certain that no
* transforms are associated with a bean property.
- *
+ *
* @return <jk>true</jk> if this class or any child classes has a {@link PojoSwap} associated with it.
*/
protected boolean hasChildPojoSwaps() {
@@ -795,7 +795,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the {@link PojoSwap} where the specified class is the same/subclass of the normal class of one of the
* child POJO swaps associated with this class.
- *
+ *
* @param normalClass The normal class being resolved.
* @return The resolved {@link PojoSwap} or <jk>null</jk> if none were found.
*/
@@ -822,7 +822,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the {@link PojoSwap} where the specified class is the same/subclass of the swap class of one of the child
* POJO swaps associated with this class.
- *
+ *
* @param swapClass The swap class being resolved.
* @return The resolved {@link PojoSwap} or <jk>null</jk> if none were found.
*/
@@ -848,12 +848,12 @@ public final class ClassMeta<T> implements Type {
/**
* Locates the no-arg constructor for the specified class.
- *
+ *
* <p>
* Constructor must match the visibility requirements specified by parameter 'v'.
* If class is abstract, always returns <jk>null</jk>.
* Note that this also returns the 1-arg constructor for non-static member classes.
- *
+ *
* @param c The class from which to locate the no-arg constructor.
* @param v The minimum visibility.
* @return The constructor, or <jk>null</jk> if no no-arg constructor exists with the required visibility.
@@ -874,7 +874,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the {@link Class} object that this class type wraps.
- *
+ *
* @return The wrapped class object.
*/
public Class<T> getInnerClass() {
@@ -883,7 +883,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the serialized (swapped) form of this class if there is an {@link PojoSwap} associated with it.
- *
+ *
* @param session
* The bean session.
* <br>Required because the swap used may depend on the media type being serialized or parsed.
@@ -898,7 +898,7 @@ public final class ClassMeta<T> implements Type {
/**
* For array and {@code Collection} types, returns the class type of the components of the array or
* {@code Collection}.
- *
+ *
* @return The element class type, or <jk>null</jk> if this class is not an array or Collection.
*/
public ClassMeta<?> getElementType() {
@@ -907,7 +907,7 @@ public final class ClassMeta<T> implements Type {
/**
* For {@code Map} types, returns the class type of the keys of the {@code Map}.
- *
+ *
* @return The key class type, or <jk>null</jk> if this class is not a Map.
*/
public ClassMeta<?> getKeyType() {
@@ -916,7 +916,7 @@ public final class ClassMeta<T> implements Type {
/**
* For {@code Map} types, returns the class type of the values of the {@code Map}.
- *
+ *
* @return The value class type, or <jk>null</jk> if this class is not a Map.
*/
public ClassMeta<?> getValueType() {
@@ -926,7 +926,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class implements {@link Delegate}, meaning it's a representation of some other
* object.
- *
+ *
* @return <jk>true</jk> if this class implements {@link Delegate}.
*/
public boolean isDelegate() {
@@ -935,7 +935,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a subclass of {@link Map}.
- *
+ *
* @return <jk>true</jk> if this class is a subclass of {@link Map}.
*/
public boolean isMap() {
@@ -944,7 +944,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a subclass of {@link Map} or it's a bean.
- *
+ *
* @return <jk>true</jk> if this class is a subclass of {@link Map} or it's a bean.
*/
public boolean isMapOrBean() {
@@ -953,7 +953,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a subclass of {@link BeanMap}.
- *
+ *
* @return <jk>true</jk> if this class is a subclass of {@link BeanMap}.
*/
public boolean isBeanMap() {
@@ -962,7 +962,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a subclass of {@link Collection}.
- *
+ *
* @return <jk>true</jk> if this class is a subclass of {@link Collection}.
*/
public boolean isCollection() {
@@ -971,7 +971,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a subclass of {@link Collection} or is an array.
- *
+ *
* @return <jk>true</jk> if this class is a subclass of {@link Collection} or is an array.
*/
public boolean isCollectionOrArray() {
@@ -980,7 +980,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is {@link Class}.
- *
+ *
* @return <jk>true</jk> if this class is {@link Class}.
*/
public boolean isClass() {
@@ -989,7 +989,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is {@link Method}.
- *
+ *
* @return <jk>true</jk> if this class is {@link Method}.
*/
public boolean isMethod() {
@@ -998,7 +998,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is an {@link Enum}.
- *
+ *
* @return <jk>true</jk> if this class is an {@link Enum}.
*/
public boolean isEnum() {
@@ -1007,7 +1007,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is an array.
- *
+ *
* @return <jk>true</jk> if this class is an array.
*/
public boolean isArray() {
@@ -1016,7 +1016,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a bean.
- *
+ *
* @return <jk>true</jk> if this class is a bean.
*/
public boolean isBean() {
@@ -1025,7 +1025,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is {@link Object}.
- *
+ *
* @return <jk>true</jk> if this class is {@link Object}.
*/
public boolean isObject() {
@@ -1034,7 +1034,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is not {@link Object}.
- *
+ *
* @return <jk>true</jk> if this class is not {@link Object}.
*/
public boolean isNotObject() {
@@ -1043,7 +1043,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a subclass of {@link Number}.
- *
+ *
* @return <jk>true</jk> if this class is a subclass of {@link Number}.
*/
public boolean isNumber() {
@@ -1052,7 +1052,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a subclass of {@link Float} or {@link Double}.
- *
+ *
* @return <jk>true</jk> if this class is a subclass of {@link Float} or {@link Double}.
*/
public boolean isDecimal() {
@@ -1061,7 +1061,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a {@link Boolean}.
- *
+ *
* @return <jk>true</jk> if this class is a {@link Boolean}.
*/
public boolean isBoolean() {
@@ -1070,7 +1070,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a subclass of {@link CharSequence}.
- *
+ *
* @return <jk>true</jk> if this class is a subclass of {@link CharSequence}.
*/
public boolean isCharSequence() {
@@ -1079,7 +1079,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a {@link String}.
- *
+ *
* @return <jk>true</jk> if this class is a {@link String}.
*/
public boolean isString() {
@@ -1088,7 +1088,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a {@link Character}.
- *
+ *
* @return <jk>true</jk> if this class is a {@link Character}.
*/
public boolean isChar() {
@@ -1097,7 +1097,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a primitive.
- *
+ *
* @return <jk>true</jk> if this class is a primitive.
*/
public boolean isPrimitive() {
@@ -1106,7 +1106,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a {@link Date} or {@link Calendar}.
- *
+ *
* @return <jk>true</jk> if this class is a {@link Date} or {@link Calendar}.
*/
public boolean isDate() {
@@ -1115,7 +1115,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a {@link URI} or {@link URL}.
- *
+ *
* @return <jk>true</jk> if this class is a {@link URI} or {@link URL}.
*/
public boolean isUri() {
@@ -1124,7 +1124,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is a {@link Reader}.
- *
+ *
* @return <jk>true</jk> if this class is a {@link Reader}.
*/
public boolean isReader() {
@@ -1133,7 +1133,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is an {@link InputStream}.
- *
+ *
* @return <jk>true</jk> if this class is an {@link InputStream}.
*/
public boolean isInputStream() {
@@ -1142,7 +1142,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is {@link Void} or <jk>void</jk>.
- *
+ *
* @return <jk>true</jk> if this class is {@link Void} or <jk>void</jk>.
*/
public boolean isVoid() {
@@ -1151,7 +1151,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this metadata represents an array of argument types.
- *
+ *
* @return <jk>true</jk> if this metadata represents an array of argument types.
*/
public boolean isArgs() {
@@ -1160,7 +1160,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the argument types of this meta.
- *
+ *
* @return The argument types of this meta, or <jk>null</jk> if this isn't an array of argument types.
*/
public ClassMeta<?>[] getArgs() {
@@ -1169,7 +1169,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the argument metadata at the specified index if this is an args metadata object.
- *
+ *
* @param index The argument index.
* @return The The argument metadata. Never <jk>null</jk>.
* @throws BeanRuntimeException If this metadata object is not a list of arguments, or the index is out of range.
@@ -1182,11 +1182,11 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if instance of this object can be <jk>null</jk>.
- *
+ *
* <p>
* Objects can be <jk>null</jk>, but primitives cannot, except for chars which can be represented by
* <code>(<jk>char</jk>)0</code>.
- *
+ *
* @return <jk>true</jk> if instance of this class can be null.
*/
public boolean isNullable() {
@@ -1197,7 +1197,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class or one of it's methods are annotated with {@link Remoteable @Remotable}.
- *
+ *
* @return <jk>true</jk> if this class is remoteable.
*/
public boolean isRemoteable() {
@@ -1206,7 +1206,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is abstract.
- *
+ *
* @return <jk>true</jk> if this class is abstract.
*/
public boolean isAbstract() {
@@ -1215,7 +1215,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is an inner class.
- *
+ *
* @return <jk>true</jk> if this class is an inner class.
*/
public boolean isMemberClass() {
@@ -1225,10 +1225,10 @@ public final class ClassMeta<T> implements Type {
/**
* All methods on this class annotated with {@link Remoteable @Remotable}, or all public methods if class is
* annotated.
- *
+ *
* <p>
* Keys are method signatures.
- *
+ *
* @return All remoteable methods on this class.
*/
public Map<String,Method> getRemoteableMethods() {
@@ -1237,10 +1237,10 @@ public final class ClassMeta<T> implements Type {
/**
* All public methods on this class including static methods.
- *
+ *
* <p>
* Keys are method signatures.
- *
+ *
* @return The public methods on this class.
*/
public Map<String,Method> getPublicMethods() {
@@ -1249,7 +1249,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the {@link PojoSwap} associated with this class that's the best match for the specified session.
- *
+ *
* @param session
* The current bean session.
* <br>If multiple swaps are associated with a class, only the first one with a matching media type will
@@ -1278,7 +1278,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the {@link BeanMeta} associated with this class.
- *
+ *
* @return
* The {@link BeanMeta} associated with this class, or <jk>null</jk> if there is no bean meta associated with
* this class.
@@ -1289,7 +1289,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the no-arg constructor for this class.
- *
+ *
* @return The no-arg constructor for this class, or <jk>null</jk> if it does not exist.
*/
public Constructor<? extends T> getConstructor() {
@@ -1298,7 +1298,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the language-specified extended metadata on this class.
- *
+ *
* @param c The name of the metadata class to create.
* @return Extended metadata on this class. Never <jk>null</jk>.
*/
@@ -1308,7 +1308,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the interface proxy invocation handler for this class.
- *
+ *
* @return The interface proxy invocation handler, or <jk>null</jk> if it does not exist.
*/
public InvocationHandler getProxyInvocationHandler() {
@@ -1317,7 +1317,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class has a no-arg constructor or invocation handler.
- *
+ *
* @return <jk>true</jk> if a new instance of this class can be constructed.
*/
public boolean canCreateNewInstance() {
@@ -1336,7 +1336,7 @@ public final class ClassMeta<T> implements Type {
* Returns <jk>true</jk> if this class has a no-arg constructor or invocation handler.
* Returns <jk>false</jk> if this is a non-static member class and the outer object does not match the class type of
* the defining class.
- *
+ *
* @param outer
* The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
* @return
@@ -1352,7 +1352,7 @@ public final class ClassMeta<T> implements Type {
* Returns <jk>true</jk> if this class can be instantiated as a bean.
* Returns <jk>false</jk> if this is a non-static member class and the outer object does not match the class type of
* the defining class.
- *
+ *
* @param outer
* The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
* @return
@@ -1370,7 +1370,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class can call the {@link #newInstanceFromString(Object, String)} method.
- *
+ *
* @param outer
* The outer class object for non-static member classes.
* Can be <jk>null</jk> for non-member or static classes.
@@ -1389,7 +1389,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class can call the {@link #newInstanceFromString(Object, String)} method.
- *
+ *
* @param outer
* The outer class object for non-static member classes.
* Can be <jk>null</jk> for non-member or static classes.
@@ -1406,7 +1406,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the class type of the parameter of the numeric constructor.
- *
+ *
* @return The class type of the numeric constructor, or <jk>null</jk> if no such constructor exists.
*/
@SuppressWarnings("unchecked")
@@ -1416,7 +1416,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the method or field annotated with {@link NameProperty @NameProperty}.
- *
+ *
* @return
* The method or field annotated with {@link NameProperty @NameProperty} or <jk>null</jk> if method does not
* exist.
@@ -1427,7 +1427,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the method or field annotated with {@link ParentProperty @ParentProperty}.
- *
+ *
* @return
* The method or field annotated with {@link ParentProperty @ParentProperty} or <jk>null</jk> if method does not
* exist.
@@ -1438,7 +1438,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the reason why this class is not a bean, or <jk>null</jk> if it is a bean.
- *
+ *
* @return The reason why this class is not a bean, or <jk>null</jk> if it is a bean.
*/
public synchronized String getNotABeanReason() {
@@ -1447,7 +1447,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns any exception that was throw in the <code>init()</code> method.
- *
+ *
* @return The cached exception.
*/
public Throwable getInitException() {
@@ -1456,7 +1456,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the {@link BeanContext} that created this object.
- *
+ *
* @return The bean context.
*/
public BeanContext getBeanContext() {
@@ -1465,7 +1465,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the default value for primitives such as <jk>int</jk> or <jk>Integer</jk>.
- *
+ *
* @return The default value, or <jk>null</jk> if this class type is not a primitive.
*/
@SuppressWarnings("unchecked")
@@ -1475,7 +1475,7 @@ public final class ClassMeta<T> implements Type {
/**
* Create a new instance of the main class of this declared type from a <code>String</code> input.
- *
+ *
* <p>
* In order to use this method, the class must have one of the following methods:
* <ul>
@@ -1483,7 +1483,7 @@ public final class ClassMeta<T> implements Type {
* <li><code><jk>public static</jk> T fromString(String in);</code>
* <li><code><jk>public</jk> T(String in);</code>
* </ul>
- *
+ *
* @param outer
* The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
* @param arg The input argument value.
@@ -1513,13 +1513,13 @@ public final class ClassMeta<T> implements Type {
/**
* Create a new instance of the main class of this declared type from a <code>Number</code> input.
- *
+ *
* <p>
* In order to use this method, the class must have one of the following methods:
* <ul>
* <li><code><jk>public</jk> T(Number in);</code>
* </ul>
- *
+ *
* @param session The current bean session.
* @param outer
* The outer class object for non-static member classes.
@@ -1548,7 +1548,7 @@ public final class ClassMeta<T> implements Type {
/**
* Create a new instance of the main class of this declared type.
- *
+ *
* @return A new instance of the object, or <jk>null</jk> if there is no no-arg constructor on the object.
* @throws IllegalAccessException
* If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is
@@ -1586,7 +1586,7 @@ public final class ClassMeta<T> implements Type {
/**
* Same as {@link #newInstance()} except for instantiating non-static member classes.
- *
+ *
* @param outer
* The instance of the owning object of the member class instance.
* Can be <jk>null</jk> if instantiating a non-member or static class.
@@ -1618,7 +1618,7 @@ public final class ClassMeta<T> implements Type {
/**
* Checks to see if the specified class type is the same as this one.
- *
+ *
* @param t The specified class type.
* @return <jk>true</jk> if the specified class type is the same as the class for this type.
*/
@@ -1633,7 +1633,7 @@ public final class ClassMeta<T> implements Type {
/**
* Similar to {@link #equals(Object)} except primitive and Object types that are similar are considered the same.
* (e.g. <jk>boolean</jk> == <code>Boolean</code>).
- *
+ *
* @param cm The class meta to compare to.
* @return <jk>true</jk> if the specified class-meta is equivalent to this one.
*/
@@ -1650,7 +1650,7 @@ public final class ClassMeta<T> implements Type {
/**
* Same as {@link #toString()} except use simple class names.
- *
+ *
* @param simple Print simple class names only (no package).
* @return A new string.
*/
@@ -1660,7 +1660,7 @@ public final class ClassMeta<T> implements Type {
/**
* Appends this object as a readable string to the specified string builder.
- *
+ *
* @param sb The string builder to append this object to.
* @param simple Print simple class names only (no package).
* @return The same string builder passed in (for method chaining).
@@ -1692,10 +1692,10 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if the specified object is an instance of this class.
- *
+ *
* <p>
* This is a simple comparison on the base class itself and not on any generic parameters.
- *
+ *
* @param o The object to check.
* @return <jk>true</jk> if the specified object is an instance of this class.
*/
@@ -1707,7 +1707,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns a readable name for this class (e.g. <js>"java.lang.String"</js>, <js>"boolean[]"</js>).
- *
+ *
* @return The readable name for this class.
*/
public String getReadableName() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ClassMetaExtended.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ClassMetaExtended.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ClassMetaExtended.java
index b085de1..e502732 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ClassMetaExtended.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ClassMetaExtended.java
@@ -14,7 +14,7 @@ package org.apache.juneau;
/**
* Defines extended language-specific metadata associated with a class.
- *
+ *
* <p>
* Serializers and parsers can implement their own language-specific metadata on a class and retrieve the metadata
* using the {@link ClassMeta#getExtendedMeta(Class)} method.
@@ -25,7 +25,7 @@ public class ClassMetaExtended {
/**
* Constructor.
- *
+ *
* @param cm The metadata of the class we're extending.
* @throws BeanRuntimeException If any error occurred trying to construct the metadata.
*/
@@ -35,7 +35,7 @@ public class ClassMetaExtended {
/**
* Returns the class metadata that was passed into the constructor.
- *
+ *
* @return The class metadata that was passed into the constructor.
*/
protected ClassMeta<?> getClassMeta() {
@@ -44,7 +44,7 @@ public class ClassMetaExtended {
/**
* Convenience method for calling {@link ClassMeta#getInnerClass()} on the metadata passed to the constructor.
- *
+ *
* @return The class wrapped by this metadata.
*/
protected Class<?> getInnerClass() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ConfigException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ConfigException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ConfigException.java
index 10e44f6..c7b8805 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ConfigException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ConfigException.java
@@ -22,7 +22,7 @@ public class ConfigException extends FormattedRuntimeException {
/**
* Constructor
- *
+ *
* @param message The error message.
* @param args Optional {@link MessageFormat}-style arguments.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Context.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Context.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Context.java
index 5c7649b..16a7fe3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Context.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Context.java
@@ -22,10 +22,10 @@ import org.apache.juneau.serializer.*;
/**
* A reusable stateless thread-safe read-only configuration, typically used for creating one-time use {@link Session}
* objects.
- *
+ *
* <p>
* Contexts are created through the {@link ContextBuilder#build()} method (and subclasses of {@link ContextBuilder}).
- *
+ *
* <p>
* Subclasses MUST implement the following constructor:
*
@@ -37,7 +37,7 @@ import org.apache.juneau.serializer.*;
* Besides that restriction, a context object can do anything you desire.
* <br>However, it MUST be thread-safe and all fields should be declared final to prevent modification.
* <br>It should NOT be used for storing temporary or state information.
- *
+ *
* @see PropertyStore
*/
public abstract class Context {
@@ -47,10 +47,10 @@ public abstract class Context {
/**
* Constructor for this class.
- *
+ *
* <p>
* Subclasses MUST implement the same public constructor.
- *
+ *
* @param ps The read-only configuration for this context object.
*/
public Context(PropertyStore ps) {
@@ -394,7 +394,7 @@ public abstract class Context {
/**
* Returns the property store associated with this context.
- *
+ *
* @return The property store associated with this context.
*/
@BeanIgnore
@@ -416,11 +416,11 @@ public abstract class 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.
- *
+ *
* @return A new session object.
*/
public Session createSession() {
@@ -430,7 +430,7 @@ public abstract class Context {
/**
* Create a new session based on the properties defined on this context combined with the specified
* runtime args.
- *
+ *
* <p>
* Use this method for creating sessions if you don't need to override any
* properties or locale/timezone currently set on this context.
@@ -450,7 +450,7 @@ public abstract class Context {
/**
* Returns the properties defined on this bean context as a simple map for debugging purposes.
- *
+ *
* @return A new map containing the properties defined on this context.
*/
public ObjectMap asMap() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextBuilder.java
index 47bcaa3..321fb46 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextBuilder.java
@@ -32,7 +32,7 @@ public abstract class ContextBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public ContextBuilder(PropertyStore ps) {
@@ -66,7 +66,7 @@ public abstract class ContextBuilder {
/**
* Build the object.
- *
+ *
* @return The built object.
* Subsequent calls to this method will create new instances.
*/
@@ -74,7 +74,7 @@ public abstract class ContextBuilder {
/**
* Copies the settings from the specified property store into this builder.
- *
+ *
* @param copyFrom The factory whose settings are being copied.
* @return This object (for method chaining).
*/
@@ -85,7 +85,7 @@ public abstract class ContextBuilder {
/**
* Build a new instance of the specified object.
- *
+ *
* @param c The subclass of {@link Context} to instantiate.
* @return A new object using the settings defined in this builder.
*/
@@ -109,7 +109,7 @@ public abstract class ContextBuilder {
/**
* Sets a configuration property on this object.
- *
+ *
* @param name The property name.
* @param value The property value.
* @return This object (for method chaining).
@@ -140,7 +140,7 @@ public abstract class ContextBuilder {
/**
* Sets multiple configuration properties on this object.
- *
+ *
* @param properties The properties to set on this class.
* @return This object (for method chaining).
* @see PropertyStoreBuilder#set(java.util.Map)
@@ -152,7 +152,7 @@ public abstract class ContextBuilder {
/**
* Adds multiple configuration properties on this object.
- *
+ *
* @param properties The properties to set on this class.
* @return This object (for method chaining).
* @see PropertyStoreBuilder#add(java.util.Map)
@@ -164,7 +164,7 @@ public abstract class ContextBuilder {
/**
* Adds a value to a SET or LIST property.
- *
+ *
* @param name The property name.
* @param value The new value to add to the SET property.
* @return This object (for method chaining).
@@ -177,7 +177,7 @@ public abstract class ContextBuilder {
/**
* Adds or overwrites a value to a SET, LIST, or MAP property.
- *
+ *
* @param name The property name.
* @param key The property value map key.
* @param value The property value map value.
@@ -191,7 +191,7 @@ public abstract class ContextBuilder {
/**
* Removes a value from a SET, LIST, or MAP property.
- *
+ *
* @param name The property name.
* @param value The property value in the SET property.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextRuntimeException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextRuntimeException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextRuntimeException.java
index cae3726..1b92f5f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextRuntimeException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextRuntimeException.java
@@ -21,7 +21,7 @@ public final class ContextRuntimeException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param message The error message.
*/
public ContextRuntimeException(String message) {
@@ -30,7 +30,7 @@ public final class ContextRuntimeException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param message The error message.
* @param args Arguments passed in to the {@code String.format()} method.
*/
@@ -40,7 +40,7 @@ public final class ContextRuntimeException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param cause The initial cause of the exception.
* @param message The error message.
* @param args Arguments passed in to the {@code String.format()} method.
@@ -52,7 +52,7 @@ public final class ContextRuntimeException extends FormattedRuntimeException {
/**
* Constructor.
- *
+ *
* @param cause The initial cause of the exception.
*/
public ContextRuntimeException(Throwable cause) {
@@ -62,7 +62,7 @@ public final class ContextRuntimeException extends FormattedRuntimeException {
/**
* 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/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Delegate.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Delegate.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Delegate.java
index 00d0bec..23a828f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Delegate.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Delegate.java
@@ -14,20 +14,20 @@ package org.apache.juneau;
/**
* An object that represents another object, often wrapping that object.
- *
+ *
* <p>
* <b>*** Internal Interface - Not intended for external use ***</b>
- *
+ *
* <p>
* For example, {@link BeanMap} is a map representation of a bean.
- *
+ *
* @param <T> The represented class type.
*/
public interface Delegate<T> {
/**
* The {@link ClassMeta} of the class of the represented object.
- *
+ *
* @return The class type of the represented object.
*/
public ClassMeta<T> getClassMeta();
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedException.java
index 11096f1..fa91007 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedException.java
@@ -25,7 +25,7 @@ public class FormattedException extends Exception {
/**
* Constructor.
- *
+ *
* @param message The {@link MessageFormat}-style message.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -35,7 +35,7 @@ public class FormattedException extends Exception {
/**
* Constructor.
- *
+ *
* @param causedBy The cause of this exception.
* @param message The {@link MessageFormat}-style message.
* @param args Optional {@link MessageFormat}-style arguments.
@@ -47,7 +47,7 @@ public class FormattedException extends Exception {
/**
* Constructor.
- *
+ *
* @param causedBy The cause of this exception.
*/
public FormattedException(Throwable causedBy) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedIllegalArgumentException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedIllegalArgumentException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedIllegalArgumentException.java
index 4922968..c2defda 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedIllegalArgumentException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedIllegalArgumentException.java
@@ -25,7 +25,7 @@ public class FormattedIllegalArgumentException extends IllegalArgumentException
/**
* Constructor.
- *
+ *
* @param message The {@link MessageFormat}-style message.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -35,7 +35,7 @@ public class FormattedIllegalArgumentException extends IllegalArgumentException
/**
* Constructor.
- *
+ *
* @param causedBy The cause of this exception.
* @param message The {@link MessageFormat}-style message.
* @param args Optional {@link MessageFormat}-style arguments.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedRuntimeException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedRuntimeException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedRuntimeException.java
index b1bb74f..4b56148 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedRuntimeException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/FormattedRuntimeException.java
@@ -25,7 +25,7 @@ public class FormattedRuntimeException extends RuntimeException {
/**
* Constructor.
- *
+ *
* @param message The {@link MessageFormat}-style message.
* @param args Optional {@link MessageFormat}-style arguments.
*/
@@ -35,7 +35,7 @@ public class FormattedRuntimeException extends RuntimeException {
/**
* Constructor.
- *
+ *
* @param causedBy The cause of this exception.
* @param message The {@link MessageFormat}-style message.
* @param args Optional {@link MessageFormat}-style arguments.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/InvalidDataConversionException.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/InvalidDataConversionException.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/InvalidDataConversionException.java
index 89d0d28..cd5583f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/InvalidDataConversionException.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/InvalidDataConversionException.java
@@ -18,7 +18,7 @@ import org.apache.juneau.json.*;
/**
* General invalid conversion exception.
- *
+ *
* <p>
* Exception that gets thrown if you try to perform an invalid conversion, such as when calling
* {@code ObjectMap.getInt(...)} on a non-numeric <code>String</code>.
[26/32] juneau git commit: Javadoc updates.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
index ef01f78..ee1c6bb 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
@@ -21,7 +21,7 @@ import org.apache.juneau.annotation.*;
/**
* Describes a single HTTP header.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -29,7 +29,7 @@ import org.apache.juneau.annotation.*;
* <js>"type"</js>: <js>"integer"</js>
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -79,10 +79,10 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* A short description of the header.
- *
+ *
* @return
* The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -92,10 +92,10 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* A short description of the header.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -106,7 +106,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #description(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -116,12 +116,12 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* <p>
* Required. The type of the object.
* The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or <
* js>"array"</js>.
- *
+ *
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getType() {
@@ -130,12 +130,12 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
- *
+ *
* <p>
* Required. The type of the object.
* The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
* <js>"array"</js>.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -151,7 +151,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setType(String)}.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -161,12 +161,12 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
- *
+ *
* <p>
* The extending format for the previously mentioned <code>type</code>.
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
- *
+ *
* @return The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getFormat() {
@@ -175,12 +175,12 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
- *
+ *
* <p>
* The extending format for the previously mentioned <code>type</code>.
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
- *
+ *
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -191,7 +191,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setFormat(String)}.
- *
+ *
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -201,11 +201,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>items</property>.
- *
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
* Describes the type of items in the array.
- *
+ *
* @return The value of the <property>items</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Items getItems() {
@@ -214,11 +214,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>items</property>.
- *
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
* Describes the type of items in the array.
- *
+ *
* @param items The new value for the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -229,7 +229,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setItems(Items)}.
- *
+ *
* @param items The new value for the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -239,11 +239,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>collectionFormat</property>.
- *
+ *
* <p>
* Determines the format of the array if type array is used.
* <p>
- *
+ *
* Possible values are:
* <ul>
* <li><code>csv</code> - comma separated values <code>foo,bar</code>.
@@ -251,10 +251,10 @@ public class HeaderInfo extends SwaggerElement {
* <li><code>tsv</code> - tab separated values <code>foo\tbar</code>.
* <li><code>pipes</code> - pipe separated values <code>foo|bar</code>.
* </ul>
- *
+ *
* <p>
* Default value is <code>csv</code>.
- *
+ *
* @return
* The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -264,10 +264,10 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>collectionFormat</property>.
- *
+ *
* <p>
* Determines the format of the array if type array is used.
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -276,10 +276,10 @@ public class HeaderInfo extends SwaggerElement {
* <li><code>tsv</code> - tab separated values <code>foo\tbar</code>.
* <li><code>pipes</code> - pipe separated values <code>foo|bar</code>.
* </ul>
- *
+ *
* <p>
* Default value is <code>csv</code>.
- *
+ *
* @param collectionFormat The new value for the <property>collectionFormat</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -295,7 +295,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setCollectionFormat(String)}.
- *
+ *
* @param collectionFormat The new value for the <property>collectionFormat</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -305,14 +305,14 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>default</property>.
- *
+ *
* <p>
* Declares the value of the header that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
* 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 the header.
- *
+ *
* @return The value of the <property>_default</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Object getDefault() {
@@ -321,14 +321,14 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>default</property>.
- *
+ *
* <p>
* Declares the value of the header that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
* 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 the header.
- *
+ *
* @param _default The new value for the <property>_default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -339,7 +339,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setDefault(Object)}.
- *
+ *
* @param _default The new value for the <property>_default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -349,11 +349,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>maximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @return The value of the <property>maximum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMaximum() {
@@ -362,11 +362,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>maximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -377,7 +377,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaximum(Number)}.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -387,11 +387,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
* not set.
*/
@@ -401,11 +401,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMaximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -416,7 +416,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setExclusiveMaximum(Boolean)}.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -426,11 +426,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>minimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @return The value of the <property>minimum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMinimum() {
@@ -439,11 +439,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>minimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -454,7 +454,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinimum(Number)}.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -464,11 +464,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
* not set.
*/
@@ -478,11 +478,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMinimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -493,7 +493,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setExclusiveMinimum(Boolean)}.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -503,11 +503,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
* http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
- *
+ *
* @return The value of the <property>maxLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxLength() {
@@ -516,11 +516,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
* http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -531,7 +531,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaxLength(Integer)}.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -541,11 +541,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>minLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
* http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
- *
+ *
* @return The value of the <property>minLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinLength() {
@@ -554,11 +554,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>minLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
* http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
- *
+ *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -577,11 +577,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>pattern</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
* http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
- *
+ *
* @return The value of the <property>pattern</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getPattern() {
@@ -590,11 +590,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
* http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -605,7 +605,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setPattern(String)}.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -615,11 +615,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
* http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
- *
+ *
* @return The value of the <property>maxItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxItems() {
@@ -628,11 +628,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>maxItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
* http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -643,7 +643,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setMaxItems(Integer)}.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -653,11 +653,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>minItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
* http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
- *
+ *
* @return The value of the <property>minItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinItems() {
@@ -666,11 +666,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>minItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
* http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -681,7 +681,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setMinItems(Integer)}.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -691,11 +691,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>uniqueItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
* http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
- *
+ *
* @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Boolean getUniqueItems() {
@@ -704,11 +704,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>uniqueItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
* http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -719,7 +719,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setUniqueItems(Boolean)}.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -729,11 +729,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>enum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
* http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
- *
+ *
* @return The value of the <property>enum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Object> getEnum() {
@@ -742,11 +742,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>enum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
* http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
- *
+ *
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -757,11 +757,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
* http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
- *
+ *
* @param _enum
* The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -784,7 +784,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #addEnum(Object...)}.
- *
+ *
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -794,11 +794,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>multipleOf</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
* http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
- *
+ *
* @return The value of the <property>multipleOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMultipleOf() {
@@ -807,11 +807,11 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>multipleOf</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
* http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -822,7 +822,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Synonym for {@link #setMultipleOf(Number)}.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java
index 6a03d0a..35cfe6c 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java
@@ -17,7 +17,7 @@ import org.apache.juneau.annotation.*;
/**
* The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented
* in the Swagger-UI for convenience.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -36,7 +36,7 @@ import org.apache.juneau.annotation.*;
* <js>"version"</js>: <js>"1.0.1"</js>
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -64,10 +64,10 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>title</property>.
- *
+ *
* <p>
* Required. The title of the application.
- *
+ *
* @return The value of the <property>title</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getTitle() {
@@ -76,10 +76,10 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>title</property>.
- *
+ *
* <p>
* Required. The title of the application.
- *
+ *
* @param title The new value for the <property>title</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -90,7 +90,7 @@ public class Info extends SwaggerElement {
/**
* Synonym for {@link #setTitle(String)}.
- *
+ *
* @param title The new value for the <property>title</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -100,10 +100,10 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* A short description of the application. GFM syntax can be used for rich text representation.
- *
+ *
* @return
* The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -113,10 +113,10 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* A short description of the application. GFM syntax can be used for rich text representation.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -127,7 +127,7 @@ public class Info extends SwaggerElement {
/**
* Synonym for {@link #setDescription(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -137,10 +137,10 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>termsOfService</property>.
- *
+ *
* <p>
* The Terms of Service for the API.
- *
+ *
* @return The value of the <property>termsOfService</property> property on this bean, or <jk>null</jk> if it is not
* set.
*/
@@ -150,10 +150,10 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>termsOfService</property>.
- *
+ *
* <p>
* The Terms of Service for the API.
- *
+ *
* @param termsOfService The new value for the <property>termsOfService</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -164,7 +164,7 @@ public class Info extends SwaggerElement {
/**
* Synonym for {@link #setTermsOfService(String)}.
- *
+ *
* @param termsOfService The new value for the <property>termsOfService</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -174,10 +174,10 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>contact</property>.
- *
+ *
* <p>
* The contact information for the exposed API.
- *
+ *
* @return The value of the <property>contact</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Contact getContact() {
@@ -186,10 +186,10 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>contact</property>.
- *
+ *
* <p>
* The contact information for the exposed API.
- *
+ *
* @param contact The new value for the <property>contact</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -200,7 +200,7 @@ public class Info extends SwaggerElement {
/**
* Synonym for {@link #setContact(Contact)}.
- *
+ *
* @param contact The new value for the <property>contact</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -210,10 +210,10 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>license</property>.
- *
+ *
* <p>
* The license information for the exposed API.
- *
+ *
* @return The value of the <property>license</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public License getLicense() {
@@ -222,10 +222,10 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>license</property>.
- *
+ *
* <p>
* The license information for the exposed API.
- *
+ *
* @param license The new value for the <property>license</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -236,7 +236,7 @@ public class Info extends SwaggerElement {
/**
* Synonym for {@link #setLicense(License)}.
- *
+ *
* @param license The new value for the <property>license</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -246,10 +246,10 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>version</property>.
- *
+ *
* <p>
* Required. Provides the version of the application API (not to be confused with the specification version).
- *
+ *
* @return The value of the <property>version</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getVersion() {
@@ -258,10 +258,10 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>version</property>.
- *
+ *
* <p>
* Required. Provides the version of the application API (not to be confused with the specification version).
- *
+ *
* @param version The new value for the <property>version</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -272,7 +272,7 @@ public class Info extends SwaggerElement {
/**
* Synonym for {@link #setVersion(String)}.
- *
+ *
* @param version The new value for the <property>version</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
index 6aafda4..c5a4793 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
@@ -22,7 +22,7 @@ import org.apache.juneau.json.*;
/**
* A limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in "body".
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -30,7 +30,7 @@ import org.apache.juneau.json.*;
* <js>"minLength"</js>: 2
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -79,12 +79,12 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>type</property>.
- *
+ *
* <p>
* Required. The internal type of the array.
* The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
* <js>"array"</js>.
- *
+ *
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getType() {
@@ -93,12 +93,12 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
- *
+ *
* <p>
* Required. The internal type of the array.
* The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
* <js>"array"</js>.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -113,7 +113,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setType(String)}.
- *
+ *
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -123,11 +123,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
- *
+ *
* <p>
* The extending format for the previously mentioned <code>type</code>. See <a class="doclink"
* href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
- *
+ *
* @return The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getFormat() {
@@ -136,11 +136,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
- *
+ *
* <p>
* The extending format for the previously mentioned <code>type</code>. See <a class="doclink"
* href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
- *
+ *
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -151,7 +151,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setFormat(String)}.
- *
+ *
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -161,11 +161,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>items</property>.
- *
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
* Describes the type of items in the array.
- *
+ *
* @return The value of the <property>items</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Items getItems() {
@@ -174,11 +174,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>items</property>.
- *
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
* Describes the type of items in the array.
- *
+ *
* @param items The new value for the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -189,7 +189,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setItems(Items)}.
- *
+ *
* @param items The new value for the <property>items</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -199,10 +199,10 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>collectionFormat</property>.
- *
+ *
* <p>
* Determines the format of the array if type array is used.
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -211,10 +211,10 @@ public class Items extends SwaggerElement {
* <li><code>tsv</code> - tab separated values <code>foo\tbar</code>.
* <li><code>pipes</code> - pipe separated values <code>foo|bar</code>.
* </ul>
- *
+ *
* <p>
* Default value is <code>csv</code>.
- *
+ *
* @return
* The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -225,10 +225,10 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>collectionFormat</property>.
- *
+ *
* <p>
* Determines the format of the array if type array is used.
- *
+ *
* <p>
* Possible values are:
* <ul>
@@ -237,10 +237,10 @@ public class Items extends SwaggerElement {
* <li><code>tsv</code> - tab separated values <code>foo\tbar</code>.
* <li><code>pipes</code> - pipe separated values <code>foo|bar</code>.
* </ul>
- *
+ *
* <p>
* Default value is <code>csv</code>.
- *
+ *
* @param collectionFormat The new value for the <property>collectionFormat</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -256,7 +256,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setCollectionFormat(String)}.
- *
+ *
* @param collectionFormat The new value for the <property>collectionFormat</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -266,14 +266,14 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>default</property>.
- *
+ *
* <p>
* Declares the value of the item that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
* 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 the data type.
- *
+ *
* @return The value of the <property>default</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Object getDefault() {
@@ -282,14 +282,14 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>default</property>.
- *
+ *
* <p>
* Declares the value of the item that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
* 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 the data type.
- *
+ *
* @param _default The new value for the <property>default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -300,7 +300,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setDefault(Object)}.
- *
+ *
* @param _default The new value for the <property>default</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -310,11 +310,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>maximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @return The value of the <property>maximum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMaximum() {
@@ -323,11 +323,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>maximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -338,7 +338,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setMaximum(Number)}.
- *
+ *
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -348,11 +348,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @return
* The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
* not set.
@@ -363,11 +363,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMaximum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17">
* http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -378,7 +378,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setExclusiveMaximum(Boolean)}.
- *
+ *
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -388,11 +388,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>minimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @return The value of the <property>minimum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMinimum() {
@@ -401,11 +401,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>minimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -416,7 +416,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setMinimum(Number)}.
- *
+ *
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -426,11 +426,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
* not set.
*/
@@ -440,11 +440,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>exclusiveMinimum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21">
* http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -455,7 +455,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setExclusiveMinimum(Boolean)}.
- *
+ *
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -465,11 +465,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>maxLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
* http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
- *
+ *
* @return The value of the <property>maxLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxLength() {
@@ -478,11 +478,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>maxLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26">
* http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -493,7 +493,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setMaxLength(Integer)}.
- *
+ *
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -503,11 +503,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>minLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
* http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
- *
+ *
* @return The value of the <property>minLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinLength() {
@@ -516,11 +516,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>minLength</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29">
* http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.
- *
+ *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -531,7 +531,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setMinLength(Integer)}.
- *
+ *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -541,11 +541,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>pattern</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
* http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
- *
+ *
* @return The value of the <property>pattern</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getPattern() {
@@ -554,11 +554,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>pattern</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33">
* http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -569,7 +569,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setPattern(String)}.
- *
+ *
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -579,11 +579,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>maxItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
* http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
- *
+ *
* @return The value of the <property>maxItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxItems() {
@@ -592,11 +592,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>maxItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42">
* http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -607,7 +607,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setMaxItems(Integer)}.
- *
+ *
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -617,11 +617,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>minItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
* http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
- *
+ *
* @return The value of the <property>minItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinItems() {
@@ -630,11 +630,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>minItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
* http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -645,7 +645,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setMinItems(Integer)}.
- *
+ *
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -655,11 +655,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>uniqueItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
* http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
- *
+ *
* @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not
* set.
*/
@@ -669,11 +669,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>uniqueItems</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
* http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -684,7 +684,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setUniqueItems(Boolean)}.
- *
+ *
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -694,11 +694,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>enum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
* http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
- *
+ *
* @return The value of the <property>enum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Object> getEnum() {
@@ -707,11 +707,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>enum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
* http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
- *
+ *
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -722,11 +722,11 @@ public class Items extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
* http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
- *
+ *
* @param _enum
* The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -749,7 +749,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #addEnum(Object...)}.
- *
+ *
* @param _enum
* The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -761,11 +761,11 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>multipleOf</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
* http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
- *
+ *
* @return The value of the <property>multipleOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Number getMultipleOf() {
@@ -774,11 +774,11 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>multipleOf</property>.
- *
+ *
* <p>
* See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
* http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -789,7 +789,7 @@ public class Items extends SwaggerElement {
/**
* Synonym for {@link #setMultipleOf(Number)}.
- *
+ *
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/License.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/License.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/License.java
index 5b2a022..51aae5d 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/License.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/License.java
@@ -22,7 +22,7 @@ import org.apache.juneau.annotation.*;
/**
* License information for the exposed API.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -30,7 +30,7 @@ import org.apache.juneau.annotation.*;
* <js>"url"</js>: <js>"http://www.apache.org/licenses/LICENSE-2.0.html"</js>
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -54,10 +54,10 @@ public class License extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
- *
+ *
* <p>
* Required. The license name used for the API.
- *
+ *
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getName() {
@@ -66,10 +66,10 @@ public class License extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
- *
+ *
* <p>
* Required. The license name used for the API.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -80,7 +80,7 @@ public class License extends SwaggerElement {
/**
* Synonym for {@link #setName(String)}.
- *
+ *
* @param name The new value for the <property>name</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -90,17 +90,17 @@ public class License extends SwaggerElement {
/**
* Bean property getter: <property>url</property>.
- *
+ *
* <p>
* A URL to the license used for the API.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @return The value of the <property>url</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public URI getUrl() {
@@ -109,14 +109,14 @@ public class License extends SwaggerElement {
/**
* Bean property setter: <property>url</property>.
- *
+ *
* <p>
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
* Strings must be valid URIs.
- *
+ *
* <p>
* URIs defined by {@link UriResolver} can be used for values.
- *
+ *
* @param url The new value for the <property>url</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -127,7 +127,7 @@ public class License extends SwaggerElement {
/**
* Synonym for {@link #setUrl(Object)}.
- *
+ *
* @param url The new value for the <property>url</property> property on this bean.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Operation.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Operation.java b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Operation.java
index ec00295..be867bb 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Operation.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Operation.java
@@ -19,7 +19,7 @@ import org.apache.juneau.http.*;
/**
* Describes a single API operation on a path.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* {
@@ -77,7 +77,7 @@ import org.apache.juneau.http.*;
* ]
* }
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='link'>
@@ -111,11 +111,11 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>tags</property>.
- *
+ *
* <p>
* A list of tags for API documentation control.
* Tags can be used for logical grouping of operations by resources or any other qualifier.
- *
+ *
* @return The value of the <property>tags</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<String> getTags() {
@@ -124,11 +124,11 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>tags</property>.
- *
+ *
* <p>
* A list of tags for API documentation control.
* Tags can be used for logical grouping of operations by resources or any other qualifier.
- *
+ *
* @param tags The new value for the <property>tags</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -139,11 +139,11 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>tags</property>.
- *
+ *
* <p>
* A list of tags for API documentation control.
* Tags can be used for logical grouping of operations by resources or any other qualifier.
- *
+ *
* @param tags The values to add for the <property>tags</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -153,11 +153,11 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>tags</property>.
- *
+ *
* <p>
* A list of tags for API documentation control.
* Tags can be used for logical grouping of operations by resources or any other qualifier.
- *
+ *
* @param tags
* The values to add for the <property>tags</property> property on this bean.
* Ignored if <jk>null</jk>.
@@ -174,7 +174,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addTags(String...)}.
- *
+ *
* @param tags The new value for the <property>tags</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -184,7 +184,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addTags(Collection)}.
- *
+ *
* @param tags The new value for the <property>tags</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -194,11 +194,11 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>summary</property>.
- *
+ *
* <p>
* A short summary of what the operation does.
* For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
- *
+ *
* @return The value of the <property>summary</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getSummary() {
@@ -207,11 +207,11 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>summary</property>.
- *
+ *
* <p>
* A short summary of what the operation does.
* For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
- *
+ *
* @param summary The new value for the <property>summary</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -222,7 +222,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #setSummary(String)}.
- *
+ *
* @param summary The new value for the <property>summary</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -232,12 +232,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
- *
+ *
* <p>
* A verbose explanation of the operation behavior.
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
- *
+ *
* @return
* The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -247,12 +247,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
- *
+ *
* <p>
* A verbose explanation of the operation behavior.
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -263,7 +263,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #setDescription(String)}.
- *
+ *
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -273,10 +273,10 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>externalDocs</property>.
- *
+ *
* <p>
* Additional external documentation for this operation.
- *
+ *
* @return
* The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -286,10 +286,10 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>externalDocs</property>.
- *
+ *
* <p>
* Additional external documentation for this operation.
- *
+ *
* @param externalDocs The new value for the <property>externalDocs</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -300,7 +300,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #setExternalDocs(ExternalDocumentation)}.
- *
+ *
* @param externalDocs The new value for the <property>externalDocs</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -310,12 +310,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>operationId</property>.
- *
+ *
* <p>
* Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
* Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to
* follow common programming naming conventions.
- *
+ *
* @return
* The value of the <property>operationId</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -325,12 +325,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>operationId</property>.
- *
+ *
* <p>
* Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
* Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to
* follow common programming naming conventions.
- *
+ *
* @param operationId The new value for the <property>operationId</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -341,7 +341,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #setOperationId(String)}.
- *
+ *
* @param operationId The new value for the <property>operationId</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -351,13 +351,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>consumes</property>.
- *
+ *
* <p>
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @return The value of the <property>consumes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<MediaType> getConsumes() {
@@ -366,13 +366,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>consumes</property>.
- *
+ *
* <p>
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @param consumes The new value for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -383,13 +383,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>consumes</property>.
- *
+ *
* <p>
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @param consumes The new values to add to the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -399,13 +399,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>consumes</property>.
- *
+ *
* <p>
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @param consumes The new values to add to the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -420,7 +420,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addConsumes(MediaType...)}.
- *
+ *
* @param consumes The new values to add to the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -430,7 +430,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addConsumes(Collection)}.
- *
+ *
* @param consumes The new values to add to the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -440,13 +440,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>produces</property>.
- *
+ *
* <p>
* A list of MIME types the operation can produce.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @return The value of the <property>produces</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<MediaType> getProduces() {
@@ -455,13 +455,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>produces</property>.
- *
+ *
* <p>
* A list of MIME types the operation can produce.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -472,13 +472,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>produces</property>.
- *
+ *
* <p>
* A list of MIME types the operation can produce.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -493,13 +493,13 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>produces</property>.
- *
+ *
* <p>
* A list of MIME types the operation can produces.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
* Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
- *
+ *
* @param produces The new values to add to the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -514,7 +514,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addProduces(MediaType...)}.
- *
+ *
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -524,7 +524,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addProduces(Collection)}.
- *
+ *
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -534,7 +534,7 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>parameters</property>.
- *
+ *
* <p>
* A list of parameters that are applicable for this operation.
* If a parameter is already defined at the <a class="doclink"
@@ -545,7 +545,7 @@ public class Operation extends SwaggerElement {
* The list can use the <a class="doclink" href="http://swagger.io/specification/#referenceObject">Reference Object</a>
* to link to parameters that are defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
* There can be one <js>"body"</js> parameter at most.
- *
+ *
* @return The value of the <property>parameters</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<ParameterInfo> getParameters() {
@@ -554,7 +554,7 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>parameters</property>.
- *
+ *
* <p>
* A list of parameters that are applicable for this operation.
* If a parameter is already defined at the <a class="doclink"
@@ -567,7 +567,7 @@ public class Operation extends SwaggerElement {
* defined at the <a class="doclink"
* href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
* There can be one <js>"body"</js> parameter at most.
- *
+ *
* @param parameters The new value for the <property>parameters</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -578,7 +578,7 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>parameters</property>.
- *
+ *
* <p>
* A list of parameters that are applicable for this operation.
* If a parameter is already defined at the <a class="doclink"
@@ -591,7 +591,7 @@ public class Operation extends SwaggerElement {
* defined at the <a class="doclink"
* href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
* There can be one <js>"body"</js> parameter at most.
- *
+ *
* @param parameters The new value to add to the <property>parameters</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -604,7 +604,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addParameters(ParameterInfo...)}.
- *
+ *
* @param parameters The new value to add to the <property>parameters</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -614,7 +614,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #setParameters(List)}.
- *
+ *
* @param parameters The new value to add to the <property>parameters</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -624,10 +624,10 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>responses</property>.
- *
+ *
* <p>
* Required. The list of possible responses as they are returned from executing this operation.
- *
+ *
* @return The value of the <property>responses</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<Integer,ResponseInfo> getResponses() {
@@ -636,10 +636,10 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>responses</property>.
- *
+ *
* <p>
* Required. The list of possible responses as they are returned from executing this operation.
- *
+ *
* @param responses The new value for the <property>responses</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -650,10 +650,10 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>responses</property>.
- *
+ *
* <p>
* Required. The list of possible responses as they are returned from executing this operation.
- *
+ *
* @param statusCode The HTTP status code.
* @param response The response description.
* @return This object (for method chaining).
@@ -667,7 +667,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addResponse(Integer,ResponseInfo)}.
- *
+ *
* @param statusCode The HTTP status code.
* @param response The response description.
* @return This object (for method chaining).
@@ -678,7 +678,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #setResponses(Map)}.
- *
+ *
* @param responses The new value for the <property>responses</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -688,12 +688,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>schemes</property>.
- *
+ *
* <p>
* The transfer protocol for the operation.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
* The value overrides the Swagger Object <code>schemes</code> definition.
- *
+ *
* @return The value of the <property>schemes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<String> getSchemes() {
@@ -702,12 +702,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>schemes</property>.
- *
+ *
* <p>
* The transfer protocol for the operation.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
* The value overrides the Swagger Object <code>schemes</code> definition.
- *
+ *
* @param schemes The new value for the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -718,12 +718,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>schemes</property>.
- *
+ *
* <p>
* The transfer protocol for the operation.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
* The value overrides the Swagger Object <code>schemes</code> definition.
- *
+ *
* @param schemes The new values to add to the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -733,12 +733,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>schemes</property>.
- *
+ *
* <p>
* The transfer protocol for the operation.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
* The value overrides the Swagger Object <code>schemes</code> definition.
- *
+ *
* @param schemes The new values to add to the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -751,7 +751,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addSchemes(String...)}.
- *
+ *
* @param schemes The new values to add to the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -761,12 +761,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>deprecated</property>.
- *
+ *
* <p>
* Declares this operation to be deprecated.
* Usage of the declared operation should be refrained.
* Default value is <jk>false</jk>.
- *
+ *
* @return The value of the <property>deprecated</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Boolean getDeprecated() {
@@ -775,12 +775,12 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>deprecated</property>.
- *
+ *
* <p>
* Declares this operation to be deprecated.
* Usage of the declared operation should be refrained.
* Default value is <jk>false</jk>.
- *
+ *
* @param deprecated The new value for the <property>deprecated</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -791,7 +791,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #setDeprecated(Boolean)}.
- *
+ *
* @param deprecated The new value for the <property>deprecated</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -801,14 +801,14 @@ public class Operation extends SwaggerElement {
/**
* Bean property getter: <property>security</property>.
- *
+ *
* <p>
* A declaration of which security schemes are applied for this operation.
* The list of values describes alternative security schemes that can be used (that is, there is a logical OR
* between the security requirements).
* This definition overrides any declared top-level security.
* To remove a top-level <code>security</code> declaration, an empty array can be used.
- *
+ *
* @return The value of the <property>security</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public List<Map<String,List<String>>> getSecurity() {
@@ -817,14 +817,14 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>security</property>.
- *
+ *
* <p>
* A declaration of which security schemes are applied for this operation.
* The list of values describes alternative security schemes that can be used (that is, there is a logical OR
* between the security requirements).
* This definition overrides any declared top-level security.
* To remove a top-level <code>security</code> declaration, an empty array can be used.
- *
+ *
* @param security The new value for the <property>security</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -835,14 +835,14 @@ public class Operation extends SwaggerElement {
/**
* Bean property adder: <property>security</property>.
- *
+ *
* <p>
* A declaration of which security schemes are applied for this operation.
* The list of values describes alternative security schemes that can be used (that is, there is a logical OR
* between the security requirements).
* This definition overrides any declared top-level security.
* To remove a top-level <code>security</code> declaration, an empty array can be used.
- *
+ *
* @param security The new value to add to the <property>security</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -855,7 +855,7 @@ public class Operation extends SwaggerElement {
/**
* Synonym for {@link #addSecurity(Map)}.
- *
+ *
* @param scheme The security scheme that applies to this operation
* @param alternatives
* The list of values describes alternative security schemes that can be used (that is, there is a logical OR