org.netbeans.api.lsp

Class Hover

java.lang.Object

org.netbeans.api.lsp.Hover

public final class Hover
extends Object

Represents a hover information at a given text document position.

Since:

1.2

Constructor Summary

Constructors

Constructor and Description
Hover()

Method Summary

Modifier and Type	Method and Description
static CompletableFuture<String>	getContent(Document doc, int offset) Resolves a hover information at the given document offset and returns its content.

Methods inherited from class java.lang.Object

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

Constructor Detail

Hover

public Hover()

Method Detail

getContent

@NonNull
public static CompletableFuture<String> getContent(@NonNull
                                                            Document doc,
                                                            int offset)

Resolves a hover information at the given document offset and returns its content. Example usage can be illustrated by:

// Resolve a hover information at the given document offset...
CompletableFuture<String> future = Hover.getContent(doc, offset);

// ...and get its content
String content = future.getNow(null);
assertEquals("Foo hover information", content);

Parameters:

doc - document on which to operate.

offset - offset within document

Returns:

a HTML formatted content

Since:

1.2