You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2018/01/14 16:02:36 UTC
[08/32] juneau git commit: Javadoc updates.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
index b5e7fd2..5387299 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
@@ -17,31 +17,31 @@ import org.apache.juneau.utils.*;
/**
* JVM args variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$ARG{argNameOrNum}"</js> or <js>"$ARG{argNameOrNum,defaultValue}"</js>
- *
+ *
* <p>
* This variable resolver requires that an {@link Args} object be set as a context object on the resolver or a
* session object on the resolver session.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create an args object from the main(String[]) method.</jc>
* Args args = new Args(argv);
- *
+ *
* <jc>// Create a variable resolver that resolves JVM arguments (e.g. "$ARG{1}")</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(ArgsVar.<js>class</js>)
* .addContextObject(<jsf>SESSION_args</jsf>, args);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"Arg #1 is set to $ARG{1}"</js>));
* </p>
- *
+ *
* <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.
- *
+ *
* @see org.apache.juneau.utils.Args
* @see org.apache.juneau.svl
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceAndRecurseVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceAndRecurseVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceAndRecurseVar.java
index bcfda2c..4dd0471 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceAndRecurseVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceAndRecurseVar.java
@@ -16,7 +16,7 @@ import org.apache.juneau.svl.*;
/**
* A basic variable resolver that returns the first non-null value.
- *
+ *
* <p>
* The format for this var is <js>"$CR{arg1[,arg2...]}"</js>.
*
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceVar.java
index cbc198a..6844a3a 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/CoalesceVar.java
@@ -16,7 +16,7 @@ import org.apache.juneau.svl.*;
/**
* A basic variable resolver that returns the first non-null value.
- *
+ *
* <p>
* The format for this var is <js>"$CO{arg1[,arg2...]}"</js>.
*
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/EnvVariablesVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/EnvVariablesVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/EnvVariablesVar.java
index 7a78664..f9da2fd 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/EnvVariablesVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/EnvVariablesVar.java
@@ -16,23 +16,23 @@ import org.apache.juneau.svl.*;
/**
* Environment variable variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$E{envVar[,defaultValue]}"</js>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a variable resolver that resolves environment variables (e.g. "$E{PATH}")</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(EnvVariablesVar.<js>class</js>);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"Environment variable PATH is set to $E{PATH}"</js>));
* </p>
- *
+ *
* <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.
- *
+ *
* @see org.apache.juneau.svl
*/
public class EnvVariablesVar extends DefaultingVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/IfVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/IfVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/IfVar.java
index 4f7d9b6..e26f306 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/IfVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/IfVar.java
@@ -18,33 +18,33 @@ import org.apache.juneau.svl.*;
/**
* A basic if-else logic variable resolver.
- *
+ *
* <p>
* The format for this var is one of the following:
* <ul>
* <li><js>"$IF{booleanArg,thenValue}"</js>
* <li><js>"$IF{booleanArg,thenValue,elseValue}"</js>
* </ul>
- *
+ *
* <p>
* The boolean argument is any string.
* <br>The following values are interpreted as <jk>true</jk>: <js>"true"</js>,<js>"TRUE"</js>,<js>"t"</js>,
* <js>"T"</js>,<js>"1"</js>.
* <br>All else are interpreted as <jk>false</jk>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a variable resolver that resolves system properties and $IF vars.</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(IfVar.<jk>class</jk>, SystemPropertiesVar.<jk>class</jk>);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"Property $IF{$S{someBooleanFlag},IS,IS NOT} set!"</js>));
* </p>
- *
+ *
* <p>
* Since this is a {@link MultipartVar}, 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
*/
public class IfVar extends MultipartVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java
index 18eb086..d6bbc83 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ManifestFileVar.java
@@ -17,31 +17,31 @@ import org.apache.juneau.utils.*;
/**
* Manifest file entries variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$MF{key}"</js> or <js>"$MF{key,defaultValue}"</js>
- *
+ *
* <p>
* This variable resolver requires that a {@link ManifestFile} object be set as a context object on the resolver or a
* session object on the resolver session.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a ManifestFile object that contains the manifest of the jar file containing this class.</jc>
* ManifestFile mf = <jk>new</jk> ManifestFile(<jk>this</jk>.getClass());
- *
+ *
* <jc>// Create a variable resolver that resolves manifest file entries (e.g. "$MF{Main-Class}")</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(ManifestFile.<js>class</js>)
* .addContextObject(<jsf>SESSION_manifest</jsf>, mf);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"The main class is $MF{Main-Class}"</js>));
* </p>
- *
+ *
* <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.
- *
+ *
* @see org.apache.juneau.utils.ManifestFile
* @see org.apache.juneau.svl
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java
index 11dce68..e51740c 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SwitchVar.java
@@ -20,7 +20,7 @@ import org.apache.juneau.svl.*;
/**
* A basic switch/case logic variable resolver.
- *
+ *
* <p>
* The format for this var is one of the following:
* <ul>
@@ -30,20 +30,20 @@ import org.apache.juneau.svl.*;
* <li><js>"$SW{stringArg,pattern,thenValue,pattern,thenValue,elsePattern}"</js>
* <li>...
* </ul>
- *
+ *
* <p>
* The pattern can be any string optionally containing <js>'*'</js> or <js>'?'</js> representing any or one character
* respectively.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a variable resolver that resolves system properties and $SW vars.</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(SwitchVar.<jk>class</jk>, SystemPropertiesVar.<jk>class</jk>);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"We are running on $SW{$P{os.name},*win*,Windows,Something else}!"</js>));
* </p>
- *
+ *
* <p>
* Since this is a {@link MultipartVar}, 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.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SystemPropertiesVar.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SystemPropertiesVar.java b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SystemPropertiesVar.java
index a147f39..2218df7 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SystemPropertiesVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/SystemPropertiesVar.java
@@ -16,23 +16,23 @@ import org.apache.juneau.svl.*;
/**
* System property variable resolver.
- *
+ *
* <p>
* The format for this var is <js>"$S{systemProperty[,defaultValue]}"</js></js>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create a variable resolver that resolves system properties (e.g. "$S{java.home}")</jc>
* VarResolver r = <jk>new</jk> VarResolver().addVars(SystemPropertiesVar.<js>class</js>);
- *
+ *
* <jc>// Use it!</jc>
* System.<jsf>out</jsf>.println(r.resolve(<js>"java.home is set to $S{java.home}"</js>));
* </p>
- *
+ *
* <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.
- *
+ *
* @see org.apache.juneau.svl
*/
public class SystemPropertiesVar extends MapVar {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonConfigurationExample.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonConfigurationExample.java b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonConfigurationExample.java
index dd53f7d..31b9205 100644
--- a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonConfigurationExample.java
+++ b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonConfigurationExample.java
@@ -6,9 +6,9 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonSimpleExample.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonSimpleExample.java b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonSimpleExample.java
index 565dc14..7c53e22 100644
--- a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonSimpleExample.java
+++ b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/json/JsonSimpleExample.java
@@ -6,9 +6,9 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/pojo/Pojo.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/pojo/Pojo.java b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/pojo/Pojo.java
index 46e9308..86e974a 100644
--- a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/pojo/Pojo.java
+++ b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/pojo/Pojo.java
@@ -6,9 +6,9 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/rdf/RdfExample.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/rdf/RdfExample.java b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/rdf/RdfExample.java
index a5f0643..b9353ad 100644
--- a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/rdf/RdfExample.java
+++ b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/rdf/RdfExample.java
@@ -6,9 +6,9 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-examples/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/RestTestcase.java
----------------------------------------------------------------------
diff --git a/juneau-examples/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/RestTestcase.java b/juneau-examples/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/RestTestcase.java
index 8b7471a..cff048b 100644
--- a/juneau-examples/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/RestTestcase.java
+++ b/juneau-examples/juneau-examples-rest/src/test/java/org/apache/juneau/examples/rest/RestTestcase.java
@@ -16,7 +16,7 @@ import org.junit.*;
/**
* Superclass of REST testcases that start up the REST test microservice before running the tests locally.
- *
+ *
* @author James Bognar (james.bognar@salesforce.com)
*/
public class RestTestcase {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Microservice.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Microservice.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Microservice.java
index 1067e30..1671e2c 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Microservice.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Microservice.java
@@ -47,9 +47,9 @@ import org.apache.juneau.utils.*;
* <p>
* Your microservice class must be specified as the <jk>Main-Class</jk> entry in the manifest file of your microservice
* jar file.
- *
+ *
* <h6 class='topic'>Microservice Configuration</h6>
- *
+ *
* This class defines the following method for accessing configuration for your microservice:
* <ul class='spaced-list'>
* <li>
@@ -59,9 +59,9 @@ import org.apache.juneau.utils.*;
* <li>
* {@link #getManifest()} - The manifest file for the main jar file.
* </ul>
- *
+ *
* <h6 class='topic'>Entry point Method</h6>
- *
+ *
* 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 class='bcode'>
@@ -69,9 +69,9 @@ import org.apache.juneau.utils.*;
* <jk>new</jk> MyMicroservice(args).start();
* }
* </p>
- *
+ *
* <h6 class='topic'>Lifecycle Methods</h6>
- *
+ *
* Subclasses must implement the following lifecycle methods:
* <ul class='spaced-list'>
* <li>
@@ -81,9 +81,9 @@ import org.apache.juneau.utils.*;
* <li>
* {@link #kill()} - Can be used to forcibly shut down the service. Doesn't get called during normal operation.
* </ul>
- *
+ *
* <h6 class='topic'>Lifecycle Listener Methods</h6>
- *
+ *
* Subclasses can optionally implement the following event listener methods:
* <ul class='spaced-list'>
* <li>
@@ -95,9 +95,9 @@ import org.apache.juneau.utils.*;
* <li>
* {@link #onConfigChange(ConfigFile, Set)} - Gets executed after a config file has been modified.
* </ul>
- *
+ *
* <h6 class='topic'>Other Methods</h6>
- *
+ *
* Subclasses can optionally override the following methods to provide customized behavior:
* <ul class='spaced-list'>
* <li>
@@ -139,7 +139,7 @@ public abstract class Microservice {
/**
* Constructor.
- *
+ *
* @param args Command line arguments.
* @throws Exception
*/
@@ -172,7 +172,7 @@ public abstract class Microservice {
*
* <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.
* @param create Create the file if it doesn't exist.
* @return This object (for method chaining).
@@ -196,7 +196,7 @@ public abstract class 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()}.
- *
+ *
* @param cf The config file for this application, or <jk>null</jk> if no config file is needed.
*/
public void setConfig(ConfigFile cf) {
@@ -214,7 +214,7 @@ public abstract class Microservice {
* is located in the project root.
* <li>Using the class loader for this class to find the file at the URL <js>"META-INF/MANIFEST.MF"</js>.
* </ol>
- *
+ *
* @param mf The manifest file of this microservice.
*/
public void setManifest(Manifest mf) {
@@ -223,7 +223,7 @@ public abstract class Microservice {
/**
* Convenience method for specifying the manifest contents directly.
- *
+ *
* @param contents The lines in the manifest file.
* @return This object (for method chaining).
* @throws IOException
@@ -236,7 +236,7 @@ public abstract class Microservice {
/**
* Same as {@link #setManifest(Manifest)} except specified through a {@link File} object.
- *
+ *
* @param f The manifest file of this microservice.
* @throws IOException If a problem occurred while trying to read the manifest file.
*/
@@ -247,7 +247,7 @@ public abstract class Microservice {
/**
* 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.
* @throws IOException If a problem occurred while trying to read the manifest file.
*/
@@ -273,7 +273,7 @@ public abstract class Microservice {
*
* <p>
* Subclasses can override this method to provide their own variables.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jd>/**
@@ -301,7 +301,7 @@ public abstract class Microservice {
* <jc>// Example java code</jc>
* String myentry = getConfig().getString(<js>"MySection/myEntry"</js>); <jc>// == "[foo]"</js>
* </p>
- *
+ *
* @return A new {@link VarResolver}.
*/
protected VarResolverBuilder createVarResolver() {
@@ -323,7 +323,7 @@ public abstract class Microservice {
*
* <p>
* See {@link Args} for details on using this method.
- *
+ *
* @return The command-line arguments passed into the application.
*/
public Args getArgs() {
@@ -356,50 +356,50 @@ public abstract class Microservice {
*
* <p>
* This method can be called from the class constructor.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <cc>#--------------------------</cc>
* <cc># My section</cc>
* <cc>#--------------------------</cc>
* <cs>[MySection]</cs>
- *
+ *
* <cc># An integer</cc>
* <ck>anInt</ck> = 1
- *
+ *
* <cc># A boolean</cc>
* <ck>aBoolean</ck> = true
- *
+ *
* <cc># An int array</cc>
* <ck>anIntArray</ck> = 1,2,3
- *
+ *
* <cc># A POJO that can be converted from a String</cc>
* <ck>aURL</ck> = http://foo
- *
+ *
* <cc># A POJO that can be converted from JSON</cc>
* <ck>aBean</ck> = {foo:'bar',baz:123}
- *
+ *
* <cc># A system property</cc>
* <ck>locale</ck> = $S{java.locale, en_US}
- *
+ *
* <cc># An environment variable</cc>
* <ck>path</ck> = $E{PATH, unknown}
- *
+ *
* <cc># A manifest file entry</cc>
* <ck>mainClass</ck> = $MF{Main-Class}
- *
+ *
* <cc># Another value in this config file</cc>
* <ck>sameAsAnInt</ck> = $C{MySection/anInt}
- *
+ *
* <cc># A command-line argument in the form "myarg=foo"</cc>
* <ck>myArg</ck> = $ARG{myarg}
- *
+ *
* <cc># The first command-line argument</cc>
* <ck>firstArg</ck> = $ARG{0}
- *
+ *
* <cc># Look for system property, or env var if that doesn't exist, or command-line arg if that doesn't exist.</cc>
* <ck>nested</ck> = $S{mySystemProperty,$E{MY_ENV_VAR,$ARG{0}}}
- *
+ *
* <cc># A POJO with embedded variables</cc>
* <ck>aBean2</ck> = {foo:'$ARG{0}',baz:$C{MySection/anInt}}
* </p>
@@ -407,7 +407,7 @@ public abstract class Microservice {
* <p class='bcode'>
* <jc>// Java code for accessing config entries above.</jc>
* ConfigFile cf = getConfig();
- *
+ *
* <jk>int</jk> anInt = cf.getInt(<js>"MySection/anInt"</js>);
* <jk>boolean</jk> aBoolean = cf.getBoolean(<js>"MySection/aBoolean"</js>);
* <jk>int</jk>[] anIntArray = cf.getObject(<jk>int</jk>[].<jk>class</jk>, <js>"MySection/anIntArray"</js>);
@@ -420,7 +420,7 @@ public abstract class Microservice {
* String myArg = cf.getString(<js>"MySection/myArg"</js>);
* String firstArg = cf.getString(<js>"MySection/firstArg"</js>);
* </p>
- *
+ *
* @return The config file for this application, or <jk>null</jk> if no config file is configured.
*/
public ConfigFile getConfig() {
@@ -435,16 +435,16 @@ public abstract class Microservice {
* simple strings.
* <p>
* This method can be called from the class constructor.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Get Main-Class from manifest file.</jc>
* String mainClass = Microservice.<jsm>getManifest</jsm>().getString(<js>"Main-Class"</js>, <js>"unknown"</js>);
- *
+ *
* <jc>// Get Rest-Resources from manifest file.</jc>
* String[] restResources = Microservice.<jsm>getManifest</jsm>().getStringArray(<js>"Rest-Resources"</js>);
* </p>
- *
+ *
* @return The manifest file from the main jar, or <jk>null</jk> if the manifest file could not be retrieved.
*/
public ManifestFile getManifest() {
@@ -483,7 +483,7 @@ public abstract class Microservice {
*
* <p>
* Overridden methods MUST call this method FIRST so that the {@link #onStart()} method is called.
- *
+ *
* @return This object (for method chaining).
* @throws Exception
*/
@@ -611,7 +611,7 @@ public abstract class Microservice {
*
* <p>
* Note that this is typically started after all initialization has occurred so that the console output isn't polluted.
- *
+ *
* @return This object (for method chaining).
* @throws Exception
*/
@@ -675,25 +675,25 @@ public abstract class Microservice {
* # See FileHandler Java class for details.
* #================================================================================</cc>
* <cs>[Logging]</cs>
- *
+ *
* <cc># The directory where to create the log file.
* # Default is ".".</cc>
* <ck>logDir</ck> = logs
- *
+ *
* <cc># The name of the log file to create for the main logger.
* # The logDir and logFile make up the pattern that's passed to the FileHandler
* # constructor.
* # If value is not specified, then logging to a file will not be set up.</cc>
* <ck>logFile</ck> = microservice.%g.log
- *
+ *
* <cc># Whether to append to the existing log file or create a new one.
* # Default is false.</cc>
* <ck>append</ck> =
- *
+ *
* <cc># The SimpleDateFormat format to use for dates.
* # Default is "yyyy.MM.dd hh:mm:ss".</cc>
* <ck>dateFormat</ck> =
- *
+ *
* <cc># The log message format.
* # The value can contain any of the following variables:
* # {date} - The date, formatted per dateFormat.
@@ -706,32 +706,32 @@ public abstract class Microservice {
* # {exception} - The localized exception message.
* # Default is "[{date} {level}] {msg}%n".</cc>
* <ck>format</ck> =
- *
+ *
* <cc># The maximum log file size.
* # Suffixes available for numbers.
* # See ConfigFile.getInt(String,int) for details.
* # Default is 1M.</cc>
* <ck>limit</ck> = 10M
- *
+ *
* <cc># Max number of log files.
* # Default is 1.</cc>
* <ck>count</ck> = 5
- *
+ *
* <cc># Default log levels.
* # Keys are logger names.
* # Values are serialized Level POJOs.</cc>
* <ck>levels</ck> = { org.apache.juneau:'INFO' }
- *
+ *
* <cc># Only print unique stack traces once and then refer to them by a simple 8 character hash identifier.
* # Useful for preventing log files from filling up with duplicate stack traces.
* # Default is false.</cc>
* <ck>useStackTraceHashes</ck> = true
- *
+ *
* <cc># The default level for the console logger.
* # Default is WARNING.</cc>
* <ck>consoleLevel</ck> = WARNING
* </p>
- *
+ *
* @throws Exception
*/
protected void initLogging() throws Exception {
@@ -770,7 +770,7 @@ public abstract class Microservice {
*
* <p>
* Default implementation is a no-op.
- *
+ *
* @return This object (for method chaining).
* @throws Exception
*/
@@ -786,7 +786,7 @@ public abstract class Microservice {
*
* <p>
* Overridden methods MUST call this method LAST so that the {@link #onStop()} method is called.
- *
+ *
* @return This object (for method chaining).
*/
public Microservice stop() {
@@ -829,7 +829,7 @@ public abstract class Microservice {
*
* <p>
* Subclasses can override this method to listen for config file changes.
- *
+ *
* @param cf The config file.
*/
protected void onConfigSave(ConfigFile cf) {}
@@ -839,7 +839,7 @@ public abstract class Microservice {
*
* <p>
* Subclasses can override this method to listen for config file changes.
- *
+ *
* @param cf The config file.
* @param changes The list of keys in the config file being changed.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Resource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Resource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Resource.java
index d98a293..9baf89b 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Resource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/Resource.java
@@ -28,7 +28,7 @@ import org.apache.juneau.svl.vars.*;
* <li>
* <code class='snippet'>$ARG{...}</code> - Command line arguments pulled from {@link Microservice#getArgs()}.
*
- * <h6 class='figure'>Example:</h6>
+ * <h6 class='figure'>Example:</h6>
* <p class='bcode'>
* String firstArg = request.getVarResolver().resolve(<js>"$ARG{0}"</js>); <jc>// First argument.</jc>
* String namedArg = request.getVarResolver().resolve(<js>"$ARG{myarg}"</js>); <jc>// Named argument (e.g. "myarg=foo"). </jc>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/RestMicroservice.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/RestMicroservice.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/RestMicroservice.java
index 1e71d57..513e2ef 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/RestMicroservice.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/RestMicroservice.java
@@ -32,21 +32,22 @@ import org.eclipse.jetty.xml.*;
/**
* Entry point for Juneau microservice that implements a REST interface using Jetty on a single port.
- *
+ *
* <h6 class='topic'>Jetty Server Details</h6>
*
* 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>
*
* Top-level REST resources are defined in the <code>jetty.xml</code> file as normal servlets.
- *
- * <h6 class='topic'>Logging</h6>
+ *
+ *
+ * <h5 class='topic'>Logging</h5>
*
* Logging is initialized by the {@link #initLogging()} method.
* This method can be overridden to provide customized logging behavior.
- *
+ *
* <h6 class='topic'>Lifecycle Listener Methods</h6>
* Subclasses can optionally implement the following event listener methods:
* <ul class='spaced-list'>
@@ -93,7 +94,7 @@ public class RestMicroservice extends Microservice {
*
* <p>
* Subclasses must also implement this method!
- *
+ *
* @param args Command line arguments.
* @throws Exception
*/
@@ -103,7 +104,7 @@ public class RestMicroservice extends Microservice {
/**
* Constructor.
- *
+ *
* @param args Command line arguments.
* @throws Exception
*/
@@ -282,7 +283,7 @@ public class RestMicroservice extends Microservice {
* # jetty.xml file as "$S{availablePort}" (assuming resolveVars is enabled).</cc>
* <ck>port</ck> = 10000,0,0,0
* </p>
- *
+ *
* @return The newly-created server.
* @throws Exception
*/
@@ -389,7 +390,7 @@ public class RestMicroservice extends Microservice {
*
* <p>
* Subclasses can override this method to customize server startup.
- *
+ *
* @return The port that this server started on.
* @throws Exception
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ConfigResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ConfigResource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ConfigResource.java
index ef020af..c7c9de2 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ConfigResource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ConfigResource.java
@@ -47,7 +47,7 @@ public class ConfigResource extends Resource {
/**
* [GET /] - Show contents of config file.
- *
+ *
* @return The config file.
* @throws Exception
*/
@@ -58,7 +58,7 @@ public class ConfigResource extends Resource {
/**
* [GET /edit] - Show config file edit page.
- *
+ *
* @param req The HTTP request.
* @return The config file as a reader resource.
* @throws Exception
@@ -81,7 +81,7 @@ public class ConfigResource extends Resource {
/**
* [GET /{section}] - Show config file section.
- *
+ *
* @param section The section name.
* @return The config file section.
* @throws Exception
@@ -100,7 +100,7 @@ public class ConfigResource extends Resource {
/**
* [GET /{section}/{key}] - Show config file entry.
- *
+ *
* @param section The section name.
* @param key The section key.
* @return The value of the config file entry.
@@ -121,7 +121,7 @@ public class ConfigResource extends Resource {
/**
* [POST /] - Sets contents of config file from a FORM post.
- *
+ *
* @param contents The new contents of the config file.
* @return The new config file contents.
* @throws Exception
@@ -140,7 +140,7 @@ public class ConfigResource extends Resource {
/**
* [PUT /] - Sets contents of config file.
- *
+ *
* @param contents The new contents of the config file.
* @return The new config file contents.
* @throws Exception
@@ -160,7 +160,7 @@ public class ConfigResource extends Resource {
/**
* [PUT /{section}] - Add or overwrite a config file section.
- *
+ *
* @param section The section name.
* @param contents The new contents of the config file section.
* @return The new section.
@@ -182,7 +182,7 @@ public class ConfigResource extends Resource {
/**
* [PUT /{section}/{key}] - Add or overwrite a config file entry.
- *
+ *
* @param section The section name.
* @param key The section key.
* @param value The new value.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
index e0e7b74..11d08a4 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/DirectoryResource.java
@@ -114,7 +114,7 @@ public class DirectoryResource extends Resource {
/**
* [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
* file or directory.
@@ -152,7 +152,7 @@ public class DirectoryResource extends Resource {
/**
* [DELETE /*] - Delete a file on the file system.
- *
+ *
* @param req The HTTP request.
* @return The message <js>"File deleted"</js> if successful.
* @throws Exception If file could not be read or access was not granted.
@@ -173,7 +173,7 @@ public class DirectoryResource extends Resource {
/**
* [PUT /*] - Add or overwrite a file on the file system.
- *
+ *
* @param req The HTTP request.
* @return The message <js>"File added"</js> if successful.
* @throws Exception If file could not be read or access was not granted.
@@ -199,7 +199,7 @@ public class DirectoryResource extends Resource {
*
* <p>
* Applies to files only.
- *
+ *
* @param req The HTTP request.
* @param res The HTTP response.
* @return A Reader containing the contents of the file.
@@ -228,7 +228,7 @@ public class DirectoryResource extends Resource {
*
* <p>
* Applies to files only.
- *
+ *
* @param req The HTTP request.
* @param res The HTTP response.
* @return A Reader containing the contents of the file.
@@ -258,7 +258,7 @@ public class DirectoryResource extends Resource {
* <p>
* Subclasses can override this method to provide customized behavior.
* Method should throw a {@link RestException} if the request should be disallowed.
- *
+ *
* @param req The HTTP request.
*/
protected void checkAccess(RestRequest req) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java
index 02a2dcf..91c36d6 100644
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogEntryFormatter.java
@@ -50,7 +50,7 @@ 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:
@@ -182,7 +182,7 @@ public class LogEntryFormatter extends Formatter {
/**
* Returns the regular expression pattern used for matching log entries.
- *
+ *
* @return The regular expression pattern used for matching log entries.
*/
public Pattern getLogEntryPattern() {
@@ -191,7 +191,7 @@ public class LogEntryFormatter extends Formatter {
/**
* Returns the {@link DateFormat} used for matching dates.
- *
+ *
* @return The {@link DateFormat} used for matching dates.
*/
public DateFormat getDateFormat() {
@@ -201,7 +201,7 @@ public class LogEntryFormatter extends Formatter {
/**
* 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:
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogParser.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogParser.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogParser.java
index ca5c896..229277d 100644
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogParser.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogParser.java
@@ -35,7 +35,7 @@ public final class LogParser implements Iterable<LogParser.Entry>, Iterator<LogP
/**
* Constructor.
- *
+ *
* @param formatter The log entry formatter.
* @param f The log file.
* @param start Don't return rows before this date. If <jk>null</jk>, start from the beginning of the file.
@@ -111,7 +111,7 @@ public final class LogParser implements Iterable<LogParser.Entry>, Iterator<LogP
/**
* 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/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
index c5f9932..173872b 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/LogsResource.java
@@ -84,7 +84,7 @@ public class LogsResource extends Resource {
/**
* [GET /*] - Get file details or directory listing.
- *
+ *
* @param req The HTTP request
* @param res The HTTP response
* @param properties The writable properties for setting the descriptions.
@@ -120,7 +120,7 @@ public class LogsResource extends Resource {
/**
* [VIEW /*] - Retrieve the contents of a log file.
- *
+ *
* @param req The HTTP request.
* @param res The HTTP response.
* @param path The log file path.
@@ -190,7 +190,7 @@ public class LogsResource extends Resource {
/**
* [VIEW /*] - Retrieve the contents of a log file as parsed entries.
- *
+ *
* @param req The HTTP request.
* @param path The log file path.
* @param start Optional start timestamp. Don't print lines logged before the specified timestamp. Example: "&start=2014-01-23 11:25:47".
@@ -222,7 +222,7 @@ public class LogsResource extends Resource {
/**
* [DOWNLOAD /*] - Download file.
- *
+ *
* @param res The HTTP response.
* @param path The log file path.
* @return The contents of the log file.
@@ -249,7 +249,7 @@ public class LogsResource extends Resource {
/**
* [DELETE /*] - Delete a file.
- *
+ *
* @param path The log file path.
* @return A redirect object to the root.
* @throws Exception
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ShutdownResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ShutdownResource.java b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ShutdownResource.java
index be66963..e950c15 100755
--- a/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ShutdownResource.java
+++ b/juneau-microservice/juneau-microservice-server/src/main/java/org/apache/juneau/microservice/resources/ShutdownResource.java
@@ -30,7 +30,7 @@ public class ShutdownResource extends Resource {
/**
* [GET /] - Shutdown this resource.
- *
+ *
* @return The string <js>"OK"</js>.
* @throws Exception
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/HtmlDocLinksResource.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/HtmlDocLinksResource.java b/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/HtmlDocLinksResource.java
index 57c1a71..3c54110 100644
--- a/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/HtmlDocLinksResource.java
+++ b/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/HtmlDocLinksResource.java
@@ -143,7 +143,7 @@ public class HtmlDocLinksResource extends RestServletDefault {
)
public static class HtmlDocLinksResource2 extends HtmlDocLinksResource {
/**
- *
+ *
*/
private static final long serialVersionUID = 1L;
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/pojos/Constants.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/pojos/Constants.java b/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/pojos/Constants.java
index 76c469e..ba7aced 100644
--- a/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/pojos/Constants.java
+++ b/juneau-microservice/juneau-microservice-test/src/main/java/org/apache/juneau/rest/test/pojos/Constants.java
@@ -15,7 +15,7 @@ package org.apache.juneau.rest.test.pojos;
/**
* Description.
* <p>
- *
+ *
* @author James Bognar (james.bognar@salesforce.com)
*/
public class Constants {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/GzipTest.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/GzipTest.java b/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/GzipTest.java
index 2df12fd..f6efc23 100644
--- a/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/GzipTest.java
+++ b/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/GzipTest.java
@@ -26,7 +26,7 @@ import org.junit.*;
/**
* Test Accept-Encoding and Content-Encoding handling.
- *
+ *
* Note: WAS does automatic gzip decompression on http request messages, so we have to invent
* our own 'mycoding' compression.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/RestTestcase.java
----------------------------------------------------------------------
diff --git a/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/RestTestcase.java b/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/RestTestcase.java
index 983180e..0a5c2ea 100644
--- a/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/RestTestcase.java
+++ b/juneau-microservice/juneau-microservice-test/src/test/java/org/apache/juneau/rest/test/RestTestcase.java
@@ -22,7 +22,7 @@ import org.junit.*;
/**
* Superclass of REST testcases that start up the REST test microservice before running the tests locally.
- *
+ *
* @author James Bognar (james.bognar@salesforce.com)
*/
public class RestTestcase {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java
index 17e945f..4199936 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/AllowAllRedirects.java
@@ -16,8 +16,9 @@ import org.apache.http.impl.client.*;
/**
* Redirect strategy that allows for redirects on any request type, not just <code>GET</code> or <code>HEAD</code>.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>
* This class is similar to <code>org.apache.http.impl.client.LaxRedirectStrategy</code>
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java
index 98f2412..b5994d7 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/DateHeader.java
@@ -19,7 +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'>
@@ -32,7 +32,7 @@ public final class DateHeader extends BasicHeader {
/**
* Creates a date request property in RFC2616 format.
- *
+ *
* @param name The header name.
* @param value The header value.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/HttpMethod.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/HttpMethod.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/HttpMethod.java
index 9dc0d67..f89b71e 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/HttpMethod.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/HttpMethod.java
@@ -52,7 +52,7 @@ public enum HttpMethod {
/**
* Returns whether this HTTP method normally has content.
- *
+ *
* @return <jk>true</jk> if this HTTP method normally has content.
*/
public boolean hasContent() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java
index d63ea31..2fe804b 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/NameValuePairs.java
@@ -24,11 +24,11 @@ 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* NameValuePairs params = <jk>new</jk> NameValuePairs()
@@ -43,7 +43,7 @@ public final class NameValuePairs extends LinkedList<NameValuePair> {
/**
* Appends the specified pair to the end of this list.
- *
+ *
* @param pair The pair to append to this list.
* @return This object (for method chaining).
*/
@@ -54,10 +54,10 @@ 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>.
- *
+ *
* @param name The pair name.
* @param value The pair value.
* @return This object (for method chaining).
@@ -69,10 +69,10 @@ 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.
- *
+ *
* @param name The pair name.
* @param value The pair value.
* @param partSerializer The serializer to use for converting values to simple strings.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java
----------------------------------------------------------------------
diff --git a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java
index cf491c6..66e55ca 100644
--- a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java
+++ b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/ResponsePattern.java
@@ -17,18 +17,18 @@ 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 class='bcode'>
* <jk>final</jk> List<Number> xList = <jk>new</jk> ArrayList<Number>();
* <jk>final</jk> List<String> yList = <jk>new</jk> ArrayList<String>();
- *
+ *
* restClient.doGet(<jsf>URL</jsf>)
* .addResponsePattern(
* <jk>new</jk> ResponsePattern(<js>"x=(\\d+)"</js>) {
@@ -56,7 +56,7 @@ import java.util.regex.*;
* )
* .run();
* </p>
- *
+ *
* <h5 class='notes'>Important Notes:</h5>
* <ol class='notes'>
* <li>
@@ -80,7 +80,7 @@ public abstract class ResponsePattern {
/**
* Constructor.
- *
+ *
* @param pattern Regular expression pattern.
*/
public ResponsePattern(String pattern) {
@@ -104,7 +104,7 @@ public abstract class ResponsePattern {
/**
* Returns the pattern passed in through the constructor.
- *
+ *
* @return The pattern passed in through the constructor.
*/
protected String getPattern() {
@@ -113,10 +113,10 @@ public abstract class ResponsePattern {
/**
* Instances can override this method to handle when a regular expression pattern matches on the output.
- *
+ *
* <p>
* This method is called once for every pattern match that occurs in the response text.
- *
+ *
* @param rc The {@link RestCall} that this pattern finder is being used on.
* @param m The regular expression {@link Matcher}. Can be used to retrieve group matches in the pattern.
* @throws RestCallException Instances can throw an exception if a failure condition is detected.
@@ -125,7 +125,7 @@ public abstract class ResponsePattern {
/**
* Instances can override this method to handle when a regular expression pattern doesn't match on the output.
- *
+ *
* @param rc The {@link RestCall} that this pattern finder is being used on.
* @throws RestCallException Instances can throw an exception if a failure condition is detected.
*/