org.exolab.castor.mapping
public abstract class GeneralizedFieldHandler extends AbstractFieldHandler
Version: $Revision: 1.3 $ $Date: 2005/01/19 00:29:45 $
See Also: FieldDescriptor FieldHandler
Nested Class Summary | |
---|---|
static class | GeneralizedFieldHandler.GFHConverterEnumeration |
Constructor Summary | |
---|---|
protected | GeneralizedFieldHandler()
Creates a new default GeneralizedFieldHandler. |
Method Summary | |
---|---|
abstract Object | convertUponGet(Object value)
This method is used to convert the value when the getValue method
is called. |
abstract Object | convertUponSet(Object value)
This method is used to convert the value when the setValue method
is called. |
abstract Class | getFieldType()
Returns the class type for the field that this GeneralizedFieldHandler
converts to and from. |
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.
|
void | setCollectionIteration(boolean autoCollectionIteration)
Sets whether or not this GeneralizedFieldHandler should automatically
iterate over the collection returned by the target object and pass
only the items (one by one) to the convertUponGet method.
|
void | setFieldHandler(FieldHandler handler)
Sets the FieldHandler that this FieldHander delegates to.
|
void | setValue(Object object, Object value)
Sets the value of the field on the object.
|
Parameters: value the object value to convert after performing a get operation
Returns: the converted value.
Parameters: value the object value to convert before performing a set operation
Returns: the converted value.
Returns: the class type of of the field
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 compatiable with the Java object
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
Parameters: parent The object for which the field is created args the set of constructor arguments
Returns: A new instance of the field's value
Throws: IllegalStateException This field is a simple type and cannot be instantiated
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 compatiable with the Java object
Parameters: autoCollectionIteration a boolean that when true indicates that this GeneralizedFieldHandler should automatically iterate over a collection and pass only collection items to the convertUponGet method.
Parameters: handler the FieldHandler to delegate to
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 compatiable with the Java object
UNKNOWN: IllegalArgumentException The value passed is not of a supported type