Skip to content

Commit

Permalink
[IO-824] SymbolicLineFileFilter documentation fixes Javadoc
Browse files Browse the repository at this point in the history
Apply variation of patch in the ticket
  • Loading branch information
garydgregory committed Dec 2, 2023
1 parent a1f3108 commit 7bf7432
Showing 1 changed file with 4 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ public class SymbolicLinkFileFilter extends AbstractFileFilter implements Serial
* unit test to works around this by doing two things: 1) This separates the class logic from
* the call to identify a symbolic link, and 2) It allows the unit test to override that
* symbolic link call on Windows only.
* This means we can write unit tests will run on all machines. On Windows, the unit test
* This means we can write unit tests that will run on all machines. On Windows, the unit test
* can't create a symbolic link without admin privileges, so the unit tests won't
* completely test all the necessary behavior on Windows, but they will still test the class
* logic. Be careful not to break this, but be aware of it when writing unit tests. You can
Expand Down Expand Up @@ -117,10 +117,11 @@ public boolean accept(final File file) {
}

/**
* Checks to see if the file is a file.
* Checks to see if the file is a symbolic link.
*
* @param path the File Path to check
* @return true if the file exists and is a symbolic link to either another file or a directory.
* @return {@code onAccept} from {@link #SymbolicLinkFileFilter(FileVisitResult, FileVisitResult)} if the file exists and is a symbolic link to either
* another file or a directory; returns {@code onReject} otherwise.
*/
@Override
public FileVisitResult accept(final Path path, final BasicFileAttributes attributes) {
Expand Down

0 comments on commit 7bf7432

Please sign in to comment.