EnumUtils (bus-all 5.3.5 API)

java.lang.Object
- org.aoju.bus.core.utils.EnumUtils

```
public class EnumUtils
extends Object
```
枚举工具类

Since:

JDK 1.8+

Version:

5.3.5

Author:

Kimi Liu

Constructor Summary

Constructors
Constructor and Description

EnumUtils()

Constructors
Constructor and Description
`EnumUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`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 <E extends Enum<E>> E`	`fromString(Class<E> enumClass, String value)` 字符串转枚举，调用`Enum.valueOf(Class, String)`
`static <E extends Enum<E>> E`	`fromString(Class<E> enumClass, String value, E defaultValue)` 字符串转枚举，调用`Enum.valueOf(Class, String)` 如果无枚举值，返回默认值
`static <E extends Enum<E>> E`	`fromStringQuietly(Class<E> enumClass, String value)` 字符串转枚举，调用`Enum.valueOf(Class, String)`，转换失败返回`null` 而非报错
`static <E extends Enum<E>> long`	`generateBitVector(Class<E> enumClass, E... values)` 创建给定Enum值数组的长位向量表示
`static <E extends Enum<E>> long`	`generateBitVector(Class<E> enumClass, Iterable<? extends E> values)` 创建Enum的给定子集的长位向量表示
`static <E extends Enum<E>> long[]`	`generateBitVectors(Class<E> enumClass, E... values)` 根据需要使用任意数量的`long`创建Enum的给定子集的位向量表示
`static <E extends Enum<E>> long[]`	`generateBitVectors(Class<E> enumClass, Iterable<? extends E> values)` 根据需要使用任意数量的`long`创建Enum的给定子集的位向量表示
`static <E extends Enum<E>> E`	`getEnum(Class<E> enumClass, String enumName)` 获取类的枚举，如果没有找到，则返回`null`
`static <E extends Enum<E>> E`	`getEnumIgnoreCase(Class<E> enumClass, String enumName)` 获取类的枚举，如果没有找到，则返回`null`
`static <E extends Enum<E>> List<E>`	`getEnumList(Class<E> enumClass)` 获取枚举的`List`
`static <E extends Enum<E>> LinkedHashMap<String,E>`	`getEnumMap(Class<E> enumClass)` 获取枚举字符串值和枚举对象的Map对应，使用LinkedHashMap保证有序结果中键为枚举名，值为枚举对象
`static List<String>`	`getFieldNames(Class<? extends Enum<?>> clazz)` 获得枚举类中所有的字段名除用户自定义的字段名，也包括“name”字段，例如：
`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 <E extends Enum<E>> boolean`	`isValidEnum(Class<E> enumClass, String enumName)` 检查指定的名称是否是类的有效枚举
`static <E extends Enum<E>> boolean`	`isValidEnumIgnoreCase(Class<E> enumClass, String enumName)` 检查指定的名称是否是类的有效枚举
`static <E extends Enum<E>> E`	`likeValueOf(Class<E> enumClass, Object value)` 模糊匹配转换为枚举，给定一个值，匹配枚举中定义的所有字段名（包括name属性），一旦匹配到返回这个枚举对象，否则返回null
`static <E extends Enum<E>> boolean`	`notContains(Class<E> enumClass, String val)` 判断某个值是不存在枚举中
`static <E extends Enum<E>> EnumSet<E>`	`processBitVector(Class<E> enumClass, long value)` 将`generateBitVector(java.lang.Class<E>, java.lang.Iterable<? extends E>)`创建的长值转换为它所表示的enum值集
`static <E extends Enum<E>> EnumSet<E>`	`processBitVectors(Class<E> enumClass, long... values)` 将`generateBitVectors(java.lang.Class<E>, java.lang.Iterable<? extends E>)` 创建的`long[]`转换为它所表示的一组enum值
`static String`	`toString(Enum<?> e)` Enum对象转String，调用`Enum.name()` 方法

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EnumUtils
```
public EnumUtils()
```
- Method Detail
  - isEnum
```
public static boolean isEnum(Class<?> clazz)
```
    指定类是否为Enum类
    
    Parameters:
    
    clazz - 类
    
    Returns:
    
    是否为Enum类
  - isEnum
```
public static boolean isEnum(Object obj)
```
    指定类是否为Enum类
    
    Parameters:
    
    obj - 类
    
    Returns:
    
    是否为Enum类
  - toString
```
public static String toString(Enum<?> e)
```
    Enum对象转String，调用Enum.name() 方法
    
    Parameters:
    
    e - Enum
    
    Returns:
    
    name值
    
    Since:
    
    4.1.13
  - fromString
```
public static <E extends Enum<E>> E fromString(Class<E> enumClass,
                                               String value)
