org.apache.commons.convert
Interface Converter<S,T>

Type Parameters:

S - The source object type

T - The target object type

All Known Subinterfaces:

LocalizedConverter<S,T>

All Known Implementing Classes:

AbstractConverter, AbstractLocalizedConverter, BooleanConverters.BooleanToInteger, BooleanConverters.IntegerToBoolean, BooleanConverters.StringToBoolean, CollectionConverters.ArrayToList, Converters.PassThruConverter, DateTimeConverters.CalendarToLong, DateTimeConverters.CalendarToString, DateTimeConverters.DateToSqlDate, DateTimeConverters.DateToString, DateTimeConverters.DateToTimestamp, DateTimeConverters.GenericDateToLong, DateTimeConverters.LongToCalendar, DateTimeConverters.LongToDate, DateTimeConverters.LongToSqlDate, DateTimeConverters.LongToSqlTime, DateTimeConverters.LongToTimestamp, DateTimeConverters.SqlDateToDate, DateTimeConverters.SqlDateToString, DateTimeConverters.SqlDateToTimestamp, DateTimeConverters.SqlTimeToString, DateTimeConverters.StringToCalendar, DateTimeConverters.StringToDate, DateTimeConverters.StringToSqlDate, DateTimeConverters.StringToSqlTime, DateTimeConverters.StringToTimestamp, DateTimeConverters.StringToTimeZone, DateTimeConverters.TimestampToDate, DateTimeConverters.TimestampToString, DateTimeConverters.TimeZoneToString, GenericSingletonToList, GenericSingletonToSet, GenericToStringConverter, MiscConverters.BlobToByteArray, MiscConverters.ByteArrayToByteBuffer, MiscConverters.ByteBufferToByteArray, MiscConverters.CharsetToString, MiscConverters.ClobToString, MiscConverters.DecimalFormatToString, MiscConverters.EnumToString, MiscConverters.SimpleDateFormatToString, MiscConverters.StringToCharset, MiscConverters.StringToDecimalFormat, MiscConverters.StringToLocale, MiscConverters.StringToRegexPattern, MiscConverters.StringToSimpleDateFormat, MiscConverters.StringToUUID, NetConverters.InetAddressToString, NetConverters.StringToInetAddress, NetConverters.StringToURI, NetConverters.StringToURL, NetConverters.URIToURL, NetConverters.URLToURI, NumberConverters.AbstractNumberConverter, NumberConverters.AbstractNumberToStringConverter, NumberConverters.AbstractStringToNumberConverter, NumberConverters.BigDecimalToString, NumberConverters.BigIntegerToString, NumberConverters.ByteToString, NumberConverters.DoubleToString, NumberConverters.FloatToString, NumberConverters.GenericNumberToBigDecimal, NumberConverters.GenericNumberToBigInteger, NumberConverters.GenericNumberToByte, NumberConverters.GenericNumberToDouble, NumberConverters.GenericNumberToFloat, NumberConverters.GenericNumberToInteger, NumberConverters.GenericNumberToLong, NumberConverters.GenericNumberToShort, NumberConverters.IntegerToString, NumberConverters.LongToBigDecimal, NumberConverters.LongToString, NumberConverters.ShortToString, NumberConverters.StringToBigDecimal, NumberConverters.StringToBigInteger, NumberConverters.StringToByte, NumberConverters.StringToDouble, NumberConverters.StringToFloat, NumberConverters.StringToInteger, NumberConverters.StringToLong, NumberConverters.StringToShort

public interface Converter<S,T>

Converter interface. Classes implement this interface to convert one Java object type to another.

Method Summary

boolean	canConvert(Class<?> sourceClass, Class<?> targetClass) Returns true if this object can convert sourceClass to targetClass.
T	convert(S obj) Converts obj to T.
Class<?>	getSourceClass() Returns the source Class for this converter.
Class<?>	getTargetClass() Returns the target Class for this converter.

Method Detail

canConvert

boolean canConvert(Class<?> sourceClass,
                   Class<?> targetClass)

Returns true if this object can convert sourceClass to targetClass.

Implementations can accomodate class hierarchy ranges by converting super classes or interfaces.

Parameters:

sourceClass - The source Class

targetClass - The target Class

Returns:

true if this object can convert sourceClass to targetClass.

convert

T convert(S obj)
          throws ConversionException

Converts obj to T.

Parameters:

obj - The source Object to convert

Returns:

The converted Object

Throws:

ConversionException

getSourceClass

Class<?> getSourceClass()

Returns the source Class for this converter.

Returns:

The source Class for this converter

getTargetClass

Class<?> getTargetClass()

Returns the target Class for this converter.

Returns:

The target Class for this converter