org.exolab.castor.xml

Class XMLFieldHandler

public class XMLFieldHandler extends 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
voidcheckValidity(Object object)
Checks the field validity.
booleanequals(Object obj)
Returns true if the given object is an XMLFieldHandler that is equivalent to this one.
ObjectgetValue(Object object)
Returns the value of the field from the object.
ObjectnewInstance(Object parent)
Creates a new instance of the object described by this field.
voidresetValue(Object object)
voidsetValue(Object object, Object value)
Sets the value of the field on the object.

Constructor Detail

XMLFieldHandler

public XMLFieldHandler()
Creates a new default XMLFieldHandler

Method Detail

checkValidity

public void checkValidity(Object object)
Checks the field validity. Returns successfully if the field can be stored, is valid, etc, throws an exception otherwise.

Parameters: object The object

Throws: ValidityException The field is invalid, is required and null, or any other validity violation IllegalStateException The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object

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)
Returns the value of the field from the object.

Parameters: object The object

Returns: The value of the field

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

newInstance

public Object newInstance(Object parent)
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

Throws: IllegalStateException This field is a simple type and cannot be instantiated

resetValue

public void resetValue(Object object)

setValue

public void setValue(Object object, Object value)
Sets the value of the field on the object.

Parameters: object The object value The new value

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

UNKNOWN: IllegalArgumentException The value passed is not of a supported type

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