View Javadoc
1 package org.codehaus.classworlds; 2 3 /* 4 $Id: ClassRealm.java,v 1.1.1.1 2003/07/29 04:38:00 bob Exp $ 5 6 Copyright 2002 (C) The Werken Company. All Rights Reserved. 7 8 Redistribution and use of this software and associated documentation 9 ("Software"), with or without modification, are permitted provided 10 that the following conditions are met: 11 12 1. Redistributions of source code must retain copyright 13 statements and notices. Redistributions must also contain a 14 copy of this document. 15 16 2. Redistributions in binary form must reproduce the 17 above copyright notice, this list of conditions and the 18 following disclaimer in the documentation and/or other 19 materials provided with the distribution. 20 21 3. The name "classworlds" must not be used to endorse or promote 22 products derived from this Software without prior written 23 permission of The Werken Company. For written permission, 24 please contact bob@werken.com. 25 26 4. Products derived from this Software may not be called "classworlds" 27 nor may "classworlds" appear in their names without prior written 28 permission of The Werken Company. "classworlds" is a registered 29 trademark of The Werken Company. 30 31 5. Due credit should be given to The Werken Company. 32 (http://classworlds.werken.com/). 33 34 THIS SOFTWARE IS PROVIDED BY THE WERKEN COMPANY AND CONTRIBUTORS 35 ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT 36 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 37 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 38 THE WERKEN COMPANY OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 39 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 40 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 41 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 42 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 43 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 44 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 45 OF THE POSSIBILITY OF SUCH DAMAGE. 46 47 */ 48 49 import java.net.URL; 50 51 /*** Autonomous sub-portion of a <code>ClassWorld</code>. 52 * 53 * <p> 54 * This class most closed maps to the <code>ClassLoader</code> 55 * role from Java and in facts can provide a <code>ClassLoader</code> 56 * view of itself using {@link #getClassLoader}. 57 * </p> 58 * 59 * @author <a href="mailto:bob@eng.werken.com">bob mcwhirter</a> 60 * @author <a href="mailto:jason@zenplex.com">Jason van Zyl</a> 61 * 62 * @version $Id: ClassRealm.java,v 1.1.1.1 2003/07/29 04:38:00 bob Exp $ 63 */ 64 public interface ClassRealm 65 { 66 /*** Retrieve the id. 67 * 68 * @return The id. 69 */ 70 String getId(); 71 72 /*** Retrieve the <code>ClassWorld</code> of which this is a member. 73 * 74 * @return The class-world. 75 */ 76 ClassWorld getWorld(); 77 78 /*** Import packages from another <code>ClassRealm</code>. 79 * 80 * <p> 81 * Specific packages can be imported from another realm 82 * instead of attempting to load them locally from this 83 * one. When importing a package a realm defers <b>completely</b> 84 * to the foreign realm to satisfy the package dependencies. 85 * </p> 86 * 87 * @param realmId The realm id from which to import. 88 * @param pkgName The package name to import. 89 * 90 * @throws NoSuchRealmException If the id of the realm from which 91 * to import does not correspond to a foreign realm within 92 * this realm's world. 93 */ 94 void importFrom(String realmId, 95 String pkgName) throws NoSuchRealmException; 96 97 /*** Retrieve the <code>ClassLoader</code> that models this 98 * <code>ClassRealm</code>. 99 * 100 * @return The classloader. 101 */ 102 ClassLoader getClassLoader(); 103 104 /*** Load a class. 105 * 106 * @param name The name of the class to load. 107 * 108 * @return The loaded class. 109 * 110 * @throws ClassNotFoundException If the class cannot be found. 111 */ 112 Class loadClass(String name) throws ClassNotFoundException; 113 114 URL getResource( String name ); 115 116 /*** Add a constituent to this realm for locating classes. 117 * 118 * <p> 119 * A constituent is a URL that points to either a JAR 120 * format file containing classes and/or resources, or 121 * a directory that should be used for searching. If 122 * the constituent is a directory, then the URL <b>must</b> 123 * end with a slash (<code>/</code>). Otherwise the 124 * constituent will be treated as a JAR file. 125 * </p> 126 * 127 * @param constituent URL to contituent jar or directory. 128 */ 129 void addConstituent(URL constituent); 130 131 /*** Set the parent <code>ClassRealm</code>. 132 * 133 * @param classRealm The parent ClassRealm. 134 */ 135 void setParent( ClassRealm classRealm ); 136 137 /*** Create a child realm. 138 * 139 * @param id The name of child realm. 140 */ 141 ClassRealm createChildRealm( String id ); 142 }

This page was automatically generated by Maven