Public Member Functions

org.exolab.castor.mapping.FieldHandler Interface Reference

Inheritance diagram for org.exolab.castor.mapping.FieldHandler:
org.exolab.castor.mapping.loader.ExtendedFieldHandler org.exolab.castor.mapping.loader.FieldHandlerFriend org.exolab.castor.xml.handlers.ContainerFieldHandler org.exolab.castor.xml.handlers.EnumFieldHandler org.exolab.castor.mapping.ExtendedFieldHandler org.exolab.castor.mapping.AbstractFieldHandler org.exolab.castor.mapping.GeneralizedFieldHandler org.exolab.castor.mapping.handlers.TransientFieldHandler org.exolab.castor.mapping.loader.FieldHandlerImpl org.exolab.castor.xml.XMLFieldHandler org.exolab.castor.mapping.handlers.EnumFieldHandler org.exolab.castor.xml.handlers.SQLTimeFieldHandler org.exolab.castor.xml.handlers.SQLTimestampFieldHandler org.exolab.castor.xml.handlers.ValueOfFieldHandler org.exolab.castor.types.CenturyDescriptor.CenturyFieldHandler org.exolab.castor.types.DateDescriptor.DateFieldHandler org.exolab.castor.types.DurationDescriptor.DurationFieldHandler org.exolab.castor.types.GDayDescriptor.GDayFieldHandler org.exolab.castor.types.GMonthDayDescriptor.GMonthDayFieldHandler org.exolab.castor.types.GMonthDescriptor.GMonthFieldHandler org.exolab.castor.types.GYearDescriptor.GYearFieldHandler org.exolab.castor.types.GYearMonthDescriptor.GYearMonthFieldHandler org.exolab.castor.types.MonthDescriptor.MonthFieldHandler org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler org.exolab.castor.types.TimeDescriptor.TimeFieldHandler org.exolab.castor.types.TimeDurationDescriptor.TimeDurationFieldHandler org.exolab.castor.types.TimePeriodDescriptor.TimePeriodFieldHandler org.exolab.castor.types.YearDescriptor.YearFieldHandler org.exolab.castor.xml.handlers.CollectionFieldHandler org.exolab.castor.xml.handlers.DateFieldHandler

List of all members.

Public Member Functions

Object getValue (Object object) throws IllegalStateException
void setValue (Object object, Object value) throws IllegalStateException, IllegalArgumentException
void resetValue (Object object) throws IllegalStateException, IllegalArgumentException
void checkValidity (Object object) throws ValidityException, IllegalStateException
Object newInstance (Object parent) throws IllegalStateException

Detailed Description

A field handler knows how to perform various operations on the field that require access to the field value.

Author:
Assaf Arkin
Version:
Revision:
1.1.1.1
Date:
2003/03/03 07:08:26
See also:
FieldDescriptor

Member Function Documentation

void org.exolab.castor.mapping.FieldHandler.checkValidity ( Object  object  )  throws ValidityException, IllegalStateException
Deprecated:
No longer supported

Implemented in org.exolab.castor.mapping.ExtendedFieldHandler, org.exolab.castor.mapping.loader.ExtendedFieldHandler, org.exolab.castor.mapping.loader.FieldHandlerFriend, org.exolab.castor.types.CenturyDescriptor.CenturyFieldHandler, org.exolab.castor.types.DateDescriptor.DateFieldHandler, org.exolab.castor.types.DurationDescriptor.DurationFieldHandler, org.exolab.castor.types.GDayDescriptor.GDayFieldHandler, org.exolab.castor.types.GMonthDayDescriptor.GMonthDayFieldHandler, org.exolab.castor.types.GMonthDescriptor.GMonthFieldHandler, org.exolab.castor.types.GYearDescriptor.GYearFieldHandler, org.exolab.castor.types.GYearMonthDescriptor.GYearMonthFieldHandler, org.exolab.castor.types.MonthDescriptor.MonthFieldHandler, org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler, org.exolab.castor.types.TimeDescriptor.TimeFieldHandler, org.exolab.castor.types.TimeDurationDescriptor.TimeDurationFieldHandler, org.exolab.castor.types.TimePeriodDescriptor.TimePeriodFieldHandler, org.exolab.castor.types.YearDescriptor.YearFieldHandler, org.exolab.castor.xml.handlers.CollectionFieldHandler, org.exolab.castor.xml.handlers.ContainerFieldHandler, and org.exolab.castor.xml.handlers.EnumFieldHandler.

