<?xml version="1.0" encoding="UTF-8"?>

<!--

DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.

The contents of this file are subject to the terms of either the GNU

General Public License Version 2 only ("GPL") or the Common

Development and Distribution License("CDDL") (collectively, the

"License"). You may not use this file except in compliance with the

License. You can obtain a copy of the License at

http://www.netbeans.org/cddl-gplv2.html

or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

specific language governing permissions and limitations under the

License.  When distributing the software, include this License Header

Notice in each file and include the License file at

nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

particular file as subject to the "Classpath" exception as provided

by Sun in the GPL Version 2 section of the License file that

accompanied this code. If applicable, add the following below the

License Header, with the fields enclosed by brackets [] replaced by

your own identifying information:

"Portions Copyrighted [year] [name of copyright owner]"

Contributor(s):

The Original Software is NetBeans. The Initial Developer of the Original

Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

Microsystems, Inc. All Rights Reserved.

If you wish your version of this file to be governed by only the CDDL

or only the GPL Version 2, indicate your decision by adding

"[Contributor] elects to include this software in this distribution

under the [CDDL or GPL Version 2] license." If you do not indicate a

single choice of license, a recipient has the option to distribute

your version of this file under either the CDDL, the GPL Version 2 or

to extend the choice of license to its licensees as provided above.

However, if you add GPL Version 2 code and therefore, elected the GPL

Version 2 license, then the option applies only if the new code is

made subject to such option by the copyright holder.

-->

<!DOCTYPE api-answers PUBLIC "-//NetBeans//DTD Arch Answers//EN" "../nbbuild/antsrc/org/netbeans/nbbuild/Arch.dtd" [

  <!ENTITY api-questions SYSTEM "../nbbuild/antsrc/org/netbeans/nbbuild/Arch-api-questions.xml">

]>

<api-answers

  question-version="1.24"

  author="tzezula@netbeans.org"

>

  &api-questions;

<!--

        <question id="arch-overall" when="init">

            Describe the overall architecture.

            <hint>

            What will be API for

            <a href="http://openide.netbeans.org/tutorial/api-design.html#design.apiandspi">

                clients and what support API</a>? 

            What parts will be pluggable?

            How will plug-ins be registered? Please use <code>&lt;api type="export"/&gt;</code>

            to describe your general APIs.

            If possible please provide 

            simple diagrams. 

            </hint>

        </question>

-->

 <answer id="arch-overall">

  <api group="java" name="JavaSupportAPIs" type="export" category="official">

   The ClassPath APIs provides java classpath like ordered collection of (source)

   roots with ability to listen on changes and helper methods like finding the file

   under the roots, returning a path from root to given file. It also provides a

   registry where projects register their classpaths to make them visible to languages

   infrastructure.

  </api>

 </answer>

<!--

        <question id="arch-quality" when="init">

            How the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html">quality</a>

            of your code will be tested and 

            how future regressions are going to be prevented?

            <hint>

            What kind of testing

            you want to use? What/how much area of functionality

            should be covered by the tests? 

            </hint>

        </question>

-->

 <answer id="arch-quality">

  <p>

   Ought to be covered by unit tests.

  </p>

 </answer>

<!--

        <question id="arch-time" when="init">

            What are the time estimates of the work?

            <hint>

            Please express your estimates of how long the design, implementation,

            stabilization are likely to last. How many people will be needed to

            implement this and what is the expected milestone the work should be 

            ready.

            </hint>

        </question>

-->

 <answer id="arch-time">

  <p>

   Essentially done.

  </p>

 </answer>

<!--

        <question id="arch-usecases" when="init">

            Describe the main <a href="http://openide.netbeans.org/tutorial/api-design.html#usecase">

            use cases</a> of the new API. Who will use it at

            what circumstances and what will be the typical code to write

            to use the module.

        </question>

-->

 <answer id="arch-usecases">

  <p>

   The API is widely used by all sorts of IDE modules which need to work with

   sources. The SPI is intended mainly for (java) platforms and

   library providers, and project type providers, to declare all of this

   information.

  </p>

 </answer>

<!--

        <question id="arch-what" when="init">

            What is this project good for?

            <hint>

            Please provide here a few lines describing the project, 

            what problem it should solve, provide links to documentation, 

            specifications, etc.

            </hint>

        </question>

-->

 <answer id="arch-what">

  <p>

   Models basic aspects of the metadata surrounding list of source roots, such as

   the classpath. More information in the Javadoc.

  </p>

 </answer>

<!--

        <question id="compat-i18n" when="impl">

            Is your module correctly internationalized?

            <hint>

            Correct internationalization means that it obeys instructions 

            at <a href="http://www.netbeans.org/download/dev/javadoc/org-openide-modules/org/openide/modules/doc-files/i18n-branding.html">

            NetBeans I18N pages</a>.

            </hint>

        </question>

-->

 <answer id="compat-i18n">

  <p>

   No I18N issues.

  </p>

 </answer>

<!--

        <question id="compat-standards" when="init">

            Does the module implement or define any standards? Is the 

            implementation exact or does it deviate somehow?

        </question>

