DocumentLink

java.lang.Object

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

org.graalvm.tools.lsp.server.types.DocumentLink

public class DocumentLink extends JSONBase

A document link is a range in a text document that links to an internal or external resource, like another text document or a web site.

Method Summary

Modifier and Type

Method

Description

static DocumentLink

create(Range range, String target, Object data)

Creates a new DocumentLink literal.

boolean

equals(Object obj)

Object

getData()

A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.

Range

getRange()

The range this link applies to.

String

getTarget()

The uri this link points to.

String

getTooltip()

The tooltip text when you hover over this link.

int

hashCode()

DocumentLink

setData(Object data)

DocumentLink

setRange(Range range)

DocumentLink

setTarget(String target)

DocumentLink

setTooltip(String tooltip)

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

Method Details
- getRange
  
  public Range getRange()
  
  The range this link applies to.
- setRange
  
  public DocumentLink setRange(Range range)
- getTarget
  
  public String getTarget()
  
  The uri this link points to.
- setTarget
  
  public DocumentLink setTarget(String target)
- getTooltip
  
  public String getTooltip()
  
  The tooltip text when you hover over this link. If a tooltip is provided, is will be displayed in a string that includes instructions on how to trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS, user settings, and localization.
  
  Since:
  
  3.15.0
- setTooltip
  
  public DocumentLink setTooltip(String tooltip)
- getData
  
  public Object getData()
  
  A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.
- setData
  
  public DocumentLink setData(Object data)
- equals
  
  public boolean equals(Object obj)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- create
  
  public static DocumentLink create(Range range, String target, Object data)
  
  Creates a new DocumentLink literal.