Author: radu Date: Mon Jul 13 17:29:21 2015 New Revision: 1690768 URL: http://svn.apache.org/r1690768 Log: trivial: updated JavaDoc to allow releases with JRE >= 1.8
Modified: sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/RedirectServlet.java sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/JsonRendererServlet.java sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/PlainTextRendererServlet.java sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/StreamRendererServlet.java Modified: sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/RedirectServlet.java URL: http://svn.apache.org/viewvc/sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/RedirectServlet.java?rev=1690768&r1=1690767&r2=1690768&view=diff ============================================================================== --- sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/RedirectServlet.java (original) +++ sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/RedirectServlet.java Mon Jul 13 17:29:21 2015 @@ -52,6 +52,7 @@ import org.slf4j.LoggerFactory; * 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) Modified: sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/JsonRendererServlet.java URL: http://svn.apache.org/viewvc/sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/JsonRendererServlet.java?rev=1690768&r1=1690767&r2=1690768&view=diff ============================================================================== --- sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/JsonRendererServlet.java (original) +++ sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/JsonRendererServlet.java Mon Jul 13 17:29:21 2015 @@ -137,9 +137,12 @@ public class JsonRendererServlet extends } } - /** 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 @@ public class JsonRendererServlet extends } 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 @@ public class JsonRendererServlet extends 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); } Modified: sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/PlainTextRendererServlet.java URL: http://svn.apache.org/viewvc/sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/PlainTextRendererServlet.java?rev=1690768&r1=1690767&r2=1690768&view=diff ============================================================================== --- sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/PlainTextRendererServlet.java (original) +++ sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/PlainTextRendererServlet.java Mon Jul 13 17:29:21 2015 @@ -80,6 +80,12 @@ public class PlainTextRendererServlet ex * 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() + "**"); Modified: sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/StreamRendererServlet.java URL: http://svn.apache.org/viewvc/sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/StreamRendererServlet.java?rev=1690768&r1=1690767&r2=1690768&view=diff ============================================================================== --- sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/StreamRendererServlet.java (original) +++ sling/trunk/bundles/servlets/get/src/main/java/org/apache/sling/servlets/get/impl/helpers/StreamRendererServlet.java Mon Jul 13 17:29:21 2015 @@ -718,6 +718,8 @@ public class StreamRendererServlet exten /** * Validate range. + * + * @return {@code true} if the range is valid, {@code false} otherwise */ public boolean validate() { if (end >= length) end = length - 1;