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 2003 (C) Intalio, Inc. All Rights Reserved.
32 *
33 * $Id$
34 */
35
36
37 package org.exolab.castor.mapping;
38
39
40
41 /**
42 * An abstract factory class for creating GeneralizedFieldHandlers.
43 *
44 *
45 * @author <a href="kvisco@intalio.com">Keith Visco</a>
46 * @version $Revision$ $Date: 2003-10-23 13:53:59 -0600 (Thu, 23 Oct 2003) $
47 */
48 public abstract class FieldHandlerFactory {
49
50 /**
51 * Returns an array of the supported Class types for this FieldHandlerFactory. The array may be
52 * empty, but must not be null.
53 *
54 * @return an array of supported Class types.
55 */
56 public abstract Class[] getSupportedTypes();
57
58 /**
59 * Returns true if the given Class type is supported by this FieldHandlerFactory. If the type is
60 * supported, a call to #createFieldHandler will return a valid FieldHandler. If the type is not
61 * supported, a call to createFieldHandler may return null or throw a MappingException.
62 *
63 * @param type the Class type to determine support for.
64 *
65 * @return true if the given Class type is supported.
66 */
67 public abstract boolean isSupportedType(Class type);
68
69 /**
70 * Creates a GeneralizedFieldHandler for the given class type. The method should return a new
71 * GeneralizedFieldHandler as an "underlying" FieldHandler will need to be set by the caller.
72 *
73 * @param type the Class type to create the FieldHandler for.
74 */
75 public abstract GeneralizedFieldHandler createFieldHandler(Class type) throws MappingException;
76
77
78
79 } // -- FieldHandlerFactory
80
81