org.netbeans.spi.java.queries

Interface SourceForBinaryQueryImplementation2

All Superinterfaces:

SourceForBinaryQueryImplementation

All Known Implementing Classes:

SourceForBinaryQueryImpl2Base

public interface SourceForBinaryQueryImplementation2
extends SourceForBinaryQueryImplementation

Information about where Java sources corresponding to binaries (classfiles) can be found.

In addition to the original SourceForBinaryQueryImplementation this interface also provides information used by the java infrastructure if sources should be preferred over the binaries. When sources are preferred the java infrastructure will use sources as a primary source of the metadata otherwise the binaries (classfiles) are used as a primary source of information and sources are used as a source of formal parameter names and javadoc only. In general sources should be preferred for projects which are user editable but not for libraries or platforms where the sources may not be complete or up to date.

Since:

org.netbeans.api.java/1 1.15

See Also:

SourceForBinaryQueryImplementation

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SourceForBinaryQueryImplementation2.Result

Method Summary

Modifier and Type	Method and Description
SourceForBinaryQueryImplementation2.Result	findSourceRoots2(URL binaryRoot) Returns the source root(s) for a given binary root.

Methods inherited from interface org.netbeans.spi.java.queries.SourceForBinaryQueryImplementation

findSourceRoots

Method Detail

findSourceRoots2

SourceForBinaryQueryImplementation2.Result findSourceRoots2(URL binaryRoot)

Returns the source root(s) for a given binary root.

Parameters:

binaryRoot - the class path root of Java class files

Returns:

a result object encapsulating the answer or null if the binaryRoot is not recognized

See Also:

SourceForBinaryQueryImplementation.findSourceRoots(java.net.URL)