Package com.google.common.base
Class Enums
- java.lang.Object
-
- com.google.common.base.Enums
-
@GwtCompatible(emulated=true) public final class Enums extends Object
Utility methods for working withEnum
instances.- Since:
- 9.0
- Author:
- Steve McKay
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Field
getField(Enum<?> enumValue)
Returns theField
in whichenumValue
is defined.static <T extends Enum<T>>
Optional<T>getIfPresent(Class<T> enumClass, String value)
Returns an optional enum constant for the given type, usingEnum.valueOf(java.lang.Class<T>, java.lang.String)
.static <T extends Enum<T>>
Converter<String,T>stringConverter(Class<T> enumClass)
Returns a converter that converts between strings andenum
values of typeenumClass
usingEnum.valueOf(Class, String)
andEnum.name()
.
-
-
-
Method Detail
-
getField
@GwtIncompatible public static Field getField(Enum<?> enumValue)
Returns theField
in whichenumValue
is defined. For example, to get theDescription
annotation on theGOLF
constant of enumSport
, useEnums.getField(Sport.GOLF).getAnnotation(Description.class)
.- Since:
- 12.0
-
getIfPresent
public static <T extends Enum<T>> Optional<T> getIfPresent(Class<T> enumClass, String value)
Returns an optional enum constant for the given type, usingEnum.valueOf(java.lang.Class<T>, java.lang.String)
. If the constant does not exist,Optional.absent()
is returned. A common use case is for parsing user input or falling back to a default enum constant. For example,Enums.getIfPresent(Country.class, countryInput).or(Country.DEFAULT);
- Since:
- 12.0
-
stringConverter
public static <T extends Enum<T>> Converter<String,T> stringConverter(Class<T> enumClass)
Returns a converter that converts between strings andenum
values of typeenumClass
usingEnum.valueOf(Class, String)
andEnum.name()
. The converter will throw anIllegalArgumentException
if the argument is not the name of any enum constant in the specified enum.- Since:
- 16.0
-
-