1 /**
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Intalio, Inc. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Intalio, Inc. Exolab is a registered
23 * trademark of Intalio, Inc.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2003 (C) Intalio, Inc. All Rights Reserved.
42 *
43 * $Id$
44 */
45
46
47 package org.exolab.castor.mapping;
48
49
50
51 /**
52 * An abstract factory class for creating GeneralizedFieldHandlers.
53 *
54 *
55 * @author <a href="kvisco@intalio.com">Keith Visco</a>
56 * @version $Revision$ $Date: 2003-10-23 13:53:59 -0600 (Thu, 23 Oct 2003) $
57 */
58 public abstract class FieldHandlerFactory {
59
60 /**
61 * Returns an array of the supported Class types
62 * for this FieldHandlerFactory. The array may
63 * be empty, but must not be null.
64 *
65 * @return an array of supported Class types.
66 */
67 public abstract Class[] getSupportedTypes();
68
69 /**
70 * Returns true if the given Class type is supported by
71 * this FieldHandlerFactory. If the type is supported,
72 * a call to #createFieldHandler will return a valid
73 * FieldHandler. If the type is not supported, a call
74 * to createFieldHandler may return null or throw
75 * a MappingException.
76 *
77 * @param type the Class type to determine support for.
78 *
79 * @return true if the given Class type is supported.
80 */
81 public abstract boolean isSupportedType(Class type);
82
83 /**
84 * Creates a GeneralizedFieldHandler for the given class type.
85 * The method should return a new GeneralizedFieldHandler as
86 * an "underlying" FieldHandler will need to be set by the
87 * caller.
88 *
89 * @param type the Class type to create the FieldHandler for.
90 */
91 public abstract GeneralizedFieldHandler createFieldHandler(Class type)
92 throws MappingException;
93
94
95
96 } //-- FieldHandlerFactory
97
98
99