Skip to content

Commit 37d17bc

Browse files
committed
Javadoc: Normalize spelling
1 parent 90c9d39 commit 37d17bc

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

src/main/java/org/apache/commons/io/DirectoryWalker.java

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -196,14 +196,14 @@
196196
* <pre>
197197
* public class FooDirectoryWalker extends DirectoryWalker {
198198
*
199-
* private volatile boolean cancelled = false;
199+
* private volatile boolean canceled = false;
200200
*
201201
* public void cancel() {
202-
* cancelled = true;
202+
* canceled = true;
203203
* }
204204
*
205205
* protected boolean handleIsCancelled(File file, int depth, Collection results) {
206-
* return cancelled;
206+
* return canceled;
207207
* }
208208
*
209209
* protected void handleCancelled(File startDirectory, Collection results, CancelException cancel) {
@@ -272,8 +272,8 @@ public static class CancelException extends IOException {
272272
* Constructs a {@link CancelException} with
273273
* the file and depth when cancellation occurred.
274274
*
275-
* @param file the file when the operation was cancelled, may be null.
276-
* @param depth the depth when the operation was cancelled, may be null.
275+
* @param file the file when the operation was canceled, may be null.
276+
* @param depth the depth when the operation was canceled, may be null.
277277
*/
278278
public CancelException(final File file, final int depth) {
279279
this("Operation Cancelled", file, depth);
@@ -285,8 +285,8 @@ public CancelException(final File file, final int depth) {
285285
* cancellation occurred.
286286
*
287287
* @param message the detail message.
288-
* @param file the file when the operation was cancelled.
289-
* @param depth the depth when the operation was cancelled.
288+
* @param file the file when the operation was canceled.
289+
* @param depth the depth when the operation was canceled.
290290
*/
291291
public CancelException(final String message, final File file, final int depth) {
292292
super(message);
@@ -295,18 +295,18 @@ public CancelException(final String message, final File file, final int depth) {
295295
}
296296

297297
/**
298-
* Returns the depth when the operation was cancelled.
298+
* Returns the depth when the operation was canceled.
299299
*
300-
* @return the depth when the operation was cancelled.
300+
* @return the depth when the operation was canceled.
301301
*/
302302
public int getDepth() {
303303
return depth;
304304
}
305305

306306
/**
307-
* Returns the file when the operation was cancelled.
307+
* Returns the file when the operation was canceled.
308308
*
309-
* @return the file when the operation was cancelled.
309+
* @return the file when the operation was canceled.
310310
*/
311311
public File getFile() {
312312
return file;
@@ -376,7 +376,7 @@ protected DirectoryWalker(IOFileFilter directoryFilter, IOFileFilter fileFilter,
376376
}
377377

378378
/**
379-
* Checks whether the walk has been cancelled by calling {@link #handleIsCancelled},
379+
* Checks whether the walk has been canceled by calling {@link #handleIsCancelled},
380380
* throwing a {@link CancelException} if it has.
381381
* <p>
382382
* Writers of subclasses should not normally call this method as it is called
@@ -417,7 +417,7 @@ protected File[] filterDirectoryContents(final File directory, final int depth,
417417
}
418418

419419
/**
420-
* Overridable callback method invoked when the operation is cancelled.
420+
* Overridable callback method invoked when the operation is canceled.
421421
* The file being processed when the cancellation occurred can be
422422
* obtained from the exception.
423423
* <p>
@@ -526,21 +526,21 @@ protected void handleFile(final File file, final int depth, final Collection<T>
526526

527527
/**
528528
* Overridable callback method invoked to determine if the entire walk
529-
* operation should be immediately cancelled.
529+
* operation should be immediately canceled.
530530
* <p>
531531
* This method should be implemented by those subclasses that want to
532532
* provide a public {@code cancel()} method available from another
533533
* thread. The design pattern for the subclass should be as follows:
534534
* </p>
535535
* <pre>
536536
* public class FooDirectoryWalker extends DirectoryWalker {
537-
* private volatile boolean cancelled = false;
537+
* private volatile boolean canceled = false;
538538
*
539539
* public void cancel() {
540-
* cancelled = true;
540+
* canceled = true;
541541
* }
542542
* private void handleIsCancelled(File file, int depth, Collection results) {
543-
* return cancelled;
543+
* return canceled;
544544
* }
545545
* protected void handleCancelled(File startDirectory,
546546
* Collection results, CancelException cancel) {
@@ -550,7 +550,7 @@ protected void handleFile(final File file, final int depth, final Collection<T>
550550
* </pre>
551551
* <p>
552552
* If this method returns true, then the directory walk is immediately
553-
* cancelled. The next callback method will be {@link #handleCancelled}.
553+
* canceled. The next callback method will be {@link #handleCancelled}.
554554
* </p>
555555
* <p>
556556
* This implementation returns false.
@@ -559,14 +559,14 @@ protected void handleFile(final File file, final int depth, final Collection<T>
559559
* @param file the file or directory being processed.
560560
* @param depth the current directory level (starting directory = 0).
561561
* @param results the collection of result objects, may be updated.
562-
* @return true if the walk has been cancelled.
562+
* @return true if the walk has been canceled.
563563
* @throws IOException if an I/O Error occurs.
564564
*/
565565
@SuppressWarnings("unused") // Possibly thrown from subclasses.
566566
protected boolean handleIsCancelled(
567567
final File file, final int depth, final Collection<T> results) throws IOException {
568568
// do nothing - overridable by subclass
569-
return false; // not cancelled
569+
return false; // not canceled
570570
}
571571

572572
/**

0 commit comments

Comments
 (0)