java.lang.Object
- com.vladsch.flexmark.util.sequence.IRichSequenceBase<BasedSequence>
- - com.vladsch.flexmark.util.sequence.BasedSequenceImpl

All Implemented Interfaces:

BasedOptionsHolder, BasedSequence, IRichSequence<BasedSequence>, SequenceUtils, java.lang.CharSequence, java.lang.Comparable<java.lang.CharSequence>

Direct Known Subclasses:

BasedSequence.EmptyBasedSequence, CharSubSequence, MappedBasedSequence, PrefixedSubSequence, SegmentedSequence, SubSequence
```
public abstract class BasedSequenceImpl
extends IRichSequenceBase<BasedSequence>
implements BasedSequence
```
Implementation of BaseSequence

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

Constructor Summary

Constructors
Constructor Description

BasedSequenceImpl(int hash)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addSegments(IBasedSegmentBuilder<?> builder)`	Add segments for this sequence, replacing out of base characters with strings
`int`	`baseColumnAtEnd()`
`int`	`baseColumnAtIndex(int index)`
`int`	`baseColumnAtStart()`
`int`	`baseEndOfLine()`
`int`	`baseEndOfLine(int index)`
`int`	`baseEndOfLineAnyEOL()`
`int`	`baseEndOfLineAnyEOL(int index)`
`Pair<java.lang.Integer,java.lang.Integer>`	`baseLineColumnAtEnd()`
`Pair<java.lang.Integer,java.lang.Integer>`	`baseLineColumnAtIndex(int index)`
`Pair<java.lang.Integer,java.lang.Integer>`	`baseLineColumnAtStart()`
`Range`	`baseLineRangeAtEnd()`
`Range`	`baseLineRangeAtIndex(int index)`
`Range`	`baseLineRangeAtStart()`
`int`	`baseStartOfLine()`
`int`	`baseStartOfLine(int index)`
`int`	`baseStartOfLineAnyEOL()`
`int`	`baseStartOfLineAnyEOL(int index)`
`BasedSequence`	`baseSubSequence(int startIndex)`	Get a portion of the original sequence that this sequence is based on
`BasedSequence`	`baseSubSequence(int startIndex, int endIndex)`	Get a portion of this sequence's base sequence
`boolean`	`containsAllOf(BasedSequence other)`	start/end offset based containment, not textual
`boolean`	`containsOnlyIn(CharPredicate charSet)`	Test for line contains only characters from the set
`boolean`	`containsOnlyNotIn(CharPredicate charSet)`	Test for line containing only characters not in the set
`boolean`	`containsSomeIn(CharPredicate charSet)`	Test for line containing some of the characters in the set
`boolean`	`containsSomeNotIn(CharPredicate charSet)`	Test for line containing some characters not in the set
`boolean`	`containsSomeOf(BasedSequence other)`	start/end offset based containment, not textual
`BasedSequence[]`	`emptyArray()`
`BasedSequence`	`extendByAny(CharPredicate charSet)`
`BasedSequence`	`extendByAny(CharPredicate charSet, int maxCount)`	Extend this based sequence to include characters from underlying based sequence
`BasedSequence`	`extendByAnyNot(CharPredicate charSet)`
`BasedSequence`	`extendByAnyNot(CharPredicate charSet, int maxCount)`	Extend this based sequence to include characters from underlying based sequence not in character set
`BasedSequence`	`extendByOneOfAny(CharPredicate charSet)`
`BasedSequence`	`extendByOneOfAnyNot(CharPredicate charSet)`
`BasedSequence`	`extendToEndOfLine()`
`BasedSequence`	`extendToEndOfLine(boolean includeEol)`
`BasedSequence`	`extendToEndOfLine(CharPredicate eolChars)`
`BasedSequence`	`extendToEndOfLine(CharPredicate eolChars, boolean includeEol)`	Extend in contained based sequence
`BasedSequence`	`extendToStartOfLine()`
`BasedSequence`	`extendToStartOfLine(boolean includeEol)`
`BasedSequence`	`extendToStartOfLine(CharPredicate eolChars)`
`BasedSequence`	`extendToStartOfLine(CharPredicate eolChars, boolean includeEol)`	Extend in contained based sequence
`static BasedSequence`	`firstNonNull(BasedSequence... sequences)`
`SequenceBuilder`	`getBuilder()`	Get a sequence builder for this sequence type
`BasedSequence`	`getEmptyPrefix()`	Get empty prefix to this sequence
`BasedSequence`	`getEmptySuffix()`	Get empty suffix to this sequence
`SegmentTree`	`getSegmentTree()`	Get the segment tree for this sequence or null if sequence is contiguous from startOffset to endOffset
`BasedSequence`	`intersect(BasedSequence other)`	start/end offset based intersection, not textual
`boolean`	`isBaseCharAt(int index, CharPredicate predicate)`	Safe, if index out of range but based sequence has characters will return those, else returns '\0'
`boolean`	`isContinuationOf(BasedSequence other)`	Test if this sequence is a continuation of the given sequence in original source text
`boolean`	`isContinuedBy(BasedSequence other)`	Test if the given sequence is a continuation of this sequence in original source text
`BasedSequence`	`normalizeEndWithEOL(ReplacedTextMapper textMapper)`	replace any \r\n and \r by \n, append terminating EOL if one is not present
`BasedSequence`	`normalizeEOL(ReplacedTextMapper textMapper)`	replace any \r\n and \r by \n
`BasedSequence`	`nullSequence()`
`BasedSequence`	`prefixOf(BasedSequence other)`	Get the prefix part of this from other, start/end offset based containment, not textual
`BasedSequence`	`prefixWith(java.lang.CharSequence prefix)`	Prefix this sequence with a char sequence
`BasedSequence`	`prefixWithIndent()`
`BasedSequence`	`prefixWithIndent(int maxColumns)`	Extend this based sequence to include characters from underlying based sequence taking tab expansion to 4th spaces into account
`char`	`safeBaseCharAt(int index)`	Safe, if index out of range but based sequence has characters will return those, else returns '\0'
`char`	`safeCharAt(int index)`	return char at index or '\0' if index <0 or >=length()
`BasedSequence`	`sequenceOf(java.lang.CharSequence charSequence, int startIndex, int endIndex)`	Factory function
`BasedSequence`	`spliceAtEnd(BasedSequence other)`	Splice the given sequence to the end of this one and return a BasedSequence of the result.
`BasedSequence`	`suffixOf(BasedSequence other)`	Get the suffix part of this from other, start/end offset based containment, not textual
`BasedSequence`	`toMapped(CharMapper mapper)`
`java.lang.String`	`toStringOrNull()`	Return string or null if BaseSequence.NULL
`java.lang.String`	`unescape()`	Get the unescaped string of this sequence content
`BasedSequence`	`unescape(ReplacedTextMapper textMapper)`	Get the unescaped string of this sequence content
`java.lang.String`	`unescapeNoEntities()`	Get the unescaped string of this sequence content without unescaping entities

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, toString, 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.BasedOptionsHolder
allOptions, anyOptions, getOption, getOptionFlags, getOptions

Methods inherited from interface com.vladsch.flexmark.util.sequence.BasedSequence
extendToAny, extendToAny, getBase, getBaseSequence, getEndOffset, getIndexOffset, getSourceRange, getStartOffset, subSequence

Methods inherited from interface java.lang.CharSequence
charAt, chars, codePoints, length, toString

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, 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, 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, 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, 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

- Constructor Detail
  - BasedSequenceImpl
```
public BasedSequenceImpl(int hash)
```
- Method Detail
  - firstNonNull
```
public static BasedSequence firstNonNull(BasedSequence... sequences)
```
  - emptyArray
```
@NotNull
public BasedSequence[] emptyArray()
```
    Specified by:
    
    emptyArray in interface IRichSequence<BasedSequence>
  - nullSequence
```
@NotNull
public BasedSequence nullSequence()
```
    Specified by:
    
    nullSequence in interface IRichSequence<BasedSequence>
  - sequenceOf
```
@NotNull
public BasedSequence sequenceOf(@Nullable
                                java.lang.CharSequence charSequence,
                                int startIndex,
                                int endIndex)
