org.netbeans.api.lsp

Class SignatureInformation.ParameterInformation

java.lang.Object

org.netbeans.api.lsp.SignatureInformation.ParameterInformation

Enclosing class:

SignatureInformation

public static final class SignatureInformation.ParameterInformation
extends Object

Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.

Since:

1.20

Method Summary

Modifier and Type	Method and Description
String	getDocumentation() A human-readable string that represents a doc-comment.
String	getLabel() The label of this parameter information.
boolean	isActive() Returns true if the parameter 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 parameter information.

Note: a label should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the SignatureInformation.label.

Since:

1.20

isActive

public boolean isActive()

Returns true if the parameter 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