JavadocForBinaryQuery.Result (NetBeans Java Support APIs) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.api.java.queries
Interface JavadocForBinaryQuery.Result

Enclosing interface:: JavadocForBinaryQuery

public static interface JavadocForBinaryQuery.Result

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

Method Summary

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

public 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

public void addChangeListener(ChangeListener l)

Add a listener to changes in the roots.

Parameters:: l - a listener to add

removeChangeListener

public void removeChangeListener(ChangeListener l)

Remove a listener to changes in the roots.

Parameters:: l - a listener to remove