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)
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
toString()
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.
-
-
-
Enum Constant Detail
-
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.
-
-
Method Detail
-
values
public static MarkdownMode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (MarkdownMode c : MarkdownMode.values()) System.out.println(c);
- 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 nameNullPointerException
- if the argument is null
-
toString
public String toString()
- Overrides:
toString
in classEnum<MarkdownMode>
-
-