Object org.exolab.castor.mapping.FieldHandler.getValue ( Object  object  )  throws IllegalStateException

Returns the value of the field from the object.

Parameters:
object The object
Returns:
The value of the field
Exceptions:
IllegalStateException The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object

Implemented in org.exolab.castor.mapping.AbstractFieldHandler, org.exolab.castor.mapping.ExtendedFieldHandler, org.exolab.castor.mapping.GeneralizedFieldHandler, org.exolab.castor.mapping.handlers.TransientFieldHandler, org.exolab.castor.mapping.loader.ExtendedFieldHandler, org.exolab.castor.mapping.loader.FieldHandlerFriend, org.exolab.castor.mapping.loader.FieldHandlerImpl, org.exolab.castor.types.CenturyDescriptor.CenturyFieldHandler, org.exolab.castor.types.DateDescriptor.DateFieldHandler, org.exolab.castor.types.DurationDescriptor.DurationFieldHandler, org.exolab.castor.types.GDayDescriptor.GDayFieldHandler, org.exolab.castor.types.GMonthDayDescriptor.GMonthDayFieldHandler, org.exolab.castor.types.GMonthDescriptor.GMonthFieldHandler, org.exolab.castor.types.GYearDescriptor.GYearFieldHandler, org.exolab.castor.types.GYearMonthDescriptor.GYearMonthFieldHandler, org.exolab.castor.types.MonthDescriptor.MonthFieldHandler, org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler, org.exolab.castor.types.TimeDescriptor.TimeFieldHandler, org.exolab.castor.types.TimeDurationDescriptor.TimeDurationFieldHandler, org.exolab.castor.types.TimePeriodDescriptor.TimePeriodFieldHandler, org.exolab.castor.types.YearDescriptor.YearFieldHandler, org.exolab.castor.xml.handlers.CollectionFieldHandler, org.exolab.castor.xml.handlers.ContainerFieldHandler, org.exolab.castor.xml.handlers.DateFieldHandler, org.exolab.castor.xml.handlers.EnumFieldHandler, and org.exolab.castor.xml.XMLFieldHandler.

Referenced by org.exolab.castor.xml.util.XMLClassDescriptorImpl.canAccept(), org.exolab.castor.xml.UnmarshalHandler.endElement(), org.exolab.castor.mapping.GeneralizedFieldHandler.getValue(), org.exolab.castor.mapping.loader.FieldHandlerImpl.getValue(), org.exolab.castor.xml.handlers.EnumFieldHandler.getValue(), org.exolab.castor.xml.handlers.DateFieldHandler.getValue(), org.exolab.castor.xml.handlers.ContainerFieldHandler.getValue(), org.exolab.castor.xml.handlers.CollectionFieldHandler.getValue(), org.exolab.castor.mapping.loader.FieldHandlerImpl.setValue(), org.exolab.castor.xml.util.XMLClassDescriptorImpl.validate(), and org.exolab.castor.xml.FieldValidator.validate().

Object org.exolab.castor.mapping.FieldHandler.newInstance ( Object  parent  )  throws IllegalStateException

Creates a new instance of the object described by this field.

Parameters:
parent The object for which the field is created
Returns:
A new instance of the field's value
Exceptions:
IllegalStateException This field is a simple type and cannot be instantiated

