ParameterInformation

java.lang.Object

org.graalvm.tools.lsp.server.types.JSONBase

org.graalvm.tools.lsp.server.types.ParameterInformation

public class ParameterInformation extends JSONBase

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

Method Summary

Modifier and Type

Method

Description

static ParameterInformation

create(Object label, String documentation)

Creates a new parameter information literal.

boolean

equals(Object obj)

Object

getDocumentation()

The human-readable doc-comment of this signature.

Object

getLabel()

The label of this parameter information.

int

hashCode()

ParameterInformation

setDocumentation(Object documentation)

ParameterInformation

setLabel(Object label)

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

Method Details
- getLabel
  
  public Object getLabel()
  
  The label of this parameter information. Either a string or an inclusive start and exclusive end offsets within its containing signature label. (see SignatureInformation.label). The offsets are based on a UTF-16 string representation as `Position` and `Range` does. *Note*: a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
- setLabel
  
  public ParameterInformation setLabel(Object label)
- getDocumentation
  
  public Object getDocumentation()
  
  The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.
- setDocumentation
  
  public ParameterInformation setDocumentation(Object documentation)
- equals
  
  public boolean equals(Object obj)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- create
  
  public static ParameterInformation create(Object label, String documentation)
  
  Creates a new parameter information literal.
  
  Parameters:
  
  label - A label string.
  
  documentation - A doc string.