org.exolab.castor.mapping.loader

Class TypeInfo

java.lang.Object

org.exolab.castor.mapping.loader.TypeInfo

public class TypeInfo
extends Object

Type information passed on creation of a FieldHandlerImpl.

Version:

$Revision: 8670 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $

Author:

Assaf Arkin

Constructor Summary

Constructors

Constructor and Description
TypeInfo(Class<?> fieldType) Construct new type information for a field.
TypeInfo(Class<?> fieldType, TypeConvertor convertorTo, TypeConvertor convertorFrom, boolean required, Object defaultValue, CollectionHandler colHandler) Construct new type information for the field.
TypeInfo(Class fieldType, TypeConvertor convertorTo, TypeConvertor convertorFrom, boolean required, Object defaultValue, CollectionHandler colHandler, boolean checkForCollection) Construct new type information for the field.

Method Summary

Methods

Modifier and Type	Method and Description
CollectionHandler	getCollectionHandler() Return the collection handler of this field.
TypeConvertor	getConvertorFrom() Returns the convertor from the field type to an external type.
TypeConvertor	getConvertorTo() Returns the convertor to the field type from an external type.
Object	getDefaultValue() Returns the default value for the field.
Class	getFieldType() Returns the field type.
boolean	isImmutable() Returns true if field type is immutable.
boolean	isRequired() Returns true if field type is required.
void	setCollectionHandler(CollectionHandler handler) Sets the CollectionHandler to use for the field described by this TypeInfo.
void	setRequired(boolean required) Sets a flag indictating if the field is required.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeInfo

public TypeInfo(Class<?> fieldType)

Construct new type information for a field. This field requires no type conversion, and has no default value.

Parameters:

fieldType - The field type

TypeInfo

public TypeInfo(Class<?> fieldType,
        TypeConvertor convertorTo,
        TypeConvertor convertorFrom,
        boolean required,
        Object defaultValue,
        CollectionHandler colHandler)

Construct new type information for the field.

Parameters:

fieldType - The field type

convertorTo - Convertor to the field type from external type, or null if no conversion is required

convertorFrom - Convertor from the field type to external type, or null if no conversion is required

required - True if the field is required

defaultValue - The default value of the field, null to use the known Java defaults

colHandler - The collection handler for this field, or null if field is singular

TypeInfo

public TypeInfo(Class fieldType,
        TypeConvertor convertorTo,
        TypeConvertor convertorFrom,
        boolean required,
        Object defaultValue,
        CollectionHandler colHandler,
        boolean checkForCollection)

Construct new type information for the field.

Parameters:

fieldType - The field type

convertorTo - Convertor to the field type from external type, or null if no conversion is required

convertorFrom - Convertor from the field type to external type, or null if no conversion is required

required - True if the field is required

defaultValue - The default value of the field, null to use the known Java defaults

colHandler - The collection handler for this field, or null if field is singular

Method Detail

getFieldType

public Class getFieldType()

Returns the field type.

Returns:

The field type

getConvertorTo

public TypeConvertor getConvertorTo()

Returns the convertor to the field type from an external type.

Returns:

Convertor to field type

getConvertorFrom

public TypeConvertor getConvertorFrom()

Returns the convertor from the field type to an external type.

Returns:

Convertor from field type

isImmutable

public boolean isImmutable()

Returns true if field type is immutable.

Returns:

True if type is immutable

isRequired

public boolean isRequired()

Returns true if field type is required.

Returns:

True if field is required

getDefaultValue

public Object getDefaultValue()

Returns the default value for the field.

Returns:

The default value

getCollectionHandler

public CollectionHandler getCollectionHandler()

Return the collection handler of this field.

Returns:

The collection handler of this field

setRequired

public void setRequired(boolean required)

Sets a flag indictating if the field is required.

Parameters:

required - the value of the flag. Should be true if the field is required, false otherwise.

setCollectionHandler

public void setCollectionHandler(CollectionHandler handler)

Sets the CollectionHandler to use for the field described by this TypeInfo.

Parameters:

handler - the CollectionHandler, or null if no CollectionHandler should be used.