org.exolab.castor.mapping.loader
Class FieldHandlerFriend
java.lang.Object
org.exolab.castor.mapping.loader.FieldHandlerFriend
- FieldHandler
public abstract class FieldHandlerFriend
extends java.lang.Object
An extended version of the FieldHandler interface which is
used for adding additional functionality while preserving
backward compatability.
$Revision: 1.1 $ $Date: 2003/04/16 06:29:08 $abstract void | checkValidity(Object object) - No longer supported
|
protected abstract FieldDescriptor | getFieldDescriptor() - Returns the FieldDescriptor for the field that this
handler is reponsibile for, or null if no FieldDescriptor
has been set.
|
abstract Object | getValue(Object object) - Returns the value of the field from the object.
|
abstract Object | newInstance(Object parent) - Creates a new instance of the object described by this field.
|
abstract void | resetValue(Object object) - Sets the value of the field to a default value.
|
protected abstract void | setFieldDescriptor(FieldDescriptor fieldDesc) - Sets the FieldDescriptor that this FieldHander is
responsibile for.
|
abstract void | setValue(Object object, Object value) - Sets the value of the field on the object.
|
getFieldDescriptor
protected abstract FieldDescriptor getFieldDescriptor()
Returns the FieldDescriptor for the field that this
handler is reponsibile for, or null if no FieldDescriptor
has been set. This method is useful for implementations
of the FieldHandler interface that wish to obtain information
about the field in order to make the FieldHandler more generic
and reusable, or simply for validation purposes.
- the FieldDescriptor, or null if none exists.
getValue
public abstract Object getValue(Object object)
throws IllegalStateException
Returns the value of the field from the object.
- getValue in interface FieldHandler
newInstance
public abstract Object newInstance(Object parent)
throws IllegalStateException
Creates a new instance of the object described by this field.
- newInstance in interface FieldHandler
parent
- The object for which the field is created
- A new instance of the field's value
resetValue
public abstract 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.
- resetValue in interface FieldHandler
setFieldDescriptor
protected abstract void setFieldDescriptor(FieldDescriptor fieldDesc)
Sets the FieldDescriptor that this FieldHander is
responsibile for. By setting the FieldDescriptor, it
allows the implementation of the FieldHandler methods
to obtain information about the field itself. This allows
a particular implementation to become more generic and
reusable.
fieldDesc
- the FieldDescriptor to set
setValue
public abstract void setValue(Object object,
Object value)
throws IllegalStateException,
IllegalArgumentException
Sets the value of the field on the object.
- setValue in interface FieldHandler
object
- The objectvalue
- The new value
Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com