CompletionCollector.Builder (LSP APIs)

java.lang.Object
- org.netbeans.spi.lsp.CompletionCollector.Builder

Enclosing interface:: CompletionCollector

public static final class CompletionCollector.Builder
extends Object

Builder for Completion instances. Its usage can be illustrated by:

// Create a builder for creating 'Completion' instance providing its 'label'
Completion c = CompletionCollector.newBuilder("label")

        // set completion detail
        .detail("detail")

        // set completion documentation with deffered computation
        .documentation(() -> {
            return "documentation";
        })

        // create a new 'Completion' instance
        .build();

Since:: 1.0

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletionCollector.Builder`	`addCommitCharacter(char commitCharacter)` Adds character that when pressed while this completion is active will accept it first and then type that character.
`CompletionCollector.Builder`	`additionalTextEdits(List<TextEdit> additionalTextEdits)` A list of additional text edits that are applied when selecting this completion.
`CompletionCollector.Builder`	`additionalTextEdits(java.util.function.Supplier<List<TextEdit>> additionalTextEdits)` A list of additional text edits that are applied when selecting this completion.
`CompletionCollector.Builder`	`addTag(Completion.Tag tag)` Adds tag for this completion.
`Completion`	`build()` Builds completion.
`CompletionCollector.Builder`	`command(Command command)` An optional command that is executed after inserting this completion.
`CompletionCollector.Builder`	`detail(String detail)` A human-readable string with additional information about this completion, like type or symbol information.
`CompletionCollector.Builder`	`detail(java.util.function.Supplier<String> detail)` A human-readable string with additional information about this completion, like type or symbol information.
`CompletionCollector.Builder`	`documentation(String documentation)` A human-readable string that represents a doc-comment.
`CompletionCollector.Builder`	`documentation(java.util.function.Supplier<String> documentation)` A human-readable string that represents a doc-comment.
`CompletionCollector.Builder`	`filterText(String filterText)` A string that should be used when filtering a set of completions.
`CompletionCollector.Builder`	`insertText(String insertText)` A string that should be inserted into a document when selecting this completion.
`CompletionCollector.Builder`	`insertTextFormat(Completion.TextFormat insertTextFormat)` The format of the insert text.
`CompletionCollector.Builder`	`kind(Completion.Kind kind)` The kind of this completion.
`CompletionCollector.Builder`	`label(String label)` The label of this completion.
`CompletionCollector.Builder`	`preselect(boolean preselect)` Select this completion when showing.
`CompletionCollector.Builder`	`sortText(String sortText)` A string that should be used when comparing this completion with other completions.
`CompletionCollector.Builder`	`textEdit(TextEdit textEdit)` An edit which is applied to a document when selecting this completion.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - label
```
@NonNull
public CompletionCollector.Builder label(@NonNull
                                                  String label)
```
    The label of this completion. By default also the text that is inserted when selecting this completion.
    
    Since:
    
    1.0
  - kind
```
@NonNull
public CompletionCollector.Builder kind(@NonNull
                                                 Completion.Kind kind)
```
    The kind of this completion.
    
    Since:
    
    1.0
  - addTag
```
@NonNull
public CompletionCollector.Builder addTag(@NonNull
                                                   Completion.Tag tag)
```
    Adds tag for this completion.
    
    Since:
    
    1.0
  - detail
```
@NonNull
public CompletionCollector.Builder detail(@NonNull
                                                   String detail)
```
    A human-readable string with additional information about this completion, like type or symbol information. If computing of a full detail is expensive, user should use CompletionCollector.Builder.detail(java.util.function.Supplier) to defer computation to the subsequent completionItem/resolve request.
    
    Since:
    
    1.0
  - detail
```
@NonNull
public CompletionCollector.Builder detail(@NonNull
                                                   java.util.function.Supplier<String> detail)
```
    A human-readable string with additional information about this completion, like type or symbol information. Use this method to defer computation of a full detail to the subsequent completionItem/resolve request.
    
    Since:
    
    1.0
  - documentation
```
@NonNull
public CompletionCollector.Builder documentation(@NonNull
                                                          String documentation)
```
    A human-readable string that represents a doc-comment. An HTML format is supported. If computing of a full documentation is expensive, user should use CompletionCollector.Builder.documentation(java.util.function.Supplier) to defer computation to the subsequent completionItem/resolve request.
    
    Since:
    
    1.0
  - documentation
```
@NonNull
public CompletionCollector.Builder documentation(@NonNull
                                                          java.util.function.Supplier<String> documentation)
```
    A human-readable string that represents a doc-comment. An HTML format is supported. Use this method to defer computation of a full documentation to the subsequent completionItem/resolve request.
    
    Since:
    
    1.0
  - preselect
```
@NonNull
public CompletionCollector.Builder preselect(boolean preselect)
```
    Select this completion when showing.
    
    Since:
    
    1.0
  - sortText
```
@NonNull
public CompletionCollector.Builder sortText(@NonNull
                                                     String sortText)
```
    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
  - filterText
```
@NonNull
public CompletionCollector.Builder filterText(@NonNull
                                                       String filterText)
```
    A string that should be used when filtering a set of completions. When null the label is used as the filter.
    
    Since:
    
    1.0
  - insertText
```
@NonNull
public CompletionCollector.Builder insertText(@NonNull
                                                       String insertText)
```
    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
  - insertTextFormat
```
@NonNull
public CompletionCollector.Builder insertTextFormat(@NonNull
                                                             Completion.TextFormat insertTextFormat)
```
    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
  - textEdit
```
@NonNull
public CompletionCollector.Builder textEdit(@NonNull
                                                     TextEdit textEdit)
```
    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
  - command
```
@NonNull
public CompletionCollector.Builder command(@NonNull
                                                    Command command)
```
    An optional command that is executed after inserting this completion.
    
    Since:
    
    1.17
  - additionalTextEdits
```
@NonNull
public CompletionCollector.Builder additionalTextEdits(@NonNull
                                                                List<TextEdit> additionalTextEdits)
```
    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). If computing of the additional text edits is expensive, user should use CompletionCollector.Builder.additionalTextEdits(java.util.function.Supplier) to defer computation to the subsequent completionItem/resolve request.
    
    Since:
    
    1.0
  - additionalTextEdits
```
@NonNull
public CompletionCollector.Builder additionalTextEdits(@NonNull
                                                                java.util.function.Supplier<List<TextEdit>> additionalTextEdits)
```
    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). Use this method to defer computation of the additional text edits to the subsequent completionItem/resolve request.
    
    Since:
    
    1.0
  - addCommitCharacter
```
@NonNull
public CompletionCollector.Builder addCommitCharacter(char commitCharacter)
```
    Adds character that when pressed while this completion is active will accept it first and then type that character.
    
    Since:
    
    1.0
  - build
```
@NonNull
public Completion build()
```
    Builds completion.
    
    Since:
    
    1.0

Class CompletionCollector.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

label

kind

addTag

detail

detail

documentation

documentation

preselect

sortText

filterText

insertText

insertTextFormat

textEdit

command

additionalTextEdits

additionalTextEdits

addCommitCharacter

build