org.netbeans.spi.lsp

Interface CompletionCollector

@MimeLocation(subfolderName="CompletionCollectors")
public interface CompletionCollector

Interface for computing and collecting completions. Clients can use this interface to collect completions and send them for presentation outside of NetBeans using the Language Server Protocol. Implementations of the interface should be registered in MimeLookup.

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

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CompletionCollector.Builder Builder for Completion instances.

Method Summary

Modifier and Type	Method and Description
boolean	collectCompletions(Document doc, int offset, Completion.Context context, java.util.function.Consumer<Completion> consumer) Computes and collects completions for a document at a given offset.
static CompletionCollector.Builder	newBuilder(String label) Creates a builder for Completion instances.

Method Detail

collectCompletions

boolean collectCompletions(@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.

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

Since:

1.0

newBuilder

static CompletionCollector.Builder newBuilder(@NonNull
                                              String label)

Creates a builder for Completion instances.

Parameters:

label - the label of the completion

Returns:

newly created builder

Since:

1.0