```
    Description copied from interface: IRichSequence
    
    Factory function
    
    Specified by:
    
    sequenceOf in interface IRichSequence<BasedSequence>
    
    Parameters:
    
    charSequence - char sequence from which to construct a rich char sequence
    
    startIndex - start index of the sequence to use
    
    endIndex - end index of the sequence to use
    
    Returns:
    
    rich char sequence from given inputs
  - getBuilder
```
@NotNull
public SequenceBuilder getBuilder()
```
    Description copied from interface: IRichSequence
    
    Get a sequence builder for this sequence type
    
    Specified by:
    
    getBuilder in interface BasedSequence
    
    Specified by:
    
    getBuilder in interface IRichSequence<BasedSequence>
    
    Returns:
    
    builder which can build this type of sequence
  - addSegments
```
public void addSegments(@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
    
    Parameters:
    
    builder - builder
  - getSegmentTree
```
@NotNull
public SegmentTree getSegmentTree()
```
    Get the segment tree for this sequence or null if sequence is contiguous from startOffset to endOffset
    
    Specified by:
    
    getSegmentTree in interface BasedSequence
    
    Returns:
    
    null for contiguous sequences, else segment tree for this sequence
  - toMapped
```
@NotNull
public BasedSequence toMapped(CharMapper mapper)
```
    Specified by:
    
    toMapped in interface IRichSequence<BasedSequence>
  - baseSubSequence
```
@NotNull
public final BasedSequence baseSubSequence(int startIndex)
```
    Description copied from interface: BasedSequence
    
    Get a portion of the original sequence that this sequence is based on
    
    Specified by:
    
    baseSubSequence in interface BasedSequence
    
    Parameters:
    
    startIndex - offset from 0 of original sequence
    
    Returns:
    
    based sequence from startIndex to the endIndex
  - baseSubSequence
```
@NotNull
public 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
    
    Parameters:
    
    startIndex - offset from 0 of original sequence
    
    endIndex - offset from 0 of original sequence
    
    Returns:
    
    based sequence whose contents reflect the selected portion
  - safeCharAt
```
public char safeCharAt(int index)
```
    Description copied from interface: IRichSequence
    
    return char at index or '\0' if index <0 or >=length()
    
    Specified by:
    
    safeCharAt in interface IRichSequence<BasedSequence>
    
    Overrides:
    
    safeCharAt in class IRichSequenceBase<BasedSequence>
    
    Parameters:
    
    index - index
    
    Returns:
    
    char or '\0'
  - safeBaseCharAt
```
public char safeBaseCharAt(int index)
```
    Description copied from interface: BasedSequence
    
    Safe, if index out of range but based sequence has characters will return those, else returns '\0'
    Allows peeking into preceding/following characters to the ones contained in this sequence
    
    Specified by:
    
    safeBaseCharAt in interface BasedSequence
    
    Parameters:
    
    index - index in string
    
    Returns:
    
    character or '\0' if index out of base sequence
  - isBaseCharAt
```
public boolean isBaseCharAt(int index,
                            @NotNull
                            CharPredicate predicate)
```
    Description copied from interface: BasedSequence
    
    Safe, if index out of range but based sequence has characters will return those, else returns '\0'
    Allows peeking into preceding/following characters to the ones contained in this sequence
    
    Specified by:
    
    isBaseCharAt in interface BasedSequence
    
    Parameters:
    
    index - index in string
    
    predicate - character set predicate
    
    Returns:
    
    true if character at index tests true
  - getEmptyPrefix
```
@NotNull
public BasedSequence getEmptyPrefix()
```
    Description copied from interface: BasedSequence
    
    Get empty prefix to this sequence
    
    Specified by:
    
    getEmptyPrefix in interface BasedSequence
    
    Returns:
    
    same as subSequence(0,0)
  - getEmptySuffix
```
@NotNull
public BasedSequence getEmptySuffix()
```
    Description copied from interface: BasedSequence
    
    Get empty suffix to this sequence
    
    Specified by:
    
    getEmptySuffix in interface BasedSequence
    
    Returns:
    
    same as subSequence(length())
  - toStringOrNull
```
@Nullable
public java.lang.String toStringOrNull()
```
    Description copied from interface: IRichSequence
    
    Return string or null if BaseSequence.NULL
    
    Specified by:
    
    toStringOrNull in interface IRichSequence<BasedSequence>
    
    Overrides:
    
    toStringOrNull in class IRichSequenceBase<BasedSequence>
    
    Returns:
    
    string or null if BaseSequence.NULL
  - unescape
```
@NotNull
public java.lang.String unescape()
```
    Description copied from interface: BasedSequence
    
    Get the unescaped string of this sequence content
    
    Specified by:
    
    unescape in interface BasedSequence
    
    Returns:
    
    unescaped text
  - unescapeNoEntities
```
@NotNull
public java.lang.String unescapeNoEntities()
```
    Description copied from interface: BasedSequence
    
    Get the unescaped string of this sequence content without unescaping entities
    
    Specified by:
    
    unescapeNoEntities in interface BasedSequence
    
    Returns:
    
    unescaped text
  - unescape
```
@NotNull
public BasedSequence unescape(@NotNull
                              ReplacedTextMapper textMapper)
```
    Description copied from interface: BasedSequence
    
    Get the unescaped string of this sequence content
    
    Specified by:
    
    unescape in interface BasedSequence
    
    Parameters:
    
    textMapper - replaced text mapper which will be uses to map unescaped index to original source index
    
    Returns:
    
    unescaped text in based sequence
  - normalizeEOL
```
@NotNull
public BasedSequence normalizeEOL(@NotNull
                                  ReplacedTextMapper textMapper)
```
    Description copied from interface: BasedSequence
    
    replace any \r\n and \r by \n
    
    Specified by:
    
    normalizeEOL in interface BasedSequence
    
    Parameters:
    
    textMapper - replaced text mapper which will be uses to map unescaped index to original source index
    
    Returns:
    
    based sequence with only \n for line separators
  - normalizeEndWithEOL
```
@NotNull
public BasedSequence normalizeEndWithEOL(@NotNull
                                         ReplacedTextMapper textMapper)
```
    Description copied from interface: BasedSequence
    
    replace any \r\n and \r by \n, append terminating EOL if one is not present
    
    Specified by:
    
    normalizeEndWithEOL in interface BasedSequence
    
    Parameters:
    
    textMapper - replaced text mapper which will be uses to map unescaped index to original source index
    
    Returns:
    
    based sequence with only \n for line separators and terminated by \n
  - isContinuedBy
```
public boolean isContinuedBy(@NotNull
                             BasedSequence other)
```
    Description copied from interface: BasedSequence
    
    Test if the given sequence is a continuation of this sequence in original source text
    
    Specified by:
    
    isContinuedBy in interface BasedSequence
    
    Parameters:
    
    other - sequence to test
    
    Returns:
    
    true if the given sequence is a continuation of this one in the original text
  - isContinuationOf
```
public boolean isContinuationOf(@NotNull
                                BasedSequence other)
```
    Description copied from interface: BasedSequence
    
    Test if this sequence is a continuation of the given sequence in original source text
    
    Specified by:
    
    isContinuationOf in interface BasedSequence
    
    Parameters:
    
    other - sequence to test
    
    Returns:
    
    true if this sequence is a continuation of the given sequence in original source text
  - spliceAtEnd
```
@NotNull
public BasedSequence spliceAtEnd(@NotNull
                                 BasedSequence other)
```
    Description copied from interface: BasedSequence
    
    Splice the given sequence to the end of this one and return a BasedSequence of the result. Does not copy anything, creates a new based sequence of the original text but one that spans characters of this sequence and other
    
    Specified by:
    
    spliceAtEnd in interface BasedSequence
    
    Parameters:
    
    other - sequence to append to end of this one
    
    Returns:
    
    based sequence that contains the span from start of this sequence and end of other
    assertion will fail if the other sequence is not a continuation of this one
  - containsAllOf
```
public boolean containsAllOf(@NotNull
                             BasedSequence other)
```
    Description copied from interface: BasedSequence
    
    start/end offset based containment, not textual
    
    Specified by:
    
    containsAllOf in interface BasedSequence
    
    Parameters:
    
    other - based sequence from the same base
    
    Returns:
    
    true if other is contained in this
  - containsSomeOf
```
public boolean containsSomeOf(@NotNull
                              BasedSequence other)
```
    Description copied from interface: BasedSequence
    
    start/end offset based containment, not textual
    
    Specified by:
    
    containsSomeOf in interface BasedSequence
    
    Parameters:
    
    other - based sequence from the same base
    
    Returns:
    
    true if other is contained in this
  - intersect
```
@NotNull
public BasedSequence intersect(@NotNull
                               BasedSequence other)
```
    Description copied from interface: BasedSequence
    
    start/end offset based intersection, not textual
    
    Specified by:
    
    intersect in interface BasedSequence
    
    Parameters:
    
    other - based sequence from the same parent
    
    Returns:
    
    sequence which is the intersection of the range of this and other
  - containsSomeIn
```
public boolean containsSomeIn(@NotNull
                              CharPredicate charSet)
```
    Description copied from interface: BasedSequence
    
    Test for line containing some of the characters in the set
    
    Specified by:
    
    containsSomeIn in interface BasedSequence
    
    Parameters:
    
    charSet - set of characters to be tested
    
    Returns:
    
    true if line contains some characters in the set
  - containsSomeNotIn
```
public boolean containsSomeNotIn(@NotNull
                                 CharPredicate charSet)
```
    Description copied from interface: BasedSequence
    
    Test for line containing some characters not in the set
    
    Specified by:
    
    containsSomeNotIn in interface BasedSequence
    
    Parameters:
    
    charSet - set of characters to be tested
    
    Returns:
    
    true if line contains some characters not in the set
  - containsOnlyIn
```
public boolean containsOnlyIn(@NotNull
                              CharPredicate charSet)
```
    Description copied from interface: BasedSequence
    
    Test for line contains only characters from the set
    
    Specified by:
    
    containsOnlyIn in interface BasedSequence
    
    Parameters:
    
    charSet - set of characters to be tested
    
    Returns:
    
    true if line contains some characters from the set
  - containsOnlyNotIn
```
public boolean containsOnlyNotIn(@NotNull
                                 CharPredicate charSet)
```
    Description copied from interface: BasedSequence
    
    Test for line containing only characters not in the set
    
    Specified by:
    
    containsOnlyNotIn in interface BasedSequence
    
    Parameters:
    
    charSet - set of characters to be tested
    
    Returns:
    
    true if line contains some characters from the set
  - extendByAny
```
@NotNull
public BasedSequence extendByAny(@NotNull
                                 CharPredicate charSet)
```
    Specified by:
    
    extendByAny in interface BasedSequence
  - extendByOneOfAny
```
@NotNull
public BasedSequence extendByOneOfAny(@NotNull
                                      CharPredicate charSet)
```
    Specified by:
    
    extendByOneOfAny in interface BasedSequence
  - extendByAny
```
@NotNull
public BasedSequence extendByAny(@NotNull
                                 CharPredicate charSet,
                                 int maxCount)
```
    Description copied from interface: BasedSequence
    
    Extend this based sequence to include characters from underlying based sequence
    
    Specified by:
    
    extendByAny in interface BasedSequence
    
    Parameters:
    
    charSet - set of characters to include
    
    maxCount - maximum extra characters to include
    
    Returns:
    
    sequence which
  - extendByAnyNot
```
@NotNull
public BasedSequence extendByAnyNot(@NotNull
                                    CharPredicate charSet)
```
    Specified by:
    
    extendByAnyNot in interface BasedSequence
  - extendByOneOfAnyNot
```
@NotNull
public BasedSequence extendByOneOfAnyNot(@NotNull
                                         CharPredicate charSet)
```
    Specified by:
    
    extendByOneOfAnyNot in interface BasedSequence
  - extendByAnyNot
```
@NotNull
public BasedSequence extendByAnyNot(@NotNull
                                    CharPredicate charSet,
                                    int maxCount)
```
    Description copied from interface: BasedSequence
    
    Extend this based sequence to include characters from underlying based sequence not in character set
    
    Specified by:
    
    extendByAnyNot in interface BasedSequence
    
    Parameters:
    
    charSet - set of characters to include
    
    maxCount - maximum extra characters to include
    
    Returns:
    
    sequence which
  - extendToEndOfLine
```
@NotNull
public final BasedSequence extendToEndOfLine(@NotNull
                                             CharPredicate eolChars)
```
    Specified by:
    
    extendToEndOfLine in interface BasedSequence
  - extendToEndOfLine
```
@NotNull
public final BasedSequence extendToEndOfLine(boolean includeEol)
```
    Specified by:
    
    extendToEndOfLine in interface BasedSequence
  - extendToEndOfLine
```
@NotNull
public final BasedSequence extendToEndOfLine()
```
    Specified by:
    
    extendToEndOfLine in interface BasedSequence
  - extendToStartOfLine
```
@NotNull
public final BasedSequence extendToStartOfLine(@NotNull
                                               CharPredicate eolChars)
```
    Specified by:
    
    extendToStartOfLine in interface BasedSequence
  - extendToStartOfLine
```
@NotNull
public final BasedSequence extendToStartOfLine(boolean includeEol)
```
    Specified by:
    
    extendToStartOfLine in interface BasedSequence
  - extendToStartOfLine
```
@NotNull
public final BasedSequence extendToStartOfLine()
```
    Specified by:
    
    extendToStartOfLine in interface BasedSequence
  - extendToEndOfLine
```
@NotNull
public final BasedSequence extendToEndOfLine(@NotNull
                                             CharPredicate eolChars,
                                             boolean includeEol)
```
    Description copied from interface: BasedSequence
    
    Extend in contained based sequence
    
    Specified by:
    
    extendToEndOfLine in interface BasedSequence
    
    Parameters:
    
    eolChars - characters to consider as EOL, note IRichSequence.eolStartLength(int) IRichSequence.eolEndLength(int) should report length of EOL found if length > 1
    
    includeEol - if to include the eol in the string
    
    Returns:
    
    resulting sequence after extension. If already spanning the line then this sequence is returned. if the last character of this sequence are found in eolChars then no extension will be performed since it already includes the line end
  - extendToStartOfLine
```
@NotNull
public BasedSequence extendToStartOfLine(@NotNull
                                         CharPredicate eolChars,
                                         boolean includeEol)
```
    Description copied from interface: BasedSequence
    
    Extend in contained based sequence
    
    Specified by:
    
    extendToStartOfLine in interface BasedSequence
    
    Parameters:
    
    eolChars - characters to consider as EOL, note IRichSequence.eolStartLength(int) IRichSequence.eolEndLength(int) should report length of EOL found if length > 1
    
    includeEol - if to include the eol in the string
    
    Returns:
    
    resulting sequence after extension. If already spanning the line then this sequence is returned. if the first character of this sequence are found in eolChars then no extension will be performed since it already includes the line end
  - prefixWith
```
@NotNull
public BasedSequence prefixWith(@Nullable
                                java.lang.CharSequence prefix)
```
    Description copied from interface: IRichSequence
    
    Prefix this sequence with a char sequence
    
    Specified by:
    
    prefixWith in interface IRichSequence<BasedSequence>
    
    Overrides:
    
    prefixWith in class IRichSequenceBase<BasedSequence>
    
    Parameters:
    
    prefix - char sequence
    
    Returns:
    
    resulting sequence
  - prefixWithIndent
```
@NotNull
public final BasedSequence prefixWithIndent()
```
    Specified by:
    
    prefixWithIndent in interface BasedSequence
  - prefixWithIndent
```
@NotNull
public BasedSequence prefixWithIndent(int maxColumns)
```
    Description copied from interface: BasedSequence
    
    Extend this based sequence to include characters from underlying based sequence taking tab expansion to 4th spaces into account
    
    Specified by:
    
    prefixWithIndent in interface BasedSequence
    
    Parameters:
    
    maxColumns - maximum columns to include, default Integer.MAX_VALUE
    
    Returns:
    
    sequence which
  - prefixOf
```
@NotNull
public BasedSequence prefixOf(@NotNull
                              BasedSequence other)
```
    Description copied from interface: BasedSequence
    
    Get the prefix part of this from other, start/end offset based containment, not textual
    
    Specified by:
    
    prefixOf in interface BasedSequence
    
    Parameters:
    
    other - based sequence from the same base
    
    Returns:
    
    prefix part of this as compared to other, start/end offset based, not content
  - suffixOf
```
@NotNull
public BasedSequence suffixOf(@NotNull
                              BasedSequence other)
```
    Description copied from interface: BasedSequence
    
    Get the suffix part of this from other, start/end offset based containment, not textual
    
    Specified by:
    
    suffixOf in interface BasedSequence
    
    Parameters:
    
    other - based sequence from the same base
    
    Returns:
    
    suffix part of this as compared to other, start/end offset based, not content
  - baseLineRangeAtIndex
```
@NotNull
public Range baseLineRangeAtIndex(int index)
```
    Specified by:
    
    baseLineRangeAtIndex in interface BasedSequence
  - baseLineColumnAtIndex
```
@NotNull
public Pair<java.lang.Integer,java.lang.Integer> baseLineColumnAtIndex(int index)
```
    Specified by:
    
    baseLineColumnAtIndex in interface BasedSequence
  - baseEndOfLine
```
public int baseEndOfLine(int index)
```
    Specified by:
    
    baseEndOfLine in interface BasedSequence
  - baseEndOfLineAnyEOL
```
public int baseEndOfLineAnyEOL(int index)
```
    Specified by:
    
    baseEndOfLineAnyEOL in interface BasedSequence
  - baseStartOfLine
```
public int baseStartOfLine(int index)
```
    Specified by:
    
    baseStartOfLine in interface BasedSequence
  - baseStartOfLineAnyEOL
```
public int baseStartOfLineAnyEOL(int index)
```
    Specified by:
    
    baseStartOfLineAnyEOL in interface BasedSequence
  - baseColumnAtIndex
```
public int baseColumnAtIndex(int index)
```
    Specified by:
    
    baseColumnAtIndex in interface BasedSequence
  - baseEndOfLine
```
public int baseEndOfLine()
```
    Specified by:
    
    baseEndOfLine in interface BasedSequence
  - baseEndOfLineAnyEOL
```
public int baseEndOfLineAnyEOL()
```
    Specified by:
    
    baseEndOfLineAnyEOL in interface BasedSequence
  - baseColumnAtEnd
```
public int baseColumnAtEnd()
```
    Specified by:
    
    baseColumnAtEnd in interface BasedSequence
  - baseLineRangeAtEnd
```
@NotNull
public Range baseLineRangeAtEnd()
```
    Specified by:
    
    baseLineRangeAtEnd in interface BasedSequence
  - baseLineColumnAtEnd
```
@NotNull
public Pair<java.lang.Integer,java.lang.Integer> baseLineColumnAtEnd()
```
    Specified by:
    
    baseLineColumnAtEnd in interface BasedSequence
  - baseStartOfLine
```
public int baseStartOfLine()
```
    Specified by:
    
    baseStartOfLine in interface BasedSequence
  - baseStartOfLineAnyEOL
```
public int baseStartOfLineAnyEOL()
```
    Specified by:
    
    baseStartOfLineAnyEOL in interface BasedSequence
  - baseColumnAtStart
```
public int baseColumnAtStart()
```
    Specified by:
    
    baseColumnAtStart in interface BasedSequence
  - baseLineRangeAtStart
```
@NotNull
public Range baseLineRangeAtStart()
```
    Specified by:
    
    baseLineRangeAtStart in interface BasedSequence
  - baseLineColumnAtStart
```
@NotNull
public Pair<java.lang.Integer,java.lang.Integer> baseLineColumnAtStart()
```
    Specified by:
    
    baseLineColumnAtStart in interface BasedSequence

Class BasedSequenceImpl

Nested Class Summary

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

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

Field Summary

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.lang.CharSequence

Methods inherited from interface java.lang.Comparable

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

Constructor Detail

BasedSequenceImpl

Method Detail

firstNonNull

emptyArray

nullSequence

sequenceOf

getBuilder

addSegments

getSegmentTree

toMapped

baseSubSequence

baseSubSequence

safeCharAt

safeBaseCharAt

isBaseCharAt

getEmptyPrefix

getEmptySuffix

toStringOrNull

unescape

unescapeNoEntities

unescape

normalizeEOL

normalizeEndWithEOL

isContinuedBy

isContinuationOf

spliceAtEnd

containsAllOf

containsSomeOf

intersect

containsSomeIn

containsSomeNotIn

containsOnlyIn

containsOnlyNotIn

extendByAny

extendByOneOfAny

extendByAny

extendByAnyNot

extendByOneOfAnyNot

extendByAnyNot

extendToEndOfLine

extendToEndOfLine

extendToEndOfLine

extendToStartOfLine

extendToStartOfLine

extendToStartOfLine

extendToEndOfLine

extendToStartOfLine

prefixWith

prefixWithIndent

prefixWithIndent

prefixOf

suffixOf

baseLineRangeAtIndex

baseLineColumnAtIndex

baseEndOfLine

baseEndOfLineAnyEOL

baseStartOfLine

baseStartOfLineAnyEOL

baseColumnAtIndex

baseEndOfLine

baseEndOfLineAnyEOL

baseColumnAtEnd