Package com.vladsch.flexmark.util.sequence

Class PrefixedSubSequence

java.lang.Object

com.vladsch.flexmark.util.sequence.IRichSequenceBase<BasedSequence>

com.vladsch.flexmark.util.sequence.BasedSequenceImpl

com.vladsch.flexmark.util.sequence.PrefixedSubSequence

All Implemented Interfaces:

BasedOptionsHolder, BasedSequence, IRichSequence<BasedSequence>, ReplacedBasedSequence, SequenceUtils, CharSequence, Comparable<CharSequence>

public final class PrefixedSubSequence
extends BasedSequenceImpl
implements ReplacedBasedSequence

A BasedSequence with an out of scope of original char sequence prefix

a subSequence() returns a sub-sequence from the original base sequence, possibly with a prefix if it falls in range

Nested Class Summary

Nested classes/interfaces inherited from interface com.vladsch.flexmark.util.sequence.BasedOptionsHolder

BasedOptionsHolder.Options

Nested classes/interfaces inherited from interface com.vladsch.flexmark.util.sequence.BasedSequence

BasedSequence.EmptyBasedSequence

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

Fields inherited from interface com.vladsch.flexmark.util.sequence.BasedSequence

EMPTY, EMPTY_ARRAY, EMPTY_LIST, EMPTY_SEGMENTS, EOL, LINE_SEP, NULL, SPACE

Fields inherited from interface com.vladsch.flexmark.util.sequence.SequenceUtils

ANY_EOL, ANY_EOL_SET, BACKSLASH_SET, DECIMAL_DIGITS, EMPTY_INDICES, ENC_NUL, EOL, EOL_CHAR, EOL_CHAR1, EOL_CHAR2, EOL_CHARS, EOL_SET, HASH_SET, HEXADECIMAL_DIGITS, LINE_SEP, LS, LSEP, NBSP, NBSP_CHARS, NUL, OCTAL_DIGITS, SPACE, SPACE_EOL, SPACE_EOL_SET, SPACE_SET, SPACE_TAB, SPACE_TAB_EOL_SET, SPACE_TAB_NBSP_SET, SPACE_TAB_SET, SPC, SPLIT_INCLUDE_DELIM_PARTS, SPLIT_INCLUDE_DELIMS, SPLIT_SKIP_EMPTY, SPLIT_TRIM_PARTS, SPLIT_TRIM_SKIP_EMPTY, TAB_SET, US, US_CHARS, US_SET, visibleSpacesMap, WHITESPACE, WHITESPACE_CHARS, WHITESPACE_NBSP, WHITESPACE_NBSP_CHARS, WHITESPACE_NBSP_SET, WHITESPACE_NO_EOL_CHARS, WHITESPACE_SET

Method Summary

Modifier and Type	Method	Description
void	addSegments(@NotNull IBasedSegmentBuilder<?> builder)	Add segments for this sequence, replacing out of base characters with strings
boolean	allOptions(int options)	Options test for options for this sequence
boolean	anyOptions(int options)	Options test for options for this sequence
@NotNull BasedSequence	baseSubSequence(int startIndex, int endIndex)	Get a portion of this sequence's base sequence
char	charAt(int index)
@NotNull Object	getBase()	Get the underlying object on which this sequence contents are based
@NotNull BasedSequence	getBaseSequence()	Get the base sequence for the text
int	getEndOffset()	Get the end offset of this sequence into BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source.
int	getIndexOffset(int index)	Get the offset of index in this sequence mapped to offset into BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source.
<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
@NotNull Range	getSourceRange()	Get the range of this sequence in original BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source.
int	getStartOffset()	Get the start offset of this sequence into BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source.
int	length()
static PrefixedSubSequence	of(CharSequence prefix, BasedSequence baseSeq)	Deprecated.
static PrefixedSubSequence	of(CharSequence prefix, BasedSequence baseSeq, int startIndex)	Deprecated.
static PrefixedSubSequence	of(CharSequence prefix, BasedSequence baseSeq, int startIndex, int endIndex)	Deprecated.
static PrefixedSubSequence	prefixOf(CharSequence prefix, BasedSequence baseSeq)
static PrefixedSubSequence	prefixOf(CharSequence prefix, BasedSequence baseSeq, int startIndex)
static PrefixedSubSequence	prefixOf(CharSequence prefix, BasedSequence baseSeq, int startIndex, int endIndex)
static PrefixedSubSequence	repeatOf(char prefix, int count, BasedSequence baseSeq)
static PrefixedSubSequence	repeatOf(CharSequence prefix, int count, BasedSequence baseSeq)
@NotNull BasedSequence	subSequence(int startIndex, int endIndex)	Get a portion of this sequence
@NotNull String	toString()

