Package org.apache.juneau.marshall.markdown

Enum Class MarkdownFormat

java.lang.Object

java.lang.Enum<MarkdownFormat>

org.apache.juneau.marshall.markdown.MarkdownFormat

All Implemented Interfaces:

Serializable, Comparable<MarkdownFormat>, Constable

public enum MarkdownFormat
extends Enum<MarkdownFormat>

Rendering format for Markdown serialization.

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
CODE	Render as a fenced code block.
DEFAULT	Auto-detect: tables for beans/maps, bulleted list for simple-value collections.
JSON5	Render as inline JSON5 wrapped in backticks.
LIST	Force bulleted list rendering even for beans/maps.
PLAIN_TEXT	Render using Object.toString().
TABLE	Force table rendering even for collections.

Method Summary

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

DEFAULT

public static final MarkdownFormat DEFAULT

Auto-detect: tables for beans/maps, bulleted list for simple-value collections.

TABLE

public static final MarkdownFormat TABLE

Force table rendering even for collections.

LIST

public static final MarkdownFormat LIST

Force bulleted list rendering even for beans/maps.

CODE

public static final MarkdownFormat CODE

Render as a fenced code block.

PLAIN_TEXT

public static final MarkdownFormat PLAIN_TEXT

Render using Object.toString().

JSON5

public static final MarkdownFormat JSON5

Render as inline JSON5 wrapped in backticks.

Method Details

values

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