-->

 <answer id="compat-standards">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="compat-version" when="impl">

            Can your module coexist with earlier and future

            versions of itself? Can you correctly read all old settings? Will future

            versions be able to read your current settings? Can you read

            or politely ignore settings stored by a future version?

            <hint>

            Very helpful for reading settings is to store version number

            there, so future versions can decide whether how to read/convert

            the settings and older versions can ignore the new ones.

            </hint>

        </question>

-->

 <answer id="compat-version">

  <p>

   No settings.

  </p>

 </answer>

<!--

        <question id="dep-jre" when="final">

            Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?

            <hint>

            It is expected that if your module runs on 1.x that it will run 

            on 1.x+1 if no, state that please. Also describe here cases where

            you run different code on different versions of JRE and why.

            </hint>

        </question>

-->

 <answer id="dep-jre">

  <p>

   1.5+.

  </p>

 </answer>

<!--

        <question id="dep-jrejdk" when="final">

            Do you require the JDK or is the JRE enough?

        </question>

-->

 <answer id="dep-jrejdk">

  <p>

   JRE.

  </p>

 </answer>

<!--

        <question id="dep-nb" when="init">

            What other NetBeans projects and modules does this one depend on?

            <hint>

            If you want, describe such projects as imported API using

            the <code>&lt;api name="identification" type="import or export" category="stable" url="where is the description" /&gt;</code>

            </hint>

        </question>

-->

 <answer id="dep-nb">

  <ul>

   <li>

    <api group="java" name="Filesystems" type="import" category="official">

     <p>

      For many purposes.

     </p>

    </api>

   </li>

   <li>

    <api group="java" name="Execution" type="import" category="official">

     <p>

      <code>NbClassLoader</code> is used by

      <code>ClassPath.getClassLoader(...)</code>.

     </p>

    </api>

   </li>

  </ul>

 </answer>

<!--

        <question id="dep-non-nb" when="init">

            What other projects outside NetBeans does this one depend on?

            <hint>

            Some non-NetBeans projects are packaged as NetBeans modules

            (see <a href="http://libs.netbeans.org/">libraries</a>) and

            it is preferred to use this approach when more modules may

            depend on such third-party library.

            </hint>

        </question>

-->

 <answer id="dep-non-nb">

  <p>

   None.

  </p>

 </answer>

<!--

        <question id="dep-platform" when="init">

            On which platforms does your module run? Does it run in the same

            way on each?

            <hint>

            If your module is using JNI or deals with special differences of

            OSes like filesystems, etc. please describe here what they are.

            </hint>

        </question>

-->

 <answer id="dep-platform">

  <p>

   Any.

  </p>

 </answer>

 <answer id="deploy-dependencies">

Nothing.

 </answer>

<!--

        <question id="deploy-jar" when="impl">

            Do you deploy just module JAR file(s) or other files as well?

            <hint>

            If your module consists of just one module JAR file, just confirm that.

            If it uses more than one JAR, describe where they are located, how

            they refer to each other. 

            If it consist of module JAR(s) and other files, please describe

            what is their purpose, why other files are necessary. Please 

            make sure that installation/uninstallation leaves the system 

            in state as it was before installation.

            </hint>

        </question>

-->

 <answer id="deploy-jar">

  <p>

   Just a JAR.

  </p>

 </answer>

<!--

        <question id="deploy-nbm" when="impl">

            Can you deploy an NBM via the Update Center?

            <hint>

            If not why?

            </hint>

        </question>

-->

 <answer id="deploy-nbm">

  <p>

   Yes.

  </p>

 </answer>

<!--

        <question id="deploy-packages" when="init">

            Are packages of your module made inaccessible by not declaring them

            public?

            <hint>

            NetBeans module system allows restriction of access rights to

            public classes of your module from other modules. This prevents

            unwanted dependencies of others on your code and should be used

            whenever possible (<a href="http://www.netbeans.org/download/javadoc/OpenAPIs/org/openide/doc-files/upgrade.html#3.4-public-packages">

            public packages

            </a>). If you do not restrict access to your classes you are

            making it too easy for other people to misuse your implementation

            details, that is why you should have good reason for not 

            restricting package access.

            </hint>

        </question>

-->

 <answer id="deploy-packages">

  <p>

   Yes, only API and SPI packages are exported.

  </p>

 </answer>

<!--

        <question id="deploy-shared" when="final">

            Do you need to be installed in the shared location only, or in the user directory only,

            or can your module be installed anywhere?

            <hint>

            Installation location shall not matter, if it does explain why.

            Consider also whether <code>InstalledFileLocator</code> can help.

            </hint>

        </question>

-->

 <answer id="deploy-shared">

  <p>

   Anywhere.

  </p>

 </answer>

<!--

        <question id="exec-classloader" when="impl">

            Does your code create its own class loader(s)?

            <hint>

            A bit unusual. Please explain why and what for.

            </hint>

        </question>

-->

 <answer id="exec-classloader">

  <p>

   There is support for getting a class loader corresponding to a given

   classpath, useful e.g. for loading user JavaBeans to introspect. This is not

   used within the module itself.

  </p>

 </answer>

