01: /**
02: * Redistribution and use of this software and associated documentation
03: * ("Software"), with or without modification, are permitted provided
04: * that the following conditions are met:
05: *
06: * 1. Redistributions of source code must retain copyright
07: * statements and notices. Redistributions must also contain a
08: * copy of this document.
09: *
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 1999 (C) Intalio, Inc. All Rights Reserved.
42: *
43: * $Id: MappingLoader.java 6055 2006-07-31 19:42:40Z rjoachim $
44: */package org.exolab.castor.mapping;
45:
46: import java.util.Iterator;
47:
48: import org.castor.mapping.BindingType;
49:
50: /**
51: * Provides the mapping descriptor for Java classes. The engines use
52: * resolvers to obtain the mapping descriptor for a particular Java
53: * class, or to list all the known descriptors. Although the interface
54: * is identical, each engine will use a resolver that returns class
55: * descriptor suitable for that particular engine. Resolvers are
56: * immutable and engines need not cache the returned descriptors.
57: *
58: * @author <a href="arkin@intalio.com">Assaf Arkin</a>
59: * @version $Revision: 6055 $ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
60: */
61: public interface MappingLoader {
62: BindingType getBindingType();
63:
64: String getSourceType();
65:
66: void clear();
67:
68: void setClassLoader(final ClassLoader loader);
69:
70: /**
71: * Returns the class loader associated with this mapping loader if one was specified. This is
72: * the class loader used to load all the classes mapped by this mapping loader. May be null if
73: * no class loader was specified or in certain JVMs.
74: */
75: ClassLoader getClassLoader();
76:
77: /**
78: * Returns the ClassDescriptor for the class with the given name. If no such ClassDescriptor
79: * exists, within the set of mappings for this MappingLoader, null will be returned.
80: *
81: * @param classname The className for which to return the associated ClassDescriptor.
82: * @return The ClassDescriptor or null if not found.
83: */
84: ClassDescriptor getDescriptor(String classname);
85:
86: /**
87: * Returns an iterator over all the known descriptors in the original order they have been
88: * added. Each element is of type {@link ClassDescriptor}.
89: */
90: Iterator descriptorIterator();
91: }
|