com.vladsch.flexmark.util.sequence

Interface BasedSequence

All Superinterfaces:

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

All Known Subinterfaces:

ReplacedBasedSequence

All Known Implementing Classes:

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

public interface BasedSequence
extends IRichSequence<BasedSequence>, BasedOptionsHolder

A CharSequence that references original char sequence with offsets into original preserved.

NOTE: '\0' changed to '�' use NullEncoder.decodeNull mapper to get original null chars.

Since equals is used for comparison of sequences and strings by base sequence manager, a base sequence with NUL may not compare equal to an equivalent unwrapped sequence because NUL chars are not converted. For Strings this is handled by using String.equals() for comparison. For other CharacterSequence types the match will fail if original has NUL in it.

a subSequence() returns a sub-sequence from the original base sequence with corresponding offsets

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BasedSequence.EmptyBasedSequence

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

BasedOptionsHolder.Options

Field Summary

Fields

Modifier and Type	Field and Description
static BasedSequence	EMPTY
static BasedSequence[]	EMPTY_ARRAY
static List<BasedSequence>	EMPTY_LIST
static BasedSequence[]	EMPTY_SEGMENTS
static BasedSequence	EOL
static BasedSequence	LINE_SEP
static BasedSequence	NULL
static BasedSequence	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_CHAR, EOL_CHAR1, EOL_CHAR2, EOL_CHARS, EOL_SET, HASH_SET, HEXADECIMAL_DIGITS, LS, LSEP, NBSP, NBSP_CHARS, NUL, OCTAL_DIGITS, 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

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 and Description
void	addSegments(@NotNull 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)
@NotNull com.vladsch.flexmark.util.misc.Pair<Integer,Integer>	baseLineColumnAtEnd()
@NotNull com.vladsch.flexmark.util.misc.Pair<Integer,Integer>	baseLineColumnAtIndex(int index)
@NotNull com.vladsch.flexmark.util.misc.Pair<Integer,Integer>	baseLineColumnAtStart()
@NotNull Range	baseLineRangeAtEnd()
@NotNull Range	baseLineRangeAtIndex(int index)
@NotNull Range	baseLineRangeAtStart()
int	baseStartOfLine()
int	baseStartOfLine(int index)
int	baseStartOfLineAnyEOL()
int	baseStartOfLineAnyEOL(int index)
@NotNull BasedSequence	baseSubSequence(int startIndex) Get a portion of the original sequence that this sequence is based on
@NotNull BasedSequence	baseSubSequence(int startIndex, int endIndex) Get a portion of this sequence's base sequence
boolean	containsAllOf(@NotNull BasedSequence other) start/end offset based containment, not textual
boolean	containsSomeOf(@NotNull BasedSequence other) start/end offset based containment, not textual
@NotNull BasedSequence	extendByAny(@NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet)
@NotNull BasedSequence	extendByAny(@NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet, int maxCount) Extend this based sequence to include characters from underlying based sequence
@NotNull BasedSequence	extendByAnyNot(@NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet)
@NotNull BasedSequence	extendByAnyNot(@NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet, int maxCount) Extend this based sequence to include characters from underlying based sequence not in character set
@NotNull BasedSequence	extendByOneOfAny(@NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet)
@NotNull BasedSequence	extendByOneOfAnyNot(@NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet)
default @NotNull BasedSequence	extendToAny(@NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet) Deprecated.
default @NotNull BasedSequence	extendToAny(@NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet, int maxCount) Deprecated.
@NotNull BasedSequence	extendToEndOfLine()
@NotNull BasedSequence	extendToEndOfLine(boolean includeEol)
@NotNull BasedSequence	extendToEndOfLine(@NotNull com.vladsch.flexmark.util.misc.CharPredicate eolChars)
@NotNull BasedSequence	extendToEndOfLine(@NotNull com.vladsch.flexmark.util.misc.CharPredicate eolChars, boolean includeEol) Extend in contained based sequence
@NotNull BasedSequence	extendToStartOfLine()
@NotNull BasedSequence	extendToStartOfLine(boolean includeEol)
@NotNull BasedSequence	extendToStartOfLine(@NotNull com.vladsch.flexmark.util.misc.CharPredicate eolChars)
@NotNull BasedSequence	extendToStartOfLine(@NotNull com.vladsch.flexmark.util.misc.CharPredicate eolChars, boolean includeEol) Extend in contained based sequence
@NotNull Object	getBase() Get the underlying object on which this sequence contents are based
@NotNull BasedSequence	getBaseSequence() Get the base sequence for the text
@NotNull SequenceBuilder	getBuilder() Get a sequence builder for this sequence type
@NotNull BasedSequence	getEmptyPrefix() Get empty prefix to this sequence
@NotNull BasedSequence	getEmptySuffix() Get empty suffix to this sequence
int	getEndOffset() Get the end offset of this sequence into getBaseSequence() and getBase() original text source.
int	getIndexOffset(int index) Get the offset of index in this sequence mapped to offset into getBaseSequence() and getBase() original text source.
@NotNull SegmentTree	getSegmentTree() Get the segment tree for this sequence
@NotNull Range	getSourceRange() Get the range of this sequence in original getBaseSequence() and getBase() original text source.
int	getStartOffset() Get the start offset of this sequence into getBaseSequence() and getBase() original text source.
@NotNull BasedSequence	intersect(@NotNull BasedSequence other) start/end offset based intersection, not textual
boolean	isBaseCharAt(int index, @NotNull com.vladsch.flexmark.util.misc.CharPredicate predicate) Safe, if index out of range but based sequence has characters will return those, else returns '\0'
boolean	isContinuationOf(@NotNull BasedSequence other) Test if this sequence is a continuation of the given sequence in original source text
boolean	isContinuedBy(@NotNull BasedSequence other) Test if the given sequence is a continuation of this sequence in original source text
@NotNull BasedSequence	normalizeEndWithEOL(@NotNull ReplacedTextMapper textMapper) replace any \r\n and \r by \n, append terminating EOL if one is not present
@NotNull BasedSequence	normalizeEOL(@NotNull ReplacedTextMapper textMapper) replace any \r\n and \r by \n
static @NotNull BasedSequence	of(@Nullable CharSequence charSequence)
static @NotNull BasedSequence	of(@Nullable CharSequence charSequence, int startIndex) Deprecated.
static @NotNull BasedSequence	of(@Nullable CharSequence charSequence, int startIndex, int endIndex) Deprecated.
static @NotNull BasedSequence	ofSpaces(int count)
@NotNull BasedSequence	prefixOf(@NotNull BasedSequence other) Get the prefix part of this from other, start/end offset based containment, not textual
@NotNull BasedSequence	prefixWithIndent()
@NotNull BasedSequence	prefixWithIndent(int maxColumns) Extend this based sequence to include characters from underlying based sequence taking tab expansion to 4th spaces into account
static @NotNull BasedSequence	repeatOf(char c, int count)
static @NotNull BasedSequence	repeatOf(@NotNull CharSequence chars, int count)
static @NotNull BasedSequence	repeatOf(@NotNull CharSequence chars, int startIndex, int endIndex)
char	safeBaseCharAt(int index) Safe, if index out of range but based sequence has characters will return those, else returns '\0'
@NotNull BasedSequence	spliceAtEnd(@NotNull BasedSequence other) Splice the given sequence to the end of this one and return a BasedSequence of the result.
@NotNull BasedSequence	subSequence(int startIndex, int endIndex) Get a portion of this sequence
@NotNull BasedSequence	suffixOf(@NotNull BasedSequence other) Get the suffix part of this from other, start/end offset based containment, not textual
@NotNull String	unescape() Get the unescaped string of this sequence content
@NotNull BasedSequence	unescape(@NotNull ReplacedTextMapper textMapper) Get the unescaped string of this sequence content
@NotNull String	unescapeNoEntities() Get the unescaped string of this sequence content without unescaping entities

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

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.SequenceUtils

