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/08 02:00:51 UTC
[2/4] juneau git commit: Javadoc updates.
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/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 4803ade..03b4d97 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
@@ -183,25 +183,6 @@ public class RestClientBuilder extends BeanContextBuilder {
}
/**
- * Set a root URL for this client.
- *
- * <p>
- * When set, URL strings passed in through the various rest call methods (e.g. {@link RestClient#doGet(Object)}
- * will be prefixed with the specified root.
- * This root URL is ignored on those methods if you pass in a {@link URL}, {@link URI}, or an absolute URL string.
- *
- * @param rootUrl
- * The root URL to prefix to relative URL strings.
- * Trailing slashes are trimmed.
- * Usually a <code>String</code> but you can also pass in <code>URI</code> and <code>URL</code> objects as well.
- * @return This object (for method chaining).
- */
- public RestClientBuilder rootUrl(Object rootUrl) {
- set(RESTCLIENT_rootUri, rootUrl);
- return this;
- }
-
- /**
* Enable SSL support on this client.
*
* @param opts
@@ -242,16 +223,6 @@ public class RestClientBuilder extends BeanContextBuilder {
}
/**
- * Adds an interceptor that gets called immediately after a connection is made.
- *
- * @param interceptor The interceptor.
- * @return This object (for method chaining).
- */
- public RestClientBuilder interceptor(RestCallInterceptor interceptor) {
- return addTo(RESTCLIENT_interceptors, interceptor);
- }
-
- /**
* Adds a {@link RestCallLogger} to the list of interceptors on this class.
*
* @param level The log level to log messages at.
@@ -263,23 +234,6 @@ public class RestClientBuilder extends BeanContextBuilder {
}
/**
- * Make HTTP calls retryable if an error response (>=400) is received.
- *
- * @param retries The number of retries to attempt.
- * @param interval The time in milliseconds between attempts.
- * @param retryOn
- * Optional object used for determining whether a retry should be attempted.
- * If <jk>null</jk>, uses {@link RetryOn#DEFAULT}.
- * @return This object (for method chaining).
- */
- public RestClientBuilder retryable(int retries, int interval, RetryOn retryOn) {
- set(RESTCLIENT_retries, retries);
- set(RESTCLIENT_retryInterval, interval);
- set(RESTCLIENT_retryOn, retryOn);
- return this;
- }
-
- /**
* When called, the {@link #createConnectionManager()} method will return a {@link PoolingHttpClientConnectionManager}
* instead of a {@link BasicHttpClientConnectionManager}.
*
@@ -291,73 +245,6 @@ public class RestClientBuilder extends BeanContextBuilder {
}
/**
- * Sets the serializer used for serializing POJOs to the HTTP request message body.
- *
- * @param serializer The serializer.
- * @return This object (for method chaining).
- */
- public RestClientBuilder serializer(Serializer serializer) {
- return set(RESTCLIENT_serializer, serializer);
- }
-
- /**
- * Same as {@link #serializer(Serializer)}, except takes in a serializer class that will be instantiated through a
- * no-arg constructor.
- *
- * @param serializerClass The serializer class.
- * @return This object (for method chaining).
- */
- public RestClientBuilder serializer(Class<? extends Serializer> serializerClass) {
- return set(RESTCLIENT_serializer, serializerClass);
- }
-
- /**
- * Sets the parser used for parsing POJOs from the HTTP response message body.
- *
- * @param parser The parser.
- * @return This object (for method chaining).
- */
- public RestClientBuilder parser(Parser parser) {
- set(RESTCLIENT_parser, parser);
- return this;
- }
-
- /**
- * Same as {@link #parser(Parser)}, except takes in a parser class that will be instantiated through a no-arg
- * constructor.
- *
- * @param parserClass The parser class.
- * @return This object (for method chaining).
- */
- public RestClientBuilder parser(Class<? extends Parser> parserClass) {
- return set(RESTCLIENT_parser, parserClass);
- }
-
- /**
- * Sets the part serializer to use for converting POJOs to headers, query parameters, form-data parameters, and
- * path variables.
- *
- * @param partSerializer The part serializer instance.
- * @return This object (for method chaining).
- */
- public RestClientBuilder partSerializer(HttpPartSerializer partSerializer) {
- return set(RESTCLIENT_partSerializer, partSerializer);
- }
-
- /**
- * Sets the part formatter to use for converting POJOs to headers, query parameters, form-data parameters, and
- * path variables.
- *
- * @param partSerializerClass
- * The part serializer class.
- * The class must have a no-arg constructor.
- * @return This object (for method chaining).
- */
- public RestClientBuilder partSerializer(Class<? extends HttpPartSerializer> partSerializerClass) {
- return set(RESTCLIENT_partSerializer, partSerializerClass);
- }
-
- /**
* Set up this client to use BASIC auth.
*
* @param host The auth scope hostname.
@@ -388,32 +275,6 @@ public class RestClientBuilder extends BeanContextBuilder {
return this;
}
- /**
- * 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>
- * <li>{@link RestCall#runFuture()}
- * <li>{@link RestCall#getResponseFuture(Class)}
- * <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.
- *
- * @param executorService The executor service.
- * @param shutdownOnClose Call {@link ExecutorService#shutdown()} when {@link RestClient#close()} is called.
- * @return This object (for method chaining).
- */
- public RestClientBuilder executorService(ExecutorService executorService, boolean shutdownOnClose) {
- set(RESTCLIENT_executorService, executorService);
- set(RESTCLIENT_executorServiceShutdownOnClose, shutdownOnClose);
- return this;
- }
-
//--------------------------------------------------------------------------------
// HTTP headers
@@ -682,6 +543,20 @@ 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() {
+ return header("No-Trace", true);
+ }
+
+ /**
* Sets the value for the <code>Origin</code> request header.
*
* <p>
@@ -817,269 +692,420 @@ public class RestClientBuilder extends BeanContextBuilder {
//--------------------------------------------------------------------------------
/**
- * Sets the {@link Serializer#SERIALIZER_abridged} property on all serializers in this group.
+ * Defines the executor service to use when calling future methods on the {@link RestCall} class.
*
- * @param value The new value for this property.
+ * <p>
+ * This executor service is used to create {@link Future} objects on the following methods:
+ * <ul>
+ * <li>{@link RestCall#runFuture()}
+ * <li>{@link RestCall#getResponseFuture(Class)}
+ * <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}
+ * <li class='jf'>{@link RestClient#RESTCLIENT_executorServiceShutdownOnClose}
+ * </ul>
+ *
+ * @param executorService The executor service.
+ * @param shutdownOnClose Call {@link ExecutorService#shutdown()} when {@link RestClient#close()} is called.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_abridged
*/
- public RestClientBuilder abridged(boolean value) {
- return set(SERIALIZER_abridged, value);
+ public RestClientBuilder executorService(ExecutorService executorService, boolean shutdownOnClose) {
+ set(RESTCLIENT_executorService, executorService);
+ set(RESTCLIENT_executorServiceShutdownOnClose, shutdownOnClose);
+ return this;
}
/**
- * Sets the {@link Serializer#SERIALIZER_addBeanTypeProperties} property on all serializers in this group.
+ * Configuration property: Request headers.
*
- * @param value The new value for this property.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestClient#RESTCLIENT_headers}
+ * </ul>
+ *
+ * @param key The header name.
+ * @param value The header value.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_addBeanTypeProperties
*/
- public RestClientBuilder addBeanTypeProperties(boolean value) {
- return set(SERIALIZER_addBeanTypeProperties, value);
+ public RestClientBuilder header(String key, Object value) {
+ return addTo(RESTCLIENT_headers, key, value);
}
/**
- * Sets the {@link Serializer#SERIALIZER_detectRecursions} property on all serializers in this group.
+ * 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}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_detectRecursions
*/
- public RestClientBuilder detectRecursions(boolean value) {
- return set(SERIALIZER_detectRecursions, value);
+ public RestClientBuilder keepHttpClientOpen(boolean value) {
+ return set(RESTCLIENT_keepHttpClientOpen, value);
}
/**
- * Sets the {@link Parser#PARSER_fileCharset} property on all parsers in this group.
+ * Adds an interceptor that gets called immediately after a connection is made.
*
- * @param value The new value for this property.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestClient#RESTCLIENT_interceptors}
+ * </ul>
+ *
+ * @param interceptor The interceptor.
* @return This object (for method chaining).
- * @see Parser#PARSER_fileCharset
*/
- public RestClientBuilder fileCharset(String value) {
- return set(PARSER_fileCharset, value);
+ public RestClientBuilder interceptor(RestCallInterceptor interceptor) {
+ return addTo(RESTCLIENT_interceptors, interceptor);
}
/**
- * Configuration property: Request headers.
+ * Sets the parser used for parsing POJOs from the HTTP response message body.
*
- * @param key The header name.
- * @param value The header value.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestClient#RESTCLIENT_parser}
+ * </ul>
+ *
+ * @param parser The parser.
* @return This object (for method chaining).
- * @see RestClient#RESTCLIENT_headers
*/
- public RestClientBuilder header(String key, Object value) {
- return addTo(RESTCLIENT_headers, key, value);
+ public RestClientBuilder parser(Parser parser) {
+ return set(RESTCLIENT_parser, parser);
}
/**
- * Sets the {@link Serializer#SERIALIZER_ignoreRecursions} property on all serializers in this group.
+ * Same as {@link #parser(Parser)}, except takes in a parser class that will be instantiated through a no-arg
+ * constructor.
*
- * @param value The new value for this property.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestClient#RESTCLIENT_parser}
+ * </ul>
+ *
+ * @param parserClass The parser class.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_ignoreRecursions
*/
- public RestClientBuilder ignoreRecursions(boolean value) {
- return set(SERIALIZER_ignoreRecursions, value);
+ public RestClientBuilder parser(Class<? extends Parser> parserClass) {
+ return set(RESTCLIENT_parser, parserClass);
}
/**
- * Sets the {@link Serializer#SERIALIZER_initialDepth} property on all serializers in this group.
+ * Sets the part serializer to use for converting POJOs to headers, query parameters, form-data parameters, and
+ * path variables.
*
- * @param value The new value for this property.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestClient#RESTCLIENT_partSerializer}
+ * </ul>
+ *
+ * @param partSerializer The part serializer instance.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_initialDepth
*/
- public RestClientBuilder initialDepth(int value) {
- return set(SERIALIZER_initialDepth, value);
+ public RestClientBuilder partSerializer(HttpPartSerializer partSerializer) {
+ return set(RESTCLIENT_partSerializer, partSerializer);
}
/**
- * Sets the {@link Parser#PARSER_inputStreamCharset} property on all parsers in this group.
+ * Sets the part formatter to use for converting POJOs to headers, query parameters, form-data parameters, and
+ * path variables.
*
- * @param value The new value for this property.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestClient#RESTCLIENT_partSerializer}
+ * </ul>
+ *
+ * @param partSerializerClass
+ * The part serializer class.
+ * The class must have a no-arg constructor.
* @return This object (for method chaining).
- * @see Parser#PARSER_inputStreamCharset
*/
- public RestClientBuilder inputStreamCharset(String value) {
- return set(PARSER_inputStreamCharset, value);
+ public RestClientBuilder partSerializer(Class<? extends HttpPartSerializer> partSerializerClass) {
+ return set(RESTCLIENT_partSerializer, partSerializerClass);
}
/**
- * Configuration property: Keep HttpClient open.
+ * 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}
+ * <li class='jf'>{@link RestClient#RESTCLIENT_retryInterval}
+ * <li class='jf'>{@link RestClient#RESTCLIENT_retryOn}
+ * </ul>
+ *
+ * @param retries The number of retries to attempt.
+ * @param interval The time in milliseconds between attempts.
+ * @param retryOn
+ * Optional object used for determining whether a retry should be attempted.
+ * If <jk>null</jk>, uses {@link RetryOn#DEFAULT}.
+ * @return This object (for method chaining).
+ */
+ public RestClientBuilder retryable(int retries, int interval, RetryOn retryOn) {
+ set(RESTCLIENT_retries, retries);
+ set(RESTCLIENT_retryInterval, interval);
+ set(RESTCLIENT_retryOn, retryOn);
+ return this;
+ }
+
+ /**
+ * Set a root URL for this client.
*
* <p>
- * Don't close this client when the {@link RestClient#close()} method is called.
+ * When set, URL strings passed in through the various rest call methods (e.g. {@link RestClient#doGet(Object)}
+ * will be prefixed with the specified root.
+ * 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'>Notes:</h5>
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>This is equivalent to calling <code>set(<jsf>RESTCLIENT_keepHttpClientOpen</jsf>, value)</code>.
+ * <li class='jf'>{@link RestClient#RESTCLIENT_rootUri}
* </ul>
+ *
+ * @param rootUrl
+ * The root URL to prefix to relative URL strings.
+ * Trailing slashes are trimmed.
+ * Usually a <code>String</code> but you can also pass in <code>URI</code> and <code>URL</code> objects as well.
+ * @return This object (for method chaining).
+ */
+ public RestClientBuilder rootUrl(Object rootUrl) {
+ return set(RESTCLIENT_rootUri, rootUrl);
+ }
+
+ /**
+ * Configuration property: Request query parameters.
*
- * @param value The new value for this property.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestClient#RESTCLIENT_query}
+ * </ul>
+ *
+ * @param key The query parameter name.
+ * @param value The query parameter value value.
* @return This object (for method chaining).
- * @see RestClient#RESTCLIENT_keepHttpClientOpen
*/
- public RestClientBuilder keepHttpClientOpen(boolean value) {
- return set(RESTCLIENT_keepHttpClientOpen, value);
+ public RestClientBuilder query(String key, Object value) {
+ return addTo(RESTCLIENT_query, key, value);
}
/**
- * Sets the {@link Serializer#SERIALIZER_listener} and {@link Parser#PARSER_listener} property on all
- * serializers and parsers in this group.
+ * Sets the serializer used for serializing POJOs to the HTTP request message body.
*
- * @param sl The new serializer listener.
- * @param pl The new parser listener.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestClient#RESTCLIENT_serializer}
+ * </ul>
+ *
+ * @param serializer The serializer.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_abridged
*/
- public RestClientBuilder listeners(Class<? extends SerializerListener> sl, Class<? extends ParserListener> pl) {
- set(SERIALIZER_listener, sl);
- set(PARSER_listener, pl);
- return this;
+ public RestClientBuilder serializer(Serializer serializer) {
+ return set(RESTCLIENT_serializer, serializer);
}
/**
- * Sets the {@link Serializer#SERIALIZER_maxDepth} property on all serializers in this group.
+ * Same as {@link #serializer(Serializer)}, except takes in a serializer class that will be instantiated through a
+ * no-arg constructor.
*
- * @param value The new value for this property.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestClient#RESTCLIENT_serializer}
+ * </ul>
+ *
+ * @param serializerClass The serializer class.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_maxDepth
*/
- public RestClientBuilder maxDepth(int value) {
- return set(SERIALIZER_maxDepth, value);
+ public RestClientBuilder serializer(Class<? extends Serializer> serializerClass) {
+ return set(RESTCLIENT_serializer, serializerClass);
}
/**
- * Sets the {@link Serializer#SERIALIZER_maxIndent} property on all serializers in this group.
+ * Sets the {@link Serializer#SERIALIZER_abridged} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_abridged}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_maxIndent
*/
- public RestClientBuilder maxIndent(boolean value) {
- return set(SERIALIZER_maxIndent, value);
+ public RestClientBuilder abridged(boolean value) {
+ return set(SERIALIZER_abridged, value);
}
/**
- * 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.
+ * Sets the {@link Serializer#SERIALIZER_addBeanTypeProperties} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_addBeanTypeProperties}
+ * </ul>
+ *
+ * @param value The new value for this property.
* @return This object (for method chaining).
*/
- public RestClientBuilder noTrace() {
- return header("No-Trace", true);
+ public RestClientBuilder addBeanTypeProperties(boolean value) {
+ return set(SERIALIZER_addBeanTypeProperties, value);
}
/**
- * Sets the {@link UonSerializer#UON_paramFormat} property on the URL-encoding serializers in this group.
- *
- * <p>
- * This overrides the behavior of the URL-encoding serializer to quote and escape characters in query names and
- * values that may be confused for UON notation (e.g. <js>"'(foo=123)'"</js>, <js>"'@(1,2,3)'"</js>).
+ * Sets the {@link Serializer#SERIALIZER_detectRecursions} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_detectRecursions}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see UonSerializer#UON_paramFormat
*/
- public RestClientBuilder paramFormat(String value) {
- super.set(UON_paramFormat, value);
- return this;
+ public RestClientBuilder detectRecursions(boolean value) {
+ return set(SERIALIZER_detectRecursions, value);
}
/**
- * Shortcut for calling <code>paramFormat(<js>"PLAINTEXT"</js>)</code>.
+ * Sets the {@link Serializer#SERIALIZER_ignoreRecursions} property on all serializers in this group.
*
- * <p>
- * The default behavior is to serialize part values (query parameters, form data, headers, path variables) in UON
- * notation.
- * Calling this method forces plain-text to be used instead.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_ignoreRecursions}
+ * </ul>
+ *
+ * @param value The new value for this property.
+ * @return This object (for method chaining).
+ */
+ public RestClientBuilder ignoreRecursions(boolean value) {
+ return set(SERIALIZER_ignoreRecursions, value);
+ }
+
+ /**
+ * Sets the {@link Serializer#SERIALIZER_initialDepth} property on all serializers in this group.
*
- * <p>
- * Specifically, UON notation has the following effects:
+ * <h5 class='section'>See Also:</h5>
* <ul>
- * <li>Boolean strings (<js>"true"</js>/<js>"false"</js>) and numeric values (<js>"123"</js>) will be
- * quoted (<js>"'true'"</js>, <js>"'false'"</js>, <js>"'123'"</js>.
- * <br>This allows them to be differentiated from actual boolean and numeric values.
- * <li>String such as <js>"(foo='bar')"</js> that mimic UON structures will be quoted and escaped to
- * <js>"'(foo=bar~'baz~')'"</js>.
+ * <li class='jf'>{@link Serializer#SERIALIZER_initialDepth}
* </ul>
- * <p>
- * The down-side to using plain text part serialization is that you cannot serialize arbitrary POJOs.
+ *
+ * @param value The new value for this property.
+ * @return This object (for method chaining).
+ */
+ public RestClientBuilder initialDepth(int value) {
+ return set(SERIALIZER_initialDepth, value);
+ }
+
+ /**
+ * Sets the {@link Serializer#SERIALIZER_maxDepth} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_maxDepth}
+ * </ul>
+ *
+ * @param value The new value for this property.
* @return This object (for method chaining).
*/
- public RestClientBuilder plainTextParts() {
- super.set(UON_paramFormat, "PLAINTEXT");
- return this;
+ public RestClientBuilder maxDepth(int value) {
+ return set(SERIALIZER_maxDepth, value);
}
/**
- * Configuration property: Request query parameters.
+ * Sets the {@link Serializer#SERIALIZER_maxIndent} property on all serializers in this group.
*
- * @param key The query parameter name.
- * @param value The query parameter value value.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_maxIndent}
+ * </ul>
+ *
+ * @param value The new value for this property.
* @return This object (for method chaining).
- * @see RestClient#RESTCLIENT_query
*/
- public RestClientBuilder query(String key, Object value) {
- return addTo(RESTCLIENT_query, key, value);
+ public RestClientBuilder maxIndent(boolean value) {
+ return set(SERIALIZER_maxIndent, value);
}
/**
* Sets the {@link Serializer#SERIALIZER_quoteChar} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_quoteChar}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_quoteChar
*/
public RestClientBuilder quoteChar(char value) {
return set(SERIALIZER_quoteChar, value);
}
/**
- * Sets the {@link Serializer#SERIALIZER_sortCollections} property on all serializers in this group.
+ * Sets the {@link Serializer#SERIALIZER_listener} property on all serializers in this group.
*
- * @param value The new value for this property.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_listener}
+ * </ul>
+ *
+ * @param sl The new serializer listener.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_sortCollections
*/
- public RestClientBuilder sortCollections(boolean value) {
- return set(SERIALIZER_sortCollections, value);
+ public RestClientBuilder serializerListener(Class<? extends SerializerListener> sl) {
+ return set(SERIALIZER_listener, sl);
}
/**
- * Sets the {@link Serializer#SERIALIZER_sortMaps} property on all serializers in this group.
+ * Sets the {@link Serializer#SERIALIZER_sortCollections} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_sortCollections}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_sortMaps
*/
- public RestClientBuilder sortMaps(boolean value) {
- return set(SERIALIZER_sortMaps, value);
+ public RestClientBuilder sortCollections(boolean value) {
+ return set(SERIALIZER_sortCollections, value);
}
/**
- * Sets the {@link Parser#PARSER_strict} property on all parsers in this group.
+ * Sets the {@link Serializer#SERIALIZER_sortMaps} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_sortMaps}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Parser#PARSER_strict
*/
- public RestClientBuilder strict(boolean value) {
- return set(PARSER_strict, value);
+ public RestClientBuilder sortMaps(boolean value) {
+ return set(SERIALIZER_sortMaps, value);
}
/**
* Sets the {@link Serializer#SERIALIZER_trimEmptyCollections} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyCollections}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_trimEmptyCollections
*/
public RestClientBuilder trimEmptyCollections(boolean value) {
return set(SERIALIZER_trimEmptyCollections, value);
@@ -1088,9 +1114,13 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the {@link Serializer#SERIALIZER_trimEmptyMaps} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_trimEmptyMaps}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_trimEmptyMaps
*/
public RestClientBuilder trimEmptyMaps(boolean value) {
return set(SERIALIZER_trimEmptyMaps, value);
@@ -1099,9 +1129,13 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the {@link Serializer#SERIALIZER_trimNullProperties} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_trimNullProperties}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_trimNullProperties
*/
public RestClientBuilder trimNullProperties(boolean value) {
return set(SERIALIZER_trimNullProperties, value);
@@ -1110,31 +1144,28 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the {@link Serializer#SERIALIZER_trimStrings} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_trimStrings}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_trimStrings
*/
public RestClientBuilder trimStrings(boolean value) {
return set(SERIALIZER_trimStrings, value);
}
/**
- * Sets the {@link Parser#PARSER_trimStrings} property on all parsers in this group.
- *
- * @param value The new value for this property.
- * @return This object (for method chaining).
- * @see Parser#PARSER_trimStrings
- */
- public RestClientBuilder trimStringsP(boolean value) {
- return set(PARSER_trimStrings, value);
- }
-
- /**
* Sets the {@link Serializer#SERIALIZER_uriContext} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_uriContext}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_uriContext
*/
public RestClientBuilder uriContext(UriContext value) {
return set(SERIALIZER_uriContext, value);
@@ -1143,9 +1174,13 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the {@link Serializer#SERIALIZER_uriRelativity} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_uriRelativity}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_uriRelativity
*/
public RestClientBuilder uriRelativity(UriRelativity value) {
return set(SERIALIZER_uriRelativity, value);
@@ -1154,9 +1189,13 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the {@link Serializer#SERIALIZER_uriResolution} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_uriResolution}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_uriResolution
*/
public RestClientBuilder uriResolution(UriResolution value) {
return set(SERIALIZER_uriResolution, value);
@@ -1165,13 +1204,142 @@ public class RestClientBuilder extends BeanContextBuilder {
/**
* Sets the {@link Serializer#SERIALIZER_useWhitespace} property on all serializers in this group.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_useWhitespace}
+ * </ul>
+ *
* @param value The new value for this property.
* @return This object (for method chaining).
- * @see Serializer#SERIALIZER_useWhitespace
*/
public RestClientBuilder useWhitespace(boolean value) {
return set(SERIALIZER_useWhitespace, value);
}
+
+ /**
+ * Sets the {@link Parser#PARSER_fileCharset} property on all parsers in this group.
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Parser#PARSER_fileCharset}
+ * </ul>
+ *
+ * @param value The new value for this property.
+ * @return This object (for method chaining).
+ */
+ public RestClientBuilder fileCharset(String value) {
+ return set(PARSER_fileCharset, value);
+ }
+
+ /**
+ * Sets the {@link Parser#PARSER_inputStreamCharset} property on all parsers in this group.
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Parser#PARSER_inputStreamCharset}
+ * </ul>
+ *
+ * @param value The new value for this property.
+ * @return This object (for method chaining).
+ */
+ public RestClientBuilder inputStreamCharset(String value) {
+ return set(PARSER_inputStreamCharset, value);
+ }
+
+ /**
+ * Sets the {@link Parser#PARSER_listener} property on all parsers in this group.
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Parser#PARSER_listener}
+ * </ul>
+ *
+ * @param pl The new parser listener.
+ * @return This object (for method chaining).
+ */
+ public RestClientBuilder parserListener(Class<? extends ParserListener> pl) {
+ return set(PARSER_listener, pl);
+ }
+
+ /**
+ * Sets the {@link Parser#PARSER_strict} property on all parsers in this group.
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Parser#PARSER_strict}
+ * </ul>
+ *
+ * @param value The new value for this property.
+ * @return This object (for method chaining).
+ */
+ public RestClientBuilder strict(boolean value) {
+ return set(PARSER_strict, value);
+ }
+
+ /**
+ * Sets the {@link Parser#PARSER_trimStrings} property on all parsers in this group.
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Parser#PARSER_trimStrings}
+ * </ul>
+ *
+ * @param value The new value for this property.
+ * @return This object (for method chaining).
+ */
+ public RestClientBuilder trimStringsP(boolean value) {
+ return set(PARSER_trimStrings, value);
+ }
+
+ /**
+ * Sets the {@link UonSerializer#UON_paramFormat} property on the URL-encoding serializers in this group.
+ *
+ * <p>
+ * This overrides the behavior of the URL-encoding serializer to quote and escape characters in query names and
+ * values that may be confused for UON notation (e.g. <js>"'(foo=123)'"</js>, <js>"'@(1,2,3)'"</js>).
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link UonSerializer#UON_paramFormat}
+ * </ul>
+ *
+ * @param value The new value for this property.
+ * @return This object (for method chaining).
+ */
+ public RestClientBuilder paramFormat(String value) {
+ return set(UON_paramFormat, value);
+ }
+
+ /**
+ * Shortcut for calling <code>paramFormat(<js>"PLAINTEXT"</js>)</code>.
+ *
+ * <p>
+ * The default behavior is to serialize part values (query parameters, form data, headers, path variables) in UON
+ * notation.
+ * Calling this method forces plain-text to be used instead.
+ *
+ * <p>
+ * Specifically, UON notation has the following effects:
+ * <ul>
+ * <li>Boolean strings (<js>"true"</js>/<js>"false"</js>) and numeric values (<js>"123"</js>) will be
+ * quoted (<js>"'true'"</js>, <js>"'false'"</js>, <js>"'123'"</js>.
+ * <br>This allows them to be differentiated from actual boolean and numeric values.
+ * <li>String such as <js>"(foo='bar')"</js> that mimic UON structures will be quoted and escaped to
+ * <js>"'(foo=bar~'baz~')'"</js>.
+ * </ul>
+ * <p>
+ * The down-side to using plain text part serialization is that you cannot serialize arbitrary POJOs.
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link UonSerializer#UON_paramFormat}
+ * </ul>
+ *
+ * @return This object (for method chaining).
+ */
+ public RestClientBuilder plainTextParts() {
+ return set(UON_paramFormat, "PLAINTEXT");
+ }
@Override /* BeanContextBuilder */
public RestClientBuilder beanClassVisibility(Visibility value) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java
index 3c07472..df26ff8 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestContextBuilder.java
@@ -513,9 +513,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <br>
* For example: <js>"?body=(name='John%20Smith',age=45)"</js>
*
- * <p>
- * See {@link RestContext#REST_allowBodyParam} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_allowBodyParam}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -532,9 +534,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <br>
* For example: <js>"?method=OPTIONS"</js>
*
- * <p>
- * See {@link RestContext#REST_allowedMethodParams} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_allowedMethodParams}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -550,9 +554,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* parameters.
* <br>For example: <js>"?Accept=text/json&Content-Type=text/json"</js>
*
- * <p>
- * See {@link RestContext#REST_allowHeaderParams} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_allowHeaderParams}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -567,9 +573,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* This class handles the basic lifecycle of an HTTP REST call.
* <br>Subclasses can be used to customize how these HTTP calls are handled.
*
- * <p>
- * See {@link RestContext#REST_callHandler} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_callHandler}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -583,6 +591,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #callHandler(Class)} except input is a pre-constructed instance.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_callHandler}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -600,8 +613,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* A REST child resource is simply another servlet that is initialized as part of the parent resource and has a
* servlet path directly under the parent servlet path.
*
- * <p>
- * See {@link RestContext#REST_children} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_children}
+ * </ul>
*
* @param values The values to add to this setting.
* @return This object (for method chaining).
@@ -616,6 +631,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #children(Class...)} except input is pre-constructed instances.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_children}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -632,8 +652,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* This can be used for resources that don't have a {@link RestResource#path()} annotation.
*
- * <p>
- * See {@link RestContext#REST_children} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_children}
+ * </ul>
*
* @param path The child path relative to the parent resource URI.
* @param child The child to add to this resource.
@@ -649,8 +671,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Used to retrieve localized files from the classpath.
*
- * <p>
- * See {@link RestContext#REST_classpathResourceFinder} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_classpathResourceFinder}
+ * </ul>
*
* @param value The new value for this setting.
* @return This object (for method chaining).
@@ -665,6 +689,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #classpathResourceFinder(ClasspathResourceFinder)} except input is a pre-constructed instance.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_classpathResourceFinder}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -682,9 +711,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* The client version is used to support backwards compatibility for breaking REST interface changes.
* <br>Used in conjunction with {@link RestMethod#clientVersion()} annotation.
*
- * <p>
- * See {@link RestContext#REST_clientVersionHeader} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_clientVersionHeader}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -704,9 +735,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* The net effect is that the {@link RestRequest#getContextPath()} and {@link RestRequest#getServletPath()} methods
* will return this value instead of the actual context path of the web app.
*
- * <p>
- * See {@link RestContext#REST_contextPath} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_contextPath}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -724,9 +757,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* These converters get called immediately after execution of the REST method in the same order specified in the
* annotation.
*
- * <p>
- * See {@link RestContext#REST_converters} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_converters}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -740,6 +775,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #converters(Class...)} except input is pre-constructed instances.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_converters}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -753,9 +793,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* The default character encoding for the request and response if not specified on the request.
*
- * <p>
- * See {@link RestContext#REST_defaultCharset} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_defaultCharset}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -769,9 +811,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Adds class-level default HTTP request headers to this resource.
*
- * <p>
- * See {@link RestContext#REST_defaultRequestHeaders} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_defaultRequestHeaders}
+ * </ul>
+ *
* @param headers The headers in the format <js>"Header-Name: header-value"</js>.
* @return This object (for method chaining).
* @throws RestServletException If malformed header is found.
@@ -792,6 +836,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #defaultRequestHeaders(String...)} but adds a single header name/value pair.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_defaultRequestHeaders}
+ * </ul>
+ *
* @param name The HTTP header name.
* @param value The HTTP header value.
* @return This object (for method chaining).
@@ -806,9 +855,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Specifies default values for response headers.
*
- * <p>
- * See {@link RestContext#REST_defaultResponseHeaders} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_defaultResponseHeaders}
+ * </ul>
+ *
* @param headers The headers in the format <js>"Header-Name: header-value"</js>.
* @return This object (for method chaining).
* @throws RestServletException If malformed header is found.
@@ -829,6 +880,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #defaultResponseHeaders(String...)} but adds a single header name/value pair.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_defaultResponseHeaders}
+ * </ul>
+ *
* @param name The HTTP header name.
* @param value The HTTP header value.
* @return This object (for method chaining).
@@ -843,9 +899,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.
*
- * <p>
- * See {@link RestContext#REST_encoders} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_encoders}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -859,6 +917,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #encoders(Class...)} except input a pre-constructed instances.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_encoders}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -877,9 +940,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* Typically, guards will be used for permissions checking on the user making the request, but it can also be used
* for other purposes like pre-call validation of a request.
*
- * <p>
- * See {@link RestContext#REST_guards} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_guards}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -893,6 +958,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #guards(Class...)} except input is pre-constructed instances.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_guards}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -906,9 +976,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Class used to retrieve title/description/swagger information about a resource.
*
- * <p>
- * See {@link RestContext#REST_infoProvider} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_infoProvider}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -922,6 +994,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #infoProvider(Class)} except input is a pre-constructed instance.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_infoProvider}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -935,9 +1012,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Specifies the logger to use for logging.
*
- * <p>
- * See {@link RestContext#REST_logger} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_logger}
+ * </ul>
+ *
* @param value The new value for this setting. Can be <jk>null</jk> to disable logging.
* @return This object (for method chaining).
*/
@@ -951,6 +1030,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #logger(Class)} except input is a pre-constructed instance.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_logger}
+ * </ul>
+ *
* @param value The new value for this setting. Can be <jk>null</jk> to disable logging.
* @return This object (for method chaining).
*/
@@ -965,9 +1049,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* Useful for alleviating DoS attacks by throwing an exception when too much input is received instead of resulting
* in out-of-memory errors which could affect system stability.
*
- * <p>
- * See {@link RestContext#REST_maxInput} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_maxInput}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -981,9 +1067,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Identifies the location of the resource bundle for this class.
*
- * <p>
- * See {@link RestContext#REST_messages} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_messages}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -998,6 +1086,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* Same as {@link #messages(MessageBundleLocation...)} except allows you to pass in the base class and bundle
* path separately.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_messages}
+ * </ul>
+ *
* @param baseClass
* The base class that the bundle path is relative to.
* <br>If <jk>null</jk>, assumed to be the resource class itself.
@@ -1014,6 +1107,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #messages(Class,String)} except assumes the base class is the resource class itself.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_messages}
+ * </ul>
+ *
* @param bundlePath The bundle path relative to the base class.
* @return This object (for method chaining).
*/
@@ -1027,9 +1125,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Defines MIME-type file type mappings.
*
- * <p>
- * See {@link RestContext#REST_mimeTypes} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_mimeTypes}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -1045,9 +1145,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <code>RestRequest</code>, <code>Accept</code>, <code>Reader</code>).
* This annotation allows you to provide your own resolvers for your own class types that you want resolved.
*
- * <p>
- * See {@link RestContext#REST_paramResolvers} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_paramResolvers}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -1062,6 +1164,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #paramResolvers(Class...)} except input is pre-constructed instances.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_paramResolvers}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -1075,9 +1182,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Specifies the parser listener class to use for listening to non-fatal parsing errors.
*
- * <p>
- * See {@link Parser#PARSER_listener} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Parser#PARSER_listener}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -1091,9 +1200,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Adds class-level parsers to this resource.
*
- * <p>
- * See {@link RestContext#REST_parsers} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_parsers}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -1107,6 +1218,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #parsers(Class...)} except allows you to overwrite the previous value.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_parsers}
+ * </ul>
+ *
* @param append
* If <jk>true</jk>, append to the existing list, otherwise overwrite the previous value.
* @param values The values to add to this setting.
@@ -1126,6 +1242,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* Parser instances are considered set-in-stone and do NOT inherit properties and transforms defined on the
* resource class or method.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_parsers}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -1139,9 +1260,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Specifies the {@link HttpPartParser} to use for parsing headers, query/form parameters, and URI parts.
*
- * <p>
- * See {@link RestContext#REST_partParser} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_partParser}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -1155,6 +1278,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #partParser(Class)} except input is a pre-constructed instance.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_partParser}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -1168,9 +1296,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Specifies the {@link HttpPartSerializer} to use for serializing headers, query/form parameters, and URI parts.
*
- * <p>
- * See {@link RestContext#REST_partSerializer} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_partSerializer}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -1184,6 +1314,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #partSerializer(Class)} except input is a pre-constructed instance.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_partSerializer}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -1197,9 +1332,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Identifies the URL subpath relative to the parent resource.
*
- * <p>
- * See {@link RestContext#REST_path} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_path}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -1216,9 +1353,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Render stack traces in HTTP response bodies when errors occur.
*
- * <p>
- * See {@link RestContext#REST_renderResponseStackTraces} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_renderResponseStackTraces}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -1235,9 +1374,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Can be used to provide customized resolution of REST resource class instances (e.g. resources retrieve from Spring).
*
- * <p>
- * See {@link RestContext#REST_resourceResolver} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_resourceResolver}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -1251,6 +1392,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #resourceResolver(Class)} except input is a pre-constructed instance.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_resourceResolver}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -1265,9 +1411,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* Specifies a list of {@link ResponseHandler} classes that know how to convert POJOs returned by REST methods or
* set via {@link RestResponse#setOutput(Object)} into appropriate HTTP responses.
*
- * <p>
- * See {@link RestContext#REST_responseHandlers} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_responseHandlers}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -1281,6 +1429,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #responseHandlers(Class...)} except input is pre-constructed instances.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_responseHandlers}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -1294,9 +1447,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Specifies the serializer listener class to use for listening to non-fatal serialization errors.
*
- * <p>
- * See {@link Serializer#SERIALIZER_listener} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link Serializer#SERIALIZER_listener}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -1310,9 +1465,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Adds class-level serializers to this resource.
*
- * <p>
- * See {@link RestContext#REST_serializers} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_serializers}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -1326,6 +1483,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #serializers(Class...)} except allows you to overwrite the previous value.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_serializers}
+ * </ul>
+ *
* @param append
* If <jk>true</jk>, append to the existing list, otherwise overwrite the previous value.
* @param values The values to add to this setting.
@@ -1345,6 +1507,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* Serializer instances are considered set-in-stone and do NOT inherit properties and transforms defined on the
* resource class or method.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_serializers}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -1358,8 +1525,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Used to customize the headers on responses returned for statically-served files.
*
- * <p>
- * See {@link RestContext#REST_staticFileResponseHeaders} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_staticFileResponseHeaders}
+ * </ul>
*
* @param append
* If <jk>true</jk>, append to the existing list, otherwise overwrite the previous value.
@@ -1377,6 +1546,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* Same as {@link #staticFileResponseHeaders(boolean, Map)} with append=<jk>true</jk> except headers are strings
* composed of key/value pairs.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_staticFileResponseHeaders}
+ * </ul>
+ *
* @param headers The headers in the format <js>"Header-Name: header-value"</js>.
* @return This object (for method chaining).
* @throws RestServletException If malformed header is found.
@@ -1397,6 +1571,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #staticFileResponseHeaders(String...)} except header is broken into name/value pair.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_staticFileResponseHeaders}
+ * </ul>
+ *
* @param name The HTTP header name.
* @param value The HTTP header value.
* @return This object (for method chaining).
@@ -1411,9 +1590,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Used to define paths and locations of statically-served files such as images or HTML documents.
*
- * <p>
- * See {@link RestContext#REST_staticFiles} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_staticFiles}
+ * </ul>
+ *
* @param values The values to append to this setting.
* @return This object (for method chaining).
*/
@@ -1434,6 +1615,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <li><js>"path:location:headers-json"</js> (e.g. <js>"foodocs:docs/foo:{'Cache-Control':'max-age=86400, public'}"</js>)
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_staticFiles}
+ * </ul>
+ *
* @param mappingString The static file mapping string.
* @return This object (for method chaining).
*/
@@ -1454,6 +1640,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <li><js>"path:location:headers-json"</js> (e.g. <js>"foodocs:docs/foo:{'Cache-Control':'max-age=86400, public'}"</js>)
* </ul>
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_staticFiles}
+ * </ul>
+ *
* @param baseClass
* Overrides the default class to use for retrieving the classpath resource.
* <br>If <jk>null<jk>, uses the REST resource class.
@@ -1470,6 +1661,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #staticFiles(String)} except path and location are already split values.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_staticFiles}
+ * </ul>
+ *
* @param path
* The mapped URI path.
* <br>Leading and trailing slashes are trimmed.
@@ -1488,6 +1684,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #staticFiles(String,String)} except overrides the base class for retrieving the resource.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_staticFiles}
+ * </ul>
+ *
* @param baseClass
* Overrides the default class to use for retrieving the classpath resource.
* <br>If <jk>null<jk>, uses the REST resource class.
@@ -1509,9 +1710,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Overrides the media types inferred from the serializers that identify what media types can be produced by the resource.
*
- * <p>
- * See {@link RestContext#REST_supportedAcceptTypes} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_supportedAcceptTypes}
+ * </ul>
+ *
* @param append
* If <jk>true</jk>, append to the existing list, otherwise overwrite the previous value.
* @param values The values to add to this setting.
@@ -1527,6 +1730,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #supportedAcceptTypes(boolean, String...)} except input is {@link MediaType} instances.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_supportedAcceptTypes}
+ * </ul>
+ *
* @param append
* If <jk>true</jk>, append to the existing list, otherwise overwrite the previous value.
* @param values The values to add to this setting.
@@ -1542,9 +1750,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Overrides the media types inferred from the parsers that identify what media types can be consumed by the resource.
*
- * <p>
- * See {@link RestContext#REST_supportedContentTypes} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_supportedContentTypes}
+ * </ul>
+ *
* @param append
* If <jk>true</jk>, append to the existing list, otherwise overwrite the previous value.
* @param values The values to add to this setting.
@@ -1560,6 +1770,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #supportedContentTypes(boolean, String...)} except input is {@link MediaType} instances.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_supportedContentTypes}
+ * </ul>
+ *
* @param append
* If <jk>true</jk>, append to the existing list, otherwise overwrite the previous value.
* @param values The values to add to this setting.
@@ -1576,8 +1791,10 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* When enabled, resources retrieved via {@link RestContext#getClasspathResource(String, Locale)} (and related
* methods) will be cached in memory to speed subsequent lookups.
*
- * <p>
- * See {@link RestContext#REST_useClasspathResourceCaching} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_useClasspathResourceCaching}
+ * </ul>
*
* @param value The new value for this setting.
* @return This object (for method chaining).
@@ -1593,9 +1810,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* When enabled, the number of times an exception has occurred will be determined based on stack trace hashsums,
* made available through the {@link RestException#getOccurrence()} method.
*
- * <p>
- * See {@link RestContext#REST_useStackTraceHashes} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_useStackTraceHashes}
+ * </ul>
+ *
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
@@ -1610,9 +1829,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* Defines widgets that can be used in conjunction with string variables of the form <js>"$W{name}"</js>to quickly
* generate arbitrary replacement text.
*
- * <p>
- * See {@link RestContext#REST_widgets} for more information.
- *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_widgets}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -1627,6 +1848,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #widgets(Class...)} except input is pre-constructed instances.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_widgets}
+ * </ul>
+ *
* @param values The values to add to this setting.
* @return This object (for method chaining).
*/
@@ -1640,6 +1866,11 @@ public class RestContextBuilder extends BeanContextBuilder implements ServletCon
* <p>
* Same as {@link #widgets(Widget...)} except allows you to overwrite the previous value.
*
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_widgets}
+ * </ul>
+ *
* @param append
* If <jk>true</jk>, appends to the existing list of widgets.
* <br>Otherwise, replaces the previous list.
http://git-wip-us.apache.org/repos/asf/juneau/blob/7780e6fe/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
index 765ef25..9e6c602 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
@@ -41,8 +41,10 @@ public @interface RestMethod {
/**
* Appends the specified bean filters to all serializers and parsers used by this method.
*
- * <p>
- * See {@link BeanContext#BEAN_beanFilters} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_beanFilters}
+ * </ul>
*/
Class<?>[] beanFilters() default {};
@@ -90,6 +92,11 @@ public @interface RestMethod {
* bpi={<js>"Bean1: foo"</js>,<js>"Bean2: bar,baz"</js>}
* bpi=<js>"Bean1: foo; Bean2: bar,baz"</js>
* </p>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_includeProperties}
+ * </ul>
*/
String[] bpi() default {};
@@ -136,6 +143,11 @@ public @interface RestMethod {
* bpx={<js>"Bean1: foo"</js>,<js>"Bean2: bar,baz"</js>}
* bpx=<js>"Bean1: foo; Bean2: bar,baz"</js>
* </p>
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_excludeProperties}
+ * </ul>
*/
String[] bpx() default {};
@@ -211,8 +223,10 @@ public @interface RestMethod {
* <p>
* Associates one or more {@link RestConverter converters} with this method.
*
- * <p>
- * See {@link RestContext#REST_converters} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_converters}
+ * </ul>
*/
Class<? extends RestConverter>[] converters() default {};
@@ -232,8 +246,10 @@ public @interface RestMethod {
* {@link SystemPropertiesVar $S}
* {@link SwitchVar $SW}
*
- * <p>
- * See {@link RestContext#REST_defaultCharset} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_defaultCharset}
+ * </ul>
*/
String defaultCharset() default "";
@@ -329,8 +345,12 @@ public @interface RestMethod {
* {@link SystemPropertiesVar $S}
* {@link SwitchVar $SW}
*
- * <p>
- * See {@link RestContext#REST_defaultRequestHeaders} for more information.
+ * @see RestContext#REST_defaultRequestHeaders
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_defaultRequestHeaders}
+ * </ul>
*/
String[] defaultRequestHeaders() default {};
@@ -394,8 +414,10 @@ public @interface RestMethod {
* <p>
* Use <code>inherit={<js>"ENCODERS"</js>}</code> to inherit encoders from the resource class.
*
- * <p>
- * See {@link RestContext#REST_encoders} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_encoders}
+ * </ul>
*/
Class<? extends Encoder>[] encoders() default {};
@@ -413,8 +435,10 @@ public @interface RestMethod {
* <p>
* Associates one or more {@link RestGuard RestGuards} with this method.
*
- * <p>
- * See {@link RestContext#REST_guards} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_guards}
+ * </ul>
*/
Class<? extends RestGuard>[] guards() default {};
@@ -491,8 +515,10 @@ public @interface RestMethod {
* {@link SystemPropertiesVar $S}
* {@link SwitchVar $SW}
*
- * <p>
- * See {@link RestContext#REST_maxInput} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_maxInput}
+ * </ul>
*/
String maxInput() default "";
@@ -570,8 +596,10 @@ public @interface RestMethod {
* }
* </p>
*
- * <p>
- * See {@link RestContext#REST_parsers} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_parsers}
+ * </ul>
*/
Class<? extends Parser>[] parsers() default {};
@@ -600,9 +628,11 @@ public @interface RestMethod {
/**
* Appends the specified POJO swaps to all serializers and parsers used by this method.
- *
- * <p>
- * See {@link BeanContext#BEAN_pojoSwaps} for more information.
+ *
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link BeanContext#BEAN_pojoSwaps}
+ * </ul>
*/
Class<?>[] pojoSwaps() default {};
@@ -655,8 +685,10 @@ public @interface RestMethod {
* }
* </p>
*
- * <p>
- * See {@link RestContext#REST_serializers} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_serializers}
+ * </ul>
*/
Class<? extends Serializer>[] serializers() default {};
@@ -722,8 +754,10 @@ public @interface RestMethod {
* {@link SystemPropertiesVar $S}
* {@link SwitchVar $SW}
*
- * <p>
- * See {@link RestContext#REST_supportedAcceptTypes} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_supportedAcceptTypes}
+ * </ul>
*/
String[] supportedAcceptTypes() default {};
@@ -743,8 +777,10 @@ public @interface RestMethod {
* {@link SystemPropertiesVar $S}
* {@link SwitchVar $SW}
*
- * <p>
- * See {@link RestContext#REST_supportedContentTypes} for more information.
+ * <h5 class='section'>See Also:</h5>
+ * <ul>
+ * <li class='jf'>{@link RestContext#REST_supportedContentTypes}
+ * </ul>
*/
String[] supportedContentTypes() default {};