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 (C) Intalio, Inc. All Rights Reserved.
32 *
33 * $Id$
34 */
35 package org.exolab.castor.mapping;
36
37 import java.util.List;
38
39 import org.castor.mapping.BindingType;
40
41 /**
42 * Provides the mapping descriptor for Java classes. The engines use resolvers to obtain the mapping
43 * descriptor for a particular Java class, or to list all the known descriptors. Although the
44 * interface is identical, each engine will use a resolver that returns class descriptor suitable
45 * for that particular engine. Resolvers are immutable and engines need not cache the returned
46 * descriptors.
47 *
48 * @author <a href="arkin@intalio.com">Assaf Arkin</a>
49 * @version $Revision$ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
50 */
51 public interface MappingLoader {
52
53 BindingType getBindingType();
54
55 String getSourceType();
56
57 void clear();
58
59 void setClassLoader(final ClassLoader loader);
60
61 /**
62 * Returns the class loader associated with this mapping loader if one was specified. This is the
63 * class loader used to load all the classes mapped by this mapping loader. May be null if no
64 * class loader was specified or in certain JVMs.
65 */
66 ClassLoader getClassLoader();
67
68 /**
69 * Returns the ClassDescriptor for the class with the given name. If no such ClassDescriptor
70 * exists, within the set of mappings for this MappingLoader, null will be returned.
71 *
72 * @param classname The className for which to return the associated ClassDescriptor.
73 * @return The ClassDescriptor or null if not found.
74 */
75 ClassDescriptor getDescriptor(String classname);
76
77 /**
78 * Returns a List of {@link ClassDescriptor}s of all known descriptors.
79 *
80 * @return List of {@link ClassDescriptor}
81 */
82 List<ClassDescriptor> getDescriptors();
83 }