org.netbeans.api.java.queries

Class JavadocForBinaryQuery

java.lang.Object

org.netbeans.api.java.queries.JavadocForBinaryQuery

public class JavadocForBinaryQuery
extends Object

A query to find Javadoc root for the given classpath root.

Since:

org.netbeans.api.java/1 1.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JavadocForBinaryQuery.Result Result of finding Javadoc, encapsulating the answer as well as the ability to listen to it.

Method Summary

Modifier and Type	Method and Description
static JavadocForBinaryQuery.Result	findJavadoc(URL binary) Find Javadoc information for a classpath root containing Java classes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

findJavadoc

public static JavadocForBinaryQuery.Result findJavadoc(URL binary)

Find Javadoc information for a classpath root containing Java classes.

These methods calls findJavadoc method on the JavadocForBinaryQueryImplementation instances registered in the lookup until a non null result is returned for given binaryRoot.

Parameters:

binary - URL of a classpath root

Returns:

a result object encapsulating the answer (never null)