org.exolab.castor.mapping.loader
Class TypeInfo

java.lang.Object
  extended by org.exolab.castor.mapping.loader.TypeInfo

public class TypeInfo
extends java.lang.Object

Type information passed on creation of a FieldHandlerImpl.

Version:
$Revision: 1.5 $ $Date: 2005/03/05 13:41:52 $
Author:
Assaf Arkin

Constructor Summary
TypeInfo(java.lang.Class fieldType)
          Construct new type information for a field.
TypeInfo(java.lang.Class fieldType, TypeConvertor convertorTo, TypeConvertor convertorFrom, boolean required, java.lang.Object defaultValue, CollectionHandler colHandler)
          Construct new type information for the field.
TypeInfo(java.lang.Class fieldType, TypeConvertor convertorTo, TypeConvertor convertorFrom, java.lang.String convertorParam, boolean required, java.lang.Object defaultValue, CollectionHandler colHandler)
          Construct new type information for the field.
TypeInfo(java.lang.Class fieldType, TypeConvertor convertorTo, TypeConvertor convertorFrom, java.lang.String convertorParam, boolean required, java.lang.Object defaultValue, CollectionHandler colHandler, boolean checkForCollection)
          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.
 java.lang.String getConvertorParam()
          Returns the convertor parameter.
 TypeConvertor getConvertorTo()
          Returns the convertor to the field type from an external type.
 java.lang.Object getDefaultValue()
          Returns the default value for the field.
 java.lang.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.
(package private)  void setImmutable(boolean immutable)
          Sets whether or not the type is immutable
 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(java.lang.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(java.lang.Class fieldType,
                TypeConvertor convertorTo,
                TypeConvertor convertorFrom,
                boolean required,
                java.lang.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(java.lang.Class fieldType,
                TypeConvertor convertorTo,
                TypeConvertor convertorFrom,
                java.lang.String convertorParam,
                boolean required,
                java.lang.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(java.lang.Class fieldType,
                TypeConvertor convertorTo,
                TypeConvertor convertorFrom,
                java.lang.String convertorParam,
                boolean required,
                java.lang.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
Method Detail

getFieldType

public java.lang.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

getConvertorParam

public java.lang.String getConvertorParam()
Returns the convertor parameter.

Returns:
Convertor parameter

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 java.lang.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.

setImmutable

void setImmutable(boolean immutable)
Sets whether or not the type is immutable

Parameters:
immutable - a boolean that when true indicates the type is immutable


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