com.github.avatar21.enumobj.utils

类 EnumObjectUtils

java.lang.Object

com.github.avatar21.enumobj.utils.EnumObjectUtils

public class EnumObjectUtils
extends Object

Utilities for descriptive enum, such as:

• Turn descriptive enum into POJO Object
• get enum by code

构造器概要

构造器

构造器和说明
EnumObjectUtils()

方法概要

限定符和类型	方法和说明
static <E extends Enum & IConfigSubKey> E[]	asConfigSubKeyEnumArray(Class<E> enumClass) retrieve all enum values as array
static <E extends Enum & IDescriptiveEnum> E[]	asDescriptiveEnumArray(Class<E> enumClass) retrieve all enum values as array
static <E extends Enum & IDescriptiveEnum> List<E>	asDescriptiveEnumList(Class<E> enumClass) retrieve all enum values as list
static <K,E extends Enum & IDescriptiveEnum<K>> Map<K,E>	asDescriptiveEnumMap(Class<E> enumClass) retrieve all enum values as code->enum HashMap
static <K,E extends Enum & IDescriptiveEnum<K>,T extends AbstractDescriptiveEnumObject<E,K>> T	asDescriptiveEnumObject(Class<T> enumObjectClass, E enumInstance) convert enum into POJO object usage: // === enum class ... === public enum SampleEnum implements IDescriptiveEnum <String > { // implement enum ... } // === usage === AbstractDescriptiveEnumObject <String > sampleEnumObj = EnumObjectUtils.asDescriptiveEnumObject(SampleEnum.class, SampleEnum.S1);
static <K,E extends Enum & IDescriptiveEnum<K>,T extends AbstractDescriptiveEnumObject<E,K>> T[]	asDescriptiveEnumObjectArray(Class<E> enumClass, Class<T> enumObjectClass) retrieve all enum values as pojo array
static <K,E extends Enum & IDescriptiveEnum<K>,T extends AbstractDescriptiveEnumObject<E,K>> List<T>	asDescriptiveEnumObjectList(Class<E> enumClass, Class<T> enumObjectClass) retrieve all enum values as pojo list
static <K,E extends Enum & IDescriptiveEnum<K>,T extends AbstractDescriptiveEnumObject<E,K>> Map<K,T>	asDescriptiveEnumObjectMap(Class<E> enumClass, Class<T> enumObjectClass) retrieve all enum values as code->pojo map
static <E extends Enum> E[]	asEnumArray(Class<E> enumClass) retrieve all enum values as array(泛类enum)
static <K,E extends Enum & IDescriptiveEnum<K>> E	getByCode(Class<E> enumClass, K code) get enum by code usage: // === enum class ... === public enum SampleEnum implements IDescriptiveEnum<String> { // implement enum ... } // === usage === SampleEnum enumIns = EnumObjectUtils.getByCode(SampleEnum.class, "0");
static <K,T extends Enum & IDescriptiveEnum<K>> T	getByGenericCode(Class<T> enumClass, String code) 如果知晓IDescriptiveEnum参数类型，可以使用getByCode(Class, Object) 方法 若不知晓参数类型，可以使用此方法，统一传入String 类
static ConfigKey	getConfigKeyByCode(String code) 以编码获取ConfigKey 枚举类
static <K,E extends Enum & IConfigSubKey<K>> E	getConfigSubKeyByCode(Class<E> enumClass, K code) get enum by code usage: // === enum class ... === public enum SampleEnum implements IDescriptiveEnum<String> { // implement enum ... } // === usage === SampleEnum enumIns = EnumObjectUtils.getByCode(SampleEnum.class, "0");
static <E extends Enum & IConfigSubKey> Class<E>	getSubKeyClassForConfigKey(ConfigKey configKey) 获取配置组的“子配置”的枚举类
static <T extends Enum<T>> T	stringToEnum(Class<T> enumType, String enumName) 转换字符串成指定enum类(泛类enum)

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

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

构造器详细资料

EnumObjectUtils

public EnumObjectUtils()

方法详细资料

getByCode

