org.netbeans.spi.lsp

Class SignatureInformationCollector.Builder

java.lang.Object

org.netbeans.spi.lsp.SignatureInformationCollector.Builder

Enclosing interface:

SignatureInformationCollector

public static final class SignatureInformationCollector.Builder
extends Object

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

// Create a builder for creating 'SignatureInformation' instance providing its 'label' and 'isActive' flag
SignatureInformation si = SignatureInformationCollector.newBuilder("label", true)

        // add signature parameters
        .addParameter("param0", false, "param0 documentation")
        .addParameter("param1", true, "param1 documentation")

        // set signature documentation
        .documentation("documentation")

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

Since:

1.20

Method Summary

Modifier and Type	Method and Description
SignatureInformationCollector.Builder	addParameter(String label, boolean isActive, String documentation) Adds parameter information to this signature.
SignatureInformation	build() Builds signature information.
SignatureInformationCollector.Builder	documentation(String documentation) A human-readable string that represents a doc-comment.

Methods inherited from class java.lang.Object

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

Method Detail

documentation

@NonNull
public SignatureInformationCollector.Builder documentation(@NonNull
                                                                    String documentation)

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

Since:

1.20

addParameter

@NonNull
public SignatureInformationCollector.Builder addParameter(@NonNull
                                                                   String label,
                                                                   boolean isActive,
                                                                   @NullAllowed
                                                                   String documentation)

Adds parameter information to this signature.

Parameters:

label - label of the parameter information

isActive - true if the the parameter is active

documentation - an optional doc-comment of the parameter

Since:

1.20

build

@NonNull
public SignatureInformation build()

Builds signature information.

Since:

1.20