com.foreach.common.spring.convert

Class EnumConverterFactory

java.lang.Object

com.foreach.common.spring.convert.EnumConverterFactory

All Implemented Interfaces:

RecursiveConverter, org.springframework.core.convert.converter.ConverterFactory<String,Enum>

public class EnumConverterFactory
extends Object
implements org.springframework.core.convert.converter.ConverterFactory<String,Enum>, RecursiveConverter

EnumConverterFactory is an implementation of the Spring ConverterFactory interface that generates Converters from String to Enum classes implementing IdLookup or CodeLookup.

The conversion is a two step process: first a String is converted to the parameter type of IdLookup or CodeLookup, then that value is used to determine the enum with that id or code.

Each EnumConverterFactory instance must be provided with a conversion service that can convert String to all the parameter types that require conversion.

When converting to an Enum class implementing both IdLookup and CodeLookup, the IdLookup is attempted first.

In most cases, you will group your converters in a single conversion service. Check the spring documentation on how to configure a conversion service for your application.

If an object can't be converted with the conversion service, the system falls back to property editors. For this reason, you should keep all your converters as specific as possible.

To use the EnumConverterFactory in Spring 3.1+ with @Configuration annotations:

         public class WebConfig extends WebMvcConfigurerAdapter
         {
              @Override
             public void addFormatters( FormatterRegistry registry ) {
               registry.addConverterFactory( new EnumConverterFactory() );
             }
         }
     

Constructor Summary

Constructors

Constructor and Description
EnumConverterFactory()

Method Summary

Modifier and Type	Method and Description
<E extends Enum> org.springframework.core.convert.converter.Converter<String,E>	getConverter(Class<E> targetType) Get a converter instance for the specified enum class.
void	setConversionService(org.springframework.core.convert.ConversionService conversionService) Set the conversionService.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumConverterFactory

public EnumConverterFactory()

Method Detail

setConversionService

public final void setConversionService(org.springframework.core.convert.ConversionService conversionService)

Set the conversionService. This service must be able to convert String to all the parameter types used.

Specified by:

setConversionService in interface RecursiveConverter

getConverter

public final <E extends Enum> org.springframework.core.convert.converter.Converter<String,E> getConverter(Class<E> targetType)

Get a converter instance for the specified enum class.

Specified by:

getConverter in interface org.springframework.core.convert.converter.ConverterFactory<String,Enum>

Parameters:

targetType - the Enum class being converted to.

Returns:

a converter implementing the Spring Converter interface that converts String to the specified enum class.