You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/02/24 22:15:25 UTC
[2/9] incubator-juneau git commit: Clean up javadocs
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletContext.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletContext.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletContext.java
index b8a3797..1ea0340 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletContext.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletContext.java
@@ -23,14 +23,14 @@ import org.apache.juneau.serializer.*;
/**
* Configurable properties on the {@link RestServlet} class.
* <p>
- * Properties can be set on the {@link RestServlet} class using the {@link RestResource#properties} or {@link RestMethod#properties} annotations.
+ * Properties can be set on the {@link RestServlet} class using the {@link RestResource#properties} or {@link RestMethod#properties} annotations.
* <p>
- * These properties can also be passed in as servlet init parameters or system properties.
+ * These properties can also be passed in as servlet init parameters or system properties.
* <p>
- * Some of these properties are only applicable on the servlet class, and others can be specified on the servlet class or method.<br>
- * These distinctions are noted below.
+ * Some of these properties are only applicable on the servlet class, and others can be specified on the servlet class or method.<br>
+ * These distinctions are noted below.
* <p>
- * See {@link ContextFactory} for more information about context properties.
+ * See {@link ContextFactory} for more information about context properties.
*/
public final class RestServletContext extends Context {
@@ -43,14 +43,14 @@ public final class RestServletContext extends Context {
* <li><b>Default:</b> <jk>true</jk>
* </ul>
* <p>
- * When enabled, headers such as <js>"Accept"</js> and <js>"Content-Type"</js> to be passed in as URL query parameters.
- * For example: <js>"?Accept=text/json&Content-Type=text/json"</js>
+ * When enabled, headers such as <js>"Accept"</js> and <js>"Content-Type"</js> to be passed in as URL query parameters.
+ * For example: <js>"?Accept=text/json&Content-Type=text/json"</js>
* <p>
- * Parameter names are case-insensitive.
+ * Parameter names are case-insensitive.
* <p>
- * Useful for debugging REST interface using only a browser.
+ * Useful for debugging REST interface using only a browser.
* <p>
- * Applicable to servlet class only.
+ * Applicable to servlet class only.
*/
public static final String REST_allowHeaderParams = "RestServlet.allowHeaderParams";
@@ -63,20 +63,20 @@ public final class RestServletContext extends Context {
* <li><b>Default:</b> <js>""</js>
* </ul>
* <p>
- * When specified, the HTTP method can be overridden by passing in a <js>"method"</js> URL parameter on a regular GET request.
- * For example: <js>"?method=OPTIONS"</js>
+ * When specified, the HTTP method can be overridden by passing in a <js>"method"</js> URL parameter on a regular GET request.
+ * For example: <js>"?method=OPTIONS"</js>
* <p>
- * Format is a comma-delimited list of HTTP method names that can be passed in as a method parameter.
- * Parameter name is case-insensitive.
- * Use "*" to represent all methods.
- * For backwards compatibility, "true" also means "*".
+ * Format is a comma-delimited list of HTTP method names that can be passed in as a method parameter.
+ * Parameter name is case-insensitive.
+ * Use "*" to represent all methods.
+ * For backwards compatibility, "true" also means "*".
* <p>
- * Note that per the <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html">HTTP specification</a>, special care should
+ * Note that per the <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html">HTTP specification</a>, special care should
* be taken when allowing non-safe (POST, PUT, DELETE) methods to be invoked through GET requests.
* <p>
- * Applicable to servlet class only.
+ * Applicable to servlet class only.
* <p>
- * Example: <js>"HEAD,OPTIONS"</js>
+ * Example: <js>"HEAD,OPTIONS"</js>
*/
public static final String REST_allowMethodParam = "RestServlet.allowMethodParam";
@@ -89,14 +89,14 @@ public final class RestServletContext extends Context {
* <li><b>Default:</b> <jk>true</jk>
* </ul>
* <p>
- * When enabled, the HTTP body content on PUT and POST requests can be passed in as text using the <js>"body"</js> URL parameter.
- * For example: <js>"?body={name:'John%20Smith',age:45}"</js>
+ * When enabled, the HTTP body content on PUT and POST requests can be passed in as text using the <js>"body"</js> URL parameter.
+ * For example: <js>"?body={name:'John%20Smith',age:45}"</js>
* <p>
- * Parameter name is case-insensitive.
+ * Parameter name is case-insensitive.
* <p>
- * Useful for debugging PUT and POST methods using only a browser.
+ * Useful for debugging PUT and POST methods using only a browser.
* <p>
- * Applicable to servlet class only.
+ * Applicable to servlet class only.
*/
public static final String REST_allowBodyParam = "RestServlet.allowBodyParam";
@@ -109,12 +109,12 @@ public final class RestServletContext extends Context {
* <li><b>Default:</b> <jk>false</jk>
* </ul>
* <p>
- * Render stack traces in HTTP response bodies when errors occur.
+ * Render stack traces in HTTP response bodies when errors occur.
* <p>
- * When enabled, Java stack traces will be rendered in the output response.
- * Useful for debugging, although allowing stack traces to be rendered may cause security concerns.
+ * When enabled, Java stack traces will be rendered in the output response.
+ * Useful for debugging, although allowing stack traces to be rendered may cause security concerns.
* <p>
- * Applicable to servlet class only.
+ * Applicable to servlet class only.
*/
public static final String REST_renderResponseStackTraces = "RestServlet.renderResponseStackTraces";
@@ -127,10 +127,10 @@ public final class RestServletContext extends Context {
* <li><b>Default:</b> <jk>true</jk>
* </ul>
* <p>
- * When enabled, the number of times an exception has occurred will be determined based on stack trace hashsums,
+ * 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>
- * Applicable to servlet class only.
+ * Applicable to servlet class only.
*/
public static final String REST_useStackTraceHashes = "RestServlet.useStackTraceHashes";
@@ -143,9 +143,9 @@ public final class RestServletContext extends Context {
* <li><b>Default:</b> <js>"utf-8"</js>
* </ul>
* <p>
- * The default character encoding for the request and response if not specified on the request.
+ * The default character encoding for the request and response if not specified on the request.
* <p>
- * Applicable to servlet class and methods.
+ * Applicable to servlet class and methods.
*/
public static final String REST_defaultCharset = "RestServlet.defaultCharset";
@@ -158,22 +158,22 @@ public final class RestServletContext extends Context {
* <li><b>Default:</b> <js>"UON"</js>
* </ul>
* <p>
- * Possible values:
+ * Possible values:
* <ul class='spaced-list'>
* <li><js>"UON"</js> - URL-Encoded Object Notation.<br>
- * This notation allows for request parameters to contain arbitrarily complex POJOs.
+ * This notation allows for request parameters to contain arbitrarily complex POJOs.
* <li><js>"PLAIN"</js> - Plain text.<br>
- * This treats request parameters as plain text.<br>
- * Only POJOs directly convertable from <l>Strings</l> can be represented in parameters when using this mode.
+ * This treats request parameters as plain text.<br>
+ * Only POJOs directly convertable from <l>Strings</l> can be represented in parameters when using this mode.
* </ul>
* <p>
- * Note that the parameter value <js>"(foo)"</js> is interpreted as <js>"(foo)"</js> when using plain mode, but
+ * Note that the parameter value <js>"(foo)"</js> is interpreted as <js>"(foo)"</js> when using plain mode, but
* <js>"foo"</js> when using UON mode.
* <p>
- * The format can also be specified per-parameter using the {@link FormData#format() @FormData.format()} and {@link Query#format() @Query.format()}
+ * The format can also be specified per-parameter using the {@link FormData#format() @FormData.format()} and {@link Query#format() @Query.format()}
* annotations.
* <p>
- * Applicable to servlet class and methods.
+ * Applicable to servlet class and methods.
*/
public static final String REST_paramFormat = "RestServlet.paramFormat";
@@ -184,94 +184,94 @@ public final class RestServletContext extends Context {
/**
* The request servlet path.
* <p>
- * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
+ * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
* and are therefore available through {@link SerializerSession#getProperties()} and {@link ParserSession#getProperties()}.
* <p>
- * Equivalent to the value returned by {@link RestRequest#getServletPath()}
+ * Equivalent to the value returned by {@link RestRequest#getServletPath()}
*/
public static final String REST_servletPath = "RestServlet.servletPath";
/**
* The request servlet URI.
* <p>
- * Equivalent to the value returned by {@link RestRequest#getServletURI()}
+ * Equivalent to the value returned by {@link RestRequest#getServletURI()}
*/
public static final String REST_servletURI = "RestServlet.servletURI";
/**
* The request servlet URI.
* <p>
- * Equivalent to the value returned by {@link RestRequest#getRelativeServletURI()}
+ * Equivalent to the value returned by {@link RestRequest#getRelativeServletURI()}
*/
public static final String REST_relativeServletURI = "RestServlet.relativeServletURI";
/**
* The request URI path info.
* <p>
- * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
+ * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
* and are therefore available through {@link SerializerSession#getProperties()} and {@link ParserSession#getProperties()}.
* <p>
- * Equivalent to the value returned by {@link RestRequest#getPathInfo()}
+ * Equivalent to the value returned by {@link RestRequest#getPathInfo()}
*/
public static final String REST_pathInfo = "RestServlet.pathInfo";
/**
* The request URI.
* <p>
- * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
+ * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
* and are therefore available through {@link SerializerSession#getProperties()} and {@link ParserSession#getProperties()}.
* <p>
- * Equivalent to the value returned by {@link RestRequest#getRequestURI()}
+ * Equivalent to the value returned by {@link RestRequest#getRequestURI()}
*/
public static final String REST_requestURI = "RestServlet.requestURI";
/**
* The request method.
* <p>
- * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
+ * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
* and are therefore available through {@link SerializerSession#getProperties()} and {@link ParserSession#getProperties()}.
* <p>
- * Equivalent to the value returned by {@link RestRequest#getMethod()}
+ * Equivalent to the value returned by {@link RestRequest#getMethod()}
*/
public static final String REST_method = "RestServlet.method";
/**
* The localized servlet title.
* <p>
- * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
+ * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
* and are therefore available through {@link SerializerSession#getProperties()} and {@link ParserSession#getProperties()}.
* <p>
- * Equivalent to the value returned by {@link RestRequest#getServletTitle()}
+ * Equivalent to the value returned by {@link RestRequest#getServletTitle()}
*/
public static final String REST_servletTitle = "RestServlet.servletTitle";
/**
* The localized servlet description.
* <p>
- * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
+ * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
* and are therefore available through {@link SerializerSession#getProperties()} and {@link ParserSession#getProperties()}.
* <p>
- * Equivalent to the value returned by {@link RestRequest#getServletDescription()}
+ * Equivalent to the value returned by {@link RestRequest#getServletDescription()}
*/
public static final String REST_servletDescription = "RestServlet.servletDescription";
/**
* The localized method summary.
* <p>
- * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
+ * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
* and are therefore available through {@link SerializerSession#getProperties()} and {@link ParserSession#getProperties()}.
* <p>
- * Equivalent to the value returned by {@link RestRequest#getMethodSummary()}
+ * Equivalent to the value returned by {@link RestRequest#getMethodSummary()}
*/
public static final String REST_methodSummary = "RestServlet.methodSummary";
/**
* The localized method description.
* <p>
- * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
+ * Automatically added to properties return by {@link RestServlet#createRequestProperties(org.apache.juneau.ObjectMap, RestRequest)}
* and are therefore available through {@link SerializerSession#getProperties()} and {@link ParserSession#getProperties()}.
* <p>
- * Equivalent to the value returned by {@link RestRequest#getMethodDescription()}
+ * Equivalent to the value returned by {@link RestRequest#getMethodDescription()}
*/
public static final String REST_methodDescription = "RestServlet.methodDescription";
@@ -282,7 +282,7 @@ public final class RestServletContext extends Context {
/**
* Constructor.
* <p>
- * Typically only called from {@link ContextFactory#getContext(Class)}.
+ * Typically only called from {@link ContextFactory#getContext(Class)}.
*
* @param cf The factory that created this context.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletDefault.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletDefault.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletDefault.java
index a95ae6d..12e83b7 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletDefault.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletDefault.java
@@ -29,7 +29,7 @@ import org.apache.juneau.xml.*;
/**
* Subclass of {@link RestServlet} with default serializers and parsers defined.
* <p>
- * Supports the following request <code>Accept</code> header values with the resulting response <code>Content-Type</code>:
+ * Supports the following request <code>Accept</code> header values with the resulting response <code>Content-Type</code>:
* </p>
* <table class='styled'>
* <tr>
@@ -99,7 +99,7 @@ import org.apache.juneau.xml.*;
* </tr>
* </table>
* <p>
- * Supports the following request <code>Content-Type</code> header values:
+ * Supports the following request <code>Content-Type</code> header values:
* </p>
* <table class='styled'>
* <tr>
@@ -132,22 +132,18 @@ import org.apache.juneau.xml.*;
* </tr>
* </table>
* <p>
- * It should be noted that we do NOT add {@link JavaSerializedObjectParser} to the list of parsers since this could
- * cause security issues. Use caution when using this particular parser as it could inadvertantly cause
- * code execution security holes.
- * </p>
+ * It should be noted that we do NOT add {@link JavaSerializedObjectParser} to the list of parsers since this could
+ * cause security issues. Use caution when using this particular parser as it could inadvertantly cause
+ * code execution security holes.
* <p>
- * The list of serializers and parsers can be appended to using the {@link RestResource#serializers() @RestResource.serializers()}
- * and {@link RestResource#parsers() @RestResource.parsers()} annotations on subclasses.
- * </p>
+ * The list of serializers and parsers can be appended to using the {@link RestResource#serializers() @RestResource.serializers()}
+ * and {@link RestResource#parsers() @RestResource.parsers()} annotations on subclasses.
* <p>
- * This subclass also provides a default OPTIONS page by implementing a {@link #getOptions(RestRequest)} that returns a POJO consisting
- * of beans describing the class.
- * </p>
+ * This subclass also provides a default OPTIONS page by implementing a {@link #getOptions(RestRequest)} that returns a POJO consisting
+ * of beans describing the class.
* <img class='bordered' src='doc-files/OptionsPage.png'>
* <p>
- * The OPTIONS page can be modified or augmented by overriding this method and providing your own data.
- * </p>
+ * The OPTIONS page can be modified or augmented by overriding this method and providing your own data.
*
* <h6 class='topic'>Other Notes</h6>
* <ul class='spaced-list'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletGroupDefault.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletGroupDefault.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletGroupDefault.java
index 77a95a6..872d372 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletGroupDefault.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RestServletGroupDefault.java
@@ -18,10 +18,10 @@ import org.apache.juneau.rest.labels.*;
/**
* Specialized subclass of {@link RestServletDefault} for showing "group" pages.
* <p>
- * Group pages consist of simple lists of child resource URLs and their labels.
- * They're meant to be used as jumping-off points for child resources.
+ * Group pages consist of simple lists of child resource URLs and their labels.
+ * They're meant to be used as jumping-off points for child resources.
* <p>
- * Child resources are specified using the {@link RestResource#children()} annotation.
+ * Child resources are specified using the {@link RestResource#children()} annotation.
*/
@RestResource()
public abstract class RestServletGroupDefault extends RestServletDefault {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Body.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Body.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Body.java
index f302e34..db5dcbe 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Body.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Body.java
@@ -30,7 +30,7 @@ import java.lang.annotation.*;
* }
* </p>
* <p>
- * This is functionally equivalent to the following code...
+ * This is functionally equivalent to the following code...
* </p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"POST"</js>)
@@ -40,8 +40,8 @@ import java.lang.annotation.*;
* }
* </p>
* <p>
- * {@link Reader Readers} and {@link InputStream InputStreams} can also be specified as content parameters.
- * When specified, any registered parsers are bypassed.
+ * {@link Reader Readers} and {@link InputStream InputStreams} can also be specified as content parameters.
+ * When specified, any registered parsers are bypassed.
* </p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"POST"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/FormData.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/FormData.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/FormData.java
index 1086956..055b805 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/FormData.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/FormData.java
@@ -32,7 +32,7 @@ import org.apache.juneau.rest.*;
* }
* </p>
* <p>
- * This is functionally equivalent to the following code...
+ * This is functionally equivalent to the following code...
* </p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"POST"</js>)
@@ -46,11 +46,11 @@ import org.apache.juneau.rest.*;
*
* <h6 class='topic'>Important note concerning FORM posts</h6>
* <p>
- * This annotation should not be combined with the {@link Body @Body} annotation or {@link RestRequest#getBody(Class)} method
+ * This annotation should not be combined with the {@link Body @Body} annotation or {@link RestRequest#getBody(Class)} method
* for <code>application/x-www-form-urlencoded POST</code> posts, since it will trigger the underlying servlet
* API to parse the body content as key-value pairs resulting in empty content.
* <p>
- * The {@link Query @Query} annotation can be used to retrieve a URL parameter
+ * The {@link Query @Query} annotation can be used to retrieve a URL parameter
* in the URL string without triggering the servlet to drain the body content.
*/
@Documented
@@ -67,12 +67,12 @@ public @interface FormData {
/**
* Specify <jk>true</jk> if using multi-part parameters to represent collections and arrays.
* <p>
- * Normally, we expect single parameters to be specified in UON notation for representing
- * collections of values (e.g. <js>"key=(1,2,3)"</js>.
- * This annotation allows the use of multi-part parameters to represent collections
- * (e.g. <js>"key=1&key=2&key=3"</js>.
+ * Normally, we expect single parameters to be specified in UON notation for representing
+ * collections of values (e.g. <js>"key=(1,2,3)"</js>.
+ * This annotation allows the use of multi-part parameters to represent collections
+ * (e.g. <js>"key=1&key=2&key=3"</js>.
* <p>
- * This setting should only be applied to Java parameters of type array or Collection.
+ * This setting should only be applied to Java parameters of type array or Collection.
*/
boolean multipart() default false;
@@ -82,10 +82,10 @@ public @interface FormData {
* Possible values:
* <ul class='spaced-list'>
* <li><js>"UON"</js> - URL-Encoded Object Notation.<br>
- * This notation allows for request parameters to contain arbitrarily complex POJOs.
+ * This notation allows for request parameters to contain arbitrarily complex POJOs.
* <li><js>"PLAIN"</js> - Plain text.<br>
- * This treats request parameters as plain text.<br>
- * Only POJOs directly convertable from <l>Strings</l> can be represented in parameters when using this mode.
+ * This treats request parameters as plain text.<br>
+ * Only POJOs directly convertable from <l>Strings</l> can be represented in parameters when using this mode.
* <li><js>"INHERIT"</js> (default) - Inherit from the {@link RestServletContext#REST_paramFormat} property on the servlet method or class.
* </ul>
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java
index 3a8e207..79d9ba0 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasFormData.java
@@ -23,7 +23,7 @@ import org.apache.juneau.rest.*;
* Annotation that can be applied to a parameter of a {@link RestMethod} annotated method
* to identify whether or not the request has the specified multipart form POST parameter.
* <p>
- * Note that this can be used to detect the existence of a parameter when it's not set to a particular value.
+ * Note that this can be used to detect the existence of a parameter when it's not set to a particular value.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -33,7 +33,7 @@ import org.apache.juneau.rest.*;
* }
* </p>
* <p>
- * This is functionally equivalent to the following code...
+ * This is functionally equivalent to the following code...
* </p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"POST"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java
index 0d60f43..880b1b7 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/HasQuery.java
@@ -36,7 +36,7 @@ import org.apache.juneau.rest.*;
* }
* </p>
* <p>
- * This is functionally equivalent to the following code...
+ * This is functionally equivalent to the following code...
* </p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"GET"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Header.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Header.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Header.java
index bc4cdb5..aacc510 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Header.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Header.java
@@ -29,7 +29,7 @@ import java.lang.annotation.*;
* }
* </p>
* <p>
- * This is functionally equivalent to the following code...
+ * This is functionally equivalent to the following code...
* </p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"GET"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Messages.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Messages.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Messages.java
index ae396a3..4cf84f3 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Messages.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Messages.java
@@ -24,7 +24,7 @@ import org.apache.juneau.utils.*;
* Annotation that can be applied to a parameter of a {@link RestMethod} annotated method
* to identify it as the resource bundle for the request locale.
* <p>
- * Parameter type must be either {@link ResourceBundle} or {@link MessageBundle}.
+ * Parameter type must be either {@link ResourceBundle} or {@link MessageBundle}.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -34,7 +34,7 @@ import org.apache.juneau.utils.*;
* }
* </p>
* <p>
- * This is functionally equivalent to the following code...
+ * This is functionally equivalent to the following code...
* </p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"GET"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Method.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Method.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Method.java
index fbdbe66..aab6843 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Method.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Method.java
@@ -21,7 +21,7 @@ import java.lang.annotation.*;
* Annotation that can be applied to a parameter of a {@link RestMethod} annotated method
* to identify it as the HTTP method.
* <p>
- * Typically used for HTTP method handlers of type <js>"*"</js> (i.e. handle all requests).
+ * Typically used for HTTP method handlers of type <js>"*"</js> (i.e. handle all requests).
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -31,7 +31,7 @@ import java.lang.annotation.*;
* }
* </p>
* <p>
- * This is functionally equivalent to the following code...
+ * This is functionally equivalent to the following code...
* </p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"*"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Parameter.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
index 668638a..76c7b77 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Parameter.java
@@ -88,9 +88,9 @@ public @interface Parameter {
/**
* The schema defining the type used for the body parameter.
* <p>
- * Only applicable for <code>in</code> of type <js>"body"</js>.
+ * Only applicable for <code>in</code> of type <js>"body"</js>.
* <p>
- * The schema is a JSON object specified <a class="doclink" href="http://swagger.io/specification/#schemaObject">here</a>.
+ * The schema is a JSON object specified <a class="doclink" href="http://swagger.io/specification/#schemaObject">here</a>.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Path.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Path.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Path.java
index 1333656..d9bdff9 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Path.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Path.java
@@ -30,10 +30,10 @@ import java.lang.annotation.*;
* }
* </p>
* <p>
- * The <ja>@Path</ja> annotation is optional if the parameters are specified immediately
+ * The <ja>@Path</ja> annotation is optional if the parameters are specified immediately
* following the <code>RestRequest</code> and <code>RestResponse</code> parameters,
* and are specified in the same order as the variables in the URL path pattern.
- * The following example is equivalent to the previous example.
+ * The following example is equivalent to the previous example.
* </p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/myurl/{foo}/{bar}/{baz}/*"</js>)
@@ -43,9 +43,9 @@ import java.lang.annotation.*;
* }
* </p>
* <p>
- * If the order of parameters is not the default order shown above, the
+ * If the order of parameters is not the default order shown above, the
* attribute names must be specified (since parameter names are lost during compilation).
- * The following example is equivalent to the previous example, except
+ * The following example is equivalent to the previous example, except
* the parameter order has been switched, requiring the use of the <ja>@Path</ja>
* annotations.
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java
index ea93705..95f7f51 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/PathRemainder.java
@@ -29,7 +29,7 @@ import java.lang.annotation.*;
* }
* </p>
* <p>
- * This is functionally equivalent to the following code...
+ * This is functionally equivalent to the following code...
* </p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/foo/*"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Properties.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Properties.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Properties.java
index 4957c1d..a41a24c 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Properties.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Properties.java
@@ -32,7 +32,7 @@ import org.apache.juneau.*;
* }
* </p>
* <p>
- * This is functionally equivalent to the following code...
+ * This is functionally equivalent to the following code...
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"GET"</js>)
* <jk>public Person</jk> doGetPerson(RestResponse res) {
@@ -51,7 +51,7 @@ import org.apache.juneau.*;
* }
* </p>
* <p>
- * The parameter type can be one of the following:
+ * The parameter type can be one of the following:
* <ul>
* <li>{@link ObjectMap}
* <li><code>Map<String,Object></code>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Property.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Property.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Property.java
index a4a8344..7e59b41 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Property.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Property.java
@@ -27,7 +27,7 @@ import org.apache.juneau.xml.*;
/**
* Property name/value pair used in the {@link RestResource#properties()} annotation.
* <p>
- * Any of the following property names can be specified:
+ * Any of the following property names can be specified:
* <ul>
* <li>{@link BeanContext}
* <li>{@link SerializerContext}
@@ -40,10 +40,10 @@ import org.apache.juneau.xml.*;
* <li>{@link XmlParserContext}
* </ul>
* <p>
- * Property values types that are not <code>Strings</code> will automatically be converted to the
- * correct type (e.g. <code>Boolean</code>, etc...).
+ * Property values types that are not <code>Strings</code> will automatically be converted to the
+ * correct type (e.g. <code>Boolean</code>, etc...).
* <p>
- * See {@link RestResource#properties} for more information.
+ * See {@link RestResource#properties} for more information.
*/
@Documented
@Target(ANNOTATION_TYPE)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Query.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Query.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Query.java
index 649b7cd..4bac857 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Query.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/Query.java
@@ -37,7 +37,7 @@ import org.apache.juneau.rest.*;
* }
* </p>
* <p>
- * This is functionally equivalent to the following code...
+ * This is functionally equivalent to the following code...
* </p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(name=<js>"GET"</js>)
@@ -63,12 +63,12 @@ public @interface Query {
/**
* Specify <jk>true</jk> if using multi-part parameters to represent collections and arrays.
* <p>
- * Normally, we expect single parameters to be specified in UON notation for representing
+ * Normally, we expect single parameters to be specified in UON notation for representing
* collections of values (e.g. <js>"&key=(1,2,3)"</js>.
- * This annotation allows the use of multi-part parameters to represent collections
+ * This annotation allows the use of multi-part parameters to represent collections
* (e.g. <js>"&key=1&key=2&key=3"</js>.
* <p>
- * This setting should only be applied to Java parameters of type array or Collection.
+ * This setting should only be applied to Java parameters of type array or Collection.
*/
boolean multipart() default false;
@@ -78,10 +78,10 @@ public @interface Query {
* Possible values:
* <ul class='spaced-list'>
* <li><js>"UON"</js> - URL-Encoded Object Notation.<br>
- * This notation allows for request parameters to contain arbitrarily complex POJOs.
+ * This notation allows for request parameters to contain arbitrarily complex POJOs.
* <li><js>"PLAIN"</js> - Plain text.<br>
- * This treats request parameters as plain text.<br>
- * Only POJOs directly convertable from <l>Strings</l> can be represented in parameters when using this mode.
+ * This treats request parameters as plain text.<br>
+ * Only POJOs directly convertable from <l>Strings</l> can be represented in parameters when using this mode.
* <li><js>"INHERIT"</js> (default) - Inherit from the {@link RestServletContext#REST_paramFormat} property on the servlet method or class.
* </ul>
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
----------------------------------------------------------------------
diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
index 3d1e941..6b0a991 100644
--- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
+++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestMethod.java
@@ -36,13 +36,13 @@ public @interface RestMethod {
/**
* REST method name.
* <p>
- * Typically <js>"GET"</js>, <js>"PUT"</js>, <js>"POST"</js>, <js>"DELETE"</js>, or <js>"OPTIONS"</js>.
+ * Typically <js>"GET"</js>, <js>"PUT"</js>, <js>"POST"</js>, <js>"DELETE"</js>, or <js>"OPTIONS"</js>.
* <p>
- * Can also be a non-HTTP-standard name that is passed in through a <code>&method=methodName</code> URL parameter.
+ * Can also be a non-HTTP-standard name that is passed in through a <code>&method=methodName</code> URL parameter.
* <p>
- * Method names are case-insensitive (always folded to upper-case).
+ * Method names are case-insensitive (always folded to upper-case).
* <p>
- * If a method name is not specified, then the method name is determined based on the Java method name.<br>
+ * If a method name is not specified, then the method name is determined based on the Java method name.<br>
* For example, if the method is <code>doPost(...)</code>, then the method name is automatically detected as <js>"POST"</js>.
*/
@@ -51,8 +51,8 @@ public @interface RestMethod {
/**
* Optional path pattern for the specified method.
* <p>
- * Appending <js>"/*"</js> to the end of the path pattern will make it match any remainder too.<br>
- * Not appending <js>"/*"</js> to the end of the pattern will cause a 404 (Not found) error to occur
+ * Appending <js>"/*"</js> to the end of the path pattern will make it match any remainder too.<br>
+ * Not appending <js>"/*"</js> to the end of the pattern will cause a 404 (Not found) error to occur
* if the exact pattern is not found.
*/
String path() default "/*";
@@ -60,9 +60,9 @@ public @interface RestMethod {
/**
* URL path pattern priority.
* <p>
- * To force path patterns to be checked before other path patterns, use a higher priority number.
+ * To force path patterns to be checked before other path patterns, use a higher priority number.
* <p>
- * By default, it's <code>0</code>, which means it will use an internal heuristic to
+ * By default, it's <code>0</code>, which means it will use an internal heuristic to
* determine a best match.
*/
int priority() default 0;
@@ -70,10 +70,10 @@ public @interface RestMethod {
/**
* Method guards.
* <p>
- * Associates one or more {@link RestGuard RestGuards} with a method call.
- * These guards get called immediately before execution of the REST method.
+ * Associates one or more {@link RestGuard RestGuards} with a method call.
+ * These guards get called immediately before execution of the REST method.
* <p>
- * Typically, guards will be used for permissions checking on the user making the request,
+ * 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.
*/
Class<? extends RestGuard>[] guards() default {};
@@ -81,34 +81,34 @@ public @interface RestMethod {
/**
* Method response converters.
* <p>
- * Associates one or more {@link RestConverter RestConverters} with a method call.
- * These converters get called immediately after execution of the REST method in the same
+ * Associates one or more {@link RestConverter RestConverters} with a method call.
+ * These converters get called immediately after execution of the REST method in the same
* order specified in the annotation.
* <p>
- * Can be used for performing post-processing on the response object before serialization.
+ * Can be used for performing post-processing on the response object before serialization.
* <p>
- * Default converters are available in the <a class='doclink' href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package.
+ * Default converters are available in the <a class='doclink' href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package.
*/
Class<? extends RestConverter>[] converters() default {};
/**
* Method matchers.
* <p>
- * Associates one more more {@link RestMatcher RestMatchers} with this method.
+ * Associates one more more {@link RestMatcher RestMatchers} with this method.
* <p>
- * Matchers are used to allow multiple Java methods to handle requests assigned to the same
- * URL path pattern, but differing based on some request attribute, such as a specific header value.
+ * Matchers are used to allow multiple Java methods to handle requests assigned to the same
+ * URL path pattern, but differing based on some request attribute, such as a specific header value.
* <p>
- * See {@link RestMatcher} for details.
+ * See {@link RestMatcher} for details.
*/
Class<? extends RestMatcher>[] matchers() default {};
/**
* Overrides the list of serializers assigned at the method level.
* <p>
- * Use this annotation when the list of serializers assigned to a method differs from the list of serializers assigned at the servlet level.
+ * Use this annotation when the list of serializers assigned to a method differs from the list of serializers assigned at the servlet level.
* <p>
- * To append to the list of serializers assigned at the servlet level, use <code>serializersInherit=<jsf>SERIALIZERS</jsf></code>.
+ * To append to the list of serializers assigned at the servlet level, use <code>serializersInherit=<jsf>SERIALIZERS</jsf></code>.
*
* <p class='bcode'>
* <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {
@@ -130,14 +130,14 @@ public @interface RestMethod {
/**
* Used in conjunction with {@link #serializers()} to identify what class-level settings are inherited by the method serializer group.
* <p>
- * Possible values:
+ * Possible values:
* <ul>
* <li>{@link Inherit#SERIALIZERS} - Inherit class-level serializers.
* <li>{@link Inherit#PROPERTIES} - Inherit class-level properties.
* <li>{@link Inherit#TRANSFORMS} - Inherit class-level transforms.
* </ul>
* <p>
- * For example, to inherit all serializers, properties, and transforms from the servlet class:
+ * For example, to inherit all serializers, properties, and transforms from the servlet class:
* </p>
* <p class='bcode'>
* <ja>@RestMethod</ja>(
@@ -152,9 +152,9 @@ public @interface RestMethod {
/**
* Overrides the list of parsers assigned at the method level.
* <p>
- * Use this annotation when the list of parsers assigned to a method differs from the list of parsers assigned at the servlet level.
+ * Use this annotation when the list of parsers assigned to a method differs from the list of parsers assigned at the servlet level.
* <p>
- * To append to the list of serializers assigned at the servlet level, use <code>serializersInherit=<jsf>SERIALIZERS</jsf></code>.
+ * To append to the list of serializers assigned at the servlet level, use <code>serializersInherit=<jsf>SERIALIZERS</jsf></code>.
*
* <p class='bcode'>
* <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {
@@ -176,14 +176,14 @@ public @interface RestMethod {
/**
* Used in conjunction with {@link #parsers()} to identify what class-level settings are inherited by the method parser group.
* <p>
- * Possible values:
+ * Possible values:
* <ul>
* <li>{@link Inherit#PARSERS} - Inherit class-level parsers.
* <li>{@link Inherit#PROPERTIES} - Inherit class-level properties.
* <li>{@link Inherit#TRANSFORMS} - Inherit class-level transforms.
* </ul>
* <p>
- * For example, to inherit all parsers, properties, and transforms from the servlet class:
+ * For example, to inherit all parsers, properties, and transforms from the servlet class:
* <p class='bcode'>
* <ja>@RestMethod</ja>(
* path=<js>"/foo"</js>,
@@ -197,9 +197,9 @@ public @interface RestMethod {
/**
* Appends to the list of {@link Encoder encoders} specified on the servlet.
* <p>
- * Use this annotation when the list of encoders assigned to a method differs from the list of encoders assigned at the servlet level.
+ * Use this annotation when the list of encoders assigned to a method differs from the list of encoders assigned at the servlet level.
* <p>
- * These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.
+ * These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.
*
* <p class='bcode'>
* <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {
@@ -215,7 +215,7 @@ public @interface RestMethod {
* }
* </p>
* <p>
- * If you want to OVERRIDE the set of encoders specified by the servlet, combine this annotation with <code><ja>@RestMethod</ja>(inheritEncoders=<jk>false</jk>)</code>.
+ * If you want to OVERRIDE the set of encoders specified by the servlet, combine this annotation with <code><ja>@RestMethod</ja>(inheritEncoders=<jk>false</jk>)</code>.
*/
Class<? extends Encoder>[] encoders() default {};
@@ -227,7 +227,7 @@ public @interface RestMethod {
/**
* Same as {@link RestResource#properties()}, except defines property values by default when this method is called.
* <p>
- * This is equivalent to simply calling <code>res.addProperties()</code> in the Java method, but is provided for convenience.
+ * This is equivalent to simply calling <code>res.addProperties()</code> in the Java method, but is provided for convenience.
*/
Property[] properties() default {};
@@ -244,16 +244,16 @@ public @interface RestMethod {
/**
* Specifies default values for request headers.
* <p>
- * Strings are of the format <js>"Header-Name: header-value"</js>.
+ * Strings are of the format <js>"Header-Name: header-value"</js>.
* <p>
- * Affects values returned by {@link RestRequest#getHeader(String)} when the header is not present on the request.
+ * Affects values returned by {@link RestRequest#getHeader(String)} when the header is not present on the request.
* <p>
- * The most useful reason for this annotation is to provide a default <code>Accept</code> header when one is not specified
+ * The most useful reason for this annotation is to provide a default <code>Accept</code> header when one is not specified
* so that a particular default {@link Serializer} is picked.
* <p>
- * Only one header value can be specified per entry (i.e. it's not a delimited list of header entries).
+ * Only one header value can be specified per entry (i.e. it's not a delimited list of header entries).
* <p>
- * Header values specified at the method level override header values specified at the servlet level.
+ * Header values specified at the method level override header values specified at the servlet level.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -269,47 +269,47 @@ public @interface RestMethod {
/**
* Optional summary for the exposed API.
* <p>
- * This summary is used in the following locations:
+ * This summary is used in the following locations:
* <ul class='spaced-list'>
* <li>The value returned by {@link RestRequest#getMethodSummary()}.
* <li>The <js>"$R{methodSummary}"</js> variable.
* <li>The summary of the method in the Swagger page.
* </ul>
* <p>
- * The default value pulls the description from the <code>(className.?)[javaMethodName].summary</code> entry in the servlet resource bundle.
+ * The default value pulls the description from the <code>(className.?)[javaMethodName].summary</code> entry in the servlet resource bundle.
* (e.g. <js>"MyClass.myMethod.summary = foo"</js> or <js>"myMethod.summary = foo"</js>).
* <p>
- * This field value can contain variables (e.g. "$L{my.localized.variable}").
+ * This field value can contain variables (e.g. "$L{my.localized.variable}").
* <p>
- * Corresponds to the swagger field <code>/paths/{path}/{method}/summary</code>.
+ * Corresponds to the swagger field <code>/paths/{path}/{method}/summary</code>.
*/
String summary() default "";
/**
* Optional description for the exposed API.
* <p>
- * This description is used in the following locations:
+ * This description is used in the following locations:
* <ul class='spaced-list'>
* <li>The value returned by {@link RestRequest#getMethodDescription()}.
* <li>The <js>"$R{methodDescription}"</js> variable.
* <li>The description of the method in the Swagger page.
* </ul>
* <p>
- * The default value pulls the description from the <code>(className.?)[javaMethodName].description</code> entry in the servlet resource bundle.
+ * The default value pulls the description from the <code>(className.?)[javaMethodName].description</code> entry in the servlet resource bundle.
* (e.g. <js>"MyClass.myMethod.description = foo"</js> or <js>"myMethod.description = foo"</js>).
* <p>
- * This field value can contain variables (e.g. "$L{my.localized.variable}").
+ * This field value can contain variables (e.g. "$L{my.localized.variable}").
* <p>
- * Corresponds to the swagger field <code>/paths/{path}/{method}/description</code>.
+ * Corresponds to the swagger field <code>/paths/{path}/{method}/description</code>.
*/
String description() default "";
/**
* Optional external documentation information for the exposed API.
* <p>
- * Used to populate the Swagger external documentation field.
+ * Used to populate the Swagger external documentation field.
* <p>
- * A simplified JSON string with the following fields:
+ * A simplified JSON string with the following fields:
* <p class='bcode'>
* {
* description: string,
@@ -317,7 +317,7 @@ public @interface RestMethod {
* }
* </p>
* <p>
- * The default value pulls the description from the <code>(className.?)[javaMethodName].externalDocs</code> entry in the servlet resource bundle.
+ * The default value pulls the description from the <code>(className.?)[javaMethodName].externalDocs</code> entry in the servlet resource bundle.
* (e.g. <js>"MyClass.myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js> or <js>"myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js>).
*
* <h5 class='section'>Example:</h5>
@@ -325,21 +325,21 @@ public @interface RestMethod {
* <ja>@RestMethod</ja>(externalDocs=<js>"{url:'http://juneau.apache.org'}"</js>)
* </p>
* <p>
- * This field can contain variables (e.g. "$L{my.localized.variable}").
+ * This field can contain variables (e.g. "$L{my.localized.variable}").
* <p>
- * Corresponds to the swagger field <code>/paths/{path}/{method}/externalDocs</code>.
+ * Corresponds to the swagger field <code>/paths/{path}/{method}/externalDocs</code>.
*/
String externalDocs() default "";
/**
* Optional tagging information for the exposed API.
* <p>
- * Used to populate the Swagger tags field.
+ * Used to populate the Swagger tags field.
* <p>
- * A comma-delimited list of tags for API documentation control.
- * Tags can be used for logical grouping of operations by resources or any other qualifier.
+ * A comma-delimited list of tags for API documentation control.
+ * Tags can be used for logical grouping of operations by resources or any other qualifier.
* <p>
- * The default value pulls the description from the <code>(className.?)[javaMethodName].tags</code> entry in the servlet resource bundle.
+ * The default value pulls the description from the <code>(className.?)[javaMethodName].tags</code> entry in the servlet resource bundle.
* (e.g. <js>"MyClass.myMethod.tags = foo,bar"</js> or <js>"myMethod.tags = foo,bar"</js>).
*
* <h5 class='section'>Example:</h5>
@@ -347,18 +347,18 @@ public @interface RestMethod {
* <ja>@RestMethod</ja>(tags=<js>"foo,bar"</js>)
* </p>
* <p>
- * This field can contain variables (e.g. "$L{my.localized.variable}").
+ * This field can contain variables (e.g. "$L{my.localized.variable}").
* <p>
- * Corresponds to the swagger field <code>/paths/{path}/{method}/tags</code>.
+ * Corresponds to the swagger field <code>/paths/{path}/{method}/tags</code>.
*/
String tags() default "";
/**
* Optional deprecated flag for the exposed API.
* <p>
- * Used to populate the Swagger deprecated field.
+ * Used to populate the Swagger deprecated field.
* <p>
- * The default value pulls the description from the <code>(className.?)[javaMethodName].deprecated</code> entry in the servlet resource bundle.
+ * The default value pulls the description from the <code>(className.?)[javaMethodName].deprecated</code> entry in the servlet resource bundle.
* (e.g. <js>"MyClass.myMethod.deprecated = true"</js> or <js>"myMethod.deprecated = foo,bar"</js>).
*
* <h5 class='section'>Example:</h5>
@@ -366,17 +366,17 @@ public @interface RestMethod {
* <ja>@RestMethod</ja>(deprecated=<jk>true</jk>)
* </p>
* <p>
- * This field can contain variables (e.g. "$L{my.localized.variable}").
+ * This field can contain variables (e.g. "$L{my.localized.variable}").
* <p>
- * Corresponds to the swagger field <code>/paths/{path}/{method}/deprecated</code>.
+ * Corresponds to the swagger field <code>/paths/{path}/{method}/deprecated</code>.
*/
boolean deprecated() default false;
/**
* Optional parameter descriptions.
* <p>
- * This annotation is provided for documentation purposes and is used to populate the method <js>"parameters"</js> column
- * on the Swagger page.
+ * This annotation is provided for documentation purposes and is used to populate the method <js>"parameters"</js> column
+ * on the Swagger page.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -391,7 +391,7 @@ public @interface RestMethod {
* }
* )
* </p>
- * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in this case
+ * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in this case
* the strings are internationalized.
* <p class='bcode'>
* <jk>MyClass.myMethod.description</jk> = <js>This is my method.</js>
@@ -400,20 +400,20 @@ public @interface RestMethod {
* <jk>MyClass.myMethod.req.body.description</jk> = <js>The HTTP content</js>
* <jk>MyClass.myMethod.req.header.d.description</jk> = <js>The 'D' header</js>
* <p>
- * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support English),
+ * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support English),
* and use resource bundles if you need to support localization.
* <p>
- * These annotations can contain variables (e.g. "$L{my.localized.variable}").
+ * These annotations can contain variables (e.g. "$L{my.localized.variable}").
* <p>
- * Corresponds to the swagger field <code>/paths/{path}/{method}/parameters</code>.
+ * Corresponds to the swagger field <code>/paths/{path}/{method}/parameters</code>.
*/
Parameter[] parameters() default {};
/**
* Optional output description.
* <p>
- * This annotation is provided for documentation purposes and is used to populate the method <js>"responses"</js> column
- * on the Swagger page.
+ * This annotation is provided for documentation purposes and is used to populate the method <js>"responses"</js> column
+ * on the Swagger page.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -431,32 +431,32 @@ public @interface RestMethod {
* }
* )
* </p>
- * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in this case
+ * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in this case
* the strings are internationalized.
* <p class='bcode'>
* <jk>MyClass.myMethod.res.200.description</jk> = <js>OK</js>
* <jk>MyClass.myMethod.res.302.description</jk> = <js>Thing wasn't found here</js>
* <jk>MyClass.myMethod.res.302.header.Location.description</jk> = <js>The place to find the thing</js>
* <p>
- * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support English),
+ * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support English),
* and use resource bundles if you need to support localization.
* <p>
- * These annotations can contain variables (e.g. "$L{my.localized.variable}").
+ * These annotations can contain variables (e.g. "$L{my.localized.variable}").
*/
Response[] responses() default {};
/**
* Specifies whether this method can be called based on the client version.
* <p>
- * The client version is identified via the HTTP request header identified by {@link RestResource#clientVersionHeader()} which
+ * The client version is identified via the HTTP request header identified by {@link RestResource#clientVersionHeader()} which
* by default is <js>"X-Client-Version"</js>.
* <p>
- * This is a specialized kind of {@link RestMatcher} that allows you to invoke different Java methods for the same method/path based
+ * This is a specialized kind of {@link RestMatcher} that allows you to invoke different Java methods for the same method/path based
* on the client version.
* <p>
- * The format of the client version range is similar to that of OSGi versions.
+ * The format of the client version range is similar to that of OSGi versions.
* <p>
- * In the following example, the Java methods are mapped to the same HTTP method and URL <js>"/foobar"</js>.
+ * In the following example, the Java methods are mapped to the same HTTP method and URL <js>"/foobar"</js>.
* <p class='bcode'>
* <jc>// Call this method if X-Client-Version is at least 2.0.
* // Note that this also matches 2.0.1.</jc>
@@ -478,7 +478,7 @@ public @interface RestMethod {
* }
* </p>
* <p>
- * It's common to combine the client version with transforms that will convert new POJOs into older POJOs for backwards compatability.
+ * It's common to combine the client version with transforms that will convert new POJOs into older POJOs for backwards compatability.
* <p class='bcode'>
* <jc>// Call this method if X-Client-Version is at least 2.0.</jc>
* <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/foobar"</js>, clientVersion=<js>"2.0"</js>)
@@ -492,9 +492,9 @@ public @interface RestMethod {
* <jk>return</jk> newMethod()
* }
* <p>
- * Note that in the previous example, we're returning the exact same POJO, but using a transform to convert it into an older form.
- * The old method could also just return back a completely different object.
- * The range can be any of the following:
+ * Note that in the previous example, we're returning the exact same POJO, but using a transform to convert it into an older form.
+ * The old method could also just return back a completely different object.
+ * The range can be any of the following:
* <ul>
* <li><js>"[0,1.0)"</js> = Less than 1.0. 1.0 and 1.0.0 does not match.
* <li><js>"[0,1.0]"</js> = Less than or equal to 1.0. Note that 1.0.1 will match.