Class ToStringFieldHandler

java.lang.Object

org.exolab.castor.mapping.loader.FieldHandlerFriend

org.exolab.castor.mapping.ExtendedFieldHandler

org.exolab.castor.mapping.AbstractFieldHandler

org.exolab.castor.mapping.GeneralizedFieldHandler

org.exolab.castor.xml.handlers.ToStringFieldHandler

All Implemented Interfaces:

ConfigurableFieldHandler, FieldHandler

public class ToStringFieldHandler
extends GeneralizedFieldHandler

An implementation of GeneralizedFieldHandler that simply calls Object#toString() in the conversion methods.

Version:

$Revision: 6671 $ $Date: 2005-02-28 17:53:23 -0700 (Mon, 28 Feb 2005) $

Author:

Keith Visco

Field Summary

Fields inherited from class AbstractFieldHandler

_properties

Modifier and Type	Field	Description
protected Properties	_properties	Configuration that can be used by subclasses when needed.

Constructor Summary

Constructors

Constructor	Description
ToStringFieldHandler(Class type)	Creates a new ToStringFieldHandler.
ToStringFieldHandler(Class type, FieldHandler handler)	Creates a new ToStringFieldHandler.

Method Summary

Modifier and Type	Method	Description
Object	convertUponGet(Object value)	This method is used to convert the value when the getValue method is called.
Object	convertUponSet(Object value)	This method is used to convert the value when the setValue method is called.
Class	getFieldType()	Returns the class type for the field that this GeneralizedFieldHandler converts to and from.

Methods inherited from class GeneralizedFieldHandler

getValue, newInstance, newInstance, resetValue, setCollectionIteration, setFieldHandler, setValue

Modifier and Type	Method	Description
final 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.
final 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.
final void	setFieldHandler(FieldHandler handler)	Sets the FieldHandler that this FieldHander delegates to.
final void	setValue(Object object, Object value)	Sets the value of the field on the object.

Methods inherited from class AbstractFieldHandler

getFieldDescriptor, hasValue, setConfiguration, setFieldDescriptor

Modifier and Type	Method	Description
protected final FieldDescriptor	getFieldDescriptor()	Returns the FieldDescriptor for the field that this handler is responsible for, or null if no FieldDescriptor has been set.
boolean	hasValue(Object object)	Returns true if the "handled" field has a value within the given object.
void	setConfiguration(Properties config)	Empty implementation of the ConfigurableFieldHandler interface, for convenience purpose.
void	setFieldDescriptor(FieldDescriptor fieldDesc)	Sets the FieldDescriptor that this FieldHander is responsibile for.

Methods inherited from class ExtendedFieldHandler

checkValidity

Modifier and Type	Method	Description
void	checkValidity(Object object)	Deprecated. No longer supported

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ToStringFieldHandler

public ToStringFieldHandler(Class type)

Creates a new ToStringFieldHandler.

Parameters:

type - the class type to create the FieldHandler for

ToStringFieldHandler

public ToStringFieldHandler(Class type,
 FieldHandler handler)

Creates a new ToStringFieldHandler.

Parameters:

type - the class type to create the FieldHandler for

handler - the FieldHandler to wrap

Method Details

convertUponGet

public Object convertUponGet(Object value)

This method is used to convert the value when the getValue method is called. The getValue method will obtain the actual field value from given 'parent' object. This convert method is then invoked with the field's value. The value returned from this method will be the actual value returned by getValue method.

Specified by:

convertUponGet in class GeneralizedFieldHandler

Parameters:

value - the object value to convert after performing a get operation

Returns:

the converted value.

See Also:

• GeneralizedFieldHandler.convertUponGet(java.lang.Object)

convertUponSet

public Object convertUponSet(Object value)

This method is used to convert the value when the setValue method is called. The setValue method will call this method to obtain the converted value. The converted value will then be used as the value to set for the field.

Specified by:

convertUponSet in class GeneralizedFieldHandler

Parameters:

value - the object value to convert before performing a set operation

Returns:

the converted value.

See Also:

• GeneralizedFieldHandler.convertUponSet(java.lang.Object)

getFieldType

public Class getFieldType()

Returns the class type for the field that this GeneralizedFieldHandler converts to and from. This should be the type that is used in the object model.

Specified by:

getFieldType in class GeneralizedFieldHandler

Returns:

the class type of of the field

See Also:

• GeneralizedFieldHandler.getFieldType()