org.netbeans.api.lsp

Class SignatureInformation

java.lang.Object

org.netbeans.api.lsp.SignatureInformation

public final class SignatureInformation
extends Object

Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.

Since:

1.20

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignatureInformation.Context Additional information about the context in which a signature help request was triggered.
static class	SignatureInformation.ParameterInformation Represents a parameter of a callable-signature.
static class	SignatureInformation.TriggerKind Specifies how a signature help was triggered.

Method Summary

Modifier and Type	Method and Description
static void	collect(Document doc, int offset, SignatureInformation.Context context, java.util.function.Consumer<SignatureInformation> consumer) Computes and collects signature information for a document at a given offset.
String	getDocumentation() A human-readable string that represents a doc-comment.
String	getLabel() The label of this signature information.
List<SignatureInformation.ParameterInformation>	getParameters() The parameters of this signature.
boolean	isActive() Returns true if the signature is active.

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 signature information.

Since:

1.20

getParameters

@NonNull
public List<SignatureInformation.ParameterInformation> getParameters()

The parameters of this signature.

Since:

1.20

isActive

public boolean isActive()

Returns true if the signature is active.

Since:

1.20

getDocumentation

@CheckForNull
public String getDocumentation()

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

Since:

1.20

collect

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

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

// Compute and collect signature information for a document at a given offset
SignatureInformation.collect(doc, offset, null, signature -> {

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

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

    // check if the signature is active
    assertTrue(signature.isActive());

    // getting signature 'parameters'
    List<SignatureInformation.ParameterInformation> params = signature.getParameters();
    // check number of parameters
    assertEquals(2, params.size());
    for (int i = 0; i < params.size(); i++) {
        SignatureInformation.ParameterInformation param = params.get(i);
        // getting parameter 'label'
        String paramLabel = param.getLabel();
        assertEquals("param" + i, paramLabel);
        // check if the parameter is active
        if (i == 1) {
            assertTrue(param.isActive());
        } else {
            assertFalse(param.isActive());
        }
        // getting optional parameter 'documentation'
        String paramDocumentation = param.getDocumentation();
        assertEquals("param" + i + " documentation", paramDocumentation);
    }

    // getting optional signature 'documentation'
    String documentation = signature.getDocumentation();
    assertEquals("documentation", documentation);
});

Parameters:

doc - a text document

offset - an offset inside the text document

context - an optional signature help context

consumer - an operation accepting collected signature information

Since:

1.20