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 (C) Intalio, Inc. All Rights Reserved.
042: *
043: * $Id: FieldHandler.java 6671 2007-01-02 05:57:46Z ekuns $
044: */package org.exolab.castor.mapping;
045:
046: /**
047: * A field handler knows how to perform various operations on the
048: * field that require access to the field value.
049: *
050: * @author <a href="arkin@intalio.com">Assaf Arkin</a>
051: * @version $Revision: 6671 $ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
052: * @see FieldDescriptor
053: */
054: public interface FieldHandler {
055: /**
056: * Returns the value of the field from the object.
057: *
058: * @param object The object
059: * @return The value of the field
060: * @throws IllegalStateException The Java object has changed and
061: * is no longer supported by this handler, or the handler is not
062: * compatible with the Java object
063: */
064: public Object getValue(Object object) throws IllegalStateException;
065:
066: /**
067: * Sets the value of the field on the object.
068: *
069: * @param object The object.
070: * @param value The new value.
071: * @throws IllegalStateException The Java object has changed and is no longer
072: * supported by this handler, or the handler is not compatible with the
073: * Java object.
074: * @throws IllegalArgumentException The value passed is not of a supported type.
075: */
076: public void setValue(Object object, Object value)
077: throws IllegalStateException, IllegalArgumentException;
078:
079: /**
080: * Sets the value of the field to a default value.
081: * <p>
082: * Reference fields are set to null, primitive fields are set to
083: * their default value, collection fields are emptied of all
084: * elements.
085: *
086: * @param object The object.
087: * @throws IllegalStateException The Java object has changed and is no longer
088: * supported by this handler, or the handler is not compatible with the
089: * Java object.
090: */
091: public void resetValue(Object object) throws IllegalStateException,
092: IllegalArgumentException;
093:
094: /**
095: * @deprecated No longer supported
096: */
097: public void checkValidity(Object object) throws ValidityException,
098: IllegalStateException;
099:
100: /**
101: * Creates a new instance of the object described by this field.
102: *
103: * @param parent The object for which the field is created
104: * @return A new instance of the field's value
105: * @throws IllegalStateException This field is a simple type and
106: * cannot be instantiated
107: */
108: public Object newInstance(Object parent)
109: throws IllegalStateException;
110:
111: }
|