com.vaadin.ui.declarative.converters
Class DesignEnumConverter

java.lang.Object
  com.vaadin.ui.declarative.converters.DesignEnumConverter

All Implemented Interfaces:

Converter<java.lang.String,java.lang.Enum>, java.io.Serializable

public class DesignEnumConverter
extends java.lang.Object
implements Converter<java.lang.String,java.lang.Enum>

An converter for Enum to/from String for DesignAttributeHandler to use internally.

Since:

7.4

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.data.util.converter.Converter

Converter.ConversionException

Constructor Summary

DesignEnumConverter()

Method Summary

java.lang.Enum	convertToModel(java.lang.String value, java.lang.Class<? extends java.lang.Enum> targetType, java.util.Locale locale) Converts the given value from target type to source type.
java.lang.String	convertToPresentation(java.lang.Enum value, java.lang.Class<? extends java.lang.String> targetType, java.util.Locale locale) Converts the given value from source type to target type.
java.lang.Class<java.lang.Enum>	getModelType() The source type of the converter.
java.lang.Class<java.lang.String>	getPresentationType() The target type of the converter.

Methods inherited from class java.lang.Object

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

Constructor Detail

DesignEnumConverter

public DesignEnumConverter()

Method Detail

convertToModel

public java.lang.Enum convertToModel(java.lang.String value,
                                     java.lang.Class<? extends java.lang.Enum> targetType,
                                     java.util.Locale locale)
                              throws Converter.ConversionException

Description copied from interface: Converter

Converts 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 chaining Converter.convertToPresentation(Object, Class, Locale) and Converter.convertToModel(Object, Class, Locale) should return the original value.

Specified by:

convertToModel in interface Converter<java.lang.String,java.lang.Enum>

Parameters:

value - The value to convert, compatible with the target type. Can be null

targetType - The requested type of the return value

locale - 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

convertToPresentation

public java.lang.String convertToPresentation(java.lang.Enum value,
                                              java.lang.Class<? extends java.lang.String> targetType,
                                              java.util.Locale locale)
                                       throws Converter.ConversionException

Description copied from interface: Converter

Converts 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 chaining Converter.convertToPresentation(Object, Class, Locale) and Converter.convertToModel(Object, Class, Locale) should return the original value.

Specified by:

convertToPresentation in interface Converter<java.lang.String,java.lang.Enum>

Parameters:

value - The value to convert, compatible with the target type. Can be null

targetType - The requested type of the return value

locale - 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 java.lang.Class<java.lang.Enum> getModelType()

Description copied from interface: Converter

The source type of the converter. Values of this type can be passed to Converter.convertToPresentation(Object, Class, Locale).

Specified by:

getModelType in interface Converter<java.lang.String,java.lang.Enum>

Returns:

The source type

getPresentationType

public java.lang.Class<java.lang.String> getPresentationType()

Description copied from interface: Converter

The target type of the converter. Values of this type can be passed to Converter.convertToModel(Object, Class, Locale).

Specified by:

getPresentationType in interface Converter<java.lang.String,java.lang.Enum>

Returns:

The target type