Methods inherited from class com.vladsch.flexmark.util.sequence.BasedSequenceImpl

baseColumnAtEnd, baseColumnAtIndex, baseColumnAtStart, baseEndOfLine, baseEndOfLine, baseEndOfLineAnyEOL, baseEndOfLineAnyEOL, baseLineColumnAtEnd, baseLineColumnAtIndex, baseLineColumnAtStart, baseLineRangeAtEnd, baseLineRangeAtIndex, baseLineRangeAtStart, baseStartOfLine, baseStartOfLine, baseStartOfLineAnyEOL, baseStartOfLineAnyEOL, baseSubSequence, containsAllOf, containsOnlyIn, containsOnlyNotIn, containsSomeIn, containsSomeNotIn, containsSomeOf, emptyArray, extendByAny, extendByAny, extendByAnyNot, extendByAnyNot, extendByOneOfAny, extendByOneOfAnyNot, extendToEndOfLine, extendToEndOfLine, extendToEndOfLine, extendToEndOfLine, extendToStartOfLine, extendToStartOfLine, extendToStartOfLine, extendToStartOfLine, firstNonNull, getBuilder, getEmptyPrefix, getEmptySuffix, getSegmentTree, intersect, isBaseCharAt, isContinuationOf, isContinuedBy, normalizeEndWithEOL, normalizeEOL, nullSequence, prefixOf, prefixWith, prefixWithIndent, prefixWithIndent, safeBaseCharAt, safeCharAt, sequenceOf, spliceAtEnd, suffixOf, toMapped, toStringOrNull, unescape, unescape, unescapeNoEntities

Methods inherited from class com.vladsch.flexmark.util.sequence.IRichSequenceBase

