Overview (Classpath APIs)

Classpath APIs
Package	Description
org.netbeans.api.java.classpath	Representation of Java classpaths, and the ability to find the classpath needed for a particular purpose.
org.netbeans.api.java.queries
org.netbeans.spi.java.classpath	SPI permitting new classpaths to be constructed and registered.
org.netbeans.spi.java.classpath.support	Convenience classes to make it easier to create classpaths.
org.netbeans.spi.java.queries
org.netbeans.spi.java.queries.support

ClassPathAPIs 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.

What is New (see all changes)?

Feb 5 '10 Added a constant representing an empty ClassPath

Added a constant representing an empty ClassPath like java.util.Collections.EMPTY_LIST. This ClassPath has no entries and never fires any events.
Jun 5 '08 Splitting the java API to independent ClassPath API and the rest of the java API

The copy of the ClassPath API was used by generic scripting framework, which cannot depend on the java cluster. To remove this copy of the ClassPath API the java API needs to be splitted into the ClassPath API (IDE cluster) and the rest of the java API (java cluster).
Mar 17 '08 Interconversions with string-format classpaths

ClassPath.toString(PathConversionMode) and ClassPathSupport.createClassPath(String) can be used to easily convert between traditional string classpaths and NetBeans' internal representation.
Mar 13 '08 Support for delegating SourceForBinaryQueryImplementation2

Added support base class for SourceForBinaryQueryImplementation2 which delegates to other SourceForBinaryQueryImplementations.
Mar 10 '08 Support for passing hint to the java infrastructure whether it should prefer source or binary

It is possible for the SouceForBinaryQuery provider to specify whether the java module should prefer sources or binaries. In general sources should be preferred for projects where user can make modification. The binaries should be preferred for libraries and platforms where sources may not be complete or correct.

Use Cases

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.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
ClassPathAPIs	Exported	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.

Implementation Details

Where are the sources for the module?

The sources for the module are in the NetBeans Mercurial repositories.

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

Nothing.

Read more about the implementation in the answers to architecture questions.

Classpath APIsOfficial