no.g9.support.castor

Class DateTimeFieldHandler

java.lang.Object

org.exolab.castor.mapping.loader.FieldHandlerFriend<T>

org.exolab.castor.mapping.ExtendedFieldHandler<T>

org.exolab.castor.mapping.AbstractFieldHandler

org.exolab.castor.mapping.GeneralizedFieldHandler

no.g9.support.castor.DateTimeFieldHandler

All Implemented Interfaces:

org.exolab.castor.mapping.ConfigurableFieldHandler, org.exolab.castor.mapping.FieldHandler

public class DateTimeFieldHandler
extends org.exolab.castor.mapping.GeneralizedFieldHandler

Castor field handler used to convert to/from XML fields of type xs:dateTime for the Joda time DateTime.

WARNING: Although this class is public, it should not be treated as part of the public API, as it might change in incompatible ways between releases (even patches).

NOTE: This class is referenced from Castor mapping files, so refactor with caution!

Field Summary

Fields inherited from class org.exolab.castor.mapping.AbstractFieldHandler

_properties

Constructor Summary

Constructors

Constructor and Description
DateTimeFieldHandler() Creates a new DateTimeFieldHandler instance

Method Summary

Modifier and Type	Method and 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<org.joda.time.DateTime>	getFieldType() Returns the class type for the field that this GeneralizedFieldHandler converts to and from.
Object	newInstance(Object parent) Creates a new instance of the object described by this field.

Methods inherited from class org.exolab.castor.mapping.GeneralizedFieldHandler

getValue, newInstance, resetValue, setCollectionIteration, setFieldHandler, setValue

Methods inherited from class org.exolab.castor.mapping.AbstractFieldHandler

getFieldDescriptor, hasValue, setConfiguration, setFieldDescriptor

Methods inherited from class org.exolab.castor.mapping.ExtendedFieldHandler

checkValidity

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.exolab.castor.mapping.FieldHandler

checkValidity

Constructor Detail

DateTimeFieldHandler

public DateTimeFieldHandler()

Creates a new DateTimeFieldHandler instance

Method Detail

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 org.exolab.castor.mapping.GeneralizedFieldHandler

Parameters:

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

Returns:

the converted value.

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 org.exolab.castor.mapping.GeneralizedFieldHandler

Parameters:

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

Returns:

the converted value.

getFieldType

public Class<org.joda.time.DateTime> 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 org.exolab.castor.mapping.GeneralizedFieldHandler

Returns:

the class type of of the field

newInstance

public Object newInstance(Object parent)
                   throws IllegalStateException

Creates a new instance of the object described by this field.

Specified by:

newInstance in interface org.exolab.castor.mapping.FieldHandler

Overrides:

newInstance in class org.exolab.castor.mapping.GeneralizedFieldHandler

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