append, append, appendEOL, appendRangesTo, appendRangesTo, appendRangesTo, appendRangesTo, appendSpace, appendSpaces, appendTo, appendTo, appendTo, appendTo, appendTo, appendTo, blankLinesRemovedRanges, blankLinesRemovedRanges, blankLinesRemovedRanges, blankLinesRemovedRanges, columnAtIndex, compareTo, countLeading, countLeading, countLeading, countLeadingColumns, countLeadingNot, countLeadingNot, countLeadingNot, countLeadingNotSpace, countLeadingNotSpace, countLeadingNotSpace, countLeadingNotSpaceTab, countLeadingNotSpaceTab, countLeadingNotSpaceTab, countLeadingNotWhitespace, countLeadingNotWhitespace, countLeadingNotWhitespace, countLeadingSpace, countLeadingSpace, countLeadingSpace, countLeadingSpaceTab, countLeadingSpaceTab, countLeadingSpaceTab, countLeadingWhitespace, countLeadingWhitespace, countLeadingWhitespace, countOfAny, countOfAny, countOfAny, countOfAnyNot, countOfAnyNot, countOfAnyNot, countOfNotSpaceTab, countOfNotWhitespace, countOfSpaceTab, countOfWhitespace, countTrailing, countTrailing, countTrailing, countTrailingNot, countTrailingNot, countTrailingNot, countTrailingNotSpace, countTrailingNotSpace, countTrailingNotSpace, countTrailingNotSpaceTab, countTrailingNotSpaceTab, countTrailingNotSpaceTab, countTrailingNotWhitespace, countTrailingNotWhitespace, countTrailingNotWhitespace, countTrailingSpace, countTrailingSpace, countTrailingSpace, countTrailingSpaceTab, countTrailingSpaceTab, countTrailingSpaceTab, countTrailingWhitespace, countTrailingWhitespace, countTrailingWhitespace, delete, endCharAt, endOfDelimitedBy, endOfDelimitedByAny, endOfDelimitedByAnyNot, endOfLine, endOfLineAnyEOL, endSequence, endSequence, endsWith, endsWith, endsWith, endsWithAnyEOL, endsWithEOL, endsWithIgnoreCase, endsWithSpace, endsWithSpaceTab, endsWithWhitespace, eolEndLength, eolEndLength, eolEndRange, eolStartLength, eolStartRange, equals, equals, equalsIgnoreCase, extractRanges, extractRanges, firstChar, hashCode, ifNull, ifNullEmptyAfter, ifNullEmptyBefore, indexOf, indexOf, indexOf, indexOf, indexOf, indexOf, indexOfAll, indexOfAny, indexOfAny, indexOfAny, indexOfAnyNot, indexOfAnyNot, indexOfAnyNot, indexOfNot, indexOfNot, indexOfNot, insert, isBlank, isCharAt, isEmpty, isIn, isIn, isNotBlank, isNotEmpty, isNotNull, isNull, lastChar, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOfAny, lastIndexOfAny, lastIndexOfAny, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfNot, lastIndexOfNot, lastIndexOfNot, leadingBlankLinesRange, leadingBlankLinesRange, leadingBlankLinesRange, leadingBlankLinesRange, lineAt, lineAtAnyEOL, lineColumnAtIndex, lineRangeAt, lineRangeAtAnyEOL, matchChars, matchChars, matchChars, matchChars, matchCharsIgnoreCase, matchCharsIgnoreCase, matchCharsReversed, matchCharsReversed, matchCharsReversedIgnoreCase, matchedCharCount, matchedCharCount, matchedCharCount, matchedCharCount, matchedCharCount, matchedCharCountIgnoreCase, matchedCharCountIgnoreCase, matchedCharCountReversed, matchedCharCountReversed, matchedCharCountReversed, matchedCharCountReversed, matchedCharCountReversedIgnoreCase, matchedCharCountReversedIgnoreCase, matches, matches, matchesIgnoreCase, midCharAt, midSequence, midSequence, normalizeEndWithEOL, normalizeEOL, nullIf, nullIf, nullIf, nullIf, nullIfBlank, nullIfEmpty, nullIfEndsWith, nullIfEndsWith, nullIfEndsWithIgnoreCase, nullIfNot, nullIfNot, nullIfNot, nullIfNotEndsWith, nullIfNotEndsWith, nullIfNotEndsWithIgnoreCase, nullIfNotStartsWith, nullIfNotStartsWith, nullIfNotStartsWithIgnoreCase, nullIfStartsWith, nullIfStartsWith, nullIfStartsWithIgnoreCase, padding, padding, padEnd, padEnd, padStart, padStart, prefixOnceWith, prefixOnceWithEOL, prefixOnceWithSpace, prefixWithEOL, prefixWithSpace, prefixWithSpaces, removePrefix, removePrefix, removePrefixIgnoreCase, removeProperPrefix, removeProperPrefix, removeProperPrefixIgnoreCase, removeProperSuffix, removeProperSuffix, removeProperSuffixIgnoreCase, removeSuffix, removeSuffix, removeSuffixIgnoreCase, replace, replace, safeSubSequence, safeSubSequence, sequenceOf, sequenceOf, split, split, split, split, split, splitEOL, splitEOL, splitList, splitList, splitList, splitList, splitList, splitListEOL, splitListEOL, splitListEOL, startOfDelimitedBy, startOfDelimitedByAny, startOfDelimitedByAnyNot, startOfLine, startOfLineAnyEOL, startsWith, startsWith, startsWith, startsWithAnyEOL, startsWithEOL, startsWithIgnoreCase, startsWithSpace, startsWithSpaceTab, startsWithWhitespace, subSequence, subSequence, subSequenceAfter, subSequenceBefore, subSequenceBeforeAfter, suffixOnceWith, suffixOnceWithEOL, suffixOnceWithSpace, suffixWith, suffixWithEOL, suffixWithSpace, suffixWithSpaces, toLowerCase, toNbSp, toSpc, toUpperCase, toVisibleWhitespaceString, trailingBlankLinesRange, trailingBlankLinesRange, trailingBlankLinesRange, trailingBlankLinesRange, trim, trim, trim, trim, trimEnd, trimEnd, trimEnd, trimEnd, trimEndRange, trimEndRange, trimEndRange, trimEndRange, trimEOL, trimLeadBlankLines, trimmed, trimmed, trimmed, trimmed, trimmedEnd, trimmedEnd, trimmedEnd, trimmedEnd, trimmedEOL, trimmedStart, trimmedStart, trimmedStart, trimmedStart, trimRange, trimRange, trimRange, trimRange, trimStart, trimStart, trimStart, trimStart, trimStartRange, trimStartRange, trimStartRange, trimStartRange, trimTailBlankLines, trimToEndOfLine, trimToEndOfLine, trimToEndOfLine, trimToEndOfLine, trimToEndOfLine, trimToStartOfLine, trimToStartOfLine, trimToStartOfLine, trimToStartOfLine, trimToStartOfLine, validateIndex, validateIndexInclusiveEnd, validateStartEnd

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vladsch.flexmark.util.sequence.BasedSequence

