You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2006/10/14 12:20:32 UTC
svn commit: r463909 -
/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/DirectoryWalker.java
Author: scolebourne
Date: Sat Oct 14 03:20:27 2006
New Revision: 463909
URL: http://svn.apache.org/viewvc?view=rev&rev=463909
Log:
Add serial version id and unify javadoc
Modified:
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/DirectoryWalker.java
Modified: jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/DirectoryWalker.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/DirectoryWalker.java?view=diff&rev=463909&r1=463908&r2=463909
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/DirectoryWalker.java (original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/DirectoryWalker.java Sat Oct 14 03:20:27 2006
@@ -415,7 +415,7 @@
*
* @param startDirectory the directory to start from
* @param results the collection of result objects, may be updated
- * @param cancel The exception throw to cancel further processing
+ * @param cancel the exception throw to cancel further processing
* containing details at the point of cancellation.
* @throws IOException if an I/O Error occurs
*/
@@ -431,15 +431,20 @@
*/
public static class CancelException extends IOException {
+ /** Serialization id. */
+ private static final long serialVersionUID = 1347339620135041008L;
+
+ /** The file being processed when the exception was thrown. */
private File file;
+ /** The file depth when the exception was thrown. */
private int depth = -1;
/**
* Constructs a <code>CancelException</code> with
* the file and depth when cancellation occurred.
*
- * @param file The file when the operation was cancelled
- * @param depth The depth when the operation was cancelled
+ * @param file the file when the operation was cancelled, may be null
+ * @param depth the depth when the operation was cancelled, may be null
*/
public CancelException(File file, int depth) {
this("Operation Cancelled", file, depth);
@@ -450,9 +455,9 @@
* an appropriate message and the file and depth when
* cancellation occurred.
*
- * @param message The detail message.
- * @param file The file when the operation was cancelled
- * @param depth The depth when the operation was cancelled
+ * @param message the detail message
+ * @param file the file when the operation was cancelled
+ * @param depth the depth when the operation was cancelled
*/
public CancelException(String message, File file, int depth) {
super(message);
@@ -463,7 +468,7 @@
/**
* Return the file when the operation was cancelled.
*
- * @return The file when the operation was cancelled
+ * @return the file when the operation was cancelled
*/
public File getFile() {
return file;
@@ -472,7 +477,7 @@
/**
* Return the depth when the operation was cancelled.
*
- * @return The depth when the operation was cancelled
+ * @return the depth when the operation was cancelled
*/
public int getDepth() {
return depth;
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org