| java.lang.Object
 org.exolab.castor.mapping.loader.FieldHandlerFriend
All known Subclasses: org.exolab.castor.mapping.ExtendedFieldHandler,
| FieldHandlerFriend | | abstract public class FieldHandlerFriend implements FieldHandler(Code) | | An extended version of the FieldHandler interface which is
used for adding additional functionality while preserving
backward compatability.
author:
Keith Visco
version:
$Revision: 6230 $ $Date: 2005-08-03 15:11:51 -0600 (Wed, 03 Aug 2005) $
See Also: FieldDescriptor
See Also: FieldHandler |
| getFieldDescriptor | | abstract 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 |
| 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 |
| 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 | | abstract 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 |
|
|