baseColumnAtEnd, baseColumnAtIndex, baseColumnAtStart, baseEndOfLine, baseEndOfLine, baseEndOfLineAnyEOL, baseEndOfLineAnyEOL, baseLineColumnAtEnd, baseLineColumnAtIndex, baseLineColumnAtStart, baseLineRangeAtEnd, baseLineRangeAtIndex, baseLineRangeAtStart, baseStartOfLine, baseStartOfLine, baseStartOfLineAnyEOL, baseStartOfLineAnyEOL, baseSubSequence, containsAllOf, containsOnlyIn, containsOnlyNotIn, containsSomeIn, containsSomeNotIn, containsSomeOf, extendByAny, extendByAny, extendByAnyNot, extendByAnyNot, extendByOneOfAny, extendByOneOfAnyNot, extendToAny, extendToAny, extendToEndOfLine, extendToEndOfLine, extendToEndOfLine, extendToEndOfLine, extendToStartOfLine, extendToStartOfLine, extendToStartOfLine, extendToStartOfLine, getBuilder, getEmptyPrefix, getEmptySuffix, getSegmentTree, intersect, isBaseCharAt, isContinuationOf, isContinuedBy, normalizeEndWithEOL, normalizeEOL, prefixOf, prefixWithIndent, prefixWithIndent, safeBaseCharAt, spliceAtEnd, suffixOf, unescape, unescape, unescapeNoEntities

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.vladsch.flexmark.util.sequence.IRichSequence