public static <K,E extends Enum & IDescriptiveEnum<K>> E getByCode(Class<E> enumClass,
                                                                   K code)

get enum by code

usage:

     // === enum class ... ===
     public enum SampleEnum implements IDescriptiveEnum<String> {
          // implement enum ...
     }
     // === usage ===
     SampleEnum enumIns = EnumObjectUtils.getByCode(SampleEnum.class, "0");
 

类型参数:

K - code type of descriptive enum

E - descriptive enum type (implement IDescriptiveEnum)

参数:

enumClass - must be implementing IDescriptiveEnum<K> interface

code - <K> code type

返回:

<E>

stringToEnum

public static <T extends Enum<T>> T stringToEnum(Class<T> enumType,
                                                 String enumName)

转换字符串成指定enum类(泛类enum)

类型参数:

T - 泛类继承enum

参数:

enumType - Class 想要转换的enum类

enumName - 该enum类toString()的值

返回:

返回成功转换的enum类实例

asDescriptiveEnumObject

public static <K,E extends Enum & IDescriptiveEnum<K>,T extends AbstractDescriptiveEnumObject<E,K>> T asDescriptiveEnumObject(Class<T> enumObjectClass,
                                                                                                                              E enumInstance)

convert enum into POJO object

usage:

 
     // === enum class ... ===
     public enum SampleEnum implements IDescriptiveEnum <String > {
          // implement enum ...
     }
     // === usage ===
     AbstractDescriptiveEnumObject <String > sampleEnumObj = EnumObjectUtils.asDescriptiveEnumObject(SampleEnum.class, SampleEnum.S1);
 
 

类型参数:

K - code type of descriptive enum

E - descriptive enum type (implement IDescriptiveEnum)

T - a child class of AbstractDescriptiveEnumObject class, as a container bean for accepting the result of enum conversion

参数:

enumObjectClass - must be implementing IDescriptiveEnum<K> interface

enumInstance - enum instance

返回:

AbstractDescriptiveEnumObject pojo instance representing enum

asEnumArray

public static <E extends Enum> E[] asEnumArray(Class<E> enumClass)

retrieve all enum values as array(泛类enum)

类型参数:

E - generic enum type

参数:

enumClass - generic enum class

返回:

possible values array of enum E

asDescriptiveEnumList

public static <E extends Enum & IDescriptiveEnum> List<E> asDescriptiveEnumList(Class<E> enumClass)

retrieve all enum values as list

类型参数:

E - descriptive enum type (implement IDescriptiveEnum)

参数:

enumClass - must be implementing IDescriptiveEnum<K> interface

返回:

possible values List of enum E

asDescriptiveEnumMap

public static <K,E extends Enum & IDescriptiveEnum<K>> Map<K,E> asDescriptiveEnumMap(Class<E> enumClass)

retrieve all enum values as code->enum HashMap

类型参数:

K - code type of descriptive enum

E - descriptive enum type (implement IDescriptiveEnum)

参数:

enumClass - must be implementing IDescriptiveEnum<K> interface

返回:

possible values Map of code K->enum E

asDescriptiveEnumObjectArray

public static <K,E extends Enum & IDescriptiveEnum<K>,T extends AbstractDescriptiveEnumObject<E,K>> T[] asDescriptiveEnumObjectArray(Class<E> enumClass,
                                                                                                                                     Class<T> enumObjectClass)

retrieve all enum values as pojo array

类型参数:

K - code type of descriptive enum

E - descriptive enum type (implement IDescriptiveEnum)

T - enum object, subclass of AbstractDescriptiveEnumObject

参数:

enumClass - must be implementing IDescriptiveEnum<K> interface

enumObjectClass - enum object class, inherits AbstractDescriptiveEnumObject

返回:

possible values array of pojo AbstractDescriptiveEnumObject representing E

asDescriptiveEnumObjectList

public static <K,E extends Enum & IDescriptiveEnum<K>,T extends AbstractDescriptiveEnumObject<E,K>> List<T> asDescriptiveEnumObjectList(Class<E> enumClass,
                                                                                                                                        Class<T> enumObjectClass)

