org.netbeans.api.java.queries

Class SourceJavadocAttacher

java.lang.Object

org.netbeans.api.java.queries.SourceJavadocAttacher

public final class SourceJavadocAttacher
extends Object

A support for attaching source roots and javadoc roots to binary roots.

Since:

1.35

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SourceJavadocAttacher.AttachmentListener Listener notified by SourceJavadocAttacher about a result of attaching source (javadoc) to binary root.

Method Summary

Modifier and Type	Method and Description
static void	attachJavadoc(URL root, Lookup context, SourceJavadocAttacher.AttachmentListener listener) Attaches a javadoc root provided by the SPI SourceJavadocAttacherImplementation to given binary root.
static void	attachJavadoc(URL root, SourceJavadocAttacher.AttachmentListener listener) Attaches a javadoc root provided by the SPI SourceJavadocAttacherImplementation to given binary root.
static void	attachSources(URL root, Lookup context, SourceJavadocAttacher.AttachmentListener listener) Attaches a source root provided by the SPI SourceJavadocAttacherImplementation to given binary root.
static void	attachSources(URL root, SourceJavadocAttacher.AttachmentListener listener) Attaches a source root provided by the SPI SourceJavadocAttacherImplementation to given binary root.

Methods inherited from class java.lang.Object

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

Method Detail

attachSources

public static void attachSources(@NonNull
                                 URL root,
                                 @NullAllowed
                                 SourceJavadocAttacher.AttachmentListener listener)

Attaches a source root provided by the SPI SourceJavadocAttacherImplementation to given binary root.

Parameters:

root - the binary root to attach sources to

listener - notified about result when attaching is done

attachSources

public static void attachSources(@NonNull
                                 URL root,
                                 @NonNull
                                 Lookup context,
                                 @NullAllowed
                                 SourceJavadocAttacher.AttachmentListener listener)

Attaches a source root provided by the SPI SourceJavadocAttacherImplementation to given binary root. If `context is given, it is used for 2 purposes:

• locate additional attacher plugins (SourceJavadocAttacherImplementations)
• provide information for SourceJavadocAttacherImplementations

Typically a Project lookup can be passed in.

If a SourceJavadocAttacherImplementation fails, the next one willing to handle the URL is tried. Final result is reported through the SourceJavadocAttacher.AttachmentListener.

Parameters:

root - the binary root to attach sources to

listener - notified about result when attaching is done

context - additional context for the operation: may contain project, or additional info consumed by SPI implementors.

Since:

1.78

attachJavadoc

public static void attachJavadoc(@NonNull
                                 URL root,
                                 @NullAllowed
                                 SourceJavadocAttacher.AttachmentListener listener)

Attaches a javadoc root provided by the SPI SourceJavadocAttacherImplementation to given binary root.

Parameters:

root - the binary root to attach javadoc to

listener - notified about result when attaching is done

attachJavadoc

public static void attachJavadoc(@NonNull
                                 URL root,
                                 @NonNull
                                 Lookup context,
                                 @NullAllowed
                                 SourceJavadocAttacher.AttachmentListener listener)

Attaches a javadoc root provided by the SPI SourceJavadocAttacherImplementation to given binary root. If `context is given, it is used for 2 purposes:

• locate additional attacher plugins (SourceJavadocAttacherImplementations)
• provide information for SourceJavadocAttacherImplementations

Typically a Project lookup can be passed in.

If a SourceJavadocAttacherImplementation fails, the next one willing to handle the URL is tried. Final result is reported through the SourceJavadocAttacher.AttachmentListener.

Parameters:

root - the binary root to attach sources to

listener - notified about result when attaching is done

context - additional context for the operation: may contain project, or additional info consumed by SPI implementors.

Since:

1.78