blankLinesRemovedRanges, blankLinesRemovedRanges, blankLinesRemovedRanges, blankLinesRemovedRanges, columnAtIndex, columnsToNextTabStop, compare, compare, compare, compareReversed, containedBy, containedBy, containsAny, containsAny, containsAnyNot, containsAnyNot, containsAnyNot, 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, endOfDelimitedBy, endOfDelimitedByAny, endOfDelimitedByAnyNot, endOfLine, endOfLineAnyEOL, endsWith, endsWith, endsWith, endsWithAnyEOL, endsWithEOL, endsWithSpace, endsWithSpaceTab, endsWithWhitespace, eolEndLength, eolEndLength, eolEndRange, eolStartLength, eolStartRange, equals, expandTo, firstChar, getVisibleSpacesMap, hashCode, indexOf, indexOf, indexOf, indexOf, indexOf, indexOf, indexOfAll, indexOfAny, indexOfAny, indexOfAny, indexOfAnyNot, indexOfAnyNot, indexOfAnyNot, indexOfNot, indexOfNot, indexOfNot, isBlank, isEmpty, isNotBlank, isNotEmpty, isVisibleWhitespace, lastChar, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOfAny, lastIndexOfAny, lastIndexOfAny, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfNot, lastIndexOfNot, lastIndexOfNot, leadingBlankLinesRange, leadingBlankLinesRange, leadingBlankLinesRange, leadingBlankLinesRange, 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, padEnd, padEnd, padStart, padStart, parseIntOrDefault, parseIntOrDefault, parseIntOrNull, parseIntOrNull, parseLongOrNull, parseLongOrNull, parseNumberOrNull, parseNumberPrefixOrNull, parseUnsignedIntOrDefault, parseUnsignedIntOrDefault, parseUnsignedIntOrNull, parseUnsignedIntOrNull, safeCharAt, 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, startsWithSpace, startsWithSpaceTab, startsWithWhitespace, subSequence, subSequence, subSequenceAfter, subSequenceBefore, subSequenceBeforeAfter, toStringArray, 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, truncateTo, validateIndex, validateIndexInclusiveEnd, validateStartEnd

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

