org.exolab.castor.mapping.loader

Class TypeInfo


public class TypeInfo
extends java.lang.Object

Type information passed on creation of a FieldHandlerImpl.
Version:
$Revision: 1.3 $ $Date: 2003/04/22 23:18:12 $
Author:
Assaf Arkin

Constructor Summary

TypeInfo(Class fieldType)
Construct new type information for a field.
TypeInfo(Class fieldType, TypeConvertor convertorTo, TypeConvertor convertorFrom, String convertorParam, boolean required, Object defaultValue, CollectionHandler colHandler)
Construct new type information for the field.
TypeInfo(Class fieldType, TypeConvertor convertorTo, TypeConvertor convertorFrom, String convertorParam, boolean required, Object defaultValue, CollectionHandler colHandler, boolean checkForCollection)
Construct new type information for the field.
TypeInfo(Class fieldType, TypeConvertor convertorTo, TypeConvertor convertorFrom, boolean required, Object defaultValue, CollectionHandler colHandler)
Construct new type information for the field.

Method Summary

CollectionHandler
getCollectionHandler()
Return the collection handler of this field.
TypeConvertor
getConvertorFrom()
Returns the convertor from the field type to an external type.
String
getConvertorParam()
Returns the convertor parameter.
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.

Constructor Details

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,
                String convertorParam,
                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
convertorParam - Optional parameter for the convertor, or null if either no conversion is required or no parameter is specified
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,
                String convertorParam,
                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
convertorParam - Optional parameter for the convertor, or null if either no conversion is required or no parameter is specified
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)
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

Method Details

getCollectionHandler

public CollectionHandler getCollectionHandler()
Return the collection handler of this field.
Returns:
The collection handler of this field

getConvertorFrom

public TypeConvertor getConvertorFrom()
Returns the convertor from the field type to an external type.
Returns:
Convertor from field type

getConvertorParam

public String getConvertorParam()
Returns the convertor parameter.
Returns:
Convertor parameter

getConvertorTo

public TypeConvertor getConvertorTo()
Returns the convertor to the field type from an external type.
Returns:
Convertor to field type

getDefaultValue

public Object getDefaultValue()
Returns the default value for the field.
Returns:
The default value

getFieldType

public Class getFieldType()
Returns the field type.
Returns:
The 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

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.

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.

Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com