Inheritance diagram for org.exolab.castor.xml.XMLFieldHandler:

Public Member Functions
	XMLFieldHandler ()
boolean	equals (Object obj)
Object	getValue (Object object) throws IllegalStateException
Object	newInstance (Object parent) throws IllegalStateException
Object	newInstance (Object parent, Object[] args) throws IllegalStateException
void	setValue (Object object, Object value) throws IllegalStateException, IllegalArgumentException
void	resetValue (Object object) throws IllegalStateException, IllegalArgumentException

Detailed Description

This FieldHandler is used in the generated descriptors.

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

Author:: Assaf Arkin; Keith Visco

Version:

Revision:: 1.3

Date:: 2003/09/23 21:16:41

See also:: org.exolab.castor.mapping.FieldDescriptor

Constructor & Destructor Documentation

org.exolab.castor.xml.XMLFieldHandler.XMLFieldHandler ( )

Creates a new default XMLFieldHandler

Member Function Documentation

boolean org.exolab.castor.xml.XMLFieldHandler.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.

Reimplemented in org.exolab.castor.xml.handlers.CollectionFieldHandler, and org.exolab.castor.xml.handlers.DateFieldHandler.

Object org.exolab.castor.xml.XMLFieldHandler.getValue ( Object object ) throws IllegalStateException [virtual]

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

Implements org.exolab.castor.mapping.AbstractFieldHandler.

Object org.exolab.castor.xml.XMLFieldHandler.newInstance	(	Object	parent,
		Object[]	args
	)			throws IllegalStateException `[virtual]`

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

Parameters:

	parent	The object for which the field is created
	args	the set of constructor arguments

Returns:: A new instance of the field's value

Exceptions:

IllegalStateException

This field is a simple type and cannot be instantiated

Implements org.exolab.castor.mapping.AbstractFieldHandler.

References org.exolab.castor.xml.XMLFieldHandler.newInstance().

Object org.exolab.castor.xml.XMLFieldHandler.newInstance ( Object parent ) throws IllegalStateException [virtual]

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

Implements org.exolab.castor.mapping.AbstractFieldHandler.

Referenced by org.exolab.castor.xml.XMLFieldHandler.newInstance().

void org.exolab.castor.xml.XMLFieldHandler.resetValue ( Object object ) throws IllegalStateException, IllegalArgumentException [virtual]

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

Implements org.exolab.castor.mapping.AbstractFieldHandler.

void org.exolab.castor.xml.XMLFieldHandler.setValue	(	Object	object,
		Object	value
	)			throws IllegalStateException, IllegalArgumentException `[virtual]`

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

Implements org.exolab.castor.mapping.AbstractFieldHandler.

The documentation for this class was generated from the following file:

XMLFieldHandler.java

All Classes Namespaces Files Functions Variables Enumerations Properties

org.exolab.castor.xml.XMLFieldHandler Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation