Enum Class SimTocOptionTypes

java.lang.Object

java.lang.Enum<SimTocOptionTypes>

com.vladsch.flexmark.ext.toc.internal.SimTocOptionTypes

All Implemented Interfaces:

OptionParser<TocOptions>, Serializable, Comparable<SimTocOptionTypes>, Constable

public enum SimTocOptionTypes
extends Enum<SimTocOptionTypes>
implements OptionParser<TocOptions>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SimTocOptionTypes.Constants

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BULLETS
FLAT
FLAT_REVERSED
FORMATTED
HIERARCHY
HTML
LEVELS
MARKDOWN
NUMERIC
SORTED
SORTED_REVERSED
TEXT

Field Summary

Fields

Modifier and Type	Field	Description
static final OptionParser<TocOptions>[]	OPTIONS
final OptionParser<TocOptions>	parser

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SimTocOptionTypes(OptionParser<TocOptions> parser)

Method Summary

Modifier and Type	Method	Description
String	getOptionName()
String	getOptionText(TocOptions options, TocOptions defaultOptions)
Pair<TocOptions, List<ParsedOption<TocOptions>>>	parseOption(BasedSequence optionText, TocOptions options, MessageProvider provider)
static SimTocOptionTypes	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SimTocOptionTypes[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LEVELS

public static final SimTocOptionTypes LEVELS

HTML

public static final SimTocOptionTypes HTML

MARKDOWN

public static final SimTocOptionTypes MARKDOWN

BULLETS

public static final SimTocOptionTypes BULLETS

NUMERIC

public static final SimTocOptionTypes NUMERIC

TEXT

public static final SimTocOptionTypes TEXT

FORMATTED

public static final SimTocOptionTypes FORMATTED

HIERARCHY

public static final SimTocOptionTypes HIERARCHY

FLAT

public static final SimTocOptionTypes FLAT

FLAT_REVERSED

public static final SimTocOptionTypes FLAT_REVERSED

SORTED

public static final SimTocOptionTypes SORTED

SORTED_REVERSED

public static final SimTocOptionTypes SORTED_REVERSED

Field Details

parser

public final OptionParser<TocOptions> parser

OPTIONS

public static final OptionParser<TocOptions>[] OPTIONS

Constructor Details

SimTocOptionTypes

private SimTocOptionTypes(OptionParser<TocOptions> parser)

Method Details

values

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

getOptionName

public String getOptionName()

Specified by:

getOptionName in interface OptionParser<TocOptions>

parseOption

public Pair<TocOptions, List<ParsedOption<TocOptions>>> parseOption(BasedSequence optionText,
 TocOptions options,
 MessageProvider provider)

Specified by:

parseOption in interface OptionParser<TocOptions>

getOptionText

public String getOptionText(TocOptions options,
 TocOptions defaultOptions)

Specified by:

getOptionText in interface OptionParser<TocOptions>