<!--

        <question id="exec-component" when="impl">

            Is execution of your code influenced by any (string) property

            of any of your components?

            <hint>

            Often <code>JComponent.getClientProperty</code>, <code>Action.getValue</code>

            or <code>PropertyDescriptor.getValue</code>, etc. are used to influence

            a behavior of some code. This of course forms an interface that should

            be documented. Also if one depends on some interface that an object

            implements (<code>component instanceof Runnable</code>) that forms an

            API as well.

            </hint>

        </question>

-->

 <answer id="exec-component">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="exec-introspection" when="impl">

            Does your module use any kind of runtime type information (<code>instanceof</code>,

            work with <code>java.lang.Class</code>, etc.)?

            <hint>

            Check for cases when you have an object of type A and you also

            expect it to (possibly) be of type B and do some special action. That

            should be documented. The same applies on operations in meta-level

            (Class.isInstance(...), Class.isAssignableFrom(...), etc.).

            </hint>

        </question>

-->

 <answer id="exec-introspection">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="exec-privateaccess" when="final">

            Are you aware of any other parts of the system calling some of 

            your methods by reflection?

            <hint>

            If so, describe the "contract" as an API. Likely private or friend one, but

            still API and consider rewrite of it.

            </hint>

        </question>

-->

 <answer id="exec-privateaccess">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="exec-process" when="impl">

            Do you execute an external process from your module? How do you ensure

            that the result is the same on different platforms? Do you parse output?

            Do you depend on result code?

            <hint>

            If you feed an input, parse the output please declare that as an API.

            </hint>

        </question>

-->

 <answer id="exec-process">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="exec-property" when="impl">

            Is execution of your code influenced by any environment or

            Java system (<code>System.getProperty</code>) property?

            <hint>

            If there is a property that can change the behavior of your 

            code, somebody will likely use it. You should describe what it does 

            and the <a href="http://openide.netbeans.org/tutorial/api-design.html#life">stability category</a>

            of this API. You may use

            <pre>

                <api type="export" group="property" name="id" category="private" url="http://...">

                    description of the property, where it is used, what it influence, etc.

                </api>            

            </pre>

            </hint>

        </question>

-->

 <answer id="exec-property">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="exec-reflection" when="impl">

            Does your code use Java Reflection to execute other code?

            <hint>

            This usually indicates a missing or insufficient API in the other

            part of the system. If the other side is not aware of your dependency

            this contract can be easily broken.

            </hint>

        </question>

-->

 <answer id="exec-reflection">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="exec-threading" when="impl">

            What threading models, if any, does your module adhere to?

            <hint>

                If your module calls foreign APIs which have a specific threading model,

                indicate how you comply with the requirements for multithreaded access

                (synchronization, mutexes, etc.) applicable to those APIs.

                If your module defines any APIs, or has complex internal structures

                that might be used from multiple threads, declare how you protect

                data against concurrent access, race conditions, deadlocks, etc.,

                and whether such rules are enforced by runtime warnings, errors, assertions, etc.

                Examples: a class might be non-thread-safe (like Java Collections); might

                be fully thread-safe (internal locking); might require access through a mutex

                (and may or may not automatically acquire that mutex on behalf of a client method);

                might be able to run only in the event queue; etc.

                Also describe when any events are fired: synchronously, asynchronously, etc.

                Ideas: <a href="http://core.netbeans.org/proposals/threading/index.html#recommendations">Threading Recommendations</a> (in progress)

            </hint>

        </question>

-->

 <answer id="exec-threading">

  <p>

   Currently each data structure is intended to be thread-safe.

  </p>

 </answer>

