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 2003 (C) Intalio, Inc. All Rights Reserved.
042: *
043: * $Id: FieldHandlerFriend.java 6230 2006-09-19 07:56:07Z wguttmn $
044: */package org.exolab.castor.mapping.loader;
045:
046: import org.exolab.castor.mapping.FieldDescriptor;
047: import org.exolab.castor.mapping.FieldHandler;
048: import org.exolab.castor.mapping.ValidityException;
049:
050: /**
051: * An extended version of the FieldHandler interface which is
052: * used for adding additional functionality while preserving
053: * backward compatability.
054: *
055: * @author <a href="kvisco@intalio.com">Keith Visco</a>
056: * @version $Revision: 6230 $ $Date: 2005-08-03 15:11:51 -0600 (Wed, 03 Aug 2005) $
057: * @see FieldDescriptor
058: * @see FieldHandler
059: */
060: public abstract class FieldHandlerFriend implements FieldHandler {
061:
062: /**
063: * Returns the FieldDescriptor for the field that this
064: * handler is reponsibile for, or null if no FieldDescriptor
065: * has been set. This method is useful for implementations
066: * of the FieldHandler interface that wish to obtain information
067: * about the field in order to make the FieldHandler more generic
068: * and reusable, or simply for validation purposes.
069: *
070: * @return the FieldDescriptor, or null if none exists.
071: */
072: protected abstract FieldDescriptor getFieldDescriptor();
073:
074: /**
075: * Sets the FieldDescriptor that this FieldHander is
076: * responsibile for. By setting the FieldDescriptor, it
077: * allows the implementation of the FieldHandler methods
078: * to obtain information about the field itself. This allows
079: * a particular implementation to become more generic and
080: * reusable.
081: *
082: * @param fieldDesc the FieldDescriptor to set
083: */
084: public abstract void setFieldDescriptor(FieldDescriptor fieldDesc);
085:
086: //---------------------------------------/
087: //- Methods inherited from FieldHandler -/
088: //---------------------------------------/
089:
090: /**
091: * @deprecated No longer supported
092: */
093: public abstract void checkValidity(Object object)
094: throws ValidityException, IllegalStateException;
095:
096: /**
097: * Returns the value of the field from the object.
098: *
099: * @param object The object
100: * @return The value of the field
101: * @throws IllegalStateException The Java object has changed and
102: * is no longer supported by this handler, or the handler is not
103: * compatiable with the Java object
104: */
105: public abstract Object getValue(Object object)
106: throws IllegalStateException;
107:
108: /**
109: * Creates a new instance of the object described by this field.
110: *
111: * @param parent The object for which the field is created
112: * @return A new instance of the field's value
113: * @throws IllegalStateException This field is a simple type and
114: * cannot be instantiated
115: */
116: public abstract Object newInstance(Object parent)
117: throws IllegalStateException;
118:
119: /**
120: * Sets the value of the field to a default value.
121: * <p>
122: * Reference fields are set to null, primitive fields are set to
123: * their default value, collection fields are emptied of all
124: * elements.
125: *
126: * @param object The object
127: * @throws IllegalStateException The Java object has changed and
128: * is no longer supported by this handler, or the handler is not
129: * compatiable with the Java object
130: */
131: public abstract void resetValue(Object object)
132: throws IllegalStateException, IllegalArgumentException;
133:
134: /**
135: * Sets the value of the field on the object.
136: *
137: * @param object The object
138: * @param value The new value
139: * @throws IllegalStateException The Java object has changed and
140: * is no longer supported by this handler, or the handler is not
141: * compatiable with the Java object
142: * @throws IllegalArgumentException The value passed is not of
143: * a supported type
144: */
145: public abstract void setValue(Object object, Object value)
146: throws IllegalStateException, IllegalArgumentException;
147:
148: } //-- FieldHandlerFriend
|