Add and use IOCase.value(IOCase, IOCase).

Author: Gary Gregory

src/changes/changes.xml

@@ -202,6 +202,9 @@ The <action> type attribute can be add,update,fix,remove.
         Add and use PathUtils.sizeOfDirectory(Path).
         Add and use PathUtils.sizeOfDirectoryAsBigInteger(Path).
       </action>
+      <action dev="ggregory" type="add" due-to="Gary Gregory">
+        Add and use IOCase.value(IOCase, IOCase).
+      </action>
       <action dev="jonfreedman" type="add" due-to="Jon Freedman, Gary Gregory">
         Add Tailer.Tailable interface to allow tailing of remote files for example using jCIFS.
       </action>

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

@@ -438,11 +438,11 @@ public static boolean equals(final String fileName1, final String fileName2) {
      * @param fileName1  the first fileName to query, may be null
      * @param fileName2  the second fileName to query, may be null
      * @param normalized  whether to normalize the fileNames
-     * @param caseSensitivity  what case sensitivity rule to use, null means case-sensitive
+     * @param ioCase  what case sensitivity rule to use, null means case-sensitive
      * @return true if the fileNames are equal, null equals null
      * @since 1.3
      */
-    public static boolean equals(String fileName1, String fileName2, final boolean normalized, IOCase caseSensitivity) {
+    public static boolean equals(String fileName1, String fileName2, final boolean normalized, final IOCase ioCase) {
 
         if (fileName1 == null || fileName2 == null) {
             return fileName1 == null && fileName2 == null;
@@ -457,10 +457,7 @@ public static boolean equals(String fileName1, String fileName2, final boolean n
                 return false;
             }
         }
-        if (caseSensitivity == null) {
-            caseSensitivity = IOCase.SENSITIVE;
-        }
-        return caseSensitivity.checkEquals(fileName1, fileName2);
+        return IOCase.value(ioCase, IOCase.SENSITIVE).checkEquals(fileName1, fileName2);
     }
 
     /**
@@ -1567,20 +1564,18 @@ public static boolean wildcardMatch(final String fileName, final String wildcard
      *
      * @param fileName  the fileName to match on
      * @param wildcardMatcher  the wildcard string to match against
-     * @param caseSensitivity  what case sensitivity rule to use, null means case-sensitive
+     * @param ioCase  what case sensitivity rule to use, null means case-sensitive
      * @return true if the fileName matches the wildcard string
      * @since 1.3
      */
-    public static boolean wildcardMatch(final String fileName, final String wildcardMatcher, IOCase caseSensitivity) {
+    public static boolean wildcardMatch(final String fileName, final String wildcardMatcher, IOCase ioCase) {
         if (fileName == null && wildcardMatcher == null) {
             return true;
         }
         if (fileName == null || wildcardMatcher == null) {
             return false;
         }
-        if (caseSensitivity == null) {
-            caseSensitivity = IOCase.SENSITIVE;
-        }
+        ioCase = IOCase.value(ioCase, IOCase.SENSITIVE);
         final String[] wcs = splitOnTokens(wildcardMatcher);
         boolean anyChars = false;
         int textIdx = 0;
@@ -1618,16 +1613,16 @@ public static boolean wildcardMatch(final String fileName, final String wildcard
                     // matching text token
                     if (anyChars) {
                         // any chars then try to locate text token
-                        textIdx = caseSensitivity.checkIndexOf(fileName, textIdx, wcs[wcsIdx]);
+                        textIdx = ioCase.checkIndexOf(fileName, textIdx, wcs[wcsIdx]);
                         if (textIdx == NOT_FOUND) {
                             // token not found
                             break;
                         }
-                        final int repeat = caseSensitivity.checkIndexOf(fileName, textIdx + 1, wcs[wcsIdx]);
+                        final int repeat = ioCase.checkIndexOf(fileName, textIdx + 1, wcs[wcsIdx]);
                         if (repeat >= 0) {
                             backtrack.push(new int[] {wcsIdx, repeat});
                         }
-                    } else if (!caseSensitivity.checkRegionMatches(fileName, textIdx, wcs[wcsIdx])) {
+                    } else if (!ioCase.checkRegionMatches(fileName, textIdx, wcs[wcsIdx])) {
                         // matching from current position
                         // couldn't match token
                         break;

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

@@ -67,12 +67,24 @@ public enum IOCase {
     /**
      * Tests for cases sensitivity in a null-safe manner.
      *
-     * @param caseSensitivity an IOCase.
+     * @param ioCase an IOCase.
      * @return true if the input is non-null and {@link #isCaseSensitive()}.
      * @since 2.10.0
      */
-    public static boolean isCaseSensitive(final IOCase caseSensitivity) {
-        return caseSensitivity != null && !caseSensitivity.isCaseSensitive();
+    public static boolean isCaseSensitive(final IOCase ioCase) {
+        return ioCase != null && !ioCase.isCaseSensitive();
+    }
+
+    /**
+     * Returns the given value if not-null, the defaultValue if null.
+     *
+     * @param value the value to test.
+     * @param defaultValue the default value.
+     * @return the given value if not-null, the defaultValue if null.
+     * @since 2.12.0
+     */
+    public static IOCase value(final IOCase value, final IOCase defaultValue) {
+        return value != null ? value : defaultValue;
     }
 
     /** Serialization version. */

src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java

@@ -77,22 +77,22 @@ public class ExtensionFileComparator extends AbstractFileComparator implements S
     public static final Comparator<File> EXTENSION_SYSTEM_REVERSE = new ReverseFileComparator(EXTENSION_SYSTEM_COMPARATOR);
 
     /** Whether the comparison is case sensitive. */
-    private final IOCase caseSensitivity;
+    private final IOCase ioCase;
 
     /**
      * Constructs a case sensitive file extension comparator instance.
      */
     public ExtensionFileComparator() {
-        this.caseSensitivity = IOCase.SENSITIVE;
+        this.ioCase = IOCase.SENSITIVE;
     }
 
     /**
      * Constructs a file extension comparator instance with the specified case-sensitivity.
      *
-     * @param caseSensitivity how to handle case sensitivity, null means case-sensitive
+     * @param ioCase how to handle case sensitivity, null means case-sensitive
      */
-    public ExtensionFileComparator(final IOCase caseSensitivity) {
-        this.caseSensitivity = caseSensitivity == null ? IOCase.SENSITIVE : caseSensitivity;
+    public ExtensionFileComparator(final IOCase ioCase) {
+        this.ioCase = IOCase.value(ioCase, IOCase.SENSITIVE);
     }
 
     /**
@@ -110,7 +110,7 @@ public ExtensionFileComparator(final IOCase caseSensitivity) {
     public int compare(final File file1, final File file2) {
         final String suffix1 = FilenameUtils.getExtension(file1.getName());
         final String suffix2 = FilenameUtils.getExtension(file2.getName());
-        return caseSensitivity.checkCompareTo(suffix1, suffix2);
+        return ioCase.checkCompareTo(suffix1, suffix2);
     }
 
     /**
@@ -120,6 +120,6 @@ public int compare(final File file1, final File file2) {
      */
     @Override
     public String toString() {
-        return super.toString() + "[caseSensitivity=" + caseSensitivity + "]";
+        return super.toString() + "[ioCase=" + ioCase + "]";
     }
 }

src/main/java/org/apache/commons/io/comparator/NameFileComparator.java

@@ -73,22 +73,22 @@ public class NameFileComparator extends AbstractFileComparator implements Serial
     public static final Comparator<File> NAME_SYSTEM_REVERSE = new ReverseFileComparator(NAME_SYSTEM_COMPARATOR);
 
     /** Whether the comparison is case sensitive. */
-    private final IOCase caseSensitivity;
+    private final IOCase ioCase;
 
     /**
      * Constructs a case sensitive file name comparator instance.
      */
     public NameFileComparator() {
-        this.caseSensitivity = IOCase.SENSITIVE;
+        this.ioCase = IOCase.SENSITIVE;
     }
 
     /**
      * Constructs a file name comparator instance with the specified case-sensitivity.
      *
-     * @param caseSensitivity  how to handle case sensitivity, null means case-sensitive
+     * @param ioCase  how to handle case sensitivity, null means case-sensitive
      */
-    public NameFileComparator(final IOCase caseSensitivity) {
-        this.caseSensitivity = caseSensitivity == null ? IOCase.SENSITIVE : caseSensitivity;
+    public NameFileComparator(final IOCase ioCase) {
+        this.ioCase = IOCase.value(ioCase, IOCase.SENSITIVE);
     }
 
     /**
@@ -103,7 +103,7 @@ public NameFileComparator(final IOCase caseSensitivity) {
      */
     @Override
     public int compare(final File file1, final File file2) {
-        return caseSensitivity.checkCompareTo(file1.getName(), file2.getName());
+        return ioCase.checkCompareTo(file1.getName(), file2.getName());
     }
 
     /**
@@ -113,6 +113,6 @@ public int compare(final File file1, final File file2) {
      */
     @Override
     public String toString() {
-        return super.toString() + "[caseSensitivity=" + caseSensitivity + "]";
+        return super.toString() + "[ioCase=" + ioCase + "]";
     }
 }

src/main/java/org/apache/commons/io/comparator/PathFileComparator.java

@@ -73,22 +73,22 @@ public class PathFileComparator extends AbstractFileComparator implements Serial
     public static final Comparator<File> PATH_SYSTEM_REVERSE = new ReverseFileComparator(PATH_SYSTEM_COMPARATOR);
 
     /** Whether the comparison is case sensitive. */
-    private final IOCase caseSensitivity;
+    private final IOCase ioCase;
 
     /**
      * Constructs a case sensitive file path comparator instance.
      */
     public PathFileComparator() {
-        this.caseSensitivity = IOCase.SENSITIVE;
+        this.ioCase = IOCase.SENSITIVE;
     }
 
     /**
      * Constructs a file path comparator instance with the specified case-sensitivity.
      *
-     * @param caseSensitivity  how to handle case sensitivity, null means case-sensitive
+     * @param ioCase  how to handle case sensitivity, null means case-sensitive
      */
-    public PathFileComparator(final IOCase caseSensitivity) {
-        this.caseSensitivity = caseSensitivity == null ? IOCase.SENSITIVE : caseSensitivity;
+    public PathFileComparator(final IOCase ioCase) {
+        this.ioCase = IOCase.value(ioCase, IOCase.SENSITIVE);
     }
 
     /**
@@ -104,7 +104,7 @@ public PathFileComparator(final IOCase caseSensitivity) {
      */
     @Override
     public int compare(final File file1, final File file2) {
-        return caseSensitivity.checkCompareTo(file1.getPath(), file2.getPath());
+        return ioCase.checkCompareTo(file1.getPath(), file2.getPath());
     }
 
     /**
@@ -114,6 +114,6 @@ public int compare(final File file1, final File file2) {
      */
     @Override
     public String toString() {
-        return super.toString() + "[caseSensitivity=" + caseSensitivity + "]";
+        return super.toString() + "[ioCase=" + ioCase + "]";
     }
 }

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

@@ -579,13 +579,13 @@ public static IOFileFilter nameFileFilter(final String name) {
      * Returns a filter that returns true if the file name matches the specified text.
      *
      * @param name  the file name
-     * @param caseSensitivity  how to handle case sensitivity, null means case-sensitive
+     * @param ioCase  how to handle case sensitivity, null means case-sensitive
      * @return a name checking filter
      * @see NameFileFilter
      * @since 2.0
      */
-    public static IOFileFilter nameFileFilter(final String name, final IOCase caseSensitivity) {
-        return new NameFileFilter(name, caseSensitivity);
+    public static IOFileFilter nameFileFilter(final String name, final IOCase ioCase) {
+        return new NameFileFilter(name, ioCase);
     }
 
     /**
@@ -644,13 +644,13 @@ public static IOFileFilter prefixFileFilter(final String prefix) {
      * Returns a filter that returns true if the file name starts with the specified text.
      *
      * @param prefix  the file name prefix
-     * @param caseSensitivity  how to handle case sensitivity, null means case-sensitive
+     * @param ioCase  how to handle case sensitivity, null means case-sensitive
      * @return a prefix checking filter
      * @see PrefixFileFilter
      * @since 2.0
      */
-    public static IOFileFilter prefixFileFilter(final String prefix, final IOCase caseSensitivity) {
-        return new PrefixFileFilter(prefix, caseSensitivity);
+    public static IOFileFilter prefixFileFilter(final String prefix, final IOCase ioCase) {
+        return new PrefixFileFilter(prefix, ioCase);
     }
 
     /**
@@ -709,13 +709,13 @@ public static IOFileFilter suffixFileFilter(final String suffix) {
      * Returns a filter that returns true if the file name ends with the specified text.
      *
      * @param suffix  the file name suffix
-     * @param caseSensitivity  how to handle case sensitivity, null means case-sensitive
+     * @param ioCase  how to handle case sensitivity, null means case-sensitive
      * @return a suffix checking filter
      * @see SuffixFileFilter
      * @since 2.0
      */
-    public static IOFileFilter suffixFileFilter(final String suffix, final IOCase caseSensitivity) {
-        return new SuffixFileFilter(suffix, caseSensitivity);
+    public static IOFileFilter suffixFileFilter(final String suffix, final IOCase ioCase) {
+        return new SuffixFileFilter(suffix, ioCase);
     }
 
     /**

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

@@ -72,7 +72,7 @@ public class NameFileFilter extends AbstractFileFilter implements Serializable {
     private final String[] names;
 
     /** Whether the comparison is case sensitive. */
-    private final IOCase caseSensitivity;
+    private final IOCase ioCase;
 
     /**
      * Constructs a new case-sensitive name file filter for a list of names.
@@ -89,16 +89,16 @@ public NameFileFilter(final List<String> names) {
      * Constructs a new name file filter for a list of names specifying case-sensitivity.
      *
      * @param names  the names to allow, must not be null
-     * @param caseSensitivity  how to handle case sensitivity, null means case-sensitive
+     * @param ioCase  how to handle case sensitivity, null means case-sensitive
      * @throws IllegalArgumentException if the name list is null
      * @throws ClassCastException if the list does not contain Strings
      */
-    public NameFileFilter(final List<String> names, final IOCase caseSensitivity) {
+    public NameFileFilter(final List<String> names, final IOCase ioCase) {
         if (names == null) {
             throw new IllegalArgumentException("The list of names must not be null");
         }
         this.names = names.toArray(EMPTY_STRING_ARRAY);
-        this.caseSensitivity = toIOCase(caseSensitivity);
+        this.ioCase = toIOCase(ioCase);
     }
 
     /**
@@ -129,31 +129,31 @@ public NameFileFilter(final String... names) {
      * Construct a new name file filter specifying case-sensitivity.
      *
      * @param name  the name to allow, must not be null
-     * @param caseSensitivity  how to handle case sensitivity, null means case-sensitive
+     * @param ioCase  how to handle case sensitivity, null means case-sensitive
      * @throws IllegalArgumentException if the name is null
      */
-    public NameFileFilter(final String name, final IOCase caseSensitivity) {
+    public NameFileFilter(final String name, final IOCase ioCase) {
         if (name == null) {
             throw new IllegalArgumentException("The wildcard must not be null");
         }
         this.names = new String[] {name};
-        this.caseSensitivity = toIOCase(caseSensitivity);
+        this.ioCase = toIOCase(ioCase);
     }
 
     /**
      * Constructs a new name file filter for an array of names specifying case-sensitivity.
      *
      * @param names  the names to allow, must not be null
-     * @param caseSensitivity  how to handle case sensitivity, null means case-sensitive
+     * @param ioCase  how to handle case sensitivity, null means case-sensitive
      * @throws IllegalArgumentException if the names array is null
      */
-    public NameFileFilter(final String[] names, final IOCase caseSensitivity) {
+    public NameFileFilter(final String[] names, final IOCase ioCase) {
         if (names == null) {
             throw new IllegalArgumentException("The array of names must not be null");
         }
         this.names = new String[names.length];
         System.arraycopy(names, 0, this.names, 0, names.length);
-        this.caseSensitivity = toIOCase(caseSensitivity);
+        this.ioCase = toIOCase(ioCase);
     }
 
     /**
@@ -193,15 +193,15 @@ public FileVisitResult accept(final Path file, final BasicFileAttributes attribu
 
     private boolean acceptBaseName(final String baseName) {
         for (final String testName : names) {
-            if (caseSensitivity.checkEquals(baseName, testName)) {
+            if (ioCase.checkEquals(baseName, testName)) {
                 return true;
             }
         }
         return false;
     }
 
-    private IOCase toIOCase(final IOCase caseSensitivity) {
-        return caseSensitivity == null ? IOCase.SENSITIVE : caseSensitivity;
+    private IOCase toIOCase(final IOCase ioCase) {
+        return IOCase.value(ioCase, IOCase.SENSITIVE);
     }
 
     /**