org.exolab.castor.mapping

Interface FieldHandler

All Known Subinterfaces:

ClonableFieldHandler, ConfigurableFieldHandler

All Known Implementing Classes:

AbstractFieldHandler, CollectionFieldHandler, ContainerFieldHandler, DateFieldHandler, EnumFieldHandler, EnumFieldHandler, ExtendedFieldHandler, ExtendedFieldHandler, FieldHandlerFriend, FieldHandlerImpl, GeneralizedFieldHandler, SQLTimeFieldHandler, SQLTimestampFieldHandler, ToStringFieldHandler, TransientFieldHandler, ValueOfFieldHandler, XMLFieldHandler

public interface FieldHandler

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

Version:

$Revision: 6671 $ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $

Author:

Assaf Arkin

See Also:

FieldDescriptor

Method Summary

Methods

Modifier and Type	Method and Description
void	checkValidity(Object object) Deprecated. No longer supported
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) Sets the value of the field to a default value.
void	setValue(Object object, Object value) Sets the value of the field on the object.

Method Detail

getValue

Object getValue(Object object)
                throws IllegalStateException

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 compatible with the Java object

setValue

void 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.

Throws:

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

IllegalArgumentException - The value passed is not of a supported type.

resetValue

void 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.

Throws:

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

IllegalArgumentException

checkValidity

void checkValidity(Object object)
                   throws ValidityException,
                          IllegalStateException

Deprecated. No longer supported

Throws:

ValidityException

IllegalStateException

newInstance

Object 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

Throws:

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