Package org.graalvm.tools.lsp.server.types

Class MarkupContent

java.lang.Object

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

org.graalvm.tools.lsp.server.types.MarkupContent

public class MarkupContent
extends JSONBase

A `MarkupContent` literal represents a string value which content is interpreted base on its kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds. If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting Here is an example how such a string can be constructed using JavaScript / TypeScript: ```ts let markdown: MarkdownContent = { kind: MarkupKind.Markdown, value: [ '# Header', 'Some text', '```typescript', 'someCode();', '```' ].join('\n') }; ``` *Please Note* that clients might sanitize the return markdown. A client could decide to remove HTML from the markdown to avoid script execution.

Method Summary

Modifier and Type	Method	Description
static MarkupContent	create(MarkupKind kind, String value)
boolean	equals(Object obj)
MarkupKind	getKind()	The type of the Markup.
String	getValue()	The content itself.
int	hashCode()
MarkupContent	setKind(MarkupKind kind)
MarkupContent	setValue(String value)

Methods inherited from class java.lang.Object

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

Method Details

getKind

public MarkupKind getKind()

The type of the Markup.

setKind

public MarkupContent setKind(MarkupKind kind)

getValue

public String getValue()

The content itself.

setValue

public MarkupContent setValue(String value)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

create

public static MarkupContent create(MarkupKind kind,
 String value)