org.exolab.castor.xml.handlers

Class EnumFieldHandler

Implemented Interfaces:
FieldHandler

public class EnumFieldHandler
extends java.lang.Object
implements FieldHandler

A specialized MarshalDescriptor for the XML Schema enumeration types
Version:
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:09:27 $
Author:
Keith Visco

Constructor Summary

EnumFieldHandler(Class enumType, FieldHandler handler)
Creates a new EnumFieldHandler with the given type and FieldHandler

Method Summary

void
checkValidity(Object object)
Checks the field validity.
boolean
equals(Object obj)
Returns true if the given object is an XMLFieldHandler that is equivalent to the delegated handler.
Object
getValue(Object target)
Returns the value of the field associated with this descriptor from the given target object.
Object
newInstance(Object parent)
Creates a new instance of the object described by this field.
void
resetValue(Object targer)
void
setValue(Object target, Object value)
Sets the value of the field associated with this descriptor.

Constructor Details

EnumFieldHandler

public EnumFieldHandler(Class enumType,
                        FieldHandler handler)
Creates a new EnumFieldHandler with the given type and FieldHandler
Parameters:
handler - the FieldHandler to delegate to

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

equals

public boolean equals(Object obj)
Returns true if the given object is an XMLFieldHandler that is equivalent to the delegated handler. An equivalent XMLFieldHandler is an XMLFieldHandler that is an instances of the same class.
Returns:
true if the given object is an XMLFieldHandler that is equivalent to this one.

getValue

public Object getValue(Object target)
            throws java.lang.IllegalStateException
Returns the value of the field associated with this descriptor from the given target object.
Specified by:
getValue in interface FieldHandler
Parameters:
target - the object to get the value from
Returns:
the value of the field associated with this descriptor from the given target object.

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 void resetValue(Object targer)
Specified by:
resetValue in interface FieldHandler

setValue

public void setValue(Object target,
                     Object value)
            throws java.lang.IllegalStateException
Sets the value of the field associated with this descriptor.
Specified by:
setValue in interface FieldHandler
Parameters:
target - the object in which to set the value
value - the value of the field

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