append, append, appendEOL, appendRangesTo, appendRangesTo, appendRangesTo, appendRangesTo, appendSpace, appendSpaces, appendTo, appendTo, appendTo, appendTo, appendTo, appendTo, blankLinesRemovedRanges, blankLinesRemovedRanges, blankLinesRemovedRanges, blankLinesRemovedRanges, columnAtIndex, countLeading, countLeading, countLeading, countLeading, countLeading, countLeadingColumns, countLeadingNot, countLeadingNot, countLeadingNot, countLeadingNotSpace, countLeadingNotSpace, countLeadingNotSpace, countLeadingNotSpaceTab, countLeadingNotSpaceTab, countLeadingNotSpaceTab, countLeadingNotWhitespace, countLeadingNotWhitespace, countLeadingNotWhitespace, countLeadingSpace, countLeadingSpace, countLeadingSpace, countLeadingSpaceTab, countLeadingSpaceTab, countLeadingSpaceTab, countLeadingWhitespace, countLeadingWhitespace, countLeadingWhitespace, countOf, countOfAny, countOfAny, countOfAny, countOfAnyNot, countOfAnyNot, countOfAnyNot, countOfNotSpaceTab, countOfNotWhitespace, countOfSpaceTab, countOfWhitespace, countTrailing, countTrailing, countTrailing, countTrailing, countTrailingNot, countTrailingNot, countTrailingNot, countTrailingNotSpace, countTrailingNotSpace, countTrailingNotSpace, countTrailingNotSpaceTab, countTrailingNotSpaceTab, countTrailingNotSpaceTab, countTrailingNotWhitespace, countTrailingNotWhitespace, countTrailingNotWhitespace, countTrailingSpace, countTrailingSpace, countTrailingSpace, countTrailingSpaceTab, countTrailingSpaceTab, countTrailingSpaceTab, countTrailingWhitespace, countTrailingWhitespace, countTrailingWhitespace, delete, emptyArray, endCharAt, endOfDelimitedBy, endOfDelimitedByAny, endOfDelimitedByAnyNot, endOfLine, endOfLineAnyEOL, endSequence, endSequence, endsWith, endsWith, endsWith, endsWithAnyEOL, endsWithEOL, endsWithIgnoreCase, endsWithSpace, endsWithSpaceTab, endsWithWhitespace, eolEndLength, eolEndLength, eolEndRange, eolLength, eolStartLength, eolStartLength, eolStartRange, equals, equals, equalsIgnoreCase, extractRanges, extractRanges, firstChar, getColumnAtIndex, getLineColumnAtIndex, hashCode, ifNull, ifNullEmptyAfter, ifNullEmptyBefore, indexOf, indexOf, indexOf, indexOf, indexOf, indexOf, indexOfAll, indexOfAny, indexOfAny, indexOfAny, indexOfAnyNot, indexOfAnyNot, indexOfAnyNot, indexOfNot, indexOfNot, indexOfNot, insert, insert, isBlank, isCharAt, isEmpty, isIn, isIn, isNotBlank, isNotEmpty, isNotNull, isNull, lastChar, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOfAny, lastIndexOfAny, lastIndexOfAny, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfNot, lastIndexOfNot, lastIndexOfNot, leadingBlankLinesRange, leadingBlankLinesRange, leadingBlankLinesRange, leadingBlankLinesRange, lineAt, lineAtAnyEOL, lineColumnAtIndex, lineRangeAt, lineRangeAtAnyEOL, matchChars, matchChars, matchChars, matchChars, matchCharsIgnoreCase, matchCharsIgnoreCase, matchCharsReversed, matchCharsReversed, matchCharsReversedIgnoreCase, matchedCharCount, matchedCharCount, matchedCharCount, matchedCharCount, matchedCharCount, matchedCharCountIgnoreCase, matchedCharCountIgnoreCase, matchedCharCountReversed, matchedCharCountReversed, matchedCharCountReversed, matchedCharCountReversed, matchedCharCountReversedIgnoreCase, matchedCharCountReversedIgnoreCase, matches, matches, matchesIgnoreCase, midCharAt, midSequence, midSequence, normalizeEndWithEOL, normalizeEOL, nullIf, nullIf, nullIf, nullIf, nullIfBlank, nullIfEmpty, nullIfEndsWith, nullIfEndsWith, nullIfEndsWithIgnoreCase, nullIfEndsWithNot, nullIfNot, nullIfNot, nullIfNot, nullIfNotEndsWith, nullIfNotEndsWith, nullIfNotEndsWithIgnoreCase, nullIfNotStartsWith, nullIfNotStartsWith, nullIfNotStartsWithIgnoreCase, nullIfStartsWith, nullIfStartsWith, nullIfStartsWithIgnoreCase, nullIfStartsWithNot, nullSequence, padding, padding, padEnd, padEnd, padStart, padStart, prefixOnceWith, prefixOnceWithEOL, prefixOnceWithSpace, prefixWith, prefixWithEOL, prefixWithSpace, prefixWithSpaces, removePrefix, removePrefix, removePrefixIgnoreCase, removeProperPrefix, removeProperPrefix, removeProperPrefixIgnoreCase, removeProperSuffix, removeProperSuffix, removeProperSuffixIgnoreCase, removeSuffix, removeSuffix, removeSuffixIgnoreCase, replace, replace, safeCharAt, safeSubSequence, safeSubSequence, sequenceOf, sequenceOf, sequenceOf, split, split, split, split, split, split, split, split, splitEOL, splitEOL, splitList, splitList, splitList, splitList, splitList, splitListEOL, splitListEOL, splitListEOL, startOfDelimitedBy, startOfDelimitedByAny, startOfDelimitedByAnyNot, startOfLine, startOfLineAnyEOL, startsWith, startsWith, startsWith, startsWithAnyEOL, startsWithEOL, startsWithIgnoreCase, startsWithSpace, startsWithSpaceTab, startsWithWhitespace, subSequence, subSequence, subSequenceAfter, subSequenceBefore, suffixOnceWith, suffixOnceWithEOL, suffixOnceWithSpace, suffixWith, suffixWithEOL, suffixWithSpace, suffixWithSpaces, toLowerCase, toMapped, toNbSp, toSpc, toStringOrNull, toUpperCase, toVisibleWhitespaceString, trailingBlankLinesRange, trailingBlankLinesRange, trailingBlankLinesRange, trailingBlankLinesRange, trim, trim, trim, trim, trimEnd, trimEnd, trimEnd, trimEnd, trimEndRange, trimEndRange, trimEndRange, trimEndRange, trimEOL, trimLeadBlankLines, trimmed, trimmed, trimmed, trimmed, trimmedEnd, trimmedEnd, trimmedEnd, trimmedEnd, trimmedEOL, trimmedStart, trimmedStart, trimmedStart, trimmedStart, trimRange, trimRange, trimRange, trimRange, trimStart, trimStart, trimStart, trimStart, trimStartRange, trimStartRange, trimStartRange, trimStartRange, trimTailBlankLines, trimToEndOfLine, trimToEndOfLine, trimToEndOfLine, trimToEndOfLine, trimToEndOfLine, trimToStartOfLine, trimToStartOfLine, trimToStartOfLine, trimToStartOfLine, trimToStartOfLine

Method Detail

getBase

@NotNull
public @NotNull Object getBase()