<!--

        <question id="format-clipboard" when="impl">

            Which data flavors (if any) does your code read from or insert to

            the clipboard (by access to clipboard on means calling methods on <code>java.awt.datatransfer.Transferable</code>?

            <hint>

            Often Node's deal with clipboard by usage of <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>.

            Check your code for overriding these methods.

            </hint>

        </question>

-->

 <answer id="format-clipboard">

  <p>

   None.

  </p>

 </answer>

<!--

        <question id="format-dnd" when="impl">

            Which protocols (if any) does your code understand during Drag & Drop?

            <hint>

            Often Node's deal with clipboard by usage of <code>Node.drag, Node.getDropType</code>. 

            Check your code for overriding these methods. Btw. if they are not overridden, they

            by default delegate to <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>.

            </hint>

        </question>

-->

 <answer id="format-dnd">

  <p>

   None.

  </p>

 </answer>

<!--

        <question id="format-types" when="impl">

            Which protocols and file formats (if any) does your module read or write on disk,

            or transmit or receive over the network?

        </question>

-->

 <answer id="format-types">

  <p>

   None.

  </p>

 </answer>

<!--

        <question id="lookup-lookup" when="init">

            Does your module use <code>org.openide.util.Lookup</code>

            or any similar technology to find any components to communicate with? Which ones?

            <hint>

            Please describe the interfaces you are searching for, where 

            are defined, whether you are searching for just one or more of them,

            if the order is important, etc. Also classify the stability of such

            API contract.

            </hint>

        </question>

-->

 <answer id="lookup-lookup">

  <p>

   Yes, query implementations are found using Lookup as usual.

  </p>

 </answer>

<!--

        <question id="lookup-register" when="final">

            Do you register anything into lookup for other code to find?

            <hint>

            Do you register using layer file or using <code>META-INF/services</code>?

            Who is supposed to find your component?

            </hint>

        </question>

-->

 <answer id="lookup-register">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="lookup-remove" when="final">

            Do you remove entries of other modules from lookup?

            <hint>

            Why? Of course, that is possible, but it can be dangerous. Is the module

            your are masking resource from aware of what you are doing?

            </hint>

        </question>

-->

 <answer id="lookup-remove">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="perf-exit" when="final">

            Does your module run any code on exit?

        </question>

-->

 <answer id="perf-exit">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="perf-huge_dialogs" when="final">

            Does your module contain any dialogs or wizards with a large number of

            GUI controls such as combo boxes, lists, trees, or text areas?

        </question>

-->

 <answer id="perf-huge_dialogs">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="perf-limit" when="init">

            Are there any hard-coded or practical limits in the number or size of

            elements your code can handle?

        </question>

-->

 <answer id="perf-limit">

  <p>

   None known.

  </p>

 </answer>

<!--

        <question id="perf-mem" when="final">

            How much memory does your component consume? Estimate

            with a relation to the number of windows, etc.

        </question>

-->

 <answer id="perf-mem">

  <p>

   TBD, but probably little.

  </p>

 </answer>

<!--

        <question id="perf-menus" when="final">

            Does your module use dynamically updated context menus, or

            context-sensitive actions with complicated enablement logic?

        </question>

-->

 <answer id="perf-menus">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="perf-progress" when="final">

            Does your module execute any long-running tasks?

            <hint>Long running tasks should never block 

            AWT thread as it badly hurts the UI

            <a href="http://performance.netbeans.org/responsiveness/issues.html">

            responsiveness</a>.

            Tasks like connecting over

            network, computing huge amount of data, compilation

            be done asynchronously (for example

            using <code>RequestProcessor</code>), definitively it should 

            not block AWT thread.

            </hint>

        </question>

-->

 <answer id="perf-progress">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="perf-scale" when="init">

            Which external criteria influence the performance of your

            program (size of file in editor, number of files in menu, 

            in source directory, etc.) and how well your code scales?

            <hint>

            Please include some estimates, there are other more detailed 

            questions to answer in later phases of implementation. 

            </hint>

        </question>

-->

 <answer id="perf-scale">

  <p>

   Queries perform linearly in number of implementations, but as usual there will

   typically be only one or two implementations, e.g. delegating to owner

   projects.

  </p>

  <p>

   Currently <code>ClassPath</code>s keep global file change listeners to permit

   roots to be invalidated, and this makes file change events linear in the

   number of <code>ClassPath</code> objects. This area is being studied and will

   hopefully be optimized, perhaps reducing overhead to a small constant.

   May require explicit support from the Filesystems API to fully optimize.

  </p>

 </answer>

<!--

        <question id="perf-spi" when="init">

            How the performance of the plugged in code will be enforced?

            <hint>

            If you allow foreign code to be plugged into your own module, how

            do you enforce, that it will behave correctly and fast and will not

            negatively influence the performance of your own module?

            </hint>

        </question>

-->

 <answer id="perf-spi">

  <p>

   No special provisions.

  </p>

 </answer>

<!--

        <question id="perf-startup" when="final">

            Does your module run any code on startup?

        </question>

-->

 <answer id="perf-startup">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="perf-wakeup" when="final">

            Does any piece of your code wake up periodically and do something

            even when the system is otherwise idle (no user interaction)?

        </question>

-->

 <answer id="perf-wakeup">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="resources-file" when="final">

            Does your module use <code>java.io.File</code> directly?

            <hint>

            NetBeans provide a logical wrapper over plain files called 

            <code>org.openide.filesystems.FileObject</code> that

            provides uniform access to such resources and is the preferred

            way that should be used. But of course there can be situations when

            this is not suitable.

            </hint>

        </question>

-->

 <answer id="resources-file">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="resources-layer" when="final">

            Does your module provide own layer? Does it create any files or

            folders in it? What it is trying to communicate by that and with which 

            components?

            <hint>

            NetBeans allows automatic and declarative installation of resources 

            by module layers. Module register files into appropriate places

            and other components use that information to perform their task

            (build menu, toolbar, window layout, list of templates, set of

            options, etc.). 

            </hint>

        </question>

-->

 <answer id="resources-layer">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="resources-mask" when="final">

            Does your module mask/hide/override any resources provided by other modules in

            their layers?

            <hint>

            If you mask a file provided by another module, you probably depend

            on that and do not want the other module to (for example) change

            the file's name. That module shall thus make that file available as an API

            of some stability category.

            </hint>

        </question>

-->

 <answer id="resources-mask">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="resources-read" when="final">

            Does your module read any resources from layers? For what purpose?

            <hint>

            As this is some kind of intermodule dependency, it is a kind of API.

            Please describe it and classify according to 

            <a href="http://openide.netbeans.org/tutorial/api-design.html#categories">

            common stability categories</a>.

            </hint>

        </question>

-->

 <answer id="resources-read">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="security-grant" when="final">

            Does your code grant additional rights to some other code?

            <hint>Avoid using a class loader that adds extra

            permissions to loaded code unless really necessary.

            Also note that your API implementation

            can also expose unneeded permissions to enemy code by

            calling AccessController.doPrivileged().</hint>

        </question>

-->

 <answer id="security-grant">

  <p>

   <code>ClassPath.getClassLoader(...)</code> is granted all permissions.

  </p>

 </answer>

<!--

        <question id="security-policy" when="final">

            Does your functionality require modifications to the standard policy file?

            <hint>Your code might pass control to third-party code not

            coming from trusted domains. This could be code downloaded over the

            network or code coming from libraries that are not bundled

            with NetBeans. Which permissions need to be granted to which domains?</hint>

        </question>

-->

 <answer id="security-policy">

  <p>

   No.

  </p>

 </answer>

<!--

        <question id="arch-where" when="impl">

            Where one can find sources for your module?

            <hint>

                Please provide link to the Hg web client at

                http://hg.netbeans.org/

                or just use tag defaultanswer generate='here'

            </hint>

        </question>

-->

 <answer id="arch-where">

  <defaultanswer generate='here' />

 </answer>

<!--

        <question id="compat-deprecation" when="init">

            How the introduction of your project influences functionality

            provided by previous version of the product?

            <hint>

            If you are planning to deprecate/remove/change any existing APIs,

            list them here accompanied with the reason explaining why you

            are doing so.

            </hint>

        </question>

-->

 <answer id="compat-deprecation">

  <p>

   XXX no answer for compat-deprecation

  </p>

 </answer>

<!--

        <question id="exec-ant-tasks" when="impl">

            Do you define or register any ant tasks that other can use?

            <hint>

            If you provide an ant task that users can use, you need to be very

            careful about its syntax and behaviour, as it most likely forms an

	          API for end users and as there is a lot of end users, their reaction

            when such API gets broken can be pretty strong.

            </hint>

        </question>

-->

 <answer id="exec-ant-tasks">

  <p>

   XXX no answer for exec-ant-tasks

  </p>

 </answer>

<!--

        <question id="resources-preferences" when="final">

            Does your module uses preferences via Preferences API? Does your module use NbPreferences or

            or regular JDK Preferences ? Does it read, write or both ? 

            Does it share preferences with other modules ? If so, then why ?

            <hint>

                You may use

                    <api type="export" group="preferences"

                    name="preference node name" category="private">

                    description of individual keys, where it is used, what it

                    influences, whether the module reads/write it, etc.

                    </api>

                Due to XML ID restrictions, rather than /org/netbeans/modules/foo give the "name" as org.netbeans.modules.foo.

                Note that if you use NbPreferences this name will then be the same as the code name base of the module.

            </hint>

        </question>

-->

 <answer id="resources-preferences">

  <p>

   XXX no answer for resources-preferences

  </p>

 </answer>

</api-answers>

<?xml version="1.0" encoding="UTF-8"?>

<project basedir="." default="netbeans" name="api.java.classpath">

    <description>Builds, tests, and runs the project org.netbeans.api.java.classpath</description>

    <import file="../nbbuild/templates/projectized.xml"/>

</project>

Manifest-Version: 1.0

OpenIDE-Module: org.netbeans.api.java.classpath/1

OpenIDE-Module-Localizing-Bundle: org/netbeans/api/java/classpath/Bundle.properties

OpenIDE-Module-Specification-Version: 1.0

is.autoload=true

javac.source=1.5

javac.compilerargs=-Xlint -Xlint:-serial

test.unit.run.cp.extra=${o.n.core.dir}/lib/boot.jar:${o.n.core.dir}/core/core.jar

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://www.netbeans.org/ns/project/1">

    <type>org.netbeans.modules.apisupport.project</type>

    <configuration>

        <data xmlns="http://www.netbeans.org/ns/nb-module-project/3">

            <code-name-base>org.netbeans.api.java.classpath</code-name-base>

            <module-dependencies>

                <dependency>

                    <code-name-base>org.openide.execution</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>1.12</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.openide.filesystems</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>7.9</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.openide.io</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>1.13</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

                    <code-name-base>org.openide.util</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <specification-version>7.13</specification-version>

                    </run-dependency>

                </dependency>

            </module-dependencies>

            <test-dependencies>

                <test-type>

                    <name>unit</name>

                    <test-dependency>

                        <code-name-base>org.openide.util</code-name-base>

                    </test-dependency>

                    <test-dependency>

                        <code-name-base>org.openide.modules</code-name-base>

                    </test-dependency>

                    <test-dependency>

                        <code-name-base>org.netbeans.modules.masterfs</code-name-base>

                    </test-dependency>

                </test-type>

                <test-type>

                    <name>qa-functional</name>

                </test-type>

            </test-dependencies>

            <public-packages>

                <package>org.netbeans.api.java.classpath</package>

                <package>org.netbeans.api.java.queries</package>

                <package>org.netbeans.spi.java.classpath</package>

                <package>org.netbeans.spi.java.classpath.support</package>

                <package>org.netbeans.spi.java.queries</package>

                <package>org.netbeans.spi.java.queries.support</package>

            </public-packages>

        </data>

    </configuration>

</project>

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.netbeans.modules.java.classpath;

import org.netbeans.api.java.classpath.ClassPath;

import org.netbeans.spi.java.classpath.ClassPathImplementation;

public abstract class ClassPathAccessor {

    public static ClassPathAccessor DEFAULT;

    // force loading of ClassPath class. That will set DEFAULT variable.

    static {

        Class c = ClassPath.class;

        try {

            Class.forName(c.getName(), true, c.getClassLoader());

        } catch (Exception ex) {

            ex.printStackTrace();

        }

    }

    public abstract ClassPath createClassPath(ClassPathImplementation spiClasspath);

    public abstract ClassPathImplementation getClassPathImpl (ClassPath cp);

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.netbeans.modules.java.classpath;

import org.netbeans.spi.java.classpath.ClassPathImplementation;

import org.netbeans.spi.java.classpath.PathResourceImplementation;

import java.util.List;

import java.util.ArrayList;

import java.util.Iterator;

import java.util.Collections;

import java.beans.PropertyChangeListener;

import java.beans.PropertyChangeEvent;

import org.openide.util.WeakListeners;

/** ProxyClassPathImplementation provides read only proxy for ClassPathImplementations.

 *  The order of the resources is given by the order of its delegates.

 *  The proxy is designed to be used as a union of class paths.

 *  E.g. to be able to easily iterate or listen on all design resources = sources + compile resources

 */

public class ProxyClassPathImplementation implements ClassPathImplementation {

    private ClassPathImplementation[] classPaths;

    private List<PathResourceImplementation> resourcesCache;

    private ArrayList<PropertyChangeListener> listeners;

    private PropertyChangeListener classPathsListener;

    public ProxyClassPathImplementation (ClassPathImplementation[] classPaths) {

        if (classPaths == null)

            throw new IllegalArgumentException ();

        List<ClassPathImplementation> impls = new ArrayList<ClassPathImplementation> ();

        classPathsListener = new DelegatesListener ();

        for (ClassPathImplementation cpImpl : classPaths) {

            if (cpImpl == null)

                continue;

            cpImpl.addPropertyChangeListener (WeakListeners.propertyChange(classPathsListener,cpImpl));

            impls.add (cpImpl);

        }

        this.classPaths = impls.toArray(new ClassPathImplementation[impls.size()]);

    }

    public List <? extends PathResourceImplementation> getResources() {

        synchronized (this) {

            if (this.resourcesCache != null) {

                return this.resourcesCache;

            }

        }

        ArrayList<PathResourceImplementation> result = new ArrayList<PathResourceImplementation> (classPaths.length*10);

        for (ClassPathImplementation cpImpl : classPaths) {

            List<? extends PathResourceImplementation> subPath = cpImpl.getResources();

            assert subPath != null : "ClassPathImplementation.getResources() returned null. ClassPathImplementation.class: " 

                + cpImpl.getClass().toString() + " ClassPathImplementation: " + cpImpl.toString();

            result.addAll (subPath);

        }

        synchronized (this) {

            if (this.resourcesCache == null) {

                resourcesCache = Collections.unmodifiableList (result);

            }

            return this.resourcesCache;

        }

    }

    public synchronized void addPropertyChangeListener(PropertyChangeListener listener) {

        if (this.listeners == null)

            this.listeners = new ArrayList<PropertyChangeListener> ();

        this.listeners.add (listener);

    }

    public synchronized void removePropertyChangeListener(PropertyChangeListener listener) {

        if (this.listeners == null)

            return;

        this.listeners.remove (listener);

    }

    public String toString () {

        StringBuilder builder = new StringBuilder("[");   //NOI18N

        for (ClassPathImplementation cpImpl : this.classPaths) {

            builder.append (cpImpl.toString());

            builder.append(", ");   //NOI18N

        }

        builder.append ("]");   //NOI18N

        return builder.toString ();

    }

    private class DelegatesListener implements PropertyChangeListener {

        public void propertyChange(PropertyChangeEvent evt) {

            PropertyChangeListener[] _listeners;

            synchronized (ProxyClassPathImplementation.this) {

                ProxyClassPathImplementation.this.resourcesCache = null;    //Clean the cache

                if (ProxyClassPathImplementation.this.listeners == null)

                    return;

                _listeners = ProxyClassPathImplementation.this.listeners.toArray(new PropertyChangeListener[ProxyClassPathImplementation.this.listeners.size()]);

            }

            PropertyChangeEvent event = new PropertyChangeEvent (ProxyClassPathImplementation.this, evt.getPropertyName(),null,null);

            for (PropertyChangeListener l : _listeners) {

                l.propertyChange (event);

            }

        }

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.netbeans.modules.java.classpath;

import java.util.List;

import java.beans.PropertyChangeListener;

import java.net.URL;

import java.util.ArrayList;

import java.util.Collections;

import java.util.Iterator;

import org.netbeans.spi.java.classpath.ClassPathImplementation;

import org.netbeans.spi.java.classpath.PathResourceImplementation;

public class SimpleClassPathImplementation implements ClassPathImplementation {

    List<? extends PathResourceImplementation> entries;

    public SimpleClassPathImplementation() {

        this(new ArrayList<PathResourceImplementation>());

    }

    public SimpleClassPathImplementation(List<? extends PathResourceImplementation> entries) {

        this.entries = entries;

    }

    public List <? extends PathResourceImplementation> getResources() {

        return Collections.unmodifiableList(entries);

    }

    public void addPropertyChangeListener(PropertyChangeListener listener) {

        // XXX TBD

    }

    public void removePropertyChangeListener(PropertyChangeListener listener) {

        // XXX TBD

    }

    public String toString () {

        StringBuilder builder = new StringBuilder ("SimpleClassPathImplementation["); //NOI18N

        for (PathResourceImplementation impl : this.entries) {

            URL[] roots = impl.getRoots();

            for (URL root : roots) {

                builder.append (root.toExternalForm());

                builder.append (", ");  //NOI18N

            }

        }

        builder.append ("]");   //NOI18N

        return builder.toString ();

    }    

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.netbeans.modules.java.classpath;

import org.netbeans.spi.java.classpath.support.PathResourceBase;

import org.netbeans.spi.java.classpath.ClassPathImplementation;

import java.net.URL;

/**

 * Provides implementation of the single rooted PathResoruceImplementation

 */

public final class SimplePathResourceImplementation  extends PathResourceBase {

    private URL[] url;

    public SimplePathResourceImplementation (URL root) {

        if (root == null)

            throw new IllegalArgumentException ();

        this.url = new URL[] {root};

    }

    public URL[] getRoots() {

        return this.url;

    }

    public ClassPathImplementation getContent() {

        return null;

    }

    public String toString () {

        return "SimplePathResource{"+this.getRoots()[0]+"}";   //NOI18N

    }

    public int hashCode () {

        return this.url[0].hashCode();

    }

    public boolean equals (Object other) {

        if (other instanceof SimplePathResourceImplementation) {

            SimplePathResourceImplementation opr = (SimplePathResourceImplementation) other;

            return this.url[0].equals (opr.url[0]);

        }

        else

            return false;

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 * 

 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.

 * 

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 * 

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 * 

 * Contributor(s):

 * 

 * Portions Copyrighted 2008 Sun Microsystems, Inc.

 */

package org.netbeans.modules.java.queries;

import javax.swing.event.ChangeListener;

import org.netbeans.api.java.queries.SourceForBinaryQuery;

import org.netbeans.spi.java.queries.SourceForBinaryQueryImplementation2;

import org.openide.filesystems.FileObject;

import org.openide.filesystems.FileUtil;

/**

 *

 * @author Tomas Zezula

 */

public class SFBQImpl2Result implements SourceForBinaryQueryImplementation2.Result {

    private final SourceForBinaryQuery.Result delegate;

    public SFBQImpl2Result (final SourceForBinaryQuery.Result result) {

        assert result != null;

        this.delegate = result;

    }

    public boolean preferSources() {

        //Preserve the old behavior from 4.0 to 6.1, ignore sources inside archives

        final FileObject[] roots = this.delegate.getRoots();

        for (FileObject root : roots) {

            if (FileUtil.getArchiveFile(root) != null) {

                return false;

            }

        }

        return true;

    }

    public FileObject[] getRoots () {

        return this.delegate.getRoots();

    }

    public void addChangeListener(ChangeListener l) {

        this.delegate.addChangeListener(l);

    }

    public void removeChangeListener(ChangeListener l) {

        this.delegate.removeChangeListener(l);

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.netbeans.spi.java.classpath;

import java.net.URL;

import org.netbeans.api.java.classpath.ClassPath;

import org.netbeans.modules.java.classpath.ClassPathAccessor;

import org.openide.filesystems.FileUtil;

/**

 * Most general way to create {@link ClassPath} instances.

 * You are not permitted to create them directly; instead you implement

 * {@link ClassPathImplementation} and use this factory.

 * See also {@link org.netbeans.spi.java.classpath.support.ClassPathSupport}

 * for easier ways to create classpaths.

 * @since org.netbeans.api.java/1 1.4

 */

public final class ClassPathFactory {

    private ClassPathFactory() {

    }

    /**

     * Create API classpath instance for the given SPI classpath.

     * @param spiClasspath instance of SPI classpath

     * @return instance of API classpath

     */

    public static ClassPath createClassPath(ClassPathImplementation spiClasspath) {

//        assert checkEntries (spiClasspath) : "ClassPathImplementation contains invalid root: " + spiClasspath.toString();    //Commented, not to decrease the performance even in the dev build.

        return ClassPathAccessor.DEFAULT.createClassPath(spiClasspath);

    }

    private static boolean checkEntries (ClassPathImplementation spiClasspath) {

        for (PathResourceImplementation impl : spiClasspath.getResources()) {

            URL[] roots = impl.getRoots();

            for (URL root : roots) {

                if (FileUtil.isArchiveFile(root)) {

                    return false;

                }

                if (root.toExternalForm().endsWith("/")) {  // NOI18N

                    return false;

                }

            }

        }

        return true;

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.netbeans.spi.java.classpath;

import java.util.List;

import java.beans.PropertyChangeListener;

/**

 * SPI interface for ClassPath.

 * @see ClassPathFactory

 * @since org.netbeans.api.java/1 1.4

 */

public interface ClassPathImplementation {

    public static final String PROP_RESOURCES = "resources";    //NOI18N

    /**

     * Returns list of entries, the list is unmodifiable.

     * @return List of PathResourceImplementation, never returns null

     * it may return an empty List

     */

    public List<? extends PathResourceImplementation> getResources();

    /**

     * Adds property change listener.

     * The listener is notified when the set of entries has changed.

     * @param listener

     */

    public void addPropertyChangeListener(PropertyChangeListener listener);

    /**

     * Removes property change listener

     * @param listener

     */

    public void removePropertyChangeListener(PropertyChangeListener listener);

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

 * The Original Software is NetBeans. The Initial Developer of the Original

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

package org.netbeans.spi.java.classpath;

import org.netbeans.api.java.classpath.ClassPath;

import org.openide.filesystems.FileObject;

/**

 * Provider interface for Java classpaths.

 * <p>

 * The <code>org.netbeans.modules.java.project</code> module registers an

 * implementation of this interface to global lookup which looks for the

 * project which owns a file (if any) and checks its lookup for this interface,

 * and if it finds an instance, delegates to it. Therefore it is not normally

 * necessary for a project type provider to register its own instance just to

 * define the classpaths for files it owns, assuming it depends on the Java

 * Project module.

 * </p>

 * <div class="nonnormative">

 * <p>

 * Note that to make editor code completion functionality work for a Java source file the

 * following classpaths must be available for it:

 * </p>

 * <ol>

 * <li>The {@link ClassPath#BOOT} type of classpath

 *     is required or the source file will not be parsable and 

 *     code completion will be disabled. See also

 *     {@link org.netbeans.spi.java.queries.SourceLevelQueryImplementation}.</li>

 * <li>The {@link ClassPath#SOURCE} type of classpath

 *     is required or code completion will be disabled.

 *     Providing this classpath will enable code completion, but only elements

 *     defined on this classpath will be offered if the compile classpath is missing.</li>

 * <li>The {@link ClassPath#COMPILE} type of classpath

 *     is recommended to be provide to make code completion work fully

 *     by suggesting all classes against which the source is developed.</li>

 * </ol>

 * <p>{@link ClassPath#EXECUTE} is also recommended for e.g. I18N functionality to work.

 * This should contain the full run-time classpath of the class, including its build

 * location (bytecode).</p>

 * <p>You should return these classpaths for the package root folder and any

 * files or folders inside it.</p>

 * <p>You should register classpaths for source files of all these types in

 * {@link org.netbeans.api.java.classpath.GlobalPathRegistry}

 * when they are to be exposed in the GUI as available for use (e.g. for the editor's Fast Open dialog),

 * and unregister them when they are no longer to be exposed. Typically this is done as part of

 * <a href="@PROJECTS/PROJECTUIAPI@/org/netbeans/spi/project/ui/ProjectOpenedHook.html">ProjectOpenedHook</a>.

 * <p>It is also desirable to produce classpath information for compiled class files

 * (bytecode), including their package roots (whether a disk folder or a JAR root).

 * This will enable parsing of the class files, which is sometimes needed (e.g. for

 * expanding the class file node and seeing its members).

 * Compiled classes should have:</p>

 * <ol>

 * <li>{@link ClassPath#BOOT} corresponding to the Java platform to be used with the classes.</li>

 * <li>{@link ClassPath#EXECUTE} containing the bytecode's package root itself, plus any other

 * libraries it needs to resolve against. Should normally be the same as the execute classpath

 * of the corresponding source files.</li>

 * </ol>

 * <p>If no specific class path providers are available for a given source file or bytecode file,

 * i.e. <code>null</code> is returned from all providers, there may be a fallback implementation

 * which would provide reasonable defaults. For source files, this could mean a boot classpath

 * corresponding to the default Java platform (i.e. the JDK being used to run the IDE); empty

 * compile and execute classpaths; and a sourcepath computed based on the package statement in the

 * source file (if this is possible). For class files, this could mean a boot classpath determined

 * as for source files, and an execute classpath containing the package root apparently owning the

 * class file (computed according to the class file's package information, if this is possible).</p>

 * </div>

 * @see ClassPath#getClassPath

 * @see org.netbeans.api.java.classpath.GlobalPathRegistry