Class FieldHandlerFriend<T>

java.lang.Object

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

All Implemented Interfaces:

FieldHandler<T>

Direct Known Subclasses:

ExtendedFieldHandler

public abstract class FieldHandlerFriend<T>
extends Object
implements FieldHandler<T>

An extended version of the FieldHandler interface which is used for adding additional functionality while preserving backward compatability.

Version:

$Revision: 9062 $ $Date: 2005-08-03 15:11:51 -0600 (Wed, 03 Aug 2005) $

Author:

Keith Visco

See Also:

• FieldDescriptor
• FieldHandler

Constructor Summary

Constructors

Constructor	Description
FieldHandlerFriend()

Method Summary

Modifier and Type	Method	Description
abstract void	checkValidity(Object object)	Deprecated. No longer supported
protected abstract FieldDescriptor	getFieldDescriptor()	Returns the FieldDescriptor for the field that this handler is responsible for, or null if no FieldDescriptor has been set.
abstract void	setFieldDescriptor(FieldDescriptor fieldDesc)	Sets the FieldDescriptor that this FieldHander is responsibile for.

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

getValue, newInstance, resetValue, setValue

Constructor Details

FieldHandlerFriend

public FieldHandlerFriend()

Method Details

getFieldDescriptor

protected abstract FieldDescriptor getFieldDescriptor()

Returns the FieldDescriptor for the field that this handler is responsible 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.

Returns:

the FieldDescriptor, or null if none exists.

setFieldDescriptor

public abstract void setFieldDescriptor(FieldDescriptor fieldDesc)

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

checkValidity

public abstract void checkValidity(Object object)
                            throws ValidityException,
IllegalStateException

Deprecated.

No longer supported

Specified by:

checkValidity in interface FieldHandler<T>

Throws:

ValidityException

IllegalStateException