Repository: incubator-juneau Updated Branches: refs/heads/master bdb982d45 -> ef1ead8e4
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestResource.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestResource.java b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestResource.java index 014d838..1061f9f 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestResource.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/annotation/RestResource.java @@ -44,17 +44,17 @@ public @interface RestResource { /** * Identifies the location of the resource bundle for this class. * <p> - * This annotation is used to provide localized messages for the following methods: + * This annotation is used to provide localized messages for the following methods: * <ul> * <li>{@link RestServlet#getMessage(java.util.Locale, String, Object...)} * <li>{@link RestServlet#getTitle(RestRequest)} * <li>{@link RestServlet#getDescription(RestRequest)} * </ul> * <p> - * Refer to the {@link MessageBundle} class for a description of the message key formats + * Refer to the {@link MessageBundle} class for a description of the message key formats * used in the properties file. * <p> - * The value can be a relative path like <js>"nls/Messages"</js>, indicating to look for the + * The value can be a relative path like <js>"nls/Messages"</js>, indicating to look for the * resource bundle <js>"com.foo.sample.nls.Messages"</js> if the resource class * is in <js>"com.foo.sample"</js>, or it can be an absolute path, like <js>"com.foo.sample.nls.Messages"</js> */ @@ -63,11 +63,11 @@ public @interface RestResource { /** * Class-level guards. * <p> - * Associates one or more {@link RestGuard RestGuards} with all REST methods defined + * Associates one or more {@link RestGuard RestGuards} with all REST methods defined * in this class. - * These guards get called immediately before execution of any REST method in this class. + * These guards get called immediately before execution of any REST method in this class. * <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 {}; @@ -75,28 +75,28 @@ public @interface RestResource { /** * Class-level converters. * <p> - * Associates one or more {@link RestConverter converters} with a resource class. - * These converters get called immediately after execution of the REST method in the same + * Associates one or more {@link RestConverter converters} with a resource class. + * 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 converter implementations are provided in the <a class='doclink' href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package. + * Default converter implementations are provided in the <a class='doclink' href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package. */ Class<? extends RestConverter>[] converters() default {}; /** * Class-level bean filters. * <p> - * Shortcut to add bean filters to the bean contexts of the objects returned by the following methods: + * Shortcut to add bean filters to the bean contexts of the objects returned by the following methods: * <ul> * <li>{@link RestServlet#getBeanContext()} * <li>{@link RestServlet#getSerializers()} * <li>{@link RestServlet#getParsers()} * </ul> * <p> - * If the specified class is an instance of {@link BeanFilterBuilder}, then a filter built from that builder is added. - * Any other classes are wrapped in a {@link InterfaceBeanFilterBuilder} to indicate that subclasses should + * If the specified class is an instance of {@link BeanFilterBuilder}, then a filter built from that builder is added. + * Any other classes are wrapped in a {@link InterfaceBeanFilterBuilder} to indicate that subclasses should * be treated as the specified class type. */ Class<?>[] beanFilters() default {}; @@ -104,29 +104,29 @@ public @interface RestResource { /** * Class-level POJO swaps. * <p> - * Shortcut to add POJO swaps to the bean contexts of the objects returned by the following methods: + * Shortcut to add POJO swaps to the bean contexts of the objects returned by the following methods: * <ul> * <li>{@link RestServlet#getBeanContext()} * <li>{@link RestServlet#getSerializers()} * <li>{@link RestServlet#getParsers()} * </ul> * <p> - * If the specified class is an instance of {@link PojoSwap}, then that swap is added. - * Any other classes are wrapped in a {@link SurrogateSwap}. + * If the specified class is an instance of {@link PojoSwap}, then that swap is added. + * Any other classes are wrapped in a {@link SurrogateSwap}. */ Class<?>[] pojoSwaps() default {}; /** * Class-level properties. * <p> - * Shortcut for specifying class-level properties on this servlet to the objects returned by the following methods: + * Shortcut for specifying class-level properties on this servlet to the objects returned by the following methods: * <ul> * <li>{@link RestServlet#getBeanContext()} * <li>{@link RestServlet#getSerializers()} * <li>{@link RestServlet#getParsers()} * </ul> * <p> - * Any of the following property names can be specified: + * Any of the following property names can be specified: * <ul> * <li>{@link RestServletContext} * <li>{@link BeanContext} @@ -140,9 +140,9 @@ public @interface RestResource { * <li>{@link XmlParserContext} * </ul> * <p> - * Property values will be converted to the appropriate type. + * Property values will be converted to the appropriate type. * <p> - * In some cases, properties can be overridden at runtime through the {@link RestResponse#setProperty(String, Object)} method + * In some cases, properties can be overridden at runtime through the {@link RestResponse#setProperty(String, Object)} method * or through a {@link Properties @Properties} annotated method parameter. */ Property[] properties() default {}; @@ -150,14 +150,14 @@ public @interface RestResource { /** * Specifies a list of {@link Serializer} classes to add to the list of serializers available for this servlet. * <p> - * This annotation can only be used on {@link Serializer} classes that have no-arg constructors. + * This annotation can only be used on {@link Serializer} classes that have no-arg constructors. */ Class<? extends Serializer>[] serializers() default {}; /** * Specifies a list of {@link Parser} classes to add to the list of parsers available for this servlet. * <p> - * This annotation can only be used on {@link Parser} classes that have no-arg constructors. + * This annotation can only be used on {@link Parser} classes that have no-arg constructors. */ Class<? extends Parser>[] parsers() default {}; @@ -166,16 +166,16 @@ public @interface RestResource { * by REST methods or set via {@link RestResponse#setOutput(Object)} into appropriate * HTTP responses. * <p> - * See {@link ResponseHandler} for details. + * See {@link ResponseHandler} for details. */ Class<? extends ResponseHandler>[] responseHandlers() default {}; /** * Specifies a list of {@link Encoder} to associate with this servlet. * <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> - * This annotation can only be used on {@link Encoder} classes that have no-arg constructors. + * This annotation can only be used on {@link Encoder} classes that have no-arg constructors. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -191,14 +191,14 @@ public @interface RestResource { /** * 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). * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -214,13 +214,13 @@ public @interface RestResource { /** * Specifies default values for response 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> - * This is equivalent to calling {@link RestResponse#setHeader(String, String)} programmatically in each of the Java methods. + * This is equivalent to calling {@link RestResponse#setHeader(String, String)} programmatically in each of the Java methods. * <p> - * The header value will not be set if the header value has already been specified (hence the 'default' in the name). + * The header value will not be set if the header value has already been specified (hence the 'default' in the name). * <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). * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -236,17 +236,17 @@ public @interface RestResource { /** * Defines children of this resource. * <p> - * A REST child resource is simply another servlet that is initialized as part of the parent + * 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. - * The main advantage to defining servlets as REST children is that you do not need + * The main advantage to defining servlets as REST children is that you do not need * to define them in the <code>web.xml</code> file of the web application. - * This can cut down on the number of entries that show up in the <code>web.xml</code> file + * This can cut down on the number of entries that show up in the <code>web.xml</code> file * if you are defining large numbers of servlets. * <p> - * Child resources must specify a value for {@link #path()} that identifies the subpath of the + * Child resources must specify a value for {@link #path()} that identifies the subpath of the * child resource relative to the parent path. * <p> - * It should be noted that servlets can be nested arbitrarily deep using this technique (i.e. children can also have children). + * It should be noted that servlets can be nested arbitrarily deep using this technique (i.e. children can also have children). * * <dl> * <dt>Servlet initialization:</dt> @@ -276,66 +276,66 @@ public @interface RestResource { /** * Identifies the URL subpath relative to the parent resource. * <p> - * Typically, this annotation is only applicable to resources defined as children through the {@link #children()} + * Typically, this annotation is only applicable to resources defined as children through the {@link #children()} * annotation. However, it may be used in other ways (e.g. defining paths for top-level resources in microservices). * <p> - * This annotation is ignored on top-level servlets (i.e. servlets defined in <code>web.xml</code> files). - * Therefore, implementers can optionally specify a path value for documentation purposes. + * This annotation is ignored on top-level servlets (i.e. servlets defined in <code>web.xml</code> files). + * Therefore, implementers can optionally specify a path value for documentation purposes. */ String path() default ""; /** * Optional servlet title. * <p> - * It is used to populate the Swagger title field and to display on HTML pages. - * This value can be retrieved programmatically through the {@link RestServlet#getTitle(RestRequest)} method. + * It is used to populate the Swagger title field and to display on HTML pages. + * This value can be retrieved programmatically through the {@link RestServlet#getTitle(RestRequest)} method. * <p> - * The default value pulls the label from the <code>label</code> entry in the servlet resource bundle. + * The default value pulls the label from the <code>label</code> entry in the servlet resource bundle. * (e.g. <js>"title = foo"</js> or <js>"MyServlet.title = foo"</js>). * <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>/info/title</code>. + * Corresponds to the swagger field <code>/info/title</code>. */ String title() default ""; /** * Optional servlet description. * <p> - * It is used to populate the Swagger description field and to display on HTML pages. - * This value can be retrieved programmatically through the {@link RestServlet#getDescription(RestRequest)} method. + * It is used to populate the Swagger description field and to display on HTML pages. + * This value can be retrieved programmatically through the {@link RestServlet#getDescription(RestRequest)} method. * <p> - * The default value pulls the description from the <code>description</code> entry in the servlet resource bundle. + * The default value pulls the description from the <code>description</code> entry in the servlet resource bundle. * (e.g. <js>"description = foo"</js> or <js>"MyServlet.description = foo"</js>). * <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>/info/description</code>. + * Corresponds to the swagger field <code>/info/description</code>. */ String description() default ""; /** * Optional servlet terms-of-service for this API. * <p> - * It is used to populate the Swagger terms-of-service field. - * This value can be retrieved programmatically through the {@link RestServlet#getTermsOfService(RestRequest)} method. + * It is used to populate the Swagger terms-of-service field. + * This value can be retrieved programmatically through the {@link RestServlet#getTermsOfService(RestRequest)} method. * <p> - * The default value pulls the description from the <code>termsOfService</code> entry in the servlet resource bundle. + * The default value pulls the description from the <code>termsOfService</code> entry in the servlet resource bundle. * (e.g. <js>"termsOfService = foo"</js> or <js>"MyServlet.termsOfService = foo"</js>). * <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>/info/termsOfService</code>. + * Corresponds to the swagger field <code>/info/termsOfService</code>. */ String termsOfService() default ""; /** * Optional contact information for the exposed API. * <p> - * It is used to populate the Swagger contact field and to display on HTML pages. - * This value can be retrieved programmatically through the {@link RestServlet#getContact(RestRequest)} method. + * It is used to populate the Swagger contact field and to display on HTML pages. + * This value can be retrieved programmatically through the {@link RestServlet#getContact(RestRequest)} method. * <p> - * A simplified JSON string with the following fields: + * A simplified JSON string with the following fields: * <p class='bcode'> * { * name: string, @@ -344,7 +344,7 @@ public @interface RestResource { * } * </p> * <p> - * The default value pulls the description from the <code>contact</code> entry in the servlet resource bundle. + * The default value pulls the description from the <code>contact</code> entry in the servlet resource bundle. * (e.g. <js>"contact = {name:'John Smith',email:'[email protected]'}"</js> or <js>"MyServlet.contact = {name:'John Smith',email:'[email protected]'}"</js>). * * <h5 class='section'>Example:</h5> @@ -352,19 +352,19 @@ public @interface RestResource { * <ja>@RestResource</ja>(contact=<js>"{name:'John Smith',email:'[email protected]'}"</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>/info/contact</code>. + * Corresponds to the swagger field <code>/info/contact</code>. */ String contact() default ""; /** * Optional license information for the exposed API. * <p> - * It is used to populate the Swagger license field and to display on HTML pages. - * This value can be retrieved programmatically through the {@link RestServlet#getLicense(RestRequest)} method. + * It is used to populate the Swagger license field and to display on HTML pages. + * This value can be retrieved programmatically through the {@link RestServlet#getLicense(RestRequest)} method. * <p> - * A simplified JSON string with the following fields: + * A simplified JSON string with the following fields: * <p class='bcode'> * { * name: string, @@ -372,7 +372,7 @@ public @interface RestResource { * } * </p> * <p> - * The default value pulls the description from the <code>license</code> entry in the servlet resource bundle. + * The default value pulls the description from the <code>license</code> entry in the servlet resource bundle. * (e.g. <js>"license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js> or <js>"MyServlet.license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>). * * <h5 class='section'>Example:</h5> @@ -380,34 +380,34 @@ public @interface RestResource { * <ja>@RestResource</ja>(license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</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>/info/license</code>. + * Corresponds to the swagger field <code>/info/license</code>. */ String license() default ""; /** * Provides the version of the application API (not to be confused with the specification version). * <p> - * It is used to populate the Swagger version field and to display on HTML pages. - * This value can be retrieved programmatically through the {@link RestServlet#getVersion(RestRequest)} method. + * It is used to populate the Swagger version field and to display on HTML pages. + * This value can be retrieved programmatically through the {@link RestServlet#getVersion(RestRequest)} method. * <p> - * The default value pulls the description from the <code>version</code> entry in the servlet resource bundle. + * The default value pulls the description from the <code>version</code> entry in the servlet resource bundle. * (e.g. <js>"version = 2.0"</js> or <js>"MyServlet.version = 2.0"</js>). * <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>/info/version</code>. + * Corresponds to the swagger field <code>/info/version</code>. */ String version() default ""; /** * Optional tagging information for the exposed API. * <p> - * It is used to populate the Swagger tags field and to display on HTML pages. - * This value can be retrieved programmatically through the {@link RestServlet#getTags(RestRequest)} method. + * It is used to populate the Swagger tags field and to display on HTML pages. + * This value can be retrieved programmatically through the {@link RestServlet#getTags(RestRequest)} method. * <p> - * A simplified JSON string with the following fields: + * A simplified JSON string with the following fields: * <p class='bcode'> * [ * { @@ -421,7 +421,7 @@ public @interface RestResource { * ] * </p> * <p> - * The default value pulls the description from the <code>tags</code> entry in the servlet resource bundle. + * The default value pulls the description from the <code>tags</code> entry in the servlet resource bundle. * (e.g. <js>"tags = [{name:'Foo',description:'Foobar'}]"</js> or <js>"MyServlet.tags = [{name:'Foo',description:'Foobar'}]"</js>). * * <h5 class='section'>Example:</h5> @@ -429,19 +429,19 @@ public @interface RestResource { * <ja>@RestResource</ja>(tags=<js>"[{name:'Foo',description:'Foobar'}]"</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>/tags</code>. + * Corresponds to the swagger field <code>/tags</code>. */ String tags() default ""; /** * Optional external documentation information for the exposed API. * <p> - * It is used to populate the Swagger external documentation field and to display on HTML pages. - * This value can be retrieved programmatically through the {@link RestServlet#getExternalDocs(RestRequest)} method. + * It is used to populate the Swagger external documentation field and to display on HTML pages. + * This value can be retrieved programmatically through the {@link RestServlet#getExternalDocs(RestRequest)} method. * <p> - * A simplified JSON string with the following fields: + * A simplified JSON string with the following fields: * <p class='bcode'> * { * description: string, @@ -449,7 +449,7 @@ public @interface RestResource { * } * </p> * <p> - * The default value pulls the description from the <code>externalDocs</code> entry in the servlet resource bundle. + * The default value pulls the description from the <code>externalDocs</code> entry in the servlet resource bundle. * (e.g. <js>"externalDocs = {url:'http://juneau.apache.org'}"</js> or <js>"MyServlet.externalDocs = {url:'http://juneau.apache.org'}"</js>). * * <h5 class='section'>Example:</h5> @@ -457,43 +457,43 @@ public @interface RestResource { * <ja>@RestResource</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>/tags</code>. + * Corresponds to the swagger field <code>/tags</code>. */ String externalDocs() default ""; /** * Optional location of configuration file for this servlet. * <p> - * The configuration file . + * The configuration file . * <p> - * This field can contain variables (e.g. "$L{my.localized.variable}"). + * This field can contain variables (e.g. "$L{my.localized.variable}"). */ String config() default ""; /** * The stylesheet to use for HTML views. * <p> - * The name is a path to a stylesheet located in either the classpath or working directory. - * The resulting stylesheet becomes available through the servlet via the URL <js>"[servletpath]/style.css"</js>. + * The name is a path to a stylesheet located in either the classpath or working directory. + * The resulting stylesheet becomes available through the servlet via the URL <js>"[servletpath]/style.css"</js>. * <p> - * The default set of styles located in the <code>org.apache.juneau.rest.styles</code> package are: - * <ul class='spaced-list'> - * <li><js>"styles/juneau.css"</js> - Theme based on Jazz look-and-feel. - * <li><js>"styles/devops.css"</js> - Theme based on IBM DevOps look-and-feel. - * </ul> + * The default set of styles located in the <code>org.apache.juneau.rest.styles</code> package are: + * <ul class='spaced-list'> + * <li><js>"styles/juneau.css"</js> - Theme based on Jazz look-and-feel. + * <li><js>"styles/devops.css"</js> - Theme based on IBM DevOps look-and-feel. + * </ul> * <p> - * The classpath search starts with the child servlet class and proceeds up the class hierarchy + * The classpath search starts with the child servlet class and proceeds up the class hierarchy * chain. Since the {@link RestServlet} class is in the <code>org.apache.juneau.rest</code> package * and the predefined styles are in the <code>org.apache.juneau.rest.styles</code> package, the paths to * the predefined styles are prefixed with <js>"styles/"</js>. * <p> - * If the stylesheet cannot be found on the classpath, an attempt to look in the working directory + * If the stylesheet cannot be found on the classpath, an attempt to look in the working directory * for it will be made. This allows for stylesheets to be placed on the file system in the working * directory. * <p> - * If the file cannot be located, the request to <js>"[servletpath]/style.css"</js> will return {@link HttpServletResponse#SC_NOT_FOUND}. + * If the file cannot be located, the request to <js>"[servletpath]/style.css"</js> will return {@link HttpServletResponse#SC_NOT_FOUND}. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -506,24 +506,24 @@ public @interface RestResource { * } * </p> * <p> - * In this example, the servlet will attempt to find the <code>mycss.css</code> file in the following ordered locations: + * In this example, the servlet will attempt to find the <code>mycss.css</code> file in the following ordered locations: * </p> * <ol> * <li><code>com.foo.mypackage.mystyles</code> package. * <li><code>org.apache.juneau.rest.mystyles</code> package (since <code>RestServletDefault</code> is in <code>org.apache.juneau.rest</code>). - * <li><code>[working-dir]/mystyles</code> directory. - * </ol> + * <li><code>[working-dir]/mystyles</code> directory. + * </ol> */ String stylesheet() default ""; /** * The favicon to use for HTML views. * <p> - * The name is a path to an icon file located in either the classpath or working directory in a similar way + * The name is a path to an icon file located in either the classpath or working directory in a similar way * to how the {@link #stylesheet()} stylesheet is resolved. - * The resulting favicon becomes available in the servlet via the URL <js>"[servletpath]/favicon.ico"</js>. + * The resulting favicon becomes available in the servlet via the URL <js>"[servletpath]/favicon.ico"</js>. * <p> - * If the file cannot be located, the request to <js>"[servletpath]/favicon.ico"</js> will return {@link HttpServletResponse#SC_NOT_FOUND}. + * If the file cannot be located, the request to <js>"[servletpath]/favicon.ico"</js> will return {@link HttpServletResponse#SC_NOT_FOUND}. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -536,7 +536,7 @@ public @interface RestResource { * } * </p> * <p> - * In this example, the servlet will attempt to find the <code>myicon.ico</code> file in the following ordered locations: + * In this example, the servlet will attempt to find the <code>myicon.ico</code> file in the following ordered locations: * </p> * <ol> * <li><code>com.foo.mypackage.mydocs</code> package. @@ -549,13 +549,13 @@ public @interface RestResource { /** * Defines paths and locations of statically served files. * <p> - * This is a JSON map of paths to packages/directories located on either the classpath or working directory. + * This is a JSON map of paths to packages/directories located on either the classpath or working directory. * <p> - * Mappings are cumulative from parent to child. Child resources can override mappings made on parent resources. + * Mappings are cumulative from parent to child. Child resources can override mappings made on parent resources. * <p> - * If the file cannot be located, the request will return {@link HttpServletResponse#SC_NOT_FOUND}. + * If the file cannot be located, the request will return {@link HttpServletResponse#SC_NOT_FOUND}. * <p> - * The media type on the response is determined by the {@link RestServlet#getMimetypesFileTypeMap()} method. + * The media type on the response is determined by the {@link RestServlet#getMimetypesFileTypeMap()} method. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -569,7 +569,7 @@ public @interface RestResource { * } * </p> * <p> - * In this example, given a GET request to <code>/myresource/htdocs/foobar.html</code>, the servlet will attempt to find the <code>foobar.html</code> file + * In this example, given a GET request to <code>/myresource/htdocs/foobar.html</code>, the servlet will attempt to find the <code>foobar.html</code> file * in the following ordered locations: * </p> * <ol> @@ -583,10 +583,10 @@ public @interface RestResource { /** * Specifies the HTTP header name used to identify the client version. * <p> - * The client version is used to support backwards compatibility for breaking REST interface + * The client version is used to support backwards compatibility for breaking REST interface * changes. Used in conjunction with {@link RestMethod#clientVersion()} annotation. * <p> - * If not specified, uses <js>"X-Client-Version"</js>. + * If not specified, uses <js>"X-Client-Version"</js>. */ String clientVersionHeader() default ""; } http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Introspectable.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Introspectable.java b/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Introspectable.java index daa556e..b4bb393 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Introspectable.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Introspectable.java @@ -22,18 +22,18 @@ import org.apache.juneau.utils.*; /** * Converter for enablement of {@link PojoIntrospector} support on response objects returned by a <code>@RestMethod</code> method. * <p> - * When enabled, public methods can be called on objects returned through the {@link RestResponse#setOutput(Object)} method. + * When enabled, public methods can be called on objects returned through the {@link RestResponse#setOutput(Object)} method. * <p> - * Note that opening up public methods for calling through a REST interface can be dangerous, and should + * Note that opening up public methods for calling through a REST interface can be dangerous, and should * be done with caution. * <p> - * Java methods are invoked by passing in the following URL parameters: + * Java methods are invoked by passing in the following URL parameters: * <ul class='spaced-list'> * <li><code>&invokeMethod</code> - The Java method name, optionally with arguments if necessary to differentiate between methods. * <li><code>&invokeArgs</code> - The arguments as a JSON array. * </ul> * <p> - * See {@link PojoIntrospector} for additional information on introspecting POJO methods. + * See {@link PojoIntrospector} for additional information on introspecting POJO methods. */ public final class Introspectable implements RestConverter { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Queryable.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Queryable.java b/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Queryable.java index 911b0b4..fee4939 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Queryable.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Queryable.java @@ -25,10 +25,10 @@ import org.apache.juneau.utils.*; /** * Converter for enablement of {@link PojoQuery} support on response objects returned by a <code>@RestMethod</code> method. * <p> - * When enabled, objects in a POJO tree can be filtered using the functionality described in the {@link PojoQuery} + * When enabled, objects in a POJO tree can be filtered using the functionality described in the {@link PojoQuery} * class. * <p> - * The following HTTP request parameters are available for tabular data (e.g. {@code Collections} of {@code Maps}, arrays of beans, etc...): + * The following HTTP request parameters are available for tabular data (e.g. {@code Collections} of {@code Maps}, arrays of beans, etc...): * <ul class='spaced-list'> * <li><b>&q=<i>JSON-object</i></b> - Query parameter. Only return rows that match the specified search string. <br> * The JSON object keys are column names, and the values are search parameter strings.<br> @@ -44,10 +44,10 @@ import org.apache.juneau.utils.*; * </ul> * * <p> - * The <b>&v</b> parameter can also be used on {@code Maps} and beans. + * The <b>&v</b> parameter can also be used on {@code Maps} and beans. * * <p> - * See {@link PojoQuery} for additional information on filtering POJO models. + * See {@link PojoQuery} for additional information on filtering POJO models. */ public final class Queryable implements RestConverter { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Traversable.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Traversable.java b/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Traversable.java index 9dfe411..f56bf15 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Traversable.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/converters/Traversable.java @@ -22,7 +22,7 @@ import org.apache.juneau.utils.*; /** * Converter for enablement of {@link PojoRest} support on response objects returned by a <code>@RestMethod</code> method. * <p> - * When enabled, objects in a POJO tree returned by the REST method can be addressed through additional URL path information. + * When enabled, objects in a POJO tree returned by the REST method can be addressed through additional URL path information. * * <p class='bcode'> * <jc>// Resource method on resource "http://localhost:8080/sample/addressBook";</jc> @@ -39,7 +39,7 @@ import org.apache.juneau.utils.*; * } * </p> * <p> - * See {@link PojoRest} for additional information on addressing elements in a POJO tree using URL notation. + * See {@link PojoRest} for additional information on addressing elements in a POJO tree using URL notation. */ public final class Traversable implements RestConverter { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaDefault.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaDefault.java b/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaDefault.java index f2d7ae5..76c7a66 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaDefault.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaDefault.java @@ -31,10 +31,10 @@ import org.apache.juneau.xml.*; /** * Subclass of {@link RestServlet} with default sets of serializers and parsers that include RDF support. * <p> - * Extends the {@link org.apache.juneau.rest.RestServletDefault} class with additional RDF support. + * Extends the {@link org.apache.juneau.rest.RestServletDefault} class with additional RDF support. * <p> * <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> @@ -134,7 +134,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> @@ -183,9 +183,8 @@ import org.apache.juneau.xml.*; * </tr> * </table> * <p> - * Note that 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> + * Note that 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. */ @RestResource( serializers={ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaGroupDefault.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaGroupDefault.java b/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaGroupDefault.java index 5ef37be..8c6e635 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaGroupDefault.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/jena/RestServletJenaGroupDefault.java @@ -19,10 +19,10 @@ import org.apache.juneau.rest.labels.*; /** * Specialized subclass of {@link RestServletJenaDefault} 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 RestServletJenaGroupDefault extends RestServletJenaDefault { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java index 08565eb..9375fc9 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/BeanDescription.java @@ -18,10 +18,10 @@ import org.apache.juneau.annotation.*; /** * Simple serializable bean description. * <p> - * Given a particular class type, this serializes the class into + * Given a particular class type, this serializes the class into * the fully-qualified class name and the properties associated with the class. * <p> - * Useful for rendering simple information about a bean during REST OPTIONS requests. + * Useful for rendering simple information about a bean during REST OPTIONS requests. */ @Bean(properties="type,properties") public final class BeanDescription { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java index 63ba284..216b34d 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ChildResourceDescriptions.java @@ -42,7 +42,7 @@ public class ChildResourceDescriptions extends LinkedList<ResourceDescription> { * @param servlet The servlet that this bean describes. * @param req The HTTP servlet request. * @param sort If <jk>true</jk>, list will be ordered by name alphabetically. - * Default is to maintain the order as specified in the annotation. + * Default is to maintain the order as specified in the annotation. */ public ChildResourceDescriptions(RestServlet servlet, RestRequest req, boolean sort) { String uri = req.getTrimmedRequestURI(); http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/labels/NameDescription.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/NameDescription.java b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/NameDescription.java index ab4f598..8a6af9d 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/NameDescription.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/NameDescription.java @@ -17,7 +17,7 @@ import org.apache.juneau.annotation.*; /** * Simple bean with {@code name} and {@code description} properties. * <p> - * Primarily used for constructing tables with name/description columns on REST OPTIONS requests. + * Primarily used for constructing tables with name/description columns on REST OPTIONS requests. */ @Bean(properties="name,description") public class NameDescription { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ResourceDescription.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ResourceDescription.java b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ResourceDescription.java index 29ea2e9..bbdf8cf 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ResourceDescription.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/labels/ResourceDescription.java @@ -33,10 +33,10 @@ public final class ResourceDescription extends NameDescription implements Compar * Constructor. * * @param rootUrl The root URI of the child resource (e.g. the URI of the parent resource). - * Must not end with <js>'/'</js>. - * Must be URL-Encoded. + * Must not end with <js>'/'</js>. + * Must be URL-Encoded. * @param name The name of the child resource. - * This will be URL-encoded and appended onto the root URL to create the hyperlink for the resource. + * This will be URL-encoded and appended onto the root URL to create the hyperlink for the resource. * @param description The description of the child resource. */ public ResourceDescription(String rootUrl, String name, String description) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-rest/src/main/java/org/apache/juneau/rest/vars/SerializedRequestAttrVar.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/SerializedRequestAttrVar.java b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/SerializedRequestAttrVar.java index f1b750d..d4c24fa 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/vars/SerializedRequestAttrVar.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/vars/SerializedRequestAttrVar.java @@ -22,13 +22,13 @@ import org.apache.juneau.svl.*; /** * Serialized request attribute variable resolver. * <p> - * The format for this var is <js>"$SA{contentType,key}"</js> or <js>"$SA{contentType,key,defaultValue}"</js>. + * The format for this var is <js>"$SA{contentType,key}"</js> or <js>"$SA{contentType,key,defaultValue}"</js>. * <p> - * This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver or a + * This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver or a * session object on the resolver session. * <p> - * Since this is a {@link SimpleVar}, any variables contained in the result will be recursively resolved. - * Likewise, if the arguments contain any variables, those will be resolved before they are passed to this var. + * Since this is a {@link SimpleVar}, any variables contained in the result will be recursively resolved. + * Likewise, if the arguments contain any variables, those will be resolved before they are passed to this var. * * @see org.apache.juneau.svl */
