cn.hutool.core.util

类 EnumUtil

java.lang.Object

cn.hutool.core.util.EnumUtil

public class EnumUtil
extends Object

枚举工具类

从以下版本开始:

3.3.0

作者:

looly

构造器概要

构造器

构造器和说明
EnumUtil()

方法概要

方法

限定符和类型	方法和说明
static <E extends Enum<E>> boolean	contains(Class<E> enumClass, String val) 判断某个值是存在枚举中
static boolean	equals(Enum<?> e, String val) 检查某个枚举值是否匹配指定值
static boolean	equalsIgnoreCase(Enum<?> e, String val) 忽略大小检查某个枚举值是否匹配指定值
static <T extends Enum<T>> T	fromString(Class<T> enumClass, String value) 字符串转枚举，调用Enum.valueOf(Class, String)
static <T extends Enum<T>> T	fromString(Class<T> enumClass, String value, T defaultValue) 字符串转枚举，调用Enum.valueOf(Class, String) 如果无枚举值，返回默认值
static <T extends Enum<T>> T	fromStringQuietly(Class<T> enumClass, String value) 字符串转枚举，调用Enum.valueOf(Class, String)，转换失败返回null 而非报错
static <E extends Enum<E>> LinkedHashMap<String,E>	getEnumMap(Class<E> enumClass) 获取枚举字符串值和枚举对象的Map对应，使用LinkedHashMap保证有序 结果中键为枚举名，值为枚举对象
static List<String>	getFieldNames(Class<? extends Enum<?>> clazz) 获得枚举类中所有的字段名 除用户自定义的字段名，也包括“name”字段，例如： EnumUtil.getFieldNames(Color.class) == ["name", "index"]
static List<Object>	getFieldValues(Class<? extends Enum<?>> clazz, String fieldName) 获得枚举类中各枚举对象下指定字段的值
static Map<String,Object>	getNameFieldMap(Class<? extends Enum<?>> clazz, String fieldName) 获得枚举名对应指定字段值的Map 键为枚举名，值为字段值
static List<String>	getNames(Class<? extends Enum<?>> clazz) 枚举类中所有枚举对象的name列表
static boolean	isEnum(Class<?> clazz) 指定类是否为Enum类
static boolean	isEnum(Object obj) 指定类是否为Enum类
static <T extends Enum<T>> T	likeValueOf(Class<T> enumClass, Object value) 模糊匹配转换为枚举，给定一个值，匹配枚举中定义的所有字段名（包括name属性），一旦匹配到返回这个枚举对象，否则返回null
static <E extends Enum<E>> boolean	notContains(Class<E> enumClass, String val) 判断某个值是不存在枚举中
static String	toString(Enum<?> e) Enum对象转String，调用Enum.name() 方法

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

EnumUtil

public EnumUtil()

方法详细资料

isEnum

public static boolean isEnum(Class<?> clazz)

指定类是否为Enum类

参数:

clazz - 类

返回:

是否为Enum类

isEnum

public static boolean isEnum(Object obj)

指定类是否为Enum类

参数:

obj - 类

返回:

是否为Enum类

toString

public static String toString(Enum<?> e)

Enum对象转String，调用Enum.name() 方法

参数:

e - Enum

返回:

name值

从以下版本开始:

4.1.13

fromString

public static <T extends Enum<T>> T fromString(Class<T> enumClass,
                               String value)

字符串转枚举，调用Enum.valueOf(Class, String)

类型参数:

T - 枚举类型泛型

参数:

enumClass - 枚举类

value - 值

返回:

枚举值

从以下版本开始:

4.1.13

fromString

public static <T extends Enum<T>> T fromString(Class<T> enumClass,
                               String value,
                               T defaultValue)

字符串转枚举，调用Enum.valueOf(Class, String)
如果无枚举值，返回默认值

类型参数:

T - 枚举类型泛型

参数:

enumClass - 枚举类

value - 值

defaultValue - 无对应枚举值返回的默认值

返回:

枚举值

从以下版本开始:

4.5.18

fromStringQuietly

public static <T extends Enum<T>> T fromStringQuietly(Class<T> enumClass,
                                      String value)

字符串转枚举，调用Enum.valueOf(Class, String)，转换失败返回null 而非报错

类型参数:

T - 枚举类型泛型

参数:

enumClass - 枚举类

value - 值

返回:

枚举值

从以下版本开始:

4.5.18

likeValueOf

public static <T extends Enum<T>> T likeValueOf(Class<T> enumClass,
                                Object value)

模糊匹配转换为枚举，给定一个值，匹配枚举中定义的所有字段名（包括name属性），一旦匹配到返回这个枚举对象，否则返回null

参数:

enumClass - 枚举类

value - 值

返回:

匹配到的枚举对象，未匹配到返回null

getNames

public static List<String> getNames(Class<? extends Enum<?>> clazz)

枚举类中所有枚举对象的name列表

参数:

clazz - 枚举类

返回:

name列表

getFieldValues

public static List<Object> getFieldValues(Class<? extends Enum<?>> clazz,
                          String fieldName)

获得枚举类中各枚举对象下指定字段的值

参数:

clazz - 枚举类

fieldName - 字段名，最终调用getXXX方法

返回:

字段值列表

getFieldNames

public static List<String> getFieldNames(Class<? extends Enum<?>> clazz)

获得枚举类中所有的字段名
除用户自定义的字段名，也包括“name”字段，例如：

   EnumUtil.getFieldNames(Color.class) == ["name", "index"]
 

参数:

clazz - 枚举类

返回:

字段名列表

从以下版本开始:

4.1.20

getEnumMap

public static <E extends Enum<E>> LinkedHashMap<String,E> getEnumMap(Class<E> enumClass)

获取枚举字符串值和枚举对象的Map对应，使用LinkedHashMap保证有序
结果中键为枚举名，值为枚举对象

参数:

enumClass - 枚举类

返回:

枚举字符串值和枚举对象的Map对应，使用LinkedHashMap保证有序

从以下版本开始:

4.0.2

getNameFieldMap

public static Map<String,Object> getNameFieldMap(Class<? extends Enum<?>> clazz,
                                 String fieldName)

获得枚举名对应指定字段值的Map
键为枚举名，值为字段值

参数:

clazz - 枚举类

fieldName - 字段名，最终调用getXXX方法

返回:

枚举名对应指定字段值的Map

contains

public static <E extends Enum<E>> boolean contains(Class<E> enumClass,
                                   String val)

判断某个值是存在枚举中

类型参数:

E -

参数:

enumClass - 枚举类

val - 需要查找的值

返回:

是否存在

notContains

public static <E extends Enum<E>> boolean notContains(Class<E> enumClass,
                                      String val)

判断某个值是不存在枚举中

类型参数:

E -

参数:

enumClass - 枚举类

val - 需要查找的值

返回:

是否不存在

equalsIgnoreCase

public static boolean equalsIgnoreCase(Enum<?> e,
                       String val)

忽略大小检查某个枚举值是否匹配指定值

参数:

e - 枚举值

val - 需要判断的值

返回:

是非匹配

equals

public static boolean equals(Enum<?> e,
             String val)

检查某个枚举值是否匹配指定值

参数:

e - 枚举值

val - 需要判断的值

返回:

是非匹配