sling-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cziege...@apache.org
Subject svn commit: r629157 - in /incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core: impl/output/BufferedPrintWriter.java impl/request/RequestData.java impl/request/SlingRequestProgressTracker.java servlets/ErrorHandler.java
Date Tue, 19 Feb 2008 16:48:27 GMT
Author: cziegeler
Date: Tue Feb 19 08:48:21 2008
New Revision: 629157

URL: http://svn.apache.org/viewvc?rev=629157&view=rev
Log:
Clean up javadocs.

Modified:
    incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/output/BufferedPrintWriter.java
    incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/request/RequestData.java
    incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/request/SlingRequestProgressTracker.java
    incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/servlets/ErrorHandler.java

Modified: incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/output/BufferedPrintWriter.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/output/BufferedPrintWriter.java?rev=629157&r1=629156&r2=629157&view=diff
==============================================================================
--- incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/output/BufferedPrintWriter.java
(original)
+++ incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/output/BufferedPrintWriter.java
Tue Feb 19 08:48:21 2008
@@ -29,10 +29,11 @@
 /**
  * The <code>BufferedPrintWriter</code> implements buffering for the
  * <code>PrintWriter</code> returned by the
- * {@link DeliveryHttpServletResponse#getWriter} method.
+ * {@link org.apache.sling.api.SlingHttpServletResponse#getWriter()} method.
  * <p>
  * We need this additional buffering class for the
- * {@link DeliveryHttpServletResponseImpl} class because we wrap the original
+ * {@link org.apache.sling.api.SlingHttpServletResponse#getWriter()} class because
+ * we wrap the original
  * <code>PrintWriter</code> retrieved from the servlet container with optional
  * caching and link checking writers.
  * <p>
@@ -92,10 +93,7 @@
      * Creates an instance wrapping the <code>PrintWriter</code> and providing
      * an initial buffer size.
      * <p>
-     * The <code>servletWriter</code> is to initially write data to. This
-     * destination may be replaced with the {@link #setDestination}. It is
-     * intended that any <code>Writer</code> set in the {@link #setDestination}
-     * method be ultimately writing to this same <code>servletWriter</code>.
+     * The <code>servletWriter</code> is to initially write data to.
      * <p>
      * The other use of the <code>servletWriter</code> is to check for any
      * errors occurred by forwarding the call to the {@link #checkError} to this

Modified: incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/request/RequestData.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/request/RequestData.java?rev=629157&r1=629156&r2=629157&view=diff
==============================================================================
--- incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/request/RequestData.java
(original)
+++ incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/request/RequestData.java
Tue Feb 19 08:48:21 2008
@@ -316,7 +316,6 @@
 
     /**
      * @param request
-     * @return
      * @throws IllegalArgumentException If the <code>request</code> is not a
      *             <code>SlingHttpServletRequest</code> and not a
      *             <code>ServletRequestWrapper</code> wrapping a
@@ -328,7 +327,6 @@
 
     /**
      * @param request
-     * @return
      * @throws IllegalArgumentException If <code>request</code> is not a
      *             <code>SlingHttpServletRequestImpl</code> and not
      *             <code>SlingHttpServletRequestWrapper</code> wrapping a
@@ -340,7 +338,6 @@
 
     /**
      * @param request
-     * @return
      * @throws IllegalArgumentException if <code>request</code> is not a
      *             <code>HttpServletRequest</code> of if <code>request</code>
      *             is not backed by <code>SlingHttpServletRequestImpl</code>.
@@ -374,7 +371,6 @@
 
     /**
      * @param response
-     * @return
      * @throws IllegalArgumentException if <code>response</code> is not a
      *             <code>HttpServletResponse</code> of if
      *             <code>response</code> is not backed by

Modified: incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/request/SlingRequestProgressTracker.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/request/SlingRequestProgressTracker.java?rev=629157&r1=629156&r2=629157&view=diff
==============================================================================
--- incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/request/SlingRequestProgressTracker.java
(original)
+++ incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/impl/request/SlingRequestProgressTracker.java
Tue Feb 19 08:48:21 2008
@@ -51,9 +51,8 @@
  * <p>
  * As the request being processed, certain steps may be tracked by calling
  * either of the <code>log</code> methods. A tracking entry consists of a time
- * stamp managed by this class, a tracking message noting the actual step being
- * tracked and an optional tracking tag. The value of the tracking tag depends
- * on the application and defaults to {@link #TAG_CHECK} if not specified.
+ * stamp managed by this class, and a tracking message noting the actual step being
+ * tracked.
  * <p>
  * <b>Timing Processing Steps</b>
  * </p>
@@ -61,32 +60,32 @@
  * required for processing should be recorded. Instances of this class maintain
  * a map of named timers. Each timer is started (initialized or reset) by
  * calling the {@link #startTimer(String)} method. This method just records the
- * starting time of the named timer and adds a tracking entry with the timer
- * name as the message and the tracking tag {@link #TAG_START}.
+ * starting time of the named timer.
  * <p>
  * To record the number of milliseconds ellapsed since a timer has been started,
- * the {@link #checkTimer(String)} method may be called. This method logs s
- * tracking entry with the tracking tag {@link #TAG_CHECK} and a message
+ * the {@link #logTimer(String)} method may be called. This method logs the
+ * tracking entry with message
  * consisting of the name of the timer and the number of milliseconds ellapsed
  * since the timer was last {@link #startTimer(String) started}. The
- * {@link #checkTimer(String)} method may be called multiple times to record
+ * {@link #logTimer(String)} method may be called multiple times to record
  * several timed steps.
  * <p>
+ * Additional information can be logged using the {@link #logTimer(String, String, Object...)}
+ * method.
+ * <p>
  * Calling the {@link #startTimer(String)} method with the name of timer which
  * already exists, resets the start time of the named timer to the current
  * system time.
  * <p>
  * <b>Dumping Tracking Entries</b>
  * <p>
- * The {@link #dumpText(PrintWriter)} methods adds a tracking entry with tag
- * {@link #TAG_CHECK} and writes all tracking entries to the given
+ * The {@link #dump(PrintWriter)} methods writes all tracking entries to the given
  * <code>PrintWriter</code>. Each entry is written on a single line
  * consisting of the following fields:
  * <ol>
  * <li>The number of milliseconds since the last {@link #reset()} (or creation)
  * of this timer.
  * <li>The absolute time of the timer in parenthesis.
- * <li>The timer tag enclosed in stars (*)
  * <li>The entry message
  * </ol>
  */
