Module org.kohsuke.github.api

Package org.kohsuke.github

Enum MarkdownMode

java.lang.Object

java.lang.Enum<MarkdownMode>

org.kohsuke.github.MarkdownMode

All Implemented Interfaces:

Serializable, Comparable<MarkdownMode>

public enum MarkdownMode
extends Enum<MarkdownMode>

Rendering mode of markdown.

Author:

Kohsuke Kawaguchi

See Also:

• GitHub#renderMarkdown(String)
• GHRepository#renderMarkdown(String, MarkdownMode)

Enum Constant Summary

Enum Constants

Enum Constant	Description
GFM	Render a document as user-content, e.g. like user comments or issues are rendered.
MARKDOWN	Render a document as plain Markdown, just like README files are rendered.

Method Summary

Modifier and Type	Method	Description
String	toString()	To string.
static MarkdownMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MarkdownMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MARKDOWN

public static final MarkdownMode MARKDOWN

Render a document as plain Markdown, just like README files are rendered.

GFM

public static final MarkdownMode GFM

Render a document as user-content, e.g. like user comments or issues are rendered. In GFM mode, hard line breaks are always taken into account, and issue and user mentions are linked accordingly.

See Also:

• GHRepository.renderMarkdown(String, MarkdownMode)

Method Details

values

public static MarkdownMode[] values()

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

Returns:

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

valueOf

public static MarkdownMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

To string.

Overrides:

toString in class Enum<MarkdownMode>

Returns:

the string