org.exolab.castor.xml.handlers

Class ContainerFieldHandler

java.lang.Object

org.exolab.castor.xml.handlers.ContainerFieldHandler

All Implemented Interfaces:

FieldHandler

public final class ContainerFieldHandler
extends java.lang.Object
implements FieldHandler

The FieldHandler for ContainerElement

Version:

$Revision: 6231 $ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $

Author:

Keith Visco

See Also:

org.exolab.castor.mapping.FieldDescriptor, .org.exolab.castor.mapping.FieldHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_AUTO
static int	MODE_CHILD_LINK
static int	MODE_PARENT_LINK

Constructor Summary

Constructors

Constructor and Description
ContainerFieldHandler(FieldHandler handler) Creates a new ContainerFieldHandler with the given FieldHandler.

Method Summary

Modifier and Type	Method and Description
void	checkValidity(java.lang.Object object) Checks the field validity.
java.lang.Object	getValue(java.lang.Object object) Returns the value of the field from the object.
java.lang.Object	newInstance(java.lang.Object parent) Creates a new instance of the object described by this field.
void	resetValue(java.lang.Object object) Sets the value of the field to a default value.
void	setValue(java.lang.Object object, java.lang.Object value) Sets the value of the field on the object.

Methods inherited from class java.lang.Object

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

Field Detail

MODE_AUTO

public static final int MODE_AUTO

See Also:

Constant Field Values

MODE_PARENT_LINK

public static final int MODE_PARENT_LINK

See Also:

Constant Field Values

MODE_CHILD_LINK

public static final int MODE_CHILD_LINK

See Also:

Constant Field Values

Constructor Detail

ContainerFieldHandler

public ContainerFieldHandler(FieldHandler handler)

Creates a new ContainerFieldHandler with the given FieldHandler.

Method Detail

getValue

public final java.lang.Object getValue(java.lang.Object object)
                                throws java.lang.IllegalStateException

Returns the value of the field from the object.

Specified by:

getValue in interface FieldHandler

Parameters:

object - The object

Returns:

The value of the field

Throws:

java.lang.IllegalStateException - The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object

newInstance

public java.lang.Object newInstance(java.lang.Object parent)
                             throws java.lang.IllegalStateException

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

Specified by:

newInstance in interface FieldHandler

Parameters:

parent - The object for which the field is created

Returns:

A new instance of the field's value

Throws:

java.lang.IllegalStateException - This field is a simple type and cannot be instantiated

resetValue

public final void resetValue(java.lang.Object object)
                      throws java.lang.IllegalStateException,
                             java.lang.IllegalArgumentException

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.

Specified by:

resetValue in interface FieldHandler

Parameters:

object - The object

Throws:

java.lang.IllegalStateException - The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object

java.lang.IllegalArgumentException

setValue

public final void setValue(java.lang.Object object,
                           java.lang.Object value)
                    throws java.lang.IllegalStateException,
                           java.lang.IllegalArgumentException

Sets the value of the field on the object.

Specified by:

setValue in interface FieldHandler

Parameters:

object - The object

value - The new value

Throws:

java.lang.IllegalStateException - The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object

java.lang.IllegalArgumentException - The value passed is not of a supported type

checkValidity

public void checkValidity(java.lang.Object object)
                   throws ValidityException,
                          java.lang.IllegalStateException

Checks the field validity. Returns successfully if the field can be stored, is valid, etc, throws an exception otherwise.

Specified by:

checkValidity in interface FieldHandler

Parameters:

object - The object

Throws:

ValidityException - The field is invalid, is required and null, or any other validity violation

java.lang.IllegalStateException - The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object