trivial: updated JavaDoc to allow releases with JRE >= 1.8
git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1690768 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/sling/servlets/get/impl/RedirectServlet.java b/src/main/java/org/apache/sling/servlets/get/impl/RedirectServlet.java
index 8965b6d..a93b3ac 100644
--- a/src/main/java/org/apache/sling/servlets/get/impl/RedirectServlet.java
+++ b/src/main/java/org/apache/sling/servlets/get/impl/RedirectServlet.java
@@ -52,6 +52,7 @@
* property <code>sling:target</code>.</li>
* <li>The second attempt is to access the resource <code>sling:target</code>
* below the requested resource and attapt this to a string.</li>
+ * </ul>
* <p>
* If there is no value found for <code>sling:target</code> a 404 (NOT FOUND)
* status is sent by this servlet. Otherwise a 302 (FOUND, temporary redirect)
diff --git a/src/main/java/org/apache/sling/servlets/get/impl/helpers/JsonRendererServlet.java b/src/main/java/org/apache/sling/servlets/get/impl/helpers/JsonRendererServlet.java
index 96f8b62..461d6ad 100644
--- a/src/main/java/org/apache/sling/servlets/get/impl/helpers/JsonRendererServlet.java
+++ b/src/main/java/org/apache/sling/servlets/get/impl/helpers/JsonRendererServlet.java
@@ -137,9 +137,12 @@
}
}
- /** Get recursion level from selectors. as per SLING-167:
- * the last selector, if present, gives the recursion
- * level.
+ /**
+ * Get recursion level from selectors. as per SLING-167: the last selector, if present, gives the recursion level.
+ *
+ * @param req the request
+ * @return the recursion level
+ * @throws IllegalArgumentException if the detected selector is not a number
*/
protected int getMaxRecursionLevel(SlingHttpServletRequest req) throws IllegalArgumentException {
int maxRecursionLevels = 0;
@@ -165,8 +168,13 @@
}
return maxRecursionLevels;
}
-
- /** True if our request has the given selector */
+
+ /**
+ * Checks if the provided request contains a certain selector.
+ * @param req the request
+ * @param selectorToCheck the selector
+ * @return {@code true} if the selector is present, {@code false} otherwise
+ */
protected boolean hasSelector(SlingHttpServletRequest req, String selectorToCheck) {
for(String selector : req.getRequestPathInfo().getSelectors()) {
if(selectorToCheck.equals(selector)) {
@@ -176,7 +184,11 @@
return false;
}
- /** True if our request wants the "tidy" pretty-printed format */
+ /**
+ * True if our request wants the "tidy" pretty-printed format
+ * @param req the request
+ * @return {@code true} if the request contains the {@link #TIDY} selector, {@code false} otherwise
+ */
protected boolean isTidy(SlingHttpServletRequest req) {
return hasSelector(req, TIDY);
}
diff --git a/src/main/java/org/apache/sling/servlets/get/impl/helpers/PlainTextRendererServlet.java b/src/main/java/org/apache/sling/servlets/get/impl/helpers/PlainTextRendererServlet.java
index 8e4f408..714f60b 100644
--- a/src/main/java/org/apache/sling/servlets/get/impl/helpers/PlainTextRendererServlet.java
+++ b/src/main/java/org/apache/sling/servlets/get/impl/helpers/PlainTextRendererServlet.java
@@ -80,6 +80,12 @@
* resp.getOutputStream().write(data.toString().getBytes()); }
*/
+ /**
+ * Dumps the information about the provided resource to a {@link PrintWriter}.
+ * @param pw the PrintWriter
+ * @param r the resource
+ * @param map the resource's properties
+ */
@SuppressWarnings("unchecked")
protected void dump(PrintWriter pw, Resource r, Map map) {
pw.println("** Resource dumped by " + getClass().getSimpleName() + "**");
diff --git a/src/main/java/org/apache/sling/servlets/get/impl/helpers/StreamRendererServlet.java b/src/main/java/org/apache/sling/servlets/get/impl/helpers/StreamRendererServlet.java
index 8cac474..b4623bd 100644
--- a/src/main/java/org/apache/sling/servlets/get/impl/helpers/StreamRendererServlet.java
+++ b/src/main/java/org/apache/sling/servlets/get/impl/helpers/StreamRendererServlet.java
@@ -718,6 +718,8 @@
/**
* Validate range.
+ *
+ * @return {@code true} if the range is valid, {@code false} otherwise
*/
public boolean validate() {
if (end >= length) end = length - 1;
