org.netbeans.spi.lsp

Interface HyperlinkTypeDefLocationProvider

@MimeLocation(subfolderName="HyperlinkTypeDefLocationProviders")
public interface HyperlinkTypeDefLocationProvider

Interface for resolving hyperlinks to type definition locations. Implementations of the interface should be registered in MimeLookup.

   @MimeRegistration(mimeType = "text/foo", service = HyperlinkTypeDefLocationProvider.class)
   public class FooHyperlinkTypeDefLocationProvider implements HyperlinkTypeDefLocationProvider {
     ...
   }
  
 

Since:

1.1

Method Summary

Modifier and Type	Method and Description
CompletableFuture<HyperlinkLocation>	getHyperlinkTypeDefLocation(Document doc, int offset) Resolves a hyperlink at the given document offset and returns its target type definition location.

Method Detail

getHyperlinkTypeDefLocation

CompletableFuture<HyperlinkLocation> getHyperlinkTypeDefLocation(@NonNull
                                                                 Document doc,
                                                                 int offset)

Resolves a hyperlink at the given document offset and returns its target type definition location.

Parameters:

doc - document on which to operate.

offset - offset within document

Returns:

target location

Since:

1.1