Source Code Cross Referenced for ClassPathProvider.java in  » IDE-Netbeans » gsf » org » netbeans » modules » gsfpath » spi » classpath » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » IDE Netbeans » gsf » org.netbeans.modules.gsfpath.spi.classpath 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


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.modules.gsfpath.spi.classpath;
043:
044:        import org.netbeans.modules.gsfpath.api.classpath.ClassPath;
045:        import org.openide.filesystems.FileObject;
046:
047:        /**
048:         * Provider interface for Java classpaths.
049:         * <p>
050:         * The <code>org.netbeans.modules.gsfpath.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.modules.gsfpath.spi.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.modules.gsfpath.api.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.modules.gsfpath.api.classpath.GlobalPathRegistry
108:         * @author Jesse Glick
109:         * @since org.netbeans.modules.gsfpath.api/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.modules.gsfpath.spi.classpath.support.ClassPathSupport
120:             */
121:            ClassPath findClassPath(FileObject file, String type);
122:
123:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.