org.exolab.castor.mapping
Class ExtendedFieldHandler
- FieldHandler
public abstract class ExtendedFieldHandler
An extended version of the FieldHandler interface which is
used for adding additional functionality while preserving
backward compatability.
Version:
- Keith Visco
FieldDescriptor
, FieldHandler
void | checkValidity(Object object) - No longer supported
|
protected FieldDescriptor | getFieldDescriptor() - Returns the FieldDescriptor for the field that this
handler is reponsibile for, or null if no FieldDescriptor
has been set.
|
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.
|
Object | newInstance(Object parent, Object[] args) - 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.
|
protected void | setFieldDescriptor(FieldDescriptor fieldDesc) - Sets the FieldDescriptor that this FieldHander is
responsibile for.
|
void | setValue(Object object, Object value) - Sets the value of the field on the object.
|
getFieldDescriptor
protected 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.
- getFieldDescriptor in interface FieldHandlerFriend
- the FieldDescriptor, or null if none exists.
getValue
public Object getValue(Object object)
throws IllegalStateException
Returns the value of the field from the object.
- getValue in interface FieldHandler
- getValue in interface FieldHandlerFriend
object
- The object
- The value of the field
newInstance
public Object newInstance(Object parent)
throws IllegalStateException
Creates a new instance of the object described by this field.
- newInstance in interface FieldHandler
- newInstance in interface FieldHandlerFriend
parent
- The object for which the field is created
- A new instance of the field's value
newInstance
public Object newInstance(Object parent,
Object[] args)
throws IllegalStateException
Creates a new instance of the object described by this field.
parent
- The object for which the field is createdargs
- the set of constructor arguments
- A new instance of the field's value
resetValue
public 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
- resetValue in interface FieldHandlerFriend
object
- The object
setFieldDescriptor
protected 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.
- setFieldDescriptor in interface FieldHandlerFriend
fieldDesc
- the FieldDescriptor to set
setValue
public void setValue(Object object,
Object value)
throws IllegalStateException,
IllegalArgumentException
Sets the value of the field on the object.
- setValue in interface FieldHandler
- setValue in interface FieldHandlerFriend
object
- The objectvalue
- The new value
Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com