org.netbeans.api.java.queries

Interface JavadocForBinaryQuery.Result

Enclosing class:

JavadocForBinaryQuery

public static interface JavadocForBinaryQuery.Result

Result of finding Javadoc, encapsulating the answer as well as the ability to listen to it.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener l) Add a listener to changes in the roots.
URL[]	getRoots() Get the Javadoc roots.
void	removeChangeListener(ChangeListener l) Remove a listener to changes in the roots.

Method Detail

getRoots

URL[] getRoots()

Get the Javadoc roots. Each root should contain the main index.html, so that for a class pkg.Class the generated documentation would have a path pkg/Class.html relative to one of the roots.

Returns:

array of roots of Javadoc documentation (may be empty but not null)

addChangeListener

void addChangeListener(ChangeListener l)

Add a listener to changes in the roots.

Parameters:

l - a listener to add

removeChangeListener

void removeChangeListener(ChangeListener l)

Remove a listener to changes in the roots.

Parameters:

l - a listener to remove