```
    字符串转枚举，调用Enum.valueOf(Class, String)
    
    Type Parameters:
    
    E - 枚举类型泛型
    
    Parameters:
    
    enumClass - 枚举类
    
    value - 值
    
    Returns:
    
    枚举值
    
    Since:
    
    4.1.13
  - fromString
```
public static <E extends Enum<E>> E fromString(Class<E> enumClass,
                                               String value,
                                               E defaultValue)
```
    字符串转枚举，调用Enum.valueOf(Class, String)
    如果无枚举值，返回默认值
    
    Type Parameters:
    
    E - 枚举类型泛型
    
    Parameters:
    
    enumClass - 枚举类
    
    value - 值
    
    defaultValue - 无对应枚举值返回的默认值
    
    Returns:
    
    枚举值
    
    Since:
    
    4.5.18
  - fromStringQuietly
```
public static <E extends Enum<E>> E fromStringQuietly(Class<E> enumClass,
                                                      String value)
```
    字符串转枚举，调用Enum.valueOf(Class, String)，转换失败返回null 而非报错
    
    Type Parameters:
    
    E - 枚举类型泛型
    
    Parameters:
    
    enumClass - 枚举类
    
    value - 值
    
    Returns:
    
    枚举值
    
    Since:
    
    4.5.18
  - likeValueOf
```
public static <E extends Enum<E>> E likeValueOf(Class<E> enumClass,
                                                Object value)
```
    模糊匹配转换为枚举，给定一个值，匹配枚举中定义的所有字段名（包括name属性），一旦匹配到返回这个枚举对象，否则返回null
    
    Type Parameters:
    
    E - 枚举类型
    
    Parameters:
    
    enumClass - 枚举类
    
    value - 值
    
    Returns:
    
    匹配到的枚举对象，未匹配到返回null
  - getNames
```
public static List<String> getNames(Class<? extends Enum<?>> clazz)
```
    枚举类中所有枚举对象的name列表
    
    Parameters:
    
    clazz - 枚举类
    
    Returns:
    
    name列表
  - getFieldValues
```
public static List<Object> getFieldValues(Class<? extends Enum<?>> clazz,
                                          String fieldName)
```
    获得枚举类中各枚举对象下指定字段的值
    
    Parameters:
    
    clazz - 枚举类
    
    fieldName - 字段名，最终调用getXXX方法
    
    Returns:
    
    字段值列表
  - getFieldNames
```
public static List<String> getFieldNames(Class<? extends Enum<?>> clazz)
```
    获得枚举类中所有的字段名
    除用户自定义的字段名，也包括“name”字段，例如：
```
   EnumUtil.getFieldNames(Color.class) == ["name", "index"]
 
```
    Parameters:
    
    clazz - 枚举类
    
    Returns:
    
    字段名列表
    
    Since:
    
    4.1.20
  - getEnumMap
```
public static <E extends Enum<E>> LinkedHashMap<String,E> getEnumMap(Class<E> enumClass)
```
    获取枚举字符串值和枚举对象的Map对应，使用LinkedHashMap保证有序
    结果中键为枚举名，值为枚举对象
    
    Type Parameters:
    
    E - 枚举类型
    
    Parameters:
    
    enumClass - 枚举类
    
    Returns:
    
    枚举字符串值和枚举对象的Map对应，使用LinkedHashMap保证有序
    
    Since:
    
    4.0.2
  - getNameFieldMap
```
public static Map<String,Object> getNameFieldMap(Class<? extends Enum<?>> clazz,
                                                 String fieldName)
