org.netbeans.spi.java.queries

Interface SourceJavadocAttacherImplementation

public interface SourceJavadocAttacherImplementation

A SPI for attaching source roots and javadoc roots to binary roots. The implementations of this interface are registered in global Lookup.

Since:

1.35

See Also:

ServiceProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SourceJavadocAttacherImplementation.Definer Extension into the default SourceJavadocAttacherImplementation allowing to download or find sources and javadoc for given binary.
static interface	SourceJavadocAttacherImplementation.Definer2 Extends the SourceJavadocAttacherImplementation.Definer interface to work better if several providers are defined.

Method Summary

Modifier and Type	Method and Description
boolean	attachJavadoc(URL root, SourceJavadocAttacher.AttachmentListener listener) Attaches a javadoc root provided by this SPI to given binary root.
boolean	attachSources(URL root, SourceJavadocAttacher.AttachmentListener listener) Attaches a source root provided by this SPI to given binary root.

Method Detail

attachSources

boolean attachSources(@NonNull
                      URL root,
                      @NonNull
                      SourceJavadocAttacher.AttachmentListener listener)
               throws IOException

Attaches a source root provided by this SPI to given binary root.

Parameters:

root - the binary root to attach sources to

a - listener notified about result when attaching is done

Throws:

IOException - in case of error

attachJavadoc

boolean attachJavadoc(@NonNull
                      URL root,
                      @NonNull
                      SourceJavadocAttacher.AttachmentListener listener)
               throws IOException

Attaches a javadoc root provided by this SPI to given binary root.

Parameters:

root - the binary root to attach javadoc to

a - listener notified about result when attaching is done

Throws:

IOException - in case of error