TypeConvertor (Castor JavaDoc)

All Superinterfaces:

java.lang.Cloneable, TypeConvertor

All Known Implementing Classes:

AbstractDateTypeConvertor, AbstractLobTypeConvertor, AbstractSimpleTypeConvertor, AbstractTypeConvertor, BigDecimalToBoolean, BigDecimalToByte, BigDecimalToDate, BigDecimalToDouble, BigDecimalToFloat, BigDecimalToInteger, BigDecimalToLong, BigDecimalToShort, BooleanToBigDecimal, BooleanToInteger, BooleanToShort, BooleanToString, ByteArrayToInputStream, ByteArrayToSerializable, ByteArrayToString, ByteToBigDecimal, ByteToInteger, ByteToShort, CastorDateToDate, CastorDateToSqlDate, CastorDurationToLong, CastorTimeToLong, CharArrayToSqlClob, CharArrayToString, DateToBigDecimal, DateToCastorDate, DateToDouble, DateToInteger, DateToLong, DateToSqlDate, DateToSqlTime, DateToSqlTimestamp, DateToString, DoubleToBigDecimal, DoubleToDate, DoubleToFloat, DoubleToInteger, DoubleToLong, EnumToOrdinal, EnumTypeConvertor, FloatToBigDecimal, FloatToDouble, FloatToInteger, FloatToLong, InputStreamToByteArray, InputStreamToSerializable, IntegerToBigDecimal, IntegerToBoolean, IntegerToByte, IntegerToDate, IntegerToDouble, IntegerToFloat, IntegerToLong, IntegerToShort, LongToBigDecimal, LongToCastorDuration, LongToCastorTime, LongToDate, LongToDouble, LongToFloat, LongToInteger, LongToShort, ObjectToString, SerializableToByteArray, SerializableToInputStream, ShortToBigDecimal, ShortToBoolean, ShortToByte, ShortToInteger, ShortToLong, SqlClobToCharArray, SqlClobToString, SqlDateToCastorDate, SqlDateToDate, SqlTimestampToDate, SqlTimestampToString, SqlTimeToDate, StringToBigDecimal, StringToBoolean, StringToByteArray, StringToCastorDuration, StringToCastorTime, StringToCharacter, StringToCharArray, StringToDate, StringToDouble, StringToFloat, StringToInteger, StringToLong, StringToShort, StringToSqlClob, StringToSqlTimestamp
```
public interface TypeConvertor
extends TypeConvertor, java.lang.Cloneable
```
Interface for a type convertor. A type convertor converts a Java object from one type to another. A type convertor implementation is required for each type of conversion.

Since:

1.1.3

Version:

$Revision: 7134 $ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $

Author:

Ralf Joachim

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.Object`	`clone()`	Creates and returns a copy of this object.
`void`	`configure(AbstractProperties properties)`	Configure the converter with given configuration.
`java.lang.Object`	`convert(java.lang.Object object)`	Convert the object from one type to another.
`java.lang.Class<?>`	`fromType()`	Get the type being converted from.
`void`	`parameterize(java.lang.String parameter)`	Initialize the converter with the given parameter.
`java.lang.Class<?>`	`toType()`	Get the type being converted to.

- Method Detail
  - configure
```
void configure(AbstractProperties properties)
```
    Configure the converter with given configuration.
    
    Parameters:
    
    properties - Properties to use.
  - parameterize
```
void parameterize(java.lang.String parameter)
```
    Initialize the converter with the given parameter. If no parameter is available the method don't need to be called or may be called with null which both should lead to the default behaviour of the converter.
    
    Parameters:
    
    parameter - The parameter for the convertor (null if is not specified).
  - clone
```
java.lang.Object clone()
```
    Creates and returns a copy of this object.
    
    Returns:
    
    A clone of this instance.
  - fromType
```
java.lang.Class<?> fromType()
```
    Get the type being converted from.
    
    Returns:
    
    The type being converted from.
  - toType
```
java.lang.Class<?> toType()
```
    Get the type being converted to.
    
    Returns:
    
    The type being converted to.
  - convert
```
java.lang.Object convert(java.lang.Object object)
                  throws java.lang.ClassCastException
```
    Convert the object from one type to another.
    
    Specified by:
    
    convert in interface TypeConvertor
    
    Parameters:
    
    object - The object to convert.
    
    Returns:
    
    The converted object.
    
    Throws:
    
    java.lang.ClassCastException - The object is not of the type supported by this convertor.

Interface TypeConvertor

Method Summary

Method Detail

configure

parameterize

clone

fromType

toType

convert