org.specrunner.converters.core

Class ConverterEnum

java.lang.Object

org.specrunner.converters.core.ConverterDefault

org.specrunner.converters.core.ConverterNotNullNotEmpty

org.specrunner.converters.core.ConverterEnum

All Implemented Interfaces:

Serializable, IConverter, IResetable

Direct Known Subclasses:

ConverterEnumTemplate, ConverterEnumValue

public class ConverterEnum
extends ConverterNotNullNotEmpty

Basic enumeration converter, from a text to the corresponding enumeration item. Two arguments are required:

• The enumeration class type, or enumeration class name;
• The method name to be used as reference for convertion, i.e. "ordinal".

Author:

Thiago Santos.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ARG_SIZE Expected arguments size.

Constructor Summary

Constructors

Constructor and Description
ConverterEnum()

Method Summary

Methods

Modifier and Type	Method and Description
Object	convert(Object obj, Object[] args) Convert a given object to another using some arguments as auxiliary.
protected Object	convertData(Object obj, Object[] args)
protected Class<? extends Enum<?>>	recoverType(Object type)
protected Object	recoverValue(Object obj, Object methodName, Class<? extends Enum<?>> enumType)

Methods inherited from class org.specrunner.converters.core.ConverterNotNullNotEmpty

accept

Methods inherited from class org.specrunner.converters.core.ConverterDefault

initialize

Methods inherited from class java.lang.Object

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

Field Detail

ARG_SIZE

protected static final int ARG_SIZE

Expected arguments size.

See Also:

Constant Field Values

Constructor Detail

ConverterEnum

public ConverterEnum()

Method Detail

convert

public Object convert(Object obj,
             Object[] args)
               throws ConverterException

Description copied from interface: IConverter

Convert a given object to another using some arguments as auxiliary.

Specified by:

convert in interface IConverter

Overrides:

convert in class ConverterNotNullNotEmpty

Parameters:

obj - The value to be converted.

args - The arguments.

Returns:

The converted object.

Throws:

ConverterException - On conversion errors.

convertData

protected Object convertData(Object obj,
                 Object[] args)
                      throws ConverterException

Throws:

ConverterException

recoverType

protected Class<? extends Enum<?>> recoverType(Object type)
                                        throws ConverterException

Throws:

ConverterException

recoverValue

protected Object recoverValue(Object obj,
                  Object methodName,
                  Class<? extends Enum<?>> enumType)
                       throws Exception

Throws:

Exception