org.netbeans.spi.java.queries

Interface SourceJavadocAttacherImplementation.Definer

All Known Subinterfaces:

SourceJavadocAttacherImplementation.Definer2

Enclosing interface:

SourceJavadocAttacherImplementation

public static interface SourceJavadocAttacherImplementation.Definer

Extension into the default SourceJavadocAttacherImplementation allowing to download or find sources and javadoc for given binary. The extension implementation is registered in the global Lookup. Multiple Definers can be defined. Consider to implement SourceJavadocAttacherImplementation.Definer2 to indicate the Definer is willing to handle the root.

Since:

1.49

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description of the SourceJavadocAttacherImplementation.Definer.
String	getDisplayName() Returns the display name of the SourceJavadocAttacherImplementation.Definer.
List<? extends URL>	getJavadoc(URL root, Callable<Boolean> cancel) Returns the list of downloaded javadocs which should be attached to the root.
List<? extends URL>	getSources(URL root, Callable<Boolean> cancel) Returns the list of downloaded sources which should be attached to the root.

Method Detail

getDisplayName

@NonNull
String getDisplayName()

Returns the display name of the SourceJavadocAttacherImplementation.Definer.

Returns:

the display name, for example "Maven Repository"

getDescription

@NonNull
String getDescription()

Returns the description of the SourceJavadocAttacherImplementation.Definer.

Returns:

the description, for example "Downloads artifacts from Maven repository"

getSources

@NonNull
List<? extends URL> getSources(@NonNull
                                        URL root,
                                        @NonNull
                                        Callable<Boolean> cancel)

Returns the list of downloaded sources which should be attached to the root.

Parameters:

root - the root to download sources for

cancel - the Callable returning true if the download should be canceled

Returns:

the list of source roots Threading: Called in background thread.

getJavadoc

@NonNull
List<? extends URL> getJavadoc(@NonNull
                                        URL root,
                                        @NonNull
                                        Callable<Boolean> cancel)

Returns the list of downloaded javadocs which should be attached to the root.

Parameters:

root - the root to download javadoc for

cancel - the Callable returning true if the download should be canceled

Returns:

the list of javadoc roots Threading: Called in background thread.