We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.data.util.converter.
Class StringToEnumConverter
- java.lang.Object
-
- com.vaadin.data.util.converter.StringToEnumConverter
-
All Implemented Interfaces:
public class StringToEnumConverter extends Object implements Converter<String,Enum>A converter that converts from
Stringto anEnumand back.Designed to provide nice human readable strings for
Enumclasses conforming to one of these patterns:- The constants are named SOME_UPPERCASE_WORDS and there's no toString implementation.
- toString() always returns the same human readable string that is not the same as its name() value. Each constant in the enum type returns a distinct toString() value.
Since:
7.4
Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.vaadin.data.util.converter.Converter
Converter.ConversionException
-
-
Constructor Summary
Constructors Constructor and Description StringToEnumConverter()
-
Method Summary
All Methods Modifier and Type Method and Description EnumconvertToModel(String value, Class<? extends Enum> targetType, Locale locale)Converts the given value from target type to source type.
StringconvertToPresentation(Enum value, Class<? extends String> targetType, Locale locale)Converts the given value from source type to target type.
static StringenumToString(Enum<?> value, Locale locale)Converts the given enum to a human readable string using the given locale
Class<Enum>getModelType()The source type of the converter.
Class<String>getPresentationType()The target type of the converter.
static <T extends Enum<T>>
TstringToEnum(String value, Class<T> enumType, Locale locale)Converts the given string to the given enum type using the given locale
-
-
-
Method Detail
-
convertToModel
public Enum convertToModel(String value, Class<? extends Enum> targetType, Locale locale) throws Converter.ConversionExceptionDescription copied from interface:
ConverterConverts the given value from target type to source type.
A converter can optionally use locale to do the conversion.
A converter should in most cases be symmetric so chainingConverter.convertToPresentation(Object, Class, Locale)andConverter.convertToModel(Object, Class, Locale)should return the original value.Specified by:
convertToModelin interfaceConverter<String,Enum>Parameters:
value- The value to convert, compatible with the target type. Can be nulltargetType- The requested type of the return valuelocale- The locale to use for conversion. Can be null.Returns:
The converted value compatible with the source type
Throws:
Converter.ConversionException- If the value could not be converted
-
stringToEnum
public static <T extends Enum<T>> T stringToEnum(String value, Class<T> enumType, Locale locale) throws Converter.ConversionExceptionConverts the given string to the given enum type using the given locale
Compatible with
enumToString(Enum, Locale)Parameters:
value- The string value to convertenumType- The type of enum to createlocale- The locale to use for conversion. If null, the JVM default locale will be usedReturns:
The enum which matches the given string
Throws:
ConversionException- if the conversion fails
-
enumToString
public static String enumToString(Enum<?> value, Locale locale)Converts the given enum to a human readable string using the given locale
Compatible with
stringToEnum(String, Class, Locale)Parameters:
value- The enum value to convertlocale- The locale to use for conversion. If null, the JVM default locale will be usedReturns:
A human readable string based on the enum
Throws:
ConversionException- if the conversion fails
-
convertToPresentation
public String convertToPresentation(Enum value, Class<? extends String> targetType, Locale locale) throws Converter.ConversionExceptionDescription copied from interface:
ConverterConverts the given value from source type to target type.
A converter can optionally use locale to do the conversion.
A converter should in most cases be symmetric so chainingConverter.convertToPresentation(Object, Class, Locale)andConverter.convertToModel(Object, Class, Locale)should return the original value.Specified by:
convertToPresentationin interfaceConverter<String,Enum>Parameters:
value- The value to convert, compatible with the target type. Can be nulltargetType- The requested type of the return valuelocale- The locale to use for conversion. Can be null.Returns:
The converted value compatible with the source type
Throws:
Converter.ConversionException- If the value could not be converted
-
getModelType
public Class<Enum> getModelType()Description copied from interface:
ConverterThe source type of the converter. Values of this type can be passed to
Converter.convertToPresentation(Object, Class, Locale).Specified by:
getModelTypein interfaceConverter<String,Enum>Returns:
The source type
-
getPresentationType
public Class<String> getPresentationType()Description copied from interface:
ConverterThe target type of the converter. Values of this type can be passed to
Converter.convertToModel(Object, Class, Locale).Specified by:
getPresentationTypein interfaceConverter<String,Enum>Returns:
The target type
-
-