http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java ---------------------------------------------------------------------- diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java index 4aabb8f..e4a556a 100755 --- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java +++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/Microservice.java @@ -28,13 +28,16 @@ import org.apache.juneau.utils.*; /** * Parent class for all microservices. + * * <p> * A microservice defines a simple API for starting and stopping simple Java services contained in executable jars. + * * <p> * The general command for invoking these services is... * <p class='bcode'> * java -jar mymicroservice.jar [mymicroservice.cfg] * </p> + * * <p> * Your microservice class must be specified as the <jk>Main-Class</jk> entry in the manifest file of your microservice * jar file. @@ -42,7 +45,6 @@ import org.apache.juneau.utils.*; * <h6 class='topic'>Microservice Configuration</h6> * * This class defines the following method for accessing configuration for your microservice: - * <p> * <ul class='spaced-list'> * <li> * {@link #getArgs()} - The command-line arguments passed to the jar file. @@ -56,7 +58,6 @@ import org.apache.juneau.utils.*; * * Subclasses must implement a static void main method as the entry point for the microservice. * Typically, this method will simply consist of the following... - * <p> * <p class='bcode'> * <jk>public static void</jk> main(String[] args) <jk>throws</jk> Exception { * <jk>new</jk> MyMicroservice(args).start(); @@ -66,7 +67,6 @@ import org.apache.juneau.utils.*; * <h6 class='topic'>Lifecycle Methods</h6> * * Subclasses must implement the following lifecycle methods: - * <p> * <ul class='spaced-list'> * <li> * {@link #start()} - Gets executed during startup. @@ -79,7 +79,6 @@ import org.apache.juneau.utils.*; * <h6 class='topic'>Lifecycle Listener Methods</h6> * * Subclasses can optionally implement the following event listener methods: - * <p> * <ul class='spaced-list'> * <li> * {@link #onStart()} - Gets executed before {@link #start()}. @@ -94,7 +93,6 @@ import org.apache.juneau.utils.*; * <h6 class='topic'>Other Methods</h6> * * Subclasses can optionally override the following methods to provide customized behavior: - * <p> * <ul class='spaced-list'> * <li> * {@link #createVarResolver()} - Creates the {@link VarResolver} used to resolve variables in the config file @@ -121,6 +119,7 @@ public abstract class Microservice { /** * Specifies the path of the config file for this microservice. + * * <p> * If you do not specify the config file location, we attempt to resolve it through the following methods: * <ol> @@ -129,6 +128,8 @@ public abstract class Microservice { * <li>A config file in the same location and with the same name as the executable jar file. * (e.g. <js>"java -jar myjar.jar"</js> will look for <js>"myjar.cfg"</js>). * </ol> + * + * <p> * If this path does not exist, a {@link FileNotFoundException} will be thrown from the {@link #start()} command. * * @param cfPath The absolute or relative path of the config file. @@ -150,6 +151,7 @@ public abstract class Microservice { /** * Specifies the config file for this microservice. + * * <p> * Note that if you use this method instead of {@link #setConfig(String,boolean)}, the config file will not use * the variable resolver constructed from {@link #createVarResolver()}. @@ -164,6 +166,7 @@ public abstract class Microservice { /** * Specifies the manifest file of the jar file this microservice is contained within. + * * <p> * If you do not specify the manifest file, we attempt to resolve it through the following methods: * <ol> @@ -207,7 +210,7 @@ public abstract class Microservice { } /** - * Same as {@link #setManifest(Manifest)} except finds and loads the manifest file of the jar file that the + * Same as {@link #setManifest(Manifest)} except finds and loads the manifest file of the jar file that the * specified class is contained within. * * @param c The class whose jar file contains the manifest to use for this microservice. @@ -220,8 +223,8 @@ public abstract class Microservice { } /** - * Creates the {@link VarResolver} used to resolve variables in the - * config file returned by {@link #getConfig()}. + * Creates the {@link VarResolver} used to resolve variables in the config file returned by {@link #getConfig()}. + * * <p> * The default implementation resolves the following variables: * <ul> @@ -234,6 +237,7 @@ public abstract class Microservice { * <li><code>$SWITCH{stringArg,pattern,thenVal...}</code>, * <code>$SWITCH{stringArg,pattern,thenVal,elseVal...}</code> - Switch-block logic. * </ul> + * * <p> * Subclasses can override this method to provide their own variables. * @@ -280,8 +284,10 @@ public abstract class Microservice { /** * Returns the command-line arguments passed into the application. + * * <p> * This method can be called from the class constructor. + * * <p> * See {@link Args} for details on using this method. * @@ -293,6 +299,7 @@ public abstract class Microservice { /** * Returns the external INI-style configuration file that can be used to configure your microservice. + * * <p> * The config file location is determined in the following order: * <ol class='spaced-list'> @@ -304,12 +311,16 @@ public abstract class Microservice { * The name of the microservice jar with a <js>".cfg"</js> suffix (e.g. * <js>"mymicroservice.jar"</js>-><js>"mymicroservice.cfg"</js>). * </ol> + * * <p> * If all methods for locating the config file fail, then this method returns <jk>null</jk>. + * * <p> * Subclasses can set their own config file by calling the {@link #setConfig(ConfigFile)} method. + * * <p> * String variables defined by {@link #createVarResolver()} are automatically resolved when using this method. + * * <p> * This method can be called from the class constructor. * @@ -358,8 +369,8 @@ public abstract class Microservice { * * <cc># A POJO with embedded variables</cc> * <ck>aBean2</ck> = {foo:'$ARG{0}',baz:$C{MySection/anInt}} - * * </p> + * * <p class='bcode'> * <jc>// Java code for accessing config entries above.</jc> * ConfigFile cf = getConfig(); @@ -385,9 +396,10 @@ public abstract class Microservice { /** * Returns the main jar manifest file contents as a simple {@link ObjectMap}. + * * <p> - * This map consists of the contents of {@link Manifest#getMainAttributes()} with the keys - * and entries converted to simple strings. + * This map consists of the contents of {@link Manifest#getMainAttributes()} with the keys and entries converted to + * simple strings. * <p> * This method can be called from the class constructor. * @@ -413,8 +425,10 @@ public abstract class Microservice { /** * Start this application. + * * <p> * Default implementation simply calls {@link #onStart()}. + * * <p> * Overridden methods MUST call this method FIRST so that the {@link #onStart()} method is called. * @@ -545,6 +559,7 @@ public abstract class Microservice { /** * Joins the application with the current thread. + * * <p> * Default implementation is a no-op. * @@ -557,8 +572,10 @@ public abstract class Microservice { /** * Stop this application. + * * <p> * Default implementation simply calls {@link #onStop()}. + * * <p> * Overridden methods MUST call this method LAST so that the {@link #onStop()} method is called. * @@ -585,6 +602,7 @@ public abstract class Microservice { /** * Called at the beginning of the {@link #start()} call. + * * <p> * Subclasses can override this method to hook into the lifecycle of this application. */ @@ -592,6 +610,7 @@ public abstract class Microservice { /** * Called at the end of the {@link #stop()} call. + * * <p> * Subclasses can override this method to hook into the lifecycle of this application. */ @@ -599,6 +618,7 @@ public abstract class Microservice { /** * Called if the {@link ConfigFile#save()} is called on the config file. + * * <p> * Subclasses can override this method to listen for config file changes. * @@ -608,6 +628,7 @@ public abstract class Microservice { /** * Called if one or more changes occur in the config file. + * * <p> * Subclasses can override this method to listen for config file changes. *
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-microservice/src/main/java/org/apache/juneau/microservice/Resource.java ---------------------------------------------------------------------- diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/Resource.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/Resource.java index 2c6283c..ef0eea1 100755 --- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/Resource.java +++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/Resource.java @@ -18,6 +18,7 @@ import org.apache.juneau.svl.vars.*; /** * Superclass for all REST resources. + * * <p> * In additional to the functionality of the {@link RestServletDefault} group, * augments the {@link RestContext#getVarResolver()} method with the following additional variable types: http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-microservice/src/main/java/org/apache/juneau/microservice/ResourceGroup.java ---------------------------------------------------------------------- diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/ResourceGroup.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/ResourceGroup.java index 793ab6e..ce27cef 100755 --- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/ResourceGroup.java +++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/ResourceGroup.java @@ -18,6 +18,7 @@ import org.apache.juneau.svl.vars.*; /** * Superclass for all REST resource groups. + * * <p> * In additional to the functionality of the {@link RestServletGroupDefault} group, * augments the {@link RestContext#getVarResolver()} method with the following additional variable types: http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java ---------------------------------------------------------------------- diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java index 6fbdd72..9dd4639 100755 --- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java +++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/RestMicroservice.java @@ -43,17 +43,17 @@ import org.eclipse.jetty.util.ssl.*; * Entry point for Juneau microservice that implements a REST interface using Jetty on a single port. * * <h6 class='topic'>Jetty Server Details</h6> - * <p> + * * The Jetty server is created by the {@link #createServer()} method and started with the {@link #startServer()} method. * These methods can be overridden to provided customized behavior. * * <h6 class='topic'>Defining REST Resources</h6> - * <p> + * * Top-level REST resources are defined by the {@link #getResourceMap()} method. * This method can be overridden to provide a customized list of REST resources. * * <h6 class='topic'>Logging</h6> - * <p> + * * Logging is initialized by the {@link #initLogging()} method. * This method can be overridden to provide customized logging behavior. * @@ -85,6 +85,8 @@ public class RestMicroservice extends Microservice { /** * Main method. + * + * <p> * Subclasses must also implement this method! * * @param args Command line arguments. @@ -185,8 +187,10 @@ public class RestMicroservice extends Microservice { /** * Initialize the logging for this microservice. + * * <p> * Subclasses can override this method to provide customized logging. + * * <p> * The default implementation uses the <cs>Logging</cs> section in the config file to set up logging: * <p class='bcode'> @@ -286,11 +290,12 @@ public class RestMicroservice extends Microservice { /** * Method used to create (but not start) an instance of a Jetty server. + * * <p> * Subclasses can override this method to customize the Jetty server before it is started. + * * <p> * The default implementation is configured by the following values in the config file: - * <p> * <p class='bcode'> * <cc>#================================================================================ * # REST settings @@ -419,6 +424,7 @@ public class RestMicroservice extends Microservice { /** * Method used to start the Jetty server created by {@link #createServer()}. + * * <p> * Subclasses can override this method to customize server startup. * @@ -435,12 +441,12 @@ public class RestMicroservice extends Microservice { /** * Returns the resource map to use for this microservice. - * <p> + * * <p> * Subclasses can override this method to programmatically specify their resources. + * * <p> * The default implementation is configured by the following values in the config file: - * <p> * <p class='bcode'> * * <cc>#================================================================================ @@ -465,10 +471,10 @@ public class RestMicroservice extends Microservice { * # the manifest file.</cc> * <ck>resources</ck> = * </p> + * * <p> - * In most cases, the rest resources will be specified in the manifest file since - * it's not likely to be a configurable property: - * <p> + * In most cases, the rest resources will be specified in the manifest file since it's not likely to be a + * configurable property: * <p class='bcode'> * <mk>Rest-Resources:</mk> org.apache.juneau.microservice.sample.RootResources * </p> @@ -510,9 +516,9 @@ public class RestMicroservice extends Microservice { /** * Called when {@link ConfigFile#save()} is called on the config file. + * * <p> * The default behavior is configured by the following value in the config file: - * <p> * <p class='bcode'> * <cs>[REST]</cs> * @@ -556,6 +562,7 @@ public class RestMicroservice extends Microservice { /** * Called before {@link #createServer()} is called. + * * <p> * Subclasses can override this method to hook into the lifecycle of this application. */ @@ -563,6 +570,7 @@ public class RestMicroservice extends Microservice { /** * Called before {@link #startServer()} is called. + * * <p> * Subclasses can override this method to hook into the lifecycle of this application. */ @@ -570,6 +578,7 @@ public class RestMicroservice extends Microservice { /** * Called after the Jetty server is started. + * * <p> * Subclasses can override this method to hook into the lifecycle of this application. */ @@ -577,6 +586,7 @@ public class RestMicroservice extends Microservice { /** * Called before the Jetty server is stopped. + * * <p> * Subclasses can override this method to hook into the lifecycle of this application. */ @@ -584,6 +594,7 @@ public class RestMicroservice extends Microservice { /** * Called after the Jetty server is stopped. + * * <p> * Subclasses can override this method to hook into the lifecycle of this application. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java ---------------------------------------------------------------------- diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java index 99ea01c..5d818bc 100755 --- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java +++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java @@ -35,18 +35,18 @@ import org.apache.juneau.utils.*; /** * REST resource that allows access to a file system directory. + * * <p> * The root directory is specified in one of two ways: - * </p> * <ul class='spaced-list'> * <li> * Specifying the location via a <l>DirectoryResource.rootDir</l> property. * <li> * Overriding the {@link #getRootDir()} method. * </ul> + * * <p> * Read/write access control is handled through the following properties: - * </p> * <ul class='spaced-list'> * <li> * <l>DirectoryResource.allowViews</l> - If <jk>true</jk>, allows view and download access to files. @@ -55,6 +55,7 @@ import org.apache.juneau.utils.*; * <li> * <l>DirectoryResource.allowDeletes</l> - If <jk>true</jk>, allows files to be deleted. * </ul> + * * <p> * Access can also be controlled by overriding the {@link #checkAccess(RestRequest)} method. */ @@ -95,7 +96,10 @@ public class DirectoryResource extends Resource { /** * Returns the root directory defined by the 'rootDir' init parameter. + * + * <p> * Subclasses can override this method to provide their own root directory. + * * @return The root directory. */ protected File getRootDir() { @@ -109,9 +113,7 @@ public class DirectoryResource extends Resource { } /** - * [GET /*] - * On directories, returns a directory listing. - * On files, returns information about the file. + * [GET /*] - On directories, returns a directory listing. On files, returns information about the file. * * @param req The HTTP request. * @return Either a FileResource or list of FileResources depending on whether it's a @@ -149,8 +151,7 @@ public class DirectoryResource extends Resource { } /** - * [DELETE /*] - * Delete a file on the file system. + * [DELETE /*] - Delete a file on the file system. * * @param req The HTTP request. * @return The message <js>"File deleted"</js> if successful. @@ -171,8 +172,7 @@ public class DirectoryResource extends Resource { } /** - * [PUT /*] - * Add or overwrite a file on the file system. + * [PUT /*] - Add or overwrite a file on the file system. * * @param req The HTTP request. * @return The message <js>"File added"</js> if successful. @@ -194,8 +194,9 @@ public class DirectoryResource extends Resource { } /** - * [VIEW /*] - * View the contents of a file. + * [VIEW /*] - View the contents of a file. + * + * <p> * Applies to files only. * * @param req The HTTP request. @@ -222,8 +223,9 @@ public class DirectoryResource extends Resource { } /** - * [DOWNLOAD /*] - * Download the contents of a file. + * [DOWNLOAD /*] - Download the contents of a file. + * + * <p> * Applies to files only. * * @param req The HTTP request. @@ -251,6 +253,8 @@ public class DirectoryResource extends Resource { /** * Verify that the specified request is allowed. + * + * <p> * Subclasses can override this method to provide customized behavior. * Method should throw a {@link RestException} if the request should be disallowed. * @@ -275,6 +279,7 @@ public class DirectoryResource extends Resource { /** * Constructor. + * * @param f The file. * @param url The URL of the file resource. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java ---------------------------------------------------------------------- diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java index ad547fb..2c36603 100644 --- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java +++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java @@ -24,6 +24,7 @@ import java.util.regex.*; /** * Log entry formatter. + * * <p> * Uses three simple parameter for configuring log entry formats: * <ul class='spaced-list'> @@ -35,6 +36,7 @@ import java.util.regex.*; * <code>useStackTraceHashes</code> - A setting that causes duplicate stack traces to be replaced with 8-character * hash strings. * </ul> + * * <p> * This class converts the format strings into a regular expression that can be used to parse the resulting log file. */ @@ -49,21 +51,24 @@ public class LogEntryFormatter extends Formatter { /** * Create a new formatter. * - * @param format The log entry format. e.g. <js>"[{date} {level}] {msg}%n"</js> - * The string can contain any of the following variables: - * <ol> - * <li><js>"{date}"</js> - The date, formatted per <js>"Logging/dateFormat"</js>. - * <li><js>"{class}"</js> - The class name. - * <li><js>"{method}"</js> - The method name. - * <li><js>"{logger}"</js> - The logger name. - * <li><js>"{level}"</js> - The log level name. - * <li><js>"{msg}"</js> - The log message. - * <li><js>"{threadid}"</js> - The thread ID. - * <li><js>"{exception}"</js> - The localized exception message. - * </ol> - * @param dateFormat The {@link SimpleDateFormat} format to use for dates. e.g. <js>"yyyy.MM.dd hh:mm:ss"</js>. - * @param useStackTraceHashes If <jk>true</jk>, only print unique stack traces once and then refer to them by a - * simple 8 character hash identifier. + * @param format + * The log entry format. e.g. <js>"[{date} {level}] {msg}%n"</js> + * The string can contain any of the following variables: + * <ol> + * <li><js>"{date}"</js> - The date, formatted per <js>"Logging/dateFormat"</js>. + * <li><js>"{class}"</js> - The class name. + * <li><js>"{method}"</js> - The method name. + * <li><js>"{logger}"</js> - The logger name. + * <li><js>"{level}"</js> - The log level name. + * <li><js>"{msg}"</js> - The log message. + * <li><js>"{threadid}"</js> - The thread ID. + * <li><js>"{exception}"</js> - The localized exception message. + * </ol> + * @param dateFormat + * The {@link SimpleDateFormat} format to use for dates. e.g. <js>"yyyy.MM.dd hh:mm:ss"</js>. + * @param useStackTraceHashes + * If <jk>true</jk>, only print unique stack traces once and then refer to them by a simple 8 character hash + * identifier. */ public LogEntryFormatter(String format, String dateFormat, boolean useStackTraceHashes) { this.df = new SimpleDateFormat(dateFormat); @@ -194,10 +199,12 @@ public class LogEntryFormatter extends Formatter { } /** - * Given a matcher that has matched the pattern specified by {@link #getLogEntryPattern()}, - * returns the field value from the match. + * Given a matcher that has matched the pattern specified by {@link #getLogEntryPattern()}, returns the field value + * from the match. * - * @param fieldName The field name. Possible values are: + * @param fieldName + * The field name. + * Possible values are: * <ul> * <li><js>"date"</js> * <li><js>"class"</js> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogParser.java ---------------------------------------------------------------------- diff --git a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogParser.java b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogParser.java index 3aca085..59e5165 100644 --- a/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogParser.java +++ b/juneau-microservice/src/main/java/org/apache/juneau/microservice/resources/LogParser.java @@ -20,9 +20,10 @@ import java.util.regex.*; /** * Utility class for reading log files. + * * <p> - * Provides the capability of returning splices of log files based on dates and filtering based - * on thread and logger names. + * Provides the capability of returning splices of log files based on dates and filtering based on thread and logger + * names. */ public class LogParser implements Iterable<LogParser.Entry>, Iterator<LogParser.Entry> { private BufferedReader br; @@ -113,8 +114,7 @@ public class LogParser implements Iterable<LogParser.Entry>, Iterator<LogParser. } /** - * Serializes the contents of the parsed log file to the specified writer - * and then closes the underlying reader. + * Serializes the contents of the parsed log file to the specified writer and then closes the underlying reader. * * @param w The writer to write the log file to. * @throws IOException http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-releng/eclipse-preferences/user-dictionary.txt ---------------------------------------------------------------------- diff --git a/juneau-releng/eclipse-preferences/user-dictionary.txt b/juneau-releng/eclipse-preferences/user-dictionary.txt index 03e4024..e287b97 100644 --- a/juneau-releng/eclipse-preferences/user-dictionary.txt +++ b/juneau-releng/eclipse-preferences/user-dictionary.txt @@ -10,467 +10,467 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the * * specific language governing permissions and limitations under the License. * *************************************************************************************************************************** +aaa +ab +abbr abbrev -juneau -juno -servlet -microservice -lax -jena -zip -json -xml -html -javadoc -jc -jd -jt -jk -js -jf -jsa -jsf -jsm -jss -ja -xt -xa -xc -xs -xv -mk -mv -cc -cs -ck -ce -cv -l -properties -ua -uk -un -us - -bcode -int -myparam -foo -remoteable -url -proxies -proxy -marshalled -doclink -href -myurl -foo -baz -bcode -serializers -mybeans -serializer -foobar -metadata -scratchpads -int -serializable -overridable -arg -introspector -specs -subpackages -config -timezone -genericized -hashmap -dyna -souped -impl -struct -prev -covariant -superclasses -nutshell -multi -args -enum -bm -metas -op -classloader -swappable -unswap -init -enums -charset -stateless -typecasting accessor -iterable -lowercase -def -decapitalize -cacheable -classpath -ps -bc -hashcode -scratchpad +addr +admin +andandand +anywhereville +apache +api appendable -uri -relativize -relativizes -relativized -mod -javadocs -subtypes -doctree -mytype -jackson -params -jane -doe -hyperlink -codepoint -sublink -jp -rel -hreflang -en -em -logo -timestamp -xhtml -src -marshalling -namespaces -sq -janesmith -namespace -xmlabbrev -bognar -barry -caceres -mpeg -div -xmlns -fÃn -cognos -dataset +apr +arg +args +attr +aug +auth barack -obama -george -ds -abbr -coords +barney +barry +batchfile +baz +bbb +bc +bcode +bcode bdi bdo -dir +billy +birthdate blockquote +blog +bm +bognar br +byteranges +ca +caceres +cacheable +callable +cc +ce +centric +cert +cf +charset +chrome +chunked +ck +classloader +classpath +cloudant +cm +cmd +codec +codepoint +cognos col colgroup +colspan +com +concat +config +configfile +cont +cookbook +coords +costas +covariant +cp +crawford +cs +css +csv +ctx +cv +da +danish datalist +dataset +datatype dd +dec +decapitalize +def +deflate del +demoted +deserialize dfn +differentiable +dir +discoverable +discriminator +div dl +doclink +docs +doctree +doctype +doe +ds dt +duper +dvi +dyna +em +en +endian +enum +enums +envfile +etag +ethel +ext +extlink +favicon +feb +fico fieldset figcaption -hr -iframe +filesystem +firefox +firewall +fixarray +fixext +fixint +fixmap +fixnum +fixstr +foo +foo +foobar +fred +fÃn +gatewayed +gb +gecko +genericized +generics +george +gif +gigabytes +globalizable +globalized +gzip +hashcode +hashmap +hashsums +hostname +hr +href +hreflang +htdocs +htm +html +htmldoc +http +httpclient +httpcore +httpmime +https +hussein +hv +hyperlink +hyperlinks +iframe img +impl +inbound +init +instanceof +int +int +intercepters +interceptors +introspectable +introspector +io +iri +iso +iter +iterable +iterables +ja +jackson +jan +jane +janesmith +javadoc +javadocs +javascript +jc +jd +jena +jetty +jf +jk +jp +jpeg +js +jsa +jsf +jsm +json +jss +jt +jul +jun +juneau +juneaubp +juno kbd keygen +l +lang +lax li +lib +libwww +lifecycle +locales +localhost +logo +lossless +losslessly +lowercase +lowercased +ls +lucy +maori +marshalled +marshalling +maxage +mertz +metadata +metamodel +metamodels +metas +mf +mi +microservice +microservices +min +mk +mkdirs +mod +mozilla +mpeg +msg +msgpack +multi +multipart +mv +myarg +mybeans +mydiv +mydocs +myentry +myform +myheader +mymethod +myobject +myparam +myproperty +myproxy +myresource +mystyles +mytable +mytype +myurl +namespace +namespaces nav +neg +nls noscript +nosniff +nov +nowrap +ns +nutshell +obama +oct +octets ol +onload +onmouseover +op optgroup +ordinality +org +orig +ororor +outbound +outerdata +overridable param +params +parsable +payload +pb +pg +pl +playback +png +pojo +pos +pp +pragma pre +prev +println +properties +proxies +proxy +ps +pseudonym +pseudonyms +pw +qs +queryable +qvalue +qvalues rb +rc +rd +rdf +readonly +reconstitute +ref +referer +rel +relativize +relativized +relativizes +remoteable +req +resp +retryable +revalidate +revalidating +ricky rp +rs rt rtc +rv samp +scratchpad +scratchpads +se +seemlessly +seg +sept +serializable +serializer +serializers +servlet +servlets +sf +sic +sorta +souped +spec +specs +sq +sql +src +ss +ssl +ssv +stacktrace +stateless +str +streamable +struct +stylesheet +stylesheets +subclassed +subdirectories +sublink +subpackages +subpath +subtype +subtypes +superclasses +superinterfaces +swappable tbody td +tee +templating +testcases textarea tfoot th thead +threadid +throwables +thu +timestamp +timezone +tm +tomcat +tooltips tr +traversable +tsv +tumblr +txt +typecasting +ua +uint +uk ul +ultra +un +uncacheable +unencoded +unicode +unswap +uon +uri +url +urlencoded +urlencoding +us +usemap +username +utf +val +validator +vals var +vars +waitangi wbr -attr -xxx -readonly -usemap -pragma -ordinality -playback -onmouseover -mydiv -myform -mytable -ref -htmldoc -req -csv -ssv -tsv -http -https +webmaster +website +websocket +writeable ws wss -urlencoded www -templating -payload -multipart -discriminator -spec -docs -website -gzip -nls -hyperlinks -stylesheet -css -subclassed -outerdata -subtype -htdocs -metamodel -metamodels -costas -billy -barney -dvi -jpeg -extlink -qvalue -utf -unicode -iso -deflate -qvalues -danish -da -gb -maxage -revalidate -min -waitangi -maori -mi -octets -resp -pos -nov -gif -byteranges -orig -gatewayed -revalidating -validator +xa +xc +xhtml +xml +xmlabbrev +xmlbase +xmlns +xs +xt +xv +xxx +xyz xyzzy -thu -dec -org -webmaster -oct -inbound -lowercased -outbound -referer -sic -libwww -demoted -chunked -websocket -firefox -gecko -rv -mozilla -uncacheable -fred -pseudonym -firewall -ricky -ethel -lucy -mertz -pseudonyms -val -datatype -cf -configfile -envfile -vals -batchfile -unencoded -duper -println -generics -mkdirs -locales -myobject -com -iterables -superinterfaces -tee -javascript -aaa -bbb yyy -xyz -birthdate -fixint -fixmap -fixarray -fixstr -ext -uint -fixext -str -neg -fixnum -endian -cont -msgpack -myproxy -mymethod -pojo -parsable -instanceof -vars -myproperty -mf -reconstitute yyyy -uon -anywhereville -differentiable -ultra -colspan -seg -pp -andandand -ororor -zzz -fico -cmd -ls -pb -ns -losslessly -lossless -ab -addr -microservices -traversable -queryable -introspectable -cookbook -pg -servlets -centric -aug -discoverable +zip zipped -jetty -subpath -cp -ca -cm -globalizable -hussein -jul -rd -crawford -tumblr -blog -sql -rs -concat -ss -se -cloudant -apr -feb -jan -sept -jun -iter -onload -lang -etag -throwables -callable -urlencoding -rdf -xmlbase -doctype -iri -api -juneaubp -deserialize -lifecycle -myentry -myarg -auth -username -codec -lib -io -httpclient -httpcore -httpmime -globalized -sorta -writeable -tomcat -myheader -streamable -htm -txt -png -stylesheets -favicon -subdirectories -nowrap -hashsums -stacktrace -msg -qs -filesystem -nosniff -chrome -admin -apache -mystyles -mydocs -myresource -tooltips -testcases -interceptors -seemlessly -pl -pw -rc -localhost -retryable -hostname -hv -tm -ctx -sf -ssl -intercepters -cert -gigabytes +zzz http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java ---------------------------------------------------------------------- diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java index b1321d9..98f2412 100644 --- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java +++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java @@ -19,6 +19,7 @@ import org.apache.http.message.*; /** * Convenience class for setting date headers in RFC2616 format. + * * <p> * Equivalent to the following code: * <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java ---------------------------------------------------------------------- diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java index 4a9a98b..e7ab3a1 100644 --- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java +++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java @@ -24,6 +24,7 @@ import org.apache.juneau.urlencoding.*; /** * Convenience class for constructing instances of <code>List<NameValuePair></code> for the * {@link UrlEncodedFormEntity} class. + * * <p> * Instances of this method can be passed directly to the {@link RestClient#doPost(Object, Object)} method or * {@link RestCall#input(Object)} methods to perform URL-encoded form posts. @@ -53,6 +54,7 @@ public final class NameValuePairs extends LinkedList<NameValuePair> { /** * Appends the specified name/value pair to the end of this list. + * * <p> * The value is simply converted to a string using <code>toString()</code>, or <js>"null"</js> if <jk>null</jk>. * @@ -67,6 +69,7 @@ public final class NameValuePairs extends LinkedList<NameValuePair> { /** * Appends the specified name/value pair to the end of this list. + * * <p> * The value is converted to UON notation using the {@link UrlEncodingSerializer} defined on the client. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java ---------------------------------------------------------------------- diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java index a0e1ae0..cf491c6 100644 --- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java +++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java @@ -17,13 +17,14 @@ import java.util.regex.*; /** * Used to find regular expression matches in REST responses made through {@link RestCall}. + * * <p> * Response patterns are applied to REST calls through the {@link RestCall#responsePattern(ResponsePattern)} method. * * <h5 class='section'>Example:</h5> + * * This example shows how to use a response pattern finder to find and capture patterns for <js>"x=number"</js> and * <js>"y=string"</js> from a response body. - * <p> * <p class='bcode'> * <jk>final</jk> List<Number> xList = <jk>new</jk> ArrayList<Number>(); * <jk>final</jk> List<String> yList = <jk>new</jk> ArrayList<String>(); http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java ---------------------------------------------------------------------- diff --git a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java index c73dfa4..d7c9c36 100644 --- a/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java +++ b/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/SerializedNameValuePair.java @@ -18,8 +18,8 @@ import org.apache.juneau.serializer.*; import org.apache.juneau.urlencoding.*; /** - * Subclass of {@link NameValuePair} for serializing POJOs as URL-encoded form post entries - * using the {@link UrlEncodingSerializer class}. + * Subclass of {@link NameValuePair} for serializing POJOs as URL-encoded form post entries using the + * {@link UrlEncodingSerializer class}. * * <h5 class='section'>Example:</h5> * <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java ---------------------------------------------------------------------- diff --git a/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java b/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java index 7ec2633..ce95bb0 100644 --- a/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java +++ b/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/BaseProvider.java @@ -74,8 +74,8 @@ public class BaseProvider implements MessageBodyReader<Object>, MessageBodyWrite /** * Returns properties defined on the specified method through the {@link RestMethod#properties()} - * annotation specified on the method and the {@link JuneauProvider#properties()} annotation - * specified on the provider class. + * annotation specified on the method and the {@link JuneauProvider#properties()} annotation specified on the + * provider class. * * @param a All annotations defined on the method. * @return A map of all properties define on the method. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java ---------------------------------------------------------------------- diff --git a/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java b/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java index 6390073..e36a5fc 100644 --- a/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java +++ b/juneau-rest-jaxrs/src/main/java/org/apache/juneau/rest/jaxrs/JuneauProvider.java @@ -30,7 +30,7 @@ import org.apache.juneau.xml.*; * Annotations applicable to subclasses of {@link BaseProvider}. * * <h5 class='section'>Description:</h5> - * <p> + * * Used to associate serializers, parsers, filters, and properties with instances of {@link BaseProvider}. */ @Documented @@ -41,19 +41,23 @@ public @interface JuneauProvider { /** * Provider-level bean filters. + * * <p> * These filters are applied to all serializers and parsers being used by the provider. + * * <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 - * be treated as the specified class type. + * be treated as the specified class type. */ Class<?>[] beanFilters() default {}; /** * Provider-level POJO swaps. + * * <p> * These POJO swaps are applied to all serializers and parsers being used by the provider. + * * <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}. @@ -62,6 +66,7 @@ public @interface JuneauProvider { /** * Provider-level properties. + * * <p> * Any of the following property names can be specified: * <ul> @@ -73,8 +78,10 @@ public @interface JuneauProvider { * <li>{@link XmlSerializerContext} * <li>{@link XmlParserContext} * </ul> + * * <p> * Property values will be converted to the appropriate type. + * * <p> * These properties can be augmented/overridden through the {@link RestMethod#properties()} annotation on the REST method. */ @@ -82,6 +89,7 @@ public @interface JuneauProvider { /** * Shortcut for setting {@link #properties()} of boolean types. + * * <p> * Setting a flag is the equivalent to setting the same property to <js>"true"</js>. */ @@ -89,6 +97,7 @@ public @interface JuneauProvider { /** * Specifies a list of {@link Serializer} classes to add to the list of serializers available for this provider. + * * <p> * This annotation can only be used on {@link Serializer} classes that have no-arg constructors. */ @@ -96,6 +105,7 @@ public @interface JuneauProvider { /** * Specifies a list of {@link Parser} classes to add to the list of parsers available for this provider. + * * <p> * This annotation can only be used on {@link Parser} classes that have no-arg constructors. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest/src/main/java/org/apache/juneau/rest/CallRouter.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/CallRouter.java b/juneau-rest/src/main/java/org/apache/juneau/rest/CallRouter.java index acc4de4..a592f5a 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/CallRouter.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/CallRouter.java @@ -21,6 +21,7 @@ import javax.servlet.http.*; /** * Represents a group of CallMethods on a REST resource that handle the same HTTP Method name but with different * paths/matchers/guards/etc... + * * <p> * Incoming requests for a particular HTTP method type (e.g. <js>"GET"</js>) are handed off to this class and then * dispatched to the appropriate CallMethod. @@ -67,6 +68,7 @@ class CallRouter { /** * Workhorse method. + * * <p> * Routes this request to one of the CallMethods. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java b/juneau-rest/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java index 891cda5..6d340bd 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/ClientVersionMatcher.java @@ -19,6 +19,7 @@ import org.apache.juneau.rest.annotation.*; /** * Specialized matcher for matching client versions. + * * <p> * See {@link RestResource#clientVersionHeader} and {@link RestMethod#clientVersion} for more info. */ @@ -30,8 +31,9 @@ public class ClientVersionMatcher extends RestMatcher { /** * Constructor. * - * @param clientVersionHeader The HTTP request header name containing the client version. - * If <jk>null</jk> or an empty string, uses <js>"X-Client-Version"</js> + * @param clientVersionHeader + * The HTTP request header name containing the client version. + * If <jk>null</jk> or an empty string, uses <js>"X-Client-Version"</js> * @param javaMethod The version string that the client version must match. */ protected ClientVersionMatcher(String clientVersionHeader, java.lang.reflect.Method javaMethod) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest/src/main/java/org/apache/juneau/rest/ReaderResource.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/ReaderResource.java b/juneau-rest/src/main/java/org/apache/juneau/rest/ReaderResource.java index 93478c2..ee2272e 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/ReaderResource.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/ReaderResource.java @@ -27,6 +27,7 @@ import org.apache.juneau.svl.*; /** * Represents the contents of a text file with convenience methods for resolving {@link Parameter} variables and adding * HTTP response headers. + * * <p> * This class is handled special by the {@link WritableHandler} class. */ @@ -41,14 +42,15 @@ public class ReaderResource implements Writable { * Constructor. * * @param mediaType The HTTP media type. - * @param contents The contents of this resource. - * <br>If multiple contents are specified, the results will be concatenated. - * <br>Contents can be any of the following: - * <ul> - * <li><code>CharSequence</code> - * <li><code>Reader</code> - * <li><code>File</code> - * </ul> + * @param contents + * The contents of this resource. + * <br>If multiple contents are specified, the results will be concatenated. + * <br>Contents can be any of the following: + * <ul> + * <li><code>CharSequence</code> + * <li><code>Reader</code> + * <li><code>File</code> + * </ul> * @throws IOException */ protected ReaderResource(MediaType mediaType, Object...contents) throws IOException { @@ -61,15 +63,16 @@ public class ReaderResource implements Writable { * @param mediaType The resource media type. * @param headers The HTTP response headers for this streamed resource. * @param varSession Optional variable resolver for resolving variables in the string. - * @param contents The resource contents. - * <br>If multiple contents are specified, the results will be concatenated. - * <br>Contents can be any of the following: - * <ul> - * <li><code>InputStream</code> - * <li><code>Reader</code> - Converted to UTF-8 bytes. - * <li><code>File</code> - * <li><code>CharSequence</code> - Converted to UTF-8 bytes. - * </ul> + * @param contents + * The resource contents. + * <br>If multiple contents are specified, the results will be concatenated. + * <br>Contents can be any of the following: + * <ul> + * <li><code>InputStream</code> + * <li><code>Reader</code> - Converted to UTF-8 bytes. + * <li><code>File</code> + * <li><code>CharSequence</code> - Converted to UTF-8 bytes. + * </ul> * @throws IOException */ public ReaderResource(MediaType mediaType, Map<String,String> headers, VarResolverSession varSession, Object...contents) throws IOException { @@ -134,18 +137,20 @@ public class ReaderResource implements Writable { /** * Specifies the contents for this resource. + * * <p> * This method can be called multiple times to add more content. * - * @param contents The resource contents. - * <br>If multiple contents are specified, the results will be concatenated. - * <br>Contents can be any of the following: - * <ul> - * <li><code>InputStream</code> - * <li><code>Reader</code> - Converted to UTF-8 bytes. - * <li><code>File</code> - * <li><code>CharSequence</code> - Converted to UTF-8 bytes. - * </ul> + * @param contents + * The resource contents. + * <br>If multiple contents are specified, the results will be concatenated. + * <br>Contents can be any of the following: + * <ul> + * <li><code>InputStream</code> + * <li><code>Reader</code> - Converted to UTF-8 bytes. + * <li><code>File</code> + * <li><code>CharSequence</code> - Converted to UTF-8 bytes. + * </ul> * @return This object (for method chaining). */ public Builder contents(Object...contents) { @@ -157,7 +162,9 @@ public class ReaderResource implements Writable { * Specifies an HTTP response header value. * * @param name The HTTP header name. - * @param value The HTTP header value. Will be converted to a <code>String</code> using {@link Object#toString()}. + * @param value + * The HTTP header value. + * Will be converted to a <code>String</code> using {@link Object#toString()}. * @return This object (for method chaining). */ public Builder header(String name, Object value) { @@ -168,7 +175,9 @@ public class ReaderResource implements Writable { /** * Specifies HTTP response header values. * - * @param headers The HTTP headers. Values will be converted to <code>Strings</code> using {@link Object#toString()}. + * @param headers + * The HTTP headers. + * Values will be converted to <code>Strings</code> using {@link Object#toString()}. * @return This object (for method chaining). */ public Builder headers(Map<String,Object> headers) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest/src/main/java/org/apache/juneau/rest/Redirect.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/Redirect.java b/juneau-rest/src/main/java/org/apache/juneau/rest/Redirect.java index 1a79d24..98fdb75 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/Redirect.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/Redirect.java @@ -21,6 +21,7 @@ import org.apache.juneau.urlencoding.*; /** * REST methods can return this object as a shortcut for performing <code>HTTP 302</code> redirects. + * * <p> * The following example shows the difference between handling redirects via the {@link RestRequest}/{@link RestResponse}, * and the simplified approach of using this class. @@ -39,6 +40,7 @@ import org.apache.juneau.urlencoding.*; * <jk>return new</jk> Redirect(<js>"foobar"</js>); * } * </p> + * * <p> * The constructor can use a {@link MessageFormat}-style pattern with multiple arguments: * <p class='bcode'> @@ -47,10 +49,12 @@ import org.apache.juneau.urlencoding.*; * <jk>return new</jk> Redirect(<js>"foo/{0}/bar/{1}"</js>, id1, id2); * } * </p> + * * <p> * The arguments are serialized to strings using the servlet's {@link UrlEncodingSerializer}, so any filters defined on * the serializer or REST method/class will be used when present. * The arguments will also be automatically URL-encoded. + * * <p> * Redirecting to the servlet root can be accomplished by simply using the no-arg constructor. * <p class='bcode'> @@ -61,6 +65,7 @@ import org.apache.juneau.urlencoding.*; * <jk>return new</jk> Redirect(); * } * </p> + * * <p> * This class is handled by {@link org.apache.juneau.rest.response.RedirectHandler}, a built-in default response * handler created in {@link RestConfig}. @@ -72,15 +77,18 @@ public final class Redirect { /** * Redirect to the specified URL. + * + * <p> * Relative paths are interpreted as relative to the servlet path. * - * @param uri The URL to redirect to. - * <br>Can be any of the following: - * <ul> - * <li><code>URL</code> - * <li><code>URI</code> - * <li><code>CharSequence</code> - * </ul> + * @param uri + * The URL to redirect to. + * <br>Can be any of the following: + * <ul> + * <li><code>URL</code> + * <li><code>URI</code> + * <li><code>CharSequence</code> + * </ul> * @param args Optional {@link MessageFormat}-style arguments. */ public Redirect(Object uri, Object...args) { @@ -89,15 +97,18 @@ public final class Redirect { /** * Convenience method for redirecting to instance of {@link URL} and {@link URI}. + * + * <p> * Same as calling <code>toString()</code> on the object and using the other constructor. * - * @param uri The URL to redirect to. - * <br>Can be any of the following: - * <ul> - * <li><code>URL</code> - * <li><code>URI</code> - * <li><code>CharSequence</code> - * </ul> + * @param uri + * The URL to redirect to. + * <br>Can be any of the following: + * <ul> + * <li><code>URL</code> + * <li><code>URI</code> + * <li><code>CharSequence</code> + * </ul> */ public Redirect(Object uri) { this(0, uri, (Object[])null); @@ -105,16 +116,19 @@ public final class Redirect { /** * Redirect to the specified URL. + * + * <p> * Relative paths are interpreted as relative to the servlet path. * * @param httpResponseCode The HTTP response code. - * @param url The URL to redirect to. - * <br>Can be any of the following: - * <ul> - * <li><code>URL</code> - * <li><code>URI</code> - * <li><code>CharSequence</code> - * </ul> + * @param url + * The URL to redirect to. + * <br>Can be any of the following: + * <ul> + * <li><code>URL</code> + * <li><code>URI</code> + * <li><code>CharSequence</code> + * </ul> * @param args Optional {@link MessageFormat}-style arguments. */ public Redirect(int httpResponseCode, Object url, Object...args) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest/src/main/java/org/apache/juneau/rest/RequestBody.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestBody.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestBody.java index a7fe2e5..5da647a 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestBody.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestBody.java @@ -86,9 +86,11 @@ public class RequestBody { /** * Reads the input from the HTTP request as JSON, XML, or HTML and converts the input to a POJO. + * * <p> * If {@code allowHeaderParams} init parameter is <jk>true</jk>, then first looks for {@code &body=xxx} in the URL * query string. + * * <p> * If type is <jk>null</jk> or <code>Object.<jk>class</jk></code>, then the actual type will be determined * automatically based on the following input: @@ -131,6 +133,7 @@ public class RequestBody { * <td><jk>null</jk></td> * </tr> * </table> + * * <p> * Refer to <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a> for * a complete definition of supported POJOs. @@ -157,8 +160,9 @@ public class RequestBody { * @param <T> The class type to instantiate. * @return The input parsed to a POJO. * @throws IOException If a problem occurred trying to read from the reader. - * @throws ParseException If the input contains a syntax error or is malformed for the requested {@code Accept} - * header or is not valid for the specified type. + * @throws ParseException + * If the input contains a syntax error or is malformed for the requested {@code Accept} header or is not valid + * for the specified type. */ public <T> T asType(Class<T> type) throws IOException, ParseException { return parse(beanSession.getClassMeta(type)); @@ -182,13 +186,15 @@ public class RequestBody { * Map<String,List<MyBean>> body = req.getBody().asType(TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>); * </p> * - * @param type The type of object to create. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * @param args The type arguments of the class if it's a collection or map. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * <br>Ignored if the main type is not a map or collection. + * @param type + * The type of object to create. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * @param args + * The type arguments of the class if it's a collection or map. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * <br>Ignored if the main type is not a map or collection. * @param <T> The class type to instantiate. * @return The input parsed to a POJO. */ @@ -198,6 +204,7 @@ public class RequestBody { /** * Returns the HTTP body content as a plain string. + * * <p> * If {@code allowHeaderParams} init parameter is true, then first looks for {@code &body=xxx} in the URL query * string. @@ -225,9 +232,11 @@ public class RequestBody { /** * Returns the HTTP body content as a {@link Reader}. + * * <p> * If {@code allowHeaderParams} init parameter is true, then first looks for {@code &body=xxx} in the URL query * string. + * * <p> * Automatically handles GZipped input streams. * @@ -257,6 +266,7 @@ public class RequestBody { /** * Returns the HTTP body content as an {@link InputStream}. + * * <p> * Automatically handles GZipped input streams. * @@ -281,9 +291,10 @@ public class RequestBody { /** * Returns the parser and media type matching the request <code>Content-Type</code> header. * - * @return The parser matching the request <code>Content-Type</code> header, or <jk>null</jk> if no matching parser - * was found. - * Includes the matching media type. + * @return + * The parser matching the request <code>Content-Type</code> header, or <jk>null</jk> if no matching parser was + * found. + * Includes the matching media type. */ public ParserMatch getParserMatch() { MediaType mediaType = headers.getContentType(); @@ -305,8 +316,9 @@ public class RequestBody { /** * Returns the parser matching the request <code>Content-Type</code> header. * - * @return The parser matching the request <code>Content-Type</code> header, or <jk>null</jk> if no matching parser - * was found. + * @return + * The parser matching the request <code>Content-Type</code> header, or <jk>null</jk> if no matching parser was + * found. */ public Parser getParser() { ParserMatch pm = getParserMatch(); @@ -316,8 +328,9 @@ public class RequestBody { /** * Returns the reader parser matching the request <code>Content-Type</code> header. * - * @return The reader parser matching the request <code>Content-Type</code> header, or <jk>null</jk> if no matching - * reader parser was found, or the matching parser was an input stream parser. + * @return + * The reader parser matching the request <code>Content-Type</code> header, or <jk>null</jk> if no matching + * reader parser was found, or the matching parser was an input stream parser. */ public ReaderParser getReaderParser() { Parser p = getParser(); http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest/src/main/java/org/apache/juneau/rest/RequestFormData.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestFormData.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestFormData.java index 4c56c33..a9ba34e 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestFormData.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestFormData.java @@ -45,6 +45,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> { /** * Adds default entries to these form-data parameters. + * * <p> * This includes the default form-data parameters defined on the servlet and method levels. * @@ -75,6 +76,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> { /** * Returns a form data parameter value. + * * <p> * Parameter lookup is case-insensitive (consistent with WAS, but differs from Tomcat). * @@ -221,6 +223,7 @@ public class RequestFormData extends LinkedHashMap<String,String[]> { /** * Same as {@link #get(String, Class)} except for use on multi-part parameters * (e.g. <js>"key=1&key=2&key=3"</js> instead of <js>"key=(1,2,3)"</js>) + * * <p> * This method must only be called when parsing into classes of type Collection or array. * @@ -260,13 +263,15 @@ public class RequestFormData extends LinkedHashMap<String,String[]> { * </p> * * @param name The parameter name. - * @param type The type of object to create. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * @param args The type arguments of the class if it's a collection or map. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * <br>Ignored if the main type is not a map or collection. + * @param type + * The type of object to create. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * @param args + * The type arguments of the class if it's a collection or map. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * <br>Ignored if the main type is not a map or collection. * @return The parameter value converted to the specified class type. * @throws ParseException */ @@ -277,17 +282,20 @@ public class RequestFormData extends LinkedHashMap<String,String[]> { /** * Same as {@link #get(String, Type, Type...)} except for use on multi-part parameters * (e.g. <js>"key=1&key=2&key=3"</js> instead of <js>"key=(1,2,3)"</js>) + * * <p> * This method must only be called when parsing into classes of type Collection or array. * * @param name The parameter name. - * @param type The type of object to create. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * @param args The type arguments of the class if it's a collection or map. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * <br>Ignored if the main type is not a map or collection. + * @param type + * The type of object to create. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * @param args + * The type arguments of the class if it's a collection or map. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * <br>Ignored if the main type is not a map or collection. * @return The parameter value converted to the specified class type. * @throws ParseException */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest/src/main/java/org/apache/juneau/rest/RequestHeaders.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestHeaders.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestHeaders.java index ff3f3cd..18f403c 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestHeaders.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestHeaders.java @@ -28,6 +28,7 @@ import org.apache.juneau.urlencoding.*; /** * Represents the headers in an HTTP request. + * * <p> * Entries are stored in a case-insensitive map. */ @@ -59,6 +60,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Adds default entries to these headers. + * * <p> * This includes the default headers defined on the servlet and method levels. * @@ -98,10 +100,11 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the specified header value, or <jk>null</jk> if the header doesn't exist. + * * <p> * If {@code allowHeaderParams} init parameter is <jk>true</jk>, then first looks for {@code &HeaderName=x} in the * URL query string. - * <p> + * * @param name The header name. * @return The header value, or <jk>null</jk> if it doesn't exist. */ @@ -118,6 +121,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the specified header value, or a default value if the header doesn't exist. + * * <p> * If {@code allowHeaderParams} init parameter is <jk>true</jk>, then first looks for {@code &HeaderName=x} in the * URL query string. @@ -187,6 +191,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the specified header value converted to a POJO. + * * <p> * The type can be any POJO type convertible from a <code>String</code> * (See <a class="doclink" href="package-summary.html#PojosConvertableFromString">POJOs Convertible From Strings</a>). @@ -228,6 +233,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the specified header value converted to a POJO. + * * <p> * The type can be any POJO type convertible from a <code>String</code> * (See <a class="doclink" href="package-summary.html#PojosConvertableFromString">POJOs Convertible From Strings</a>). @@ -239,13 +245,15 @@ public class RequestHeaders extends TreeMap<String,String[]> { * </p> * * @param name The HTTP header name. - * @param type The type of object to create. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * @param args The type arguments of the class if it's a collection or map. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * <br>Ignored if the main type is not a map or collection. + * @param type + * The type of object to create. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * @param args + * The type arguments of the class if it's a collection or map. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * <br>Ignored if the main type is not a map or collection. * @param <T> The class type to convert the header value to. * @return The parameter value converted to the specified class type. * @throws ParseException If the header could not be converted to the specified type. @@ -282,6 +290,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Accept</code> header on the request. + * * <p> * Content-Types that are acceptable for the response. * @@ -298,6 +307,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Accept-Charset</code> header on the request. + * * <p> * Character sets that are acceptable. * @@ -314,6 +324,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Accept-Encoding</code> header on the request. + * * <p> * List of acceptable encodings. * @@ -330,6 +341,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Accept-Language</code> header on the request. + * * <p> * List of acceptable human languages for response. * @@ -346,6 +358,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Authorization</code> header on the request. + * * <p> * Authentication credentials for HTTP authentication. * @@ -362,6 +375,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Cache-Control</code> header on the request. + * * <p> * Used to specify directives that must be obeyed by all caching mechanisms along the request-response chain. * @@ -378,6 +392,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Connection</code> header on the request. + * * <p> * Control options for the current connection and list of hop-by-hop request fields. * @@ -395,6 +410,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Content-Length</code> header on the request. + * * <p> * The length of the request body in octets (8-bit bytes). * @@ -411,6 +427,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Content-Type</code> header on the request. + * * <p> * The MIME type of the body of the request (used with POST and PUT requests). * @@ -427,6 +444,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Date</code> header on the request. + * * <p> * The date and time that the message was originated (in "HTTP-date" format as defined by RFC 7231 Date/Time Formats). * @@ -443,6 +461,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Expect</code> header on the request. + * * <p> * Indicates that particular server behaviors are required by the client. * @@ -459,6 +478,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>From</code> header on the request. + * * <p> * The email address of the user making the request. * @@ -475,6 +495,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Host</code> header on the request. + * * <p> * The domain name of the server (for virtual hosting), and the TCP port number on which the server is listening. * The port number may be omitted if the port is the standard port for the service requested. @@ -493,6 +514,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>If-Match</code> header on the request. + * * <p> * Only perform the action if the client supplied entity matches the same entity on the server. * This is mainly for methods like PUT to only update a resource if it has not been modified since the user last @@ -511,6 +533,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>If-Modified-Since</code> header on the request. + * * <p> * Allows a 304 Not Modified to be returned if content is unchanged. * @@ -527,6 +550,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>If-None-Match</code> header on the request. + * * <p> * Allows a 304 Not Modified to be returned if content is unchanged, see HTTP ETag. * @@ -543,6 +567,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>If-Range</code> header on the request. + * * <p> * If the entity is unchanged, send me the part(s) that I am missing; otherwise, send me the entire new entity. * @@ -559,6 +584,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>If-Unmodified-Since</code> header on the request. + * * <p> * Only send the response if the entity has not been modified since a specific time. * @@ -575,6 +601,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Max-Forwards</code> header on the request. + * * <p> * Limit the number of times the message can be forwarded through proxies or gateways. * @@ -591,6 +618,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Pragma</code> header on the request. + * * <p> * Implementation-specific fields that may have various effects anywhere along the request-response chain. * @@ -607,6 +635,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Proxy-Authorization</code> header on the request. + * * <p> * Authorization credentials for connecting to a proxy. * @@ -623,6 +652,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Range</code> header on the request. + * * <p> * Request only part of an entity. Bytes are numbered from 0. * @@ -639,6 +669,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Referer</code> header on the request. + * * <p> * This is the address of the previous web page from which a link to the currently requested page was followed. * @@ -655,6 +686,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>TE</code> header on the request. + * * <p> * The transfer encodings the user agent is willing to accept: the same values as for the response header field * Transfer-Encoding can be used, plus the "trailers" value (related to the "chunked" transfer method) to notify the @@ -673,6 +705,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Time-Zone</code> header value on the request if there is one. + * * <p> * Example: <js>"GMT"</js>. * @@ -687,6 +720,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>User-Agent</code> header on the request. + * * <p> * The user agent string of the user agent. * @@ -703,6 +737,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Upgrade</code> header on the request. + * * <p> * Ask the server to upgrade to another protocol. * @@ -719,6 +754,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Via</code> header on the request. + * * <p> * Informs the server of proxies through which the request was sent. * @@ -735,6 +771,7 @@ public class RequestHeaders extends TreeMap<String,String[]> { /** * Returns the <code>Warning</code> header on the request. + * * <p> * A general warning about possible problems with the entity body. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest/src/main/java/org/apache/juneau/rest/RequestPathMatch.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestPathMatch.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestPathMatch.java index fa75767..7dde6d6 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestPathMatch.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestPathMatch.java @@ -23,6 +23,7 @@ import org.apache.juneau.urlencoding.*; /** * Contains information about the matched path on the HTTP request. + * * <p> * Provides access to the matched path variables and path match remainder. */ @@ -65,6 +66,7 @@ public class RequestPathMatch extends TreeMap<String,String> { /** * Returns the specified path parameter converted to a POJO. + * * <p> * The type can be any POJO type convertible from a <code>String</code> (See <a class="doclink" * href="package-summary.html#PojosConvertibleFromString">POJOs Convertible From Strings</a>). @@ -99,9 +101,11 @@ public class RequestPathMatch extends TreeMap<String,String> { /** * Returns the specified path parameter converted to a POJO. + * * <p> * The type can be any POJO type convertible from a <code>String</code> (See <a class="doclink" * href="package-summary.html#PojosConvertibleFromString">POJOs Convertible From Strings</a>). + * * <p> * Use this method if you want to parse into a parameterized <code>Map</code>/<code>Collection</code> object. * @@ -121,13 +125,15 @@ public class RequestPathMatch extends TreeMap<String,String> { * </p> * * @param name The attribute name. - * @param type The type of object to create. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * @param args The type arguments of the class if it's a collection or map. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * <br>Ignored if the main type is not a map or collection. + * @param type + * The type of object to create. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * @param args + * The type arguments of the class if it's a collection or map. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * <br>Ignored if the main type is not a map or collection. * @param <T> The class type to convert the attribute value to. * @return The attribute value converted to the specified class type. * @throws ParseException @@ -149,9 +155,9 @@ public class RequestPathMatch extends TreeMap<String,String> { /** * Returns the decoded remainder of the URL following any path pattern matches. + * * <p> * The behavior of path remainder is shown below given the path pattern "/foo/*": - * <p> * <table class='styled'> * <tr> * <th>URL</th> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-rest/src/main/java/org/apache/juneau/rest/RequestQuery.java ---------------------------------------------------------------------- diff --git a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestQuery.java b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestQuery.java index c4d9a7c..e714344 100644 --- a/juneau-rest/src/main/java/org/apache/juneau/rest/RequestQuery.java +++ b/juneau-rest/src/main/java/org/apache/juneau/rest/RequestQuery.java @@ -48,6 +48,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { /** * Adds default entries to these query parameters. + * * <p> * This includes the default queries defined on the servlet and method levels. * @@ -78,12 +79,15 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { /** * Returns a query parameter value. + * * <p> * Same as {@link HttpServletRequest#getParameter(String)} except only looks in the URL string, not parameters from * URL-Encoded FORM posts. + * * <p> * This method can be used to retrieve a parameter without triggering the underlying servlet API to load and parse * the request body. + * * <p> * If multiple query parameters have the same name, this returns only the first instance. * @@ -110,8 +114,9 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { * * @param name The URL parameter name. * @param def The default value. - * @return The parameter value, or the default value if parameter not specified or has no value - * (e.g. <js>"&foo"</js>. + * @return + * The parameter value, or the default value if parameter not specified or has no value + * (e.g. <js>"&foo"</js>. */ public String getString(String name, String def) { String s = getString(name); @@ -122,8 +127,9 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { * Same as {@link #getString(String)} but converts the value to an integer. * * @param name The URL parameter name. - * @return The parameter value, or <code>0</code> if parameter not specified or has no value - * (e.g. <js>"&foo"</js>. + * @return + * The parameter value, or <code>0</code> if parameter not specified or has no value + * (e.g. <js>"&foo"</js>. */ public int getInt(String name) { return getInt(name, 0); @@ -134,8 +140,9 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { * * @param name The URL parameter name. * @param def The default value. - * @return The parameter value, or the default value if parameter not specified or has no value - * (e.g. <js>"&foo"</js>. + * @return + * The parameter value, or the default value if parameter not specified or has no value + * (e.g. <js>"&foo"</js>. */ public int getInt(String name, int def) { String s = getString(name); @@ -146,8 +153,9 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { * Same as {@link #getString(String)} but converts the value to a boolean. * * @param name The URL parameter name. - * @return The parameter value, or <jk>false</jk> if parameter not specified or has no value - * (e.g. <js>"&foo"</js>. + * @return + * The parameter value, or <jk>false</jk> if parameter not specified or has no value + * (e.g. <js>"&foo"</js>. */ public boolean getBoolean(String name) { return getBoolean(name, false); @@ -158,8 +166,9 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { * * @param name The URL parameter name. * @param def The default value. - * @return The parameter value, or the default value if parameter not specified or has no value - * (e.g. <js>"&foo"</js>. + * @return + * The parameter value, or the default value if parameter not specified or has no value + * (e.g. <js>"&foo"</js>. */ public boolean getBoolean(String name, boolean def) { String s = getString(name); @@ -168,6 +177,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { /** * Returns the specified query parameter value converted to a POJO. + * * <p> * This method can be used to retrieve a parameter without triggering the underlying servlet API to load and parse * the request body. @@ -216,9 +226,11 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { /** * Returns the specified query parameter value converted to a POJO. + * * <p> * This method can be used to retrieve a parameter without triggering the underlying servlet API to load and parse * the request body. + * * <p> * Use this method if you want to parse into a parameterized <code>Map</code>/<code>Collection</code> object. * @@ -238,13 +250,15 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { * </p> * * @param name The parameter name. - * @param type The type of object to create. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * @param args The type arguments of the class if it's a collection or map. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * <br>Ignored if the main type is not a map or collection. + * @param type + * The type of object to create. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * @param args + * The type arguments of the class if it's a collection or map. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * <br>Ignored if the main type is not a map or collection. * @param <T> The class type to convert the parameter value to. * @return The parameter value converted to the specified class type. * @throws ParseException @@ -257,13 +271,15 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { * Same as {@link #get(String, Class)} except returns a default value if not found. * * @param name The parameter name. - * @param type The type of object to create. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * @param args The type arguments of the class if it's a collection or map. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * <br>Ignored if the main type is not a map or collection. + * @param type + * The type of object to create. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * @param args + * The type arguments of the class if it's a collection or map. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * <br>Ignored if the main type is not a map or collection. * @param def The default value if the parameter was not specified or is <jk>null</jk>. * @param <T> The class type to convert the parameter value to. * @return The parameter value converted to the specified class type. @@ -276,6 +292,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { /** * Same as {@link #get(String, Class)} except for use on multi-part parameters * (e.g. <js>"&key=1&key=2&key=3"</js> instead of <js>"&key=(1,2,3)"</js>). + * * <p> * This method must only be called when parsing into classes of type Collection or array. * @@ -292,17 +309,20 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { /** * Same as {@link #get(String, Type, Type...)} except for use on multi-part parameters * (e.g. <js>"&key=1&key=2&key=3"</js> instead of <js>"&key=(1,2,3)"</js>). + * * <p> * This method must only be called when parsing into classes of type Collection or array. * * @param name The query parameter name. - * @param type The type of object to create. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * @param args The type arguments of the class if it's a collection or map. - * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, - * {@link GenericArrayType} - * <br>Ignored if the main type is not a map or collection. + * @param type + * The type of object to create. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * @param args + * The type arguments of the class if it's a collection or map. + * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, + * {@link GenericArrayType} + * <br>Ignored if the main type is not a map or collection. * @param <T> The class type to convert the parameter value to. * @return The query parameter value converted to the specified class type. * @throws ParseException @@ -326,6 +346,7 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { /** * Locates the special search query arguments in the query and returns them as a {@link SearchArgs} object. + * * <p> * The query arguments are as follows: * <ul> @@ -350,11 +371,13 @@ public final class RequestQuery extends LinkedHashMap<String,String[]> { * <js>"&i="</js> - The case-insensitive search flag. * <br>Example: <js>"&i=true"</js> * </ul> + * * <p> * Whitespace is trimmed in the parameters. * - * @return A new {@link SearchArgs} object initialized with the special search query arguments. - * <jk>null</jk> if no search arguments were found. + * @return + * A new {@link SearchArgs} object initialized with the special search query arguments. + * <jk>null</jk> if no search arguments were found. */ public SearchArgs getSearchArgs() { if (hasAny("s","v","o","p","l","i")) {
