View Javadoc
1   /**
2    * Redistribution and use of this software and associated documentation ("Software"), with or
3    * without modification, are permitted provided that the following conditions are met:
4    *
5    * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
6    * must also contain a copy of this document.
7    *
8    * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
9    * conditions and the following disclaimer in the documentation and/or other materials provided with
10   * the distribution.
11   *
12   * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
13   * without prior written permission of Intalio, Inc. For written permission, please contact
14   * info@exolab.org.
15   *
16   * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
17   * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
18   * Intalio, Inc.
19   *
20   * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
21   *
22   * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
23   * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
24   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
25   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
29   * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30   *
31   * Copyright 1999-2002 (C) Intalio, Inc. All Rights Reserved.
32   *
33   * $Id$
34   */
35  
36  package org.exolab.castor.mapping.loader;
37  
38  import org.exolab.castor.mapping.FieldDescriptor;
39  import org.exolab.castor.mapping.FieldHandler;
40  
41  /**
42   * An extended version of the FieldHandler interface which is used for adding additional
43   * functionality while preserving backward compatability.
44   * 
45   * @author <a href="kvisco@intalio.com">Keith Visco</a>
46   * @version $Revision$ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
47   * @see FieldDescriptor
48   * @see FieldHandler
49   */
50  public abstract class ExtendedFieldHandler<T> implements FieldHandler<T> {
51  
52    // /**
53    // * Returns the FieldDescriptor for the field that this handler is responsible
54    // * for, or null if no FieldDescriptor has been set. This method is useful for
55    // * implementations of the FieldHandler interface that wish to obtain
56    // * information about the field in order to make the FieldHandler more generic
57    // * and reusable, or simply for validation purposes.
58    // *
59    // * @return the FieldDescriptor, or null if none exists.
60    // */
61    // protected abstract FieldDescriptor getFieldDescriptor();
62    //
63    // /**
64    // * Sets the FieldDescriptor that this FieldHander is responsible for. By
65    // * setting the FieldDescriptor, it allows the implementation of the
66    // * FieldHandler methods to obtain information about the field itself. This
67    // * allows a particular implementation to become more generic and reusable.
68    // *
69    // * @param fieldDesc
70    // * the FieldDescriptor to set
71    // */
72    // protected abstract void setFieldDescriptor(FieldDescriptor fieldDesc);
73  
74    // /**
75    // * @deprecated No longer supported
76    // */
77    // public final void checkValidity(Object object) throws ValidityException, IllegalStateException
78    // {
79    // // -- do nothing...deprecated method
80    // } // -- checkValidity
81    //
82    // /**
83    // * Returns the value of the field from the object.
84    // *
85    // * @param object
86    // * The object
87    // * @return The value of the field
88    // * @throws IllegalStateException
89    // * The Java object has changed and is no longer supported by this
90    // * handler, or the handler is not compatiable with the Java object
91    // */
92    // public abstract Object getValue(Object object) throws IllegalStateException;
93    //
94    // /**
95    // * Creates a new instance of the object described by this field.
96    // *
97    // * @param parent
98    // * The object for which the field is created
99    // * @return A new instance of the field's value
100   // * @throws IllegalStateException
101   // * This field is a simple type and cannot be instantiated
102   // */
103   // public abstract Object newInstance(Object parent) throws IllegalStateException;
104   //
105   // /**
106   // * Sets the value of the field to a default value.
107   // * <p>
108   // * Reference fields are set to null, primitive fields are set to their
109   // * default value, collection fields are emptied of all elements.
110   // *
111   // * @param object
112   // * The object
113   // * @throws IllegalStateException
114   // * The Java object has changed and is no longer supported by this
115   // * handler, or the handler is not compatiable with the Java object
116   // */
117   // public abstract void resetValue(Object object) throws IllegalStateException,
118   // IllegalArgumentException;
119   //
120   // /**
121   // * Sets the value of the field on the object.
122   // *
123   // * @param object
124   // * The object
125   // * @param value
126   // * The new value
127   // * @throws IllegalStateException
128   // * The Java object has changed and is no longer supported by this
129   // * handler, or the handler is not compatiable with the Java object
130   // * @throws IllegalArgumentException
131   // * The value passed is not of a supported type
132   // */
133   // public abstract void setValue(Object object, Object value) throws IllegalStateException,
134   // IllegalArgumentException;
135 
136 }
137