Skip to content

Commit

Permalink
[IO-572] Refactor duplicate code in org.apache.commons.io.FileUtils.
Browse files Browse the repository at this point in the history
  • Loading branch information
@garydgregory
garydgregory committed Mar 10, 2018
1 parent 71fc2c4 commit f0751b6
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 49 deletions.
3 changes: 3 additions & 0 deletions src/changes/changes.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ The <action> type attribute can be add,update,fix,remove.
<action issue="IO-571" dev="ggregory" type="fix" due-to="pranet">
Remove redundant isDirectory() check in org.apache.commons.io.FileUtils.listFilesAndDirs(File, IOFileFilter, IOFileFilter).
</action>
<action issue="IO-572" dev="ggregory" type="update" due-to="Pranet Verma">
Refactor duplicate code in org.apache.commons.io.FileUtils.
</action>
</release>

<release version="2.6" date="2017-10-15" description="Java 7 required, Java 9 supported.">
Expand Down
101 changes: 52 additions & 49 deletions src/main/java/org/apache/commons/io/FileUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -513,16 +513,7 @@ private static void innerListFiles(final Collection<File> files, final File dire
*/
public static Collection<File> listFiles(
final File directory, final IOFileFilter fileFilter, final IOFileFilter dirFilter) {
validateListFilesParameters(directory, fileFilter);

final IOFileFilter effFileFilter = setUpEffectiveFileFilter(fileFilter);
final IOFileFilter effDirFilter = setUpEffectiveDirFilter(dirFilter);

//Find files
final Collection<File> files = new java.util.LinkedList<>();
innerListFiles(files, directory,
FileFilterUtils.or(effFileFilter, effDirFilter), false);
return files;
return innerListFilesOrDirectories(directory, fileFilter, dirFilter, false);
}

/**
Expand Down Expand Up @@ -586,16 +577,39 @@ private static IOFileFilter setUpEffectiveDirFilter(final IOFileFilter dirFilter
*/
public static Collection<File> listFilesAndDirs(
final File directory, final IOFileFilter fileFilter, final IOFileFilter dirFilter) {
return innerListFilesOrDirectories(directory, fileFilter, dirFilter, true);
}

/**
* Finds files within a given directory (and optionally its
* subdirectories). All files found are filtered by an IOFileFilter.
*
* @param directory the directory to search in
* @param fileFilter filter to apply when finding files.
* @param dirFilter optional filter to apply when finding subdirectories.
* If this parameter is {@code null}, subdirectories will not be included in the
* search. Use TrueFileFilter.INSTANCE to match all directories.
* @param includeSubDirectories indicates if will include the subdirectories themselves
* @return a collection of java.io.File with the matching files
* @see org.apache.commons.io.FileUtils#listFiles
* @see org.apache.commons.io.filefilter.FileFilterUtils
* @see org.apache.commons.io.filefilter.NameFileFilter
*/
private static Collection<File> innerListFilesOrDirectories(
final File directory, final IOFileFilter fileFilter, final IOFileFilter dirFilter,
boolean includeSubDirectories) {
validateListFilesParameters(directory, fileFilter);

final IOFileFilter effFileFilter = setUpEffectiveFileFilter(fileFilter);
final IOFileFilter effDirFilter = setUpEffectiveDirFilter(dirFilter);

//Find files
final Collection<File> files = new java.util.LinkedList<>();
files.add(directory);
if (includeSubDirectories) {
files.add(directory);
}
innerListFiles(files, directory,
FileFilterUtils.or(effFileFilter, effDirFilter), true);
FileFilterUtils.or(effFileFilter, effDirFilter), includeSubDirectories);
return files;
}

