org.easetech.easytest.converter

Class AbstractConverter<Type>

java.lang.Object

org.easetech.easytest.converter.AbstractConverter<Type>

Type Parameters:

Type - the type of object to convert to.

All Implemented Interfaces:

BaseConverter<Map<String,Object>,Type>, Converter<Type>, ParamAwareConverter<Type>

public abstract class AbstractConverter<Type>
extends Object
implements ParamAwareConverter<Type>

An abstract implementation of the ParamAwareConverter interface that can be used by the user to define their custom converters. Users are encouraged to extend this class instead of implementing either Converter or ParamAwareConverterinterface directly as this class provides the common implementations of convertTo() , instanceOfType() and convert(Map, String) methods whose implementations are generic to every Converter. For an example of a custom converter, you can look at the following : https://github.com/EaseTech/easytest-core/blob/master/src/test/java/org/easetech/easytest/example/ItemConverter.java

Author:

Anuj Kumar

Field Summary

Fields inherited from interface org.easetech.easytest.converter.BaseConverter

COLON, EMPTY_STRING

Constructor Summary

Constructors

Constructor and Description
AbstractConverter()

Method Summary

Methods

Modifier and Type	Method and Description
Type	convert(Map<String,Object> convertFrom, String paramName) Convert the Map into a user defined object and also expect the param name
Class<Type>	convertTo() Get the Class variable representing the Type object
ConverterSupport	getConverterSupport() Get the converter support instance
String	getParamName() Deprecated.
Type	instanceOfType() Method responsible for returning an instance of the provided Generic Type argument.
void	setConverterSupport(ConverterSupport converterSupport) Set the converter support instance
void	setParamName(String paramName) Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.easetech.easytest.converter.Converter

convert

Constructor Detail

AbstractConverter

public AbstractConverter()

Method Detail

convertTo

public Class<Type> convertTo()

Get the Class variable representing the Type object

Specified by:

convertTo in interface Converter<Type>

Returns:

the Class variable representing the Type object

convert

public Type convert(Map<String,Object> convertFrom,
           String paramName)

Description copied from interface: ParamAwareConverter

Convert the Map into a user defined object and also expect the param name

Specified by:

convert in interface ParamAwareConverter<Type>

Parameters:

convertFrom - the Map to convert from

paramName - the name of the parameter for which this converter is called

Returns:

the object to convert to identified by Converter.convertTo() class.

instanceOfType

public Type instanceOfType()

Method responsible for returning an instance of the provided Generic Type argument. The default implementation assumes that the generic type argument is a concrete type with a default no arg constructor. It calls the Class.newInstance() method to return the instance. If the passed generic type argument is an interface or an abstract type, then the method calls the Assert.fail() telling the user that the passed Class object was not a Concrete class.
A user can always extend this behavior to return specific instances in case the passed instance is an interface or an abstract class. It is recommended to extend the Abstract Converter instead of implementing the Converter interface directly.

Specified by:

instanceOfType in interface Converter<Type>

Returns:

an instance of the generic type argument passed to the AbstractConverter

getParamName

@Deprecated
public String getParamName()

Deprecated.

setParamName

@Deprecated
public void setParamName(String paramName)

Deprecated.

getConverterSupport

public ConverterSupport getConverterSupport()

Get the converter support instance

Returns:

the converterSupport

setConverterSupport

public void setConverterSupport(ConverterSupport converterSupport)

Set the converter support instance

Parameters:

converterSupport - the converterSupport to set