```
    获得枚举名对应指定字段值的Map
    键为枚举名，值为字段值
    
    Parameters:
    
    clazz - 枚举类
    
    fieldName - 字段名，最终调用getXXX方法
    
    Returns:
    
    枚举名对应指定字段值的Map
  - contains
```
public static <E extends Enum<E>> boolean contains(Class<E> enumClass,
                                                   String val)
```
    判断某个值是存在枚举中
    
    Type Parameters:
    
    E - 枚举类型
    
    Parameters:
    
    enumClass - 枚举类
    
    val - 需要查找的值
    
    Returns:
    
    是否存在
  - notContains
```
public static <E extends Enum<E>> boolean notContains(Class<E> enumClass,
                                                      String val)
```
    判断某个值是不存在枚举中
    
    Type Parameters:
    
    E - 枚举类型
    
    Parameters:
    
    enumClass - 枚举类
    
    val - 需要查找的值
    
    Returns:
    
    是否不存在
  - equalsIgnoreCase
```
public static boolean equalsIgnoreCase(Enum<?> e,
                                       String val)
```
    忽略大小检查某个枚举值是否匹配指定值
    
    Parameters:
    
    e - 枚举值
    
    val - 需要判断的值
    
    Returns:
    
    是非匹配
  - equals
```
public static boolean equals(Enum<?> e,
                             String val)
```
    检查某个枚举值是否匹配指定值
    
    Parameters:
    
    e - 枚举值
    
    val - 需要判断的值
    
    Returns:
    
    是非匹配
  - getEnumList
```
public static <E extends Enum<E>> List<E> getEnumList(Class<E> enumClass)
```
    获取枚举的List
    
    Type Parameters:
    
    E - 枚举的类型
    
    Parameters:
    
    enumClass - 要查询的枚举的类
    
    Returns:
    
    枚举的可修改列表，从不为空
  - isValidEnum
```
public static <E extends Enum<E>> boolean isValidEnum(Class<E> enumClass,
                                                      String enumName)
```
    检查指定的名称是否是类的有效枚举
    
    Type Parameters:
    
    E - 枚举的类型
    
    Parameters:
    
    enumClass - 要查询的枚举的类
    
    enumName - 枚举名null返回false
    
    Returns:
    
    如果枚举名有效，则为真，否则为假
  - isValidEnumIgnoreCase
```
public static <E extends Enum<E>> boolean isValidEnumIgnoreCase(Class<E> enumClass,
                                                                String enumName)
```
    检查指定的名称是否是类的有效枚举
    
    Type Parameters:
    
    E - 枚举的类型
    
    Parameters:
    
    enumClass - 要查询的枚举的类
    
    enumName - 枚举名null返回false
    
    Returns:
    
    如果枚举名有效，则为真，否则为假
  - getEnum
```
public static <E extends Enum<E>> E getEnum(Class<E> enumClass,
                                            String enumName)
```
    获取类的枚举，如果没有找到，则返回null
    
    Type Parameters:
    
    E - 枚举的类型
    
    Parameters:
    
    enumClass - 要查询的枚举的类
    
    enumName - 枚举名
    
    Returns:
    
    枚举，如果没有找到则为空
  - getEnumIgnoreCase
```
public static <E extends Enum<E>> E getEnumIgnoreCase(Class<E> enumClass,
                                                      String enumName)