allOptions, anyOptions, getOption, getOptionFlags, getOptions, optionsToString

Field Detail

NULL

static final BasedSequence NULL

EMPTY

static final BasedSequence EMPTY

EOL

static final BasedSequence EOL

SPACE

static final BasedSequence SPACE

EMPTY_LIST

static final List<BasedSequence> EMPTY_LIST

EMPTY_ARRAY

static final BasedSequence[] EMPTY_ARRAY

EMPTY_SEGMENTS

static final BasedSequence[] EMPTY_SEGMENTS

LINE_SEP

static final BasedSequence LINE_SEP

Method Detail

of

@NotNull
static @NotNull BasedSequence of(@Nullable
                                          @Nullable CharSequence charSequence)

of

@NotNull
 @Deprecated
static @NotNull BasedSequence of(@Nullable
                                                       @Nullable CharSequence charSequence,
                                                       int startIndex)

Deprecated.

of

@NotNull
 @Deprecated
static @NotNull BasedSequence of(@Nullable
                                                       @Nullable CharSequence charSequence,
                                                       int startIndex,
                                                       int endIndex)

Deprecated.

ofSpaces

@NotNull
static @NotNull BasedSequence ofSpaces(int count)

repeatOf

@NotNull
static @NotNull BasedSequence repeatOf(char c,
                                                int count)

repeatOf

@NotNull
static @NotNull BasedSequence repeatOf(@NotNull
                                                @NotNull CharSequence chars,
                                                int count)

repeatOf

@NotNull
static @NotNull BasedSequence repeatOf(@NotNull
                                                @NotNull CharSequence chars,
                                                int startIndex,
                                                int endIndex)

getBuilder

@NotNull
@NotNull SequenceBuilder getBuilder()

Description copied from interface: IRichSequence

Get a sequence builder for this sequence type

Specified by:

getBuilder in interface IRichSequence<BasedSequence>

Returns:

builder which can build this type of sequence

getBase

@NotNull
@NotNull Object getBase()

Get the underlying object on which this sequence contents are based

Returns:

underlying object containing original text

getBaseSequence

@NotNull
@NotNull BasedSequence getBaseSequence()

Get the base sequence for the text

Returns:

base sequence

getStartOffset

int getStartOffset()

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

Returns:

start offset in original text

getEndOffset

int getEndOffset()

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

Returns:

end offset in original text

getIndexOffset

int getIndexOffset(int index)

Get the offset of index in this sequence mapped to offset into getBaseSequence() and 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

Parameters:

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

Returns:

offset of index of this sequence in original text

addSegments

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

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

Parameters:

builder - builder

getSegmentTree

@NotNull
@NotNull SegmentTree getSegmentTree()

Get the segment tree for this sequence

Returns:

segment tree

getSourceRange

@NotNull
@NotNull Range getSourceRange()

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

Returns:

Range of start offset and end offset

subSequence

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

Get a portion of this sequence

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.

