commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nutty...@apache.org
Subject svn commit: r441252 - /jakarta/commons/sandbox/pipeline/trunk/src/main/java/org/apache/commons/pipeline/driver/FaultTolerance.java
Date Thu, 07 Sep 2006 22:04:06 GMT
Author: nuttycom
Date: Thu Sep  7 15:04:06 2006
New Revision: 441252

URL: http://svn.apache.org/viewvc?view=rev&rev=441252
Log:
Documentation improvements

Modified:
    jakarta/commons/sandbox/pipeline/trunk/src/main/java/org/apache/commons/pipeline/driver/FaultTolerance.java

Modified: jakarta/commons/sandbox/pipeline/trunk/src/main/java/org/apache/commons/pipeline/driver/FaultTolerance.java
URL: http://svn.apache.org/viewvc/jakarta/commons/sandbox/pipeline/trunk/src/main/java/org/apache/commons/pipeline/driver/FaultTolerance.java?view=diff&rev=441252&r1=441251&r2=441252
==============================================================================
--- jakarta/commons/sandbox/pipeline/trunk/src/main/java/org/apache/commons/pipeline/driver/FaultTolerance.java
(original)
+++ jakarta/commons/sandbox/pipeline/trunk/src/main/java/org/apache/commons/pipeline/driver/FaultTolerance.java
Thu Sep  7 15:04:06 2006
@@ -17,13 +17,31 @@
 package org.apache.commons.pipeline.driver;
 
 /**
- * An enumeration of error handling strategies for stage processing.
+ * Stores the failure tolerance flag for a worker thread. If faultTolerance
+ * is set to CHECKED, {@link org.apache.commons.pipeline.StageException StageException}s
thrown by
+ * the {@link org.apache.commons.pipeline.Stage#process(Object)} method will not interrupt
queue
+ * processing, but will simply be logged with a severity of ERROR.
+ * If faultTolerance is set to ALL, runtime exceptions will also be
+ * logged and otherwise ignored.
+ *
+ *
  */
 public enum FaultTolerance {
-    /** All exceptions are allowed to propagate up the stack and halt stage processing */
+    /**
+     * {@link org.apache.commons.pipeline.StageException StageException}s thrown by
+     * the {@link org.apache.commons.pipeline.Stage#process(Object)} method will interrupt
queue
+     * processing and will be logged with a severity of ERROR.
+     */
     NONE, 
-    /** Only unchecked exceptions are allowed to propagate up the stack. */
+    /**
+     * {@link org.apache.commons.pipeline.StageException StageException}s thrown by
+     * the {@link org.apache.commons.pipeline.Stage#process(Object)} method will not interrupt
queue
+     * processing, but will simply be logged with a severity of ERROR.
+     */
     CHECKED, 
-    /** All exceptions are swallowed and logged; stage processing continues with the next
object as normal. */
+    /**
+     * If faultTolerance is set to ALL, runtime exceptions will be
+     * logged and otherwise ignored.
+     */
     ALL;
 }



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message