```
    获取类的枚举，如果没有找到，则返回null
    
    Type Parameters:
    
    E - 枚举的类型
    
    Parameters:
    
    enumClass - 要查询的枚举的类
    
    enumName - 枚举名
    
    Returns:
    
    枚举，如果没有找到则为空
  - generateBitVector
```
public static <E extends Enum<E>> long generateBitVector(Class<E> enumClass,
                                                         Iterable<? extends E> values)
```
    创建Enum的给定子集的长位向量表示
    
    Type Parameters:
    
    E - 枚举的类型
    
    Parameters:
    
    enumClass - 我们使用的enum类，而不是null
    
    values - long[]表示一组enum值，最右边是最不重要的数字，而不是null
    
    Returns:
    
    一组枚举值
    
    Since:
    
    3.0.1
    
    See Also:
    
    generateBitVectors(Class, Iterable)
  - generateBitVectors
```
public static <E extends Enum<E>> long[] generateBitVectors(Class<E> enumClass,
                                                            Iterable<? extends E> values)
```
    根据需要使用任意数量的long创建Enum的给定子集的位向量表示
    
    Type Parameters:
    
    E - 枚举的类型
    
    Parameters:
    
    enumClass - 我们使用的enum类，而不是null
    
    values - long[]表示一组enum值，最右边是最不重要的数字，而不是null
    
    Returns:
    
    一组枚举值
    
    Since:
    
    3.2.0
  - generateBitVector
```
public static <E extends Enum<E>> long generateBitVector(Class<E> enumClass,
                                                         E... values)
```
    创建给定Enum值数组的长位向量表示
    
    Type Parameters:
    
    E - 枚举的类型
    
    Parameters:
    
    enumClass - 我们使用的enum类，而不是null
    
    values - long[]表示一组enum值，最右边是最不重要的数字，而不是null
    
    Returns:
    
    一组枚举值
    
    Since:
    
    3.0.1
  - generateBitVectors
```
public static <E extends Enum<E>> long[] generateBitVectors(Class<E> enumClass,
                                                            E... values)
```
    根据需要使用任意数量的long创建Enum的给定子集的位向量表示
    
    Type Parameters:
    
    E - 枚举的类型
    
    Parameters:
    
    enumClass - 我们使用的enum类，而不是null
    
    values - long[]表示一组enum值，最右边是最不重要的数字，而不是null
    
    Returns:
    
    一组枚举值
    
    Since:
    
    3.2.0
  - processBitVector
```
public static <E extends Enum<E>> EnumSet<E> processBitVector(Class<E> enumClass,
                                                              long value)
```
    将generateBitVector(java.lang.Class<E>, java.lang.Iterable<? extends E>)创建的长值转换为它所表示的enum值集
    
    Type Parameters:
    
    E - 枚举的类型
    
    Parameters:
    
    enumClass - 我们使用的enum类，而不是null
    
    value - long表示一组enum值，最右边是最不重要的数字，而不是null
    
    Returns:
    
    一组枚举值
    
    Since:
    
    3.0.1
  - processBitVectors
```
public static <E extends Enum<E>> EnumSet<E> processBitVectors(Class<E> enumClass,
                                                               long... values)
```
    将generateBitVectors(java.lang.Class<E>, java.lang.Iterable<? extends E>) 创建的long[]转换为它所表示的一组enum值
    
    Type Parameters:
    
    E - 枚举的类型
    
    Parameters:
    
    enumClass - 我们使用的enum类，而不是null
    
    values - long[]表示一组enum值，最右边是最不重要的数字，而不是null
    
    Returns:
    
    一组枚举值
    
    Since:
    
    3.2.0

Class EnumUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnumUtils

Method Detail

isEnum

isEnum

toString

fromString

fromString

fromStringQuietly

likeValueOf

getNames

getFieldValues

getFieldNames

getEnumMap

getNameFieldMap

contains

notContains

equalsIgnoreCase

equals

getEnumList

isValidEnum

isValidEnumIgnoreCase

getEnum

getEnumIgnoreCase

generateBitVector

generateBitVectors

generateBitVector

generateBitVectors

processBitVector

processBitVectors