Class BasedOptionsSequence

java.lang.Object

com.vladsch.flexmark.util.sequence.BasedOptionsSequence

All Implemented Interfaces:

BasedOptionsHolder, CharSequence

public final class BasedOptionsSequence
extends Object
implements CharSequence, BasedOptionsHolder

A BasedSequence with offset tracking that follows editing operations and subSequence() chopping as best as it can

a subSequence() returns a sub-sequence from the original base sequence with updated offset tracking

Nested Class Summary

Nested classes/interfaces inherited from interface BasedOptionsHolder

BasedOptionsHolder.Options

Field Summary

Fields

Modifier and Type	Field	Description
private final @NotNull CharSequence	chars
private final int	optionFlags
private final @Nullable DataHolder	options

Fields inherited from interface BasedOptionsHolder

F_APPLICATION_OPTIONS, F_COLLECT_FIRST256_STATS, F_COLLECT_SEGMENTED_STATS, F_FULL_SEGMENTED_SEQUENCES, F_LIBRARY_OPTIONS, F_NO_ANCHORS, F_TREE_SEGMENTED_SEQUENCES, O_COLLECT_FIRST256_STATS, O_COLLECT_SEGMENTED_STATS, O_FULL_SEGMENTED_SEQUENCES, O_NO_ANCHORS, O_TREE_SEGMENTED_SEQUENCES, SEGMENTED_STATS

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BasedOptionsSequence(@NotNull CharSequence chars, int optionFlags, @Nullable DataHolder options)

Method Summary

Modifier and Type	Method	Description
boolean	allOptions(int options)	Options test for options for this sequence
boolean	anyOptions(int options)	Options test for options for this sequence
char	charAt(int index)
IntStream	chars()
IntStream	codePoints()
boolean	equals(Object o)
<T> T	getOption(DataKeyBase<T> dataKey)	Options holder, default has none, only available on BasedSequenceWithOptions
int	getOptionFlags()	Options test for options for this sequence
@Nullable DataHolder	getOptions()	Options holder, default has none, only available on BasedSequenceWithOptions
int	hashCode()
int	length()
static BasedOptionsSequence	of(@NotNull CharSequence chars, int optionFlags)
static BasedOptionsSequence	of(@NotNull CharSequence chars, int optionFlags, @Nullable DataHolder options)
static BasedOptionsSequence	of(@NotNull CharSequence chars, BitFieldSet<BasedOptionsHolder.Options> optionFlags)
static BasedOptionsSequence	of(@NotNull CharSequence chars, BitFieldSet<BasedOptionsHolder.Options> optionFlags, @Nullable DataHolder options)
CharSequence	subSequence(int start, int end)
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface CharSequence

getChars, isEmpty

Field Details

chars

@NotNull
private final @NotNull CharSequence chars

optionFlags

private final int optionFlags

options

@Nullable
private final @Nullable DataHolder options

Constructor Details

BasedOptionsSequence

private BasedOptionsSequence(@NotNull
 @NotNull CharSequence chars,
 int optionFlags,
 @Nullable
 @Nullable DataHolder options)

Method Details

getOptionFlags

public int getOptionFlags()

Description copied from interface: BasedOptionsHolder

Options test for options for this sequence

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

Specified by:

getOptionFlags in interface BasedOptionsHolder

Returns:

option flags for this sequence

allOptions

public boolean allOptions(int options)

Description copied from interface: BasedOptionsHolder

Options test for options for this sequence

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

Specified by:

allOptions in interface BasedOptionsHolder

Parameters:

options - option flags

Returns:

true if all option flags passed are set for this sequence

anyOptions

public boolean anyOptions(int options)

Description copied from interface: BasedOptionsHolder

Options test for options for this sequence

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

Specified by:

anyOptions in interface BasedOptionsHolder

Parameters:

options - option flags

Returns:

true if any option flags passed are set for this sequence

getOption

public <T> T getOption(DataKeyBase<T> dataKey)

Description copied from interface: BasedOptionsHolder

Options holder, default has none, only available on BasedSequenceWithOptions

Specified by:

getOption in interface BasedOptionsHolder

Type Parameters:

T - type of value held by key

Parameters:

dataKey - in options

Returns:

true if data key is available

getOptions

@Nullable
public @Nullable DataHolder getOptions()

Description copied from interface: BasedOptionsHolder

Options holder, default has none, only available on BasedSequenceWithOptions

Specified by:

getOptions in interface BasedOptionsHolder

Returns:

data holder with options or null if none for this sequence

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
 int end)

Specified by:

subSequence in interface CharSequence

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

chars

public IntStream chars()

Specified by:

chars in interface CharSequence

codePoints

public IntStream codePoints()

Specified by:

codePoints in interface CharSequence

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

of

public static BasedOptionsSequence of(@NotNull
 @NotNull CharSequence chars,
 BitFieldSet<BasedOptionsHolder.Options> optionFlags)

of

public static BasedOptionsSequence of(@NotNull
 @NotNull CharSequence chars,
 int optionFlags)

of

public static BasedOptionsSequence of(@NotNull
 @NotNull CharSequence chars,
 BitFieldSet<BasedOptionsHolder.Options> optionFlags,
 @Nullable
 @Nullable DataHolder options)

of

public static BasedOptionsSequence of(@NotNull
 @NotNull CharSequence chars,
 int optionFlags,
 @Nullable
 @Nullable DataHolder options)