Implemented in org.exolab.castor.mapping.AbstractFieldHandler, org.exolab.castor.mapping.ExtendedFieldHandler, org.exolab.castor.mapping.GeneralizedFieldHandler, org.exolab.castor.mapping.handlers.EnumFieldHandler, org.exolab.castor.mapping.handlers.TransientFieldHandler, org.exolab.castor.mapping.loader.ExtendedFieldHandler, org.exolab.castor.mapping.loader.FieldHandlerFriend, org.exolab.castor.mapping.loader.FieldHandlerImpl, org.exolab.castor.types.CenturyDescriptor.CenturyFieldHandler, org.exolab.castor.types.DateDescriptor.DateFieldHandler, org.exolab.castor.types.DurationDescriptor.DurationFieldHandler, org.exolab.castor.types.GDayDescriptor.GDayFieldHandler, org.exolab.castor.types.GMonthDayDescriptor.GMonthDayFieldHandler, org.exolab.castor.types.GMonthDescriptor.GMonthFieldHandler, org.exolab.castor.types.GYearDescriptor.GYearFieldHandler, org.exolab.castor.types.GYearMonthDescriptor.GYearMonthFieldHandler, org.exolab.castor.types.MonthDescriptor.MonthFieldHandler, org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler, org.exolab.castor.types.TimeDescriptor.TimeFieldHandler, org.exolab.castor.types.TimeDurationDescriptor.TimeDurationFieldHandler, org.exolab.castor.types.TimePeriodDescriptor.TimePeriodFieldHandler, org.exolab.castor.types.YearDescriptor.YearFieldHandler, org.exolab.castor.xml.handlers.CollectionFieldHandler, org.exolab.castor.xml.handlers.ContainerFieldHandler, org.exolab.castor.xml.handlers.DateFieldHandler, org.exolab.castor.xml.handlers.EnumFieldHandler, org.exolab.castor.xml.handlers.SQLTimeFieldHandler, org.exolab.castor.xml.handlers.SQLTimestampFieldHandler, org.exolab.castor.xml.handlers.ValueOfFieldHandler, and org.exolab.castor.xml.XMLFieldHandler.

Referenced by org.exolab.castor.mapping.loader.MappingLoader.createFieldDesc(), org.exolab.castor.mapping.GeneralizedFieldHandler.newInstance(), org.exolab.castor.mapping.loader.FieldHandlerImpl.newInstance(), org.exolab.castor.xml.handlers.DateFieldHandler.newInstance(), and org.exolab.castor.xml.handlers.ContainerFieldHandler.newInstance().

void org.exolab.castor.mapping.FieldHandler.resetValue ( Object  object  )  throws IllegalStateException, IllegalArgumentException

Sets the value of the field to a default value.

Reference fields are set to null, primitive fields are set to their default value, collection fields are emptied of all elements.

Parameters:
object The object
Exceptions:
IllegalStateException The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object

Implemented in org.exolab.castor.mapping.AbstractFieldHandler, org.exolab.castor.mapping.ExtendedFieldHandler, org.exolab.castor.mapping.GeneralizedFieldHandler, org.exolab.castor.mapping.handlers.TransientFieldHandler, org.exolab.castor.mapping.loader.ExtendedFieldHandler, org.exolab.castor.mapping.loader.FieldHandlerFriend, org.exolab.castor.mapping.loader.FieldHandlerImpl, org.exolab.castor.types.CenturyDescriptor.CenturyFieldHandler, org.exolab.castor.types.DateDescriptor.DateFieldHandler, org.exolab.castor.types.DurationDescriptor.DurationFieldHandler, org.exolab.castor.types.GDayDescriptor.GDayFieldHandler, org.exolab.castor.types.GMonthDayDescriptor.GMonthDayFieldHandler, org.exolab.castor.types.GMonthDescriptor.GMonthFieldHandler, org.exolab.castor.types.GYearDescriptor.GYearFieldHandler, org.exolab.castor.types.GYearMonthDescriptor.GYearMonthFieldHandler, org.exolab.castor.types.MonthDescriptor.MonthFieldHandler, org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler, org.exolab.castor.types.TimeDescriptor.TimeFieldHandler, org.exolab.castor.types.TimeDurationDescriptor.TimeDurationFieldHandler, org.exolab.castor.types.TimePeriodDescriptor.TimePeriodFieldHandler, org.exolab.castor.types.YearDescriptor.YearFieldHandler, org.exolab.castor.xml.handlers.CollectionFieldHandler, org.exolab.castor.xml.handlers.ContainerFieldHandler, org.exolab.castor.xml.handlers.DateFieldHandler, org.exolab.castor.xml.handlers.EnumFieldHandler, and org.exolab.castor.xml.XMLFieldHandler.

