Skip to content

Commit 7bf7432

Browse files
committed
[IO-824] SymbolicLineFileFilter documentation fixes Javadoc
Apply variation of patch in the ticket
1 parent a1f3108 commit 7bf7432

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

src/main/java/org/apache/commons/io/filefilter/SymbolicLinkFileFilter.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public class SymbolicLinkFileFilter extends AbstractFileFilter implements Serial
7171
* unit test to works around this by doing two things: 1) This separates the class logic from
7272
* the call to identify a symbolic link, and 2) It allows the unit test to override that
7373
* symbolic link call on Windows only.
74-
* This means we can write unit tests will run on all machines. On Windows, the unit test
74+
* This means we can write unit tests that will run on all machines. On Windows, the unit test
7575
* can't create a symbolic link without admin privileges, so the unit tests won't
7676
* completely test all the necessary behavior on Windows, but they will still test the class
7777
* logic. Be careful not to break this, but be aware of it when writing unit tests. You can
@@ -117,10 +117,11 @@ public boolean accept(final File file) {
117117
}
118118

119119
/**
120-
* Checks to see if the file is a file.
120+
* Checks to see if the file is a symbolic link.
121121
*
122122
* @param path the File Path to check
123-
* @return true if the file exists and is a symbolic link to either another file or a directory.
123+
* @return {@code onAccept} from {@link #SymbolicLinkFileFilter(FileVisitResult, FileVisitResult)} if the file exists and is a symbolic link to either
124+
* another file or a directory; returns {@code onReject} otherwise.
124125
*/
125126
@Override
126127
public FileVisitResult accept(final Path path, final BasicFileAttributes attributes) {

0 commit comments

Comments
 (0)