retrieve all enum values as pojo list

类型参数:

K - code type of descriptive enum

E - descriptive enum type (implement IDescriptiveEnum)

T - enum object, subclass of AbstractDescriptiveEnumObject

参数:

enumClass - must be implementing IDescriptiveEnum<K> interface

enumObjectClass - enum object class, inherits AbstractDescriptiveEnumObject

返回:

possible values List of pojo AbstractDescriptiveEnumObject representing E

asDescriptiveEnumObjectMap

public static <K,E extends Enum & IDescriptiveEnum<K>,T extends AbstractDescriptiveEnumObject<E,K>> Map<K,T> asDescriptiveEnumObjectMap(Class<E> enumClass,
                                                                                                                                        Class<T> enumObjectClass)

retrieve all enum values as code->pojo map

类型参数:

K - code type of descriptive enum

E - descriptive enum type (implement IDescriptiveEnum)

T - enum object, subclass of AbstractDescriptiveEnumObject

参数:

enumClass - must be implementing IDescriptiveEnum<K> interface

enumObjectClass - enum object class, inherits AbstractDescriptiveEnumObject

返回:

possible values Map of code K->pojo AbstractDescriptiveEnumObject representing E

getConfigSubKeyByCode

public static <K,E extends Enum & IConfigSubKey<K>> E getConfigSubKeyByCode(Class<E> enumClass,
                                                                            K code)

get enum by code

usage:

     // === enum class ... ===
     public enum SampleEnum implements IDescriptiveEnum<String> {
          // implement enum ...
     }
     // === usage ===
     SampleEnum enumIns = EnumObjectUtils.getByCode(SampleEnum.class, "0");
 

类型参数:

K - code type of descriptive enum

E - descriptive enum type (implement IConfigSubKey)

参数:

enumClass - must be implementing IConfigSubKey<K> interface

code - <K> code type

返回:

<K>

getConfigKeyByCode

public static ConfigKey getConfigKeyByCode(String code)

以编码获取ConfigKey 枚举类

参数:

code - 租户配置组编码

返回:

ConfigKey 枚举类

getSubKeyClassForConfigKey

public static <E extends Enum & IConfigSubKey> Class<E> getSubKeyClassForConfigKey(ConfigKey configKey)

获取配置组的“子配置”的枚举类

类型参数:

E - (实现 IConfigSubKey) “子配置”的枚举类

参数:

configKey - ConfigKey 银行专属配置枚举类（组）

返回:

返回IConfigSubKey “子配置”的枚举类

另请参阅:

IConfigSubKey

asDescriptiveEnumArray

public static <E extends Enum & IDescriptiveEnum> E[] asDescriptiveEnumArray(Class<E> enumClass)

retrieve all enum values as array

类型参数:

E - descriptive enum type (implement IDescriptiveEnum)

参数:

enumClass - must be implementing IDescriptiveEnum<K> interface

返回:

possible values array of enum E

asConfigSubKeyEnumArray

public static <E extends Enum & IConfigSubKey> E[] asConfigSubKeyEnumArray(Class<E> enumClass)

retrieve all enum values as array

类型参数:

E - configSubKey enum type (implement IConfigSubKey)

参数:

enumClass - must be implementing IConfigSubKey<K> interface

返回:

possible values array of enum E

getByGenericCode

public static <K,T extends Enum & IDescriptiveEnum<K>> T getByGenericCode(Class<T> enumClass,
                                                                          String code)
                                                                   throws Exception,
                                                                          ClassNotFoundException,
                                                                          ClassCastException

如果知晓IDescriptiveEnum参数类型，可以使用getByCode(Class, Object) 方法

若不知晓参数类型，可以使用此方法，统一传入String 类

类型参数:

K - IDescriptiveEnum 枚举类的参数“编码”类型

T - IDescriptiveEnum 枚举类

参数:

enumClass - 想获得解析的实际枚举类

code - 想获得的编码(字符串)

返回:

返回已解析成功的枚举

抛出:

ClassNotFoundException - enum class is missing

ClassCastException - failed to cast code to enum

Exception