org.exolab.castor.xml.handlers

Class ContainerFieldHandler

Implemented Interfaces:
FieldHandler

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

The FieldHandler for ContainerElement

Version:
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:09:27 $

Author:
Keith Visco

See Also:
FieldDescriptor, FieldHandler

Field Summary

static int
MODE_AUTO
static int
MODE_CHILD_LINK
static int
MODE_PARENT_LINK

Constructor Summary

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

Method Summary

void
checkValidity(Object object)
Checks the field validity.
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.
void
resetValue(Object object)
Sets the value of the field to a default value.
void
setValue(Object object, Object value)
Sets the value of the field on the object.

Field Details

MODE_AUTO

public static final int MODE_AUTO

Field Value:
0


MODE_CHILD_LINK

public static final int MODE_CHILD_LINK

Field Value:
2


MODE_PARENT_LINK

public static final int MODE_PARENT_LINK

Field Value:
1

Constructor Details

ContainerFieldHandler

public ContainerFieldHandler(FieldHandler handler)
Creates a new ContainerFieldHandler with the given FieldHandler.

Method Details

checkValidity

public void checkValidity(Object object)
            throws ValidityException,
                   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


getValue

public final Object getValue(Object object)
            throws 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


newInstance

public Object newInstance(Object parent)
            throws 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


resetValue

public final void resetValue(Object object)
            throws IllegalStateException,
                   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


setValue

public final void setValue(Object object,
                           Object value)
            throws IllegalStateException,
                   IllegalArgumentException
Sets the value of the field on the object.
Specified by:
setValue in interface FieldHandler

Parameters:
object - The object
value - The new value


Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com