Package com.linecorp.armeria.server.docs

Enum Class Markup

java.lang.Object

java.lang.Enum<Markup>

com.linecorp.armeria.server.docs.Markup

All Implemented Interfaces:

Serializable, Comparable<Markup>, java.lang.constant.Constable

@UnstableApi
public enum Markup
extends Enum<Markup>

Supported markup types in Description.

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
MARKDOWN	Markdown.
MERMAID	Mermaid.
NONE	No markup.

Method Summary

Modifier and Type	Method	Description
static Markup	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Markup[]	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

NONE

public static final Markup NONE

No markup.

MARKDOWN

public static final Markup MARKDOWN

Markdown.

MERMAID

public static final Markup MERMAID

Mermaid.

Method Details

values

public static Markup[] 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 Markup 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