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:34 UTC
[06/32] juneau git commit: Javadoc updates.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
index f0f5c77..36c4df7 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClientBuilder.java
@@ -95,19 +95,19 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Creates an instance of an {@link HttpClient} to be used to handle all HTTP communications with the target server.
- *
+ *
* <p>
* This HTTP client is used when the HTTP client is not specified through one of the constructors or the
* {@link #httpClient(CloseableHttpClient, boolean)} method.
- *
+ *
* <p>
* Subclasses can override this method to provide specially-configured HTTP clients to handle stuff such as
* SSL/TLS certificate handling, authentication, etc.
- *
+ *
* <p>
* The default implementation returns an instance of {@link HttpClient} using the client builder returned by
* {@link #createHttpClientBuilder()}.
- *
+ *
* @return The HTTP client to use.
* @throws Exception
*/
@@ -120,17 +120,17 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Creates an instance of an {@link HttpClientBuilder} to be used to create the {@link HttpClient}.
- *
+ *
* <p>
* Subclasses can override this method to provide their own client builder.
- *
+ *
* <p>
* The predefined method returns an {@link HttpClientBuilder} with the following settings:
* <ul>
* <li>Lax redirect strategy.
* <li>The connection manager returned by {@link #createConnectionManager()}.
* </ul>
- *
+ *
* @return The HTTP client builder to use to create the HTTP client.
*/
protected HttpClientBuilder createHttpClientBuilder() {
@@ -141,13 +141,13 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Creates the {@link HttpClientConnectionManager} returned by {@link #createConnectionManager()}.
- *
+ *
* <p>
* Subclasses can override this method to provide their own connection manager.
- *
+ *
* <p>
* The default implementation returns an instance of a {@link PoolingHttpClientConnectionManager}.
- *
+ *
* @return The HTTP client builder to use to create the HTTP client.
*/
@SuppressWarnings("resource")
@@ -186,7 +186,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Enable SSL support on this client.
- *
+ *
* @param opts
* The SSL configuration options.
* See {@link SSLOpts} for details.
@@ -202,10 +202,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Enable LAX SSL support.
- *
+ *
* <p>
* Certificate chain validation and hostname verification is disabled.
- *
+ *
* @return This object (for method chaining).
* @throws KeyStoreException
* @throws NoSuchAlgorithmException
@@ -216,7 +216,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the client version by setting the value for the <js>"X-Client-Version"</js> header.
- *
+ *
* @param version The version string (e.g. <js>"1.2.3"</js>)
* @return This object (for method chaining).
*/
@@ -226,7 +226,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Adds a {@link RestCallLogger} to the list of interceptors on this class.
- *
+ *
* @param level The log level to log messages at.
* @param log The logger to log messages to.
* @return This object (for method chaining).
@@ -238,7 +238,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* When called, the {@link #createConnectionManager()} method will return a {@link PoolingHttpClientConnectionManager}
* instead of a {@link BasicHttpClientConnectionManager}.
- *
+ *
* @return This object (for method chaining).
*/
public RestClientBuilder pooled() {
@@ -248,7 +248,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Set up this client to use BASIC auth.
- *
+ *
* @param host The auth scope hostname.
* @param port The auth scope port.
* @param user The username.
@@ -266,7 +266,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the internal {@link HttpClient} to use for handling HTTP communications.
- *
+ *
* @param httpClient The HTTP client.
* @param keepHttpClientOpen Don't close this client when the {@link RestClient#close()} method is called.
* @return This object (for method chaining).
@@ -284,11 +284,11 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Accept</code> request header.
- *
+ *
* <p>
* This overrides the media type specified on the parser, but is overridden by calling
* <code>header(<js>"Accept"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -298,10 +298,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Accept-Charset</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Accept-Charset"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -311,10 +311,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Accept-Encoding</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Accept-Encoding"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -324,10 +324,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Accept-Language</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Accept-Language"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -337,10 +337,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Authorization</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Authorization"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -350,10 +350,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Cache-Control</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Cache-Control"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -363,10 +363,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Connection</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Connection"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -376,10 +376,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Content-Length</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Content-Length"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -389,11 +389,11 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Content-Type</code> request header.
- *
+ *
* <p>
* This overrides the media type specified on the serializer, but is overridden by calling
* <code>header(<js>"Content-Type"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -403,10 +403,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Date</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Date"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -416,10 +416,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Expect</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Expect"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -429,10 +429,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Forwarded</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Forwarded"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -442,10 +442,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>From</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"From"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -455,10 +455,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Host</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Host"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -468,10 +468,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>If-Match</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-Match"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -481,10 +481,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>If-Modified-Since</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-Modified-Since"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -494,10 +494,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>If-None-Match</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-None-Match"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -507,10 +507,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>If-Range</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-Range"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -520,10 +520,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>If-Unmodified-Since</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"If-Unmodified-Since"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -533,10 +533,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Max-Forwards</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Max-Forwards"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -546,12 +546,12 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* When called, <code>No-Trace: true</code> is added to requests.
- *
+ *
* <p>
* This gives the opportunity for the servlet to not log errors on invalid requests.
* This is useful for testing purposes when you don't want your log file to show lots of errors that are simply the
* results of testing.
- *
+ *
* @return This object (for method chaining).
*/
public RestClientBuilder noTrace() {
@@ -560,10 +560,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Origin</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Origin"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -573,10 +573,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Pragma</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Pragma"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -586,10 +586,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Proxy-Authorization</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Proxy-Authorization"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -599,10 +599,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Range</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Range"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -612,10 +612,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Referer</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Referer"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -625,10 +625,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>TE</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"TE"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -638,10 +638,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>User-Agent</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"User-Agent"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -651,10 +651,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Upgrade</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Upgrade"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -664,10 +664,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Via</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Via"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -677,10 +677,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the value for the <code>Warning</code> request header.
- *
+ *
* <p>
* This is a shortcut for calling <code>header(<js>"Warning"</js>, value);</code>
- *
+ *
* @param value The new header value.
* @return This object (for method chaining).
*/
@@ -698,7 +698,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Defines the executor service to use when calling future methods on the {@link RestCall} class.
- *
+ *
* <p>
* This executor service is used to create {@link Future} objects on the following methods:
* <ul>
@@ -707,11 +707,11 @@ public class RestClientBuilder extends BeanContextBuilder {
* <li>{@link RestCall#getResponseFuture(Type,Type...)}
* <li>{@link RestCall#getResponseAsString()}
* </ul>
- *
+ *
* <p>
* The default executor service is a single-threaded {@link ThreadPoolExecutor} with a 30 second timeout
* and a queue size of 10.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_executorService}
@@ -730,7 +730,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Request headers.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_headers}
@@ -746,10 +746,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Keep HttpClient open.
- *
+ *
* <p>
* Don't close this client when the {@link RestClient#close()} method is called.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_keepHttpClientOpen}
@@ -769,7 +769,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Adds an interceptor that gets called immediately after a connection is made.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_interceptors}
@@ -787,7 +787,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* The parser to use for parsing POJOs in response bodies.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_parser}
@@ -807,7 +807,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Same as {@link #parser(Parser)} except takes in a parser instance.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_parser}
@@ -824,10 +824,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Part serializer.
- *
+ *
* <p>
* The serializer to use for serializing POJOs in form data, query parameters, headers, and path variables.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_partSerializer}
@@ -844,10 +844,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Part serializer.
- *
+ *
* <p>
* Same as {@link #partSerializer(Class)} but takes in a parser instance.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_partSerializer}
@@ -864,7 +864,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Make HTTP calls retryable if an error response (>=400) is received.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_retries}
@@ -888,12 +888,12 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Root URI.
- *
+ *
* <p>
* When set, relative URL strings passed in through the various rest call methods (e.g. {@link RestClient#doGet(Object)}
* will be prefixed with the specified root.
* <br>This root URL is ignored on those methods if you pass in a {@link URL}, {@link URI}, or an absolute URL string.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_rootUri}
@@ -911,7 +911,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Request query parameters.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_query}
@@ -927,10 +927,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Serializer.
- *
+ *
* <p>
* The serializer to use for serializing POJOs in request bodies.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_serializer}
@@ -947,10 +947,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Serializer.
- *
+ *
* <p>
* Same as {@link #serializer(Class)} but takes in a serializer instance.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link RestClient#RESTCLIENT_serializer}
@@ -967,11 +967,11 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Abridged output.
- *
+ *
* <p>
* When enabled, it is assumed that the parser knows the exact Java POJO type being parsed, and therefore top-level
* type information that might normally be included to determine the data type will not be serialized.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_abridged}
@@ -988,10 +988,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Abridged output.
- *
+ *
* <p>
* Shortcut for calling <code>abridged(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_abridged}
@@ -1005,11 +1005,11 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Add <js>"_type"</js> properties when needed.
- *
+ *
* <p>
* If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
* through reflection.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_addBeanTypeProperties}
@@ -1026,15 +1026,15 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Automatically detect POJO recursions.
- *
+ *
* <p>
* Specifies that recursions should be checked for during serialization.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Checking for recursion can cause a small performance penalty.
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_detectRecursions}
@@ -1051,10 +1051,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Automatically detect POJO recursions.
- *
+ *
* <p>
* Shortcut for calling <code>detectRecursions(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_detectRecursions}
@@ -1068,16 +1068,16 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Ignore recursion errors.
- *
+ *
* <p>
* If <jk>true</jk>, when we encounter the same object when serializing a tree, we set the value to <jk>null</jk>.
* Otherwise, an exception is thrown.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Checking for recursion can cause a small performance penalty.
* </ul>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_ignoreRecursions}
@@ -1094,10 +1094,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Ignore recursion errors.
- *
+ *
* <p>
* Shortcut for calling <code>ignoreRecursions(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_ignoreRecursions}
@@ -1111,10 +1111,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Initial depth.
- *
+ *
* <p>
* The initial indentation level at the root.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_initialDepth}
@@ -1131,10 +1131,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Serializer listener.
- *
+ *
* <p>
* Class used to listen for errors and warnings that occur during serialization.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_listener}
@@ -1150,12 +1150,12 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Max serialization depth.
- *
+ *
* <p>
* Abort serialization if specified depth is reached in the POJO tree.
* <br>If this depth is exceeded, an exception is thrown.
* <br>This prevents stack overflows from occurring when trying to serialize models with recursive references.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_maxDepth}
@@ -1172,10 +1172,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Maximum indentation.
- *
+ *
* <p>
* Specifies the maximum indentation level in the serialized document.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_maxIndent}
@@ -1192,10 +1192,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Quote character.
- *
+ *
* <p>
* This is the character used for quoting attributes and values.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_quoteChar}
@@ -1215,7 +1215,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>quoteChar(<js>'\''</js>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_quoteChar}
@@ -1229,10 +1229,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Sort arrays and collections alphabetically.
- *
+ *
* <p>
* Copies and sorts the contents of arrays and collections before serializing them.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortCollections}
@@ -1252,7 +1252,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>sortCollections(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortCollections}
@@ -1266,10 +1266,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the {@link Serializer#SERIALIZER_sortMaps} property on all serializers in this group.
- *
+ *
* <p>
* Copies and sorts the contents of maps before serializing them.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortMaps}
@@ -1287,7 +1287,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>sortMaps(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_sortMaps}
@@ -1301,10 +1301,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty lists and arrays.
- *
+ *
* <p>
* If <jk>true</jk>, empty list values will not be serialized to the output.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyCollections}
@@ -1321,10 +1321,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty lists and arrays.
- *
+ *
* <p>
* Shortcut for calling <code>trimEmptyCollections(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyCollections}
@@ -1338,10 +1338,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty maps.
- *
+ *
* <p>
* If <jk>true</jk>, empty map values will not be serialized to the output.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyMaps}
@@ -1358,10 +1358,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim empty maps.
- *
+ *
* <p>
* Shortcut for calling <code>trimEmptyMaps(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyMaps}
@@ -1375,10 +1375,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim null bean property values.
- *
+ *
* <p>
* If <jk>true</jk>, null bean values will not be serialized to the output.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimNullProperties}
@@ -1395,10 +1395,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim strings.
- *
+ *
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being serialized.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimStrings}
@@ -1415,10 +1415,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim strings.
- *
+ *
* <p>
* Shortcut for calling <code>trimStrings(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_trimStrings}
@@ -1432,10 +1432,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: URI context bean.
- *
+ *
* <p>
* Bean used for resolution of URIs to absolute or root-relative form.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriContext}
@@ -1450,10 +1450,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: URI relativity.
- *
+ *
* <p>
* Defines what relative URIs are relative to when serializing URI/URL objects.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriRelativity}
@@ -1470,10 +1470,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: URI resolution.
- *
+ *
* <p>
* Defines the resolution level for URIs when serializing URI/URL objects.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_uriResolution}
@@ -1490,10 +1490,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Use whitespace.
- *
+ *
* <p>
* If <jk>true</jk>, newlines and indentation and spaces are added to the output to improve readability.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_useWhitespace}
@@ -1510,7 +1510,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Use whitespace.
- *
+ *
* <p>
* Shortcut for calling <code>useWhitespace(<jk>true</jk>)</code>.
*
@@ -1526,10 +1526,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Use whitespace.
- *
+ *
* <p>
* Shortcut for calling <code>useWhitespace(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Serializer#SERIALIZER_useWhitespace}
@@ -1543,10 +1543,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: File charset.
- *
+ *
* <p>
* The character set to use for reading <code>Files</code> from the file system.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_fileCharset}
@@ -1563,10 +1563,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Input stream charset.
- *
+ *
* <p>
* The character set to use for converting <code>InputStreams</code> and byte arrays to readers.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_inputStreamCharset}
@@ -1583,10 +1583,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Parser listener.
- *
+ *
* <p>
* Class used to listen for errors and warnings that occur during parsing.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_listener}
@@ -1601,10 +1601,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Strict mode.
- *
+ *
* <p>
* If <jk>true</jk>, strict mode for the parser is enabled.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_strict}
@@ -1624,7 +1624,7 @@ public class RestClientBuilder extends BeanContextBuilder {
*
* <p>
* Shortcut for calling <code>strict(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_strict}
@@ -1638,11 +1638,11 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
@@ -1659,10 +1659,10 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Configuration property: Trim parsed strings.
- *
+ *
* <p>
* Shortcut for calling <code>trimStrings(<jk>true</jk>)</code>.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
@@ -1676,7 +1676,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* TODO
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UonSerializer#UON_paramFormat}
@@ -1691,7 +1691,7 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* TODO
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link UonSerializer#UON_paramFormat}
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java
index 46adfaf..83c919c 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestRequestEntity.java
@@ -32,7 +32,7 @@ public final class RestRequestEntity extends BasicHttpEntity {
/**
* Constructor.
- *
+ *
* @param input The POJO to serialize. Can also be a {@link Reader} or {@link InputStream}.
* @param serializer The serializer to use to serialize this response.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java
index 31e56af..30908fc 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RetryOn.java
@@ -16,7 +16,7 @@ import org.apache.http.*;
/**
* Used to determine whether a request should be retried based on the HTTP response code.
- *
+ *
* <p>
* Subclasses should override either the {@link #onCode(int)} method (if you only care about the HTTP status code)
* or {@link #onResponse(HttpResponse)} (if you want full access to the HTTP response object.
@@ -45,7 +45,7 @@ public abstract class RetryOn {
/**
* Subclasses should override this method to determine whether the HTTP response is retryable.
- *
+ *
* @param response The HTTP response object. May be <jk>null</jk> if a connection could not be made.
* @return <jk>true</jk> if the specified response code is retryable.
*/
@@ -55,7 +55,7 @@ public abstract class RetryOn {
/**
* Subclasses should override this method to determine whether the HTTP response is retryable.
- *
+ *
* @param httpResponseCode The HTTP response code. <code>-1</code> if a connection could not be made.
* @return <jk>true</jk> if the specified response code is retryable.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java
index e00fa48..1728c74 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SSLOpts.java
@@ -40,7 +40,7 @@ public class SSLOpts {
/**
* Constructor.
- *
+ *
* @param protocols
* A comma-delimited list of supported SSL protocols.
* If <jk>null</jk>, uses the value returned by {@link #getDefaultProtocols()}.
@@ -57,16 +57,16 @@ public class SSLOpts {
/**
* Returns the default list of SSL protocols to support when the <code>protocols</code> parameter on the constructor
* is <jk>null</jk>.
- *
+ *
* <p>
* The default value is <jk>"SSL_TLS,TLS,SSL"</js> unless overridden by one of the following system properties:
* <ul>
* <li><js>"transport.client.protocol"</js>
* </ul>
- *
+ *
* <p>
* Subclasses can override this method to provide their own logic for determining default supported protocols.
- *
+ *
* @return The comma-delimited list of supported protocols.
*/
protected String getDefaultProtocols() {
@@ -83,7 +83,7 @@ public class SSLOpts {
/**
* Bean property getter: <property>protocols</property>.
- *
+ *
* @return The value of the <property>protocols</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public String getProtocols() {
@@ -92,7 +92,7 @@ public class SSLOpts {
/**
* Bean property setter: <property>protocols</property>.
- *
+ *
* @param protocols The new value for the <property>protocols</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -103,7 +103,7 @@ public class SSLOpts {
/**
* Bean property getter: <property>certValidate</property>.
- *
+ *
* @return The value of the <property>certValidate</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public CertValidate getCertValidate() {
@@ -112,7 +112,7 @@ public class SSLOpts {
/**
* Bean property setter: <property>certValidate</property>.
- *
+ *
* @param certValidate The new value for the <property>certValidate</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -123,7 +123,7 @@ public class SSLOpts {
/**
* Bean property getter: <property>hostVerify</property>.
- *
+ *
* @return The value of the <property>hostVerify</property> property on this bean, or <jk>null</jk> if it is not set.
*/
public HostVerify getHostVerify() {
@@ -132,7 +132,7 @@ public class SSLOpts {
/**
* Bean property setter: <property>hostVerify</property>.
- *
+ *
* @param hostVerify The new value for the <property>hostVerify</property> property on this bean.
* @return This object (for method chaining).
*/
@@ -148,7 +148,7 @@ public class SSLOpts {
/**
* Certificate validation options.
- *
+ *
* <p>
* Used as enum for {@link SSLOpts#getCertValidate()} property.
*/
@@ -167,7 +167,7 @@ public class SSLOpts {
/**
* Certificate host verification options.
- *
+ *
* <p>
* Used as enum for {@link SSLOpts#getHostVerify()} property.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java
index 8fbe329..0cf3796 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java
@@ -19,7 +19,7 @@ import org.apache.juneau.urlencoding.*;
/**
* Subclass of {@link NameValuePair} for serializing POJOs as URL-encoded form post entries using the
* {@link UrlEncodingSerializer class}.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* NameValuePairs params = <jk>new</jk> NameValuePairs()
@@ -35,7 +35,7 @@ public final class SerializedNameValuePair implements NameValuePair {
/**
* Constructor.
- *
+ *
* @param name The parameter name.
* @param value The POJO to serialize to the parameter value.
* @param serializer The serializer to use to convert the value to a string.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java
index d4a0671..66cd38c 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SimpleX509TrustManager.java
@@ -26,7 +26,7 @@ public final class SimpleX509TrustManager implements X509TrustManager {
/**
* Constructor.
- *
+ *
* @param lax If <jk>true</jk>, allow self-signed and expired certificates.
* @throws KeyStoreException
* @throws NoSuchAlgorithmException
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java b/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java
index c7cd4e8..1a9d20d 100644
--- a/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java
+++ b/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java
@@ -76,7 +76,7 @@ public class BaseProvider implements MessageBodyReader<Object>, MessageBodyWrite
* Returns properties defined on the specified method through the {@link RestMethod#properties() @RestMethod.properties()}
* annotation specified on the method and the {@link JuneauProvider#properties()} annotation specified on the
* provider class.
- *
+ *
* @param a All annotations defined on the method.
* @return A map of all properties define on the method.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java b/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java
index d84ecd1..fdd69d2 100644
--- a/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java
+++ b/juneau-rest/juneau-rest-server-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java
@@ -28,8 +28,9 @@ import org.apache.juneau.xml.*;
/**
* Annotations applicable to subclasses of {@link BaseProvider}.
- *
- * <h5 class='section'>Description:</h5>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
*
* Used to associate serializers, parsers, filters, and properties with instances of {@link BaseProvider}.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java
index 6d340bd..e323a0f 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java
@@ -19,7 +19,7 @@ import org.apache.juneau.rest.annotation.*;
/**
* Specialized matcher for matching client versions.
- *
+ *
* <p>
* See {@link RestResource#clientVersionHeader} and {@link RestMethod#clientVersion} for more info.
*/
@@ -30,7 +30,7 @@ public class ClientVersionMatcher extends RestMatcher {
/**
* Constructor.
- *
+ *
* @param clientVersionHeader
* The HTTP request header name containing the client version.
* If <jk>null</jk> or an empty string, uses <js>"X-Client-Version"</js>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/HtmlDocBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/HtmlDocBuilder.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/HtmlDocBuilder.java
index 54ebb1b..ce1731e 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/HtmlDocBuilder.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/HtmlDocBuilder.java
@@ -25,11 +25,11 @@ import org.apache.juneau.utils.*;
/**
* Programmatic interface for setting properties used by the HtmlDoc serializer.
- *
+ *
* <p>
* Basically just a convenience wrapper around the servlet or method level properties for setting properties defined
* by the {@link HtmlDocSerializer} class.
- *
+ *
* <p>
* This class is instantiated through the following methods.
* <ul>
@@ -74,25 +74,25 @@ public class HtmlDocBuilder {
/**
* Sets the HTML header section contents.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* The page header normally contains the title and description, but this value can be used to override the contents
* to be whatever you want.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#header() @HtmlDoc.header()} annotation.
- *
+ *
* @param value
* The HTML header section contents.
* Object will be converted to a string using {@link Object#toString()}.
@@ -110,28 +110,28 @@ public class HtmlDocBuilder {
/**
* Sets the links in the HTML nav section.
- *
+ *
* <p>
* The format of this value is a lax-JSON map of key/value pairs where the keys are the link text and the values are
* relative (to the servlet) or absolute URLs.
- *
+ *
* <p>
* The page links are positioned immediately under the title and text.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This field can also use URIs of any support type in {@link UriResolver}.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#navlinks() @HtmlDoc.navlinks()} annotation.
- *
+ *
* @param value
* The HTML nav section links links.
* <p>
@@ -148,30 +148,30 @@ public class HtmlDocBuilder {
/**
* Sets the HTML nav section contents.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* The nav section of the page contains the links.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* When a value is specified, the {@link #navlinks(Object[])} value will be ignored.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#nav() @HtmlDoc.nav()} annotation.
- *
+ *
* @param value
* The HTML nav section contents.
* Object will be converted to a string using {@link Object#toString()}.
@@ -189,24 +189,24 @@ public class HtmlDocBuilder {
/**
* Sets the HTML aside section contents.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* The aside section typically floats on the right side of the page.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#aside() @HtmlDoc.aside()} annotation.
- *
+ *
* @param value
* The HTML aside section contents.
* Object will be converted to a string using {@link Object#toString()}.
@@ -224,24 +224,24 @@ public class HtmlDocBuilder {
/**
* Sets the HTML footer section contents.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* The footer section typically floats on the bottom of the page.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#footer() @HtmlDoc.footer()} annotation.
- *
+ *
* @param value
* The HTML footer section contents.
* Object will be converted to a string using {@link Object#toString()}.
@@ -259,21 +259,21 @@ public class HtmlDocBuilder {
/**
* Sets the HTML CSS style section contents.
- *
+ *
* <p>
* The format of this value is CSS.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#style() @HtmlDoc.style()} annotation.
- *
+ *
* @param value
* The HTML CSS style section contents.
* Object will be converted to a string using {@link Object#toString()}.
@@ -291,24 +291,24 @@ public class HtmlDocBuilder {
/**
* Sets the CSS URL in the HTML CSS style section.
- *
+ *
* <p>
* The format of this value is a comma-delimited list of URLs.
- *
+ *
* <p>
* Specifies the URL to the stylesheet to add as a link in the style tag in the header.
- *
+ *
* <p>
* The format of this value is CSS.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>) and can use URL protocols defined
* by {@link UriResolver}.
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#stylesheet() @HtmlDoc.stylesheet()} annotation.
- *
+ *
* @param value
* The CSS URL in the HTML CSS style section.
* Object will be converted to a string using {@link Object#toString()}.
@@ -326,21 +326,21 @@ public class HtmlDocBuilder {
/**
* Sets the HTML script section contents.
- *
+ *
* <p>
* The format of this value is Javascript.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#script() @HtmlDoc.script()} annotation.
- *
+ *
* @param value
* The HTML script section contents.
* Object will be converted to a string using {@link Object#toString()}.
@@ -358,21 +358,21 @@ public class HtmlDocBuilder {
/**
* Sets the HTML head section contents.
- *
+ *
* <p>
* The format of this value is HTML.
- *
+ *
* <p>
* This field can contain variables (e.g. <js>"$L{my.localized.variable}"</js>).
* <br>See {@link RestContext#getVarResolver()} for the list of supported variables.
- *
+ *
* <p>
* A value of <js>"INHERIT"</js> means copy the values from the parent.
* <br>A value of <js>"NONE"</js> can be used to force no value.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#head() @HtmlDoc.head()} annotation.
- *
+ *
* @param value
* The HTML head section contents.
* <p>
@@ -389,10 +389,10 @@ public class HtmlDocBuilder {
/**
* Shorthand method for forcing the rendered HTML content to be no-wrap.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#nowrap() @HtmlDoc.nowrap()} annotation.
- *
+ *
* @param value The new nowrap setting.
* @return This object (for method chaining).
*/
@@ -402,11 +402,11 @@ public class HtmlDocBuilder {
/**
* Specifies the text to display when serializing an empty array or collection.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#noResultsMessage() @HtmlDoc.noResultsMessage()}
* annotation.
- *
+ *
* @param value The text to display when serializing an empty array or collection.
* @return This object (for method chaining).
*/
@@ -416,14 +416,14 @@ public class HtmlDocBuilder {
/**
* Specifies the template class to use for rendering the HTML page.
- *
+ *
* <p>
* By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom
* renderer or subclasses from the basic class to have full control over how the page is rendered.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.
- *
+ *
* @param value The HTML page template to use to render the HTML page.
* @return This object (for method chaining).
*/
@@ -433,14 +433,14 @@ public class HtmlDocBuilder {
/**
* Specifies the template class to use for rendering the HTML page.
- *
+ *
* <p>
* By default, uses {@link HtmlDocTemplateBasic} to render the contents, although you can provide your own custom
* renderer or subclasses from the basic class to have full control over how the page is rendered.
- *
+ *
* <p>
* This is the programmatic equivalent to the {@link HtmlDoc#template() @HtmlDoc.template()} annotation.
- *
+ *
* @param value The HTML page template to use to render the HTML page.
* @return This object (for method chaining).
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ReaderResource.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ReaderResource.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ReaderResource.java
index c187616..d9762f9 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ReaderResource.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/ReaderResource.java
@@ -27,7 +27,7 @@ import org.apache.juneau.svl.*;
/**
* Represents the contents of a text file with convenience methods for resolving {@link Parameter @Parameter} variables and adding
* HTTP response headers.
- *
+ *
* <p>
* This class is handled special by the {@link WritableHandler} class.
*/
@@ -40,7 +40,7 @@ public class ReaderResource implements Writable {
/**
* Constructor.
- *
+ *
* @param mediaType The HTTP media type.
* @param contents
* The contents of this resource.
@@ -59,7 +59,7 @@ public class ReaderResource implements Writable {
/**
* Constructor.
- *
+ *
* @param mediaType The resource media type.
* @param headers The HTTP response headers for this streamed resource.
* @param varSession Optional variable resolver for resolving variables in the string.
@@ -114,7 +114,7 @@ public class ReaderResource implements Writable {
/**
* Specifies the resource media type string.
- *
+ *
* @param mediaType The resource media type string.
* @return This object (for method chaining).
*/
@@ -125,7 +125,7 @@ public class ReaderResource implements Writable {
/**
* Specifies the resource media type string.
- *
+ *
* @param mediaType The resource media type string.
* @return This object (for method chaining).
*/
@@ -136,10 +136,10 @@ public class ReaderResource implements Writable {
/**
* Specifies the contents for this resource.
- *
+ *
* <p>
* This method can be called multiple times to add more content.
- *
+ *
* @param contents
* The resource contents.
* <br>If multiple contents are specified, the results will be concatenated.
@@ -159,7 +159,7 @@ public class ReaderResource implements Writable {
/**
* Specifies an HTTP response header value.
- *
+ *
* @param name The HTTP header name.
* @param value
* The HTTP header value.
@@ -173,7 +173,7 @@ public class ReaderResource implements Writable {
/**
* Specifies HTTP response header values.
- *
+ *
* @param headers
* The HTTP headers.
* Values will be converted to <code>Strings</code> using {@link Object#toString()}.
@@ -187,7 +187,7 @@ public class ReaderResource implements Writable {
/**
* Specifies the variable resolver to use for this resource.
- *
+ *
* @param varResolver The variable resolver.
* @return This object (for method chaining).
*/
@@ -198,7 +198,7 @@ public class ReaderResource implements Writable {
/**
* Create a new {@link ReaderResource} using values in this builder.
- *
+ *
* @return A new immutable {@link ReaderResource} object.
* @throws IOException
*/
@@ -209,7 +209,7 @@ public class ReaderResource implements Writable {
/**
* Get the HTTP response headers.
- *
+ *
* @return The HTTP response headers.
*/
public Map<String,String> getHeaders() {
@@ -246,10 +246,10 @@ public class ReaderResource implements Writable {
/**
* Same as {@link #toString()} but strips comments from the text before returning it.
- *
+ *
* <p>
* Supports stripping comments from the following media types: HTML, XHTML, XML, JSON, Javascript, CSS.
- *
+ *
* @return The resource contents stripped of any comments.
*/
public String toCommentStrippedString() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/Redirect.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/Redirect.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/Redirect.java
index 451f2c7..6f50c27 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/Redirect.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/Redirect.java
@@ -21,26 +21,26 @@ import org.apache.juneau.urlencoding.*;
/**
* REST methods can return this object as a shortcut for performing <code>HTTP 302</code> redirects.
- *
+ *
* <p>
* The following example shows the difference between handling redirects via the {@link RestRequest}/{@link RestResponse},
* and the simplified approach of using this class.
* <p class='bcode'>
* <jc>// Redirect to "/contextPath/servletPath/foobar"</jc>
- *
+ *
* <jc>// Using RestRequest and RestResponse</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/example1"</js>)
* <jk>public void</jk> example1(RestRequest req, RestResponse res) <jk>throws</jk> IOException {
* res.sendRedirect(req.getServletURI() + <js>"/foobar"</js>);
* }
- *
+ *
* <jc>// Using Redirect</jc>
* <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/example2"</js>)
* <jk>public</jk> Redirect example2() {
* <jk>return new</jk> Redirect(<js>"foobar"</js>);
* }
* </p>
- *
+ *
* <p>
* The constructor can use a {@link MessageFormat}-style pattern with multiple arguments:
* <p class='bcode'>
@@ -49,12 +49,12 @@ import org.apache.juneau.urlencoding.*;
* <jk>return new</jk> Redirect(<js>"foo/{0}/bar/{1}"</js>, id1, id2);
* }
* </p>
- *
+ *
* <p>
* The arguments are serialized to strings using the servlet's {@link UrlEncodingSerializer}, so any filters defined on
* the serializer or REST method/class will be used when present.
* The arguments will also be automatically URL-encoded.
- *
+ *
* <p>
* Redirecting to the servlet root can be accomplished by simply using the no-arg constructor.
* <p class='bcode'>
@@ -65,7 +65,7 @@ import org.apache.juneau.urlencoding.*;
* <jk>return new</jk> Redirect();
* }
* </p>
- *
+ *
* <p>
* This class is handled by {@link org.apache.juneau.rest.response.RedirectHandler}, a built-in default response
* handler created in {@link RestContextBuilder}.
@@ -77,10 +77,10 @@ public final class Redirect {
/**
* Redirect to the specified URL.
- *
+ *
* <p>
* Relative paths are interpreted as relative to the servlet path.
- *
+ *
* @param uri
* The URL to redirect to.
* <br>Can be any of the following:
@@ -97,10 +97,10 @@ public final class Redirect {
/**
* Convenience method for redirecting to instance of {@link URL} and {@link URI}.
- *
+ *
* <p>
* Same as calling <code>toString()</code> on the object and using the other constructor.
- *
+ *
* @param uri
* The URL to redirect to.
* <br>Can be any of the following:
@@ -116,10 +116,10 @@ public final class Redirect {
/**
* Redirect to the specified URL.
- *
+ *
* <p>
* Relative paths are interpreted as relative to the servlet path.
- *
+ *
* @param httpResponseCode The HTTP response code.
* @param url
* The URL to redirect to.
@@ -147,7 +147,7 @@ public final class Redirect {
/**
* Returns the response code passed in through the constructor.
- *
+ *
* @return The response code passed in through the constructor, or <code>0</code> if response code wasn't specified.
*/
public int getHttpResponseCode() {
@@ -156,7 +156,7 @@ public final class Redirect {
/**
* Returns the URI to redirect to.
- *
+ *
* @return The URI to redirect to.
*/
public URI getURI() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestBody.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestBody.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestBody.java
index 03b1251..51117b0 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestBody.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestBody.java
@@ -84,11 +84,11 @@ public class RequestBody {
/**
* Reads the input from the HTTP request as JSON, XML, or HTML and converts the input to a POJO.
- *
+ *
* <p>
* If {@code allowHeaderParams} init parameter is <jk>true</jk>, then first looks for {@code &body=xxx} in the URL
* query string.
- *
+ *
* <p>
* If type is <jk>null</jk> or <code>Object.<jk>class</jk></code>, then the actual type will be determined
* automatically based on the following input:
@@ -131,29 +131,29 @@ public class RequestBody {
* <td><jk>null</jk></td>
* </tr>
* </table>
- *
+ *
* <p>
* Refer to <a class="doclink" href="../../../../overview-summary.html#juneau-marshall.PojoCategories">POJO Categories</a> for
* a complete definition of supported POJOs.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into an integer.</jc>
* <jk>int</jk> body = req.getBody().asType(<jk>int</jk>.<jk>class</jk>);
- *
+ *
* <jc>// Parse into an int array.</jc>
* <jk>int</jk>[] body = req.getBody().asType(<jk>int</jk>[].<jk>class</jk>);
* <jc>// Parse into a bean.</jc>
* MyBean body = req.getBody().asType(MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of objects.</jc>
* List body = req.getBody().asType(LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of object keys/values.</jc>
* Map body = req.getBody().asType(TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* @param type The class type to instantiate.
* @param <T> The class type to instantiate.
* @return The input parsed to a POJO.
@@ -168,22 +168,22 @@ public class RequestBody {
/**
* Reads the input from the HTTP request as JSON, XML, or HTML and converts the input to a POJO.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into a linked-list of strings.</jc>
* List<String> body = req.getBody().asType(LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of linked-lists of strings.</jc>
* List<List<String>> body = req.getBody().asType(LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of string keys/values.</jc>
* Map<String,String> body = req.getBody().asType(TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map containing string keys and values of lists containing beans.</jc>
* Map<String,List<MyBean>> body = req.getBody().asType(TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);
* </p>
- *
+ *
* @param type
* The type of object to create.
* <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
@@ -202,11 +202,11 @@ public class RequestBody {
/**
* Returns the HTTP body content as a plain string.
- *
+ *
* <p>
* If {@code allowHeaderParams} init parameter is true, then first looks for {@code &body=xxx} in the URL query
* string.
- *
+ *
* @return The incoming input from the connection as a plain string.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -218,7 +218,7 @@ public class RequestBody {
/**
* Returns the HTTP body content as a simple hexadecimal character string.
- *
+ *
* @return The incoming input from the connection as a plain string.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -230,7 +230,7 @@ public class RequestBody {
/**
* Returns the HTTP body content as a simple space-delimited hexadecimal character string.
- *
+ *
* @return The incoming input from the connection as a plain string.
* @throws IOException If a problem occurred trying to read from the reader.
*/
@@ -242,14 +242,14 @@ public class RequestBody {
/**
* Returns the HTTP body content as a {@link Reader}.
- *
+ *
* <p>
* If {@code allowHeaderParams} init parameter is true, then first looks for {@code &body=xxx} in the URL query
* string.
- *
+ *
* <p>
* Automatically handles GZipped input streams.
- *
+ *
* @return The body contents as a reader.
* @throws IOException
*/
@@ -264,7 +264,7 @@ public class RequestBody {
/**
* Same as {@link #getReader()}, but doesn't encapsulate the result in a {@link BufferedReader};
- *
+ *
* @return An unbuffered reader.
* @throws IOException
*/
@@ -276,10 +276,10 @@ public class RequestBody {
/**
* Returns the HTTP body content as an {@link InputStream}.
- *
+ *
* <p>
* Automatically handles GZipped input streams.
- *
+ *
* @return The negotiated input stream.
* @throws IOException If any error occurred while trying to get the input stream or wrap it in the GZIP wrapper.
*/
@@ -298,7 +298,7 @@ public class RequestBody {
/**
* Returns the parser and media type matching the request <code>Content-Type</code> header.
- *
+ *
* @return
* The parser matching the request <code>Content-Type</code> header, or <jk>null</jk> if no matching parser was
* found.
@@ -317,7 +317,7 @@ public class RequestBody {
/**
* Returns the parser matching the request <code>Content-Type</code> header.
- *
+ *
* @return
* The parser matching the request <code>Content-Type</code> header, or <jk>null</jk> if no matching parser was
* found.
@@ -329,7 +329,7 @@ public class RequestBody {
/**
* Returns the reader parser matching the request <code>Content-Type</code> header.
- *
+ *
* @return
* The reader parser matching the request <code>Content-Type</code> header, or <jk>null</jk> if no matching
* reader parser was found, or the matching parser was an input stream parser.
@@ -410,7 +410,7 @@ public class RequestBody {
/**
* Returns the content length of the body.
- *
+ *
* @return The content length of the body in bytes.
*/
public int getContentLength() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java
index 4549870..0fda7cb 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RequestFormData.java
@@ -45,10 +45,10 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Adds default entries to these form-data parameters.
- *
+ *
* <p>
* This includes the default form-data parameters defined on the servlet and method levels.
- *
+ *
* @param defaultEntries The default entries. Can be <jk>null</jk>.
* @return This object (for method chaining).
*/
@@ -67,7 +67,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Sets a request form data parameter value.
- *
+ *
* @param name The parameter name.
* @param value The parameter value.
*/
@@ -77,10 +77,10 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Returns a form data parameter value.
- *
+ *
* <p>
* Parameter lookup is case-insensitive (consistent with WAS, but differs from Tomcat).
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Calling this method on URL-Encoded FORM posts causes the body content to be loaded and parsed by the
@@ -95,7 +95,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
* <li><js>"foo~~bar"</js> => <js>"foo~bar"</js>
* </ul>
* </ul>
- *
+ *
* @param name The form data parameter name.
* @return The parameter value, or <jk>null</jk> if parameter does not exist.
*/
@@ -115,7 +115,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getString(String)} except returns a default value if <jk>null</jk> or empty.
- *
+ *
* @param name The form data parameter name.
* @param def The default value.
* @return The parameter value, or the default value if parameter does not exist or is <jk>null</jk> or empty.
@@ -127,7 +127,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getString(String)} but converts the value to an integer.
- *
+ *
* @param name The form data parameter name.
* @return The parameter value, or <code>0</code> if parameter does not exist or is <jk>null</jk> or empty.
*/
@@ -137,7 +137,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getString(String,String)} but converts the value to an integer.
- *
+ *
* @param name The form data parameter name.
* @param def The default value.
* @return The parameter value, or the default value if parameter does not exist or is <jk>null</jk> or empty.
@@ -149,7 +149,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getString(String)} but converts the value to a boolean.
- *
+ *
* @param name The form data parameter name.
* @return The parameter value, or <jk>false</jk> if parameter does not exist or is <jk>null</jk> or empty.
*/
@@ -159,7 +159,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getString(String,String)} but converts the value to a boolean.
- *
+ *
* @param name The form data parameter name.
* @param def The default value.
* @return The parameter value, or the default value if parameter does not exist or is <jk>null</jk> or empty.
@@ -172,31 +172,31 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Returns the specified form data parameter value converted to a POJO using the {@link HttpPartParser}
* registered with this servlet.
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into an integer.</jc>
* <jk>int</jk> myparam = req.getFormDataParameter(<js>"myparam"</js>, <jk>int</jk>.<jk>class</jk>);
- *
+ *
* <jc>// Parse into an int array.</jc>
* <jk>int</jk>[] myparam = req.getFormDataParameter(<js>"myparam"</js>, <jk>int</jk>[].<jk>class</jk>);
* <jc>// Parse into a bean.</jc>
* MyBean myparam = req.getFormDataParameter(<js>"myparam"</js>, MyBean.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of objects.</jc>
* List myparam = req.getFormDataParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of object keys/values.</jc>
* Map myparam = req.getFormDataParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>);
* </p>
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Calling this method on URL-Encoded FORM posts causes the body content to be loaded and parsed by the
* underlying servlet API.
* </ul>
- *
+ *
* @param name The parameter name.
* @param type The class type to convert the parameter value to.
* @param <T> The class type to convert the parameter value to.
@@ -209,7 +209,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Object, Class)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -225,7 +225,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Class)} except returns a default value if not specified.
- *
+ *
* @param name The parameter name.
* @param def The default value if the parameter was not specified or is <jk>null</jk>.
* @param type The class type to convert the parameter value to.
@@ -239,7 +239,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Object, Class)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -257,10 +257,10 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Class)} except for use on multi-part parameters
* (e.g. <js>"key=1&key=2&key=3"</js> instead of <js>"key=(1,2,3)"</js>)
- *
+ *
* <p>
* This method must only be called when parsing into classes of type Collection or array.
- *
+ *
* @param name The parameter name.
* @param type The class type to convert the parameter value to.
* @return The parameter value converted to the specified class type.
@@ -272,10 +272,10 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getAll(String, Class)} but allows you to override the part parser.
- *
+ *
* <p>
* This method must only be called when parsing into classes of type Collection or array.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -291,29 +291,29 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Returns the specified form data parameter value converted to a POJO using the {@link HttpPartParser}
* registered with this servlet.
- *
+ *
* <h5 class='section'>Notes:</h5>
* <ul>
* <li>Calling this method on URL-Encoded FORM posts causes the body content to be loaded and parsed by the
* underlying servlet API.
* <li>Use this method if you want to parse into a parameterized <code>Map</code>/<code>Collection</code> object.
* </ul>
- *
+ *
* <h5 class='section'>Examples:</h5>
* <p class='bcode'>
* <jc>// Parse into a linked-list of strings.</jc>
* List<String> myparam = req.getFormDataParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a linked-list of linked-lists of strings.</jc>
* List<List<String>> myparam = req.getFormDataParameter(<js>"myparam"</js>, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map of string keys/values.</jc>
* Map<String,String> myparam = req.getFormDataParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
- *
+ *
* <jc>// Parse into a map containing string keys and values of lists containing beans.</jc>
* Map<String,List<MyBean>> myparam = req.getFormDataParameter(<js>"myparam"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);
* </p>
- *
+ *
* @param name The parameter name.
* @param type
* The type of object to create.
@@ -333,7 +333,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Type, Type...)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -357,10 +357,10 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #get(String, Type, Type...)} except for use on multi-part parameters
* (e.g. <js>"key=1&key=2&key=3"</js> instead of <js>"key=(1,2,3)"</js>)
- *
+ *
* <p>
* This method must only be called when parsing into classes of type Collection or array.
- *
+ *
* @param name The parameter name.
* @param type
* The type of object to create.
@@ -380,7 +380,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Same as {@link #getAll(String, Type, Type...)} but allows you to override the part parser.
- *
+ *
* @param parser
* The parser to use for parsing the string value.
* <br>If <jk>null</jk>, uses the part parser defined on the servlet/method.
@@ -459,7 +459,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> {
/**
* Converts the form data parameters to a readable string.
- *
+ *
* @param sorted Sort the form data parameters by name.
* @return A JSON string containing the contents of the form data parameters.
*/