Cleanup enumeration static factory methods

[mdsal.git] / binding / yang-binding / src / main / java / org / opendaylight / yangtools / yang / binding / CodeHelpers.java

diff --git a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/CodeHelpers.java b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/CodeHelpers.java
index 028543b2cd7cf216f7408f6935288660e512bf49..75e625fc1f11b33e97fc8461d540a9e1fe7e3112 100644 (file)
--- a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/CodeHelpers.java
+++ b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/CodeHelpers.java
@@ -369,6 +369,38 @@ public final class CodeHelpers {
         return hash == 0 ? 31 : hash;
     }
 
+    /**
+     * Check that the specified {@link Enumeration} object is not {@code null}. This method is meant to be used with
+     * {@code ofName(String)} and {@code ofValue(int)} static factory methods.
+     *
+     * @param obj enumeration object, possibly null
+     * @param name User-supplied enumeration name
+     * @return Enumeration object
+     * @throws IllegalArgumentException if {@code obj} is null
+     */
+    public static <T extends Enumeration> @NonNull T checkEnum(final @Nullable T obj, final String name) {
+        if (obj == null) {
+            throw new IllegalArgumentException("\"" + name + "\" is not a valid name");
+        }
+        return obj;
+    }
+
+    /**
+     * Check that the specified {@link Enumeration} object is not {@code null}. This method is meant to be used with
+     * {@code ofName(String)} and {@code ofValue(int)} static factory methods.
+     *
+     * @param obj enumeration object, possibly null
+     * @param value User-supplied enumeration value
+     * @return Enumeration object
+     * @throws IllegalArgumentException if {@code obj} is null
+     */
+    public static <T extends Enumeration> @NonNull T checkEnum(final @Nullable T obj, final int value) {
+        if (obj == null) {
+            throw new IllegalArgumentException(value + " is not a valid value");
+        }
+        return obj;
+    }
+
     /**
      * Utility method for checking whether a target object is a compatible DataObject.
      *