org.exolab.castor.mapping
Class ExtendedFieldHandler

java.lang.Object
  org.exolab.castor.mapping.loader.FieldHandlerFriend
      org.exolab.castor.mapping.ExtendedFieldHandler

All Implemented Interfaces:

FieldHandler

Direct Known Subclasses:

AbstractFieldHandler

public abstract class ExtendedFieldHandler

extends org.exolab.castor.mapping.loader.FieldHandlerFriend

An extended version of the FieldHandler interface which is used for adding additional functionality while preserving backward compatability.

Version:

$Revision: 1.3 $ $Date: 2003/09/23 21:19:16 $

Author:

Keith Visco

See Also:

FieldDescriptor, FieldHandler

Constructor Summary

ExtendedFieldHandler()

Method Summary

void	checkValidity(java.lang.Object object) Deprecated. No longer supported
abstract java.lang.Object	getValue(java.lang.Object object) Returns the value of the field from the object.
abstract java.lang.Object	newInstance(java.lang.Object parent) Creates a new instance of the object described by this field.
abstract java.lang.Object	newInstance(java.lang.Object parent, java.lang.Object[] args) Creates a new instance of the object described by this field.
abstract void	resetValue(java.lang.Object object) Sets the value of the field to a default value.
abstract void	setValue(java.lang.Object object, java.lang.Object value) Sets the value of the field on the object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtendedFieldHandler

public ExtendedFieldHandler()

Method Detail

checkValidity

public void checkValidity(java.lang.Object object)
                   throws ValidityException,
                          java.lang.IllegalStateException

Deprecated. No longer supported

Throws:

ValidityException

java.lang.IllegalStateException

getValue

public abstract java.lang.Object getValue(java.lang.Object object)
                                   throws java.lang.IllegalStateException

Returns the value of the field from the object.

Parameters:

object - The object

Returns:

The value of the field

Throws:

java.lang.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 abstract java.lang.Object newInstance(java.lang.Object parent)
                                      throws java.lang.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

Throws:

java.lang.IllegalStateException - This field is a simple type and cannot be instantiated

newInstance

public abstract java.lang.Object newInstance(java.lang.Object parent,
                                             java.lang.Object[] args)
                                      throws java.lang.IllegalStateException

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

Throws:

java.lang.IllegalStateException - This field is a simple type and cannot be instantiated

resetValue

public abstract void resetValue(java.lang.Object object)
                         throws java.lang.IllegalStateException,
                                java.lang.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

Throws:

java.lang.IllegalStateException - The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object

java.lang.IllegalArgumentException

setValue

public abstract void setValue(java.lang.Object object,
                              java.lang.Object value)
                       throws java.lang.IllegalStateException,
                              java.lang.IllegalArgumentException

Sets the value of the field on the object.

Parameters:

object - The object

value - The new value

Throws:

java.lang.IllegalStateException - The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object

java.lang.IllegalArgumentException