001: /**
002: * Redistribution and use of this software and associated documentation
003: * ("Software"), with or without modification, are permitted provided
004: * that the following conditions are met:
005: *
006: * 1. Redistributions of source code must retain copyright
007: * statements and notices. Redistributions must also contain a
008: * copy of this document.
009: *
010: * 2. Redistributions in binary form must reproduce the
011: * above copyright notice, this list of conditions and the
012: * following disclaimer in the documentation and/or other
013: * materials provided with the distribution.
014: *
015: * 3. The name "Exolab" must not be used to endorse or promote
016: * products derived from this Software without prior written
017: * permission of Intalio, Inc. For written permission,
018: * please contact info@exolab.org.
019: *
020: * 4. Products derived from this Software may not be called "Exolab"
021: * nor may "Exolab" appear in their names without prior written
022: * permission of Intalio, Inc. Exolab is a registered
023: * trademark of Intalio, Inc.
024: *
025: * 5. Due credit should be given to the Exolab Project
026: * (http://www.exolab.org/).
027: *
028: * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
029: * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
030: * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
031: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
032: * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
033: * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
034: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
035: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
036: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
037: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
038: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
039: * OF THE POSSIBILITY OF SUCH DAMAGE.
040: *
041: * Copyright 1999-2003 (C) Intalio, Inc. All Rights Reserved.
042: *
043: * $Id: ExtendedFieldHandler.java 6216 2006-09-15 23:26:59Z rjoachim $
044: */package org.exolab.castor.mapping;
045:
046: import org.exolab.castor.mapping.loader.FieldHandlerFriend;
047:
048: /**
049: * An extended version of the FieldHandler interface which is
050: * used for adding additional functionality while preserving
051: * backward compatability.
052: *
053: * @author <a href="kvisco@intalio.com">Keith Visco</a>
054: * @version $Revision: 6216 $ $Date: 2005-08-03 15:11:51 -0600 (Wed, 03 Aug 2005) $
055: * @see FieldDescriptor
056: * @see FieldHandler
057: */
058: public abstract class ExtendedFieldHandler extends FieldHandlerFriend {
059: /**
060: * Returns the FieldDescriptor for the field that this
061: * handler is reponsibile for, or null if no FieldDescriptor
062: * has been set. This method is useful for implementations
063: * of the FieldHandler interface that wish to obtain information
064: * about the field in order to make the FieldHandler more generic
065: * and reusable, or simply for validation purposes.
066: *
067: * @return the FieldDescriptor, or null if none exists.
068: */
069: protected abstract FieldDescriptor getFieldDescriptor();
070:
071: /**
072: * Sets the FieldDescriptor that this FieldHander is
073: * responsibile for. By setting the FieldDescriptor, it
074: * allows the implementation of the FieldHandler methods
075: * to obtain information about the field itself. This allows
076: * a particular implementation to become more generic and
077: * reusable.
078: *
079: * @param fieldDesc the FieldDescriptor to set
080: */
081: public abstract void setFieldDescriptor(FieldDescriptor fieldDesc);
082:
083: //---------------------------------------/
084: //- Methods inherited from FieldHandler -/
085: //---------------------------------------/
086:
087: /**
088: * @deprecated No longer supported
089: */
090: public void checkValidity(Object object) throws ValidityException,
091: IllegalStateException {
092: //-- do nothing...deprecated method
093: } //-- checkValidity
094:
095: /**
096: * Returns the value of the field from the object.
097: *
098: * @param object The object
099: * @return The value of the field
100: * @throws IllegalStateException The Java object has changed and
101: * is no longer supported by this handler, or the handler is not
102: * compatiable with the Java object
103: */
104: public abstract Object getValue(Object object)
105: throws IllegalStateException;
106:
107: /**
108: * Creates a new instance of the object described by this field.
109: *
110: * @param parent The object for which the field is created
111: * @return A new instance of the field's value
112: * @throws IllegalStateException This field is a simple type and
113: * cannot be instantiated
114: */
115: public abstract Object newInstance(Object parent)
116: throws IllegalStateException;
117:
118: /**
119: * Creates a new instance of the object described by this field.
120: *
121: * @param parent The object for which the field is created
122: * @param args the set of constructor arguments
123: * @return A new instance of the field's value
124: * @throws IllegalStateException This field is a simple type and
125: * cannot be instantiated
126: */
127: public abstract Object newInstance(Object parent, Object[] args)
128: throws IllegalStateException;
129:
130: /**
131: * Sets the value of the field to a default value.
132: * <p>
133: * Reference fields are set to null, primitive fields are set to
134: * their default value, collection fields are emptied of all
135: * elements.
136: *
137: * @param object The object
138: * @throws IllegalStateException The Java object has changed and
139: * is no longer supported by this handler, or the handler is not
140: * compatiable with the Java object
141: */
142: public abstract void resetValue(Object object)
143: throws IllegalStateException, IllegalArgumentException;
144:
145: /**
146: * Sets the value of the field on the object.
147: *
148: * @param object The object.
149: * @param value The new value.
150: * @throws IllegalStateException The Java object has changed and is no longer
151: * supported by this handler, or the handler is not compatiable with the
152: * Java object.
153: * @throws IllegalArgumentException The value passed is not of a supported type.
154: */
155: public abstract void setValue(Object object, Object value)
156: throws IllegalStateException, IllegalArgumentException;
157: } //-- ExtendedFieldHandler
|