001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.spi.java.classpath;
043:
044: import org.netbeans.api.java.classpath.ClassPath;
045: import org.openide.filesystems.FileObject;
046:
047: /**
048: * Provider interface for Java classpaths.
049: * <p>
050: * The <code>org.netbeans.modules.java.project</code> module registers an
051: * implementation of this interface to global lookup which looks for the
052: * project which owns a file (if any) and checks its lookup for this interface,
053: * and if it finds an instance, delegates to it. Therefore it is not normally
054: * necessary for a project type provider to register its own instance just to
055: * define the classpaths for files it owns, assuming it depends on the Java
056: * Project module.
057: * </p>
058: * <div class="nonnormative">
059: * <p>
060: * Note that to make editor code completion functionality work for a Java source file the
061: * following classpaths must be available for it:
062: * </p>
063: * <ol>
064: * <li>The {@link ClassPath#BOOT} type of classpath
065: * is required or the source file will not be parsable and
066: * code completion will be disabled. See also
067: * {@link org.netbeans.spi.java.queries.SourceLevelQueryImplementation}.</li>
068: * <li>The {@link ClassPath#SOURCE} type of classpath
069: * is required or code completion will be disabled.
070: * Providing this classpath will enable code completion, but only elements
071: * defined on this classpath will be offered if the compile classpath is missing.</li>
072: * <li>The {@link ClassPath#COMPILE} type of classpath
073: * is recommended to be provide to make code completion work fully
074: * by suggesting all classes against which the source is developed.</li>
075: * </ol>
076: * <p>{@link ClassPath#EXECUTE} is also recommended for e.g. I18N functionality to work.
077: * This should contain the full run-time classpath of the class, including its build
078: * location (bytecode).</p>
079: * <p>You should return these classpaths for the package root folder and any
080: * files or folders inside it.</p>
081: * <p>You should register classpaths for source files of all these types in
082: * {@link org.netbeans.api.java.classpath.GlobalPathRegistry}
083: * when they are to be exposed in the GUI as available for use (e.g. for the editor's Fast Open dialog),
084: * and unregister them when they are no longer to be exposed. Typically this is done as part of
085: * <a href="@PROJECTS/PROJECTUIAPI@/org/netbeans/spi/project/ui/ProjectOpenedHook.html">ProjectOpenedHook</a>.
086: * <p>It is also desirable to produce classpath information for compiled class files
087: * (bytecode), including their package roots (whether a disk folder or a JAR root).
088: * This will enable parsing of the class files, which is sometimes needed (e.g. for
089: * expanding the class file node and seeing its members).
090: * Compiled classes should have:</p>
091: * <ol>
092: * <li>{@link ClassPath#BOOT} corresponding to the Java platform to be used with the classes.</li>
093: * <li>{@link ClassPath#EXECUTE} containing the bytecode's package root itself, plus any other
094: * libraries it needs to resolve against. Should normally be the same as the execute classpath
095: * of the corresponding source files.</li>
096: * </ol>
097: * <p>If no specific class path providers are available for a given source file or bytecode file,
098: * i.e. <code>null</code> is returned from all providers, there may be a fallback implementation
099: * which would provide reasonable defaults. For source files, this could mean a boot classpath
100: * corresponding to the default Java platform (i.e. the JDK being used to run the IDE); empty
101: * compile and execute classpaths; and a sourcepath computed based on the package statement in the
102: * source file (if this is possible). For class files, this could mean a boot classpath determined
103: * as for source files, and an execute classpath containing the package root apparently owning the
104: * class file (computed according to the class file's package information, if this is possible).</p>
105: * </div>
106: * @see ClassPath#getClassPath
107: * @see org.netbeans.api.java.classpath.GlobalPathRegistry
108: * @author Jesse Glick
109: * @since org.netbeans.api.java/1 1.4
110: */
111: public interface ClassPathProvider {
112:
113: /**
114: * Find some kind of a classpath for a given file.
115: * @param file a file somewhere, or a source root
116: * @param type a classpath type such as {@link ClassPath#COMPILE}
117: * @return an appropriate classpath, or null for no answer
118: * @see ClassPathFactory
119: * @see org.netbeans.spi.java.classpath.support.ClassPathSupport
120: */
121: ClassPath findClassPath(FileObject file, String type);
122:
123: }
|