cz.auderis.tools.config.spi

Class SingleTargetClassTranslator

java.lang.Object

cz.auderis.tools.config.spi.SingleTargetClassTranslator

All Implemented Interfaces:

DataTranslator

Direct Known Subclasses:

BigDecimalTranslator, BigIntegerTranslator, ClassTranslator, CurrencyTranslator, PatternTranslator, UuidTranslator

public abstract class SingleTargetClassTranslator
extends Object
implements DataTranslator

SingleTargetClassTranslator

Version:

1.0

Author:

Boleslav Bobcik <bbobcik@gmail.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<?>	supportedClass

Fields inherited from interface cz.auderis.tools.config.DataTranslator

NULL_OBJECT, PRIORITY_NORMAL_SUPPORT, PRIORITY_NOT_SUPPORTED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SingleTargetClassTranslator(Class<?> supportedClass)

Method Summary

Modifier and Type	Method and Description
int	getTargetClassSupportPriority(Class<?> targetClass, DataTranslatorContext context) Determines whether the argument represents a class supported by this translator.
String	toString()
protected abstract Object	translate(Object source, DataTranslatorContext context)
Object	translateToClass(Object source, Class<?> targetClass, DataTranslatorContext context) Attempts to translate an arbitrary object into an instance of targetClass.

Methods inherited from class java.lang.Object

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

Methods inherited from interface cz.auderis.tools.config.DataTranslator

getId

Field Detail

supportedClass

protected final Class<?> supportedClass

Constructor Detail

SingleTargetClassTranslator

protected SingleTargetClassTranslator(Class<?> supportedClass)

Method Detail

translate

protected abstract Object translate(Object source,
                                    DataTranslatorContext context)

getTargetClassSupportPriority

public int getTargetClassSupportPriority(Class<?> targetClass,
                                         DataTranslatorContext context)

Description copied from interface: DataTranslator

Determines whether the argument represents a class supported by this translator. Positive values mean that the class is supported. Unsupported classes are typically represented by DataTranslator.PRIORITY_NOT_SUPPORTED constant.

The translator that reports the highest priority will be used for the actual translation. If there are multiple translators with the same maximum priority, the choice will be arbitrary.

Specified by:

getTargetClassSupportPriority in interface DataTranslator

Parameters:

targetClass - class of the expected result of translation

context - context of the translation

Returns:

positive value if this translator is able to handle targetClass; zero or negative value if the class is not supported

translateToClass

public Object translateToClass(Object source,
                               Class<?> targetClass,
                               DataTranslatorContext context)

Description copied from interface: DataTranslator

Attempts to translate an arbitrary object into an instance of targetClass. If the translation couldn't be performed, null is returned.

As the translation happens while preparing configuration data, the translator receives information about the context of translation.

Specified by:

translateToClass in interface DataTranslator

Parameters:

source - non-null object that is to be translated

targetClass - requested target class

context - context of the translation

Returns:

instance of targetClass; null if the translation cannot be performed; DataTranslator.NULL_OBJECT if the result should be true null value

toString

public String toString()

Overrides:

toString in class Object