net.sf.mmm.util.value.impl

Class ValueConverterToEnum

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.value.base.AbstractSimpleValueConverter<Object,Enum>

net.sf.mmm.util.value.impl.ValueConverterToEnum

All Implemented Interfaces:

SimpleValueConverter<Object,Enum>, ValueConverter<Object,Enum>

@Singleton
 @Named
public class ValueConverterToEnum
extends AbstractSimpleValueConverter<Object,Enum>

This is an implementation of the ValueConverter interface that converts an Object to an Enum. It supports objects given as CharSequence (e.g. String) or Number as well as an Enum having an value with the same name.

Since:

1.0.1

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
ValueConverterToEnum() The constructor.

Method Summary

Modifier and Type	Method and Description
<T extends Enum> T	convert(Object value, Object valueSource, Class<T> targetClass) This method converts the given pojo to the <TARGET>-type.
Class<Object>	getSourceType() This the type of the value accepted by this converter.
Class<Enum>	getTargetType() Is the guaranteed return-type of the conversion.

Methods inherited from class net.sf.mmm.util.value.base.AbstractSimpleValueConverter

convert

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialize, doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueConverterToEnum

public ValueConverterToEnum()

The constructor.

Method Detail

getSourceType

public Class<Object> getSourceType()

Description copied from interface: ValueConverter

This the type of the value accepted by this converter. Use Object if you want to accept any value. A very common source-type is String.

Returns:

the source-type.

getTargetType

public Class<Enum> getTargetType()

Description copied from interface: ValueConverter

Is the guaranteed return-type of the conversion. This information is used externally to choose the most specific ValueConverter that is appropriate for the conversion.
E.g. a generic converter can have Object as target-type while a specific converter may have Collection as target-type. Now if an object (compliant with the source-type) needs to be converted to a Collection or List, the specific converter is used while for other objects the generic converter is chosen.
Please note that the target-type is often more general than the actual returned result. So a ValueConverter that converts a comma-separated String to an ArrayList will typically declare List as target-type.

Returns:

the target-type.

convert

public <T extends Enum> T convert(Object value,
                                  Object valueSource,
                                  Class<T> targetClass)

Description copied from interface: SimpleValueConverter

This method converts the given pojo to the <TARGET>-type.

Type Parameters:

T - is the generic type of targetClass.

Parameters:

value - is the value to convert.

valueSource - describes the source of the value. This may be the filename where the value was read from, an XPath where the value was located in an XML document, etc. It is used in exceptions thrown if something goes wrong. This will help to find the problem easier.

targetClass - is the type to convert the value to.

Returns:

the converted value or null if the conversion is NOT possible. The returned value has to be an instance of the given targetType.