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

Enum Class InsertTextFormat

java.lang.Object

java.lang.Enum<InsertTextFormat>

org.graalvm.tools.lsp.server.types.InsertTextFormat

All Implemented Interfaces:

Serializable, Comparable<InsertTextFormat>, Constable

public enum InsertTextFormat
extends Enum<InsertTextFormat>

Defines whether the insert text in a completion item should be interpreted as plain text or a snippet.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PlainText	The primary text to be inserted is treated as a plain string.
Snippet	The primary text to be inserted is treated as a snippet.

Method Summary

Modifier and Type	Method	Description
static InsertTextFormat	get(Integer intValue)
int	getIntValue()
static InsertTextFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InsertTextFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PlainText

public static final InsertTextFormat PlainText

The primary text to be inserted is treated as a plain string.

Snippet

public static final InsertTextFormat Snippet

The primary text to be inserted is treated as a snippet. A snippet can define tab stops and placeholders with `$1`, `$2` and `${3:foo}`. `$0` defines the final tab stop, it defaults to the end of the snippet. Placeholders with equal identifiers are linked, that is typing in one will update others too.

See Also:

• https://github.com/Microsoft/vscode/blob/master/src/vs/editor/contrib/snippet/common/ snippet.md

Method Details

values

public static InsertTextFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static InsertTextFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getIntValue

public int getIntValue()

get

public static InsertTextFormat get(Integer intValue)