Package com.vladsch.flexmark.util.sequence

Class BasedOptionsSequence

java.lang.Object

com.vladsch.flexmark.util.sequence.BasedOptionsSequence

All Implemented Interfaces:

BasedOptionsHolder, java.lang.CharSequence

public final class BasedOptionsSequence
extends java.lang.Object
implements java.lang.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 com.vladsch.flexmark.util.sequence.BasedOptionsHolder

BasedOptionsHolder.Options

Field Summary

Fields inherited from interface com.vladsch.flexmark.util.sequence.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

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)
java.util.stream.IntStream	chars()
java.util.stream.IntStream	codePoints()
boolean	equals(java.lang.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
DataHolder	getOptions()	Options holder, default has none, only available on BasedSequenceWithOptions
int	hashCode()
int	length()
static BasedOptionsSequence	of(java.lang.CharSequence chars, int optionFlags)
static BasedOptionsSequence	of(java.lang.CharSequence chars, int optionFlags, DataHolder options)
static BasedOptionsSequence	of(java.lang.CharSequence chars, BitFieldSet<BasedOptionsHolder.Options> optionFlags)
static BasedOptionsSequence	of(java.lang.CharSequence chars, BitFieldSet<BasedOptionsHolder.Options> optionFlags, DataHolder options)
java.lang.CharSequence	subSequence(int start, int end)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

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 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 java.lang.CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface java.lang.CharSequence

subSequence

public java.lang.CharSequence subSequence(int start,
                                          int end)

Specified by:

subSequence in interface java.lang.CharSequence

toString

public java.lang.String toString()

Specified by:

toString in interface java.lang.CharSequence

Overrides:

toString in class java.lang.Object

chars

public java.util.stream.IntStream chars()

Specified by:

chars in interface java.lang.CharSequence

codePoints

public java.util.stream.IntStream codePoints()

Specified by:

codePoints in interface java.lang.CharSequence

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

of

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

of

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

of

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

of

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