com.overzealous.remark

Enum Options.Tables

java.lang.Object

java.lang.Enum<Options.Tables>

com.overzealous.remark.Options.Tables

All Implemented Interfaces:

Serializable, Comparable<Options.Tables>

Enclosing class:

Options

public static enum Options.Tables
extends Enum<Options.Tables>

Provides settings to control how Tables are converted.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONVERT_TO_CODE_BLOCK Convert tables to clean code block (compatible with the original Markdown)
LEAVE_AS_HTML Leave all tables and their contents as raw HTML (the default, as this is the recommended syntax from Markdown)
MARKDOWN_EXTRA Convert tables to the syntax used by PHP Markdown Extra.
MULTI_MARKDOWN Convert tables to the syntax used by MultiMarkdown.
REMOVE Remove all tables and their contents

Method Summary

Modifier and Type	Method and Description
boolean	isColspanEnabled() True if the table is rendered as a MultiMarkdown table with column spanning.
boolean	isConvertedToText() True if the table is to be converted to plain text.
boolean	isLeftAsHtml() True if the table is to be left as raw HTML.
boolean	isRemoved() True if the table is to be fully removed.
boolean	isRenderedAsCode() True if the table should be rendered as a code block
static Options.Tables	valueOf(String name) Returns the enum constant of this type with the specified name.
static Options.Tables[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REMOVE

public static final Options.Tables REMOVE

Remove all tables and their contents

LEAVE_AS_HTML

public static final Options.Tables LEAVE_AS_HTML

Leave all tables and their contents as raw HTML (the default, as this is the recommended syntax from Markdown)

CONVERT_TO_CODE_BLOCK

public static final Options.Tables CONVERT_TO_CODE_BLOCK

Convert tables to clean code block (compatible with the original Markdown)

MARKDOWN_EXTRA

public static final Options.Tables MARKDOWN_EXTRA

Convert tables to the syntax used by PHP Markdown Extra.

See Also:

PHP Markdown Extra Tables

MULTI_MARKDOWN

public static final Options.Tables MULTI_MARKDOWN

Convert tables to the syntax used by MultiMarkdown.

See Also:

MultiMarkdown Tables

Method Detail

values

public static Options.Tables[] 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 (Options.Tables c : Options.Tables.values())
    System.out.println(c);

Returns:

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

valueOf

public static Options.Tables 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

isRemoved

public boolean isRemoved()

True if the table is to be fully removed.

Returns:

true or false

isLeftAsHtml

public boolean isLeftAsHtml()

True if the table is to be left as raw HTML.

Returns:

true or false

isConvertedToText

public boolean isConvertedToText()

True if the table is to be converted to plain text. This is true if the result is a Markdown table or a code block.

Returns:

true or false

isRenderedAsCode

public boolean isRenderedAsCode()

True if the table should be rendered as a code block

Returns:

true or false

isColspanEnabled

public boolean isColspanEnabled()

True if the table is rendered as a MultiMarkdown table with column spanning.

Returns:

true or false