Referenced by org.exolab.castor.xml.UnmarshalHandler.endElement(), org.exolab.castor.mapping.GeneralizedFieldHandler.resetValue(), org.exolab.castor.mapping.loader.FieldHandlerImpl.resetValue(), org.exolab.castor.xml.handlers.DateFieldHandler.resetValue(), org.exolab.castor.xml.handlers.ContainerFieldHandler.resetValue(), and org.exolab.castor.xml.handlers.CollectionFieldHandler.resetValue().

void org.exolab.castor.mapping.FieldHandler.setValue ( Object  object,
Object  value 
) throws IllegalStateException, IllegalArgumentException

Sets the value of the field on the object.

Parameters:
object The object
value The new value
Exceptions:
IllegalStateException The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object IllegalArgumentException The value passed is not of a supported type

Implemented in org.exolab.castor.mapping.AbstractFieldHandler, org.exolab.castor.mapping.ExtendedFieldHandler, org.exolab.castor.mapping.GeneralizedFieldHandler, org.exolab.castor.mapping.handlers.TransientFieldHandler, org.exolab.castor.mapping.loader.ExtendedFieldHandler, org.exolab.castor.mapping.loader.FieldHandlerFriend, org.exolab.castor.mapping.loader.FieldHandlerImpl, org.exolab.castor.types.CenturyDescriptor.CenturyFieldHandler, org.exolab.castor.types.DateDescriptor.DateFieldHandler, org.exolab.castor.types.DurationDescriptor.DurationFieldHandler, org.exolab.castor.types.GDayDescriptor.GDayFieldHandler, org.exolab.castor.types.GMonthDayDescriptor.GMonthDayFieldHandler, org.exolab.castor.types.GMonthDescriptor.GMonthFieldHandler, org.exolab.castor.types.GYearDescriptor.GYearFieldHandler, org.exolab.castor.types.GYearMonthDescriptor.GYearMonthFieldHandler, org.exolab.castor.types.MonthDescriptor.MonthFieldHandler, org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler, org.exolab.castor.types.TimeDescriptor.TimeFieldHandler, org.exolab.castor.types.TimeDurationDescriptor.TimeDurationFieldHandler, org.exolab.castor.types.TimePeriodDescriptor.TimePeriodFieldHandler, org.exolab.castor.types.YearDescriptor.YearFieldHandler, org.exolab.castor.xml.handlers.CollectionFieldHandler, org.exolab.castor.xml.handlers.ContainerFieldHandler, org.exolab.castor.xml.handlers.DateFieldHandler, org.exolab.castor.xml.handlers.EnumFieldHandler, and org.exolab.castor.xml.XMLFieldHandler.

Referenced by org.exolab.castor.xml.UnmarshalHandler.endElement(), org.exolab.castor.mapping.GeneralizedFieldHandler.setValue(), org.exolab.castor.mapping.loader.FieldHandlerImpl.setValue(), org.exolab.castor.xml.handlers.EnumFieldHandler.setValue(), org.exolab.castor.xml.handlers.DateFieldHandler.setValue(), org.exolab.castor.xml.handlers.ContainerFieldHandler.setValue(), and org.exolab.castor.xml.handlers.CollectionFieldHandler.setValue().

The documentation for this interface was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties
Generated on Thu Jan 12 2012 23:15:44 for ACS-10.0 Java API by  doxygen 1.7.0