com.vladsch.flexmark.util.sequence

Interface BasedOptionsHolder

All Known Subinterfaces:

BasedSequence, ReplacedBasedSequence

All Known Implementing Classes:

BasedOptionsSequence, BasedSequence.EmptyBasedSequence, BasedSequenceImpl, CharSubSequence, MappedBasedSequence, PrefixedSubSequence, SegmentedSequence, SegmentedSequenceFull, SegmentedSequenceTree, SubSequence

public interface BasedOptionsHolder

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 Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BasedOptionsHolder.Options

Field Summary

Fields

Modifier and Type	Field and Description
static int	F_APPLICATION_OPTIONS
static int	F_COLLECT_FIRST256_STATS
static int	F_COLLECT_SEGMENTED_STATS
static int	F_FULL_SEGMENTED_SEQUENCES
static int	F_LIBRARY_OPTIONS
static int	F_NO_ANCHORS
static int	F_TREE_SEGMENTED_SEQUENCES
static BasedOptionsHolder.Options	O_COLLECT_FIRST256_STATS
static BasedOptionsHolder.Options	O_COLLECT_SEGMENTED_STATS
static BasedOptionsHolder.Options	O_FULL_SEGMENTED_SEQUENCES
static BasedOptionsHolder.Options	O_NO_ANCHORS
static BasedOptionsHolder.Options	O_TREE_SEGMENTED_SEQUENCES
static com.vladsch.flexmark.util.data.NullableDataKey<SegmentedSequenceStats>	SEGMENTED_STATS

Method Summary

Modifier and Type	Method and Description
boolean	allOptions(int options) Options test for options for this sequence
boolean	anyOptions(int options) Options test for options for this sequence
<T> T	getOption(com.vladsch.flexmark.util.data.DataKeyBase<T> dataKey) Options holder, default has none, only available on BasedSequenceWithOptions
int	getOptionFlags() Options test for options for this sequence
@Nullable com.vladsch.flexmark.util.data.DataHolder	getOptions() Options holder, default has none, only available on BasedSequenceWithOptions
static String	optionsToString(int options)

Field Detail

O_COLLECT_SEGMENTED_STATS

static final BasedOptionsHolder.Options O_COLLECT_SEGMENTED_STATS

O_COLLECT_FIRST256_STATS

static final BasedOptionsHolder.Options O_COLLECT_FIRST256_STATS

O_NO_ANCHORS

static final BasedOptionsHolder.Options O_NO_ANCHORS

O_FULL_SEGMENTED_SEQUENCES

static final BasedOptionsHolder.Options O_FULL_SEGMENTED_SEQUENCES

O_TREE_SEGMENTED_SEQUENCES

static final BasedOptionsHolder.Options O_TREE_SEGMENTED_SEQUENCES

F_COLLECT_SEGMENTED_STATS

static final int F_COLLECT_SEGMENTED_STATS

F_COLLECT_FIRST256_STATS

static final int F_COLLECT_FIRST256_STATS

F_NO_ANCHORS

static final int F_NO_ANCHORS

F_FULL_SEGMENTED_SEQUENCES

static final int F_FULL_SEGMENTED_SEQUENCES

F_TREE_SEGMENTED_SEQUENCES

static final int F_TREE_SEGMENTED_SEQUENCES

F_LIBRARY_OPTIONS

static final int F_LIBRARY_OPTIONS

See Also:

Constant Field Values

F_APPLICATION_OPTIONS

static final int F_APPLICATION_OPTIONS

See Also:

Constant Field Values

SEGMENTED_STATS

static final com.vladsch.flexmark.util.data.NullableDataKey<SegmentedSequenceStats> SEGMENTED_STATS

Method Detail

optionsToString

static String optionsToString(int options)

getOptionFlags

int getOptionFlags()

Options test for options for this sequence

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

Returns:

option flags for this sequence

allOptions

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 - option flags

Returns:

true if all option flags passed are set for this sequence

anyOptions

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 - option flags

Returns:

true if any option flags passed are set for this sequence

getOption

@Nullable
<T> T getOption(com.vladsch.flexmark.util.data.DataKeyBase<T> dataKey)

Options holder, default has none, only available on BasedSequenceWithOptions

Type Parameters:

T - type of value held by key

Parameters:

dataKey - in options

Returns:

true if data key is available

getOptions

@Nullable
@Nullable com.vladsch.flexmark.util.data.DataHolder getOptions()

Options holder, default has none, only available on BasedSequenceWithOptions

Returns:

data holder with options or null if none for this sequence