EnumObjectUtils (Java Enum Objectify 1.1.2 API)

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

Constructor Summary

Constructors
Constructor and Description

EnumObjectUtils()

Constructors
Constructor and Description
`EnumObjectUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`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
`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
`static <K,T extends Enum & IDescriptiveEnum<K>> T`	`getByGenericCode(Class<T> enumClass, String code)` 如果知晓IDescriptiveEnum参数类型，可以使用`getByCode(Class, Object)` 方法
`static ConfigKey`	`getConfigKeyByCode(String code)` 以编码获取ConfigKey 枚举类
`static <K,E extends Enum & IConfigSubKey<K>> E`	`getConfigSubKeyByCode(Class<E> enumClass, K code)` get enum by code
`static <E extends Enum & IConfigSubKey> Class<E>`	`getSubKeyClassForConfigKey(ConfigKey configKey)` 获取配置组的“子配置”的枚举类
`static <T extends Enum<T>> T`	`stringToEnum(Class<T> enumType, String enumName)` 转换字符串成指定enum类(泛类enum)

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

Constructor Detail
- EnumObjectUtils
```
public EnumObjectUtils()
```

Method Detail

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");

Type Parameters:: K - code type of descriptive enum; E - descriptive enum type (implement IDescriptiveEnum)
Parameters:: enumClass - must be implementing IDescriptiveEnum<K> interface; code - <K> code type
Returns:: <E>

stringToEnum
```
public static <T extends Enum<T>> T stringToEnum(Class<T> enumType,
                                 String enumName)
```
转换字符串成指定enum类(泛类enum)

Type Parameters:
T - 泛类继承enum
Parameters:
enumType - Class 想要转换的enum类
enumName - 该enum类toString()的值

Returns:
返回成功转换的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 SexEnum implements IDescriptiveEnum<Character> {
     MALE('M', "male"), FEMALE('F', "FEMALE");

     SexEnum(char code, String description) {
         // implement enum ...
     }
 }

 // === enum object class ===
 class SexEnumObject extends DescriptiveEnumObject<SexEnum, Character> {
     // implement constructor ...
     public SexEnumObject(SexEnum enumInstance) {
         super(enumInstance);
     }
 }

 // === usage ===
 public class TestMain {
     public static void main(String[] args) {
          Gson gson = new Gson();
          SexEnumObject mSexObj = EnumObjectUtils.asDescriptiveEnumObject(SexEnumObject.class, SexEnum.MALE);
          System.out.println("sex = "+gson.toJson(mSexOb));
      }
 }

Type Parameters:: 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
Parameters:: enumObjectClass - must be implementing IDescriptiveEnum<K> interface; enumInstance - enum instance
Returns:: AbstractDescriptiveEnumObject pojo instance representing enum

asEnumArray
```
public static <E extends Enum> E[] asEnumArray(Class<E> enumClass)
```
retrieve all enum values as array(泛类enum)

Type Parameters:
E - generic enum type
Parameters:
enumClass - generic enum class

Returns:
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

Type Parameters:
E - descriptive enum type (implement IDescriptiveEnum)
Parameters:
enumClass - must be implementing IDescriptiveEnum<K> interface

Returns:
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

Type Parameters:
K - code type of descriptive enum
E - descriptive enum type (implement IDescriptiveEnum)
Parameters:
enumClass - must be implementing IDescriptiveEnum<K> interface

Returns:
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

Type Parameters:
K - code type of descriptive enum
E - descriptive enum type (implement IDescriptiveEnum)
T - enum object, subclass of AbstractDescriptiveEnumObject
Parameters:
enumClass - must be implementing IDescriptiveEnum<K> interface
enumObjectClass - enum object class, inherits AbstractDescriptiveEnumObject

Returns:
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

Type Parameters:
K - code type of descriptive enum
E - descriptive enum type (implement IDescriptiveEnum)
T - enum object, subclass of AbstractDescriptiveEnumObject
Parameters:
enumClass - must be implementing IDescriptiveEnum<K> interface
enumObjectClass - enum object class, inherits AbstractDescriptiveEnumObject

Returns:
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

Type Parameters:
K - code type of descriptive enum
E - descriptive enum type (implement IDescriptiveEnum)
T - enum object, subclass of AbstractDescriptiveEnumObject
Parameters:
enumClass - must be implementing IDescriptiveEnum<K> interface
enumObjectClass - enum object class, inherits AbstractDescriptiveEnumObject

Returns:
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");

Type Parameters:: K - code type of descriptive enum; E - descriptive enum type (implement IConfigSubKey)
Parameters:: enumClass - must be implementing IConfigSubKey<K> interface; code - <K> code type
Returns:: <K>

getConfigKeyByCode
```
public static ConfigKey getConfigKeyByCode(String code)
```
以编码获取ConfigKey 枚举类

Parameters:
code - 租户配置组编码

Returns:
ConfigKey 枚举类

getSubKeyClassForConfigKey
```
public static <E extends Enum & IConfigSubKey> Class<E> getSubKeyClassForConfigKey(ConfigKey configKey)
```
获取配置组的“子配置”的枚举类

Type Parameters:
E - (实现 IConfigSubKey) “子配置”的枚举类
Parameters:
configKey - ConfigKey 银行专属配置枚举类（组）

Returns:
返回IConfigSubKey “子配置”的枚举类
See Also:
IConfigSubKey

asDescriptiveEnumArray
```
public static <E extends Enum & IDescriptiveEnum> E[] asDescriptiveEnumArray(Class<E> enumClass)
```
retrieve all enum values as array

Type Parameters:
E - descriptive enum type (implement IDescriptiveEnum)
Parameters:
enumClass - must be implementing IDescriptiveEnum<K> interface

Returns:
possible values array of enum E

asConfigSubKeyEnumArray
```
public static <E extends Enum & IConfigSubKey> E[] asConfigSubKeyEnumArray(Class<E> enumClass)
```
retrieve all enum values as array

Type Parameters:
E - configSubKey enum type (implement IConfigSubKey)
Parameters:
enumClass - must be implementing IConfigSubKey<K> interface

Returns:
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 类

Type Parameters:: K - IDescriptiveEnum 枚举类的参数“编码”类型; T - IDescriptiveEnum 枚举类
Parameters:: enumClass - 想获得解析的实际枚举类; code - 想获得的编码(字符串)
Returns:: 返回已解析成功的枚举
Throws:: ClassNotFoundException - enum class is missing; ClassCastException - failed to cast code to enum; Exception

Class EnumObjectUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnumObjectUtils

Method Detail

getByCode

stringToEnum

asDescriptiveEnumObject

asEnumArray

asDescriptiveEnumList

asDescriptiveEnumMap

asDescriptiveEnumObjectArray

asDescriptiveEnumObjectList

asDescriptiveEnumObjectMap

getConfigSubKeyByCode

getConfigKeyByCode

getSubKeyClassForConfigKey

asDescriptiveEnumArray

asConfigSubKeyEnumArray

getByGenericCode