org.apache.brooklyn.util.javalang

Class Enums

java.lang.Object

org.apache.brooklyn.util.javalang.Enums

public class Enums
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Enums()

Method Summary

Modifier and Type	Method and Description
static void	checkAllEnumeratedIgnoreCase(java.lang.Class<? extends java.lang.Enum<?>> type, java.lang.String... explicitValues) as checkAllEnumeratedIgnoreCase(String, Enum[], String...) using the same default strategy that valueOfIgnoreCase(Class, String) applies
static void	checkAllEnumeratedIgnoreCase(java.lang.String contextMessage, java.lang.Enum<?>[] enumValues, java.lang.String... explicitValues) checks that all accepted enum values are represented by the given set of explicit values
static <T extends java.lang.Enum<?>> <any>	fromStringFunction(java.lang.Class<T> type) returns a function which given a string, produces an enum of the given type or null
static <any>	nameFunction() returns a function which given an enum, returns its name() function
static <T extends java.lang.Enum<?>> Maybe<T>	valueOfIgnoreCase(java.lang.Class<T> type, java.lang.String givenValue) as valueOfIgnoreCase(String, Enum[], String) for all values of the given enum and using the enum type as the message
static <T extends java.lang.Enum<?>> Maybe<T>	valueOfIgnoreCase(java.lang.String contextMessage, T[] enumValues, java.lang.String givenValue) attempts to match the givenValue against the given enum values, first looking for exact matches (against name and toString), then matching ignoring case, then matching with CaseFormat#UPPER_UNDERSCORE converted to CaseFormat#LOWER_CAMEL, then matching with CaseFormat#LOWER_CAMEL converted to CaseFormat#UPPER_UNDERSCORE (including case insensitive matches for the final two)
static <T extends java.lang.Enum<?>> T[]	values(java.lang.Class<T> type) returns array of values in the given enum, or null if it is not an enum

Methods inherited from class java.lang.Object

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

Constructor Detail

Enums

public Enums()

Method Detail

nameFunction

public static <any> nameFunction()

returns a function which given an enum, returns its name() function

fromStringFunction

public static <T extends java.lang.Enum<?>> <any> fromStringFunction(java.lang.Class<T> type)

returns a function which given a string, produces an enum of the given type or null

values

public static <T extends java.lang.Enum<?>> T[] values(java.lang.Class<T> type)

returns array of values in the given enum, or null if it is not an enum

checkAllEnumeratedIgnoreCase

public static void checkAllEnumeratedIgnoreCase(java.lang.Class<? extends java.lang.Enum<?>> type,
                                                java.lang.String... explicitValues)

as checkAllEnumeratedIgnoreCase(String, Enum[], String...) using the same default strategy that valueOfIgnoreCase(Class, String) applies

checkAllEnumeratedIgnoreCase

public static void checkAllEnumeratedIgnoreCase(java.lang.String contextMessage,
                                                java.lang.Enum<?>[] enumValues,
                                                java.lang.String... explicitValues)

checks that all accepted enum values are represented by the given set of explicit values

valueOfIgnoreCase

public static <T extends java.lang.Enum<?>> Maybe<T> valueOfIgnoreCase(java.lang.Class<T> type,
                                                                       java.lang.String givenValue)

as valueOfIgnoreCase(String, Enum[], String) for all values of the given enum and using the enum type as the message

valueOfIgnoreCase

public static <T extends java.lang.Enum<?>> Maybe<T> valueOfIgnoreCase(java.lang.String contextMessage,
                                                                       T[] enumValues,
                                                                       java.lang.String givenValue)

attempts to match the givenValue against the given enum values, first looking for exact matches (against name and toString), then matching ignoring case, then matching with CaseFormat#UPPER_UNDERSCORE converted to CaseFormat#LOWER_CAMEL, then matching with CaseFormat#LOWER_CAMEL converted to CaseFormat#UPPER_UNDERSCORE (including case insensitive matches for the final two)