org.x4o.xml.conv

Interface ObjectConverter

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

AbstractObjectConverter, AbstractStringObjectConverter, BooleanConverter, ByteConverter, CharacterConverter, ClassConverter, DoubleConverter, EnumConverter, FloatConverter, IntegerConverter, LongConverter, StringSplitConverter, URLConverter

public interface ObjectConverter
extends Cloneable, Serializable

The interface to convert objects.

Version:

1.0 Aug 28, 2008

Author:

Willem Cazander

Method Summary

Methods

Modifier and Type	Method and Description
void	addObjectConverter(ObjectConverter converter)
ObjectConverter	clone() Force impl to have public clone method.
Object	convertBack(Object obj, Locale locale) Convert the object back.
Object	convertTo(Object obj, Locale locale) Convert to the object.
Class<?>	getObjectClassBack()
Class<?>	getObjectClassTo()
List<ObjectConverter>	getObjectConverters()
void	removeObjectConverter(ObjectConverter converter)

Method Detail

getObjectClassTo

Class<?> getObjectClassTo()

Returns:

Returns the class which we can convert to.

getObjectClassBack

Class<?> getObjectClassBack()

Returns:

Returns the class which we can convert from.

convertTo

Object convertTo(Object obj,
               Locale locale)
                 throws ObjectConverterException

Convert to the object.

Parameters:

obj - The object to convert.

locale - The Object convert locale if needed.

Returns:

Returns the converted object.

Throws:

ObjectConverterException - When the conversion failes.

convertBack

Object convertBack(Object obj,
                 Locale locale)
                   throws ObjectConverterException

Convert the object back.

Parameters:

obj - The object to convert.

locale - The Object convert locale if needed.

Returns:

Returns the converted object.

Throws:

ObjectConverterException - When the conversion failes.

getObjectConverters

List<ObjectConverter> getObjectConverters()

Returns:

Returns list of child converters.

addObjectConverter

void addObjectConverter(ObjectConverter converter)

Parameters:

converter - Adds an child converter.

removeObjectConverter

void removeObjectConverter(ObjectConverter converter)

Parameters:

converter - Removes this child converter.

clone

ObjectConverter clone()
                      throws CloneNotSupportedException

Force impl to have public clone method.

Returns:

An cloned ObjectConverter.

Throws:

CloneNotSupportedException - If thrown when cloning is not supported.