org.exolab.castor.xml

Class XMLFieldHandler

Implemented Interfaces:
FieldHandler
Known Direct Subclasses:
CenturyDescriptor.CenturyFieldHandler, CollectionFieldHandler, DateDescriptor.DateFieldHandler, DateFieldHandler, DurationDescriptor.DurationFieldHandler, GDayDescriptor.GDayFieldHandler, GMonthDayDescriptor.GMonthDayFieldHandler, GMonthDescriptor.GMonthFieldHandler, GYearDescriptor.GYearFieldHandler, GYearMonthDescriptor.GYearMonthFieldHandler, MonthDescriptor.MonthFieldHandler, RecurringDurationDescriptor.RecurringDurationFieldHandler, TimeDescriptor.TimeFieldHandler, TimeDurationDescriptor.TimeDurationFieldHandler, TimePeriodDescriptor.TimePeriodFieldHandler, YearDescriptor.YearFieldHandler

public class XMLFieldHandler
extends java.lang.Object
implements FieldHandler

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

Version:
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:09:16 $

Author:
Assaf Arkin

See Also:
FieldDescriptor

Constructor Summary

XMLFieldHandler()
Creates a new default XMLFieldHandler

Method Summary

void
checkValidity(Object object)
Checks the field validity.
boolean
equals(Object obj)
Returns true if the given object is an XMLFieldHandler that is equivalent to this one.
Object
getValue(Object object)
Returns the value of the field from the object.
Object
newInstance(Object parent)
Creates a new instance of the object described by this field.
void
resetValue(Object object)
void
setValue(Object object, Object value)
Sets the value of the field on the object.

Constructor Details

XMLFieldHandler

public XMLFieldHandler()
Creates a new default XMLFieldHandler

Method Details

checkValidity

public void checkValidity(Object object)
            throws ValidityException,
                   IllegalStateException
Checks the field validity. Returns successfully if the field can be stored, is valid, etc, throws an exception otherwise.
Specified by:
checkValidity in interface FieldHandler

Parameters:
object - The object

Throws:
ValidityException - The field is invalid, is required and null, or any other validity violation


equals

public boolean equals(Object obj)
Returns true if the given object is an XMLFieldHandler that is equivalent to this one. An equivalent XMLFieldHandler is an XMLFieldHandler that is an instances of the same class. This method can be overwritten to provide more advanced equivalence tests.

Returns:
true if the given object is an XMLFieldHandler that is equivalent to this one.


getValue

public Object getValue(Object object)
            throws IllegalStateException
Returns the value of the field from the object.
Specified by:
getValue in interface FieldHandler

Parameters:
object - The object

Returns:
The value of the field


newInstance

public Object newInstance(Object parent)
Creates a new instance of the object described by this field.
Specified by:
newInstance in interface FieldHandler

Parameters:
parent - The object for which the field is created

Returns:
A new instance of the field's value


resetValue

public void resetValue(Object object)
            throws IllegalStateException,
                   IllegalArgumentException
Specified by:
resetValue in interface FieldHandler


setValue

public void setValue(Object object,
                     Object value)
            throws IllegalStateException,
                   IllegalArgumentException
Sets the value of the field on the object.
Specified by:
setValue in interface FieldHandler

Parameters:
object - The object
value - The new value


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