Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoakim Erdfelt2015-04-22 21:37:48 -0400
committerJoakim Erdfelt2015-04-22 21:37:55 -0400
commitf7adc1aa5f569590284bfaba561472a9a5e3094f (patch)
tree331772ab2c33fbd11fa8136df446880d7c3d1e96 /jetty-rewrite
parentd434f419d28a730bf3f8f5d9c8c0b20d5e6e0e37 (diff)
downloadorg.eclipse.jetty.project-f7adc1aa5f569590284bfaba561472a9a5e3094f.tar.gz
org.eclipse.jetty.project-f7adc1aa5f569590284bfaba561472a9a5e3094f.tar.xz
org.eclipse.jetty.project-f7adc1aa5f569590284bfaba561472a9a5e3094f.zip
464727 - Update Javadoc for Java 8 DocLint
Diffstat (limited to 'jetty-rewrite')
-rw-r--r--jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderPatternRule.java1
-rw-r--r--jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderRegexRule.java4
-rw-r--r--jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/ResponsePatternRule.java2
-rw-r--r--jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewriteHandler.java1
-rw-r--r--jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewritePatternRule.java16
-rw-r--r--jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/Rule.java12
-rw-r--r--jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RuleContainer.java5
-rw-r--r--jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/ValidUrlRule.java13
8 files changed, 23 insertions, 31 deletions
diff --git a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderPatternRule.java b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderPatternRule.java
index d16ec54a2d..c50139bbd6 100644
--- a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderPatternRule.java
+++ b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderPatternRule.java
@@ -116,6 +116,7 @@ public class HeaderPatternRule extends PatternRule
/* ------------------------------------------------------------ */
/**
* Returns the add flag value.
+ * @return true if add flag set
*/
public boolean isAdd()
{
diff --git a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderRegexRule.java b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderRegexRule.java
index 802307032e..53764dce29 100644
--- a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderRegexRule.java
+++ b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/HeaderRegexRule.java
@@ -109,7 +109,7 @@ public class HeaderRegexRule extends RegexRule
/* ------------------------------------------------------------ */
/**
- * Returns the add flag value.
+ * @return the add flag value.
*/
public boolean isAdd()
{
@@ -118,7 +118,7 @@ public class HeaderRegexRule extends RegexRule
/* ------------------------------------------------------------ */
/**
- * Returns the header contents.
+ * @return the header contents.
*/
@Override
public String toString()
diff --git a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/ResponsePatternRule.java b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/ResponsePatternRule.java
index 01d7c7bea5..825f6f7942 100644
--- a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/ResponsePatternRule.java
+++ b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/ResponsePatternRule.java
@@ -53,7 +53,7 @@ public class ResponsePatternRule extends PatternRule
* Sets the reason for the response status code. Reasons will only reflect
* if the code value is greater or equal to 400.
*
- * @param reason
+ * @param reason the reason
*/
public void setReason(String reason)
{
diff --git a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewriteHandler.java b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewriteHandler.java
index fc0dfe0892..3eab973187 100644
--- a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewriteHandler.java
+++ b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewriteHandler.java
@@ -54,7 +54,6 @@ import org.eclipse.jetty.server.handler.HandlerWrapper;
* <li> {@link RewritePatternRule} - rewrites the requested URI. </li>
* <li> {@link RewriteRegexRule} - rewrites the requested URI using regular expression for pattern matching. </li>
* <li> {@link MsieSslRule} - disables the keep alive on SSL for IE5 and IE6. </li>
- * <li> {@link LegacyRule} - the old version of rewrite. </li>
* <li> {@link ForwardedSchemeHeaderRule} - set the scheme according to the headers present. </li>
* <li> {@link VirtualHostRuleContainer} - checks whether the request matches one of a set of virtual host names.</li>
* </ul>
diff --git a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewritePatternRule.java b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewritePatternRule.java
index 4d9c980e5c..3c86530ba6 100644
--- a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewritePatternRule.java
+++ b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RewritePatternRule.java
@@ -56,12 +56,6 @@ public class RewritePatternRule extends PatternRule implements Rule.ApplyURI
}
/* ------------------------------------------------------------ */
- /*
- * (non-Javadoc)
- *
- * @see org.eclipse.jetty.server.handler.rules.RuleBase#apply(javax.servlet.http.HttpServletRequest,
- * javax.servlet.http.HttpServletResponse)
- */
@Override
public String apply(String target, HttpServletRequest request, HttpServletResponse response) throws IOException
{
@@ -73,14 +67,14 @@ public class RewritePatternRule extends PatternRule implements Rule.ApplyURI
/**
* This method will add _query to the requests's queryString and also combine it with existing queryStrings in
* the request. However it won't take care for duplicate. E.g. if request.getQueryString contains a parameter
- * "param1 = true" and _query will contain "param1=false" the result will be param1=true&param1=false.
+ * <code>param1 = true</code> and _query will contain <code>param1=false</code> the result will be <code>param1=true&amp;param1=false</code>.
* To cover this use case some more complex pattern matching is necessary. We can implement this if there's use
* cases.
*
- * @param request
- * @param oldURI
- * @param newURI
- * @throws IOException
+ * @param request the request
+ * @param oldURI the old URI
+ * @param newURI the new URI
+ * @throws IOException if unable to apply the URI
*/
@Override
public void applyURI(Request request, String oldURI, String newURI) throws IOException
diff --git a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/Rule.java b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/Rule.java
index d3e5ffc54b..7bd5c63c4d 100644
--- a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/Rule.java
+++ b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/Rule.java
@@ -44,20 +44,18 @@ public abstract class Rule
/**
* This method calls tests the rule against the request/response pair and if the Rule
* applies, then the rule's action is triggered.
- * @param target The target of the request
- * @param request
- * @param response
*
+ * @param target The target of the request
+ * @param request the request
+ * @param response the response
* @return The new target if the rule has matched, else null
- * @throws IOException
+ * @throws IOException if unable to match the rule
*/
public abstract String matchAndApply(String target, HttpServletRequest request, HttpServletResponse response) throws IOException;
/**
* Sets terminating to true or false.
- * If true, this rule will terminate the loop if this rule has been applied.
- *
- * @param terminating
+ * @param terminating If true, this rule will terminate the loop if this rule has been applied.
*/
public void setTerminating(boolean terminating)
{
diff --git a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RuleContainer.java b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RuleContainer.java
index cd6efd3a2d..e7974964f8 100644
--- a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RuleContainer.java
+++ b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/RuleContainer.java
@@ -32,10 +32,7 @@ import org.eclipse.jetty.util.log.Logger;
/**
* Base container to group rules. Can be extended so that the contained rules
* will only be applied under certain conditions
- *
- *
*/
-
public class RuleContainer extends Rule
{
private static final Logger LOG = Log.getLogger(RuleContainer.class);
@@ -154,6 +151,8 @@ public class RuleContainer extends Rule
* @param target target field to pass on to the contained rules
* @param request request object to pass on to the contained rules
* @param response response object to pass on to the contained rules
+ * @return the target
+ * @throws IOException if unable to apply the rule
*/
protected String apply(String target, HttpServletRequest request, HttpServletResponse response) throws IOException
{
diff --git a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/ValidUrlRule.java b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/ValidUrlRule.java
index ebe97b552a..21e981267f 100644
--- a/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/ValidUrlRule.java
+++ b/jetty-rewrite/src/main/java/org/eclipse/jetty/rewrite/handler/ValidUrlRule.java
@@ -29,12 +29,13 @@ import org.eclipse.jetty.util.log.Logger;
/**
* This rule can be used to protect against invalid unicode characters in a url making it into applications.
- *
+ * <p>
* The logic is as follows.
- *
- * - if decoded uri character is an iso control character return code/reason
- * - if no UnicodeBlock is found for character return code/reason
- * - if character is in UnicodeBlock.SPECIALS return code/reason
+ * <ul>
+ * <li>if decoded uri character is an iso control character return code/reason</li>
+ * <li>if no UnicodeBlock is found for character return code/reason</li>
+ * <li>if character is in UnicodeBlock.SPECIALS return code/reason</li>
+ * </ul>
*/
public class ValidUrlRule extends Rule
{
@@ -65,7 +66,7 @@ public class ValidUrlRule extends Rule
/**
* Sets the reason for the response status code. Reasons will only reflect if the code value is greater or equal to 400.
*
- * @param reason
+ * @param reason the reason
*/
public void setReason(String reason)
{

Back to the top