You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2021/09/22 12:38:26 UTC

[commons-io] branch master updated: Refactor null-checks.

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git


The following commit(s) were added to refs/heads/master by this push:
     new dacc8c6  Refactor null-checks.
dacc8c6 is described below

commit dacc8c6409faa6bceaf2d44f971d2909ac1d726c
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Wed Sep 22 08:38:24 2021 -0400

    Refactor null-checks.
---
 .../commons/io/filefilter/AbstractFileFilter.java    |  7 +++++++
 .../commons/io/filefilter/DelegateFileFilter.java    | 20 ++++++++------------
 .../commons/io/filefilter/MagicNumberFileFilter.java |  4 +---
 .../apache/commons/io/filefilter/NameFileFilter.java |  4 +---
 .../apache/commons/io/filefilter/NotFileFilter.java  |  4 +---
 .../commons/io/filefilter/PrefixFileFilter.java      |  4 +---
 .../commons/io/filefilter/RegexFileFilter.java       |  4 +---
 .../commons/io/filefilter/SuffixFileFilter.java      |  4 +---
 .../commons/io/filefilter/WildcardFileFilter.java    |  4 +---
 .../apache/commons/io/filefilter/WildcardFilter.java | 12 +++---------
 10 files changed, 25 insertions(+), 42 deletions(-)

