Top Description Inners Fields Methods
com.vladsch.flexmark.util.sequence

public Interface BasedOptionsHolder

Known Direct Subinterfaces
com.vladsch.flexmark.util.sequence.BasedSequence
Known Direct Implementers
com.vladsch.flexmark.util.sequence.BasedOptionsSequence
Imports
com.vladsch.flexmark.util.data.DataHolder, .DataKeyBase, .NullableDataKey, com.vladsch.flexmark.util.misc.BitFieldSet, com.vladsch.flexmark.util.sequence.builder.SegmentedSequenceStats, org.jetbrains.annotations.Nullable
Implemented by BasedOptionsSequence, use instance of it to pass to BasedSequence#of(CharSequence) and options enabled in it will be accessible to all based sequences or uses of these for testing for options or getting options.

Only works with SubSequence base not CharArraySequence

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
BasedOptionsHolder.Options

Field Summary

Modifier and TypeField and Description
public static final int
F_APPLICATION_OPTIONS

public static final int
F_COLLECT_FIRST256_STATS

public static final int
F_COLLECT_SEGMENTED_STATS

public static final int
F_FULL_SEGMENTED_SEQUENCES

public static final int
F_LIBRARY_OPTIONS

public static final int
F_NO_ANCHORS

public static final int
F_TREE_SEGMENTED_SEQUENCES

public static final BasedOptionsHolder.Options
O_COLLECT_FIRST256_STATS

public static final BasedOptionsHolder.Options
O_COLLECT_SEGMENTED_STATS

public static final BasedOptionsHolder.Options
O_FULL_SEGMENTED_SEQUENCES

public static final BasedOptionsHolder.Options
O_NO_ANCHORS

public static final BasedOptionsHolder.Options
O_TREE_SEGMENTED_SEQUENCES

public static final NullableDataKey<SegmentedSequenceStats>
SEGMENTED_STATS

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if all option flags passed are set for this sequence
allOptions(int
option flags
options)

Options test for options for this sequence

default reports true for global default options (if any) , variation available on BasedSequenceWithOptions

public boolean

Returns:

true if any option flags passed are set for this sequence
anyOptions(int
option flags
options)

Options test for options for this sequence

default reports true for global default options (if any) , variation available on BasedSequenceWithOptions

public <
type of value held by key
T> T

Returns:

true if data key is available
getOption(DataKeyBase<T>
in options
dataKey)

Options holder, default has none, only available on BasedSequenceWithOptions

public int

Returns:

option flags for this sequence
getOptionFlags()

Options test for options for this sequence

default reports true for global default options (if any) , variation available on BasedSequenceWithOptions

public @Nullable DataHolder

Returns:

data holder with options or null if none for this sequence
getOptions()

Options holder, default has none, only available on BasedSequenceWithOptions

public static String
optionsToString(int options)

Field Detail

F_APPLICATION_OPTIONSback to summary
public static final int F_APPLICATION_OPTIONS
F_COLLECT_FIRST256_STATSback to summary
public static final int F_COLLECT_FIRST256_STATS
F_COLLECT_SEGMENTED_STATSback to summary
public static final int F_COLLECT_SEGMENTED_STATS
F_FULL_SEGMENTED_SEQUENCESback to summary
public static final int F_FULL_SEGMENTED_SEQUENCES
F_LIBRARY_OPTIONSback to summary
public static final int F_LIBRARY_OPTIONS
F_NO_ANCHORSback to summary
public static final int F_NO_ANCHORS
F_TREE_SEGMENTED_SEQUENCESback to summary
public static final int F_TREE_SEGMENTED_SEQUENCES
O_COLLECT_FIRST256_STATSback to summary
public static final BasedOptionsHolder.Options O_COLLECT_FIRST256_STATS
O_COLLECT_SEGMENTED_STATSback to summary
public static final BasedOptionsHolder.Options O_COLLECT_SEGMENTED_STATS
O_FULL_SEGMENTED_SEQUENCESback to summary
public static final BasedOptionsHolder.Options O_FULL_SEGMENTED_SEQUENCES
O_NO_ANCHORSback to summary
public static final BasedOptionsHolder.Options O_NO_ANCHORS
O_TREE_SEGMENTED_SEQUENCESback to summary
public static final BasedOptionsHolder.Options O_TREE_SEGMENTED_SEQUENCES
SEGMENTED_STATSback to summary
public static final NullableDataKey<SegmentedSequenceStats> SEGMENTED_STATS

Method Detail

allOptionsback to summary
public boolean allOptions(int options)

Options test for options for this sequence

default reports true for global default options (if any) , variation available on BasedSequenceWithOptions

Parameters
options:int

option flags

Returns:boolean

true if all option flags passed are set for this sequence

anyOptionsback to summary
public boolean anyOptions(int options)

Options test for options for this sequence

default reports true for global default options (if any) , variation available on BasedSequenceWithOptions

Parameters
options:int

option flags

Returns:boolean

true if any option flags passed are set for this sequence

getOptionback to summary
public <T> T getOption(DataKeyBase<T> dataKey)

Options holder, default has none, only available on BasedSequenceWithOptions

Parameters
<T>
type of value held by key
dataKey:DataKeyBase<T>

in options

Returns:T

true if data key is available

Annotations
@Nullable
getOptionFlagsback to summary
public int getOptionFlags()

Options test for options for this sequence

default reports true for global default options (if any) , variation available on BasedSequenceWithOptions

Returns:int

option flags for this sequence

getOptionsback to summary
public @Nullable DataHolder getOptions()

Options holder, default has none, only available on BasedSequenceWithOptions

Returns:@Nullable DataHolder

data holder with options or null if none for this sequence

Annotations
@Nullable
optionsToStringback to summary
public static String optionsToString(int options)
com.vladsch.flexmark.util.sequence back to summary

public final Enum BasedOptionsHolder.Options

extends Enum<BasedOptionsHolder.Options>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final BasedOptionsHolder.Options
COLLECT_FIRST256_STATS

public static final BasedOptionsHolder.Options
COLLECT_SEGMENTED_STATS

public static final BasedOptionsHolder.Options
FULL_SEGMENTED_SEQUENCES

public static final BasedOptionsHolder.Options
NO_ANCHORS

public static final BasedOptionsHolder.Options
TREE_SEGMENTED_SEQUENCES

Constructor Summary

AccessConstructor and Description
private
Options()

Method Summary

Modifier and TypeMethod and Description
public static BasedOptionsHolder.Options
valueOf(String name)

public static BasedOptionsHolder.Options[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

COLLECT_FIRST256_STATSback to summary
public static final BasedOptionsHolder.Options COLLECT_FIRST256_STATS
COLLECT_SEGMENTED_STATSback to summary
public static final BasedOptionsHolder.Options COLLECT_SEGMENTED_STATS
FULL_SEGMENTED_SEQUENCESback to summary
public static final BasedOptionsHolder.Options FULL_SEGMENTED_SEQUENCES
NO_ANCHORSback to summary
public static final BasedOptionsHolder.Options NO_ANCHORS
TREE_SEGMENTED_SEQUENCESback to summary
public static final BasedOptionsHolder.Options TREE_SEGMENTED_SEQUENCES

Constructor Detail

Optionsback to summary
private Options()

Method Detail

valueOfback to summary
public static BasedOptionsHolder.Options valueOf(String name)
valuesback to summary
public static BasedOptionsHolder.Options[] values()