Expand Down Expand Up @@ -2899,15 +2913,7 @@ public static Checksum checksum(final File file, final Checksum checksum) throws
* @since 1.4
*/
public static void moveDirectory(final File srcDir, final File destDir) throws IOException {
if (srcDir == null) {
throw new NullPointerException("Source must not be null");
}
if (destDir == null) {
throw new NullPointerException("Destination must not be null");
}
if (!srcDir.exists()) {
throw new FileNotFoundException("Source '" + srcDir + "' does not exist");
}
validateMoveParameters(srcDir, destDir);
if (!srcDir.isDirectory()) {
throw new IOException("Source '" + srcDir + "' is not a directory");
}
Expand Down Expand Up @@ -2943,12 +2949,7 @@ public static void moveDirectory(final File srcDir, final File destDir) throws I
*/
public static void moveDirectoryToDirectory(final File src, final File destDir, final boolean createDestDir)
throws IOException {
if (src == null) {
throw new NullPointerException("Source must not be null");
}
if (destDir == null) {
throw new NullPointerException("Destination directory must not be null");
}
validateMoveParameters(src, destDir);
if (!destDir.exists() && createDestDir) {
destDir.mkdirs();
}
Expand All @@ -2960,7 +2961,6 @@ public static void moveDirectoryToDirectory(final File src, final File destDir,
throw new IOException("Destination '" + destDir + "' is not a directory");
}
moveDirectory(src, new File(destDir, src.getName()));

}

/**
Expand All @@ -2977,15 +2977,7 @@ public static void moveDirectoryToDirectory(final File src, final File destDir,
* @since 1.4
*/
public static void moveFile(final File srcFile, final File destFile) throws IOException {
if (srcFile == null) {
throw new NullPointerException("Source must not be null");
}
if (destFile == null) {
throw new NullPointerException("Destination must not be null");
}
if (!srcFile.exists()) {
throw new FileNotFoundException("Source '" + srcFile + "' does not exist");
}
validateMoveParameters(srcFile, destFile);
if (srcFile.isDirectory()) {
throw new IOException("Source '" + srcFile + "' is a directory");
}
Expand Down Expand Up @@ -3021,12 +3013,7 @@ public static void moveFile(final File srcFile, final File destFile) throws IOEx
*/
public static void moveFileToDirectory(final File srcFile, final File destDir, final boolean createDestDir)
throws IOException {
if (srcFile == null) {
throw new NullPointerException("Source must not be null");
}
if (destDir == null) {
throw new NullPointerException("Destination directory must not be null");
}
validateMoveParameters(srcFile, destDir);
if (!destDir.exists() && createDestDir) {
destDir.mkdirs();
}
Expand Down Expand Up @@ -3057,20 +3044,36 @@ public static void moveFileToDirectory(final File srcFile, final File destDir, f
*/
public static void moveToDirectory(final File src, final File destDir, final boolean createDestDir)
throws IOException {
validateMoveParameters(src, destDir);
if (src.isDirectory()) {
moveDirectoryToDirectory(src, destDir, createDestDir);
} else {
moveFileToDirectory(src, destDir, createDestDir);
}
}

/**
* Validates the given arguments.
* <ul>
* <li>Throws {@link NullPointerException} if {@code src} is null</li>
* <li>Throws {@link NullPointerException} if {@code dest} is null</li>
* <li>Throws {@link FileNotFoundException} if {@code src} does not exist</li>
* </ul>
*
* @param src the file or directory to be moved
* @param dest the destination file or directory
* @throws FileNotFoundException if {@code src} file does not exist
*/
private static void validateMoveParameters(final File src, final File dest) throws FileNotFoundException {
if (src == null) {
throw new NullPointerException("Source must not be null");
}
if (destDir == null) {
if (dest == null) {
throw new NullPointerException("Destination must not be null");
}
if (!src.exists()) {
throw new FileNotFoundException("Source '" + src + "' does not exist");
}
if (src.isDirectory()) {
moveDirectoryToDirectory(src, destDir, createDestDir);
} else {
moveFileToDirectory(src, destDir, createDestDir);
}
}

/**
Expand Down

0 comments on commit f0751b6

Please sign in to comment.