com.overzealous.remark

Enum Options.FencedCodeBlocks

java.lang.Object

java.lang.Enum<Options.FencedCodeBlocks>

com.overzealous.remark.Options.FencedCodeBlocks

All Implemented Interfaces:

Serializable, Comparable<Options.FencedCodeBlocks>

Enclosing class:

Options

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

Provides settings to configure if fenced code blocks are used.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Completely disables fenced code blocks.
ENABLED_BACKTICK Enables fenced code blocks, using multiple '`' as the separator characters.
ENABLED_TILDE Enables fenced code blocks, using multiple '~' as the separator characters.

Method Summary

Modifier and Type	Method and Description
char	getSeparatorCharacter() Returns the separator character to use.
boolean	isEnabled() True if fenced code blocks are enabled
static Options.FencedCodeBlocks	valueOf(String name) Returns the enum constant of this type with the specified name.
static Options.FencedCodeBlocks[]	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

DISABLED

public static final Options.FencedCodeBlocks DISABLED

Completely disables fenced code blocks.

ENABLED_TILDE

public static final Options.FencedCodeBlocks ENABLED_TILDE

Enables fenced code blocks, using multiple '~' as the separator characters.

ENABLED_BACKTICK

public static final Options.FencedCodeBlocks ENABLED_BACKTICK

Enables fenced code blocks, using multiple '`' as the separator characters.

Method Detail

values

public static Options.FencedCodeBlocks[] 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.FencedCodeBlocks c : Options.FencedCodeBlocks.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.FencedCodeBlocks 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

isEnabled

public boolean isEnabled()

True if fenced code blocks are enabled

Returns:

true or false

getSeparatorCharacter

public char getSeparatorCharacter()

Returns the separator character to use.

Returns:

the separator character