baseSubSequence

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

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

Parameters:

startIndex - offset from 0 of original sequence

endIndex - offset from 0 of original sequence

Returns:

based sequence whose contents reflect the selected portion

baseSubSequence

@NotNull
@NotNull BasedSequence baseSubSequence(int startIndex)

Get a portion of the original sequence that this sequence is based on

Parameters:

startIndex - offset from 0 of original sequence

Returns:

based sequence from startIndex to the endIndex

safeBaseCharAt

char safeBaseCharAt(int index)

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

Parameters:

index - index in string

Returns:

character or '\0' if index out of base sequence

isBaseCharAt

boolean isBaseCharAt(int index,
                     @NotNull
                     @NotNull com.vladsch.flexmark.util.misc.CharPredicate predicate)

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

Parameters:

index - index in string

predicate - character set predicate

Returns:

true if character at index tests true

getEmptyPrefix

@NotNull
@NotNull BasedSequence getEmptyPrefix()

Get empty prefix to this sequence

Returns:

same as subSequence(0,0)

getEmptySuffix

@NotNull
@NotNull BasedSequence getEmptySuffix()

Get empty suffix to this sequence

Returns:

same as subSequence(length())

unescape

@NotNull
@NotNull String unescape()

Get the unescaped string of this sequence content

Returns:

unescaped text

unescapeNoEntities

@NotNull
@NotNull String unescapeNoEntities()

Get the unescaped string of this sequence content without unescaping entities

Returns:

unescaped text

unescape

@NotNull
@NotNull BasedSequence unescape(@NotNull
                                         @NotNull ReplacedTextMapper textMapper)

Get the unescaped string of this sequence content

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
@NotNull BasedSequence normalizeEOL(@NotNull
                                             @NotNull ReplacedTextMapper textMapper)

replace any \r\n and \r by \n

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
@NotNull BasedSequence normalizeEndWithEOL(@NotNull
                                                    @NotNull ReplacedTextMapper textMapper)

replace any \r\n and \r by \n, append terminating EOL if one is not present

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

boolean isContinuedBy(@NotNull
                      @NotNull BasedSequence other)

Test if the given sequence is a continuation of this sequence in original source text

Parameters:

other - sequence to test

Returns:

true if the given sequence is a continuation of this one in the original text

isContinuationOf

boolean isContinuationOf(@NotNull
                         @NotNull BasedSequence other)

Test if this sequence is a continuation of the given sequence in original source text

Parameters:

other - sequence to test

Returns:

true if this sequence is a continuation of the given sequence in original source text

spliceAtEnd

@NotNull
@NotNull BasedSequence spliceAtEnd(@NotNull
                                            @NotNull BasedSequence other)

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

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

boolean containsAllOf(@NotNull
                      @NotNull BasedSequence other)

start/end offset based containment, not textual

Parameters:

other - based sequence from the same base

Returns:

true if other is contained in this

containsSomeOf

boolean containsSomeOf(@NotNull
                       @NotNull BasedSequence other)

start/end offset based containment, not textual

Parameters:

other - based sequence from the same base

Returns:

true if other is contained in this

prefixOf

@NotNull
@NotNull BasedSequence prefixOf(@NotNull
                                         @NotNull BasedSequence other)

Get the prefix part of this from other, start/end offset based containment, not textual

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
@NotNull BasedSequence suffixOf(@NotNull
                                         @NotNull BasedSequence other)

Get the suffix part of this from other, start/end offset based containment, not textual

Parameters:

other - based sequence from the same base

Returns:

suffix part of this as compared to other, start/end offset based, not content

intersect

@NotNull
@NotNull BasedSequence intersect(@NotNull
                                          @NotNull BasedSequence other)

start/end offset based intersection, not textual

Parameters:

other - based sequence from the same parent

Returns:

sequence which is the intersection of the range of this and other

extendByAny

@NotNull
@NotNull BasedSequence extendByAny(@NotNull
                                            @NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet,
                                            int maxCount)

Extend this based sequence to include characters from underlying based sequence

Parameters:

charSet - set of characters to include

maxCount - maximum extra characters to include

Returns:

sequence which

extendByAny

@NotNull
@NotNull BasedSequence extendByAny(@NotNull
                                            @NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet)

extendByOneOfAny

@NotNull
@NotNull BasedSequence extendByOneOfAny(@NotNull
                                                 @NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet)