diff --git a/src/main/java/org/apache/commons/io/filefilter/AbstractFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/AbstractFileFilter.java
index 06dfbce..1d42470 100644
--- a/src/main/java/org/apache/commons/io/filefilter/AbstractFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/AbstractFileFilter.java
@@ -39,6 +39,13 @@ import org.apache.commons.io.file.PathVisitor;
  */
 public abstract class AbstractFileFilter implements IOFileFilter, PathVisitor {
 
+    static <T> T requireNonNull(final T obj, final String message) {
+        if (obj == null) {
+            throw new IllegalArgumentException(message);
+        }
+        return obj;
+    }
+
     static FileVisitResult toDefaultFileVisitResult(final boolean accept) {
         return accept ? FileVisitResult.CONTINUE : FileVisitResult.TERMINATE;
     }
diff --git a/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java
index 88f4ea4..7d0bb28 100644
--- a/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/DelegateFileFilter.java
@@ -39,26 +39,22 @@ public class DelegateFileFilter extends AbstractFileFilter implements Serializab
     /**
      * Constructs a delegate file filter around an existing FileFilter.
      *
-     * @param filter  the filter to decorate
+     * @param fileFilter  the filter to decorate
      */
-    public DelegateFileFilter(final FileFilter filter) {
-        if (filter == null) {
-            throw new IllegalArgumentException("The FileFilter must not be null");
-        }
-        this.fileFilter = filter;
+    public DelegateFileFilter(final FileFilter fileFilter) {
+        requireNonNull(fileFilter, "filter");
+        this.fileFilter = fileFilter;
         this.filenameFilter = null;
     }
 
     /**
      * Constructs a delegate file filter around an existing FilenameFilter.
      *
-     * @param filter  the filter to decorate
+     * @param filenameFilter  the filter to decorate
      */
-    public DelegateFileFilter(final FilenameFilter filter) {
-        if (filter == null) {
-            throw new IllegalArgumentException("The FilenameFilter must not be null");
-        }
-        this.filenameFilter = filter;
+    public DelegateFileFilter(final FilenameFilter filenameFilter) {
+        requireNonNull(filenameFilter, "filter");
+        this.filenameFilter = filenameFilter;
         this.fileFilter = null;
     }
 
diff --git a/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
index 9e395e5..82b2d0c 100644
--- a/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
@@ -164,9 +164,7 @@ public class MagicNumberFileFilter extends AbstractFileFilter implements
      *         is a negative number.
      */
     public MagicNumberFileFilter(final byte[] magicNumbers, final long offset) {
-        if (magicNumbers == null) {
-            throw new IllegalArgumentException("The magic number cannot be null");
-        }
+        requireNonNull(magicNumbers, "magicNumbers");
         if (magicNumbers.length == 0) {
             throw new IllegalArgumentException("The magic number must contain at least one byte");
         }
diff --git a/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java
index 1e86799..1bd5797 100644
--- a/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java
@@ -94,9 +94,7 @@ public class NameFileFilter extends AbstractFileFilter implements Serializable {
      * @throws ClassCastException if the list does not contain Strings
      */
     public NameFileFilter(final List<String> names, final IOCase ioCase) {
-        if (names == null) {
-            throw new IllegalArgumentException("The list of names must not be null");
-        }
+        requireNonNull(names, "names");
         this.names = names.toArray(EMPTY_STRING_ARRAY);
         this.ioCase = toIOCase(ioCase);
     }
diff --git a/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java
index ba47319..ab04b0a 100644
--- a/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/NotFileFilter.java
@@ -42,9 +42,7 @@ public class NotFileFilter extends AbstractFileFilter implements Serializable {
      * @throws IllegalArgumentException if the filter is null
      */
     public NotFileFilter(final IOFileFilter filter) {
-        if (filter == null) {
-            throw new IllegalArgumentException("The filter must not be null");
-        }
+        requireNonNull(filter, "filter");
         this.filter = filter;
     }
 
diff --git a/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java
index 56e408c..7f6e858 100644
--- a/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java
@@ -95,9 +95,7 @@ public class PrefixFileFilter extends AbstractFileFilter implements Serializable
      * @since 1.4
      */
     public PrefixFileFilter(final List<String> prefixes, final IOCase ioCase) {
-        if (prefixes == null) {
-            throw new IllegalArgumentException("The list of prefixes must not be null");
-        }
+        requireNonNull(prefixes, "prefixes");
         this.prefixes = prefixes.toArray(EMPTY_STRING_ARRAY);
         this.isCase = IOCase.value(ioCase, IOCase.SENSITIVE);
     }
diff --git a/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java
index e616fa7..24806b4 100644
--- a/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java
@@ -78,9 +78,7 @@ public class RegexFileFilter extends AbstractFileFilter implements Serializable
      * @return a new Pattern.
      */
     private static Pattern compile(final String pattern, final int flags) {
-        if (pattern == null) {
-            throw new IllegalArgumentException("Pattern is missing");
-        }
+        requireNonNull(pattern, "pattern");
         return Pattern.compile(pattern, flags);
     }
 
diff --git a/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java
index 887e811..d00969f 100644
--- a/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java
@@ -97,9 +97,7 @@ public class SuffixFileFilter extends AbstractFileFilter implements Serializable
      * @since 1.4
      */
     public SuffixFileFilter(final List<String> suffixes, final IOCase ioCase) {
-        if (suffixes == null) {
-            throw new IllegalArgumentException("The list of suffixes must not be null");
-        }
+        requireNonNull(suffixes, "suffixes");
         this.suffixes = suffixes.toArray(EMPTY_STRING_ARRAY);
         this.ioCase = IOCase.value(ioCase, IOCase.SENSITIVE);
     }
diff --git a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
index 0c336ed..62896b6 100644
--- a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
@@ -104,9 +104,7 @@ public class WildcardFileFilter extends AbstractFileFilter implements Serializab
      * @throws ClassCastException if the list does not contain Strings
      */
     public WildcardFileFilter(final List<String> wildcards, final IOCase ioCase) {
-        if (wildcards == null) {
-            throw new IllegalArgumentException("The wildcard list must not be null");
-        }
+        requireNonNull(wildcards, "wildcards");
         this.wildcards = wildcards.toArray(EMPTY_STRING_ARRAY);
         this.ioCase = IOCase.value(ioCase, IOCase.SENSITIVE);
     }
diff --git a/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java b/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java
index f13df28..2c47a92 100644
--- a/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java
@@ -92,9 +92,7 @@ public class WildcardFilter extends AbstractFileFilter implements Serializable {
      * @throws ClassCastException if the list does not contain Strings
      */
     public WildcardFilter(final List<String> wildcards) {
-        if (wildcards == null) {
-            throw new IllegalArgumentException("The wildcard list must not be null");
-        }
+        requireNonNull(wildcards, "wildcards");
         this.wildcards = wildcards.toArray(EMPTY_STRING_ARRAY);
     }
 
@@ -105,9 +103,7 @@ public class WildcardFilter extends AbstractFileFilter implements Serializable {
      * @throws IllegalArgumentException if the pattern is null
      */
     public WildcardFilter(final String wildcard) {
-        if (wildcard == null) {
-            throw new IllegalArgumentException("The wildcard must not be null");
-        }
+        requireNonNull(wildcard, "wildcard");
         this.wildcards = new String[] { wildcard };
     }
 
@@ -118,9 +114,7 @@ public class WildcardFilter extends AbstractFileFilter implements Serializable {
      * @throws IllegalArgumentException if the pattern array is null
      */
     public WildcardFilter(final String... wildcards) {
-        if (wildcards == null) {
-            throw new IllegalArgumentException("The wildcard array must not be null");
-        }
+        requireNonNull(wildcards, "wildcards");
         this.wildcards = wildcards.clone();
     }