You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/06/28 01:49:40 UTC
[1/9] incubator-juneau git commit: Clean up javadocs.
Repository: incubator-juneau
Updated Branches:
refs/heads/master 0d913b38f -> 19c566dd2
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Expires.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Expires.java b/juneau-core/src/main/java/org/apache/juneau/http/Expires.java
index 80e26bd..cce726d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Expires.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Expires.java
@@ -14,6 +14,7 @@ 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).
*
@@ -23,38 +24,48 @@ package org.apache.juneau.http;
* </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
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/From.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/From.java b/juneau-core/src/main/java/org/apache/juneau/http/From.java
index 14d5609..7a3706f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/From.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/From.java
@@ -14,6 +14,7 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>From</l> HTTP request header.
+ *
* <p>
* The email address of the user making the request.
*
@@ -27,14 +28,17 @@ package org.apache.juneau.http;
* 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.
@@ -43,9 +47,11 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java
index a1b7b92..1a1ad66 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderDate.java
@@ -16,6 +16,7 @@ import org.apache.juneau.internal.*;
/**
* Category of headers that consist of a single HTTP-date.
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
index d0faf41..d1b1cc4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidator.java
@@ -14,6 +14,7 @@ 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
index 4ba2259..b8675c1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEntityValidatorArray.java
@@ -16,6 +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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java
index 230aa61..56a202f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderEnum.java
@@ -14,6 +14,7 @@ package org.apache.juneau.http;
/**
* Category of headers that consist of a single enum value.
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
@@ -65,6 +66,7 @@ public class HeaderEnum<E extends Enum<E>> {
/**
* Returns this header as a simple string value.
+ *
* <p>
* Functionally equivalent to calling {@link #toString()}.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java
index 4a628f3..2e58b32 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderInteger.java
@@ -14,6 +14,7 @@ package org.apache.juneau.http;
/**
* Category of headers that consist of a single integer value.
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
@@ -53,6 +54,7 @@ public class HeaderInteger {
/**
* Returns this header as a simple string value.
+ *
* <p>
* Functionally equivalent to calling {@link #toString()}.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
index 6401574..8567ca4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderRangeArray.java
@@ -18,6 +18,7 @@ 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'>
@@ -68,6 +69,7 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java
index 5195550..659300c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderString.java
@@ -16,6 +16,7 @@ import org.apache.juneau.internal.*;
/**
* Category of headers that consist of a single string value.
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
@@ -66,6 +67,7 @@ public class HeaderString {
/**
* Returns this header as a simple string value.
+ *
* <p>
* Functionally equivalent to calling {@link #toString()}.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java
index 6ba933e..ca07d3c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderStringArray.java
@@ -16,6 +16,7 @@ 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'>
@@ -46,6 +47,7 @@ public class HeaderStringArray {
/**
* Returns this header as a simple string value.
+ *
* <p>
* Functionally equivalent to calling {@link #toString()}.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java b/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java
index c4c976d..feae45d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HeaderUri.java
@@ -18,6 +18,7 @@ import org.apache.juneau.internal.*;
/**
* Category of headers that consist of a single URL value.
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
@@ -57,6 +58,7 @@ public class HeaderUri{
/**
* Returns this header as a simple string value.
+ *
* <p>
* Functionally equivalent to calling {@link #toString()}.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Host.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Host.java b/juneau-core/src/main/java/org/apache/juneau/http/Host.java
index d60c6a1..cc548da 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Host.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Host.java
@@ -14,6 +14,7 @@ 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.
@@ -33,9 +34,11 @@ package org.apache.juneau.http;
* 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).
@@ -44,6 +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
@@ -52,6 +56,7 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java b/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java
index 76876ae..58313a2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/HttpMethod.java
@@ -69,6 +69,7 @@ public enum HttpMethod {
/**
* Returns the enum for the specified key.
+ *
* <p>
* Case is ignored.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java b/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java
index e8a09c6..a2d5b02 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfMatch.java
@@ -14,6 +14,7 @@ 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
@@ -34,39 +35,50 @@ 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'>
* If-Match: "xyzzy"
* 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java b/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java
index 30adcfe..5deef37 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfModifiedSince.java
@@ -14,6 +14,7 @@ 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.
*
@@ -27,14 +28,17 @@ package org.apache.juneau.http;
* 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.
@@ -48,17 +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
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java b/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java
index 1494f9b..81c00fa 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfNoneMatch.java
@@ -14,6 +14,7 @@ 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.
*
@@ -31,11 +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
@@ -45,23 +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'>
@@ -71,6 +80,7 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java b/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java
index 6fe2995..b941b2b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfRange.java
@@ -18,6 +18,7 @@ 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.
*
@@ -33,6 +34,7 @@ import org.apache.juneau.internal.*;
* 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
@@ -40,6 +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.
@@ -47,6 +50,7 @@ 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.
@@ -94,7 +98,8 @@ 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
+ * @return
+ * This header value as a {@link EntityValidator} object, or <jk>null</jk> if the value is not an entity
* validator.
*/
public EntityValidator asValidator() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java b/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
index a5d83a3..5d1f74f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/IfUnmodifiedSince.java
@@ -14,6 +14,7 @@ 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.
*
@@ -23,25 +24,32 @@ package org.apache.juneau.http;
* </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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java b/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java
index 56a9041..94d543a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/LastModified.java
@@ -14,6 +14,7 @@ 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).
*
@@ -26,14 +27,17 @@ package org.apache.juneau.http;
*
* 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.
@@ -42,15 +46,18 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Location.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Location.java b/juneau-core/src/main/java/org/apache/juneau/http/Location.java
index fdf3c7a..8734aaf 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Location.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Location.java
@@ -14,6 +14,7 @@ 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.
*
@@ -29,14 +30,17 @@ package org.apache.juneau.http;
* 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java b/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java
index c94a2cd..fa8dc07 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/MaxForwards.java
@@ -14,6 +14,7 @@ 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.
*
@@ -28,12 +29,15 @@ package org.apache.juneau.http;
* 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.
@@ -41,6 +45,7 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java b/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java
index 148054a..8e8d47d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java
@@ -72,18 +72,22 @@ 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 '=='.
- * <p>
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>Spaces are replaced with <js>'+'</js> characters.
+ * <li>
+ * Spaces are replaced with <js>'+'</js> characters.
* This gets around the issue where passing media type strings with <js>'+'</js> as HTTP GET parameters
* get replaced with spaces by your browser. Since spaces aren't supported by the spec, this
* is doesn't break anything.
- * <li>Anything including and following the <js>';'</js> character is ignored (e.g. <js>";charset=X"</js>).
+ * <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.
- * Returns <jk>null</jk> if input is null.
+ * @param s
+ * The media type string.
+ * Will be lowercased.
+ * Returns <jk>null</jk> if input is null.
* @return A cached media type object.
*/
public static MediaType forString(String s) {
@@ -168,6 +172,8 @@ 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>
*
@@ -179,6 +185,7 @@ public class MediaType implements Comparable<MediaType> {
/**
* Returns <jk>true</jk> if this media type is a match for the specified media type.
+ *
* <p>
* Matches if any of the following is true:
* <ul>
@@ -197,6 +204,7 @@ public class MediaType implements Comparable<MediaType> {
/**
* Returns a match metric against the specified media type where a larger number represents a better match.
+ *
* <p>
* <ul>
* <li>Exact matches (e.g. <js>"text/json"<js>/</js>"text/json"</js>) should match
@@ -253,6 +261,7 @@ 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>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java b/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java
index dd48a70..0267b3d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/MediaTypeRange.java
@@ -42,9 +42,11 @@ 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:
@@ -60,11 +62,13 @@ public final class MediaTypeRange implements Comparable<MediaTypeRange> {
* 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.
- * @return The media ranges described by the string.
- * The 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.
+ * @param value
+ * The value to parse.
+ * If <jk>null</jk> or empty, returns a single <code>MediaTypeRange</code> is returned that represents all types.
+ * @return
+ * The media ranges described by the string.
+ * The 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.
*/
public static MediaTypeRange[] parse(String value) {
@@ -157,8 +161,10 @@ 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>.
@@ -171,6 +177,7 @@ 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>.
*
@@ -182,6 +189,7 @@ 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.
*
@@ -245,6 +253,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
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java b/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java
index 85d9408..e95b1cc 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Pragma.java
@@ -14,6 +14,7 @@ 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.
*
@@ -23,15 +24,18 @@ package org.apache.juneau.http;
* </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.
@@ -39,14 +43,17 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java b/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java
index dc60d54..fc5da1c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthenticate.java
@@ -14,6 +14,7 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l> Proxy-Authenticate</l> HTTP response header.
+ *
* <p>
* Request authentication to access the proxy.
*
@@ -28,9 +29,11 @@ package org.apache.juneau.http;
* 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
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java b/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java
index b944aa0..f6bb7ab 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ProxyAuthorization.java
@@ -14,6 +14,7 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Proxy-Authorization</l> HTTP request header.
+ *
* <p>
* Authorization credentials for connecting to a proxy.
*
@@ -28,9 +29,11 @@ package org.apache.juneau.http;
* 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
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Range.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Range.java b/juneau-core/src/main/java/org/apache/juneau/http/Range.java
index 00248db..2c105fe 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Range.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Range.java
@@ -14,6 +14,7 @@ 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.
*
@@ -27,9 +28,11 @@ package org.apache.juneau.http;
* 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'>
@@ -40,19 +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.
@@ -60,11 +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
@@ -74,6 +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'>
@@ -86,18 +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>
@@ -109,8 +123,11 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Referer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Referer.java b/juneau-core/src/main/java/org/apache/juneau/http/Referer.java
index 3230a0a..f7ba76f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Referer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Referer.java
@@ -14,6 +14,7 @@ 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
@@ -33,14 +34,17 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java b/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java
index 60c76a0..d5278e8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/RetryAfter.java
@@ -18,6 +18,7 @@ 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.
@@ -29,21 +30,25 @@ import org.apache.juneau.internal.*;
* </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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Server.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Server.java b/juneau-core/src/main/java/org/apache/juneau/http/Server.java
index 0325cf9..e98a3a0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Server.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Server.java
@@ -14,6 +14,7 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Server</l> HTTP response header.
+ *
* <p>
* A name for the server.
*
@@ -29,17 +30,21 @@ package org.apache.juneau.http;
* 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java b/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java
index 2510511..561d5d9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/StringRange.java
@@ -19,11 +19,13 @@ import org.apache.juneau.annotation.*;
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.
+ * 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.
*
@@ -47,6 +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:
@@ -55,6 +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'>
@@ -65,11 +69,13 @@ public final class StringRange implements Comparable<StringRange> {
* 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.
- * @return The type ranges described by the string.
- * <br>The ranges are sorted such that the most acceptable type is available at ordinal position <js>'0'</js>, and
- * the least acceptable at position n-1.
+ * @param value
+ * The value to parse.
+ * If <jk>null</jk> or empty, returns a single <code>TypeRange</code> is returned that represents all types.
+ * @return
+ * The type ranges described by the string.
+ * <br>The ranges are sorted such that the most acceptable type is available at ordinal position <js>'0'</js>, and
+ * the least acceptable at position n-1.
*/
public static StringRange[] parse(String value) {
@@ -162,8 +168,10 @@ 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>.
@@ -176,6 +184,7 @@ 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>.
*
@@ -187,6 +196,7 @@ 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.
*
@@ -250,6 +260,7 @@ 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
@@ -275,6 +286,7 @@ 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>.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/TE.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/TE.java b/juneau-core/src/main/java/org/apache/juneau/http/TE.java
index c9de654..282f891 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/TE.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/TE.java
@@ -18,6 +18,7 @@ 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
@@ -34,14 +35,18 @@ import org.apache.juneau.internal.*;
* 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'>
@@ -49,27 +54,31 @@ 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>
- * <li>The "chunked" transfer-coding is always acceptable.
- * If the keyword "trailers" is listed, the client indicates that it is willing to accept trailer fields in the
- * chunked response on behalf of itself and any downstream clients.
- * The implication is that, if given, the client is stating that either all downstream clients are willing to accept
- * trailer fields in the forwarded response, or that it will attempt to buffer the response on behalf of downstream
- * recipients.
- * Note: HTTP/1.1 does not define any means to limit the size of a chunked response such that a client can be assured
- * of buffering the entire response.
- * <li>If the transfer-coding being tested is one of the transfer-codings listed in the TE field, then it is acceptable
- * unless it is accompanied by a qvalue of 0. (As defined in section 3.9, a qvalue of 0 means "not acceptable.")
- * <li>If multiple transfer-codings are acceptable, then the acceptable transfer-coding with the highest non-zero
- * qvalue is preferred.
- * The "chunked" transfer-coding always has a qvalue of 1.
+ * <li>The "chunked" transfer-coding is always acceptable.
+ * If the keyword "trailers" is listed, the client indicates that it is willing to accept trailer fields in the
+ * chunked response on behalf of itself and any downstream clients.
+ * The implication is that, if given, the client is stating that either all downstream clients are willing to accept
+ * trailer fields in the forwarded response, or that it will attempt to buffer the response on behalf of downstream
+ * recipients.
+ * Note: HTTP/1.1 does not define any means to limit the size of a chunked response such that a client can be assured
+ * of buffering the entire response.
+ * <li>If the transfer-coding being tested is one of the transfer-codings listed in the TE field, then it is acceptable
+ * unless it is accompanied by a qvalue of 0. (As defined in section 3.9, a qvalue of 0 means "not acceptable.")
+ * <li>If multiple transfer-codings are acceptable, then the acceptable transfer-coding with the highest non-zero
+ * 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java b/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java
index 237fbce..25167b5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Trailer.java
@@ -14,6 +14,7 @@ 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.
@@ -27,16 +28,20 @@ package org.apache.juneau.http;
*
* 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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java b/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java
index 6440a83..b5ee9f9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/TransferEncoding.java
@@ -14,6 +14,7 @@ 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.
@@ -28,19 +29,24 @@ package org.apache.juneau.http;
* 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java b/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java
index 6895e31..655de91 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Upgrade.java
@@ -14,6 +14,7 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Upgrade</l> HTTP request header.
+ *
* <p>
* Ask the client to upgrade to another protocol.
*
@@ -23,18 +24,22 @@ package org.apache.juneau.http;
* </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.
@@ -44,6 +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.
@@ -51,13 +57,16 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java b/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java
index 3b2db5b..4f85e7e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/UserAgent.java
@@ -14,6 +14,7 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>User-Agent</l> HTTP request header.
+ *
* <p>
* The user agent string of the user agent.
*
@@ -31,9 +32,11 @@ 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Vary.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Vary.java b/juneau-core/src/main/java/org/apache/juneau/http/Vary.java
index aff07a2..1a8a1e0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Vary.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Vary.java
@@ -14,10 +14,10 @@ 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'>
@@ -37,6 +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.
@@ -45,15 +46,18 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Via.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Via.java b/juneau-core/src/main/java/org/apache/juneau/http/Via.java
index 575a813..2b300fc 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Via.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Via.java
@@ -14,6 +14,7 @@ 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.
*
@@ -22,12 +23,15 @@ package org.apache.juneau.http;
* 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>
*
@@ -36,6 +40,7 @@ package org.apache.juneau.http;
* 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
@@ -44,26 +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
@@ -72,12 +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.
@@ -85,11 +97,13 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Warning.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Warning.java b/juneau-core/src/main/java/org/apache/juneau/http/Warning.java
index ec081ed..d972396 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Warning.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Warning.java
@@ -14,6 +14,7 @@ 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.
*
@@ -28,6 +29,7 @@ package org.apache.juneau.http;
* 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'>
@@ -41,17 +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.
@@ -61,6 +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.
@@ -70,9 +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.
@@ -94,8 +105,11 @@ 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
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java b/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
index 7dad3a0..bbfacd6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
@@ -14,6 +14,7 @@ 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.
*
@@ -27,9 +28,11 @@ package org.apache.juneau.http;
* 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
[3/9] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
index 7bc56ac..52ae75e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
@@ -21,8 +21,10 @@ import org.apache.juneau.json.*;
/**
* 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>
@@ -116,8 +118,11 @@ 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
* from the <code>path</code> field in the <a class="doclink"
@@ -134,8 +139,11 @@ 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
* from the <code>path</code> field in the <a class="doclink"
@@ -165,8 +173,11 @@ 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.
@@ -177,8 +188,11 @@ 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.
@@ -207,14 +221,17 @@ 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.
+ * @return
+ * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getDescription() {
return description;
@@ -222,8 +239,11 @@ 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.
@@ -248,8 +268,11 @@ 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>.
@@ -262,8 +285,11 @@ 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>.
@@ -288,6 +314,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>schema</property>.
+ *
* <p>
* Required. The schema defining the type used for the body parameter.
*
@@ -299,6 +326,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>schema</property>.
+ *
* <p>
* Required. The schema defining the type used for the body parameter.
*
@@ -322,8 +350,11 @@ 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>,
* <js>"array"</js> or <js>"file"</js>.
@@ -339,8 +370,11 @@ 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>,
* <js>"array"</js> or <js>"file"</js>.
@@ -372,8 +406,11 @@ 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.
*
@@ -385,8 +422,11 @@ 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.
*
@@ -410,8 +450,11 @@ 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>.
@@ -425,8 +468,11 @@ 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>.
@@ -451,8 +497,11 @@ 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.
@@ -463,8 +512,11 @@ 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.
@@ -487,8 +539,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>
@@ -500,11 +554,13 @@ 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.
+ * @return
+ * The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public String getCollectionFormat() {
return collectionFormat;
@@ -512,8 +568,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>
@@ -525,6 +583,7 @@ 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>.
*
@@ -550,6 +609,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.
@@ -566,6 +626,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.
@@ -594,6 +655,7 @@ 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>.
@@ -606,6 +668,7 @@ 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>.
@@ -630,6 +693,7 @@ 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>.
@@ -643,6 +707,7 @@ 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>.
@@ -667,6 +732,7 @@ 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>.
@@ -679,6 +745,7 @@ 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>.
@@ -703,6 +770,7 @@ 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>.
@@ -716,6 +784,7 @@ 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>.
@@ -740,6 +809,7 @@ 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>.
@@ -752,6 +822,7 @@ 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>.
@@ -776,6 +847,7 @@ 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>.
@@ -788,6 +860,7 @@ 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>.
@@ -812,6 +885,7 @@ 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>.
@@ -824,6 +898,7 @@ 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>.
@@ -848,6 +923,7 @@ 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>.
@@ -860,6 +936,7 @@ 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>.
@@ -884,6 +961,7 @@ 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>.
@@ -896,6 +974,7 @@ 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>.
@@ -920,6 +999,7 @@ 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>.
@@ -933,6 +1013,7 @@ 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>.
@@ -957,6 +1038,7 @@ 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>.
@@ -969,6 +1051,7 @@ 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>.
@@ -983,12 +1066,14 @@ 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.
+ * @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).
*/
@SuppressWarnings("unchecked")
@@ -1010,8 +1095,9 @@ 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.
+ * @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).
*/
public ParameterInfo _enum(Object..._enum) {
@@ -1020,6 +1106,7 @@ 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>.
@@ -1032,6 +1119,7 @@ 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>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
index ebfefda..6fda9a7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
@@ -58,8 +58,11 @@ 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.
*
@@ -71,8 +74,11 @@ 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.
*
@@ -96,8 +102,11 @@ 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>,
@@ -112,8 +121,11 @@ 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>,
@@ -140,6 +152,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>headers</property>.
+ *
* <p>
* A list of headers that are sent with the response.
*
@@ -151,6 +164,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>headers</property>.
+ *
* <p>
* A list of headers that are sent with the response.
*
@@ -164,6 +178,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property adder: <property>headers</property>.
+ *
* <p>
* A list of headers that are sent with the response.
*
@@ -191,8 +206,11 @@ 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.
@@ -203,8 +221,11 @@ 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.
@@ -217,6 +238,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property adder: <property>examples</property>.
+ *
* <p>
* An example of the response message.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
index 1a4c53b..f52fd6b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
@@ -18,10 +18,12 @@ 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.
@@ -77,6 +79,7 @@ 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.
@@ -89,6 +92,7 @@ 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.
@@ -143,6 +147,7 @@ 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.
@@ -155,6 +160,7 @@ 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.
@@ -179,6 +185,7 @@ 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.
*
@@ -190,6 +197,7 @@ 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.
*
@@ -274,8 +282,9 @@ 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.
+ * @return
+ * The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMaximum() {
return exclusiveMaximum;
@@ -335,8 +344,9 @@ 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.
+ * @return
+ * The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMinimum() {
return exclusiveMinimum;
@@ -680,8 +690,9 @@ 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.
+ * @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).
*/
public SchemaInfo _enum(Object..._enum) {
@@ -771,8 +782,9 @@ 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.
+ * @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.
* @return This object (for method chaining).
*/
public SchemaInfo addAllOf(Object...allOf) {
@@ -793,8 +805,9 @@ 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.
+ * @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.
* @return This object (for method chaining).
*/
public SchemaInfo allOf(Object...allOf) {
@@ -854,8 +867,9 @@ 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.
+ * @return
+ * The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it
+ * is not set.
*/
public Map<String,Object> getAdditionalProperties() {
return additionalProperties;
@@ -890,8 +904,9 @@ 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.
+ * @return
+ * The value of the <property>discriminator</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public String getDiscriminator() {
return discriminator;
@@ -981,8 +996,9 @@ 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.
+ * @return
+ * The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public ExternalDocumentation getExternalDocs() {
return externalDocs;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
index 325990b..62f0af5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
@@ -21,6 +21,7 @@ import org.apache.juneau.json.*;
/**
* 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).
@@ -89,8 +90,11 @@ 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.
@@ -101,8 +105,11 @@ 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.
@@ -129,11 +136,12 @@ 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.
+ * @return
+ * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getDescription() {
return description;
@@ -141,6 +149,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
+ *
* <p>
* A short description for security scheme.
*
@@ -164,6 +173,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
+ *
* <p>
* The name of the header or query parameter to be used.
*
@@ -175,6 +185,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
+ *
* <p>
* The name of the header or query parameter to be used.
*
@@ -198,6 +209,7 @@ 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>.
*
@@ -209,6 +221,7 @@ 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>.
*
@@ -232,8 +245,11 @@ 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.
@@ -244,8 +260,11 @@ 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.
@@ -268,12 +287,16 @@ 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.
+ * @return
+ * The value of the <property>authorizationUrl</property> property on this bean, or <jk>null</jk> if it
+ * is not set.
*/
public String getAuthorizationUrl() {
return authorizationUrl;
@@ -281,8 +304,11 @@ 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.
@@ -305,8 +331,11 @@ 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.
@@ -317,8 +346,11 @@ 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.
@@ -341,6 +373,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>scopes</property>.
+ *
* <p>
* The available scopes for the OAuth2 security scheme.
*
@@ -352,6 +385,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>scopes</property>.
+ *
* <p>
* The available scopes for the OAuth2 security scheme.
*
@@ -365,6 +399,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property adder: <property>scopes</property>.
+ *
* <p>
* The available scopes for the OAuth2 security scheme.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
index 5046967..8500444 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
@@ -60,8 +60,11 @@ 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>.
*
@@ -73,8 +76,11 @@ 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>.
*
@@ -98,8 +104,11 @@ 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.
@@ -110,8 +119,11 @@ 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.
@@ -134,8 +146,11 @@ 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).
@@ -150,8 +165,11 @@ 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).
@@ -178,8 +196,11 @@ 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"
@@ -193,8 +214,11 @@ 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"
@@ -220,8 +244,11 @@ 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.
@@ -234,8 +261,11 @@ 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.
@@ -250,8 +280,11 @@ 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.
@@ -265,8 +298,11 @@ 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.
@@ -295,8 +331,11 @@ 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>.
@@ -309,8 +348,11 @@ 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>.
@@ -325,8 +367,11 @@ 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>.
@@ -340,8 +385,11 @@ 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>.
@@ -380,8 +428,11 @@ 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>.
@@ -394,8 +445,11 @@ 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>.
@@ -410,8 +464,11 @@ 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>.
@@ -425,8 +482,11 @@ 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>.
@@ -465,6 +525,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>paths</property>.
+ *
* <p>
* Required. The available paths and operations for the API.
*
@@ -476,6 +537,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>paths</property>.
+ *
* <p>
* Required. The available paths and operations for the API.
*
@@ -489,6 +551,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>paths</property>.
+ *
* <p>
* Required. The available paths and operations for the API.
*
@@ -523,11 +586,12 @@ 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.
+ * @return
+ * The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,SchemaInfo> getDefinitions() {
return definitions;
@@ -535,6 +599,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>definitions</property>.
+ *
* <p>
* An object to hold data types produced and consumed by operations.
*
@@ -548,6 +613,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>definitions</property>.
+ *
* <p>
* An object to hold data types produced and consumed by operations.
*
@@ -575,8 +641,11 @@ 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.
@@ -587,8 +656,11 @@ 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.
@@ -601,8 +673,11 @@ 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.
@@ -629,8 +704,11 @@ 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.
@@ -641,8 +719,11 @@ 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.
@@ -655,8 +736,11 @@ 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.
@@ -683,11 +767,13 @@ 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.
+ * @return
+ * The value of the <property>securityDefinitions</property> property on this bean, or <jk>null</jk> if it
+ * is not set.
*/
public Map<String,SecurityScheme> getSecurityDefinitions() {
return securityDefinitions;
@@ -695,6 +781,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>securityDefinitions</property>.
+ *
* <p>
* Security scheme definitions that can be used across the specification.
*
@@ -708,6 +795,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>securityDefinitions</property>.
+ *
* <p>
* Security scheme definitions that can be used across the specification.
*
@@ -735,8 +823,11 @@ 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.
@@ -749,8 +840,11 @@ 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.
@@ -765,8 +859,11 @@ 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.
@@ -797,8 +894,11 @@ 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.
@@ -813,8 +913,11 @@ 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.
@@ -831,8 +934,11 @@ 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.
@@ -871,11 +977,13 @@ 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.
+ * @return
+ * The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public ExternalDocumentation getExternalDocs() {
return externalDocs;
@@ -883,6 +991,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>externalDocs</property>.
+ *
* <p>
* Additional external documentation.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
index 89f251f..9e96614 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
@@ -61,10 +61,10 @@ public class SwaggerBuilder {
*
* @param name The {@link Contact#name(String)} attribute.
* @param url
- * The {@link Contact#url(Object)} attribute.
- * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
- * <br>Strings must be valid URIs.
- * <br>URIs defined by {@link UriResolver} can be used for values.
+ * The {@link Contact#url(Object)} attribute.
+ * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
+ * <br>Strings must be valid URIs.
+ * <br>URIs defined by {@link UriResolver} can be used for values.
* @param email The {@link Contact#email(String)} attribute.
* @return The new element.
*/
@@ -86,10 +86,10 @@ public class SwaggerBuilder {
* attribute.
*
* @param url
- * The {@link ExternalDocumentation#url(Object)} attribute.
- * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
- * <br>Strings must be valid URIs.
- * <br>URIs defined by {@link UriResolver} can be used for values.
+ * The {@link ExternalDocumentation#url(Object)} attribute.
+ * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
+ * <br>Strings must be valid URIs.
+ * <br>URIs defined by {@link UriResolver} can be used for values.
* @return The new element.
*/
public static final ExternalDocumentation externalDocumentation(Object url) {
@@ -100,10 +100,11 @@ 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}.
- * <br>Strings must be valid URIs.
- * <br>URIs defined by {@link UriResolver} can be used for values.
+ * @param url
+ * The {@link ExternalDocumentation#url(Object)} attribute.
+ * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
+ * <br>Strings must be valid URIs.
+ * <br>URIs defined by {@link UriResolver} can be used for values.
* @param description The {@link ExternalDocumentation#description(String)} attribute.
* @return The new element.
*/
@@ -262,8 +263,8 @@ public class SwaggerBuilder {
/**
* Creates an {@link ResponseInfo} element with the specified {@link ResponseInfo#description(String)} attribute.
- * @param description The {@link ResponseInfo#description(String)} attribute.
*
+ * @param description The {@link ResponseInfo#description(String)} attribute.
* @return The new element.
*/
public static final ResponseInfo responseInfo(String description) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
index 6215ae0..3e97616 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.swagger;
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>.
+ * 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.
*
@@ -53,6 +53,7 @@ public class Tag extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
+ *
* <p>
* Required. The name of the tag.
*
@@ -64,6 +65,7 @@ public class Tag extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
+ *
* <p>
* Required. The name of the tag.
*
@@ -87,13 +89,16 @@ 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.
+ * @return
+ * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getDescription() {
return description;
@@ -101,8 +106,11 @@ 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.
*
@@ -126,11 +134,12 @@ 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.
+ * @return
+ * The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public ExternalDocumentation getExternalDocs() {
return externalDocs;
@@ -138,6 +147,7 @@ public class Tag extends SwaggerElement {
/**
* Bean property setter: <property>externalDocs</property>.
+ *
* <p>
* Additional external documentation for this tag.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
index 247ecda..39b7e53 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
@@ -16,6 +16,7 @@ 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.
@@ -47,8 +48,11 @@ 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
@@ -63,8 +67,11 @@ 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
@@ -91,6 +98,7 @@ 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.
*
@@ -102,6 +110,7 @@ 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.
*
@@ -125,6 +134,7 @@ public class Xml extends SwaggerElement {
/**
* Bean property getter: <property>prefix</property>.
+ *
* <p>
* The prefix to be used for the name.
*
@@ -136,6 +146,7 @@ public class Xml extends SwaggerElement {
/**
* Bean property setter: <property>prefix</property>.
+ *
* <p>
* The prefix to be used for the name.
*
@@ -159,8 +170,11 @@ 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.
@@ -171,8 +185,11 @@ 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.
@@ -195,8 +212,11 @@ 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
* (<code><book/><book/></code>).
@@ -212,8 +232,11 @@ 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
* (<code><book/><book/></code>).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java b/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java
index 7c7110f..15e774b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java
@@ -18,8 +18,10 @@ import java.io.*;
* Used for enabling decompression on requests and compression on responses, such as support for GZIP compression.
*
* <h5 class='section'>Description:</h5>
+ *
* <p>
* 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.
*/
@@ -44,8 +46,8 @@ public abstract class Encoder {
public abstract OutputStream getOutputStream(OutputStream os) throws IOException;
/**
- * Returns the codings in <code>Content-Encoding</code> and <code>Accept-Encoding</code> headers
- * that this encoder handles (e.g. <js>"gzip"</js>).
+ * 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.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
index ae3128e..c75be25 100644
--- a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
@@ -21,22 +21,25 @@ import org.apache.juneau.http.*;
* Represents the group of {@link Encoder encoders} keyed by codings.
*
* <h5 class='section'>Description:</h5>
+ *
* <p>
* 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.
+ * 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>
* <p>
* 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>.
+ * E4.<jk>class</jk>)</code> will result in the order <code>E3, E4, E1, E2</code>.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -84,9 +87,11 @@ 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.
+ * 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
index 32958ec..db54070 100644
--- a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
@@ -88,6 +88,7 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
index 71358d2..15e6ae4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
@@ -86,8 +86,9 @@ 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} annotation is specified, and {@link Html#asPlainText()} is
- * <jk>true</jk>.
+ * @return
+ * <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#asPlainText()} is
+ * <jk>true</jk>.
*/
protected boolean isAsPlainText() {
return asPlainText;
@@ -96,8 +97,9 @@ 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} annotation is specified, and {@link Html#noTables()} is
- * <jk>true</jk>.
+ * @return
+ * <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#noTables()} is
+ * <jk>true</jk>.
*/
protected boolean isNoTables() {
return noTables;
@@ -106,8 +108,9 @@ 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} annotation is specified, and {@link Html#noTableHeaders()} is
- * <jk>true</jk>.
+ * @return
+ * <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#noTableHeaders()} is
+ * <jk>true</jk>.
*/
public boolean isNoTableHeaders() {
return noTableHeaders;
@@ -115,6 +118,7 @@ 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()} annotation.
*
@@ -126,6 +130,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Adds a hyperlink to this value in HTML.
+ *
* <p>
* This value is specified via the {@link Html#link()} annotation.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
index 0f46b1e..0668b7c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
@@ -18,6 +18,7 @@ import org.apache.juneau.*;
/**
* Properties associated with the {@link HtmlDocSerializer} class.
+ *
* <p>
* These 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.
@@ -34,6 +35,7 @@ import org.apache.juneau.*;
* )
* <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'>
@@ -76,6 +78,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Page title.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.title"</js>
@@ -83,13 +86,13 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Specifies the text for the title that shows up in the header section of the page generated by the basic template.
*
* <h5 class='section'>Example:</h5>
* <p>
* The <code>AddressBookResource</code> sample class uses this property...
- * </p>
* <p class='bcode'>
* <ja>@RestResource</ja>(
* messages=<js>"nls/AddressBookResource"</js>,
@@ -99,16 +102,16 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
+ *
* <p>
* ...with this property in <code>AddressBookResource.properties</code>...
- * </p>
* <p class='bcode'>
* title = <js>AddressBook sample resource</js>
* </p>
* <p>
* ...to produce this title on the HTML page...
- * </p>
* <img class='bordered' src='doc-files/HTML_TITLE.png'>
+ *
* <p>
* Shortcuts on <ja>@RestResource</ja> are also provided for this setting:
* <p class='bcode'>
@@ -127,6 +130,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -134,6 +138,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Page description.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.description"</js>
@@ -141,6 +146,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Specifies the text for the subtitle that shows up in the header section of the page generated by the basic
* template.
@@ -159,16 +165,17 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
+ *
* <p>
* ...with this property in <code>AddressBookResource.properties</code>...
- * </p>
* <p class='bcode'>
* description = <js>Simple address book POJO sample resource</js>
* </p>
+ *
* <p>
* ...to produce this description on the HTML page...
- * </p>
* <img class='bordered' src='doc-files/HTML_DESCRIPTION.png'>
+ *
* <p>
* Shortcuts on <ja>@RestResource</ja> are also provided for this setting:
* <p class='bcode'>
@@ -187,6 +194,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -194,6 +202,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Page branding.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.branding"</js>
@@ -201,9 +210,11 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Specifies arbitrary HTML for the header that can be used for adding custom branding to the page generated by the
- * basic template.
+ * basic template.
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -211,6 +222,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Header section contents.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.header"</js>
@@ -218,6 +230,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <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.
@@ -230,9 +243,11 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* When this property is specified, the {@link #HTMLDOC_title} and {@link #HTMLDOC_description} properties are
* ignored.
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -240,6 +255,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Page links.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.links.map"</js>
@@ -247,12 +263,16 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> empty map
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <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 a JSON object string where the keys are anchor text and the values are URLs.
+ *
* <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
@@ -264,7 +284,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <h5 class='section'>Example:</h5>
* <p>
* The <code>AddressBookResource</code> sample class uses this property...
- * </p>
* <p class='bcode'>
* <ja>@RestResource</ja>(
* properties={
@@ -274,10 +293,11 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
+ *
* <p>
* ...to produce this list of links on the HTML page...
- * </p>
* <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'>
@@ -288,6 +308,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
+ *
* <p>
* Values that start with <js>'<'</js> are assumed to be HTML and rendered as-is.
*/
@@ -300,6 +321,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Nav section contents.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.nav"</js>
@@ -307,6 +329,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <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.
@@ -319,8 +342,10 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* When this property is specified, the {@link #HTMLDOC_links} property is ignored.
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -328,6 +353,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Aside section contents.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.aside"</js>
@@ -335,10 +361,12 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <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.
*
@@ -350,6 +378,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -357,6 +386,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Footer section contents.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.footer"</js>
@@ -364,8 +394,10 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Allows you to specify the contents of the footer section on the HTML page.
+ *
* <p>
* By default, the footer section is empty.
*
@@ -377,6 +409,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -384,6 +417,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> No-results message.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.noResultsMessage"</js>
@@ -391,6 +425,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <js>"<p>no results</p>"</js>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Allows you to specify the string message used when trying to serialize an empty array or empty list.
*
@@ -402,6 +437,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -409,6 +445,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Prevent word wrap on page.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.nowrap"</js>
@@ -416,6 +453,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Adds <js>"* {white-space:nowrap}"</js> to the CSS instructions on the page to prevent word wrapping.
*/
@@ -423,6 +461,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Stylesheet URL.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.cssUrl"</js>
@@ -430,11 +469,14 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <js>"style.css"</js>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Adds a link to the specified stylesheet URL.
+ *
* <p>
* If not specified, defaults to the built-in stylesheet located at <js>"style.css"</js>.
* Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation.
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -442,6 +484,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> CSS code.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.css.list"</js>
@@ -449,6 +492,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Adds the specified CSS instructions to the HTML page.
*
@@ -461,6 +505,8 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* }
* )
* </p>
+ *
+ * <p>
* A shortcut on <ja>@RestResource</ja> is also provided for this setting:
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -479,6 +525,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> HTML document template.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.template"</js>
@@ -486,8 +533,10 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <code>HtmlDocTemplateBasic.<jk>class</jk></code>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <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.
@@ -512,6 +561,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* Constructor.
+ *
* <p>
* Typically only called from {@link PropertyStore#getContext(Class)}.
*
[6/9] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java
index 3ccccd6..6b5bb01 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Code.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-code-element"><code></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java
index 4858630..935bcc2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Col.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/tabular-data.html#the-col-element"><col></a> element.
+ * 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'>
@@ -35,10 +35,13 @@ 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}.
+ * @param span
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Col span(Object span) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
index ef4e220..d4ebd5f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Colgroup.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/tabular-data.html#the-colgroup-element"><colgroup></a> element.
+ * 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'>
@@ -35,9 +35,13 @@ 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}.
+ *
+ * @param span
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Colgroup span(Object span) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java
index ae513a7..078d3f3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Data.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-data-element"><data></a> element.
+ * 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'>
@@ -36,10 +36,13 @@ 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}.
+ * @param value
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Data value(Object value) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java
index 39e0a9e..d39ebde 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Datalist.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/forms.html#the-datalist-element"><datalist></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java
index 8d77b46..e8f9b27 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dd.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-dd-element"><dd></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java
index 8bdfa2d..ac90b9e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Del.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/edits.html#the-del-element"><del></a> element.
+ * 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'>
@@ -35,6 +35,8 @@ 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.
@@ -47,6 +49,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java
index 3b1fa41..554bf44 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dfn.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-dfn-element"><dfn></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java
index a442af8..e8e7619 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Div.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-div-element"><div></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java
index 690751e..f516c35 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dl.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-dl-element"><dl></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java
index fa4950c..661de22 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Dt.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-dt-element"><dt></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java
index fb19cc5..6f1fd66 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Em.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-em-element"><em></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java
index 241d322..8980a89 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Embed.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -40,10 +40,13 @@ 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}.
+ * @param height
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Embed height(Object height) {
@@ -53,15 +56,20 @@ 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}.
+ * @param src
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final Embed src(Object src) {
@@ -71,6 +79,8 @@ 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.
@@ -83,10 +93,13 @@ 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}.
+ * @param width
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Embed width(Object width) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
index 0e51dbd..461ec5d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Fieldset.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/forms.html#the-fieldset-element"><fieldset></a> element.
+ * 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'>
@@ -35,10 +35,13 @@ 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}.
+ * @param disabled
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Fieldset disabled(Boolean disabled) {
@@ -48,6 +51,8 @@ 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.
@@ -60,6 +65,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
index a076f7d..8bfad50 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figcaption.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-figcaption-element"><figcaption></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java
index ae287cd..2ef5f19 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Figure.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-figure-element"><figure></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java
index c1bcb59..018ba97 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Footer.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML
- * <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-footer-element"><footer></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java
index 4a9ced2..ba992d7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Form.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -40,6 +40,8 @@ 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.
@@ -52,10 +54,14 @@ 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.
*
@@ -70,7 +76,9 @@ public class Form extends HtmlElementMixed {
/**
* <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-form-autocomplete">autocomplete</a>
* attribute.
- * Default setting for autofill feature for controls in the form.
+ *
+ * <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).
@@ -82,6 +90,8 @@ 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.
@@ -94,6 +104,8 @@ 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.
@@ -106,6 +118,8 @@ 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.
@@ -118,6 +132,8 @@ 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.
@@ -131,6 +147,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java
index 03ce913..feefdf9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H1.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h1></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java
index 96bf9aa..1133301 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H2.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h2></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java
index 356fe70..a83617b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H3.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h3></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java
index adcda96..5dc961b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H4.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h4></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java
index 6a25dad..ad62d13 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H5.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h5></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java
index 3cb5e56..b4148a0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/H6.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><h6></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java
index 2095029..2f4879f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Head.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/document-metadata.html#the-head-element"><head></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java
index b4e2806..ae47b12 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Header.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/sections.html#the-header-element"><header></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java
index 4626424..aba0ab1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Hr.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-hr-element"><hr></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java
index e96e4ab..9216e98 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Html.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/semantics.html#the-html-element"><html></a> element.
+ * 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'>
@@ -35,6 +35,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
index 14881cc..926e65e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElement.java
@@ -28,6 +28,7 @@ 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.
*
@@ -94,12 +95,15 @@ 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>).
+ * 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.
*
@@ -127,8 +131,9 @@ 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.
+ * @param type
+ * The class type to convert this class to.
+ * See {@link ObjectUtils} for a list of supported conversion types.
* @param key The attribute name.
* @return The attribute value, or <jk>null</jk> if the named attribute does not exist.
*/
@@ -186,8 +191,9 @@ 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}.
+ * @param hidden
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public HtmlElement hidden(Object hidden) {
@@ -262,8 +268,8 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink"
- * href="https://www.w3.org/TR/html5/webappapis.html#handler-oncanplaythrough">oncanplaythrough</a> attribute.
+ * <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).
@@ -319,8 +325,8 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink"
- * href="https://www.w3.org/TR/html5/webappapis.html#handler-ondurationchange">ondurationchange</a> attribute.
+ * <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).
@@ -453,8 +459,8 @@ public abstract class HtmlElement {
}
/**
- * <a class="doclink"
- * href="https://www.w3.org/TR/html5/webappapis.html#handler-onloadedmetadata">onloadedmetadata</a> attribute.
+ * <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).
@@ -490,6 +496,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).
*/
@@ -783,8 +790,9 @@ 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}.
+ * @param spellcheck
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public HtmlElement spellcheck(Object spellcheck) {
@@ -806,8 +814,9 @@ 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}.
+ * @param tabindex
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public HtmlElement tabindex(Object tabindex) {
@@ -829,8 +838,9 @@ 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}.
+ * @param translate
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public HtmlElement translate(Object translate) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
index 1628147..f35f237 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementContainer.java
@@ -75,8 +75,10 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
index b2ff2da..5e06b73 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementMixed.java
@@ -75,8 +75,10 @@ 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.
*
@@ -119,8 +121,9 @@ 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.
+ * @param children
+ * The children to add as child elements.
+ * Can be a mixture of strings and {@link HtmlElement} objects.
* @return This object (for method chaining).
*/
@SuppressWarnings("hiding")
@@ -137,8 +140,9 @@ 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}.
+ * @param child
+ * The child to add as a child element.
+ * Can be a string or {@link HtmlElement}.
* @return This object (for method chaining).
*/
public HtmlElement child(Object child) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
index 80e47e5..cf10aec 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementText.java
@@ -47,7 +47,7 @@ public class HtmlElementText extends HtmlElement {
}
/**
- * Sets the innter text of this element.
+ * 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).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
index 365846d..25bf964 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/HtmlElementVoid.java
@@ -18,6 +18,7 @@ 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>
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java
index 58ed0ae..fa9399c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/I.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-i-element"><i></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java
index 86af1dc..f0add3f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Iframe.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -40,10 +40,13 @@ 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}.
+ * @param height
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Iframe height(Object height) {
@@ -53,6 +56,8 @@ 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.
@@ -66,6 +71,8 @@ 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.
@@ -78,15 +85,20 @@ 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}.
+ * @param src
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final Iframe src(Object src) {
@@ -97,6 +109,8 @@ 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.
@@ -109,10 +123,13 @@ 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}.
+ * @param width
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Iframe width(Object width) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java
index 7701736..0a78701 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Img.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -39,6 +39,8 @@ 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.
@@ -50,8 +52,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.
+ * <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.
@@ -65,10 +69,13 @@ 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}.
+ * @param height
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Img height(Object height) {
@@ -78,10 +85,13 @@ 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}.
+ * @param ismap
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Img ismap(Object ismap) {
@@ -91,15 +101,20 @@ 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}.
+ * @param src
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final Img src(Object src) {
@@ -110,6 +125,8 @@ 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.
@@ -122,10 +139,13 @@ 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}.
+ * @param width
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Img width(Object width) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java
index 7932b30..1cf0520 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Input.java
@@ -37,6 +37,8 @@ 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.
@@ -49,6 +51,8 @@ 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.
@@ -61,6 +65,8 @@ 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.
@@ -73,6 +79,8 @@ 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.
@@ -85,10 +93,13 @@ 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}.
+ * @param checked
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Input checked(Object checked) {
@@ -98,6 +109,8 @@ 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.
@@ -110,10 +123,13 @@ 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}.
+ * @param disabled
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Input disabled(Object disabled) {
@@ -123,6 +139,8 @@ 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.
@@ -135,6 +153,8 @@ 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.
@@ -147,6 +167,8 @@ 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.
@@ -159,6 +181,8 @@ 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.
@@ -172,6 +196,8 @@ 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.
@@ -184,6 +210,8 @@ 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.
@@ -197,10 +225,13 @@ 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}.
+ * @param height
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Input height(Object height) {
@@ -223,6 +254,8 @@ 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.
@@ -235,10 +268,13 @@ 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}.
+ * @param max
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Input max(Object max) {
@@ -261,10 +297,13 @@ 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}.
+ * @param min
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Input min(Object min) {
@@ -274,10 +313,13 @@ 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}.
+ * @param minlength
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Input minlength(Object minlength) {
@@ -287,10 +329,13 @@ 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}.
+ * @param multiple
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Input multiple(Object multiple) {
@@ -300,6 +345,8 @@ 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.
@@ -312,6 +359,8 @@ 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.
@@ -324,6 +373,8 @@ 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.
@@ -336,10 +387,13 @@ 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}.
+ * @param readonly
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Input readonly(Object readonly) {
@@ -350,6 +404,8 @@ 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>.
@@ -363,10 +419,13 @@ 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}.
+ * @param required
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Input required(Object required) {
@@ -376,10 +435,13 @@ 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}.
+ * @param size
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Input size(Object size) {
@@ -389,10 +451,13 @@ 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}.
+ * @param src
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final Input src(Object src) {
@@ -402,6 +467,8 @@ 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.
@@ -414,6 +481,8 @@ 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.
@@ -426,10 +495,13 @@ 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}.
+ * @param value
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Input value(Object value) {
@@ -439,10 +511,13 @@ 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}.
+ * @param width
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Input width(Object width) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java
index 0a60453..820f303 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ins.java
@@ -35,6 +35,8 @@ 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.
@@ -47,6 +49,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java
index 454be16..1b4b857 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Kbd.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-kbd-element"><kbd></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java
index 4d57ec1..176cafe 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Keygen.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/forms.html#the-keygen-element"><keygen></a> element.
+ * 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'>
@@ -35,10 +35,13 @@ 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}.
+ * @param autofocus
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Keygen autofocus(Object autofocus) {
@@ -48,6 +51,8 @@ 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.
@@ -60,10 +65,13 @@ 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}.
+ * @param disabled
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Keygen disabled(Object disabled) {
@@ -73,6 +81,8 @@ 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.
@@ -85,6 +95,8 @@ 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.
@@ -97,6 +109,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java
index af3f55b..d9f366e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Label.java
@@ -35,6 +35,8 @@ 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.
@@ -47,6 +49,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java
index be89826..c2a06cf 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Legend.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/forms.html#the-legend-element"><legend></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java
index 524347f..8b7debc 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Li.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-li-element"><li></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java
index d871bdb..48cc15c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Link.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -38,8 +38,10 @@ import org.apache.juneau.annotation.*;
public class Link extends HtmlElementVoid {
/**
- * <a class="doclink"
- * href="https://www.w3.org/TR/html5/document-metadata.html#attr-link-crossorigin">crossorigin</a> attribute.
+ * <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.
@@ -52,15 +54,20 @@ 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}.
+ * @param href
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final Link href(Object href) {
@@ -71,6 +78,8 @@ 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.
@@ -83,6 +92,8 @@ 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.
@@ -95,6 +106,8 @@ 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.
@@ -107,6 +120,8 @@ 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.
@@ -119,6 +134,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java
index 13888d8..f34d0a4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Main.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-main-element"><main></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java
index 1000736..b8bcfba 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Map.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-map-element"><map></a> element.
+ * 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'>
@@ -35,6 +35,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java
index c9a3626..38d70c5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Mark.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-mark-element"><mark></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java
index 5be05b5..392aed6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meta.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/document-metadata.html#the-meta-element"><meta></a> element.
+ * 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'>
@@ -36,6 +36,8 @@ 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.
@@ -49,6 +51,8 @@ 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.
@@ -62,6 +66,8 @@ 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.
@@ -74,6 +80,8 @@ 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.
[8/9] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java b/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
index 34f3590..27120d1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
@@ -44,6 +44,7 @@ public abstract class CoreObjectBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public CoreObjectBuilder(PropertyStore propertyStore) {
@@ -208,6 +209,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Beans require no-arg constructors.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireDefaultConstructor"</js>
@@ -215,9 +217,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, a Java class must implement a default no-arg constructor to be considered a bean.
* 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>.
*
@@ -236,6 +240,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Beans require {@link Serializable} interface.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSerializable"</js>
@@ -243,9 +248,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, a Java class must implement the {@link Serializable} interface to be considered a bean.
* 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>.
*
@@ -264,6 +271,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Beans require setters for getters.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSettersForGetters"</js>
@@ -271,6 +279,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, only getters that have equivalent setters will be considered as properties on a bean.
* Otherwise, they will be ignored.
@@ -290,6 +299,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Beans require at least one property.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSomeProperties"</js>
@@ -297,9 +307,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, then a Java class must contain at least 1 property to be considered a bean.
* 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>.
*
@@ -319,6 +331,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
* value.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanMapPutReturnsOldValue"</js>
@@ -326,10 +339,12 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
* values.
* Otherwise, it returns <jk>null</jk>.
+ *
* <p>
* Disabled by default because it introduces a slight performance penalty.
*
@@ -348,6 +363,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Look for bean constructors with the specified minimum visibility.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanConstructorVisibility"</js>
@@ -355,10 +371,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> {@link Visibility#PUBLIC}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Constructors not meeting this minimum visibility will be ignored.
- * For example, if the visibility is <code>PUBLIC</code> and the constructor is <jk>protected</jk>, then
- * the constructor will be ignored.
+ * For example, if the visibility is <code>PUBLIC</code> and the constructor is <jk>protected</jk>, then the
+ * constructor will be ignored.
*
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -375,6 +392,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Look for bean classes with the specified minimum visibility.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanClassVisibility"</js>
@@ -382,10 +400,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> {@link Visibility#PUBLIC}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Classes are not considered beans unless they meet the minimum visibility requirements.
- * For example, if the visibility is <code>PUBLIC</code> and the bean class is <jk>protected</jk>, then
- * the class will not be interpreted as a bean class.
+ * For example, if the visibility is <code>PUBLIC</code> and the bean class is <jk>protected</jk>, then the class
+ * will not be interpreted as a bean class.
*
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -402,6 +421,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Look for bean fields with the specified minimum visibility.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFieldVisibility"</js>
@@ -409,10 +429,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> {@link Visibility#PUBLIC}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Fields are not considered bean properties unless they meet the minimum visibility requirements.
- * For example, if the visibility is <code>PUBLIC</code> and the bean field is <jk>protected</jk>, then
- * the field will not be interpreted as a bean property.
+ * For example, if the visibility is <code>PUBLIC</code> and the bean field is <jk>protected</jk>, then the field
+ * will not be interpreted as a bean property.
*
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -430,6 +451,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Look for bean methods with the specified minimum visibility.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.methodVisibility"</js>
@@ -437,10 +459,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> {@link Visibility#PUBLIC}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Methods are not considered bean getters/setters unless they meet the minimum visibility requirements.
- * For example, if the visibility is <code>PUBLIC</code> and the bean method is <jk>protected</jk>, then
- * the method will not be interpreted as a bean getter or setter.
+ * For example, if the visibility is <code>PUBLIC</code> and the bean method is <jk>protected</jk>, then the method
+ * will not be interpreted as a bean getter or setter.
*
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -458,6 +481,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Use Java {@link Introspector} for determining bean properties.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useJavaBeanIntrospector"</js>
@@ -465,6 +489,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
*
@@ -484,6 +509,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Use interface proxies.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useInterfaceProxies"</js>
@@ -491,6 +517,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an
* {@link InvocationHandler} if there is no other way of instantiating them.
@@ -510,6 +537,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore unknown properties.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownBeanProperties"</js>
@@ -517,6 +545,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, trying to set a value on a non-existent bean property will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
@@ -536,6 +565,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore unknown properties with null values.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownNullBeanProperties"</js>
@@ -543,6 +573,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, trying to set a <jk>null</jk> value on a non-existent bean property will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
@@ -562,6 +593,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore properties without setters.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignorePropertiesWithoutSetters"</js>
@@ -569,6 +601,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, trying to set a value on a bean property without a setter will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
@@ -588,6 +621,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore invocation errors on getters.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnGetters"</js>
@@ -595,6 +629,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
@@ -614,6 +649,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore invocation errors on setters.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnSetters"</js>
@@ -621,6 +657,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored.
* Otherwise, a {@code BeanRuntimeException} is thrown.
@@ -640,6 +677,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Sort bean properties in alphabetical order.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.sortProperties"</js>
@@ -647,17 +685,19 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order.
- * Otherwise, the natural order of the bean properties is used which is dependent on the
- * JVM vendor.
+ * Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
* On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.
- * On Oracle JVMs, the bean properties are not ordered (which follows the offical JVM specs).
+ * On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs).
*
* <h5 class='section'>Notes:</h5>
* <ul>
- * <li>This is equivalent to calling <code>property(<jsf>BEAN_sortProperties</jsf>, value)</code>.
- * <li>This property is disabled by default so that IBM JVM users don't have to use {@link Bean @Bean} annotations
+ * <li>
+ * This is equivalent to calling <code>property(<jsf>BEAN_sortProperties</jsf>, value)</code>.
+ * <li>
+ * 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
* in the Java file.
* </ul>
@@ -672,6 +712,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Packages whose classes should not be considered beans.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanPackages.set"</js>
@@ -689,10 +730,13 @@ public abstract class CoreObjectBuilder {
* </ul>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* When specified, the current list of ignore packages are appended to.
+ *
* <p>
* Any classes within these packages will be serialized to strings using {@link Object#toString()}.
+ *
* <p>
* Note that you can specify prefix patterns to include all subpackages.
*
@@ -711,6 +755,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Packages whose classes should not be considered beans.
+ *
* <p>
* Same as {@link #setNotBeanPackages(String...)} but using a <code>Collection</code>.
*
@@ -741,6 +786,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to packages whose classes should not be considered beans.
+ *
* <p>
* Same as {@link #notBeanPackages(String...)} but using a <code>Collection</code>.
*
@@ -772,6 +818,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from packages whose classes should not be considered beans.
+ *
* <p>
* Same as {@link #removeNotBeanPackages(String...)} but using a <code>Collection</code>.
*
@@ -786,6 +833,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Classes to be excluded from consideration as being beans.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanClasses.set"</js>
@@ -793,9 +841,10 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> empty set
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
- * Not-bean classes are typically converted to <code>Strings</code> during serialization even if they
- * appear to be bean-like.
+ * Not-bean classes are typically converted to <code>Strings</code> during serialization even if they appear to be
+ * bean-like.
*
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -812,6 +861,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Classes to be excluded from consideration as being beans.
+ *
* <p>
* Same as {@link #setNotBeanClasses(Class...)} but using a <code>Collection</code>.
*
@@ -843,6 +893,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to classes that should not be considered beans.
+ *
* <p>
* Same as {@link #notBeanClasses(Class...)} but using a <code>Collection</code>.
*
@@ -875,6 +926,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from classes that should not be considered beans.
+ *
* <p>
* Same as {@link #removeNotBeanClasses(Class...)} but using a <code>Collection</code>.
*
@@ -889,6 +941,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Bean filters to apply to beans.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFilters.list"</js>
@@ -896,10 +949,12 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* This is a programmatic equivalent to the {@link Bean @Bean} annotation.
- * It's useful when you want to use the Bean annotation functionality, but you don't have the ability
- * to alter the bean classes.
+ * It's useful when you want to use the Bean annotation functionality, but you don't have the ability to alter the
+ * bean classes.
+ *
* <p>
* There are two category of classes that can be passed in through this method:
* <ul class='spaced-list'>
@@ -928,6 +983,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Bean filters to apply to beans.
+ *
* <p>
* Same as {@link #setBeanFilters(Class...)} but using a <code>Collection</code>.
*
@@ -959,6 +1015,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to bean filters.
+ *
* <p>
* Same as {@link #beanFilters(Class...)} but using a <code>Collection</code>.
*
@@ -991,6 +1048,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from bean filters.
+ *
* <p>
* Same as {@link #removeBeanFilters(Class...)} but using a <code>Collection</code>.
*
@@ -1005,6 +1063,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> POJO swaps to apply to Java objects.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.pojoSwaps.list"</js>
@@ -1012,6 +1071,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* There are two category of classes that can be passed in through this method:
* <ul>
@@ -1034,6 +1094,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> POJO swaps to apply to Java objects.
+ *
* <p>
* Same as {@link #setPojoSwaps(Class...)} but using a <code>Collection</code>.
*
@@ -1065,6 +1126,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to POJO swaps.
+ *
* <p>
* Same as {@link #pojoSwaps(Class...)} but using a <code>Collection</code>.
*
@@ -1097,6 +1159,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from POJO swaps.
+ *
* <p>
* Same as {@link #removePojoSwaps(Class...)} but using a <code>Collection</code>.
*
@@ -1111,6 +1174,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Implementation classes for interfaces and abstract classes.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.implClasses.map"</js>
@@ -1118,10 +1182,11 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> empty map
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
- * For interfaces and abstract classes this method can be used to specify an implementation
- * class for the interface/abstract class so that instances of the implementation
- * class are used when instantiated (e.g. during a parse).
+ * For interfaces and abstract classes this method can be used to specify an implementation class for the
+ * interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a
+ * parse).
*
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -1158,6 +1223,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Explicitly specify visible bean properties.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.includeProperties"</js>
@@ -1165,15 +1231,18 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <code>{}</code>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Specifies to only include the specified list of properties for the specified bean classes.
+ *
* <p>
* The keys are either fully-qualified or simple class names, and the values are comma-delimited lists of property
* names.
* The key <js>"*"</js> means all bean classes.
+ *
* <p>
* For example, <code>{Bean1:<js>"foo,bar"</js>}</code> means only serialize the <code>foo</code> and <code>bar</code>
- * properties on the specified bean.
+ * properties on the specified bean.
*
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -1228,6 +1297,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Exclude specified properties from beans.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.excludeProperties"</js>
@@ -1235,15 +1305,18 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <code>{}</code>
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Specifies to exclude the specified list of properties for the specified bean classes.
+ *
* <p>
* The keys are either fully-qualified or simple class names, and the values are comma-delimited lists of property
* names.
* The key <js>"*"</js> means all bean classes.
+ *
* <p>
* For example, <code>{Bean1:<js>"foo,bar"</js>}</code> means don't serialize the <code>foo</code> and <code>bar</code>
- * properties on the specified bean.
+ * properties on the specified bean.
*
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -1298,6 +1371,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Bean lookup dictionary.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanDictionary.list"</js>
@@ -1305,6 +1379,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* This list can consist of the following class types:
* <ul>
@@ -1330,6 +1405,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Bean lookup dictionary.
+ *
* <p>
* Same as {@link #setBeanDictionary(Class...)} but using a <code>Collection</code>.
*
@@ -1361,6 +1437,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Add to bean dictionary.
+ *
* <p>
* Same as {@link #beanDictionary(Class...)} but using a <code>Collection</code>.
*
@@ -1393,6 +1470,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Remove from bean dictionary.
+ *
* <p>
* Same as {@link #removeFromBeanDictionary(Class...)} but using a <code>Collection</code>.
*
@@ -1407,6 +1485,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Name to use for the bean type properties used to represent a bean type.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanTypePropertyName"</js>
@@ -1430,6 +1509,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Default parser to use when converting <code>Strings</code> to POJOs.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.defaultParser"</js>
@@ -1437,6 +1517,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> {@link JsonSerializer}
* <li><b>Session-overridable:</b> <jk>false</jk>
* </ul>
+ *
* <p>
* Used in the in the {@link BeanSession#convertToType(Object, Class)} method.
*
@@ -1455,6 +1536,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Locale.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.locale"</js>
@@ -1478,6 +1560,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> TimeZone.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.timeZone"</js>
@@ -1501,6 +1584,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Media type.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.mediaType"</js>
@@ -1508,6 +1592,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Specifies a default media type value for serializer and parser sessions.
*
@@ -1526,6 +1611,7 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Debug mode.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.debug"</js>
@@ -1533,6 +1619,7 @@ public abstract class CoreObjectBuilder {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Enables the following additional information during serialization:
* <ul class='spaced-list'>
@@ -1542,6 +1629,7 @@ public abstract class CoreObjectBuilder {
* <li>
* Enables {@link SerializerContext#SERIALIZER_detectRecursions}.
* </ul>
+ *
* <p>
* Enables the following additional information during parsing:
* <ul class='spaced-list'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/Delegate.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Delegate.java b/juneau-core/src/main/java/org/apache/juneau/Delegate.java
index 717f556..00d0bec 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Delegate.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Delegate.java
@@ -14,8 +14,10 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java b/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java
index f4fc490..89d0d28 100644
--- a/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java
+++ b/juneau-core/src/main/java/org/apache/juneau/InvalidDataConversionException.java
@@ -18,6 +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>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/ObjectList.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ObjectList.java b/juneau-core/src/main/java/org/apache/juneau/ObjectList.java
index 916e862..13d1be4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ObjectList.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ObjectList.java
@@ -22,15 +22,17 @@ 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.
+ * 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. But this class provides some useful additional functionality
- * when working with JSON models constructed from Java 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.
+ * Note that the use of this class is optional.
+ * The serializers will accept any objects that implement the {@link Collection} interface.
+ * But this class provides some useful additional functionality when working with JSON models constructed from Java
+ * 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'>
@@ -87,6 +89,7 @@ import org.apache.juneau.utils.*;
* <jc>// Do something with p</jc>
* }
* </p>
+ *
* <p>
* This class is not thread safe.
*/
@@ -161,8 +164,9 @@ 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.
+ * @param r
+ * The reader to read from.
+ * Will automatically be wrapped in a {@link BufferedReader} if it isn't already a BufferedReader.
* @param p The parser to use to parse the input.
* @throws ParseException If the input contains a syntax error or is malformed.
* @throws IOException If a problem occurred trying to read from the reader.
@@ -175,7 +179,9 @@ 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.
+ * @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.
*/
@@ -227,8 +233,10 @@ 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.
*
@@ -242,6 +250,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).
*/
@@ -253,6 +262,7 @@ public class ObjectList extends LinkedList<Object> {
/**
* Get the entry at the specified index, converted to the specified type (if possible).
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
*
@@ -353,8 +363,9 @@ public class ObjectList extends LinkedList<Object> {
}
/**
- * Same as {@link #get(Class,int) get(Class,int)}, but the key is a slash-delimited
- * path used to traverse entries in this POJO.
+ * Same as {@link #get(Class,int) get(Class,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>
@@ -367,9 +378,10 @@ public class ObjectList extends LinkedList<Object> {
* <jc>// Using this method</jc>
* <jk>long</jk> l = m.getAt(<jk>long</jk>.<jk>class</jk>, <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).
+ * 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 <T> The class type.
* @param type The class type.
@@ -381,8 +393,9 @@ 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.
+ * 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>
@@ -395,9 +408,10 @@ public class ObjectList extends LinkedList<Object> {
* <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).
+ * 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.
@@ -408,8 +422,8 @@ public class ObjectList extends LinkedList<Object> {
}
/**
- * Similar to {@link #putAt(String,Object) putAt(String,Object)}, but used to append
- * to collections and arrays.
+ * 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>
@@ -422,9 +436,10 @@ public class ObjectList extends LinkedList<Object> {
* <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).
+ * 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.
@@ -435,8 +450,9 @@ 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.
+ * 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>
@@ -449,9 +465,10 @@ public class ObjectList extends LinkedList<Object> {
* <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).
+ * 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.
@@ -462,11 +479,14 @@ 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.
+ * the next element cannot be converted to the specified type.
+ *
* <p>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for a description of valid conversions.
*
@@ -564,8 +584,8 @@ public class ObjectList extends LinkedList<Object> {
}
/**
- * Convenience method for serializing this ObjectList to the specified Writer using
- * the JsonSerializer.DEFAULT serializer.
+ * 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java b/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java
index 42a27b1..5bccde9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ObjectMap.java
@@ -27,15 +27,16 @@ 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.
+ * An extension of {@link LinkedHashMap}, so all methods available 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 java.util.Map} interface. But this class provides some useful additional functionality
- * when working with JSON models constructed from Java 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.
+ * Note that the use of this class is optional.
+ * The serializers will accept any objects that implement the {@link java.util.Map} interface.
+ * But this class provides some useful additional functionality when working with JSON models constructed from Java
+ * 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'>
@@ -95,6 +96,7 @@ import org.apache.juneau.utils.*;
* 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.
*/
@@ -230,12 +232,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.
+ * 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);
@@ -244,8 +248,9 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* <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.
+ * @param inner
+ * The inner map.
+ * Can be <jk>null</jk> to remove the inner map from an existing map.
* @return This object (for method chaining).
*/
public ObjectMap setInner(Map<String,Object> inner) {
@@ -256,7 +261,9 @@ 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.
+ * @param key
+ * The key to search for.
+ * For performance reasons, it's preferable that the key be all lowercase.
* @return The key, or <jk>null</jk> if map does not contain this key.
*/
public String findKeyIgnoreCase(String key) {
@@ -268,8 +275,10 @@ 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.
*
@@ -292,9 +301,9 @@ 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.
+ * 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.
@@ -307,9 +316,9 @@ 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.
+ * 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).
@@ -328,8 +337,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.
+ * 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.
@@ -342,6 +350,7 @@ 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>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
*
@@ -375,6 +384,7 @@ 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>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
*
@@ -401,6 +411,7 @@ 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>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
*
@@ -415,6 +426,7 @@ 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>
* See {@link BeanSession#convertToType(Object, ClassMeta)} for the list of valid data conversions.
*
@@ -446,8 +458,10 @@ 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.
*
@@ -464,8 +478,9 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
/**
- * Same as {@link #get(Class,String) get(Class,String)}, but the key is a slash-delimited
- * path used to traverse entries in this POJO.
+ * Same as {@link #get(Class,String) get(Class,String)}, but the key is a slash-delimited path used to traverse
+ * entries in this POJO.
+ *
* <p>
* For example, the following code is equivalent:
* </p>
@@ -479,9 +494,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* <jc>// Using this method</jc>
* <jk>long</jk> l = m.getAt(<jk>long</jk>.<jk>class</jk>, <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).
+ * 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 <T> The class type.
* @param type The class type.
@@ -493,8 +509,9 @@ 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.
+ * 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>
@@ -508,9 +525,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* <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).
+ * 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.
@@ -521,8 +539,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
/**
- * Similar to {@link #putAt(String,Object) putAt(String,Object)}, but used to append
- * to collections and arrays.
+ * 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>
@@ -535,9 +553,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* <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).
+ * 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.
@@ -548,8 +567,9 @@ 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.
+ * 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>
@@ -562,9 +582,10 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* <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).
+ * 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.
@@ -575,6 +596,7 @@ 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>).
*
@@ -588,6 +610,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link String}.
+ *
* <p>
* Shortcut for <code>get(String.<jk>class</jk>, key)</code>.
*
@@ -599,11 +622,13 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
}
/**
- * Specialized method that calls {@link #getString(String)} and splits the
- * results as a simple comma-delimited list.
+ * Specialized method that calls {@link #getString(String)} and splits the results as a simple comma-delimited list.
*
* @param key the key.
- * @return A list of tokens, trimmed of whitespace. An empty list if entry not found. Never <jk>null</jk>.
+ * @return
+ * A list of tokens, trimmed of whitespace.
+ * An empty list if entry not found.
+ * Never <jk>null</jk>.
*/
public String[] getStringArray(String key) {
String s = get(String.class, key);
@@ -625,6 +650,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link String}.
+ *
* <p>
* Shortcut for <code>get(String.<jk>class</jk>, key, defVal)</code>.
*
@@ -638,6 +664,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to an {@link Integer}.
+ *
* <p>
* Shortcut for <code>get(Integer.<jk>class</jk>, key)</code>.
*
@@ -651,6 +678,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to an {@link Integer}.
+ *
* <p>
* Shortcut for <code>get(Integer.<jk>class</jk>, key, defVal)</code>.
*
@@ -665,6 +693,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Long}.
+ *
* <p>
* Shortcut for <code>get(Long.<jk>class</jk>, key)</code>.
*
@@ -678,6 +707,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Long}.
+ *
* <p>
* Shortcut for <code>get(Long.<jk>class</jk>, key, defVal)</code>.
*
@@ -692,6 +722,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Boolean}.
+ *
* <p>
* Shortcut for <code>get(Boolean.<jk>class</jk>, key)</code>.
*
@@ -705,6 +736,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Boolean}.
+ *
* <p>
* Shortcut for <code>get(Boolean.<jk>class</jk>, key, defVal)</code>.
*
@@ -719,6 +751,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Map}.
+ *
* <p>
* Shortcut for <code>get(Map.<jk>class</jk>, key)</code>.
*
@@ -732,6 +765,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Map}.
+ *
* <p>
* Shortcut for <code>get(Map.<jk>class</jk>, key, defVal)</code>.
*
@@ -746,6 +780,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link List}.
+ *
* <p>
* Shortcut for <code>get(List.<jk>class</jk>, key)</code>.
*
@@ -759,6 +794,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link List}.
+ *
* <p>
* Shortcut for <code>get(List.<jk>class</jk>, key, defVal)</code>.
*
@@ -773,6 +809,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link Map}.
+ *
* <p>
* Shortcut for <code>get(ObjectMap.<jk>class</jk>, key)</code>.
*
@@ -786,6 +823,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link ObjectMap}.
+ *
* <p>
* Shortcut for <code>get(ObjectMap.<jk>class</jk>, key, defVal)</code>.
*
@@ -800,6 +838,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link ObjectList}.
+ *
* <p>
* Shortcut for <code>get(ObjectList.<jk>class</jk>, key)</code>.
*
@@ -813,6 +852,7 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
/**
* Returns the specified entry value converted to a {@link ObjectList}.
+ *
* <p>
* Shortcut for <code>get(ObjectList.<jk>class</jk>, key, defVal)</code>.
*
@@ -827,12 +867,14 @@ 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 contains no mapping for any of the keys.
+ * @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
+ * contains no mapping for any of the keys.
*/
public String findString(String... keys) {
return find(String.class, keys);
@@ -840,12 +882,14 @@ 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 contains no mapping for any of the keys.
+ * @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
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public Integer findInt(String... keys) {
@@ -854,12 +898,14 @@ 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 contains no mapping for any of the keys.
+ * @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
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public Long findLong(String... keys) {
@@ -868,12 +914,14 @@ 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 contains no mapping for any of the keys.
+ * @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
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public Boolean findBoolean(String... keys) {
@@ -882,12 +930,14 @@ 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 contains no mapping for any of the keys.
+ * @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
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public Map<?,?> findMap(String... keys) {
@@ -896,12 +946,14 @@ 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 contains no mapping for any of the keys.
+ * @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
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public List<?> findList(String... keys) {
@@ -910,12 +962,14 @@ 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 contains no mapping for any of the keys.
+ * @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
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public ObjectMap findObjectMap(String... keys) {
@@ -924,12 +978,14 @@ 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 contains no mapping for any of the keys.
+ * @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
+ * contains no mapping for any of the keys.
* @throws InvalidDataConversionException If value cannot be converted.
*/
public ObjectList findObjectList(String... keys) {
@@ -949,7 +1005,8 @@ 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.
+ * @return
+ * The data type of the object at the specified key, or <jk>null</jk> if the value is null or does not exist.
*/
public ClassMeta<?> getClassMeta(String key) {
return session.getClassMetaForObject(get(key));
@@ -1002,8 +1059,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.
+ * 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.
@@ -1076,15 +1132,15 @@ 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>.
+ * 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.
- * @throws ClassCastException If the <js>"_type"</js> entry is present and not assignable
- * from <code>type</code>
+ * @throws ClassCastException
+ * If the <js>"_type"</js> entry is present and not assignable from <code>type</code>
*/
@SuppressWarnings("unchecked")
public <T> T cast(Class<T> type) {
@@ -1103,8 +1159,8 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
* @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.
- * @throws ClassCastException If the <js>"_type"</js> entry is present and not assignable
- * from <code>type</code>
+ * @throws ClassCastException
+ * If the <js>"_type"</js> entry is present and not assignable from <code>type</code>
*/
@SuppressWarnings({"unchecked"})
public <T> T cast(ClassMeta<T> cm) {
@@ -1241,8 +1297,8 @@ 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.
+ * 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).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/PropertyNamer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/PropertyNamer.java b/juneau-core/src/main/java/org/apache/juneau/PropertyNamer.java
index 2d6a33e..cb874a4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/PropertyNamer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/PropertyNamer.java
@@ -16,9 +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>.
+ * 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} annotation.
*/
@@ -26,6 +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/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/PropertyNamerDefault.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/PropertyNamerDefault.java b/juneau-core/src/main/java/org/apache/juneau/PropertyNamerDefault.java
index 19dcda3..2b6e18f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/PropertyNamerDefault.java
+++ b/juneau-core/src/main/java/org/apache/juneau/PropertyNamerDefault.java
@@ -24,6 +24,7 @@ import java.beans.*;
* <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/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java b/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
index 83f32ef..26961d9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
+++ b/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
@@ -27,6 +27,7 @@ import org.apache.juneau.parser.*;
/**
* A store for instantiating {@link Context} objects.
+ *
* <p>
* The hierarchy of these objects are...
* <ul class='spaced-list'>
@@ -321,9 +322,9 @@ public final class PropertyStore {
/**
* Copies the properties from the specified store into this store.
+ *
* <p>
- * Properties of type set/list/collection will be appended to the existing
- * properties if they already exist.
+ * Properties of type set/list/collection will be appended to the existing properties if they already exist.
*
* @param ps The store to copy from.
* @return This object (for method chaining).
@@ -351,15 +352,16 @@ public final class PropertyStore {
/**
* Sets a configuration property value on this object.
+ *
* <p>
* A typical usage is to set or overwrite configuration values like so...
* <p class='bcode'>
* PropertyStore ps = PropertyStore.<jsm>create</jsm>();
* ps.setProperty(<jsf>BEAN_sortProperties</jsf>, <jk>true</jk>);
* </p>
+ *
* <p>
* The possible class types of the value depend on the property type:
- * <p>
* <table class='styled'>
* <tr>
* <th>Property type</th>
@@ -434,6 +436,7 @@ public final class PropertyStore {
/**
* Convenience method for setting multiple properties in one call.
+ *
* <p>
* This appends to any previous configuration properties set on this store.
*
@@ -571,9 +574,11 @@ public final class PropertyStore {
/**
* Returns an instance of the specified context initialized with the properties in this store.
+ *
* <p>
* Multiple calls to this method for the same store class will return the same cached value as long as the
* properties on this store are not touched.
+ *
* <p>
* As soon as any properties are modified on this store, all cached entries are discarded and recreated as needed.
*
@@ -609,6 +614,7 @@ public final class PropertyStore {
/**
* Returns the configuration properties with the specified prefix.
+ *
* <p>
* For example, if <l>prefix</l> is <js>"BeanContext"</js>, then retrieves all configuration properties that are
* prefixed with <js>"BeanContext."</js>.
@@ -628,9 +634,11 @@ public final class PropertyStore {
/**
* Specifies the classloader to use when resolving classes from strings.
+ *
* <p>
* Can be used for resolving class names when the classes being created are in a different classloader from the
* Juneau code.
+ *
* <p>
* If <jk>null</jk>, the system classloader will be used to resolve classes.
*
@@ -644,6 +652,7 @@ public final class PropertyStore {
/**
* Specifies the parser to use to convert Strings to POJOs.
+ *
* <p>
* If <jk>null</jk>, {@link JsonParser#DEFAULT} will be used.
*
@@ -681,6 +690,7 @@ public final class PropertyStore {
/**
* Returns a property value either cast to the specified type, or a new instance of the specified type.
+ *
* <p>
* It's assumed that the current property value is either an instance of that type, or a <code>Class</code> that's
* a subclass of the type to be instantiated.
@@ -901,8 +911,10 @@ public final class PropertyStore {
/**
* Contains all the properties for a particular property prefix (e.g. <js>'BeanContext'</js>)
+ *
* <p>
* Instances of this map are immutable from outside this class.
+ *
* <p>
* The {@link PropertyMap#hashCode()} and {@link PropertyMap#equals(Object)} methods can be used to compare with
* other property maps.
@@ -975,6 +987,7 @@ public final class PropertyStore {
/**
* Returns the specified property as a map with the specified key and value types.
+ *
* <p>
* The map returned is an instance of {@link LinkedHashMap}.
*
@@ -1009,6 +1022,7 @@ public final class PropertyStore {
/**
* Convenience method for returning all values in this property map as a simple map.
+ *
* <p>
* Primarily useful for debugging.
*
@@ -1379,6 +1393,8 @@ public final class PropertyStore {
/**
* Returns true if a bean session is available.
+ *
+ * <p>
* Note that a bean session will not be available when constructing the BeanContext.DEFAULT context.
* (it's a chicken-and-egg thing).
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/Session.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Session.java b/juneau-core/src/main/java/org/apache/juneau/Session.java
index 43f0189..1bf8292 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Session.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Session.java
@@ -24,9 +24,10 @@ 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.
+ * Serializers and parsers use session objects to retrieve config properties and to use it as a scratchpad during
+ * serialize and parse actions.
*
* @see PropertyStore
*/
@@ -43,8 +44,9 @@ public abstract class Session {
/**
* Default constructor.
*
- * @param ctx The context creating this session object.
- * The context contains all the configuration settings for the session.
+ * @param ctx
+ * The context creating this session object.
+ * The context contains all the configuration settings for the session.
* @param op Properties associated with this session.
*/
protected Session(final Context ctx, ObjectMap op) {
@@ -54,6 +56,7 @@ public abstract class Session {
/**
* Returns the session property with the specified key.
+ *
* <p>
* The order of lookup for the property is as follows:
* <ul>
@@ -113,6 +116,8 @@ 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.
@@ -126,10 +131,13 @@ 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>.
+ * @param cacheObjects
+ * The objects to add to this session's cache.
+ * No-op if <jk>null</jk>.
*/
public void addToCache(Map<String,Object> cacheObjects) {
if (cacheObjects != null) {
@@ -184,6 +192,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/Streamable.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Streamable.java b/juneau-core/src/main/java/org/apache/juneau/Streamable.java
index 84fb539..3d98b92 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Streamable.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Streamable.java
@@ -18,9 +18,9 @@ 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.
+ * Instances must identify the media type of the content by implementing the {@link #getMediaType()} method.
*/
public interface Streamable {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/UriContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/UriContext.java b/juneau-core/src/main/java/org/apache/juneau/UriContext.java
index 1c8be0b..2890984 100644
--- a/juneau-core/src/main/java/org/apache/juneau/UriContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/UriContext.java
@@ -18,6 +18,7 @@ import org.apache.juneau.annotation.*;
/**
* 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'>
@@ -25,6 +26,7 @@ import org.apache.juneau.annotation.*;
* | 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.
@@ -34,6 +36,8 @@ public class UriContext {
/**
* Default URI context.
+ *
+ * <p>
* No information about authority, servlet-root, context-root, or path-info is known.
*/
public static final UriContext DEFAULT = new UriContext();
@@ -45,16 +49,21 @@ 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 - The context root of the application (e.g. <js>"/context-root"</js>, or
- * <js>"context-root"</js>)
- * @param servletPath - The servlet path (e.g. <js>"/servlet-path"</js>, or <js>"servlet-path"</js>)
- * @param pathInfo - The path info (e.g. <js>"/path-info"</js>, or <js>"path-info"</js>)
+ * @param authority
+ * The authority portion of URL (e.g. <js>"http://hostname:port"</js>)
+ * @param contextRoot
+ * The context root of the application (e.g. <js>"/context-root"</js>, or <js>"context-root"</js>)
+ * @param servletPath
+ * The servlet path (e.g. <js>"/servlet-path"</js>, or <js>"servlet-path"</js>)
+ * @param pathInfo
+ * The path info (e.g. <js>"/path-info"</js>, or <js>"path-info"</js>)
*/
@BeanConstructor(properties="authority,contextRoot,servletPath,pathInfo")
public UriContext(String authority, String contextRoot, String servletPath, String pathInfo) {
@@ -68,6 +77,8 @@ public class UriContext {
/**
* Default constructor.
+ *
+ * <p>
* All <jk>null</jk> values.
*/
public UriContext() {
@@ -76,12 +87,15 @@ 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.
+ * @return
+ * The absolute URI of just the authority portion of this URI context.
* Never <jk>null</jk>.
*/
public String getAbsoluteAuthority() {
@@ -90,10 +104,12 @@ 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.
+ * @return
+ * The absolute URI of the context-root portion of this URI context.
* Never <jk>null</jk>.
*/
public String getAbsoluteContextRoot() {
@@ -112,10 +128,12 @@ 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.
+ * @return
+ * The root-relative URI of the context portion of this URI context.
* Never <jk>null</jk>.
*/
public String getRootRelativeContextRoot() {
@@ -126,10 +144,12 @@ 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.
+ * @return
+ * The absolute URI of the resource portion of this URI context.
* Never <jk>null</jk>.
*/
public String getAbsoluteServletPath() {
@@ -156,10 +176,12 @@ 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.
+ * @return
+ * The root-relative URI of the resource portion of this URI context.
* Never <jk>null</jk>.
*/
public String getRootRelativeServletPath() {
@@ -200,10 +222,12 @@ 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.
+ * @return
+ * The absolute URI of the path portion of this URI context.
* Never <jk>null</jk>.
*/
public String getAbsolutePathInfo() {
@@ -244,10 +268,12 @@ 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.
+ * @return
+ * The root-relative URI of the path portion of this URI context.
* Never <jk>null</jk>.
*/
public String getRootRelativePathInfo() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/UriResolver.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/UriResolver.java b/juneau-core/src/main/java/org/apache/juneau/UriResolver.java
index b279cef..a82e6c6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/UriResolver.java
+++ b/juneau-core/src/main/java/org/apache/juneau/UriResolver.java
@@ -24,15 +24,17 @@ 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>
+ * ({@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>
* <li><js>"foo://foo"</js> - Absolute URI.
@@ -74,7 +76,8 @@ 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.
+ * @param uri
+ * The URI to convert to absolute form.
* Can be any of the following:
* <ul>
* <li>{@link java.net.URI}
@@ -114,9 +117,11 @@ 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.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/Visibility.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Visibility.java b/juneau-core/src/main/java/org/apache/juneau/Visibility.java
index 59f9fee..5a03b5b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Visibility.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Visibility.java
@@ -16,8 +16,11 @@ 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>
* <li>{@link BeanContext#BEAN_beanConstructorVisibility}
@@ -99,10 +102,13 @@ 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
+ * @return
+ * The same constructor if visibility requirements met, or <jk>null</jk> if visibility requirement not
* met or call to {@link Constructor#setAccessible(boolean)} throws a security exception.
*/
public <T> Constructor<T> transform(Constructor<T> x) {
@@ -116,10 +122,13 @@ 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
+ * @return
+ * The same method if visibility requirements met, or <jk>null</jk> if visibility requirement not
* met or call to {@link Method#setAccessible(boolean)} throws a security exception.
*/
public <T> Method transform(Method x) {
@@ -133,10 +142,13 @@ 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
+ * @return
+ * The same field if visibility requirements met, or <jk>null</jk> if visibility requirement not
* met or call to {@link Field#setAccessible(boolean)} throws a security exception.
*/
public Field transform(Field x) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/Writable.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Writable.java b/juneau-core/src/main/java/org/apache/juneau/Writable.java
index bd9298f..656cf37 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Writable.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Writable.java
@@ -18,9 +18,9 @@ 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.
+ * Instances must identify the media type of the content by implementing the {@link #getMediaType()} method.
*/
public interface Writable {
[9/9] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
Clean up javadocs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-juneau/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-juneau/commit/19c566dd
Tree: http://git-wip-us.apache.org/repos/asf/incubator-juneau/tree/19c566dd
Diff: http://git-wip-us.apache.org/repos/asf/incubator-juneau/diff/19c566dd
Branch: refs/heads/master
Commit: 19c566dd2898e5093037fdf15c6542c2bb734c4e
Parents: 0d913b3
Author: JamesBognar <ja...@apache.org>
Authored: Tue Jun 27 21:49:34 2017 -0400
Committer: JamesBognar <ja...@apache.org>
Committed: Tue Jun 27 21:49:34 2017 -0400
----------------------------------------------------------------------
.../apache/juneau/BeanPropertyMetaExtended.java | 3 +
.../org/apache/juneau/BeanPropertyValue.java | 6 +-
.../juneau/BeanProxyInvocationHandler.java | 5 +-
.../java/org/apache/juneau/BeanRegistry.java | 8 +-
.../java/org/apache/juneau/BeanSession.java | 115 +++++++----
.../main/java/org/apache/juneau/ClassMeta.java | 202 +++++++++++--------
.../org/apache/juneau/ClassMetaExtended.java | 8 +-
.../main/java/org/apache/juneau/Context.java | 7 +-
.../main/java/org/apache/juneau/CoreObject.java | 26 +--
.../org/apache/juneau/CoreObjectBuilder.java | 132 ++++++++++--
.../main/java/org/apache/juneau/Delegate.java | 2 +
.../juneau/InvalidDataConversionException.java | 1 +
.../main/java/org/apache/juneau/ObjectList.java | 78 ++++---
.../main/java/org/apache/juneau/ObjectMap.java | 186 +++++++++++------
.../java/org/apache/juneau/PropertyNamer.java | 7 +-
.../org/apache/juneau/PropertyNamerDefault.java | 1 +
.../java/org/apache/juneau/PropertyStore.java | 22 +-
.../main/java/org/apache/juneau/Session.java | 22 +-
.../main/java/org/apache/juneau/Streamable.java | 4 +-
.../main/java/org/apache/juneau/UriContext.java | 50 +++--
.../java/org/apache/juneau/UriResolver.java | 17 +-
.../main/java/org/apache/juneau/Visibility.java | 18 +-
.../main/java/org/apache/juneau/Writable.java | 4 +-
.../java/org/apache/juneau/annotation/Bean.java | 46 +++--
.../juneau/annotation/BeanConstructor.java | 11 +-
.../apache/juneau/annotation/BeanIgnore.java | 3 +
.../org/apache/juneau/annotation/BeanParam.java | 2 +-
.../apache/juneau/annotation/BeanProperty.java | 30 ++-
.../org/apache/juneau/annotation/Consumes.java | 6 +-
.../apache/juneau/annotation/NameProperty.java | 12 +-
.../juneau/annotation/ParentProperty.java | 3 +-
.../java/org/apache/juneau/annotation/Pojo.java | 1 +
.../org/apache/juneau/annotation/Produces.java | 4 +
.../apache/juneau/annotation/ThreadSafe.java | 1 +
.../java/org/apache/juneau/annotation/URI.java | 5 +
.../org/apache/juneau/csv/CsvParserContext.java | 3 +
.../org/apache/juneau/csv/CsvParserSession.java | 39 ++--
.../apache/juneau/csv/CsvSerializerContext.java | 3 +
.../apache/juneau/csv/CsvSerializerSession.java | 21 +-
.../main/java/org/apache/juneau/dto/Link.java | 11 +-
.../org/apache/juneau/dto/ResultSetList.java | 5 +-
.../org/apache/juneau/dto/atom/AtomBuilder.java | 5 +
.../org/apache/juneau/dto/atom/Category.java | 3 +-
.../java/org/apache/juneau/dto/atom/Common.java | 2 +
.../org/apache/juneau/dto/atom/Content.java | 2 +
.../java/org/apache/juneau/dto/atom/Feed.java | 1 +
.../org/apache/juneau/dto/atom/Generator.java | 2 +
.../java/org/apache/juneau/dto/atom/Icon.java | 4 +
.../java/org/apache/juneau/dto/atom/Link.java | 1 +
.../java/org/apache/juneau/dto/atom/Logo.java | 4 +
.../java/org/apache/juneau/dto/atom/Person.java | 2 +
.../java/org/apache/juneau/dto/atom/Text.java | 1 +
.../org/apache/juneau/dto/cognos/Column.java | 8 +-
.../org/apache/juneau/dto/cognos/DataSet.java | 8 +-
.../java/org/apache/juneau/dto/html5/A.java | 29 ++-
.../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 | 34 +++-
.../org/apache/juneau/dto/html5/Article.java | 4 +-
.../java/org/apache/juneau/dto/html5/Aside.java | 4 +-
.../java/org/apache/juneau/dto/html5/Audio.java | 51 +++--
.../java/org/apache/juneau/dto/html5/B.java | 4 +-
.../java/org/apache/juneau/dto/html5/Base.java | 15 +-
.../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 | 6 +-
.../java/org/apache/juneau/dto/html5/Body.java | 8 +-
.../java/org/apache/juneau/dto/html5/Br.java | 4 +-
.../org/apache/juneau/dto/html5/Button.java | 45 ++++-
.../org/apache/juneau/dto/html5/Canvas.java | 18 +-
.../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 | 11 +-
.../org/apache/juneau/dto/html5/Colgroup.java | 12 +-
.../java/org/apache/juneau/dto/html5/Data.java | 11 +-
.../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 | 8 +-
.../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 | 29 ++-
.../org/apache/juneau/dto/html5/Fieldset.java | 15 +-
.../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 | 24 ++-
.../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 | 6 +-
.../apache/juneau/dto/html5/HtmlElement.java | 46 +++--
.../juneau/dto/html5/HtmlElementContainer.java | 2 +
.../juneau/dto/html5/HtmlElementMixed.java | 12 +-
.../juneau/dto/html5/HtmlElementText.java | 2 +-
.../juneau/dto/html5/HtmlElementVoid.java | 1 +
.../java/org/apache/juneau/dto/html5/I.java | 4 +-
.../org/apache/juneau/dto/html5/Iframe.java | 33 ++-
.../java/org/apache/juneau/dto/html5/Img.java | 44 ++--
.../java/org/apache/juneau/dto/html5/Input.java | 127 +++++++++---
.../java/org/apache/juneau/dto/html5/Ins.java | 4 +
.../java/org/apache/juneau/dto/html5/Kbd.java | 4 +-
.../org/apache/juneau/dto/html5/Keygen.java | 26 ++-
.../java/org/apache/juneau/dto/html5/Label.java | 4 +
.../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 | 29 ++-
.../java/org/apache/juneau/dto/html5/Main.java | 4 +-
.../java/org/apache/juneau/dto/html5/Map.java | 6 +-
.../java/org/apache/juneau/dto/html5/Mark.java | 4 +-
.../java/org/apache/juneau/dto/html5/Meta.java | 12 +-
.../java/org/apache/juneau/dto/html5/Meter.java | 42 ++--
.../org/apache/juneau/dto/html5/Noscript.java | 4 +-
.../org/apache/juneau/dto/html5/Object2.java | 43 ++--
.../java/org/apache/juneau/dto/html5/Ol.java | 20 +-
.../org/apache/juneau/dto/html5/Optgroup.java | 13 +-
.../org/apache/juneau/dto/html5/Option.java | 27 ++-
.../org/apache/juneau/dto/html5/Output.java | 10 +-
.../java/org/apache/juneau/dto/html5/P.java | 4 +-
.../java/org/apache/juneau/dto/html5/Param.java | 13 +-
.../java/org/apache/juneau/dto/html5/Pre.java | 4 +-
.../org/apache/juneau/dto/html5/Progress.java | 18 +-
.../java/org/apache/juneau/dto/html5/Q.java | 6 +-
.../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 | 33 ++-
.../org/apache/juneau/dto/html5/Section.java | 4 +-
.../org/apache/juneau/dto/html5/Select.java | 43 ++--
.../java/org/apache/juneau/dto/html5/Small.java | 4 +-
.../org/apache/juneau/dto/html5/Source.java | 15 +-
.../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 | 8 +-
.../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 | 9 +-
.../java/org/apache/juneau/dto/html5/Tbody.java | 4 +-
.../java/org/apache/juneau/dto/html5/Td.java | 20 +-
.../org/apache/juneau/dto/html5/Template.java | 4 +-
.../org/apache/juneau/dto/html5/Textarea.java | 74 +++++--
.../java/org/apache/juneau/dto/html5/Tfoot.java | 4 +-
.../java/org/apache/juneau/dto/html5/Th.java | 26 ++-
.../java/org/apache/juneau/dto/html5/Thead.java | 4 +-
.../java/org/apache/juneau/dto/html5/Time.java | 6 +-
.../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 | 21 +-
.../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 | 71 +++++--
.../java/org/apache/juneau/dto/html5/Wbr.java | 4 +-
.../apache/juneau/dto/jsonschema/JsonType.java | 7 +-
.../juneau/dto/jsonschema/JsonTypeArray.java | 3 +-
.../apache/juneau/dto/jsonschema/Schema.java | 142 ++++++++-----
.../apache/juneau/dto/jsonschema/SchemaMap.java | 12 ++
.../jsonschema/SchemaPropertySimpleArray.java | 1 +
.../apache/juneau/dto/jsonschema/SchemaRef.java | 3 +
.../org/apache/juneau/dto/swagger/Contact.java | 7 +
.../dto/swagger/ExternalDocumentation.java | 11 +-
.../apache/juneau/dto/swagger/HeaderInfo.java | 64 +++++-
.../org/apache/juneau/dto/swagger/Info.java | 16 +-
.../org/apache/juneau/dto/swagger/Items.java | 59 +++++-
.../org/apache/juneau/dto/swagger/License.java | 7 +
.../apache/juneau/dto/swagger/Operation.java | 87 +++++---
.../juneau/dto/swagger/ParameterInfo.java | 104 +++++++++-
.../apache/juneau/dto/swagger/ResponseInfo.java | 22 ++
.../apache/juneau/dto/swagger/SchemaInfo.java | 48 +++--
.../juneau/dto/swagger/SecurityScheme.java | 43 +++-
.../org/apache/juneau/dto/swagger/Swagger.java | 121 ++++++++++-
.../juneau/dto/swagger/SwaggerBuilder.java | 27 +--
.../java/org/apache/juneau/dto/swagger/Tag.java | 22 +-
.../java/org/apache/juneau/dto/swagger/Xml.java | 23 +++
.../org/apache/juneau/encoders/Encoder.java | 6 +-
.../apache/juneau/encoders/EncoderGroup.java | 15 +-
.../juneau/encoders/EncoderGroupBuilder.java | 1 +
.../juneau/html/HtmlBeanPropertyMeta.java | 17 +-
.../juneau/html/HtmlDocSerializerContext.java | 66 +++++-
.../juneau/html/HtmlDocSerializerSession.java | 88 +++++---
.../org/apache/juneau/html/HtmlDocTemplate.java | 2 +
.../juneau/html/HtmlDocTemplateBasic.java | 1 +
.../java/org/apache/juneau/html/HtmlLink.java | 3 +
.../java/org/apache/juneau/html/HtmlParser.java | 2 +-
.../apache/juneau/html/HtmlParserBuilder.java | 1 +
.../apache/juneau/html/HtmlParserContext.java | 3 +
.../apache/juneau/html/HtmlParserSession.java | 29 ++-
.../java/org/apache/juneau/html/HtmlRender.java | 15 +-
.../juneau/html/HtmlSchemaDocSerializer.java | 3 +
.../org/apache/juneau/html/HtmlSerializer.java | 33 +--
.../juneau/html/HtmlSerializerBuilder.java | 15 +-
.../juneau/html/HtmlSerializerContext.java | 16 ++
.../juneau/html/HtmlSerializerSession.java | 26 ++-
.../juneau/html/HtmlStrippedDocSerializer.java | 2 +
.../org/apache/juneau/html/annotation/Html.java | 14 +-
.../java/org/apache/juneau/http/Accept.java | 21 +-
.../org/apache/juneau/http/AcceptCharset.java | 7 +
.../org/apache/juneau/http/AcceptEncoding.java | 7 +
.../org/apache/juneau/http/AcceptLanguage.java | 12 ++
.../org/apache/juneau/http/AcceptRanges.java | 5 +
.../main/java/org/apache/juneau/http/Age.java | 5 +
.../main/java/org/apache/juneau/http/Allow.java | 7 +
.../org/apache/juneau/http/Authorization.java | 5 +
.../org/apache/juneau/http/CacheControl.java | 5 +
.../java/org/apache/juneau/http/Connection.java | 7 +
.../org/apache/juneau/http/ContentEncoding.java | 6 +
.../org/apache/juneau/http/ContentLanguage.java | 6 +
.../org/apache/juneau/http/ContentLength.java | 5 +
.../org/apache/juneau/http/ContentLocation.java | 6 +
.../org/apache/juneau/http/ContentRange.java | 14 ++
.../org/apache/juneau/http/ContentType.java | 3 +
.../main/java/org/apache/juneau/http/Date.java | 13 +-
.../main/java/org/apache/juneau/http/ETag.java | 3 +
.../org/apache/juneau/http/EntityValidator.java | 1 +
.../java/org/apache/juneau/http/Expect.java | 7 +
.../java/org/apache/juneau/http/Expires.java | 11 +
.../main/java/org/apache/juneau/http/From.java | 6 +
.../java/org/apache/juneau/http/HeaderDate.java | 1 +
.../juneau/http/HeaderEntityValidator.java | 1 +
.../juneau/http/HeaderEntityValidatorArray.java | 1 +
.../java/org/apache/juneau/http/HeaderEnum.java | 2 +
.../org/apache/juneau/http/HeaderInteger.java | 2 +
.../apache/juneau/http/HeaderRangeArray.java | 2 +
.../org/apache/juneau/http/HeaderString.java | 2 +
.../apache/juneau/http/HeaderStringArray.java | 2 +
.../java/org/apache/juneau/http/HeaderUri.java | 2 +
.../main/java/org/apache/juneau/http/Host.java | 5 +
.../java/org/apache/juneau/http/HttpMethod.java | 1 +
.../java/org/apache/juneau/http/IfMatch.java | 12 ++
.../org/apache/juneau/http/IfModifiedSince.java | 10 +
.../org/apache/juneau/http/IfNoneMatch.java | 10 +
.../java/org/apache/juneau/http/IfRange.java | 7 +-
.../apache/juneau/http/IfUnmodifiedSince.java | 8 +
.../org/apache/juneau/http/LastModified.java | 7 +
.../java/org/apache/juneau/http/Location.java | 4 +
.../org/apache/juneau/http/MaxForwards.java | 5 +
.../java/org/apache/juneau/http/MediaType.java | 19 +-
.../org/apache/juneau/http/MediaTypeRange.java | 19 +-
.../java/org/apache/juneau/http/Pragma.java | 7 +
.../apache/juneau/http/ProxyAuthenticate.java | 3 +
.../apache/juneau/http/ProxyAuthorization.java | 3 +
.../main/java/org/apache/juneau/http/Range.java | 17 ++
.../java/org/apache/juneau/http/Referer.java | 4 +
.../java/org/apache/juneau/http/RetryAfter.java | 5 +
.../java/org/apache/juneau/http/Server.java | 5 +
.../org/apache/juneau/http/StringRange.java | 26 ++-
.../main/java/org/apache/juneau/http/TE.java | 35 ++--
.../java/org/apache/juneau/http/Trailer.java | 5 +
.../apache/juneau/http/TransferEncoding.java | 6 +
.../java/org/apache/juneau/http/Upgrade.java | 9 +
.../java/org/apache/juneau/http/UserAgent.java | 3 +
.../main/java/org/apache/juneau/http/Vary.java | 6 +-
.../main/java/org/apache/juneau/http/Via.java | 14 ++
.../java/org/apache/juneau/http/Warning.java | 14 ++
.../org/apache/juneau/http/WwwAuthenticate.java | 3 +
268 files changed, 3169 insertions(+), 1076 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java b/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java
index b7d630b..43362f2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java
@@ -14,6 +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.
@@ -24,6 +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.
*/
@@ -33,6 +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/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/BeanPropertyValue.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanPropertyValue.java b/juneau-core/src/main/java/org/apache/juneau/BeanPropertyValue.java
index 856968c..4e5812c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanPropertyValue.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanPropertyValue.java
@@ -14,7 +14,6 @@ package org.apache.juneau;
/**
* Represents a simple bean property value and the meta-data associated with it.
- * <p>
*/
public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
@@ -40,6 +39,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the bean property metadata.
+ *
* @return The bean property metadata.
*/
public final BeanPropertyMeta getMeta() {
@@ -48,6 +48,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the bean property metadata.
+ *
* @return The bean property metadata.
*/
public final ClassMeta<?> getClassMeta() {
@@ -56,6 +57,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the bean property name.
+ *
* @return The bean property name.
*/
public final String getName() {
@@ -64,6 +66,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the bean property value.
+ *
* @return The bean property value.
*/
public final Object getValue() {
@@ -72,6 +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/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java b/juneau-core/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java
index 57bd0be..27ac252 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java
@@ -19,9 +19,10 @@ 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.
+ * 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
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java b/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java
index 83f9b42..fb11738 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java
@@ -23,10 +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()} annotation.
+ *
* <p>
* The dictionary is used by the framework in the following ways:
* <ul>
@@ -116,8 +119,9 @@ 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()}.
- * Can include multi-dimensional array type names (e.g. <js>"X^^"</js>).
+ * @param typeName
+ * The bean type name as defined by {@link Bean#typeName()}.
+ * Can include multi-dimensional array type names (e.g. <js>"X^^"</js>).
* @return The class metadata for the bean.
*/
public ClassMeta<?> getClassMeta(String typeName) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanSession.java b/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
index b8ed6ec..353c65b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
@@ -30,6 +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,14 +47,18 @@ public class BeanSession extends Session {
/**
* Create a new session using properties specified in the context.
*
- * @param op The override properties.
- * These override any context properties defined in the context.
- * @param ctx The context creating this session object.
- * The context contains all the configuration settings for this object.
- * @param locale The session locale.
- * If <jk>null</jk>, then the locale defined on the context is used.
- * @param timeZone The session timezone.
- * If <jk>null</jk>, then the timezone defined on the context is used.
+ * @param op
+ * The override properties.
+ * These override any context properties defined in the context.
+ * @param ctx
+ * The context creating this session object.
+ * The context contains all the configuration settings for this object.
+ * @param locale
+ * The session locale.
+ * If <jk>null</jk>, then the locale defined on the context is used.
+ * @param timeZone
+ * The session timezone.
+ * If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
*/
protected BeanSession(BeanContext ctx, ObjectMap op, Locale locale, TimeZone timeZone, MediaType mediaType) {
@@ -76,6 +81,7 @@ public class BeanSession extends Session {
/**
* Returns the locale defined on this session.
+ *
* <p>
* The locale is determined in the following order:
* <ol>
@@ -93,6 +99,8 @@ public class BeanSession extends Session {
/**
* Returns the timezone defined on this session.
+ *
+ * <p>
* The timezone is determined in the following order:
* <ol>
* <li><code>timeZone</code> parameter passed in through constructor.
@@ -117,6 +125,8 @@ 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.
@@ -127,6 +137,7 @@ 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.
*
@@ -148,8 +159,9 @@ public class BeanSession extends Session {
* 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.
- * Should be <jk>null</jk> if not a member class.
+ * @param outer
+ * If class is a member class, this is the instance of the containing class.
+ * Should be <jk>null</jk> if not a member class.
* @param value The value to convert.
* @param type The class type to convert the value to.
* @throws InvalidDataConversionException If the specified value cannot be converted to the specified type.
@@ -161,8 +173,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'>
@@ -298,11 +312,12 @@ 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.
+ * 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.
- * Should be <jk>null</jk> if not a member class.
+ * @param outer
+ * If class is a member class, this is the instance of the containing class.
+ * Should be <jk>null</jk> if not a member class.
* @param value The value to convert.
* @param type The class type to convert the value to.
* @throws InvalidDataConversionException If the specified value cannot be converted to the specified type.
@@ -624,12 +639,14 @@ 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>.
+ * 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.
@@ -662,6 +679,7 @@ 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.
@@ -703,8 +721,9 @@ 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.
+ * 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.
*
@@ -723,8 +742,9 @@ public class BeanSession extends Session {
* @return The bean representation, or <jk>null</jk> if the object is not a true bean.
* @throws NullPointerException If either parameter is null.
* @throws IllegalArgumentException If the specified object is not an an instance of the specified class.
- * @throws BeanRuntimeException If specified object is not a bean according to the bean rules
- * specified in this context class.
+ * @throws
+ * BeanRuntimeException If specified object is not a bean according to the bean rules specified in this context
+ * class.
*/
public final <T> BeanMap<T> toBeanMap(T o, Class<? super T> c) throws BeanRuntimeException {
assertFieldNotNull(o, "o");
@@ -744,6 +764,7 @@ 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.
@@ -763,13 +784,14 @@ 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.
+ * 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 If class is a member class, this is the instance of the containing class.
- * Should be <jk>null</jk> if not a member class.
+ * @param outer
+ * If class is a member class, this is the instance of the containing class.
+ * Should be <jk>null</jk> if not a member class.
* @return A new instance of the class.
*/
public final <T> BeanMap<T> newBeanMap(Object outer, Class<T> c) {
@@ -802,13 +824,14 @@ 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.
+ * 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 If class is a member class, this is the instance of the containing class.
- * Should be <jk>null</jk> if not a member class.
+ * @param outer
+ * If class is a member class, this is the instance of the containing class.
+ * Should be <jk>null</jk> if not a member class.
* @return A new bean object.
* @throws BeanRuntimeException If the specified class is not a valid bean.
*/
@@ -834,7 +857,8 @@ public class BeanSession extends Session {
*
* @param <T> The class type to get the meta-data on.
* @param c The class to get the meta-data on.
- * @return The {@link BeanMeta} for the specified class, or <jk>null</jk> if the class
+ * @return
+ * The {@link BeanMeta} for the specified class, or <jk>null</jk> if the class
* is not a bean per the settings on this context.
*/
public final <T> BeanMeta<T> getBeanMeta(Class<T> c) {
@@ -857,12 +881,15 @@ 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.
*
@@ -899,6 +926,8 @@ 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.
@@ -928,8 +957,9 @@ 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>.
+ * @param cm
+ * The class meta of the type we're trying to resolve the type name for.
+ * Can be <jk>null</jk>.
* @return The type property name. Never <jk>null</jk>.
*/
public final String getBeanTypePropertyName(ClassMeta cm) {
@@ -948,6 +978,7 @@ 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)}.
*
@@ -973,12 +1004,13 @@ 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.
+ * This <code>ClassMeta</code> is often used to represent "any object type" when an object type is not known.
+ *
* <p>
- * This method is identical to calling <code>getClassMeta(Object.<jk>class</jk>)</code> but uses
- * a cached copy to avoid a hashmap lookup.
+ * This method is identical to calling <code>getClassMeta(Object.<jk>class</jk>)</code> but uses a cached copy to
+ * avoid a hashmap lookup.
*
* @return The {@link ClassMeta} object associated with the <code>Object</code> class.
*/
@@ -988,11 +1020,13 @@ 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.
+ * 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.
*/
@@ -1002,11 +1036,13 @@ 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.
+ * 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.
*/
@@ -1025,6 +1061,7 @@ public class BeanSession extends Session {
/**
* Returns the media type specified for this session.
+ *
* <p>
* For example, <js>"application/json"</js>.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java b/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
index 7e7d640..0e1bd72 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
@@ -34,11 +34,11 @@ import org.apache.juneau.transform.*;
import org.apache.juneau.utils.*;
/**
- * A wrapper class around the {@link Class} object that provides cached information
- * about that class.
+ * 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>
@@ -46,9 +46,10 @@ 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.
+ * 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.
*/
@@ -119,17 +120,22 @@ public final class ClassMeta<T> implements Type {
*
* @param innerClass The class being wrapped.
* @param beanContext The bean context that created this object.
- * @param implClass For interfaces and abstract classes, this represents the "real" class to instantiate.
- * Can be <jk>null</jk>.
- * @param beanFilter The {@link BeanFilter} programmatically associated with this class.
- * Can be <jk>null</jk>.
- * @param pojoSwap The {@link PojoSwap} programmatically associated with this class.
- * Can be <jk>null</jk>.
- * @param childPojoSwap The child {@link PojoSwap PojoSwaps} programmatically associated with this class.
- * These are the <code>PojoSwaps</code> that have normal classes that are subclasses of this class.
- * Can be <jk>null</jk>.
- * @param delayedInit Don't call init() in constructor.
- * Used for delayed initialization when the possibility of class reference loops exist.
+ * @param implClass
+ * For interfaces and abstract classes, this represents the "real" class to instantiate.
+ * Can be <jk>null</jk>.
+ * @param beanFilter
+ * The {@link BeanFilter} programmatically associated with this class.
+ * Can be <jk>null</jk>.
+ * @param pojoSwap
+ * The {@link PojoSwap} programmatically associated with this class.
+ * Can be <jk>null</jk>.
+ * @param childPojoSwap
+ * The child {@link PojoSwap PojoSwaps} programmatically associated with this class.
+ * These are the <code>PojoSwaps</code> that have normal classes that are subclasses of this class.
+ * Can be <jk>null</jk>.
+ * @param delayedInit
+ * Don't call init() in constructor.
+ * Used for delayed initialization when the possibility of class reference loops exist.
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
ClassMeta(Class<T> innerClass, BeanContext beanContext, Class<? extends T> implClass, BeanFilter beanFilter, PojoSwap<T,?> pojoSwap, PojoSwap<?,?>[] childPojoSwaps) {
@@ -196,6 +202,8 @@ public final class ClassMeta<T> implements Type {
/**
* Copy constructor.
+ *
+ * <p>
* Used for creating Map and Collection class metas that shouldn't be cached.
*/
ClassMeta(ClassMeta<T> mainType, ClassMeta<?> keyType, ClassMeta<?> valueType, ClassMeta<?> elementType) {
@@ -684,11 +692,13 @@ 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.
+ * @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.
*/
public String getBeanTypePropertyName() {
return typePropertyName;
@@ -696,11 +706,13 @@ 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()}.
*
- * @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.
+ * @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.
*/
public String getDictionaryName() {
return dictionaryName;
@@ -708,9 +720,10 @@ 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()} annotation defined
- * on the class, regardless of whether the class is an actual bean.
+ * This bean registry contains names specified in the {@link 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.
@@ -750,9 +763,10 @@ 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.
+ * 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.
*/
@@ -761,8 +775,8 @@ 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.
+ * 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.
@@ -788,8 +802,8 @@ 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.
+ * 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.
@@ -816,6 +830,8 @@ 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.
@@ -886,8 +902,8 @@ 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.
+ * 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}.
*/
@@ -1144,9 +1160,10 @@ 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>.
+ * 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.
*/
@@ -1167,6 +1184,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() {
@@ -1175,6 +1193,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() {
@@ -1184,6 +1203,8 @@ 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.
@@ -1194,6 +1215,8 @@ 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.
@@ -1205,8 +1228,9 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the {@link PojoSwap} associated with this class.
*
- * @return The {@link PojoSwap} associated with this class, or <jk>null</jk> if there is no POJO swap
- * associated with this class.
+ * @return
+ * The {@link PojoSwap} associated with this class, or <jk>null</jk> if there is no POJO swap associated with
+ * this class.
*/
public PojoSwap<T,?> getPojoSwap() {
return pojoSwap;
@@ -1215,8 +1239,9 @@ 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.
+ * @return
+ * The {@link BeanMeta} associated with this class, or <jk>null</jk> if there is no bean meta associated with
+ * this class.
*/
public BeanMeta<T> getBeanMeta() {
return beanMeta;
@@ -1269,13 +1294,13 @@ 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.
+ * 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 <jk>true</jk> if a new instance of this class can be created within the context of the specified outer
- * object.
+ * @param outer
+ * The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
+ * @return
+ * <jk>true</jk> if a new instance of this class can be created within the context of the specified outer object.
*/
public boolean canCreateNewInstance(Object outer) {
if (isMemberClass)
@@ -1285,13 +1310,13 @@ 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.
+ * 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 <jk>true</jk> if a new instance of this bean can be created within the context of the specified outer
- * object.
+ * @param outer
+ * The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
+ * @return
+ * <jk>true</jk> if a new instance of this bean can be created within the context of the specified outer object.
*/
public boolean canCreateNewBean(Object outer) {
if (beanMeta == null)
@@ -1306,8 +1331,9 @@ 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.
+ * @param outer
+ * The outer class object for non-static member classes.
+ * Can be <jk>null</jk> for non-member or static classes.
* @return <jk>true</jk> if this class has a no-arg constructor or invocation handler.
*/
public boolean canCreateNewInstanceFromString(Object outer) {
@@ -1324,8 +1350,9 @@ 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.
+ * @param outer
+ * The outer class object for non-static member classes.
+ * Can be <jk>null</jk> for non-member or static classes.
* @return <jk>true</jk> if this class has a no-arg constructor or invocation handler.
*/
public boolean canCreateNewInstanceFromNumber(Object outer) {
@@ -1350,18 +1377,20 @@ 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.
+ * @return
+ * The method or field annotated with {@link NameProperty @NameProperty} or <jk>null</jk> if method does not
+ * exist.
*/
public Setter getNameProperty() {
return namePropertyMethod;
}
/**
- * Returns the method or field annotated with {@link ParentProperty @ParentProperty}.
+ * 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.
+ * @return
+ * The method or field annotated with {@link ParentProperty @ParentProperty} or <jk>null</jk> if method does not
+ * exist.
*/
public Setter getParentProperty() {
return parentPropertyMethod;
@@ -1406,6 +1435,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>
@@ -1414,15 +1444,17 @@ public final class ClassMeta<T> implements Type {
* <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 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.
* @return A new instance of the object, or <jk>null</jk> if there is no string constructor on the object.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
- * the underlying constructor is inaccessible.
+ * @throws IllegalAccessException
+ * If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is
+ * inaccessible.
* @throws IllegalArgumentException If the parameter type on the method was invalid.
- * @throws InstantiationException If the class that declares the underlying constructor represents an abstract class, or
- * does not have one of the methods described above.
+ * @throws InstantiationException
+ * If the class that declares the underlying constructor represents an abstract class, or does not have one of
+ * the methods described above.
* @throws InvocationTargetException If the underlying constructor throws an exception.
*/
@SuppressWarnings("unchecked")
@@ -1441,6 +1473,7 @@ 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>
@@ -1448,15 +1481,18 @@ public final class ClassMeta<T> implements Type {
* </ul>
*
* @param session The current bean session.
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
- * classes.
+ * @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.
* @return A new instance of the object, or <jk>null</jk> if there is no numeric constructor on the object.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
- * the underlying constructor is inaccessible.
+ * @throws IllegalAccessException
+ * If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is
+ * inaccessible.
* @throws IllegalArgumentException If the parameter type on the method was invalid.
- * @throws InstantiationException If the class that declares the underlying constructor represents an abstract
- * class, or does not have one of the methods described above.
+ * @throws InstantiationException
+ * If the class that declares the underlying constructor represents an abstract class, or does not have one of
+ * the methods described above.
* @throws InvocationTargetException If the underlying constructor throws an exception.
*/
public T newInstanceFromNumber(BeanSession session, Object outer, Number arg) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, InstantiationException {
@@ -1474,9 +1510,11 @@ 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 inaccessible.
- * @throws IllegalArgumentException If one of the following occurs:
+ * @throws IllegalAccessException
+ * If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is
+ * inaccessible.
+ * @throws IllegalArgumentException
+ * If one of the following occurs:
* <ul class='spaced-list'>
* <li>
* The number of actual and formal parameters differ.
@@ -1509,12 +1547,15 @@ 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.
+ * @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.
* @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 inaccessible.
- * @throws IllegalArgumentException If one of the following occurs:
+ * @throws IllegalAccessException
+ * If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is
+ * inaccessible.
+ * @throws IllegalArgumentException
+ * If one of the following occurs:
* <ul class='spaced-list'>
* <li>
* The number of actual and formal parameters differ.
@@ -1550,8 +1591,8 @@ 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>).
+ * 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.
@@ -1611,8 +1652,9 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if the specified object is an instance of this class.
- * This is a simple comparison on the base class itself and not on
- * any generic parameters.
+ *
+ * <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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/ClassMetaExtended.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ClassMetaExtended.java b/juneau-core/src/main/java/org/apache/juneau/ClassMetaExtended.java
index 3de3147..b085de1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ClassMetaExtended.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ClassMetaExtended.java
@@ -14,9 +14,10 @@ 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.
+ * Serializers and parsers can implement their own language-specific metadata on a class and retrieve the metadata
+ * using the {@link ClassMeta#getExtendedMeta(Class)} method.
*/
public class ClassMetaExtended {
@@ -24,6 +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.
*/
@@ -33,6 +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() {
@@ -41,6 +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/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/Context.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Context.java b/juneau-core/src/main/java/org/apache/juneau/Context.java
index df8bf27..820dfc2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Context.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Context.java
@@ -19,12 +19,14 @@ 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 PropertyStore#getContext(Class)} method.
+ *
* <p>
* Subclasses MUST implement a constructor method that takes in a {@link PropertyStore} parameter.
- * Besides that restriction, a context object can do anything you desire. However, it MUST
- * be thread-safe and all fields should be declared final to prevent modification.
+ * Besides that restriction, a context object can do anything you desire.
+ * However, it MUST be thread-safe and all fields should be declared final to prevent modification.
* It should NOT be used for storing temporary or state information.
*
* @see PropertyStore
@@ -35,6 +37,7 @@ public abstract class Context {
/**
* Constructor for this class.
+ *
* <p>
* Subclasses MUST implement the same constructor.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/CoreObject.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/CoreObject.java b/juneau-core/src/main/java/org/apache/juneau/CoreObject.java
index 1d6fdce..de19fde 100644
--- a/juneau-core/src/main/java/org/apache/juneau/CoreObject.java
+++ b/juneau-core/src/main/java/org/apache/juneau/CoreObject.java
@@ -24,6 +24,7 @@ public abstract class CoreObject {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
protected CoreObject(PropertyStore propertyStore) {
@@ -32,8 +33,8 @@ public abstract class CoreObject {
}
/**
- * Creates a new builder class for this object so that a new object can be created
- * that expands upon the current object's settings.
+ * Creates a new builder class for this object so that a new object can be created that expands upon the current
+ * object's settings.
*
* @return A new builder.
*/
@@ -42,11 +43,11 @@ public abstract class CoreObject {
}
/**
- * Method used by subclasses to override context factory properties for just this
- * instance without modifying the context factory itself.
+ * Method used by subclasses to override context factory properties for just this instance without modifying the
+ * context factory itself.
+ *
* <p>
- * Subclasses can call this parent method to append to override properties defined
- * higher in the parent chain.
+ * Subclasses can call this parent method to append to override properties defined higher in the parent chain.
*
* @return The override properties. Never <jk>null</jk>.
*/
@@ -55,19 +56,19 @@ public abstract class CoreObject {
}
/**
- * Returns a copy of the context factory passed in to the constructor with
- * any override properties applied from the {@link #getOverrideProperties()}.
+ * Returns a copy of the context factory passed in to the constructor with any override properties applied from the
+ * {@link #getOverrideProperties()}.
*
- * @return The context factory on this class.
- * Multiple calls to this method returns the same factory.
+ * @return
+ * The context factory on this class.
+ * Multiple calls to this method returns the same factory.
*/
public PropertyStore createPropertyStore() {
return PropertyStore.create(propertyStore);
}
/**
- * Creates a read-only context object of the specified type using the context
- * factory on this class.
+ * Creates a read-only context object of the specified type using the context factory on this class.
*
* @param c The context class to create.
* @return The new context object.
@@ -78,6 +79,7 @@ public abstract class CoreObject {
/**
* Returns the bean context to use for this class.
+ *
* @return The bean context object.
*/
public BeanContext getBeanContext() {
[5/9] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java
index 415fc6e..2963931 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Meter.java
@@ -35,10 +35,13 @@ 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}.
+ * @param high
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Meter high(Object high) {
@@ -48,10 +51,13 @@ 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}.
+ * @param low
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Meter low(Object low) {
@@ -61,10 +67,13 @@ 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}.
+ * @param max
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Meter max(Object max) {
@@ -74,10 +83,13 @@ 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}.
+ * @param min
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Meter min(Object min) {
@@ -87,10 +99,13 @@ 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}.
+ * @param optimum
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Meter optimum(Object optimum) {
@@ -100,10 +115,13 @@ 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}.
+ * @param value
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Meter value(Object value) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java
index ac749df..a41820a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Noscript.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/scripting-1.html#the-noscript-element"><noscript></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java
index 13e1f74..bcbe8dc 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Object2.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-object-element"><object></a> element.
+ * 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'>
@@ -35,6 +35,8 @@ 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.
@@ -47,6 +49,8 @@ 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.
@@ -60,10 +64,13 @@ 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}.
+ * @param height
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Object2 height(Object height) {
@@ -73,6 +80,8 @@ 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.
@@ -85,6 +94,8 @@ 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.
@@ -96,12 +107,15 @@ 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.
+ * <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}.
+ * @param typemustmatch
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Object2 typemustmatch(Object typemustmatch) {
@@ -110,8 +124,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.
+ * <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.
@@ -124,10 +140,13 @@ 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}.
+ * @param width
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Object2 width(Object width) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java
index 8b5cd31..a559fce 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ol.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-ol-element"><ol></a> element.
+ * 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'>
@@ -36,10 +36,13 @@ 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}.
+ * @param reversed
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Ol reversed(Object reversed) {
@@ -49,10 +52,13 @@ 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}.
+ * @param start
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Ol start(Object start) {
@@ -62,6 +68,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
index d7c3726..2ee4ede 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Optgroup.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/forms.html#the-optgroup-element"><optgroup></a> element.
+ * 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'>
@@ -35,10 +35,13 @@ 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}.
+ * @param disabled
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Optgroup disabled(Object disabled) {
@@ -48,6 +51,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java
index 1b6da65..4fef873 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Option.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/forms.html#the-option-element"><option></a> element.
+ * 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'>
@@ -35,10 +35,13 @@ 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}.
+ * @param disabled
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Option disabled(Object disabled) {
@@ -48,6 +51,8 @@ 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.
@@ -60,10 +65,13 @@ 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}.
+ * @param selected
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Option selected(Object selected) {
@@ -73,10 +81,13 @@ 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}.
+ * @param value
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Option value(Object value) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java
index 0038a3f..6666dad 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Output.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/forms.html#the-output-element"><output></a> element.
+ * 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'>
@@ -35,6 +35,8 @@ 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.
@@ -47,6 +49,8 @@ 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.
@@ -59,6 +63,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java
index aa32a4e..dddd064 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/P.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-p-element"><p></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java
index efb6aa6..51dd668 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Param.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-param-element"><param></a> element.
+ * 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'>
@@ -35,6 +35,8 @@ 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.
@@ -48,10 +50,13 @@ 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}.
+ * @param value
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Param value(Object value) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java
index 54d2744..cb65eeb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Pre.java
@@ -20,8 +20,8 @@ import org.apache.juneau.annotation.*;
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.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java
index c71cb06..bb81676 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Progress.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/forms.html#the-progress-element"><progress></a> element.
+ * 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'>
@@ -35,10 +35,13 @@ 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}.
+ * @param max
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Progress max(Object max) {
@@ -48,10 +51,13 @@ 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}.
+ * @param value
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Progress value(Object value) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java
index 37e2ed2..69e33eb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Q.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-q-element"><q></a> element.
+ * 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'>
@@ -35,6 +35,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java
index b06de35..e48d0c0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rb.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rb-element"><rb></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java
index 6ed9907..fba84cb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rp.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rp-element"><rp></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java
index ce57eb3..824b54c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rt.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rt-element"><rt></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java
index 0b0cf9e..5c3ffed 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Rtc.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-rtc-element"><rtc></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java
index 8c58efd..cd4fbe2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ruby.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-ruby-element"><ruby></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java
index 46ad3a2..51caac5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/S.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-s-element"><s></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java
index 79bdbd7..8dfdbef 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Samp.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-samp-element"><samp></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java
index 05d7fec..b59999e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Script.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -39,10 +39,13 @@ 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}.
+ * @param async
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Script async(Object async) {
@@ -52,6 +55,8 @@ 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.
@@ -65,6 +70,8 @@ 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.
@@ -77,10 +84,13 @@ 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}.
+ * @param defer
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Script defer(Object defer) {
@@ -90,15 +100,20 @@ 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}.
+ * @param src
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final Script src(Object src) {
@@ -108,6 +123,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java
index 32c3f75..38c97ae 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Section.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/sections.html#the-section-element"><section></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java
index 03263c8..3e0da8e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Select.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/forms.html#the-select-element"><select></a> element.
+ * 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'>
@@ -35,10 +35,13 @@ 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}.
+ * @param autofocus
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Select autofocus(Object autofocus) {
@@ -48,10 +51,13 @@ 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}.
+ * @param disabled
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Select disabled(Object disabled) {
@@ -61,6 +67,8 @@ 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.
@@ -73,10 +81,13 @@ 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}.
+ * @param multiple
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Select multiple(Object multiple) {
@@ -86,6 +97,8 @@ 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.
@@ -98,10 +111,13 @@ 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}.
+ * @param required
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Select required(Object required) {
@@ -111,10 +127,13 @@ 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}.
+ * @param size
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Select size(Object size) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java
index daaefa3..eb40c63 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Small.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-small-element"><small></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java
index f57954a..19e42f7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Source.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -39,15 +39,20 @@ 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}.
+ * @param src
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final Source src(Object src) {
@@ -57,6 +62,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java
index 6111c85..c8b3a75 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Span.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-span-element"><span></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java
index 65258d2..364a90e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Strong.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-strong-element"><strong></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java
index 5ac39cd..23bddeb 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Style.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/document-metadata.html#the-style-element"><style></a> element.
+ * 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'>
@@ -35,6 +35,8 @@ 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.
@@ -47,6 +49,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java
index c1382ed..1d159d9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sub.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-sub-and-sup-elements"><sub></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java
index 27f41d4..7224be9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Sup.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-sub-and-sup-elements"><sup></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java
index 608a552..8f3db7e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Table.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/tabular-data.html#the-table-element"><table></a> element.
+ * 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'>
@@ -36,8 +36,9 @@ 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}.
+ * @param border
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Table border(Object border) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java
index e80fa54..b476ba7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tbody.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/tabular-data.html#the-tbody-element"><tbody></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java
index b19ea39..32093c4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Td.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/tabular-data.html#the-td-element"><td></a> element.
+ * 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'>
@@ -35,10 +35,13 @@ 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}.
+ * @param colspan
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Td colspan(Object colspan) {
@@ -48,6 +51,8 @@ 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.
@@ -60,10 +65,13 @@ 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}.
+ * @param rowspan
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Td rowspan(Object rowspan) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java
index d587dda..f9c1a1a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Template.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/scripting-1.html#the-template-element"><template></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java
index d74900f..8f08e65 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Textarea.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/forms.html#the-textarea-element"><textarea></a> element.
+ * 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'>
@@ -35,6 +35,8 @@ 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.
@@ -47,10 +49,13 @@ 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}.
+ * @param autofocus
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Textarea autofocus(Boolean autofocus) {
@@ -60,10 +65,13 @@ 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}.
+ * @param cols
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Textarea cols(Object cols) {
@@ -73,6 +81,8 @@ 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.
@@ -85,10 +95,13 @@ 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}.
+ * @param disabled
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Textarea disabled(Object disabled) {
@@ -98,6 +111,8 @@ 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.
@@ -110,6 +125,8 @@ 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.
@@ -122,10 +139,13 @@ 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}.
+ * @param maxlength
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Textarea maxlength(Object maxlength) {
@@ -135,10 +155,13 @@ 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}.
+ * @param minlength
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Textarea minlength(Object minlength) {
@@ -148,6 +171,8 @@ 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.
@@ -161,6 +186,8 @@ 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.
@@ -173,10 +200,13 @@ 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}.
+ * @param readonly
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Textarea readonly(Object readonly) {
@@ -186,10 +216,13 @@ 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}.
+ * @param required
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Textarea required(Object required) {
@@ -199,10 +232,13 @@ 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}.
+ * @param rows
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Textarea rows(Number rows) {
@@ -212,6 +248,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
index 0bdeb53..26ab554 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tfoot.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/tabular-data.html#the-tfoot-element"><tfoot></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java
index 31057e0..9fe7daf 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Th.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/tabular-data.html#the-th-element"><th></a> element.
+ * 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'>
@@ -35,6 +35,8 @@ 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.
@@ -47,10 +49,13 @@ 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}.
+ * @param colspan
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Th colspan(Object colspan) {
@@ -60,6 +65,8 @@ 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.
@@ -72,10 +79,13 @@ 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}.
+ * @param rowspan
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Th rowspan(Object rowspan) {
@@ -85,6 +95,8 @@ 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.
@@ -97,6 +109,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java
index b4ea5f5..6543101 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Thead.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/tabular-data.html#the-thead-element"><thead></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java
index 4cc57a2..72715f9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Time.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-time-element"><time></a> element.
+ * 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'>
@@ -36,6 +36,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java
index f1013c2..2c15355 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Title.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/document-metadata.html#the-title-element"><title></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java
index e788410..a848601 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Tr.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/tabular-data.html#the-tr-element"><tr></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java
index 49e7980..668efb6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Track.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -40,6 +40,8 @@ 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.
@@ -52,6 +54,8 @@ 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.
@@ -64,6 +68,8 @@ 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.
@@ -76,15 +82,20 @@ 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}.
+ * @param src
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final Track src(Object src) {
@@ -95,6 +106,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java
index e86a679..fbc66e2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/U.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-u-element"><u></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java
index c33d143..aca14e3 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Ul.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-ul-element"><ul></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java
index bd25361..eee01de 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Var.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-var-element"><var></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java
index 33137e1..8c36fac 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Video.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -40,10 +40,13 @@ 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}.
+ * @param autoplay
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Video autoplay(Object autoplay) {
@@ -54,10 +57,13 @@ 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}.
+ * @param controls
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Video controls(Object controls) {
@@ -66,8 +72,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.
+ * <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.
@@ -81,10 +89,13 @@ 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}.
+ * @param height
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Video height(Object height) {
@@ -94,10 +105,13 @@ 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}.
+ * @param loop
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Video loop(Object loop) {
@@ -106,8 +120,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.
+ * <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.
@@ -121,10 +137,13 @@ 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}.
+ * @param muted
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Video muted(Object muted) {
@@ -135,6 +154,8 @@ 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.
@@ -148,6 +169,8 @@ 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.
@@ -160,15 +183,20 @@ 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}.
+ * @param src
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final Video src(Object src) {
@@ -178,10 +206,13 @@ 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}.
+ * @param width
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Video width(Object width) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java
index 5e81f94..f99be21 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Wbr.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-wbr-element"><wbr></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
index f46950a..805b234 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonType.java
@@ -14,10 +14,11 @@ 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).
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
index 4a1faed..8339594 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/JsonTypeArray.java
@@ -51,8 +51,7 @@ public final class JsonTypeArray extends LinkedList<JsonType> {
}
/**
- * Convenience method for adding one or more {@link JsonType} objects to
- * this array.
+ * 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).
[2/9] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
index 8e20a3e..ac330a1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
@@ -26,8 +26,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 SerializerContext} for details.
+ *
* <p>
* This class is NOT thread safe. It is meant to be discarded after one-time use.
*/
@@ -42,18 +44,25 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Create a new session using properties specified in the context.
*
- * @param ctx The context creating this session object.
+ * @param ctx
+ * The context creating this session object.
* The context contains all the configuration settings for this object.
- * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.
- * @param op The override properties.
+ * @param output
+ * The output object.
+ * See {@link JsonSerializerSession#getWriter()} for valid class types.
+ * @param op
+ * The override properties.
* These override any context properties defined in the context.
* @param javaMethod The java method that called this serializer, usually the method in a REST servlet.
- * @param locale The session locale.
+ * @param locale
+ * The session locale.
* If <jk>null</jk>, then the locale defined on the context is used.
- * @param timeZone The session timezone.
+ * @param timeZone
+ * The session timezone.
* If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
- * @param uriContext The URI context.
+ * @param uriContext
+ * The URI context.
* Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
@@ -95,8 +104,10 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_cssUrl} setting value in this context.
*
- * @return The {@link HtmlDocSerializerContext#HTMLDOC_cssUrl} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * @return
+ * The {@link HtmlDocSerializerContext#HTMLDOC_cssUrl} setting value in this context.
+ * <jk>null</jk> if not specified.
+ * Never an empty string.
*/
public final String getCssUrl() {
return cssUrl;
@@ -105,7 +116,8 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_css} setting value in this context.
*
- * @return The {@link HtmlDocSerializerContext#HTMLDOC_css} setting value in this context.
+ * @return
+ * The {@link HtmlDocSerializerContext#HTMLDOC_css} setting value in this context.
* <jk>null</jk> if not specified. Never an empty array.
*/
public final String[] getCss() {
@@ -124,8 +136,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_title} setting value in this context.
*
- * @return The {@link HtmlDocSerializerContext#HTMLDOC_title} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * @return
+ * The {@link HtmlDocSerializerContext#HTMLDOC_title} setting value in this context.
+ * <jk>null</jk> if not specified. Never an empty string.
*/
public final String getTitle() {
return title;
@@ -134,8 +147,10 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_description} setting value in this context.
*
- * @return The {@link HtmlDocSerializerContext#HTMLDOC_description} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * @return
+ * The {@link HtmlDocSerializerContext#HTMLDOC_description} setting value in this context.
+ * <jk>null</jk> if not specified.
+ * Never an empty string.
*/
public final String getDescription() {
return description;
@@ -144,8 +159,10 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_branding} setting value in this context.
*
- * @return The {@link HtmlDocSerializerContext#HTMLDOC_branding} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * @return
+ * The {@link HtmlDocSerializerContext#HTMLDOC_branding} setting value in this context.
+ * <jk>null</jk> if not specified.
+ * Never an empty string.
*/
public final String getBranding() {
return branding;
@@ -154,8 +171,10 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_header} setting value in this context.
*
- * @return The {@link HtmlDocSerializerContext#HTMLDOC_header} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * @return
+ * The {@link HtmlDocSerializerContext#HTMLDOC_header} setting value in this context.
+ * <jk>null</jk> if not specified.
+ * Never an empty string.
*/
public final String getHeader() {
return header;
@@ -164,8 +183,10 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_links} setting value in this context.
*
- * @return The {@link HtmlDocSerializerContext#HTMLDOC_links} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty map.
+ * @return
+ * The {@link HtmlDocSerializerContext#HTMLDOC_links} setting value in this context.
+ * <jk>null</jk> if not specified.
+ * Never an empty map.
*/
public final Map<String,Object> getLinks() {
return links;
@@ -174,8 +195,9 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the template to use for generating the HTML page.
*
- * @return The HTML page generator.
- * Never <jk>null</jk>.
+ * @return
+ * The HTML page generator.
+ * Never <jk>null</jk>.
*/
public final HtmlDocTemplate getTemplate() {
return template;
@@ -184,8 +206,10 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_nav} setting value in this context.
*
- * @return The {@link HtmlDocSerializerContext#HTMLDOC_nav} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * @return
+ * The {@link HtmlDocSerializerContext#HTMLDOC_nav} setting value in this context.
+ * <jk>null</jk> if not specified.
+ * Never an empty string.
*/
public final String getNav() {
return nav;
@@ -194,8 +218,10 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_aside} setting value in this context.
*
- * @return The {@link HtmlDocSerializerContext#HTMLDOC_aside} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * @return
+ * The {@link HtmlDocSerializerContext#HTMLDOC_aside} setting value in this context.
+ * <jk>null</jk> if not specified.
+ * Never an empty string.
*/
public final String getAside() {
return aside;
@@ -204,8 +230,10 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_footer} setting value in this context.
*
- * @return The {@link HtmlDocSerializerContext#HTMLDOC_footer} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * @return
+ * The {@link HtmlDocSerializerContext#HTMLDOC_footer} setting value in this context.
+ * <jk>null</jk> if not specified.
+ * Never an empty string.
*/
public final String getFooter() {
return footer;
@@ -214,8 +242,10 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession {
/**
* Returns the {@link HtmlDocSerializerContext#HTMLDOC_noResultsMessage} setting value in this context.
*
- * @return The {@link HtmlDocSerializerContext#HTMLDOC_noResultsMessage} setting value in this context.
- * <jk>null</jk> if not specified. Never an empty string.
+ * @return
+ * The {@link HtmlDocSerializerContext#HTMLDOC_noResultsMessage} setting value in this context.
+ * <jk>null</jk> if not specified.
+ * Never an empty string.
*/
public final String getNoResultsMessage() {
return noResultsMessage;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
index 2e743f6..cc8b2b8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
@@ -15,6 +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'>
@@ -45,6 +46,7 @@ package org.apache.juneau.html;
* </body>
* </html></xt>
* </p>
+ *
* <p>
* This interface allows you to control how these sections get rendered.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
index 99a9688..3360770 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
@@ -18,6 +18,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/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java
index 5748815..39fba6f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java
@@ -19,10 +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/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java
index b28e73b..093c411 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java
@@ -514,7 +514,7 @@ public class HtmlParser extends XmlParser {
+ JsonSerializer.DEFAULT.toString(expected), r.getLocation());
}
- /**
+ /*
* Skips over the current element and advances to the next element.
* <p>
* Precondition: Pointing to opening tag.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java
index 7418e1b..b5e11dc 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java
@@ -36,6 +36,7 @@ public class HtmlParserBuilder extends XmlParserBuilder {
/**
* Constructor.
+ *
* @param propertyStore The initial configuration settings for this builder.
*/
public HtmlParserBuilder(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java
index 5541aba..e1abc7f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserContext.java
@@ -17,9 +17,11 @@ import org.apache.juneau.xml.*;
/**
* Configurable properties on the {@link HtmlParser} class.
+ *
* <p>
* Context properties are set by calling {@link PropertyStore#setProperty(String, Object)} on the property store
* passed into the constructor.
+ *
* <p>
* See {@link PropertyStore} for more information about context properties.
*
@@ -40,6 +42,7 @@ public final class HtmlParserContext extends XmlParserContext {
/**
* Constructor.
+ *
* <p>
* Typically only called from {@link PropertyStore#getContext(Class)}.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java
index 5e7881f..21ccd9a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java
@@ -28,6 +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 meant to be discarded after one-time use.
*/
@@ -42,9 +43,11 @@ 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.
- * @param input The input. Can be any of the following types:
+ * @param ctx
+ * The context creating this session object.
+ * The context contains all the configuration settings for this object.
+ * @param input
+ * The input. Can be any of the following types:
* <ul>
* <li><jk>null</jk>
* <li>{@link Reader}
@@ -52,14 +55,17 @@ public final class HtmlParserSession extends XmlParserSession {
* <li>{@link InputStream} containing UTF-8 encoded text.
* <li>{@link File} containing system encoded text.
* </ul>
- * @param op The override properties.
- * These override any context properties defined in the context.
+ * @param op
+ * The override properties.
+ * These override any context properties defined in the context.
* @param javaMethod The java method that called this parser, usually the method in a REST servlet.
* @param outer The outer object for instantiating top-level non-static inner classes.
- * @param locale The session locale.
- * If <jk>null</jk>, then the locale defined on the context is used.
- * @param timeZone The session timezone.
- * If <jk>null</jk>, then the timezone defined on the context is used.
+ * @param locale
+ * The session locale.
+ * If <jk>null</jk>, then the locale defined on the context is used.
+ * @param timeZone
+ * The session timezone.
+ * If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
*/
public HtmlParserSession(HtmlParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer,
@@ -69,6 +75,7 @@ public final class HtmlParserSession extends XmlParserSession {
/**
* Parses CHARACTERS data.
+ *
* <p>
* Precondition: Pointing to event immediately following opening tag.
* Postcondition: Pointing to closing tag.
@@ -158,8 +165,8 @@ public final class HtmlParserSession extends XmlParserSession {
}
/**
- * Identical to {@link #parseText(XMLStreamReader)} except assumes the current event
- * is the opening tag.
+ * Identical to {@link #parseText(XMLStreamReader)} except assumes the current event is the opening tag.
+ *
* <p>
* Precondition: Pointing to opening tag.
* Postcondition: Pointing to closing tag.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlRender.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlRender.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlRender.java
index b3dba1b..90e9898 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlRender.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlRender.java
@@ -17,18 +17,21 @@ 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:
+ * <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 {
*
@@ -116,6 +119,7 @@ import org.apache.juneau.serializer.*;
* }
* }
* </p>
+ *
* @param <T> The bean property type.
*/
public abstract class HtmlRender<T> {
@@ -123,7 +127,8 @@ public abstract class HtmlRender<T> {
/**
* Returns the CSS style of the element containing the bean property value.
*
- * @param session The current serializer session.
+ * @param session
+ * The current serializer session.
* Can be used to retrieve properties and session-level information.
* @param value The bean property value.
* @return The CSS style string, or <jk>null</jk> if no style should be added.
@@ -134,11 +139,13 @@ 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.
+ * @param session
+ * The current serializer session.
* Can be used to retrieve properties and session-level information.
* @param value The bean property value.
* @return The new bean property value.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
index 7420331..d4fcdd6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java
@@ -30,14 +30,17 @@ import org.apache.juneau.transform.*;
* <h5 class='section'>Media types:</h5>
* <p>
* Handles <code>Accept</code> types: <code>text/html+schema</code>
+ *
* <p>
* Produces <code>Content-Type</code> types: <code>text/html</code>
*
* <h5 class='section'>Description:</h5>
* <p>
* 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java
index 022fdab..22805bd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java
@@ -34,28 +34,31 @@ import org.apache.juneau.xml.annotation.*;
* <h5 class='section'>Media types:</h5>
* <p>
* Handles <code>Accept</code> types: <code>text/html</code>
+ *
* <p>
* Produces <code>Content-Type</code> types: <code>text/html</code>
*
* <h5 class='section'>Description:</h5>
* <p>
* The conversion is as follows...
- * <ul class='spaced-list'>
- * <li>
- * {@link Map Maps} (e.g. {@link HashMap}, {@link TreeMap}) and beans are converted to HTML tables with
- * 'key' and 'value' columns.
- * <li>
- * {@link Collection Collections} (e.g. {@link HashSet}, {@link LinkedList}) and Java arrays are converted
- * to HTML ordered lists.
- * <li>
- * {@code Collections} of {@code Maps} and beans are converted to HTML tables with keys as headers.
- * <li>
- * Everything else is converted to text.
- * </ul>
+ * <ul class='spaced-list'>
+ * <li>
+ * {@link Map Maps} (e.g. {@link HashMap}, {@link TreeMap}) and beans are converted to HTML tables with
+ * 'key' and 'value' columns.
+ * <li>
+ * {@link Collection Collections} (e.g. {@link HashSet}, {@link LinkedList}) and Java arrays are converted
+ * to HTML ordered lists.
+ * <li>
+ * {@code Collections} of {@code Maps} and beans are converted to HTML tables with keys as headers.
+ * <li>
+ * Everything else is converted to text.
+ * </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.
*
@@ -228,8 +231,9 @@ public class HtmlSerializer extends XmlSerializer {
* @param out The writer.
* @param o The object to serialize.
* @param eType The expected type of the object if this is a bean property.
- * @param name The attribute name of this object if this object was a field in a JSON object (i.e. key of a
- * {@link java.util.Map.Entry} or property name of a bean).
+ * @param name
+ * The attribute name of this object if this object was a field in a JSON object (i.e. key of a
+ * {@link java.util.Map.Entry} or property name of a bean).
* @param indent The current indentation value.
* @param pMeta The bean property being serialized, or <jk>null</jk> if we're not serializing a bean property.
* @param isRoot <jk>true</jk> if this is the root element of the document.
@@ -773,6 +777,7 @@ public class HtmlSerializer extends XmlSerializer {
/**
* Returns the schema serializer based on the settings of this serializer.
+ *
* @return The schema serializer.
*/
@Override /* XmlSerializer */
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
index c6cb528..0633abd 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
@@ -54,6 +54,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* <b>Configuration property:</b> Anchor text source.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.uriAnchorText"</js>
@@ -61,9 +62,11 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
* <li><b>Default:</b> <js>"toString"</js>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <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>
* Possible values:
* <ul class='spaced-list'>
@@ -97,6 +100,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* <b>Configuration property:</b> Look for URLs in {@link String Strings}.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.detectLinksInStrings"</js>
@@ -104,9 +108,10 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* If a string looks like a URL (e.g. starts with <js>"http://"</js> or <js>"https://"</js>, then treat it like a URL
- * and make it into a hyperlink based on the rules specified by {@link HtmlSerializerContext#HTML_uriAnchorText}.
+ * and make it into a hyperlink based on the rules specified by {@link HtmlSerializerContext#HTML_uriAnchorText}.
*
* <h5 class='section'>Notes:</h5>
* <ul>
@@ -124,6 +129,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* <b>Configuration property:</b> Look for link labels in the <js>"label"</js> parameter of the URL.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.lookForLabelParameters"</js>
@@ -131,8 +137,10 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <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 HtmlSerializerContext#HTML_labelParameter} property.
*
@@ -151,8 +159,8 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
}
/**
- * <b>Configuration property:</b> The parameter name to use when using
- * {@link HtmlSerializerContext#HTML_lookForLabelParameters}.
+ * <b>Configuration property:</b> The parameter name to use when using {@link HtmlSerializerContext#HTML_lookForLabelParameters}.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.labelParameter"</js>
@@ -177,6 +185,7 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* <b>Configuration property:</b> Add key/value headers on bean/map tables.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.addKeyValueTableHeaders"</js>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
index f66b94f..cbead45 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
@@ -18,9 +18,11 @@ import org.apache.juneau.xml.*;
/**
* Configurable properties on the {@link HtmlSerializer} class.
+ *
* <p>
* Context properties are set by calling {@link PropertyStore#setProperty(String, Object)} on the property store
* passed into the constructor.
+ *
* <p>
* See {@link PropertyStore} for more information about context properties.
*
@@ -41,6 +43,7 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* <b>Configuration property:</b> Anchor text source.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.uriAnchorText"</js>
@@ -48,9 +51,11 @@ public class HtmlSerializerContext extends XmlSerializerContext {
* <li><b>Default:</b> <js>"toString"</js>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <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>
* Possible values:
* <ul class='spaced-list'>
@@ -84,6 +89,7 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* <b>Configuration property:</b> Look for URLs in {@link String Strings}.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.detectLinksInStrings"</js>
@@ -91,6 +97,7 @@ public class HtmlSerializerContext extends XmlSerializerContext {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <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 #HTML_uriAnchorText}.
@@ -99,6 +106,7 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* <b>Configuration property:</b> Look for link labels in the <js>"label"</js> parameter of the URL.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.lookForLabelParameters"</js>
@@ -106,8 +114,10 @@ public class HtmlSerializerContext extends XmlSerializerContext {
* <li><b>Default:</b> <jk>true</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <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.
*/
@@ -115,6 +125,7 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* <b>Configuration property:</b> The parameter name to use when using {@link #HTML_lookForLabelParameters}.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.labelParameter"</js>
@@ -127,6 +138,7 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* <b>Configuration property:</b> Add key/value headers on bean/map tables.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.addKeyValueTableHeaders"</js>
@@ -139,6 +151,7 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* <b>Configuration property:</b> Add <js>"_type"</js> properties when needed.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.addBeanTypeProperties"</js>
@@ -146,12 +159,14 @@ public class HtmlSerializerContext extends XmlSerializerContext {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
* through reflection.
* 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 SerializerContext#SERIALIZER_addBeanTypeProperties} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerGroup}.
@@ -169,6 +184,7 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* Constructor.
+ *
* <p>
* Typically only called from {@link PropertyStore#getContext(Class)}.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
index 5377a8a..8a4f27f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java
@@ -27,6 +27,7 @@ import org.apache.juneau.xml.*;
/**
* Session object that lives for the duration of a single use of {@link HtmlSerializer}.
+ *
* <p>
* This class is NOT thread safe. It is meant to be discarded after one-time use.
*/
@@ -50,18 +51,23 @@ public class HtmlSerializerSession extends XmlSerializerSession {
/**
* Create a new session using properties specified in the context.
*
- * @param ctx The context creating this session object.
+ * @param ctx
+ * The context creating this session object.
* The context contains all the configuration settings for this object.
* @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.
- * @param op The override properties.
+ * @param op
+ * The override properties.
* These override any context properties defined in the context.
* @param javaMethod The java method that called this serializer, usually the method in a REST servlet.
- * @param locale The session locale.
+ * @param locale
+ * The session locale.
* If <jk>null</jk>, then the locale defined on the context is used.
- * @param timeZone The session timezone.
+ * @param timeZone
+ * The session timezone.
* If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
- * @param uriContext The URI context.
+ * @param uriContext
+ * The URI context.
* Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
*/
protected HtmlSerializerSession(HtmlSerializerContext ctx, ObjectMap op, Object output, Method javaMethod,
@@ -99,8 +105,9 @@ 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.
- * Can be <jk>null</jk> if the object isn't from a bean property.
+ * @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.
* @param o The object.
* @return <jk>true</jk> if the specified object is a URL.
*/
@@ -117,8 +124,9 @@ 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.
+ * @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.
* @param o The URL object.
* @return The anchor text to use for the specified URL object.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
index a43f1e7..d73319c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java
@@ -25,6 +25,7 @@ import org.apache.juneau.serializer.*;
* <h5 class='section'>Media types:</h5>
* <p>
* Handles <code>Accept</code> types: <code>text/html+stripped</code>
+ *
* <p>
* Produces <code>Content-Type</code> types: <code>text/html</code>
*
@@ -39,6 +40,7 @@ public class HtmlStrippedDocSerializer extends HtmlSerializer {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
public HtmlStrippedDocSerializer(PropertyStore propertyStore) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/annotation/Html.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/annotation/Html.java b/juneau-core/src/main/java/org/apache/juneau/html/annotation/Html.java
index 3ada90e..b385ac7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/annotation/Html.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/annotation/Html.java
@@ -20,8 +20,7 @@ import java.lang.annotation.*;
import org.apache.juneau.html.*;
/**
- * Annotation that can be applied to classes, fields, and methods to tweak how
- * they are handled by {@link HtmlSerializer}.
+ * Annotation that can be applied to classes, fields, and methods to tweak how they are handled by {@link HtmlSerializer}.
*/
@Documented
@Target({TYPE,FIELD,METHOD})
@@ -31,12 +30,16 @@ public @interface Html {
/**
* Treat as XML.
+ *
+ * <p>
* Useful when creating beans that model HTML elements.
*/
boolean asXml() default false;
/**
* 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.
*/
@@ -44,18 +47,23 @@ public @interface Html {
/**
* When <jk>true</jk>, collections of beans should be rendered as trees instead of tables.
+ *
+ * <p>
* Default is <jk>false</jk>.
*/
boolean noTables() default false;
/**
* When <jk>true</jk>, don't add headers to tables.
+ *
+ * <p>
* Default is <jk>false</jk>.
*/
boolean noTableHeaders() default false;
/**
* Associates an {@link HtmlRender} with a bean property for custom HTML rendering of the property.
+ *
* <p>
* This annotation applies to bean properties and classes.
*/
@@ -64,8 +72,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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Accept.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Accept.java b/juneau-core/src/main/java/org/apache/juneau/http/Accept.java
index 48d6373..4ea7bec 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Accept.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Accept.java
@@ -21,6 +21,7 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Accept</l> HTTP request header.
+ *
* <p>
* Content-Types that are acceptable for the response.
*
@@ -46,10 +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.
@@ -57,6 +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.
@@ -64,6 +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'>
@@ -72,21 +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.
@@ -102,6 +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.
@@ -120,6 +131,7 @@ 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
@@ -164,6 +176,7 @@ 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.
*
@@ -175,6 +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.
@@ -183,10 +197,10 @@ 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>
- * <p>
*
* @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.
@@ -218,8 +232,9 @@ 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.
+ * 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>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java b/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java
index 295aceb..c17ec3f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/AcceptCharset.java
@@ -19,6 +19,7 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Accept-Charset</l> HTTP request header.
+ *
* <p>
* Character sets that are acceptable.
*
@@ -30,6 +31,7 @@ import org.apache.juneau.internal.*;
* <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.
@@ -37,6 +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.
@@ -45,14 +48,18 @@ 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,
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java b/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java
index c9e7fef..c0cf845 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/AcceptEncoding.java
@@ -18,6 +18,7 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Accept-Encoding</l> HTTP request header.
+ *
* <p>
* List of acceptable encodings.
*
@@ -36,6 +37,7 @@ import org.apache.juneau.internal.*;
* 1#( codings [ ";" "q" "=" qvalue ] )
* codings = ( content-coding | "*" )
* </p>
+ *
* <p>
* Examples of its use are:
* <p class='bcode'>
@@ -45,6 +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>
@@ -60,20 +63,24 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java b/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java
index 0eb3454..cd187d9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/AcceptLanguage.java
@@ -18,6 +18,7 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Accept-Language</l> HTTP request header.
+ *
* <p>
* List of acceptable human languages for response.
*
@@ -37,6 +38,7 @@ import org.apache.juneau.internal.*;
* 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.
@@ -47,36 +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
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java b/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java
index 0ce6df4..18023b8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/AcceptRanges.java
@@ -14,6 +14,7 @@ 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.
*
@@ -30,6 +31,7 @@ package org.apache.juneau.http;
* 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'>
@@ -37,10 +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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Age.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Age.java b/juneau-core/src/main/java/org/apache/juneau/http/Age.java
index b1b1ce9..8cbdff0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Age.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Age.java
@@ -14,6 +14,7 @@ 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.
*
@@ -33,14 +34,18 @@ package org.apache.juneau.http;
* 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Allow.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Allow.java b/juneau-core/src/main/java/org/apache/juneau/http/Allow.java
index 7baa277..b0fab92 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Allow.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Allow.java
@@ -14,6 +14,7 @@ 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.
*
@@ -31,22 +32,28 @@ package org.apache.juneau.http;
* <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
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java b/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java
index f4fc56b..07412c8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Authorization.java
@@ -14,6 +14,7 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Authorization</l> HTTP request header.
+ *
* <p>
* Authentication credentials for HTTP authentication.
*
@@ -26,6 +27,7 @@ package org.apache.juneau.http;
*
* 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.
@@ -33,12 +35,15 @@ package org.apache.juneau.http;
* <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:
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java b/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java
index 7fee28b..8c46228 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/CacheControl.java
@@ -14,6 +14,7 @@ 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.
*
@@ -30,9 +31,11 @@ package org.apache.juneau.http;
* 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.
@@ -64,11 +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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Connection.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Connection.java b/juneau-core/src/main/java/org/apache/juneau/http/Connection.java
index aed6e82..c005c25 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Connection.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Connection.java
@@ -14,6 +14,7 @@ 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.
*
@@ -27,20 +28,24 @@ package org.apache.juneau.http;
*
* 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.
@@ -51,9 +56,11 @@ 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
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java
index 04ebf3e..76f9552 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentEncoding.java
@@ -14,6 +14,7 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Content-Encoding</l> HTTP response header.
+ *
* <p>
* The type of encoding used on the data.
*
@@ -33,22 +34,27 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java
index 09cb94b..4e6cef5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentLanguage.java
@@ -14,6 +14,7 @@ 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.
*
@@ -30,6 +31,7 @@ package org.apache.juneau.http;
* <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
@@ -38,10 +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
@@ -49,12 +53,14 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java
index 94ca051..a0f3777 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentLength.java
@@ -14,6 +14,7 @@ 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).
*
@@ -30,17 +31,21 @@ package org.apache.juneau.http;
* <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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java
index cf71009..f222af0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentLocation.java
@@ -14,6 +14,7 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Content-Location</l> HTTP response header.
+ *
* <p>
* An alternate location for the returned data.
*
@@ -34,20 +35,25 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java
index 78811e2..dc7ef18 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentRange.java
@@ -14,6 +14,7 @@ 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.
*
@@ -23,6 +24,7 @@ package org.apache.juneau.http;
* </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.
@@ -36,23 +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'>
@@ -65,6 +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
@@ -78,29 +86,35 @@ 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
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java b/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java
index 7c1ec7d..565fe21 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ContentType.java
@@ -18,6 +18,7 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Content-Type</l> HTTP request/response header.
+ *
* <p>
* The MIME type of this content.
*
@@ -33,6 +34,7 @@ import org.apache.juneau.internal.*;
* <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...
@@ -75,6 +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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Date.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Date.java b/juneau-core/src/main/java/org/apache/juneau/http/Date.java
index 310836b..3b5be3e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Date.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Date.java
@@ -14,6 +14,7 @@ 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).
*
@@ -30,31 +31,37 @@ package org.apache.juneau.http;
* <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>
* <li>If the response status code is 100 (Continue) or 101 (Switching Protocols), the response MAY include a Date
- * header field, at the server's option.
+ * header field, at the server's option.
* <li>If the response status code conveys a server error, e.g. 500 (Internal Server Error) or 503 (Service
- * Unavailable), and it is inconvenient or impossible to generate a valid Date.
+ * Unavailable), and it is inconvenient or impossible to generate a valid Date.
* <li>If the server does not have a clock that can provide a reasonable approximation of the current time, its
- * responses MUST NOT include a Date header field.
+ * 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
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/ETag.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/ETag.java b/juneau-core/src/main/java/org/apache/juneau/http/ETag.java
index 0fe1d44..23a41df 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/ETag.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/ETag.java
@@ -14,6 +14,7 @@ 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.
*
@@ -27,9 +28,11 @@ package org.apache.juneau.http;
* 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java b/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java
index 65865c9..e4a3439 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/EntityValidator.java
@@ -14,6 +14,7 @@ package org.apache.juneau.http;
/**
* Represents a validator value.
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/http/Expect.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/Expect.java b/juneau-core/src/main/java/org/apache/juneau/http/Expect.java
index 0a69862..6fa204b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/Expect.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/Expect.java
@@ -14,6 +14,7 @@ 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.
*
@@ -32,24 +33,30 @@ 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.
*
[4/9] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
index 811ca40..2e65494 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java
@@ -134,9 +134,11 @@ 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.
*
@@ -160,9 +162,11 @@ 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.
*
@@ -218,8 +222,9 @@ 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.
+ * @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.
*/
@BeanProperty(swap=JsonTypeOrJsonTypeArraySwap.class)
public Object getType() {
@@ -230,11 +235,12 @@ 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}.
+ * @return
+ * The currently set value, or <jk>null</jk> if the property is not set, or is set as a {@link JsonTypeArray}.
*/
@BeanIgnore
public JsonType getTypeAsJsonType() {
@@ -243,6 +249,7 @@ 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.
*
@@ -256,8 +263,9 @@ 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}.
+ * @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}.
* @return This object (for method chaining).
* @throws BeanRuntimeException If invalid object type passed in.
*/
@@ -292,12 +300,15 @@ 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.
*/
public static class JsonTypeOrJsonTypeArraySwap extends PojoSwap<Object,Object> {
@@ -321,8 +332,8 @@ 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.
+ * @return
+ * The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,Schema> getDefinitions() {
return definitions;
@@ -367,6 +378,8 @@ 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.
@@ -378,8 +391,10 @@ public class Schema {
/**
* Returns the property with the specified name.
- * If <property>resolve</property> is <jk>true</jk>, the property object will automatically be
- * resolved by calling {@link #resolve()}.
+ *
+ * <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>.
@@ -418,6 +433,7 @@ 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.
*
@@ -441,8 +457,9 @@ 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.
+ * @return
+ * The value of the <property>patternProperties</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Map<String,Schema> getPatternProperties() {
return patternProperties;
@@ -467,6 +484,7 @@ 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.
*
@@ -490,8 +508,8 @@ 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.
+ * @return
+ * The value of the <property>dependencies</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Map<String,Schema> getDependencies() {
return dependencies;
@@ -528,8 +546,9 @@ 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.
+ * @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.
*/
@BeanProperty(swap=SchemaOrSchemaArraySwap.class)
public Object getItems() {
@@ -540,6 +559,7 @@ 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.
*
@@ -552,6 +572,7 @@ 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.
*
@@ -564,12 +585,15 @@ 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.
*/
public static class SchemaOrSchemaArraySwap extends PojoSwap<Object,Object> {
@@ -593,8 +617,9 @@ 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}.
+ * @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}.
* @return This object (for method chaining).
* @throws BeanRuntimeException If invalid object type passed in.
*/
@@ -673,8 +698,9 @@ 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.
+ * @return
+ * The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean isExclusiveMaximum() {
return exclusiveMaximum;
@@ -714,8 +740,9 @@ 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.
+ * @return
+ * The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean isExclusiveMinimum() {
return exclusiveMinimum;
@@ -795,9 +822,10 @@ 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.
- * Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it.
+ * @return
+ * The value of the <property>additionalItems</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
+ * Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it.
*/
@BeanProperty(swap=BooleanOrSchemaArraySwap.class)
public Object getAdditionalItems() {
@@ -808,6 +836,7 @@ 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.
@@ -821,6 +850,7 @@ 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.
@@ -835,8 +865,9 @@ 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}.
+ * @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}.
* @return This object (for method chaining).
* @throws BeanRuntimeException If invalid object type passed in.
*/
@@ -860,8 +891,8 @@ 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.
+ * @param additionalItems
+ * The list of items to append to the <property>additionalItems</property> property on this bean.
* @return This object (for method chaining).
*/
public Schema addAdditionalItems(Schema...additionalItems) {
@@ -874,12 +905,15 @@ 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.
*/
public static class BooleanOrSchemaArraySwap extends PojoSwap<Object,Object> {
@@ -943,8 +977,8 @@ 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.
+ * @return
+ * The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Boolean getUniqueItems() {
return uniqueItems;
@@ -964,8 +998,8 @@ 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.
+ * @return
+ * The value of the <property>maxProperties</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMaxProperties() {
return maxProperties;
@@ -985,8 +1019,8 @@ 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.
+ * @return
+ * The value of the <property>minProperties</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public Integer getMinProperties() {
return minProperties;
@@ -1068,9 +1102,10 @@ 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.
- * Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it.
+ * @return
+ * The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it
+ * is not set.
+ * Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it.
*/
@BeanProperty(swap=BooleanOrSchemaSwap.class)
public Object getAdditionalProperties() {
@@ -1081,6 +1116,7 @@ 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.
@@ -1094,6 +1130,7 @@ 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.
@@ -1108,8 +1145,9 @@ 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}.
+ * @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}.
* @return This object (for method chaining).
* @throws BeanRuntimeException If invalid object type passed in.
*/
@@ -1133,12 +1171,15 @@ 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.
*/
public static class BooleanOrSchemaSwap extends PojoSwap<Object,Object> {
@@ -1334,9 +1375,11 @@ 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.
*
@@ -1374,9 +1417,10 @@ 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.
+ * 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>.
*/
@@ -1417,10 +1461,12 @@ public class Schema {
not.setMaster(master);
}
/**
- * 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.
- * 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.
+ * 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>.
*/
@@ -1431,8 +1477,8 @@ public class Schema {
}
/**
- * Associates a schema map with this schema for resolving other schemas identified
- * through <property>$ref</property> properties.
+ * 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/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
index 9338a5c..46e72ff 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java
@@ -22,6 +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'>
@@ -52,10 +53,14 @@ 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.
*
@@ -81,6 +86,7 @@ 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.
*
@@ -100,7 +106,10 @@ 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
@@ -128,7 +137,10 @@ 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>.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
index 1abd7a6..ced1eaf 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java
@@ -14,6 +14,7 @@ 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...
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
index 57ed39e..080cb52 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java
@@ -18,6 +18,7 @@ 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...
*
@@ -44,9 +45,11 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
index 2948d01..b08e4ba 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
@@ -57,6 +57,7 @@ public class Contact extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
+ *
* <p>
* The identifying name of the contact person/organization.
*
@@ -68,6 +69,7 @@ public class Contact extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
+ *
* <p>
* The identifying name of the contact person/organization.
*
@@ -91,6 +93,7 @@ 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.
*
@@ -102,9 +105,11 @@ 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.
*
@@ -128,6 +133,7 @@ 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.
*
@@ -139,6 +145,7 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
index 24f556c..e1485e9 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
@@ -55,11 +55,12 @@ 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.
+ * @return
+ * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getDescription() {
return description;
@@ -67,6 +68,7 @@ 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.
*
@@ -90,11 +92,14 @@ 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.
*
@@ -106,9 +111,11 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
index c6b31c2..fe97c08 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
@@ -79,11 +79,12 @@ 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.
+ * @return
+ * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getDescription() {
return description;
@@ -91,6 +92,7 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
+ *
* <p>
* A short description of the header.
*
@@ -114,6 +116,7 @@ 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 <
@@ -127,6 +130,7 @@ 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
@@ -156,9 +160,11 @@ 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.
+ * 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.
*/
@@ -168,9 +174,11 @@ 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.
+ * 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).
@@ -192,6 +200,7 @@ 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.
@@ -204,6 +213,7 @@ 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.
@@ -228,9 +238,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>.
@@ -238,10 +250,12 @@ 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.
+ * @return
+ * The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getCollectionFormat() {
return collectionFormat;
@@ -249,8 +263,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>
@@ -259,6 +275,7 @@ 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>.
*
@@ -286,6 +303,7 @@ 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.)
@@ -301,6 +319,7 @@ 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.)
@@ -328,6 +347,7 @@ 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>.
@@ -340,6 +360,7 @@ 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>.
@@ -364,6 +385,7 @@ 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>.
@@ -377,6 +399,7 @@ 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>.
@@ -401,6 +424,7 @@ 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>.
@@ -413,6 +437,7 @@ 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>.
@@ -437,6 +462,7 @@ 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>.
@@ -450,6 +476,7 @@ 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>.
@@ -474,6 +501,7 @@ 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>.
@@ -486,6 +514,7 @@ 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>.
@@ -510,6 +539,7 @@ 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>.
@@ -522,6 +552,7 @@ 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>.
@@ -535,7 +566,6 @@ public class HeaderInfo extends SwaggerElement {
}
/**
- *
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -545,6 +575,7 @@ 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>.
@@ -557,6 +588,7 @@ 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>.
@@ -581,6 +613,7 @@ 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>.
@@ -593,6 +626,7 @@ 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>.
@@ -617,6 +651,7 @@ 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>.
@@ -629,6 +664,7 @@ 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>.
@@ -653,6 +689,7 @@ 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>.
@@ -665,6 +702,7 @@ 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>.
@@ -689,6 +727,7 @@ 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>.
@@ -701,6 +740,7 @@ 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>.
@@ -715,12 +755,14 @@ 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.
+ * @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).
*/
public HeaderInfo addEnum(Object..._enum) {
@@ -750,6 +792,7 @@ 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>.
@@ -762,6 +805,7 @@ 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>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
index 4af69c8..d31d8b6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
@@ -65,6 +65,7 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>title</property>.
+ *
* <p>
* Required. The title of the application.
*
@@ -76,6 +77,7 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>title</property>.
+ *
* <p>
* Required. The title of the application.
*
@@ -99,11 +101,12 @@ 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.
+ * @return
+ * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getDescription() {
return description;
@@ -111,6 +114,7 @@ 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.
*
@@ -134,6 +138,7 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>termsOfService</property>.
+ *
* <p>
* The Terms of Service for the API.
*
@@ -146,6 +151,7 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>termsOfService</property>.
+ *
* <p>
* The Terms of Service for the API.
*
@@ -169,6 +175,7 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>contact</property>.
+ *
* <p>
* The contact information for the exposed API.
*
@@ -180,6 +187,7 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>contact</property>.
+ *
* <p>
* The contact information for the exposed API.
*
@@ -203,6 +211,7 @@ public class Info extends SwaggerElement {
/**
* Bean property getter: <property>license</property>.
+ *
* <p>
* The license information for the exposed API.
*
@@ -214,6 +223,7 @@ public class Info extends SwaggerElement {
/**
* Bean property setter: <property>license</property>.
+ *
* <p>
* The license information for the exposed API.
*
@@ -237,6 +247,7 @@ 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).
*
@@ -248,6 +259,7 @@ 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).
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
index 20140fb..b367b87 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
@@ -78,6 +78,7 @@ 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
@@ -91,6 +92,7 @@ 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
@@ -120,6 +122,7 @@ 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.
@@ -132,6 +135,7 @@ 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.
@@ -156,6 +160,7 @@ 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.
@@ -168,6 +173,7 @@ 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.
@@ -192,8 +198,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>
@@ -202,11 +210,13 @@ 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.
+ * @return
+ * The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public String getCollectionFormat() {
return collectionFormat;
@@ -214,8 +224,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>
@@ -224,6 +236,7 @@ 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>.
*
@@ -251,6 +264,7 @@ 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.)
@@ -266,6 +280,7 @@ 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.)
@@ -293,6 +308,7 @@ 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>.
@@ -305,6 +321,7 @@ 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>.
@@ -329,12 +346,14 @@ 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.
+ * @return
+ * The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMaximum() {
return exclusiveMaximum;
@@ -342,6 +361,7 @@ 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>.
@@ -366,6 +386,7 @@ 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>.
@@ -378,6 +399,7 @@ 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>.
@@ -402,6 +424,7 @@ 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>.
@@ -415,6 +438,7 @@ 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>.
@@ -439,6 +463,7 @@ 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>.
@@ -451,6 +476,7 @@ 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>.
@@ -475,6 +501,7 @@ 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>.
@@ -487,6 +514,7 @@ 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>.
@@ -511,6 +539,7 @@ 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>.
@@ -523,6 +552,7 @@ 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>.
@@ -547,6 +577,7 @@ 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>.
@@ -559,6 +590,7 @@ 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>.
@@ -583,6 +615,7 @@ 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>.
@@ -595,6 +628,7 @@ 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>.
@@ -619,6 +653,7 @@ 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>.
@@ -632,6 +667,7 @@ 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>.
@@ -656,6 +692,7 @@ 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>.
@@ -668,6 +705,7 @@ 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>.
@@ -682,12 +720,14 @@ 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.
+ * @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).
*/
public Items addEnum(Object..._enum) {
@@ -708,8 +748,9 @@ 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.
+ * @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).
*/
public Items _enum(Object..._enum) {
@@ -718,6 +759,7 @@ 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>.
@@ -730,6 +772,7 @@ 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>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
index eb28691..3b837ac 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
@@ -55,6 +55,7 @@ public class License extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
+ *
* <p>
* Required. The license name used for the API.
*
@@ -66,6 +67,7 @@ public class License extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
+ *
* <p>
* Required. The license name used for the API.
*
@@ -89,11 +91,14 @@ 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.
*
@@ -105,9 +110,11 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
index a3901d9..4766b40 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
@@ -112,6 +112,7 @@ 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.
@@ -124,6 +125,7 @@ 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.
@@ -138,6 +140,7 @@ 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.
@@ -151,12 +154,14 @@ 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>.
+ * @param tags
+ * The values to add for the <property>tags</property> property on this bean.
+ * Ignored if <jk>null</jk>.
* @return This object (for method chaining).
*/
public Operation addTags(Collection<String> tags) {
@@ -190,6 +195,7 @@ 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.
@@ -202,6 +208,7 @@ 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.
@@ -226,13 +233,14 @@ 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.
+ * @return
+ * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getDescription() {
return description;
@@ -240,6 +248,7 @@ 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
@@ -265,11 +274,12 @@ 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.
+ * @return
+ * The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public ExternalDocumentation getExternalDocs() {
return externalDocs;
@@ -277,6 +287,7 @@ public class Operation extends SwaggerElement {
/**
* Bean property setter: <property>externalDocs</property>.
+ *
* <p>
* Additional external documentation for this operation.
*
@@ -300,13 +311,14 @@ 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.
+ * @return
+ * The value of the <property>operationId</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getOperationId() {
return operationId;
@@ -314,6 +326,7 @@ 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
@@ -339,12 +352,12 @@ 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>.
+ * 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.
*/
@@ -354,12 +367,12 @@ 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>.
+ * 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).
@@ -371,12 +384,12 @@ 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>.
+ * 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).
@@ -387,12 +400,12 @@ 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>.
+ * 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).
@@ -428,12 +441,12 @@ 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>.
+ * 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.
*/
@@ -443,12 +456,12 @@ 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>.
+ * 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).
@@ -460,12 +473,12 @@ 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>.
+ * 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).
@@ -481,12 +494,12 @@ 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>.
+ * 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).
@@ -522,6 +535,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"
@@ -529,10 +543,8 @@ public class Operation extends SwaggerElement {
* but can never remove it.
* The list MUST NOT include duplicated parameters.
* A unique parameter is defined by a combination of a <code>name</code> and <code>location</code>.
- * 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>.
+ * 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.
@@ -543,6 +555,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"
@@ -566,6 +579,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"
@@ -611,6 +625,7 @@ 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.
*
@@ -622,6 +637,7 @@ 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.
*
@@ -635,6 +651,7 @@ 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.
*
@@ -672,6 +689,7 @@ 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>.
@@ -685,6 +703,7 @@ 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>.
@@ -700,6 +719,7 @@ 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>.
@@ -714,6 +734,7 @@ 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>.
@@ -741,6 +762,7 @@ 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.
@@ -754,6 +776,7 @@ 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.
@@ -779,6 +802,7 @@ 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
@@ -794,6 +818,7 @@ 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
@@ -811,6 +836,7 @@ 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
@@ -832,8 +858,9 @@ 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 between the security requirements).
+ * @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).
* @return This object (for method chaining).
*/
public Operation security(String scheme, String...alternatives) {
[7/9] incubator-juneau git commit: Clean up javadocs.
Posted by ja...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java
index 78b4d6d..d71ba6f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java
@@ -46,15 +46,19 @@ 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.
* For example, if a bean property is of type <code>Object</code>, then the serializer will add the name to the
- * output so that the class can be determined during parsing.
+ * output so that the class can be determined during parsing.
* It is also used to specify element names in XML.
+ *
* <p>
* The name is used in combination with the bean dictionary defined through {@link BeanProperty#beanDictionary()} or
- * {@link BeanContext#BEAN_beanDictionary}. Together, they make up a simple name/value mapping of names to classes.
- * Names do not need to be universally unique. However, they must be unique within a dictionary.
+ * {@link BeanContext#BEAN_beanDictionary}.
+ * Together, they make up a simple name/value mapping of names to classes.
+ * Names do not need to be universally unique.
+ * However, they must be unique within a dictionary.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -71,9 +75,9 @@ public @interface Bean {
* <ja>@Bean</ja>(typeName=<js>"baz"</js>)
* <jk>public class</jk> Baz {}
* </p>
+ *
* <p>
* When serialized as XML, the bean is rendered as:
- * </p>
* <p class='bcode'>
* <xt><foo></xt>
* <xt><x></xt>
@@ -82,9 +86,9 @@ public @interface Bean {
* <xt></x></xt>
* <xt></foo></xt>
* </p>
+ *
* <p>
* When serialized as JSON, <js>'n'</js> attributes would be added when needed to infer the type during parsing:
- * </p>
* <p class='bcode'>
* {
* x: [
@@ -99,9 +103,11 @@ 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 designated above.
* Typically, you'll define this on an interface class so that it can apply to all subclasses.
+ *
* <p class='bcode'>
* <ja>@Bean</ja>(typePropertyName=<js>"mytype"</js>, beanDictionary={MyClass1.<jk>class</jk>,MyClass2.<jk>class</jk>})
* <jk>public interface</jk> MyInterface {...}
@@ -117,6 +123,7 @@ public @interface Bean {
* <jc>// Produces "[{mytype:'C1',...},{mytype:'C2',...}]"</jc>
* String json = JsonSerializer.<jsf>DEFAULT_LAX</jsf>.serialize(x);
* </p>
+ *
* <p>
* This is similar in concept to the {@link BeanContext#BEAN_beanTypePropertyName} setting except this annotation
* applies only to the annotated class and subclasses whereas the bean context property applies globally on
@@ -135,9 +142,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.
+ *
* <p>
* This annotation is an alternative to using the {@link BeanFilter} class with an implemented
* {@link BeanFilter#getProperties()} method.
@@ -155,24 +164,27 @@ 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.
- * Otherwise, the natural order of the bean properties is used which is dependent on the
- * JVM vendor.
+ * Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
* On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.
* On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs).
+ *
* <p>
* This property is disabled by default so that IBM JVM users don't have to use {@link Bean @Bean} annotations
* to force bean properties to be in a particular order and can just alter the order of the fields/methods
* in the Java file.
+ *
* <p>
- * This annotation is equivalent to using the {@link BeanContext#BEAN_sortProperties} property, but
- * applied to individual classes instead of globally at the serializer or parser level.
+ * This annotation is equivalent to using the {@link BeanContext#BEAN_sortProperties} property, but applied to
+ * individual classes instead of globally at the serializer or parser level.
*/
boolean sort() default false;
/**
* Specifies a list of properties that should be excluded from {@link BeanMap#entrySet()}.
+ *
* <p>
* This annotation is an alternative to using the {@link BeanFilter} class with an implemented
* {@link BeanFilter#getExcludeProperties()} method.
@@ -190,10 +202,12 @@ 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.
* For example, the {@link PropertyNamerDLC} will convert property names to dashed-lowercase, and these will be used
* as attribute names in JSON, and element names in XML.
+ *
* <p>
* This annotation is an alternative to using the {@link BeanFilter} class with an implemented
* {@link BeanFilter#getPropertyNamer()} method.
@@ -211,9 +225,11 @@ 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>)
@@ -231,9 +247,11 @@ public @interface Bean {
* String r = s.serialize(a1);
* <jsm>assertEquals</jsm>(<js>"{f0:'f0'}"</js>, r); // Note f1 is not serialized.
* </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.
+ * or can be set individually on the child classes.
+ *
* <p>
* This annotation is an alternative to using the {@link BeanFilter} class with an implemented
* {@link BeanFilter#getInterfaceClass()} method.
@@ -242,9 +260,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>.
@@ -267,10 +287,12 @@ public @interface Bean {
/**
- * The list of classes that make up the bean dictionary for all properties of this bean
- * or for subclasses of this bean.
+ * The list of classes that make up the bean dictionary for all properties of this bean or for subclasses of this
+ * bean.
+ *
* <p>
* This is a shorthand for setting the {@link BeanProperty#beanDictionary()} on all properties of the bean.
+ *
* <p>
* This list can consist of the following class types:
* <ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
index fb6a133..e4bf51c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
@@ -21,11 +21,13 @@ 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>
* The definition of a read-only bean is a bean with properties with only getters, like shown below...
* <p class='bcode'>
@@ -55,17 +57,21 @@ import org.apache.juneau.*;
* String name = p.getName(); <jc>// "John Smith"</jc>
* <jk>int</jk> age = p.getAge(); <jc>// 45</jc>
* </p>
+ *
* <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.
+ * Because of this additional caching step, parsing into read-only beans tends to be slower and use more memory than
+ * parsing into beans with writable properties.
+ *
* <p>
* Attempting to call {@link BeanMap#put(String,Object)} on a read-only property after calling {@link BeanMap#getBean()}
* will result in a {@link BeanRuntimeException} being thrown.
* Multiple calls to {@link BeanMap#getBean()} will return the same bean instance.
+ *
* <p>
* Beans can be defined with a combination of read-only and read-write properties.
*/
@@ -77,6 +83,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/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
index c7c1d30..efaa145 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
@@ -19,12 +19,15 @@ 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.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/BeanParam.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanParam.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanParam.java
index 65609bd..47137fe 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanParam.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanParam.java
@@ -14,7 +14,7 @@ package org.apache.juneau.annotation;
/**
- * TODO
+ * Future support for defining bean properties on constructor args.
*/
public @interface BeanParam {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java
index 46a8d19..764b5c2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java
@@ -60,21 +60,24 @@ 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.
+ * 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
* properties not otherwise defined.
* 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'>
@@ -113,9 +116,10 @@ public @interface BeanProperty {
* }
* }
* </p>
- * <p>
- * Similar rules apply for value types and swaps. The property values optionally can be any serializable type or
- * use swaps.
+ *
+ *<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 {
@@ -135,7 +139,7 @@ public @interface BeanProperty {
* }
* }
* </p>
- * <p>
+ *
* <ul class='doctree'>
* <li class='info'>
* Note that if you're not interested in these additional properties, you can also use the
@@ -147,9 +151,10 @@ public @interface BeanProperty {
/**
* A synonym for {@link #name()}.
+ *
* <p>
* The following annotations are equivalent:
- * <p>
+ *
* <p class='bcode'>
* <ja>@BeanProperty</ja>(name=<js>"foo"</js>)
*
@@ -160,11 +165,13 @@ 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.
*
@@ -199,8 +206,10 @@ public @interface BeanProperty {
/**
* Associates a {@link PojoSwap} or {@link SurrogateSwap} with this bean property that will swap the value object
* with another object during serialization and parsing.
+ *
* <p>
* This annotation supersedes any swaps associated with the bean property type class itself.
+ *
* <p>
* Typically used for rendering {@link Date Dates} and {@link Calendar Calendars} as a particular string format.
*
@@ -218,6 +227,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'>
@@ -249,10 +259,12 @@ public @interface BeanProperty {
/**
* The list of classes that make up the bean dictionary for this bean property.
+ *
* <p>
* The dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred
* through reflection.
* The names are defined through the {@link Bean#typeName()} annotation defined on the bean class.
+ *
* <p>
* This list can consist of the following class types:
* <ul>
@@ -267,8 +279,10 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java
index 32adb2d..e4051ef 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java
@@ -25,6 +25,7 @@ import org.apache.juneau.parser.*;
* <h5 class='section'>Description:</h5>
* <p>
* Provides a way to define the contents of {@link Parser#getMediaTypes()} through an annotation.
+ *
* <p>
* The {@link Parser#getMediaTypes()} default implementation gathers the media types by looking for this annotation.
* It should be noted that this annotation is optional and that the {@link Parser#getMediaTypes()} method can be
@@ -37,9 +38,11 @@ import org.apache.juneau.parser.*;
* <ja>@Consumes</ja>(<js>"application/json,text/json"</js>)
* <jk>public class</jk> JsonParser <jk>extends</jk> ReaderParser {...}
* </p>
+ *
* <p>
* The media types can also be <code>media-range</code> values per
- * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC2616/14.1</a>.
+ * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC2616/14.1</a>.
+ *
* <p class='bcode'>
* <jc>// Consumes any text</jc>
* <ja>@Consumes</ja>(<js>"text\/*"</js>)
@@ -58,6 +61,7 @@ public @interface Consumes {
/**
* A comma-delimited list of media types that the parser can handle.
+ *
* <p>
* Can contain meta-characters per the <code>media-type</code> specification of
* <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC2616/14.1</a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java
index bce8d94..ac6d3b2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java
@@ -20,16 +20,18 @@ import java.lang.annotation.*;
import org.apache.juneau.ini.*;
/**
- * Identifies a setter as a method for setting the name of a POJO as it's known by
- * its parent object.
+ * Identifies a setter as a method for setting the name of a POJO as it's known by its parent object.
+ *
* <p>
- * For example, the {@link Section} class must know the name it's known by it's parent
- * {@link ConfigFileImpl} class, so parsers will call this method with the section name
+ * For example, the {@link Section} class must know the name it's known by it's parent {@link ConfigFileImpl} class,
+ * so parsers will call this method with the section name
* using the {@link Section#setName(String)} method.
* <p>
* A commonly-used case is when you're parsing a JSON map containing beans where one of the bean properties is the key
* used in the map.
- * <br>For example:
+ *
+ * <p>
+ * For example:
* <p class='bcode'>
* {
* id1: {name: <js>'John Smith'</js>, sex:<js>'M'</js>},
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java
index 6df9bb9..a6f24af 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java
@@ -21,10 +21,12 @@ import org.apache.juneau.ini.*;
/**
* 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.
* For example, the {@link Section} class cannot exist outside the scope of a parent {@link ConfigFileImpl} class, so
* parsers will add a reference to the config file using the {@link Section#setParent(ConfigFileImpl)} method.
+ *
* <p>
* A commonly-used case is when you're parsing beans, and a child bean has a reference to a parent bean.
* <p class='bcode'>
@@ -38,7 +40,6 @@ import org.apache.juneau.ini.*;
* <jk>public char</jk> <jf>sex</jf>;
* }
* </p>
- * <p>
*
* <h5 class='section'>Notes:</h5>
* <ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java
index 6e41c31..0823e6d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java
@@ -72,6 +72,7 @@ public @interface Pojo {
* <jsm>assertEquals</jsm>(<js>"bar"</js>, b.<jf>f1</jf>);
* }
* </p>
+ *
* <p>
* Note that using this annotation is functionally equivalent to adding swaps to the serializers and parsers:
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
index aa29dc0..cf705e7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
@@ -25,6 +25,7 @@ import org.apache.juneau.serializer.*;
* <h5 class='section'>Description:</h5>
* <p>
* Provides a way to define the contents of {@link Serializer#getMediaTypes()} through an annotation.
+ *
* <p>
* The {@link Serializer#getMediaTypes()} default implementation gathers the media types by looking for this annotation.
* <br>It should be noted that this annotation is optional and that the {@link Serializer#getMediaTypes()} method can
@@ -37,6 +38,7 @@ import org.apache.juneau.serializer.*;
* <ja>@Produces</ja>(<js>"application/json,text/json"</js>)
* <jk>public class</jk> JsonSerializer <jk>extends</jk> WriterSerializer {...}
* </p>
+ *
* <p>
* The media types can also be <code>media-range</code> values per
* <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC2616/14.1</a>.
@@ -61,6 +63,7 @@ public @interface Produces {
/**
* A comma-delimited list of the media types that the serializer can handle.
+ *
* <p>
* Can contain meta-characters per the <code>media-type</code> specification of
* <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">RFC2616/14.1</a>
@@ -71,6 +74,7 @@ public @interface Produces {
/**
* The content type that this serializer produces.
+ *
* <p>
* Can be used to override the <code>Content-Type</code> response type if the media types are
* <code>media-ranges</code> with meta-characters, or the <code>Content-Type</code> differs from the media type for some reason.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/ThreadSafe.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/ThreadSafe.java b/juneau-core/src/main/java/org/apache/juneau/annotation/ThreadSafe.java
index b992753..fdda089 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/ThreadSafe.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/ThreadSafe.java
@@ -18,6 +18,7 @@ import java.lang.annotation.*;
/**
* Identifies a class as being thread-safe.
+ *
* <p>
* Used for documentation purposes only.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java b/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java
index 24dbec9..192664b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java
@@ -23,20 +23,25 @@ import org.apache.juneau.serializer.*;
/**
* Used to identify a class or bean property as a URI.
+ *
* <p>
* By default, instances of {@link URL} and {@link URI} are considered URIs during serialization, and are handled
* differently depending on the serializer (e.g. <code>HtmlSerializer</code> creates a hyperlink,
* <code>RdfXmlSerializer</code> creates an <code>rdf:resource</code> object, etc...).
+ *
* <p>
* This annotation allows you to identify other classes that return URIs via <code>toString()</code> as URI objects.
+ *
* <p>
* URIs are automatically resolved to absolute or root-relative form based on the serializer
* {@link SerializerContext#SERIALIZER_uriResolution} and {@link SerializerContext#SERIALIZER_uriRelativity}
* configuration settings, and the URI context defined by the {@link UriContext} that's part of the serializer
* session.
+ *
* <p>
* Refer to the {@link UriResolver} class for information about the types of URIs that can be resolved during
* serialization.
+ *
* <p>
* This annotation can be applied to classes, interfaces, or bean property methods for fields.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java
index 926c263..93c5f57 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java
@@ -17,9 +17,11 @@ import org.apache.juneau.parser.*;
/**
* Configurable properties on the {@link CsvParser} class.
+ *
* <p>
* Context properties are set by calling {@link PropertyStore#setProperty(String, Object)} on the property store
* passed into the constructor.
+ *
* <p>
* See {@link PropertyStore} for more information about context properties.
*
@@ -39,6 +41,7 @@ public final class CsvParserContext extends ParserContext {
/**
* Constructor.
+ *
* <p>
* Typically only called from {@link PropertyStore#getContext(Class)}.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserSession.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserSession.java
index 548cbd2..97a24aa 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserSession.java
@@ -22,6 +22,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 meant to be discarded after one-time use.
*/
@@ -32,24 +33,29 @@ public final class CsvParserSession 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.
- * @param input The input. Can be any of the following types:
- * <ul>
- * <li><jk>null</jk>
- * <li>{@link Reader}
- * <li>{@link CharSequence}
- * <li>{@link InputStream} containing UTF-8 encoded text.
- * <li>{@link File} containing system encoded text.
- * </ul>
- * @param op The override properties.
- * These override any context properties defined in the context.
+ * @param ctx
+ * The context creating this session object.
+ * The context contains all the configuration settings for this object.
+ * @param input
+ * The input. Can be any of the following types:
+ * <ul>
+ * <li><jk>null</jk>
+ * <li>{@link Reader}
+ * <li>{@link CharSequence}
+ * <li>{@link InputStream} containing UTF-8 encoded text.
+ * <li>{@link File} containing system encoded text.
+ * </ul>
+ * @param op
+ * The override properties.
+ * These override any context properties defined in the context.
* @param javaMethod The java method that called this parser, usually the method in a REST servlet.
* @param outer The outer object for instantiating top-level non-static inner classes.
- * @param locale The session locale.
- * If <jk>null</jk>, then the locale defined on the context is used.
- * @param timeZone The session timezone.
- * If <jk>null</jk>, then the timezone defined on the context is used.
+ * @param locale
+ * The session locale.
+ * If <jk>null</jk>, then the locale defined on the context is used.
+ * @param timeZone
+ * The session timezone.
+ * If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
*/
public CsvParserSession(CsvParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {
@@ -72,6 +78,7 @@ public final class CsvParserSession extends ParserSession {
/**
* 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java
index fa84e3e..3c8c77b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java
@@ -17,9 +17,11 @@ import org.apache.juneau.serializer.*;
/**
* Configurable properties on the {@link CsvSerializer} class.
+ *
* <p>
* Context properties are set by calling {@link PropertyStore#setProperty(String, Object)} on the property store
* passed into the constructor.
+ *
* <p>
* See {@link PropertyStore} for more information about context properties.
*
@@ -39,6 +41,7 @@ public final class CsvSerializerContext extends SerializerContext {
/**
* Constructor.
+ *
* <p>
* Typically only called from {@link PropertyStore#getContext(Class)}.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
index cde39cc..c9fd758 100644
--- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
@@ -21,6 +21,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 meant to be discarded after one-time use.
*/
@@ -29,16 +30,20 @@ public final class CsvSerializerSession 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.
+ * @param ctx
+ * The context creating this session object.
+ * The context contains all the configuration settings for this object.
* @param output The output object.
- * @param op The override properties.
- * These override any context properties defined in the context.
+ * @param op
+ * The override properties.
+ * These override any context properties defined in the context.
* @param javaMethod The java method that called this serializer, usually the method in a REST servlet.
- * @param locale The session locale.
- * If <jk>null</jk>, then the locale defined on the context is used.
- * @param timeZone The session timezone.
- * If <jk>null</jk>, then the timezone defined on the context is used.
+ * @param locale
+ * The session locale.
+ * If <jk>null</jk>, then the locale defined on the context is used.
+ * @param timeZone
+ * The session timezone.
+ * If <jk>null</jk>, then the timezone defined on the context is used.
* @param mediaType The session media type (e.g. <js>"application/json"</js>).
* @param uriContext The URI context.
* Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/Link.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/Link.java b/juneau-core/src/main/java/org/apache/juneau/dto/Link.java
index 96d025f..6677dc0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/Link.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/Link.java
@@ -23,13 +23,16 @@ 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.
- * <br>All other serializers simply convert it to a simple bean.
+ * All other serializers simply convert it to a simple bean.
*/
@HtmlLink(nameProperty = "name", hrefProperty = "href")
public class Link implements Comparable<Link> {
@@ -57,6 +60,8 @@ public class Link implements Comparable<Link> {
/**
* 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.
@@ -78,6 +83,8 @@ public class Link implements Comparable<Link> {
/**
* 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.
@@ -99,6 +106,8 @@ public class Link implements Comparable<Link> {
/**
* Bean property setter: <property>href</property>.
+ *
+ * <p>
* Same as {@link #setHref(String)} except allows for {@link MessageFormat} style arguments.
*
* @param href The new href.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/ResultSetList.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/ResultSetList.java b/juneau-core/src/main/java/org/apache/juneau/dto/ResultSetList.java
index 4f99c0d..8fa21ff 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/ResultSetList.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/ResultSetList.java
@@ -21,7 +21,8 @@ import org.apache.juneau.internal.*;
/**
* Transforms an SQL {@link ResultSet ResultSet} into a list of maps.
- * <p>
+ * <
+ * p>
* Loads the entire result set into an in-memory data structure, and then closes the result set object.
*/
public final class ResultSetList extends LinkedList<Map<String,Object>> {
@@ -75,6 +76,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
index 0850725..87c80e5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java
@@ -19,6 +19,7 @@ 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'>
@@ -146,9 +147,11 @@ 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.
*
@@ -184,9 +187,11 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java
index 2922276..4f0e583 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java
@@ -78,7 +78,6 @@ public class Category extends Common {
//--------------------------------------------------------------------------------
/**
- *
* @return The category term.
*/
@Xml(format=ATTR)
@@ -110,9 +109,11 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java
index 86c28aa..544b8f2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java
@@ -71,9 +71,11 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java
index 5381c40..e90c674 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java
@@ -116,9 +116,11 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java
index 0e00ebf..4c5ca0b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java
@@ -21,6 +21,7 @@ import org.apache.juneau.xml.annotation.*;
/**
* Top-level ATOM feed object.
+ *
* <p>
* Represents an <code>atomFeed</code> construct in the RFC4287 specification.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java
index 983d299..2abcc0d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java
@@ -88,9 +88,11 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java
index e146669..e16ae23 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java
@@ -57,9 +57,11 @@ 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.
*
@@ -89,9 +91,11 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java
index c3d7e4c..695f1c5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java
@@ -137,6 +137,7 @@ public class Link extends Common {
/**
* Sets the content type of the target of this link.
+ *
* <p>
* Must be one of the following:
* <ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java
index ac1fdc0..97e045e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java
@@ -57,9 +57,11 @@ 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.
*
@@ -89,9 +91,11 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java
index 9a30649..f557a97 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java
@@ -106,9 +106,11 @@ 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.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java
index fc1dd9f..572e08a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java
@@ -91,6 +91,7 @@ public class Text extends Common {
/**
* Sets the content type of this content.
+ *
* <p>
* Must be one of the following:
* <ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java
index 5862668..a86ba4d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java
@@ -18,6 +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'>
@@ -60,12 +61,13 @@ 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.
+ * 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.
* <p class='bcode'>
* Column c = <jk>new</jk> Column(<js>"numAddresses"</js>, <js>"xs:int"</js>)
* .addPojoSwaps(
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
index 739001b..dd3f112 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
@@ -20,6 +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'>
@@ -45,6 +46,7 @@ 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.
*
@@ -88,8 +90,9 @@ public class DataSet {
* Constructor.
*
* @param columns The meta-data that represents the columns in the dataset.
- * @param o The POJO being serialized to Cognos.
- * Must be an array/collection of beans/maps.
+ * @param o
+ * The POJO being serialized to Cognos.
+ * Must be an array/collection of beans/maps.
* @param session The bean session used to convert POJOs to strings.
* @throws Exception An error occurred trying to serialize the POJO.
*/
@@ -124,6 +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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java
index 843dfb6..242d7b8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java
@@ -20,8 +20,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -40,9 +40,13 @@ 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}.
+ *
+ * @param download
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final A download(Object download) {
@@ -52,15 +56,20 @@ 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}.
+ * @param href
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final A href(Object href) {
@@ -70,6 +79,8 @@ 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.
@@ -82,6 +93,8 @@ 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.
@@ -94,6 +107,8 @@ 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.
@@ -106,6 +121,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java
index 510df45..0e2c075 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-abbr-element"><abbr></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java
index 91856d3..cd60484 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/sections.html#the-address-element"><address></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java
index 7b69b4e..97a4463 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -39,6 +39,8 @@ 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.
@@ -52,6 +54,8 @@ 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.
@@ -64,10 +68,13 @@ 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}.
+ * @param download
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Area download(Object download) {
@@ -77,15 +84,20 @@ 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}.
+ * @param href
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final Area href(Object href) {
@@ -95,6 +107,8 @@ 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.
@@ -107,6 +121,8 @@ 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.
@@ -119,6 +135,8 @@ 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.
@@ -131,6 +149,8 @@ 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.
@@ -143,6 +163,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java
index 2953d0d..519e4b0 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/sections.html#the-article-element"><article></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java
index c14e239..ca5cf08 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/sections.html#the-aside-element"><aside></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java
index 7ff0379..1acd391 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -40,10 +40,13 @@ 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}.
+ * @param autoplay
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Audio autoplay(Object autoplay) {
@@ -54,10 +57,13 @@ 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}.
+ * @param controls
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Audio controls(Object controls) {
@@ -66,8 +72,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.
+ * <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.
@@ -80,10 +88,13 @@ 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}.
+ * @param loop
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Audio loop(Object loop) {
@@ -94,6 +105,8 @@ 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.
@@ -107,10 +120,13 @@ 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}.
+ * @param muted
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Audio muted(Object muted) {
@@ -121,6 +137,8 @@ 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.
@@ -133,15 +151,20 @@ 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}.
+ * @param src
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final Audio src(Object src) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java
index 1712bfa..d4beaba 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-b-element"><b></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java
index 16cf772..253be94 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -39,15 +39,20 @@ 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}.
+ * @param href
+ * The new value for this attribute.
+ * Typically a {@link URL} or {@link String}.
* @return This object (for method chaining).
*/
public final Base href(Object href) {
@@ -58,6 +63,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java
index a9c9b06..bba51e5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-bdi-element"><bdi></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java
index 4e21958..b8c6acf 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-bdo-element"><bdo></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
index 57fd433..bcaa2db 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/grouping-content.html#the-blockquote-element"><blockquote></a> element.
+ * 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'>
@@ -36,6 +36,8 @@ 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java
index 8fbd2a4..8bd8b3f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/sections.html#the-body-element"><body></a> element.
+ * 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'>
@@ -46,8 +46,8 @@ public class Body extends HtmlElementMixed {
}
/**
- * <a class="doclink"
- * href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onbeforeunload">onbeforeunload</a> attribute.
+ * <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).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java
index f2c39c9..e7eba5e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-br-element"><br></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java
index fa9a75d..f2afd66 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java
@@ -19,8 +19,8 @@ import org.apache.juneau.*;
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.
+ * 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'>
@@ -39,10 +39,13 @@ 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}.
+ * @param autofocus
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Button autofocus(Object autofocus) {
@@ -52,10 +55,13 @@ 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}.
+ * @param disabled
+ * The new value for this attribute.
+ * Typically a {@link Boolean} or {@link String}.
* @return This object (for method chaining).
*/
public final Button disabled(Object disabled) {
@@ -65,6 +71,8 @@ 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.
@@ -77,10 +85,14 @@ 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.
*
@@ -94,6 +106,8 @@ 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.
@@ -106,6 +120,8 @@ 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.
@@ -119,6 +135,8 @@ 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.
@@ -131,6 +149,8 @@ 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.
@@ -143,6 +163,8 @@ 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.
@@ -155,6 +177,8 @@ 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.
@@ -167,6 +191,8 @@ 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.
@@ -179,10 +205,13 @@ 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}.
+ * @param value
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Button value(Object value) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java
index eb95e4a..4881e63 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/scripting-1.html#the-canvas-element"><canvas></a> element.
+ * 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'>
@@ -35,10 +35,13 @@ 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}.
+ * @param height
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Canvas height(Object height) {
@@ -48,10 +51,13 @@ 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}.
+ * @param width
+ * The new value for this attribute.
+ * Typically a {@link Number} or {@link String}.
* @return This object (for method chaining).
*/
public final Canvas width(Object width) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java
index a0da244..518b281 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/tabular-data.html#the-caption-element"><caption></a> element.
+ * 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'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java
index f6a9b77..4e745ea 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java
@@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5;
import org.apache.juneau.annotation.*;
/**
- * DTO for an HTML <a class="doclink"
- * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-cite-element"><cite></a> element.
+ * 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'>