extendByAnyNot

@NotNull
@NotNull BasedSequence extendByAnyNot(@NotNull
                                               @NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet,
                                               int maxCount)

Extend this based sequence to include characters from underlying based sequence not in character set

Parameters:

charSet - set of characters to include

maxCount - maximum extra characters to include

Returns:

sequence which

extendByAnyNot

@NotNull
@NotNull BasedSequence extendByAnyNot(@NotNull
                                               @NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet)

extendByOneOfAnyNot

@NotNull
@NotNull BasedSequence extendByOneOfAnyNot(@NotNull
                                                    @NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet)

extendToAny

@NotNull
 @Deprecated
default @NotNull BasedSequence extendToAny(@NotNull
                                                                 @NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet,
                                                                 int maxCount)

Deprecated.

extendToAny

@NotNull
 @Deprecated
default @NotNull BasedSequence extendToAny(@NotNull
                                                                 @NotNull com.vladsch.flexmark.util.misc.CharPredicate charSet)

Deprecated.

extendToEndOfLine

@NotNull
@NotNull BasedSequence extendToEndOfLine(@NotNull
                                                  @NotNull com.vladsch.flexmark.util.misc.CharPredicate eolChars,
                                                  boolean includeEol)

Extend in contained based sequence

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

extendToEndOfLine

@NotNull
@NotNull BasedSequence extendToEndOfLine(@NotNull
                                                  @NotNull com.vladsch.flexmark.util.misc.CharPredicate eolChars)

extendToEndOfLine

@NotNull
@NotNull BasedSequence extendToEndOfLine(boolean includeEol)

extendToEndOfLine

@NotNull
@NotNull BasedSequence extendToEndOfLine()

extendToStartOfLine

@NotNull
@NotNull BasedSequence extendToStartOfLine(@NotNull
                                                    @NotNull com.vladsch.flexmark.util.misc.CharPredicate eolChars,
                                                    boolean includeEol)

Extend in contained based sequence

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

extendToStartOfLine

@NotNull
@NotNull BasedSequence extendToStartOfLine(@NotNull
                                                    @NotNull com.vladsch.flexmark.util.misc.CharPredicate eolChars)

extendToStartOfLine

@NotNull
@NotNull BasedSequence extendToStartOfLine(boolean includeEol)

extendToStartOfLine

@NotNull
@NotNull BasedSequence extendToStartOfLine()

prefixWithIndent

@NotNull
@NotNull BasedSequence prefixWithIndent(int maxColumns)

Extend this based sequence to include characters from underlying based sequence taking tab expansion to 4th spaces into account

Parameters:

maxColumns - maximum columns to include, default Integer.MAX_VALUE

Returns:

sequence which

prefixWithIndent

@NotNull
@NotNull BasedSequence prefixWithIndent()

baseLineColumnAtIndex

@NotNull
@NotNull com.vladsch.flexmark.util.misc.Pair<Integer,Integer> baseLineColumnAtIndex(int index)

baseLineRangeAtIndex

@NotNull
@NotNull Range baseLineRangeAtIndex(int index)

baseEndOfLine

int baseEndOfLine(int index)

baseEndOfLineAnyEOL

int baseEndOfLineAnyEOL(int index)

baseStartOfLine

int baseStartOfLine(int index)

baseStartOfLineAnyEOL

int baseStartOfLineAnyEOL(int index)

baseColumnAtIndex

int baseColumnAtIndex(int index)

baseLineColumnAtStart

@NotNull
@NotNull com.vladsch.flexmark.util.misc.Pair<Integer,Integer> baseLineColumnAtStart()

baseLineColumnAtEnd

@NotNull
@NotNull com.vladsch.flexmark.util.misc.Pair<Integer,Integer> baseLineColumnAtEnd()

baseEndOfLine

int baseEndOfLine()

baseEndOfLineAnyEOL

int baseEndOfLineAnyEOL()

baseStartOfLine

int baseStartOfLine()

baseStartOfLineAnyEOL

int baseStartOfLineAnyEOL()

baseLineRangeAtStart

@NotNull
@NotNull Range baseLineRangeAtStart()

baseLineRangeAtEnd

@NotNull
@NotNull Range baseLineRangeAtEnd()

baseColumnAtEnd

int baseColumnAtEnd()

baseColumnAtStart

int baseColumnAtStart()