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 14 '19 Prefer binaries over sources when parsing

New Result2 and new BinaryForSourceQueryImplementation2 that allows one to specify that binaries should be used instead of compiling the sources (if the binaries are already compiled and newer).
Oct 4 '16 Added a ClassPath switching among several ClassPath instances

Added a factory method into ClassPathSupport creating a ClassPath switching among several ClassPath instances.
Jun 2 '15 Added a policy for handling in archive paths

Added a policy for handling in archive paths while converting the ClassPath to String. The ClassPath.toString takes a PathEmbeddingMode parameter determining how the in archive path is handled. It can be included into stringified root, omitted from it, or handled as an invalid classpath root.
Oct 31 '14 Added a SPI interface to allow different implementations of GlobalPathRegistry

Added a SPI interface to allow different implementations of the GlobalPathRegistry. The GlobalPathRegistry uses the first instance od the GlobalPathRegistryImplementation registered in the global Lookup
Aug 21 '14 Added ClassPath flags

Added flags to ClassPath

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 Apache Git repositories or in the GitHub 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