Enum TocOptionTypes
- java.lang.Object
-
- java.lang.Enum<TocOptionTypes>
-
- com.vladsch.flexmark.ext.toc.internal.TocOptionTypes
-
- All Implemented Interfaces:
OptionParser<TocOptions>
,java.io.Serializable
,java.lang.Comparable<TocOptionTypes>
public enum TocOptionTypes extends java.lang.Enum<TocOptionTypes> implements OptionParser<TocOptions>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BULLETS
FLAT
FLAT_REVERSED
FORMATTED
HIERARCHY
LEVELS
NUMERIC
SORTED
SORTED_REVERSED
TEXT
-
Field Summary
Fields Modifier and Type Field Description static OptionParser<TocOptions>[]
OPTIONS
OptionParser<TocOptions>
parser
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getOptionName()
java.lang.String
getOptionText(TocOptions options, TocOptions defaultOptions)
Pair<TocOptions,java.util.List<ParsedOption<TocOptions>>>
parseOption(BasedSequence optionText, TocOptions options, MessageProvider provider)
static TocOptionTypes
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static TocOptionTypes[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
LEVELS
public static final TocOptionTypes LEVELS
-
BULLETS
public static final TocOptionTypes BULLETS
-
NUMERIC
public static final TocOptionTypes NUMERIC
-
TEXT
public static final TocOptionTypes TEXT
-
FORMATTED
public static final TocOptionTypes FORMATTED
-
HIERARCHY
public static final TocOptionTypes HIERARCHY
-
FLAT
public static final TocOptionTypes FLAT
-
FLAT_REVERSED
public static final TocOptionTypes FLAT_REVERSED
-
SORTED
public static final TocOptionTypes SORTED
-
SORTED_REVERSED
public static final TocOptionTypes SORTED_REVERSED
-
-
Field Detail
-
parser
public final OptionParser<TocOptions> parser
-
OPTIONS
public static final OptionParser<TocOptions>[] OPTIONS
-
-
Method Detail
-
values
public static TocOptionTypes[] 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 (TocOptionTypes c : TocOptionTypes.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TocOptionTypes valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getOptionName
public java.lang.String getOptionName()
- Specified by:
getOptionName
in interfaceOptionParser<TocOptions>
-
parseOption
public Pair<TocOptions,java.util.List<ParsedOption<TocOptions>>> parseOption(BasedSequence optionText, TocOptions options, MessageProvider provider)
- Specified by:
parseOption
in interfaceOptionParser<TocOptions>
-
getOptionText
public java.lang.String getOptionText(TocOptions options, TocOptions defaultOptions)
- Specified by:
getOptionText
in interfaceOptionParser<TocOptions>
-
-