Package io.openems.common.utils

Class EnumUtils

java.lang.Object

io.openems.common.utils.EnumUtils

public class EnumUtils
extends Object

Constructor Summary

Constructors

Constructor	Description
EnumUtils()

Method Summary

Modifier and Type	Method	Description
static <ENUM extends Enum<ENUM>> Boolean	getAsBoolean(EnumMap<ENUM,com.google.gson.JsonElement> map, ENUM member)	Gets the member of the EnumMap as Boolean.
static <ENUM extends Enum<ENUM>, E extends Enum<E>> E	getAsEnum(Class<E> enumType, EnumMap<ENUM,com.google.gson.JsonElement> map, ENUM member)	Gets the member of the EnumMap as Enum.
static <ENUM extends Enum<ENUM>> int	getAsInt(EnumMap<ENUM,com.google.gson.JsonElement> map, ENUM member)	Gets the member of the EnumMap as int.
static <ENUM extends Enum<ENUM>> com.google.gson.JsonArray	getAsJsonArray(EnumMap<ENUM,com.google.gson.JsonElement> map, ENUM member)	Gets the member of the EnumMap as JsonArray.
static <ENUM extends Enum<ENUM>> Optional<Boolean>	getAsOptionalBoolean(EnumMap<ENUM,com.google.gson.JsonElement> map, ENUM member)	Gets the member of the EnumMap as Optional Boolean.
static <ENUM extends Enum<ENUM>, E extends Enum<E>> Optional<E>	getAsOptionalEnum(Class<E> enumType, EnumMap<ENUM,com.google.gson.JsonElement> map, ENUM member)	Gets the JsonElement as Optional Enum.
static <ENUM extends Enum<ENUM>> Optional<Integer>	getAsOptionalInt(EnumMap<ENUM,com.google.gson.JsonElement> map, ENUM member)	Gets the member of the EnumMap as Optional Integer.
static <ENUM extends Enum<ENUM>> Optional<String>	getAsOptionalString(EnumMap<ENUM,com.google.gson.JsonElement> map, ENUM member)	Gets the member of the EnumMap as Optional String.
static <ENUM extends Enum<ENUM>> com.google.gson.JsonPrimitive	getAsPrimitive(EnumMap<ENUM,com.google.gson.JsonElement> map, ENUM member)	Gets the member of the EnumMap as JsonPrimitive.
static <ENUM extends Enum<ENUM>> String	getAsString(EnumMap<ENUM,com.google.gson.JsonElement> map, ENUM member)	Gets the member of the EnumMap as String.
static <ENUM extends Enum<ENUM>> com.google.gson.JsonElement	getSubElement(EnumMap<ENUM,com.google.gson.JsonElement> map, ENUM member)	Gets the member of the EnumMap as JsonElement.
static <ENUM extends Enum<ENUM>> String	nameAsCamelCase(ENUM e)	Converts the Enum CaseFormat.UPPER_UNDERSCORE name to CaseFormat.UPPER_CAMEL-case.
static <ENUM extends Enum<ENUM>> ENUM	toEnum(Class<ENUM> enumType, String name)	Gets the Enum instance from the given value.

Methods inherited from class java.lang.Object

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

Constructor Details

EnumUtils

public EnumUtils()

Method Details

toEnum

public static <ENUM extends Enum<ENUM>> ENUM toEnum(Class<ENUM> enumType,
 String name)

Gets the Enum instance from the given value.

This is a null-safe wrapper around Enum.valueOf(Class, String).

Type Parameters:

ENUM - the type

Parameters:

enumType - the class of the Enum

name - the name of the constant to return

Returns:

the enum constant of the specified enum class with the specified name; null if there is no matching Enum constant

nameAsCamelCase

public static <ENUM extends Enum<ENUM>> String nameAsCamelCase(ENUM e)

Converts the Enum CaseFormat.UPPER_UNDERSCORE name to CaseFormat.UPPER_CAMEL-case.

Type Parameters:

ENUM - the type

Parameters:

e - the enum

Returns:

the name as Camel-Case

getAsOptionalBoolean

public static <ENUM extends Enum<ENUM>>
Optional<Boolean> getAsOptionalBoolean(EnumMap<ENUM,com.google.gson.JsonElement> map,
 ENUM member)

Gets the member of the EnumMap as Optional Boolean.

Type Parameters:

ENUM - the type of the EnumMap key

Parameters:

map - the EnumMap

member - the member

Returns:

the Optional Boolean value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalEnum

