Migrate convertToEnum method to Types.enumValue

Author: ctrueden

src/main/java/org/scijava/util/ConversionUtils.java

@@ -61,32 +61,6 @@ private ConversionUtils() {
 		// prevent instantiation of utility class
 	}
 
-	// -- Type casting --
-
-	/**
-	 * Converts the given string value to an enumeration constant of the specified
-	 * type.
-	 *
-	 * @param src The value to convert.
-	 * @param dest The type of the enumeration constant.
-	 * @return The converted enumeration constant, or null if the type is not an
-	 *         enumeration type or has no such constant.
-	 */
-	public static <T> T convertToEnum(final String src, final Class<T> dest) {
-		if (src == null || !dest.isEnum()) return null;
-		try {
-			@SuppressWarnings({ "rawtypes", "unchecked" })
-			final Enum result = Enum.valueOf((Class) dest, src);
-			@SuppressWarnings("unchecked")
-			final T typedResult = (T) result;
-			return typedResult;
-		}
-		catch (final IllegalArgumentException exc) {
-			// no such enum constant
-			return null;
-		}
-	}
-
 	// -- ConvertService setter --
 
 	/**
@@ -165,6 +139,17 @@ public static boolean canConvert(final Object src, final Class<?> dest) {
 		return (handler == null ? false : handler.canConvert(src, dest));
 	}
 
+	/** @deprecated use {@link Types#enumValue} */
+	@Deprecated
+	public static <T> T convertToEnum(final String src, final Class<T> dest) {
+		try {
+			return Types.enumValue(src,  dest);
+		}
+		catch (final IllegalArgumentException exc) {
+			return null;
+		}
+	}
+
 	/** @deprecated use {@link Types#raw} */
 	@Deprecated
 	public static Class<?> getClass(final Type type) {

src/main/java/org/scijava/util/Types.java

@@ -623,6 +623,27 @@ public static <T> T cast(final Object src, final Class<T> dest) {
 		return result;
 	}
 
+	/**
+	 * Converts the given string value to an enumeration constant of the specified
+	 * type.
+	 *
+	 * @param name The value to convert.
+	 * @param dest The type of the enumeration constant.
+	 * @return The converted enumeration constant.
+	 * @throws IllegalArgumentException if the type is not an enumeration type, or
+	 *           has no such constant.
+	 */
+	public static <T> T enumValue(final String name, final Class<T> dest) {
+		if (!dest.isEnum()) {
+			throw new IllegalArgumentException("Not an enum type: " + name(dest));
+		}
+		@SuppressWarnings({ "rawtypes", "unchecked" })
+		final Enum result = Enum.valueOf((Class) dest, name);
+		@SuppressWarnings("unchecked")
+		final T typedResult = (T) result;
+		return typedResult;
+	}
+
 	/**
 	 * Creates a new {@link ParameterizedType} of the given class together with
 	 * the specified type arguments.

src/test/java/org/scijava/util/ConversionUtilsTest.java

@@ -33,10 +33,8 @@
 package org.scijava.util;
 
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
-import static org.junit.Assert.assertSame;
 import static org.junit.Assert.assertTrue;
 
 import java.util.ArrayList;
@@ -57,22 +55,6 @@
  */
 public class ConversionUtilsTest {
 
-	/** Tests {@link ConversionUtils#convertToEnum(String, Class)}. */
-	@Test
-	public void testConvertToEnum() {
-		final Words foo = ConversionUtils.convertToEnum("FOO", Words.class);
-		assertSame(Words.FOO, foo);
-		final Words bar = ConversionUtils.convertToEnum("BAR", Words.class);
-		assertSame(Words.BAR, bar);
-		final Words fubar = ConversionUtils.convertToEnum("FUBAR", Words.class);
-		assertSame(Words.FUBAR, fubar);
-		final Words noConstant = ConversionUtils.convertToEnum("NONE", Words.class);
-		assertNull(noConstant);
-		final String notAnEnum =
-			ConversionUtils.convertToEnum("HOOYAH", String.class);
-		assertNull(notAnEnum);
-	}
-
 	/**
 	 * Tests populating a primitive array.
 	 */
@@ -457,9 +439,4 @@ public static class StringListExtension extends ArrayList<String> {
 		// NB: No implementation needed.
 	}
 
-	/** Enumeration for testing conversion to enum types. */
-	public static enum Words {
-		FOO, BAR, FUBAR
-	}
-
 }

src/test/java/org/scijava/util/TypesTest.java

@@ -462,6 +462,29 @@ public void testCast() {
 		assertEquals(5, intToNumber.intValue());
 	}
 
+	/** Tests {@link Types#enumValue(String, Class)}. */
+	@Test
+	public void testEnumValue() {
+		final Words foo = Types.enumValue("FOO", Words.class);
+		assertSame(Words.FOO, foo);
+		final Words bar = Types.enumValue("BAR", Words.class);
+		assertSame(Words.BAR, bar);
+		final Words fubar = Types.enumValue("FUBAR", Words.class);
+		assertSame(Words.FUBAR, fubar);
+	}
+
+	/** Tests {@link Types#enumValue(String, Class)} for invalid value. */
+	@Test(expected = IllegalArgumentException.class)
+	public void testEnumValueNoConstant() {
+		Types.enumValue("NONE", Words.class);
+	}
+
+	/** Tests {@link Types#enumValue(String, Class)} for non-enum class. */
+	@Test(expected = IllegalArgumentException.class)
+	public void testEnumValueNonEnum() {
+		Types.enumValue("HOOYAH", String.class);
+	}
+
 	// -- Helper classes --
 
 	private static class Thing<T> {
@@ -483,6 +506,11 @@ private static class ComplexThing<T extends Serializable & Cloneable> extends
 		// NB: No implementation needed.
 	}
 
+	/** Enumeration for testing conversion to enum types. */
+	public static enum Words {
+		FOO, BAR, FUBAR
+	}
+
 	// -- Helper methods --
 
 	/** Convenience method to get the {@link Type} of a field. */