Description copied from interface: BasedSequence

Get the underlying object on which this sequence contents are based

Specified by:

getBase in interface BasedSequence

Returns:

underlying object containing original text

getBaseSequence

@NotNull
public @NotNull BasedSequence getBaseSequence()

Description copied from interface: BasedSequence

Get the base sequence for the text

Specified by:

getBaseSequence in interface BasedSequence

Returns:

base sequence

getStartOffset

public int getStartOffset()

Description copied from interface: BasedSequence

Get the start offset of this sequence into BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source.

Specified by:

getStartOffset in interface BasedSequence

Returns:

start offset in original text

getEndOffset

public int getEndOffset()

Description copied from interface: BasedSequence

Get the end offset of this sequence into BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source.

Specified by:

getEndOffset in interface BasedSequence

Returns:

end offset in original text

getSourceRange

@NotNull
public @NotNull Range getSourceRange()

Description copied from interface: BasedSequence

Get the range of this sequence in original BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source.

Specified by:

getSourceRange in interface BasedSequence

Returns:

Range of start offset and end offset

baseSubSequence

@NotNull
public @NotNull BasedSequence baseSubSequence(int startIndex,
                                              int endIndex)

Description copied from interface: BasedSequence

Get a portion of this sequence's base sequence

NOTE: this means that if this sequence applies modifications to the original sequence then these modifications are NOT be applied to the returned sequence.

NOTE: It should only be implemented in classes which provide base sequences such as CharSubSequence and SubSequence others use inherited implementation of BasedSequenceImpl

Specified by:

baseSubSequence in interface BasedSequence

Overrides:

baseSubSequence in class BasedSequenceImpl

Parameters:

startIndex - offset from 0 of original sequence

endIndex - offset from 0 of original sequence

Returns:

based sequence whose contents reflect the selected portion

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(com.vladsch.flexmark.util.data.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 com.vladsch.flexmark.util.data.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

getIndexOffset

public int getIndexOffset(int index)

Description copied from interface: BasedSequence

Get the offset of index in this sequence mapped to offset into BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source. NOTE: if the character at given index does not equal the corresponding character in the base sequence then this method should return -1 otherwise segmented based sequence will be created for original base character

Specified by:

getIndexOffset in interface BasedSequence

Parameters:

index - index for which to get the offset in original source

Returns:

offset of index of this sequence in original text

addSegments

public void addSegments(@NotNull
                        @NotNull IBasedSegmentBuilder<?> builder)

Description copied from interface: BasedSequence

Add segments for this sequence, replacing out of base characters with strings

Specified by:

addSegments in interface BasedSequence

Overrides:

addSegments in class BasedSequenceImpl

Parameters:

builder - builder

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

@NotNull
public @NotNull BasedSequence subSequence(int startIndex,
                                          int endIndex)

Description copied from interface: BasedSequence

Get a portion of this sequence

Specified by:

subSequence in interface BasedSequence

Specified by:

subSequence in interface CharSequence

Specified by:

subSequence in interface IRichSequence<BasedSequence>

Parameters:

startIndex - offset from startIndex of this sequence

endIndex - offset from startIndex of this sequence

Returns:

based sequence which represents the requested range of this sequence.

toString

@NotNull
public @NotNull String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class IRichSequenceBase<BasedSequence>

repeatOf

public static PrefixedSubSequence repeatOf(CharSequence prefix,
                                           int count,
                                           BasedSequence baseSeq)

repeatOf

public static PrefixedSubSequence repeatOf(char prefix,
                                           int count,
                                           BasedSequence baseSeq)

prefixOf

public static PrefixedSubSequence prefixOf(CharSequence prefix,
                                           BasedSequence baseSeq)

prefixOf

public static PrefixedSubSequence prefixOf(CharSequence prefix,
                                           BasedSequence baseSeq,
                                           int startIndex)

prefixOf

public static PrefixedSubSequence prefixOf(CharSequence prefix,
                                           BasedSequence baseSeq,
                                           int startIndex,
                                           int endIndex)

of

@Deprecated
public static PrefixedSubSequence of(CharSequence prefix,
                                     BasedSequence baseSeq)

Deprecated.

of

@Deprecated
public static PrefixedSubSequence of(CharSequence prefix,
                                     BasedSequence baseSeq,
                                     int startIndex)

Deprecated.

of

@Deprecated
public static PrefixedSubSequence of(CharSequence prefix,
                                     BasedSequence baseSeq,
                                     int startIndex,
                                     int endIndex)

Deprecated.