org.netbeans.api.lsp

Class Completion

java.lang.Object

org.netbeans.api.lsp.Completion

public final class Completion
extends Object

Represents a completion proposal.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Completion.Context Contains additional information about the context in which a request for collections completions is triggered.
static class	Completion.Kind The kind of a completion.
static class	Completion.Tag Completion item tags are extra annotations that tweak the rendering of a completion.
static class	Completion.TextFormat Defines whether the insert text in a completion item should be interpreted as plain text or a snippet.
static class	Completion.TriggerKind Specifies how a completion was triggered.

Method Summary

Modifier and Type	Method and Description
static boolean	collect(Document doc, int offset, Completion.Context context, java.util.function.Consumer<Completion> consumer) Computes and collects completions for a document at a given offset.
CompletableFuture<List<TextEdit>>	getAdditionalTextEdits() A list of additional text edits that are applied when selecting this completion.
Command	getCommand() An optional command that is executed after inserting this completion.
List<Character>	getCommitCharacters() A list of characters that when pressed while this completion is active will accept it first and then type that character.
CompletableFuture<String>	getDetail() A human-readable string with additional information about this completion, like type or symbol information.
CompletableFuture<String>	getDocumentation() A human-readable string that represents a doc-comment.
String	getFilterText() A string that should be used when filtering a set of completions.
String	getInsertText() A string that should be inserted into a document when selecting this completion.
Completion.TextFormat	getInsertTextFormat() The format of the insert text.
Completion.Kind	getKind() The kind of this completion.
String	getLabel() The label of this completion.
String	getSortText() A string that should be used when comparing this completion with other completions.
List<Completion.Tag>	getTags() Tags for this completion.
TextEdit	getTextEdit() An edit which is applied to a document when selecting this completion.
boolean	isPreselect() Select this completion when showing.

Methods inherited from class java.lang.Object

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

Method Detail

getLabel

@NonNull
public String getLabel()

The label of this completion. By default also the text that is inserted when selecting this completion.

Since:

1.0

getKind

@CheckForNull
public Completion.Kind getKind()

The kind of this completion.

Since:

1.0

getTags

@CheckForNull
public List<Completion.Tag> getTags()

Tags for this completion.

Since:

1.0

getDetail

@CheckForNull
public CompletableFuture<String> getDetail()

A human-readable string with additional information about this completion, like type or symbol information.

Since:

1.0

getDocumentation

@CheckForNull
public CompletableFuture<String> getDocumentation()

A human-readable string that represents a doc-comment. An HTML format is supported.

Since:

1.0

isPreselect

public boolean isPreselect()

Select this completion when showing.

Since:

1.0

getSortText

@CheckForNull
public String getSortText()

A string that should be used when comparing this completion with other completions. When null the label is used as the sort text.

Since:

1.0

getFilterText

@CheckForNull
public String getFilterText()

A string that should be used when filtering a set of completions. When null the label is used as the filter.

Since:

1.0

getInsertText

@CheckForNull
public String getInsertText()

A string that should be inserted into a document when selecting this completion. When null the label is used as the insert text.

Since:

1.0

getInsertTextFormat

@CheckForNull
public Completion.TextFormat getInsertTextFormat()

The format of the insert text. The format applies to both the insertText property and the newText property of a provided textEdit. If omitted defaults to Completion.TextFormat.PlainText.

Since:

1.0

getTextEdit

@CheckForNull
public TextEdit getTextEdit()

An edit which is applied to a document when selecting this completion. When an edit is provided the value of insertText is ignored. The range of the edit must be a single line range and it must contain the position at which completion has been requested.

Since:

1.0

getCommand

@CheckForNull
public Command getCommand()

An optional command that is executed after inserting this completion.

Since:

1.17

getAdditionalTextEdits

@CheckForNull
public CompletableFuture<List<TextEdit>> getAdditionalTextEdits()

A list of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main edit nor with themselves. Additional text edits should be used to change text unrelated to the current cursor position (for example adding an import statement at the top of the file if the completion item will insert an unqualified type).

Since:

1.0

getCommitCharacters

@CheckForNull
public List<Character> getCommitCharacters()

A list of characters that when pressed while this completion is active will accept it first and then type that character.

Since:

1.0

collect

public static boolean collect(@NonNull
                              Document doc,
                              int offset,
                              @NullAllowed
                              Completion.Context context,
                              @NonNull
                              java.util.function.Consumer<Completion> consumer)

Computes and collects completions for a document at a given offset. Example usage can be illustrated by:

// Compute and collect completions for a document at a given offset
boolean isComplete = Completion.collect(doc, offset, null, completion -> {

    // completion should never be 'null'
    assertNotNull(completion);

    // getting completion 'label'
    String label = completion.getLabel();
    assertEquals("label", label);

    // getting optional completion 'detail'
    CompletableFuture<String> detail = completion.getDetail();
    // check for 'null' value
    if (detail != null) {
        // value should be already computed
        assertTrue(detail.isDone());
        // getting the value
        String value = detail.getNow(null);
        assertEquals("detail", value);
    }

    // getting optional completion 'documentation'
    CompletableFuture<String> documentation = completion.getDocumentation();
    // check for 'null' value
    if (documentation != null) {
        // value computation should be deferred
        assertFalse(documentation.isDone());
        // getting the value
        try {
            String value = documentation.get();
            assertEquals("documentation", value);
        } catch (Exception ex) {
            Exceptions.printStackTrace(ex);
        }
    }
});

Parameters:

doc - a text document

offset - an offset inside the text document

context - an optional completion context

consumer - an operation accepting collected completions

Returns:

true if the list of collected completion is complete. If false, further typing should result in subsequent calls to this method to recompute the completions.

Since:

1.0