| org.exolab.castor.mapping.ExtendedFieldHandler
 org.exolab.castor.mapping.AbstractFieldHandler
All known Subclasses: org.exolab.castor.mapping.loader.FieldHandlerImpl, org.exolab.castor.xml.XMLFieldHandler, org.exolab.castor.mapping.handlers.TransientFieldHandler, org.exolab.castor.mapping.GeneralizedFieldHandler,
| AbstractFieldHandler | | abstract public class AbstractFieldHandler extends ExtendedFieldHandler (Code) | | An extended version of the FieldHandler interface which is
used for adding additional functionality while preserving
backward compatability.
author:
Keith Visco
version:
$Revision: 6216 $ $Date: 2005-08-03 15:11:51 -0600 (Wed, 03 Aug 2005) $
See Also: FieldDescriptor
See Also: FieldHandler |
| Method Summary | |
| final protected FieldDescriptor | getFieldDescriptor()
Returns the FieldDescriptor for the field that this
handler is reponsibile for, or null if no FieldDescriptor
has been set. | | abstract public Object | getValue(Object object)
Returns the value of the field from the object. | | public boolean | hasValue(Object object)
Returns true if the "handled" field has a value within the
given object.
By default this just checks for null. | | abstract public Object | newInstance(Object parent)
Creates a new instance of the object described by this field. | | abstract public Object | newInstance(Object parent, Object[] args)
Creates a new instance of the object described by this field. | | abstract public void | resetValue(Object object)
Sets the value of the field to a default value. | | final public void | setFieldDescriptor(FieldDescriptor fieldDesc)
Sets the FieldDescriptor that this FieldHander is
responsibile for. | | abstract public void | setValue(Object object, Object value)
Sets the value of the field on the object. |
| AbstractFieldHandler | | protected AbstractFieldHandler()(Code) | | Creates a new default AbstractFieldHandler. This method
should be called by all extending classes so that any
important initialization code will be executed.
|
| getFieldDescriptor | | final protected FieldDescriptor getFieldDescriptor()(Code) | | 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 | | abstract public Object getValue(Object object) throws IllegalStateException(Code) | | Returns the value of the field from the object.
Parameters:
object - The object The value of the field
throws:
IllegalStateException - The Java object has changed andis no longer supported by this handler, or the handler is notcompatiable with the Java object |
| hasValue | | public boolean hasValue(Object object)(Code) | | Returns true if the "handled" field has a value within the
given object.
By default this just checks for null. Normally this method
is needed for checking if a value has been set via a call
to the setValue method, or if the primitive value has
been initialized by the JVM.
This method should be overloaded for improved value
checking.
true if the given object has a value for the handled field |
| newInstance | | abstract public Object newInstance(Object parent) throws IllegalStateException(Code) | | Creates a new instance of the object described by this field.
Parameters:
parent - The object for which the field is created A new instance of the field's value
throws:
IllegalStateException - This field is a simple type andcannot be instantiated |
| newInstance | | abstract public Object newInstance(Object parent, Object[] args) throws IllegalStateException(Code) | | Creates a new instance of the object described by this field.
Parameters:
parent - The object for which the field is created
Parameters:
args - the set of constructor arguments A new instance of the field's value
throws:
IllegalStateException - This field is a simple type andcannot be instantiated |
| resetValue | | abstract public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException(Code) | | 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 andis no longer supported by this handler, or the handler is notcompatiable with the Java object |
| setFieldDescriptor | | final public void setFieldDescriptor(FieldDescriptor fieldDesc)(Code) | | 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.
Parameters:
fieldDesc - the FieldDescriptor to set |
|
|