@@ -172,7 +171,7 @@
         }
     }
 
-    /** Creates an entry with the given message and entry tag {@link #TAG_CHECK} */
+    /** Creates an entry with the given message. */
     public void log(String message) {
         entries.add(new TrackingEntry(message));
     }
@@ -205,7 +204,7 @@
     }
 
     /**
-     * Logs an entry with entry tag {@link #TAG_CHECK} and the message set to
+     * Logs an entry with the message set to
      * the name of the timer and the number of milliseconds ellapsed since the
      * timer start.
      */

Modified: incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/servlets/ErrorHandler.java
URL: http://svn.apache.org/viewvc/incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/servlets/ErrorHandler.java?rev=629157&r1=629156&r2=629157&view=diff
==============================================================================
--- incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/servlets/ErrorHandler.java
(original)
+++ incubator/sling/trunk/sling/core/src/main/java/org/apache/sling/core/servlets/ErrorHandler.java
Tue Feb 19 08:48:21 2008
@@ -61,7 +61,6 @@
      * @param request The request object providing more information on the
      *            request.
      * @param response The response object used to send the status and message.
-     * @throws ServletException May be thrown if any processing error occurrs.
      * @throws IOException May be thrown if an error occurrs sending the
      *             response.
      */



Mime
View raw message