org.netbeans.api.lsp

Class HyperlinkLocation

java.lang.Object

org.netbeans.api.lsp.HyperlinkLocation

public final class HyperlinkLocation
extends Object

Represents the target location of a hyperlink. Location is a range inside a file object, such as a line inside a text file.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getEndOffset() The end offset of a hyperlink's target range.
FileObject	getFileObject() Target file object of this hyperlink.
int	getStartOffset() The start offset of a hyperlink's target range.
int	hashCode()
static CompletableFuture<List<HyperlinkLocation>>	resolve(Document doc, int offset) Resolves a hyperlink at the given document offset and returns its target location(s).
static CompletableFuture<List<HyperlinkLocation>>	resolveTypeDefinition(Document doc, int offset) Resolves a hyperlink at the given document offset and returns its target type definition location(s).
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getFileObject

@NonNull
public FileObject getFileObject()

Target file object of this hyperlink.

Returns:

file object

Since:

1.0

getStartOffset

public int getStartOffset()

The start offset of a hyperlink's target range.

Returns:

offset

Since:

1.0

getEndOffset

public int getEndOffset()

The end offset of a hyperlink's target range.

Returns:

offset

Since:

1.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

resolve

@NonNull
public static CompletableFuture<List<HyperlinkLocation>> resolve(@NonNull
                                                                          Document doc,
                                                                          int offset)

Resolves a hyperlink at the given document offset and returns its target location(s). Example usage can be illustrated by:

// Resolve a hyperlink at the given document offset...
CompletableFuture<List<HyperlinkLocation>> future = HyperlinkLocation.resolve(doc, offset);

// ...and get its target location(s)
List<HyperlinkLocation> locations = future.getNow(null);
assertNotNull(locations);
assertEquals(1, locations.size());
HyperlinkLocation location = locations.get(0);

// get location's file object
FileObject fileObject = location.getFileObject();
assertEquals(srcFile, fileObject);

// get location's start offset
int startOffset = location.getStartOffset();
assertEquals(10, startOffset);

// get location's end offset
int endOffset = location.getEndOffset();
assertEquals(20, endOffset);

Parameters:

doc - document on which to operate.

offset - offset within document

Returns:

target location(s)

Since:

1.0

resolveTypeDefinition

@NonNull
public static CompletableFuture<List<HyperlinkLocation>> resolveTypeDefinition(@NonNull
                                                                                        Document doc,
                                                                                        int offset)

Resolves a hyperlink at the given document offset and returns its target type definition location(s). Example usage can be illustrated by:

// Resolve a hyperlink at the given document offset...
CompletableFuture<List<HyperlinkLocation>> future = HyperlinkLocation.resolveTypeDefinition(doc, offset);

// ...and get its target type definition location(s)
List<HyperlinkLocation> locations = future.getNow(null);
assertNotNull(locations);
assertEquals(1, locations.size());
HyperlinkLocation location = locations.get(0);

// get location's file object
FileObject fileObject = location.getFileObject();
assertEquals(srcFile, fileObject);

// get location's start offset
int startOffset = location.getStartOffset();
assertEquals(10, startOffset);

// get location's end offset
int endOffset = location.getEndOffset();
assertEquals(20, endOffset);

Parameters:

doc - document on which to operate.

offset - offset within document

Returns:

target type definition location(s)

Since:

1.1