You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2018/01/14 16:02:45 UTC
[17/32] juneau git commit: Javadoc updates.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Referer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Referer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Referer.java
index f7ba76f..884f647 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Referer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Referer.java
@@ -14,19 +14,19 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Referer</l> HTTP request header.
- *
+ *
* <p>
* This is the address of the previous web page from which a link to the currently requested page was followed.
* (The word “referrer” has been misspelled in the RFC as well as in most implementations to the point that it has
* become standard usage and is considered correct terminology)
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Referer: http://en.wikipedia.org/wiki/Main_Page
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Referer[sic] request-header field allows the client to specify, for the server's benefit, the address (URI) of
* the resource from which the Request-URI was obtained (the "referrer", although the header field is misspelled.)
* The Referer request-header allows a server to generate lists of back-links to resources for interest, logging,
@@ -34,21 +34,21 @@ package org.apache.juneau.http;
* It also allows obsolete or mistyped links to be traced for maintenance.
* The Referer field MUST NOT be sent if the Request-URI was obtained from a source that does not have its own URI,
* such as input from the user keyboard.
- *
+ *
* <p class='bcode'>
* Referer = "Referer" ":" ( absoluteURI | relativeURI )
* </p>
- *
+ *
* <p>
* Example:
* <p class='bcode'>
* Referer: http://www.w3.org/hypertext/DataSources/Overview.html
* </p>
- *
+ *
* <p>
* If the field value is a relative URI, it SHOULD be interpreted relative to the Request-URI.
* The URI MUST NOT include a fragment. See section 15.1.3 for security considerations.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -62,7 +62,7 @@ public final class Referer extends HeaderUri {
/**
* Returns a parsed <code>Referer</code> header.
- *
+ *
* @param value The <code>Referer</code> header string.
* @return The parsed <code>Referer</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/RetryAfter.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/RetryAfter.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/RetryAfter.java
index d5278e8..7e5d372 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/RetryAfter.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/RetryAfter.java
@@ -18,40 +18,40 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>Retry-After</l> HTTP response header.
- *
+ *
* <p>
* If an entity is temporarily unavailable, this instructs the client to try again later.
* Value could be a specified period of time (in seconds) or a HTTP-date.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Retry-After: 120
* Retry-After: Fri, 07 Nov 2014 23:59:59 GMT
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Retry-After response-header field can be used with a 503 (Service Unavailable) response to indicate how long the
* service is expected to be unavailable to the requesting client.
* This field MAY also be used with any 3xx (Redirection) response to indicate the minimum time the user-agent is asked
* wait before issuing the redirected request.
* The value of this field can be either an HTTP-date or an integer number of seconds (in decimal) after the time of the
* response.
- *
+ *
* <p class='bcode'>
* Retry-After = "Retry-After" ":" ( HTTP-date | delta-seconds )
* </p>
- *
+ *
* <p>
* Two examples of its use are
* <p class='bcode'>
* Retry-After: Fri, 31 Dec 1999 23:59:59 GMT
* Retry-After: 120
* </p>
- *
+ *
* <p>
* In the latter example, the delay is 2 minutes.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -65,7 +65,7 @@ public final class RetryAfter extends HeaderString {
/**
* Returns a parsed <code>Retry-After</code> header.
- *
+ *
* @param value The <code>Retry-After</code> header string.
* @return The parsed <code>Retry-After</code> header, or <jk>null</jk> if the string was null.
*/
@@ -81,7 +81,7 @@ public final class RetryAfter extends HeaderString {
/**
* Returns this header value as a {@link java.util.Date} object.
- *
+ *
* @return This header value as a {@link java.util.Date} object, or <jk>null</jk> if the value is not a date.
*/
public java.util.Date asDate() {
@@ -93,7 +93,7 @@ public final class RetryAfter extends HeaderString {
/**
* Returns this header value as an integer.
- *
+ *
* @return This header value as a integer, or <code>-1</code> if the value is not an integer.
*/
public int asInt() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Server.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Server.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Server.java
index e98a3a0..9e51822 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Server.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Server.java
@@ -14,42 +14,42 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Server</l> HTTP response header.
- *
+ *
* <p>
* A name for the server.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Server: Apache/2.4.1 (Unix)
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Server response-header field contains information about the software used by the origin server to handle the
* request.
* The field can contain multiple product tokens (section 3.8) and comments identifying the server and any significant
* sub-products.
* The product tokens are listed in order of their significance for identifying the application.
- *
+ *
* <p class='bcode'>
* Server = "Server" ":" 1*( product | comment )
* </p>
- *
+ *
* <p>
* Example:
* <p class='bcode'>
* Server: CERN/3.0 libwww/2.17
* </p>
- *
+ *
* <p>
* If the response is being forwarded through a proxy, the proxy application MUST NOT modify the Server response-header.
* Instead, it SHOULD include a Via field (as described in section 14.45).
- *
+ *
* <p>
* Note: Revealing the specific software version of the server might allow the server machine to become more vulnerable
* to attacks against software that is known to contain security holes.
* Server implementors are encouraged to make this field a configurable option.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -63,7 +63,7 @@ public final class Server extends HeaderString {
/**
* Returns a parsed <code>Server</code> header.
- *
+ *
* @param value The <code>Server</code> header string.
* @return The parsed <code>Server</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/StringRange.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/StringRange.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/StringRange.java
index 8a5a3fb..09f062e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/StringRange.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/StringRange.java
@@ -21,14 +21,14 @@ import org.apache.juneau.internal.*;
/**
* Represents a single value in a comma-delimited header value that optionally contains a quality metric for
* comparison and extension parameters.
- *
+ *
* <p>
* Similar in concept to {@link MediaTypeRange} except instead of media types (e.g. <js>"text/json"</js>),
* it's a simple type (e.g. <js>"iso-8601"</js>).
- *
+ *
* <p>
* An example of a type range is a value in an <code>Accept-Encoding</code> header.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -49,7 +49,7 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Parses a header such as an <code>Accept-Encoding</code> header value into an array of type ranges.
- *
+ *
* <p>
* The syntax expected to be found in the referenced <code>value</code> complies with the syntax described in
* RFC2616, Section 14.1, as described below:
@@ -58,7 +58,7 @@ public final class StringRange implements Comparable<StringRange> {
* 1#( codings [ ";" "q" "=" qvalue ] )
* codings = ( content-coding | "*" )
* </p>
- *
+ *
* <p>
* Examples of its use are:
* <p class='bcode'>
@@ -68,7 +68,7 @@ public final class StringRange implements Comparable<StringRange> {
* Accept-Encoding: compress;q=0.5, gzip;q=1.0
* Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0
* </p>
- *
+ *
* @param value
* The value to parse.
* If <jk>null</jk> or empty, returns a single <code>TypeRange</code> is returned that represents all types.
@@ -151,14 +151,14 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Returns the type enclosed by this type range.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <ul>
* <li><js>"compress"</js>
* <li><js>"gzip"</js>
* <li><js>"*"</js>
* </ul>
- *
+ *
* @return The type of this type range, lowercased, never <jk>null</jk>.
*/
public String getType() {
@@ -167,14 +167,14 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Returns the <js>'q'</js> (quality) value for this type, as described in Section 3.9 of RFC2616.
- *
+ *
* <p>
* The quality value is a float between <code>0.0</code> (unacceptable) and <code>1.0</code> (most acceptable).
- *
+ *
* <p>
* If 'q' value doesn't make sense for the context (e.g. this range was extracted from a <js>"content-*"</js>
* header, as opposed to <js>"accept-*"</js> header, its value will always be <js>"1"</js>.
- *
+ *
* @return The 'q' value for this type, never <jk>null</jk>.
*/
public Float getQValue() {
@@ -183,10 +183,10 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Returns the optional set of custom extensions defined for this type.
- *
+ *
* <p>
* Values are lowercase and never <jk>null</jk>.
- *
+ *
* @return The optional list of extensions, never <jk>null</jk>.
*/
public Map<String,Set<String>> getExtensions() {
@@ -195,10 +195,10 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Provides a string representation of this media range, suitable for use as an <code>Accept</code> header value.
- *
+ *
* <p>
* The literal text generated will be all lowercase.
- *
+ *
* @return A media range suitable for use as an Accept header value, never <code>null</code>.
*/
@Override /* Object */
@@ -229,7 +229,7 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Returns <jk>true</jk> if the specified object is also a <code>MediaType</code>, and has the same qValue, type,
* parameters, and extensions.
- *
+ *
* @return <jk>true</jk> if object is equivalent.
*/
@Override /* Object */
@@ -249,7 +249,7 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Returns a hash based on this instance's <code>media-type</code>.
- *
+ *
* @return A hash based on this instance's <code>media-type</code>.
*/
@Override /* Object */
@@ -259,14 +259,14 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Compares two MediaRanges for equality.
- *
+ *
* <p>
* The values are first compared according to <code>qValue</code> values.
* Should those values be equal, the <code>type</code> is then lexicographically compared (case-insensitive) in
* ascending order, with the <js>"*"</js> type demoted last in that order.
* <code>TypeRanges</code> with the same types but with extensions are promoted over those same types with no
* extensions.
- *
+ *
* @param o The range to compare to. Never <jk>null</jk>.
*/
@Override /* Comparable */
@@ -285,10 +285,10 @@ public final class StringRange implements Comparable<StringRange> {
/**
* Checks if the specified type matches this range.
- *
+ *
* <p>
* The type will match this range if the range type string is the same or <js>"*"</js>.
- *
+ *
* @param type The type to match against this range.
* @return <jk>true</jk> if the specified type matches this range.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TE.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TE.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TE.java
index e944191..e30087e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TE.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TE.java
@@ -18,35 +18,35 @@ import org.apache.juneau.internal.*;
/**
* Represents a parsed <l>TE</l> HTTP request header.
- *
+ *
* <p>
* The transfer encodings the user agent is willing to accept: the same values as for the response header field
* Transfer-Encoding can be used, plus the "trailers" value (related to the "chunked" transfer method) to notify the
* server it expects to receive additional fields in the trailer after the last, zero-sized, chunk.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* TE: trailers, deflate
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The TE request-header field indicates what extension transfer-codings it is willing to accept in the response and
* whether or not it is willing to accept trailer fields in a chunked transfer-coding.
* Its value may consist of the keyword "trailers" and/or a comma-separated list of extension transfer-coding names
* with optional accept parameters (as described in section 3.6).
- *
+ *
* <p class='bcode'>
* TE = "TE" ":" #( t-codings )
* t-codings = "trailers" | ( transfer-extension [ accept-params ] )
* </p>
- *
+ *
* <p>
* The presence of the keyword "trailers" indicates that the client is willing to accept trailer fields in a chunked
* transfer-coding, as defined in section 3.6.1.
* This keyword is reserved for use with transfer-coding values even though it does not itself represent a
* transfer-coding.
- *
+ *
* <p>
* Examples of its use are:
* <p class='bcode'>
@@ -54,12 +54,12 @@ import org.apache.juneau.internal.*;
* TE:
* TE: trailers, deflate;q=0.5
* </p>
- *
+ *
* <p>
* The TE header field only applies to the immediate connection.
* Therefore, the keyword MUST be supplied within a Connection header field (section 14.10) whenever TE is present in
* an HTTP/1.1 message.
- *
+ *
* <p>
* A server tests whether a transfer-coding is acceptable, according to a TE field, using these rules:
* <ol>
@@ -77,11 +77,11 @@ import org.apache.juneau.internal.*;
* qvalue is preferred.
* The "chunked" transfer-coding always has a qvalue of 1.
* </ol>
- *
+ *
* <p>
* If the TE field-value is empty or if no TE field is present, the only transfer-coding is "chunked".
* A message with no transfer-coding is always acceptable.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -97,7 +97,7 @@ public final class TE extends HeaderRangeArray {
/**
* Returns a parsed <code>Accept</code> header.
- *
+ *
* @param value The <code>Accept</code> header string.
* @return The parsed <code>Accept</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Trailer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Trailer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Trailer.java
index 25167b5..a64f456 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Trailer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Trailer.java
@@ -14,34 +14,34 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Trailer</l> HTTP response header.
- *
+ *
* <p>
* The Trailer general field value indicates that the given set of header fields is present in the trailer of a message
* encoded with chunked transfer coding.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Trailer: Max-Forwards
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Trailer general field value indicates that the given set of header fields is present in the trailer of a message
* encoded with chunked transfer-coding.
- *
+ *
* <p class='bcode'>
* Trailer = "Trailer" ":" 1#field-name
* </p>
- *
+ *
* <p>
* An HTTP/1.1 message SHOULD include a Trailer header field in a message using chunked transfer-coding with a non-empty
* trailer.
* Doing so allows the recipient to know which header fields to expect in the trailer.
- *
+ *
* <p>
* If no Trailer header field is present, the trailer SHOULD NOT include any header fields.
* See section 3.6.1 for restrictions on the use of trailer fields in a "chunked" transfer-coding.
- *
+ *
* <p>
* Message header fields listed in the Trailer header field MUST NOT include the following header fields:
* <ul>
@@ -49,7 +49,7 @@ package org.apache.juneau.http;
* <li>Content-Length
* <li>Trailer
* </ul>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -63,7 +63,7 @@ public final class Trailer extends HeaderString {
/**
* Returns a parsed <code>Trailer</code> header.
- *
+ *
* @param value The <code>Trailer</code> header string.
* @return The parsed <code>Trailer</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TransferEncoding.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TransferEncoding.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TransferEncoding.java
index b5ee9f9..9b0a6a3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TransferEncoding.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/TransferEncoding.java
@@ -14,42 +14,42 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Transfer-Encoding</l> HTTP response header.
- *
+ *
* <p>
* The form of encoding used to safely transfer the entity to the user.
* Currently defined methods are: chunked, compress, deflate, gzip, identity.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Transfer-Encoding: chunked
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Transfer-Encoding general-header field indicates what (if any) type of transformation has been applied to the
* message body in order to safely transfer it between the sender and the recipient.
* This differs from the content-coding in that the transfer-coding is a property of the message, not of the entity.
- *
+ *
* <p class='bcode'>
* Transfer-Encoding = "Transfer-Encoding" ":" 1#transfer-coding
* </p>
- *
+ *
* <p>
* Transfer-codings are defined in section 3.6. An example is:
- *
+ *
* <p class='bcode'>
* Transfer-Encoding: chunked
* </p>
- *
+ *
* <p>
* If multiple encodings have been applied to an entity, the transfer-codings MUST be listed in the order in which
* they were applied.
* Additional information about the encoding parameters MAY be provided by other entity-header fields not defined by
* this specification.
- *
+ *
* <p>
* Many older HTTP/1.0 applications do not understand the Transfer-Encoding header.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -63,7 +63,7 @@ public final class TransferEncoding extends HeaderString {
/**
* Returns a parsed <code>Transfer-Encoding</code> header.
- *
+ *
* @param value The <code>Transfer-Encoding</code> header string.
* @return The parsed <code>Transfer-Encoding</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Upgrade.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Upgrade.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Upgrade.java
index 655de91..330efaf 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Upgrade.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Upgrade.java
@@ -14,32 +14,32 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Upgrade</l> HTTP request header.
- *
+ *
* <p>
* Ask the client to upgrade to another protocol.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Upgrade: HTTP/2.0, HTTPS/1.3, IRC/6.9, RTA/x11, websocket
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Upgrade general-header allows the client to specify what additional communication protocols it supports and
* would like to use if the server finds it appropriate to switch protocols.
* The server MUST use the Upgrade header field within a 101 (Switching Protocols) response to indicate which
* protocol(s) are being switched.
- *
+ *
* <p class='bcode'>
* Upgrade = "Upgrade" ":" 1#product
* </p>
- *
+ *
* <p>
* For example,
* <p class='bcode'>
* Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11
* </p>
- *
+ *
* <p>
* The Upgrade header field is intended to provide a simple mechanism for transition from HTTP/1.1 to some other,
* incompatible protocol.
@@ -49,7 +49,7 @@ package org.apache.juneau.http;
* the more commonly supported protocol while indicating to the server that it would like to use a "better" protocol if
* available (where "better" is determined by the server, possibly according to the nature of the method and/or resource
* being requested).
- *
+ *
* <p>
* The Upgrade header field only applies to switching application-layer protocols upon the existing transport-layer
* connection.
@@ -57,22 +57,22 @@ package org.apache.juneau.http;
* The capabilities and nature of the application-layer communication after the protocol change is entirely dependent
* upon the new protocol chosen, although the first action after changing the protocol MUST be a response to the initial
* HTTP request containing the Upgrade header field.
- *
+ *
* <p>
* The Upgrade header field only applies to the immediate connection.
* Therefore, the upgrade keyword MUST be supplied within a Connection header field (section 14.10) whenever Upgrade is
* present in an HTTP/1.1 message.
- *
+ *
* <p>
* The Upgrade header field cannot be used to indicate a switch to a protocol on a different connection.
* For that purpose, it is more appropriate to use a 301, 302, 303, or 305 redirection response.
- *
+ *
* <p>
* This specification only defines the protocol name "HTTP" for use by the family of Hypertext Transfer Protocols, as
* defined by the HTTP version rules of section 3.1 and future updates to this specification.
* Any token can be used as a protocol name; however, it will only be useful if both the client and server associate
* the name with the same protocol.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -86,7 +86,7 @@ public final class Upgrade extends HeaderStringArray {
/**
* Returns a parsed <code>Upgrade</code> header.
- *
+ *
* @param value The <code>Upgrade</code> header string.
* @return The parsed <code>Upgrade</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/UserAgent.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/UserAgent.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/UserAgent.java
index 4f85e7e..6ecd07b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/UserAgent.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/UserAgent.java
@@ -14,17 +14,17 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>User-Agent</l> HTTP request header.
- *
+ *
* <p>
* The user agent string of the user agent.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:12.0) Gecko/20100101 Firefox/21.0
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The User-Agent request-header field contains information about the user agent originating the request.
* This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for
* the sake of tailoring responses to avoid particular user agent limitations.
@@ -32,17 +32,17 @@ package org.apache.juneau.http;
* The field can contain multiple product tokens (section 3.8) and comments identifying the agent and any sub-products
* which form a significant part of the user agent.
* By convention, the product tokens are listed in order of their significance for identifying the application.
- *
+ *
* <p class='bcode'>
* User-Agent = "User-Agent" ":" 1*( product | comment )
* </p>
- *
+ *
* <p>
* Example:
* <p class='bcode'>
* User-Agent: CERN-LineMode/2.15 libwww/2.17b3
* </p>
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -56,7 +56,7 @@ public final class UserAgent extends HeaderString {
/**
* Returns a parsed <code>User-Agent</code> header.
- *
+ *
* @param value The <code>User-Agent</code> header string.
* @return The parsed <code>User-Agent</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Vary.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Vary.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Vary.java
index 1a8a1e0..0335755 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Vary.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Vary.java
@@ -14,19 +14,19 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Vary</l> HTTP response header.
- *
+ *
* <p>
* Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather
* than requesting a fresh one from the origin server.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Vary: *
* Vary: Accept-Language
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Vary field value indicates the set of request-header fields that fully determines, while the response is fresh,
* whether a cache is permitted to use the response to reply to a subsequent request without revalidation.
* For uncacheable or stale responses, the Vary field value advises the user agent about the criteria that were used to
@@ -37,7 +37,7 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Vary = "Vary" ":" ( "*" | 1#field-name )
* </p>
- *
+ *
* <p>
* An HTTP/1.1 server SHOULD include a Vary header field with any cacheable response that is subject to server-driven
* negotiation.
@@ -46,23 +46,23 @@ package org.apache.juneau.http;
* A server MAY include a Vary header field with a non-cacheable response that is subject to server-driven negotiation,
* since this might provide the user agent with useful information about the dimensions over which the response varies
* at the time of the response.
- *
+ *
* <p>
* A Vary field value consisting of a list of field-names signals that the representation selected for the response is
* based on a selection algorithm which considers ONLY the listed request-header field values in selecting the most
* appropriate representation.
* A cache MAY assume that the same selection will be made for future requests with the same values for the listed
* field names, for the duration of time for which the response is fresh.
- *
+ *
* <p>
* The field-names given are not limited to the set of standard request-header fields defined by this specification.
* Field names are case-insensitive.
- *
+ *
* <p>
* A Vary field value of "*" signals that unspecified parameters not limited to the request-headers (e.g., the network
* address of the client), play a role in the selection of the response representation.
* The "*" value MUST NOT be generated by a proxy server; it may only be generated by an origin server.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -76,7 +76,7 @@ public final class Vary extends HeaderString {
/**
* Returns a parsed <code>Vary</code> header.
- *
+ *
* @param value The <code>Vary</code> header string.
* @return The parsed <code>Vary</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Via.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Via.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Via.java
index 2b300fc..0f6c943 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Via.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Via.java
@@ -14,33 +14,33 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Via</l> HTTP response header.
- *
+ *
* <p>
* Informs the client of proxies through which the response was sent.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Via: 1.0 fred, 1.1 example.com (Apache/1.1)
* </p>
- *
+ *
* <p>
* Informs the client of proxies through which the response was sent.
- *
+ *
* <p>
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Via: 1.0 fred, 1.1 example.com (Apache/1.1)
* </p>
- *
+ *
* <p>
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Via general-header field MUST be used by gateways and proxies to indicate the intermediate protocols and
* recipients between the user agent and the server on requests, and between the origin server and the client on
* responses.
* It is analogous to the "Received" field of RFC 822 and is intended to be used for tracking message forwards,
* avoiding request loops, and identifying the protocol capabilities of all senders along the request/response chain.
- *
+ *
* <p class='bcode'>
* Via = "Via" ":" 1#( received-protocol received-by [ comment ] )
* received-protocol = [ protocol-name "/" ] protocol-version
@@ -49,31 +49,31 @@ package org.apache.juneau.http;
* received-by = ( host [ ":" port ] ) | pseudonym
* pseudonym = token
* </p>
- *
+ *
* <p>
* The received-protocol indicates the protocol version of the message received by the server or client along each
* segment of the request/response chain.
* The received-protocol version is appended to the Via field value when the message is forwarded so that information
* about the protocol capabilities of upstream applications remains visible to all recipients.
- *
+ *
* <p>
* The protocol-name is optional if and only if it would be "HTTP".
* The received-by field is normally the host and optional port number of a recipient server or client that subsequently
* forwarded the message.
* However, if the real host is considered to be sensitive information, it MAY be replaced by a pseudonym.
* If the port is not given, it MAY be assumed to be the default port of the received-protocol.
- *
+ *
* <p>
* Multiple Via field values represents each proxy or gateway that has forwarded the message.
* Each recipient MUST append its information such that the end result is ordered according to the sequence of
* forwarding applications.
- *
+ *
* <p>
* Comments MAY be used in the Via header field to identify the software of the recipient proxy or gateway, analogous
* to the User-Agent and Server header fields.
* However, all comments in the Via field are optional and MAY be removed by any recipient prior to forwarding the
* message.
- *
+ *
* <p>
* For example, a request message could be sent from an HTTP/1.0 user agent to an internal proxy code-named "fred",
* which uses HTTP/1.1 to forward the request to a public proxy at nowhere.com, which completes the request by
@@ -82,14 +82,14 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1)
* </p>
- *
+ *
* <p>
* Proxies and gateways used as a portal through a network firewall SHOULD NOT, by default, forward the names and ports
* of hosts within the firewall region.
* This information SHOULD only be propagated if explicitly enabled.
* If not enabled, the received-by host of any host behind the firewall SHOULD be replaced by an appropriate pseudonym
* for that host.
- *
+ *
* <p>
* For organizations that have strong privacy requirements for hiding internal structures, a proxy MAY combine an
* ordered subsequence of Via header field entries with identical received-protocol values into a single such entry.
@@ -97,18 +97,18 @@ package org.apache.juneau.http;
* <p class='bcode'>
* Via: 1.0 ricky, 1.1 ethel, 1.1 fred, 1.0 lucy
* </p>
- *
+ *
* <p>
* ...could be collapsed to...
* <p class='bcode'>
* Via: 1.0 ricky, 1.1 mertz, 1.0 lucy
* </p>
- *
+ *
* <p>
* Applications SHOULD NOT combine multiple entries unless they are all under the same organizational control and the
* hosts have already been replaced by pseudonyms.
* Applications MUST NOT combine entries which have different received-protocol values.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -122,7 +122,7 @@ public final class Via extends HeaderStringArray {
/**
* Returns a parsed <code>Via</code> header.
- *
+ *
* @param value The <code>Via</code> header string.
* @return The parsed <code>Via</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Warning.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Warning.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Warning.java
index d972396..a2eeed0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Warning.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Warning.java
@@ -14,22 +14,22 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>Warning</l> HTTP request/response header.
- *
+ *
* <p>
* A general warning about possible problems with the entity body.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* Warning: 199 Miscellaneous warning
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The Warning general-header field is used to carry additional information about the status or transformation of a
* message which might not be reflected in the message.
* This information is typically used to warn about a possible lack of semantic transparency from caching operations
* or transformations applied to the entity body of the message.
- *
+ *
* <p>
* Warning headers are sent with responses using:
* <p class='bcode'>
@@ -43,21 +43,21 @@ package org.apache.juneau.http;
* warn-text = quoted-string
* warn-date = <"> HTTP-date <">
* </p>
- *
+ *
* <p>
* A response MAY carry more than one Warning header.
- *
+ *
* <p>
* The warn-text SHOULD be in a natural language and character set that is most likely to be intelligible to the human
* user receiving the response.
* This decision MAY be based on any available knowledge, such as the location of the cache or user, the
* Accept-Language field in a request, the Content-Language field in a response, etc.
* The default language is English and the default character set is ISO-8859-1.
- *
+ *
* <p>
* If a character set other than ISO-8859-1 is used, it MUST be encoded in the warn-text using the method described in
* RFC 2047.
- *
+ *
* <p>
* Warning headers can in general be applied to any message, however some specific warn-codes are specific to caches
* and can only be applied to response messages.
@@ -67,7 +67,7 @@ package org.apache.juneau.http;
* to that entry except as specified for specific Warning codes.
* It MUST then add any Warning headers received in the validating response.
* In other words, Warning headers are those that would be attached to the most recent relevant response.
- *
+ *
* <p>
* When multiple Warning headers are attached to a response, the user agent ought to inform the user of as many of them
* as possible, in the order that they appear in the response.
@@ -77,13 +77,13 @@ package org.apache.juneau.http;
* <li>Warnings in the user's preferred character set take priority over warnings in other character sets but with
* identical warn-codes and warn-agents.
* </ul>
- *
+ *
* <p>
* Systems that generate multiple Warning headers SHOULD order them with this user agent behavior in mind.
- *
+ *
* <p>
* Requirements for the behavior of caches with respect to Warnings are stated in section 13.1.2.
- *
+ *
* <p>
* This is a list of the currently-defined warn-codes, each with a recommended warn-text in English, and a description
* of its meaning.
@@ -105,18 +105,18 @@ package org.apache.juneau.http;
* <li>299 Miscellaneous persistent warning The warning text MAY include arbitrary information to be presented to a
* human user, or logged. A system receiving this warning MUST NOT take any automated action.
* </ul>
- *
+ *
* <p>
* If an implementation sends a message with one or more Warning headers whose version is HTTP/1.0 or lower, then the
* sender MUST include in each warning-value a warn-date that matches the date in the response.
- *
+ *
* <p>
* If an implementation receives a message with a warning-value that includes a warn-date, and that warn-date is
* different from the Date value in the response, then that warning-value MUST be deleted from the message before
* storing, forwarding, or using it.
* (This prevents bad consequences of naive caching of Warning header fields.)
* If all of the warning-values are deleted for this reason, the Warning header MUST be deleted as well.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -130,7 +130,7 @@ public final class Warning extends HeaderString {
/**
* Returns a parsed <code>Warning</code> header.
- *
+ *
* @param value The <code>Warning</code> header string.
* @return The parsed <code>Warning</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/WwwAuthenticate.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
index bbfacd6..d336783 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/WwwAuthenticate.java
@@ -14,31 +14,31 @@ package org.apache.juneau.http;
/**
* Represents a parsed <l>WWW-Authenticate </l> HTTP response header.
- *
+ *
* <p>
* Indicates the authentication scheme that should be used to access the requested entity.
- *
+ *
* <h6 class='figure'>Example</h6>
* <p class='bcode'>
* WWW-Authenticate: Basic
* </p>
- *
+ *
* <h6 class='topic'>RFC2616 Specification</h6>
- *
+ *
* The WWW-Authenticate response-header field MUST be included in 401 (Unauthorized) response messages.
* The field value consists of at least one challenge that indicates the authentication scheme(s) and parameters
* applicable to the Request-URI.
- *
+ *
* <p class='bcode'>
* WWW-Authenticate = "WWW-Authenticate" ":" 1#challenge
* </p>
- *
+ *
* <p>
* The HTTP access authentication process is described in "HTTP Authentication: Basic and Digest Access Authentication".
* User agents are advised to take special care in parsing the WWW-Authenticate field value as it might contain more
* than one challenge, or if more than one WWW-Authenticate header field is provided, the contents of a challenge
* itself can contain a comma-separated list of authentication parameters.
- *
+ *
* <h6 class='topic'>Additional Information</h6>
* <ul class='doctree'>
* <li class='jp'>
@@ -52,7 +52,7 @@ public final class WwwAuthenticate extends HeaderString {
/**
* Returns a parsed <code>WWW-Authenticate</code> header.
- *
+ *
* @param value The <code>WWW-Authenticate</code> header string.
* @return The parsed <code>WWW-Authenticate</code> header, or <jk>null</jk> if the string was null.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartParser.java
index 428445a..9df3428 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartParser.java
@@ -17,7 +17,7 @@ import org.apache.juneau.parser.*;
/**
* Interface used to convert HTTP headers, query parameters, form-data parameters, and URI path variables to POJOs
- *
+ *
* <p>
* The following default implementations are provided:
* <ul class='doctree'>
@@ -41,7 +41,7 @@ public interface HttpPartParser {
/**
* Converts the specified input to the specified class type.
- *
+ *
* @param partType The part type being parsed.
* @param in The input being parsed.
* @param type The category of value being parsed.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSerializer.java
index b2902d9..27577b0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/HttpPartSerializer.java
@@ -18,7 +18,7 @@ import org.apache.juneau.remoteable.*;
/**
* Interface used to convert POJOs to simple strings in HTTP headers, query parameters, form-data parameters, and URI
* path variables.
- *
+ *
* <p>
* The following default implementations are provided:
* <ul class='doctree'>
@@ -41,7 +41,7 @@ import org.apache.juneau.remoteable.*;
* <li class='ja'>{@link RequestBean#serializer()}
* <li class='jc'><code>RestClientBuilder.partSerializer(Class)</code>
* </ul>
- *
+ *
* <p>
* Implementations must include either a public no-args constructor or a public constructor that takes in a single
* {@link PropertyStore} object.
@@ -59,10 +59,10 @@ public interface HttpPartSerializer {
/**
* Converts the specified value to a string that can be used as an HTTP header value, query parameter value,
* form-data parameter, or URI path variable.
- *
+ *
* <p>
* Returned values should NOT be URL-encoded.
- *
+ *
* @param type The category of value being serialized.
* @param value The value being serialized.
* @return The serialized value.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializer.java
index fe2ca70..b69b16f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializer.java
@@ -44,7 +44,7 @@ public class SimpleUonPartSerializer extends UonPartSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java
index 8039c5a..50261e3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/SimpleUonPartSerializerBuilder.java
@@ -33,7 +33,7 @@ public class SimpleUonPartSerializerBuilder extends UonPartSerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public SimpleUonPartSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParser.java
index 78ae8b4..ec8d320 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParser.java
@@ -41,7 +41,7 @@ public class UonPartParser extends UonParser implements HttpPartParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public UonPartParser(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java
index 5a3007d..99a7900 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartParserBuilder.java
@@ -35,7 +35,7 @@ public class UonPartParserBuilder extends UonParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public UonPartParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java
index dec921a..0d9ed56 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializer.java
@@ -41,7 +41,7 @@ public class UonPartSerializer extends UonSerializer implements HttpPartSerializ
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java
index a20fef6..7ab3aba 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/UonPartSerializerBuilder.java
@@ -33,7 +33,7 @@ public class UonPartSerializerBuilder extends UonSerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public UonPartSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ArrayUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ArrayUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ArrayUtils.java
index 9bb852e..7c60001 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ArrayUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ArrayUtils.java
@@ -24,7 +24,7 @@ public final class ArrayUtils {
/**
* Appends one or more elements to an array.
- *
+ *
* @param <T> The element type.
* @param array The array to append to.
* @param newElements The new elements to append to the array.
@@ -46,7 +46,7 @@ public final class ArrayUtils {
/**
* Appends one or more elements to an array.
- *
+ *
* @param <T> The element type.
* @param array The array to append to.
* @param newElements The new elements to append to the array.
@@ -68,7 +68,7 @@ public final class ArrayUtils {
/**
* Combine an arbitrary number of arrays into a single array.
- *
+ *
* @param arrays Collection of arrays to combine.
* @return A new combined array, or <jk>null</jk> if all arrays are <jk>null</jk>.
*/
@@ -95,7 +95,7 @@ public final class ArrayUtils {
/**
* Creates a new array with reversed entries.
- *
+ *
* @param <T> The class type of the array.
* @param array The array to reverse.
* @return A new array with reversed entries, or <jk>null</jk> if the array was <jk>null</jk>.
@@ -131,10 +131,10 @@ public final class ArrayUtils {
/**
* Converts the specified array to a <code>Set</code>.
- *
+ *
* <p>
* The order of the entries in the set are the same as the array.
- *
+ *
* @param <T> The entry type of the array.
* @param array The array being wrapped in a <code>Set</code> interface.
* @return The new set.
@@ -178,11 +178,11 @@ public final class ArrayUtils {
/**
* Returns an iterator against an array.
- *
+ *
* <p>
* This works with any array type (e.g. <code>String[]</code>, <code>Object[]</code>,
* <code><jk>int</jk>[]</code>, etc...).
- *
+ *
* @param array The array to create an iterator over.
* @return An iterator over the specified array.
*/
@@ -212,10 +212,10 @@ public final class ArrayUtils {
/**
* Converts the specified collection to an array.
- *
+ *
* <p>
* Works on both object and primitive arrays.
- *
+ *
* @param c The collection to convert to an array.
* @param componentType The component type of the collection.
* @return A new array.
@@ -231,7 +231,7 @@ public final class ArrayUtils {
/**
* Returns <jk>true</jk> if the specified object is an array.
- *
+ *
* @param array The array to test.
* @return <jk>true</jk> if the specified object is an array.
*/
@@ -241,7 +241,7 @@ public final class ArrayUtils {
/**
* Converts the specified array to an <code>ArrayList</code>
- *
+ *
* @param array The array to convert.
* @param componentType
* The type of objects in the array.
@@ -258,7 +258,7 @@ public final class ArrayUtils {
/**
* Shortcut for calling <code>myList.toArray(new T[myList.size()]);</code>
- *
+ *
* @param c The collection being converted to an array.
* @param componentType The component type of the array.
* @return The collection converted to an array.
@@ -275,10 +275,10 @@ public final class ArrayUtils {
/**
* Copies the specified array into the specified list.
- *
+ *
* <p>
* Works on both object and primitive arrays.
- *
+ *
* @param array The array to copy into a list.
* @param list The list to copy the values into.
* @return The same list passed in.
@@ -296,7 +296,7 @@ public final class ArrayUtils {
/**
* Returns <jk>true</jk> if the specified array contains the specified element using the {@link Object#equals(Object)}
* method.
- *
+ *
* @param element The element to check for.
* @param array The array to check.
* @return
@@ -309,7 +309,7 @@ public final class ArrayUtils {
/**
* Returns the index position of the element in the specified array using the {@link Object#equals(Object)} method.
- *
+ *
* @param element The element to check for.
* @param array The array to check.
* @return
@@ -330,7 +330,7 @@ public final class ArrayUtils {
/**
* Returns <jk>true</jk> if the specified array contains the specified element using the {@link String#equals(Object)}
* method.
- *
+ *
* @param element The element to check for.
* @param array The array to check.
* @return
@@ -343,7 +343,7 @@ public final class ArrayUtils {
/**
* Returns the index position of the element in the specified array using the {@link String#equals(Object)} method.
- *
+ *
* @param element The element to check for.
* @param array The array to check.
* @return
@@ -363,7 +363,7 @@ public final class ArrayUtils {
/**
* Converts a primitive wrapper array (e.g. <code>Integer[]</code>) to a primitive array (e.g. <code><jk>int</jk>[]</code>).
- *
+ *
* @param o The array to convert. Must be a primitive wrapper array.
* @return A new array.
* @throws IllegalArgumentException If object is not a wrapper object array.
@@ -384,7 +384,7 @@ public final class ArrayUtils {
/**
* Converts an Iterable to a list.
- *
+ *
* @param i The iterable to convert.
* @return A new list of objects copied from the iterable.
*/
@@ -398,7 +398,7 @@ public final class ArrayUtils {
/**
* Returns the first object in the specified collection or array.
- *
+ *
* @param val The collection or array object.
* @return
* The first object, or <jk>null</jk> if the collection or array is empty or <jk>null</jk> or the value
@@ -420,11 +420,11 @@ public final class ArrayUtils {
/**
* Converts the specified collection to an array of strings.
- *
+ *
* <p>
* Entries are converted to strings using {@link #toString()}.
* <jk>null</jk> values remain <jk>null</jk>.
- *
+ *
* @param c The collection to convert.
* @return The collection as a string array.
*/
@@ -438,7 +438,7 @@ public final class ArrayUtils {
/**
* Returns <jk>true</jk> if the following sorted arrays are equals.
- *
+ *
* @param a1 Array #1.
* @param a2 Array #2.
* @return <jk>true</jk> if the following sorted arrays are equals.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiMap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiMap.java
index 4f63f77..645cc91 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiMap.java
@@ -20,7 +20,7 @@ public final class AsciiMap {
/**
* Adds an entry to this map.
- *
+ *
* @param c The key.
* @param s The value.
* @return This object (for method chaining).
@@ -33,7 +33,7 @@ public final class AsciiMap {
/**
* Returns the value for the specified key.
- *
+ *
* @param c The key.
* @return The value.
*/
@@ -43,7 +43,7 @@ public final class AsciiMap {
/**
* Returns <jk>true</jk> if the specified character is in this store.
- *
+ *
* @param c The character to check.
* @return <jk>true</jk> if the specified character is in this store.
*/
@@ -55,7 +55,7 @@ public final class AsciiMap {
/**
* Returns <jk>true</jk> if the specified character is in this store.
- *
+ *
* @param c The character to check.
* @return <jk>true</jk> if the specified character is in this store.
*/
@@ -67,7 +67,7 @@ public final class AsciiMap {
/**
* Returns <jk>true</jk> if the specified string contains at least one character in this set.
- *
+ *
* @param s The string to test.
* @return <jk>true</jk> if the string is not null and contains at least one character in this set.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiSet.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiSet.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiSet.java
index 7f84418..87439bd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiSet.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/AsciiSet.java
@@ -20,7 +20,7 @@ public final class AsciiSet {
/**
* Constructor.
- *
+ *
* @param chars The characters to keep in this store.
*/
public AsciiSet(String chars) {
@@ -33,7 +33,7 @@ public final class AsciiSet {
/**
* Returns <jk>true</jk> if the specified character is in this store.
- *
+ *
* @param c The character to check.
* @return <jk>true</jk> if the specified character is in this store.
*/
@@ -45,7 +45,7 @@ public final class AsciiSet {
/**
* Returns <jk>true</jk> if the specified character is in this store.
- *
+ *
* @param c The character to check.
* @return <jk>true</jk> if the specified character is in this store.
*/
@@ -57,7 +57,7 @@ public final class AsciiSet {
/**
* Returns <jk>true</jk> if the specified string contains at least one character in this set.
- *
+ *
* @param s The string to test.
* @return <jk>true</jk> if the string is not null and contains at least one character in this set.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayCache.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
index dc90746..ff77624 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
@@ -23,7 +23,7 @@ public class ByteArrayCache {
/**
* Default global byte array cache.
- *
+ *
* <p>
* Note that this can't ever get garbage collected so don't add really large arrays!
*/
@@ -33,7 +33,7 @@ public class ByteArrayCache {
/**
* Add the specified byte array to this cache.
- *
+ *
* @param contents The byte array to add to this cache.
* @return
* Either the same byte array or a previously cached byte array depending on whether the byte array already
@@ -49,7 +49,7 @@ public class ByteArrayCache {
/**
* Add the specified input stream to this cache.
- *
+ *
* @param contents The input stream whose contents are to be added to this cache.
* @return
* Either the same byte array or a previously cached byte array depending on whether the byte array already
@@ -66,7 +66,7 @@ public class ByteArrayCache {
/**
* Returns the number of byte arrays in this cache.
- *
+ *
* @return The number of byte arrays in this cache.
*/
public int size() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayInOutStream.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayInOutStream.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayInOutStream.java
index 62b9e19..8e8c569 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayInOutStream.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ByteArrayInOutStream.java
@@ -21,7 +21,7 @@ public class ByteArrayInOutStream extends ByteArrayOutputStream {
/**
* Creates a new input stream from this object.
- *
+ *
* @return A new input stream from this object.
*/
public ByteArrayInputStream getInputStream() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Cache.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Cache.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Cache.java
index 65bf6f6..1964c02 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Cache.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/Cache.java
@@ -16,10 +16,10 @@ import java.util.concurrent.*;
/**
* Simple in-memory cache of objects.
- *
+ *
* <p>
* Essentially just a wrapper around a ConcurrentHashMap.
- *
+ *
* @param <K> The key type.
* @param <V> The value type.
*/
@@ -30,7 +30,7 @@ public class Cache<K,V> {
/**
* Constructor.
- *
+ *
* @param disabled If <jk>true</jk> then the cache is disabled.
* @param maxSize The maximum size of the cache. If this threshold is reached, the cache is flushed.
*/
@@ -45,7 +45,7 @@ public class Cache<K,V> {
/**
* Retrieves the value with the specified key from this cache.
- *
+ *
* @param key The key.
* @return The value, or <jk>null</jk> if the value is not in the cache, or the cache is disabled.
*/
@@ -57,7 +57,7 @@ public class Cache<K,V> {
/**
* Adds the value with the specified key to this cache.
- *
+ *
* @param key The key.
* @param value The value.
* @return
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CharSequenceReader.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CharSequenceReader.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CharSequenceReader.java
index bfe877c..d607fc7 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CharSequenceReader.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CharSequenceReader.java
@@ -28,7 +28,7 @@ public final class CharSequenceReader extends BufferedReader {
/**
* Constructor.
- *
+ *
* @param cs The char sequence to read from. Can be <jk>null</jk>.
*/
public CharSequenceReader(CharSequence cs) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java
index 8e002f0..936f80d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/ClassUtils.java
@@ -54,7 +54,7 @@ public final class ClassUtils {
/**
* Given the specified list of objects, return readable names for the class types of the objects.
- *
+ *
* @param o The objects.
* @return An array of readable class type strings.
*/
@@ -67,7 +67,7 @@ public final class ClassUtils {
/**
* Shortcut for calling <code><jsm>getReadableClassName</jsm>(c.getName())</code>
- *
+ *
* @param c The class.
* @return A readable class type name, or <jk>null</jk> if parameter is <jk>null</jk>.
*/
@@ -79,7 +79,7 @@ public final class ClassUtils {
/**
* Shortcut for calling <code><jsm>getReadableClassName</jsm>(c.getClass().getName())</code>
- *
+ *
* @param o The object whose class we want to render.
* @return A readable class type name, or <jk>null</jk> if parameter is <jk>null</jk>.
*/
@@ -91,7 +91,7 @@ public final class ClassUtils {
/**
* Converts the specified class name to a readable form when class name is a special construct like <js>"[[Z"</js>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jsm>getReadableClassName</jsm>(<js>"java.lang.Object"</js>); <jc>// Returns "java.lang.Object"</jc>
@@ -101,7 +101,7 @@ public final class ClassUtils {
* <jsm>getReadableClassName</jsm>(<js>"[Ljava.lang.Object;"</js>); <jc>// Returns "java.lang.Object[]"</jc>
* <jsm>getReadableClassName</jsm>(<jk>null</jk>); <jc>// Returns null</jc>
* </p>
- *
+ *
* @param className The class name.
* @return A readable class type name, or <jk>null</jk> if parameter is <jk>null</jk>.
*/
@@ -138,10 +138,10 @@ public final class ClassUtils {
/**
* Converts the string generated by {@link #getReadableClassName(Class)} back into a {@link Class}.
- *
+ *
* <p>
* Generics are stripped from the string since they cannot be converted to a class.
- *
+ *
* @param cl The classloader to use to load the class.
* @param name The readable class name.
* @return The class object.
@@ -153,7 +153,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if <code>parent</code> is a parent class of <code>child</code>.
- *
+ *
* @param parent The parent class.
* @param child The child class.
* @param strict If <jk>true</jk> returns <jk>false</jk> if the classes are the same.
@@ -165,7 +165,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if <code>parent</code> is a parent class or the same as <code>child</code>.
- *
+ *
* @param parent The parent class.
* @param child The child class.
* @return <jk>true</jk> if <code>parent</code> is a parent class or the same as <code>child</code>.
@@ -176,7 +176,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if <code>parent</code> is a parent class or the same as <code>child</code>.
- *
+ *
* @param parent The parent class.
* @param child The child class.
* @return <jk>true</jk> if <code>parent</code> is a parent class or the same as <code>child</code>.
@@ -189,12 +189,12 @@ public final class ClassUtils {
/**
* Returns the signature of the specified method.
- *
+ *
* <p>
* For no-arg methods, the signature will be a simple string such as <js>"toString"</js>.
* For methods with one or more args, the arguments will be fully-qualified class names (e.g.
* <js>"append(java.util.StringBuilder,boolean)"</js>)
- *
+ *
* @param m The methods to get the signature on.
* @return The methods signature.
*/
@@ -238,7 +238,7 @@ public final class ClassUtils {
/**
* If the specified class is a primitive (e.g. <code><jk>int</jk>.<jk>class</jk></code>) returns it's wrapper class
* (e.g. <code>Integer.<jk>class</jk></code>).
- *
+ *
* @param c The class.
* @return The wrapper class, or <jk>null</jk> if class is not a primitive.
*/
@@ -249,7 +249,7 @@ public final class ClassUtils {
/**
* If the specified class is a primitive wrapper (e.g. <code><jk>Integer</jk>.<jk>class</jk></code>) returns it's
* primitive class (e.g. <code>int.<jk>class</jk></code>).
- *
+ *
* @param c The class.
* @return The primitive class, or <jk>null</jk> if class is not a primitive wrapper.
*/
@@ -260,7 +260,7 @@ public final class ClassUtils {
/**
* If the specified class is a primitive (e.g. <code><jk>int</jk>.<jk>class</jk></code>) returns it's wrapper class
* (e.g. <code>Integer.<jk>class</jk></code>).
- *
+ *
* @param c The class.
* @return The wrapper class if it's primitive, or the same class if class is not a primitive.
*/
@@ -272,7 +272,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified class has the {@link Deprecated @Deprecated} annotation on it.
- *
+ *
* @param c The class.
* @return <jk>true</jk> if the specified class has the {@link Deprecated @Deprecated} annotation on it.
*/
@@ -282,7 +282,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified method has the {@link Deprecated @Deprecated} annotation on it.
- *
+ *
* @param m The method.
* @return <jk>true</jk> if the specified method has the {@link Deprecated @Deprecated} annotation on it.
*/
@@ -293,7 +293,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified constructor has the {@link Deprecated @Deprecated} annotation on it.
- *
+ *
* @param c The constructor.
* @return <jk>true</jk> if the specified constructor has the {@link Deprecated @Deprecated} annotation on it.
*/
@@ -303,7 +303,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified class is public.
- *
+ *
* @param c The class.
* @return <jk>true</jk> if the specified class is public.
*/
@@ -313,7 +313,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified class is public.
- *
+ *
* @param c The class.
* @return <jk>true</jk> if the specified class is public.
*/
@@ -323,7 +323,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified class is abstract.
- *
+ *
* @param c The class.
* @return <jk>true</jk> if the specified class is abstract.
*/
@@ -333,7 +333,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified method is public.
- *
+ *
* @param m The method.
* @return <jk>true</jk> if the specified method is public.
*/
@@ -343,7 +343,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified method is static.
- *
+ *
* @param m The method.
* @return <jk>true</jk> if the specified method is static.
*/
@@ -353,7 +353,7 @@ public final class ClassUtils {
/**
* Returns <jk>true</jk> if the specified constructor is public.
- *
+ *
* @param c The constructor.
* @return <jk>true</jk> if the specified constructor is public.
*/
@@ -363,16 +363,16 @@ public final class ClassUtils {
/**
* Returns the specified annotation on the specified method.
- *
+ *
* <p>
* Similar to {@link Method#getAnnotation(Class)}, but searches up the parent hierarchy for the annotation
* defined on parent classes and interfaces.
- *
+ *
* <p>
* Normally, annotations defined on methods of parent classes and interfaces are not inherited by the child methods.
* This utility method gets around that limitation by searching the class hierarchy for the "same" method
* (i.e. the same name and arguments).
- *
+ *
* @param a The annotation to search for.
* @param m The method to search.
* @return The annotation, or <jk>null</jk> if it wasn't found.
@@ -383,16 +383,16 @@ public final class ClassUtils {
/**
* Returns the specified annotation on the specified method.
- *
+ *
* <p>
* Similar to {@link Method#getAnnotation(Class)}, but searches up the parent hierarchy for the annotation defined
* on parent classes and interfaces.
- *
+ *
* <p>
* Normally, annotations defined on methods of parent classes and interfaces are not inherited by the child methods.
* This utility method gets around that limitation by searching the class hierarchy for the "same" method
* (i.e. the same name and arguments).
- *
+ *
* @param a The annotation to search for.
* @param c
* The child class to start searching from.
@@ -429,12 +429,12 @@ public final class ClassUtils {
/**
* Locates the no-arg constructor for the specified class.
- *
+ *
* <p>
* Constructor must match the visibility requirements specified by parameter 'v'.
* If class is abstract, always returns <jk>null</jk>.
* Note that this also returns the 1-arg constructor for non-static member classes.
- *
+ *
* @param c The class from which to locate the no-arg constructor.
* @param v The minimum visibility.
* @return The constructor, or <jk>null</jk> if no no-arg constructor exists with the required visibility.
@@ -455,7 +455,7 @@ public final class ClassUtils {
/**
* Finds the real parameter type of the specified class.
- *
+ *
* @param c The class containing the parameters (e.g. PojoSwap<T,S>)
* @param index The zero-based index of the parameter to resolve.
* @param oc The class we're trying to resolve the parameter type for.
@@ -546,7 +546,7 @@ public final class ClassUtils {
/**
* Finds a public method with the specified parameters.
- *
+ *
* @param c The class to look for the method.
* @param name The method name.
* @param returnType
@@ -574,7 +574,7 @@ public final class ClassUtils {
/**
* Finds a public constructor with the specified parameters without throwing an exception.
- *
+ *
* @param c The class to search for a constructor.
* @param fuzzyArgs
* Use fuzzy-arg matching.
@@ -666,7 +666,7 @@ public final class ClassUtils {
/**
* Finds the public constructor that can take in the specified arguments.
- *
+ *
* @param c The class we're trying to construct.
* @param args The arguments we want to pass into the constructor.
* @return
@@ -679,7 +679,7 @@ public final class ClassUtils {
/**
* Finds the public constructor that can take in the specified arguments.
- *
+ *
* @param c The class we're trying to construct.
* @param args The argument types we want to pass into the constructor.
* @return
@@ -692,7 +692,7 @@ public final class ClassUtils {
/**
* Finds the public constructor that can take in the specified arguments.
- *
+ *
* @param c The class we're trying to construct.
* @param fuzzyArgs
* Use fuzzy-arg matching.
@@ -708,7 +708,7 @@ public final class ClassUtils {
/**
* Returns the class types for the specified arguments.
- *
+ *
* @param args The objects we're getting the classes of.
* @return The classes of the arguments.
*/
@@ -721,7 +721,7 @@ public final class ClassUtils {
/**
* Returns a {@link MethodInfo} bean that describes the specified method.
- *
+ *
* @param m The method to describe.
* @return The bean with information about the method.
*/
@@ -731,7 +731,7 @@ public final class ClassUtils {
/**
* Returns {@link MethodInfo} beans that describe the specified methods.
- *
+ *
* @param m The methods to describe.
* @return The beans with information about the methods.
*/
@@ -764,7 +764,7 @@ public final class ClassUtils {
/**
* Creates an instance of the specified class.
- *
+ *
* @param c
* The class to cast to.
* @param c2
@@ -781,7 +781,7 @@ public final class ClassUtils {
/**
* Creates an instance of the specified class.
- *
+ *
* @param c
* The class to cast to.
* @param c2
@@ -882,10 +882,10 @@ public final class ClassUtils {
/**
* Returns all the fields in the specified class and all parent classes.
- *
+ *
* <p>
* Fields are ordered in either parent-to-child, or child-to-parent order, then alphabetically.
- *
+ *
* @param c The class to get all fields on.
* @param parentFirst Order them in parent-class-to-child-class order, otherwise child-class-to-parent-class order.
* @return An iterable of all fields in the specified class.
@@ -940,10 +940,10 @@ public final class ClassUtils {
/**
* Returns all the methods in the specified class and all parent classes.
- *
+ *
* <p>
* Methods are ordered in either parent-to-child, or child-to-parent order, then alphabetically.
- *
+ *
* @param c The class to get all methods on.
* @param parentFirst Order them in parent-class-to-child-class order, otherwise child-class-to-parent-class order.
* @return An iterable of all methods in the specified class.
@@ -1015,7 +1015,7 @@ public final class ClassUtils {
/**
* Sorts methods in alphabetical order.
- *
+ *
* @param m The methods to sort.
* @return The same array, but with elements sorted.
*/
@@ -1034,7 +1034,7 @@ public final class ClassUtils {
/**
* Sorts methods in alphabetical order.
- *
+ *
* @param m The methods to sort.
* @return The same array, but with elements sorted.
*/
@@ -1045,7 +1045,7 @@ public final class ClassUtils {
/**
* Returns a list of all the parent classes of the specified class including the class itself.
- *
+ *
* @param c The class to retrieve the parent classes.
* @param parentFirst In parent-to-child order, otherwise child-to-parent.
* @param includeInterfaces Include interfaces.
@@ -1077,7 +1077,7 @@ public final class ClassUtils {
/**
* Returns the default value for the specified primitive class.
- *
+ *
* @param primitiveClass The primitive class to get the default value for.
* @return The default value, or <jk>null</jk> if the specified class is not a primitive class.
*/
@@ -1107,10 +1107,10 @@ public final class ClassUtils {
/**
* Returns a readable representation of the specified method.
- *
+ *
* <p>
* The format of the string is <js>"full-qualified-class.method-name(parameter-simple-class-names)"</js>.
- *
+ *
* @param m The method to stringify.
* @return The stringified method.
*/
@@ -1127,10 +1127,10 @@ public final class ClassUtils {
/**
* Returns a readable representation of the specified field.
- *
+ *
* <p>
* The format of the string is <js>"full-qualified-class.field-name"</js>.
- *
+ *
* @param f The field to stringify.
* @return The stringified field.
*/
@@ -1140,7 +1140,7 @@ public final class ClassUtils {
/**
* Throws an {@link IllegalArgumentException} if the parameters on the method are not in the specified list provided.
- *
+ *
* @param m The method to test.
* @param args The valid class types (exact) for the arguments.
* @throws FormattedIllegalArgumentException If any of the parameters on the method weren't in the list.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CollectionUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CollectionUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CollectionUtils.java
index 7bb2e50..a71ea97 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CollectionUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/CollectionUtils.java
@@ -25,7 +25,7 @@ public final class CollectionUtils {
/**
* Reverses the order of a {@link LinkedHashMap}.
- *
+ *
* @param in The map to reverse the order on.
* @return A new {@link LinkedHashMap} with keys in reverse order.
*/
@@ -46,7 +46,7 @@ public final class CollectionUtils {
/**
* Add a value to a list if the value is not null.
- *
+ *
* @param l The list to add to.
* @param o The element to add.
* @return The same list.
@@ -59,10 +59,10 @@ public final class CollectionUtils {
/**
* Adds the contents of one list to the other in reverse order.
- *
+ *
* <p>
* i.e. add values from 2nd list from end-to-start order to the end of the 1st list.
- *
+ *
* @param list The list to append to.
* @param append Contains the values to append to the list.
* @return The same list.
@@ -76,10 +76,10 @@ public final class CollectionUtils {
/**
* Adds the contents of the array to the list in reverse order.
- *
+ *
* <p>
* i.e. add values from the array from end-to-start order to the end of the list.
- *
+ *
* @param list The list to append to.
* @param append Contains the values to append to the list.
* @return The same list.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java
index e37cabe..57cfce3 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java
@@ -20,10 +20,10 @@ import javax.xml.bind.*;
/**
* A utility class for parsing and formatting HTTP dates as used in cookies and other headers.
- *
+ *
* <p>
* This class handles dates as defined by RFC 2616 section 3.3.1 as well as some other common non-standard formats.
- *
+ *
* <p>
* This class was copied from HttpClient 4.3.
*/
@@ -56,7 +56,7 @@ public final class DateUtils {
/**
* Parses a date value. The formats used for parsing the date value are retrieved from the default http params.
- *
+ *
* @param dateValue the date value to parse
* @return the parsed date or null if input could not be parsed
*/
@@ -66,7 +66,7 @@ public final class DateUtils {
/**
* Parses the date value using the given date formats.
- *
+ *
* @param dateValue the date value to parse
* @param dateFormats the date formats to use
* @return the parsed date or null if input could not be parsed
@@ -77,7 +77,7 @@ public final class DateUtils {
/**
* Parses the date value using the given date formats.
- *
+ *
* @param dateValue the date value to parse
* @param dateFormats the date formats to use
* @param startDate
@@ -109,7 +109,7 @@ public final class DateUtils {
/**
* Parses an ISO8601 string and converts it to a {@link Calendar}.
- *
+ *
* @param s The string to parse.
* @return The parsed value, or <jk>null</jk> if the string was <jk>null</jk> or empty.
*/
@@ -121,7 +121,7 @@ public final class DateUtils {
/**
* Formats the given date according to the RFC 1123 pattern.
- *
+ *
* @param date The date to format.
* @return An RFC 1123 formatted date string.
* @see #PATTERN_RFC1123
@@ -132,10 +132,10 @@ public final class DateUtils {
/**
* Formats the given date according to the specified pattern.
- *
+ *
* <p>
* The pattern must conform to that used by the {@link SimpleDateFormat simple date format} class.
- *
+ *
* @param date The date to format.
* @param pattern The pattern to use for formatting the date.
* @return A formatted date string.
@@ -156,7 +156,7 @@ public final class DateUtils {
/**
* A factory for {@link SimpleDateFormat}s.
- *
+ *
* <p>
* The instances are stored in a thread-local way because SimpleDateFormat is not thread-safe as noted in
* {@link SimpleDateFormat its javadoc}.
@@ -172,7 +172,7 @@ public final class DateUtils {
/**
* Creates a {@link SimpleDateFormat} for the requested format string.
- *
+ *
* @param pattern
* A non-<code>null</code> format String according to {@link SimpleDateFormat}.
* The format is not checked against <code>null</code> since all paths go through {@link DateUtils}.
@@ -204,7 +204,7 @@ public final class DateUtils {
/**
* Pads out an ISO8601 string so that it can be parsed using {@link DatatypeConverter#parseDateTime(String)}.
- *
+ *
* <ul>
* <li><js>"2001-07-04T15:30:45-05:00"</js> --> <js>"2001-07-04T15:30:45-05:00"</js>
* <li><js>"2001-07-04T15:30:45Z"</js> --> <js>"2001-07-04T15:30:45Z"</js>
@@ -215,7 +215,7 @@ public final class DateUtils {
* <li><js>"2001-07"</js> --> <js>"2001-07-01T00:00:00"</js>
* <li><js>"2001"</js> --> <js>"2001-01-01T00:00:00"</js>
* </ul>
- *
+ *
* @param in The string to pad.
* @return The padded string.
*/