public static <ENUM extends Enum<ENUM>,
E extends Enum<E>>
Optional<E> getAsOptionalEnum(Class<E> enumType,
 EnumMap<ENUM,com.google.gson.JsonElement> map,
 ENUM member)

Gets the JsonElement as Optional Enum.

Type Parameters:

ENUM - the type EnumMap

E - the Enum type

Parameters:

enumType - the class of the Enum

map - the EnumMap

member - the member of the EnumMap

Returns:

the enum value

getAsOptionalString

public static <ENUM extends Enum<ENUM>>
Optional<String> getAsOptionalString(EnumMap<ENUM,com.google.gson.JsonElement> map,
 ENUM member)

Gets the member of the EnumMap as Optional String.

Type Parameters:

ENUM - the type of the EnumMap key

Parameters:

map - the EnumMap

member - the member

Returns:

the Optional String value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsOptionalInt

public static <ENUM extends Enum<ENUM>>
Optional<Integer> getAsOptionalInt(EnumMap<ENUM,com.google.gson.JsonElement> map,
 ENUM member)

Gets the member of the EnumMap as Optional Integer.

Type Parameters:

ENUM - the type of the EnumMap key

Parameters:

map - the EnumMap

member - the member

Returns:

the Optional Integer value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsPrimitive

public static <ENUM extends Enum<ENUM>>
com.google.gson.JsonPrimitive getAsPrimitive(EnumMap<ENUM,com.google.gson.JsonElement> map,
 ENUM member)
                                      throws OpenemsError.OpenemsNamedException

Gets the member of the EnumMap as JsonPrimitive.

Type Parameters:

ENUM - the type of the EnumMap key

Parameters:

map - the EnumMap

member - the member

Returns:

the JsonPrimitive value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsJsonArray

public static <ENUM extends Enum<ENUM>>
com.google.gson.JsonArray getAsJsonArray(EnumMap<ENUM,com.google.gson.JsonElement> map,
 ENUM member)
                                  throws OpenemsError.OpenemsNamedException

Gets the member of the EnumMap as JsonArray.

Type Parameters:

ENUM - the type of the EnumMap key

Parameters:

map - the EnumMap

member - the member

Returns:

the JsonArray value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsBoolean

public static <ENUM extends Enum<ENUM>> Boolean getAsBoolean(EnumMap<ENUM,com.google.gson.JsonElement> map,
 ENUM member)
                                                      throws OpenemsError.OpenemsNamedException

Gets the member of the EnumMap as Boolean.

Type Parameters:

ENUM - the type of the EnumMap key

Parameters:

map - the EnumMap

member - the member

Returns:

the Boolean value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsEnum

public static <ENUM extends Enum<ENUM>,
E extends Enum<E>>
E getAsEnum(Class<E> enumType,
 EnumMap<ENUM,com.google.gson.JsonElement> map,
 ENUM member)
     throws OpenemsError.OpenemsNamedException

Gets the member of the EnumMap as Enum.

Type Parameters:

ENUM - the type EnumMap

E - the Enum type

Parameters:

enumType - the class of the Enum

map - the EnumMap

member - the member

Returns:

the enum value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsString

public static <ENUM extends Enum<ENUM>> String getAsString(EnumMap<ENUM,com.google.gson.JsonElement> map,
 ENUM member)
                                                    throws OpenemsError.OpenemsNamedException

Gets the member of the EnumMap as String.

Type Parameters:

ENUM - the type of the EnumMap key

Parameters:

map - the EnumMap

member - the member

Returns:

the String value

Throws:

OpenemsError.OpenemsNamedException - on error

getSubElement

public static <ENUM extends Enum<ENUM>>
com.google.gson.JsonElement getSubElement(EnumMap<ENUM,com.google.gson.JsonElement> map,
 ENUM member)
                                   throws OpenemsError.OpenemsNamedException

Gets the member of the EnumMap as JsonElement.

Type Parameters:

ENUM - the type of the EnumMap key

Parameters:

map - the EnumMap

member - the member

Returns:

the JsonElement value

Throws:

OpenemsError.OpenemsNamedException - on error

getAsInt

public static <ENUM extends Enum<ENUM>> int getAsInt(EnumMap<ENUM,com.google.gson.JsonElement> map,
 ENUM member)
                                              throws OpenemsError.OpenemsNamedException

Gets the member of the EnumMap as int.

Type Parameters:

ENUM - the type of the EnumMap key

Parameters:

map - the EnumMap

member - the member

Returns:

the int value

Throws:

OpenemsError.OpenemsNamedException - on error