org.exolab.castor.xml.handlers

Class EnumFieldHandler

public class EnumFieldHandler extends 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
voidcheckValidity(Object object)
Checks the field validity.
booleanequals(Object obj)
Returns true if the given object is an XMLFieldHandler that is equivalent to the delegated handler.
ObjectgetValue(Object target)
Returns the value of the field associated with this descriptor from the given target object.
ObjectnewInstance(Object parent)
Creates a new instance of the object described by this field.
voidresetValue(Object targer)
voidsetValue(Object target, Object value)
Sets the value of the field associated with this descriptor.

Constructor Detail

EnumFieldHandler

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

Parameters: type the Class type of the described field handler the FieldHandler to delegate to

Method Detail

checkValidity

public void checkValidity(Object object)
Checks the field validity. Returns successfully if the field can be stored, is valid, etc, throws an exception otherwise.

Parameters: object The object

Throws: ValidityException The field is invalid, is required and null, or any other validity violation IllegalStateException The Java object has changed and is no longer supported by this handler, or the handler is not compatiable with the Java object

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)
Returns the value of the field associated with this descriptor from the given target object.

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)
Creates a new instance of the object described by this field.

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

resetValue

public void resetValue(Object targer)

setValue

public void setValue(Object target, Object value)
Sets the value of the field associated with this descriptor.

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