Package org.nuiton.converter

Class EnumConverter<E extends Enum>

java.lang.Object

org.nuiton.converter.EnumConverter<E>

All Implemented Interfaces:

org.apache.commons.beanutils.Converter, NuitonConverter<E>

public class EnumConverter<E extends Enum>
extends Object
implements NuitonConverter<E>

To convert Enum type-safe (exact type is enumType from and to String.

It is possible also to convert the enum object from his ordinal using method convertFromOrdinal(Class, Object).

you can also define a default value while trying to convert null value.

To register a new such converter use methods ConverterUtil.registerEnumConverter(Class), or ConverterUtil.registerEnumConverter(Class, Object) .

Since:

1.0

Author:

Tony Chemit - chemit@codelutin.com

See Also:

Enum, Enum.ordinal()

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	defaultValue	Default value to use if try to convert null value and flag useDefault is on.
protected Class<E>	enumType	Enum type-safe.
protected boolean	useDefault	flag to use or not default value.

Constructor Summary

Constructors

Constructor	Description
EnumConverter(Class<E> enumType)
EnumConverter(Class<E> enumType, Object defaultValue)

Method Summary

Modifier and Type	Method	Description
protected EnumSet<?>	allOf(Class<?> aClass)
<T> T	convert(Class<T> aClass, Object value)
protected Object	convertFromOrdinal(Class<?> aClass, Object value)
Class<E>	getType()
protected static boolean	isEnabled(Class<?> aClass, Class<?> enumType)
protected Object	valueOf(Class<?> aClass, Object value)

Methods inherited from class java.lang.Object

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

Field Detail

defaultValue

protected Object defaultValue

Default value to use if try to convert null value and flag useDefault is on.

useDefault

protected boolean useDefault

flag to use or not default value.

enumType

protected Class<E extends Enum> enumType

Enum type-safe.

Constructor Detail

EnumConverter

public EnumConverter(Class<E> enumType,
                     Object defaultValue)

EnumConverter

public EnumConverter(Class<E> enumType)

Method Detail

convert

public <T> T convert(Class<T> aClass,
                     Object value)

Specified by:

convert in interface org.apache.commons.beanutils.Converter

getType

public Class<E> getType()

Specified by:

getType in interface NuitonConverter<E extends Enum>

Returns:

the main type of the converter.

isEnabled

protected static boolean isEnabled(Class<?> aClass,
                                   Class<?> enumType)

convertFromOrdinal

protected Object convertFromOrdinal(Class<?> aClass,
                                    Object value)

valueOf

protected Object valueOf(Class<?> aClass,
                         Object value)

allOf

protected EnumSet<?> allOf(Class<?> aClass)