Author: nuttycom
Date: Fri Aug 3 21:33:34 2007
New Revision: 562656
URL: http://svn.apache.org/viewvc?view=rev&rev=562656
Log:
Minor documentation improvements.
Modified:
commons/sandbox/pipeline/trunk/src/main/java/org/apache/commons/pipeline/ProcessingException.java
Modified:
commons/sandbox/pipeline/trunk/src/main/java/org/apache/commons/pipeline/ProcessingException.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/pipeline/trunk/src/main/java/org/apache/commons/pipeline/ProcessingException.java?view=diff&rev=562656&r1=562655&r2=562656
==============================================================================
---
commons/sandbox/pipeline/trunk/src/main/java/org/apache/commons/pipeline/ProcessingException.java
(original)
+++
commons/sandbox/pipeline/trunk/src/main/java/org/apache/commons/pipeline/ProcessingException.java
Fri Aug 3 21:33:34 2007
@@ -21,7 +21,7 @@
/**
* This exception class is used to store detailed information about
- * a failure in the processing step of a stage including the failing data,
+ * a failure in the processing step of a stage including the failing data,
* the driver state at the time of failure, and any exceptions encountered.
*/
public class ProcessingException extends StageException {
@@ -30,7 +30,7 @@
/**
* Creates a new instance of ProcessingException
- *
+ *
* @param data The object which was not able to be processed.
* @param throwable The exception that occurred.
*/
@@ -38,15 +38,20 @@
super(stage, cause);
this.data = data;
this.driverState = driverState;
- }
+ }
- /** Returns the data
- [EMAIL PROTECTED] The object which was not able to be processed.
+ /**
+ * Returns the object that was being processed at the time of failure.
+ * @return The object which was not able to be processed.
*/
public Object getData(){
return this.data;
- }
+ }
+ /**
+ * Returns the saved driver state at the time of processing failure.
+ * @return the driver state at the time of processing failure.
+ */
public State getDriverState() {
return this.driverState;
}