Class BasedSequenceImpl

java.lang.Object

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

com.vladsch.flexmark.util.sequence.BasedSequenceImpl

All Implemented Interfaces:

BasedOptionsHolder, BasedSequence, IRichSequence<BasedSequence>, SequenceUtils, CharSequence, Comparable<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 BasedOptionsHolder

BasedOptionsHolder.Options

Nested classes/interfaces inherited from interface BasedSequence

BasedSequence.EmptyBasedSequence

Field Summary

Fields inherited from interface BasedOptionsHolder

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

Fields inherited from interface BasedSequence

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

Fields inherited from interface 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

Modifier and Type	Method	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 Pair<Integer,Integer>	baseLineColumnAtEnd()
@NotNull Pair<Integer,Integer>	baseLineColumnAtIndex(int index)
@NotNull 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)
final @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	containsOnlyIn(@NotNull CharPredicate charSet)	Test for line contains only characters from the set
boolean	containsOnlyNotIn(@NotNull CharPredicate charSet)	Test for line containing only characters not in the set
boolean	containsSomeIn(@NotNull CharPredicate charSet)	Test for line containing some of the characters in the set
boolean	containsSomeNotIn(@NotNull CharPredicate charSet)	Test for line containing some characters not in the set
boolean	containsSomeOf(@NotNull BasedSequence other)	start/end offset based containment, not textual
(package private) static BasedSequence	create(@Nullable CharSequence charSequence)
@NotNull BasedSequence[]	emptyArray()
@NotNull BasedSequence	extendByAny(@NotNull CharPredicate charSet)
@NotNull BasedSequence	extendByAny(@NotNull CharPredicate charSet, int maxCount)	Extend this based sequence to include characters from underlying based sequence
@NotNull BasedSequence	extendByAnyNot(@NotNull CharPredicate charSet)
@NotNull BasedSequence	extendByAnyNot(@NotNull CharPredicate charSet, int maxCount)	Extend this based sequence to include characters from underlying based sequence not in character set
@NotNull BasedSequence	extendByOneOfAny(@NotNull CharPredicate charSet)
@NotNull BasedSequence	extendByOneOfAnyNot(@NotNull CharPredicate charSet)
final @NotNull BasedSequence	extendToEndOfLine()
final @NotNull BasedSequence	extendToEndOfLine(boolean includeEol)
final @NotNull BasedSequence	extendToEndOfLine(@NotNull CharPredicate eolChars)
final @NotNull BasedSequence	extendToEndOfLine(@NotNull CharPredicate eolChars, boolean includeEol)	Extend in contained based sequence
final @NotNull BasedSequence	extendToStartOfLine()
final @NotNull BasedSequence	extendToStartOfLine(boolean includeEol)
final @NotNull BasedSequence	extendToStartOfLine(@NotNull CharPredicate eolChars)
@NotNull BasedSequence	extendToStartOfLine(@NotNull CharPredicate eolChars, boolean includeEol)	Extend in contained based sequence
static BasedSequence	firstNonNull(BasedSequence... sequences)
@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
@NotNull SegmentTree	getSegmentTree()	Get the segment tree for this sequence or null if sequence is contiguous from startOffset to endOffset
@NotNull BasedSequence	intersect(@NotNull BasedSequence other)	start/end offset based intersection, not textual
boolean	isBaseCharAt(int index, @NotNull 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
@NotNull BasedSequence	nullSequence()
@NotNull BasedSequence	prefixOf(@NotNull BasedSequence other)	Get the prefix part of this from other, start/end offset based containment, not textual
@NotNull BasedSequence	prefixWith(@Nullable CharSequence prefix)	Prefix this sequence with a char sequence
final @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
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()
@NotNull BasedSequence	sequenceOf(@Nullable CharSequence charSequence, int startIndex, int endIndex)	Factory function
@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	suffixOf(@NotNull BasedSequence other)	Get the suffix part of this from other, start/end offset based containment, not textual
@NotNull BasedSequence	toMapped(CharMapper mapper)
@Nullable String	toStringOrNull()	Return string or null if BaseSequence.NULL
@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 class 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 Object

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

Methods inherited from interface BasedOptionsHolder

allOptions, anyOptions, getOption, getOptionFlags, getOptions

Methods inherited from interface BasedSequence

extendToAny, extendToAny, getBase, getBaseSequence, getEndOffset, getIndexOffset, getSourceRange, getStartOffset, subSequence

Methods inherited from interface CharSequence

charAt, chars, codePoints, getChars, length, toString

Methods inherited from interface Comparable

compareTo

Methods inherited from interface 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 Details

BasedSequenceImpl

public BasedSequenceImpl(int hash)

Method Details

firstNonNull

public static BasedSequence firstNonNull(BasedSequence... sequences)

emptyArray

@NotNull
public @NotNull BasedSequence[] emptyArray()

Specified by:

emptyArray in interface IRichSequence<BasedSequence>

nullSequence

@NotNull
public @NotNull BasedSequence nullSequence()

Specified by:

nullSequence in interface IRichSequence<BasedSequence>

sequenceOf

@NotNull
public @NotNull BasedSequence sequenceOf(@Nullable
 @Nullable 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 @NotNull 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
 @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 @NotNull 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 @NotNull BasedSequence toMapped(CharMapper mapper)

Specified by:

toMapped in interface IRichSequence<BasedSequence>

baseSubSequence

@NotNull
public final @NotNull 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 @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

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
 @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 @NotNull 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 @NotNull 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 @Nullable 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 @NotNull 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 @NotNull 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 @NotNull BasedSequence unescape(@NotNull
 @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 @NotNull BasedSequence normalizeEOL(@NotNull
 @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 @NotNull BasedSequence normalizeEndWithEOL(@NotNull
 @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
 @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
 @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 @NotNull BasedSequence spliceAtEnd(@NotNull
 @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
 @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
 @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 @NotNull BasedSequence intersect(@NotNull
 @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
 @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
 @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
 @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
 @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 @NotNull BasedSequence extendByAny(@NotNull
 @NotNull CharPredicate charSet)

Specified by:

extendByAny in interface BasedSequence

extendByOneOfAny

@NotNull
public @NotNull BasedSequence extendByOneOfAny(@NotNull
 @NotNull CharPredicate charSet)

Specified by:

extendByOneOfAny in interface BasedSequence

extendByAny

@NotNull
public @NotNull BasedSequence extendByAny(@NotNull
 @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 @NotNull BasedSequence extendByAnyNot(@NotNull
 @NotNull CharPredicate charSet)

Specified by:

extendByAnyNot in interface BasedSequence

extendByOneOfAnyNot

@NotNull
public @NotNull BasedSequence extendByOneOfAnyNot(@NotNull
 @NotNull CharPredicate charSet)

Specified by:

extendByOneOfAnyNot in interface BasedSequence

extendByAnyNot

@NotNull
public @NotNull BasedSequence extendByAnyNot(@NotNull
 @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 @NotNull BasedSequence extendToEndOfLine(@NotNull
 @NotNull CharPredicate eolChars)

Specified by:

extendToEndOfLine in interface BasedSequence

extendToEndOfLine

@NotNull
public final @NotNull BasedSequence extendToEndOfLine(boolean includeEol)

Specified by:

extendToEndOfLine in interface BasedSequence

extendToEndOfLine

@NotNull
public final @NotNull BasedSequence extendToEndOfLine()

Specified by:

extendToEndOfLine in interface BasedSequence

extendToStartOfLine

@NotNull
public final @NotNull BasedSequence extendToStartOfLine(@NotNull
 @NotNull CharPredicate eolChars)

Specified by:

extendToStartOfLine in interface BasedSequence

extendToStartOfLine

@NotNull
public final @NotNull BasedSequence extendToStartOfLine(boolean includeEol)

Specified by:

extendToStartOfLine in interface BasedSequence

extendToStartOfLine

@NotNull
public final @NotNull BasedSequence extendToStartOfLine()

Specified by:

extendToStartOfLine in interface BasedSequence

extendToEndOfLine

@NotNull
public final @NotNull BasedSequence extendToEndOfLine(@NotNull
 @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 @NotNull BasedSequence extendToStartOfLine(@NotNull
 @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 @NotNull BasedSequence prefixWith(@Nullable
 @Nullable 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 @NotNull BasedSequence prefixWithIndent()

Specified by:

prefixWithIndent in interface BasedSequence

prefixWithIndent

@NotNull
public @NotNull 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 @NotNull BasedSequence prefixOf(@NotNull
 @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 @NotNull BasedSequence suffixOf(@NotNull
 @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 @NotNull Range baseLineRangeAtIndex(int index)

Specified by:

baseLineRangeAtIndex in interface BasedSequence

baseLineColumnAtIndex

@NotNull
public @NotNull Pair<Integer,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 @NotNull Range baseLineRangeAtEnd()

Specified by:

baseLineRangeAtEnd in interface BasedSequence

baseLineColumnAtEnd

@NotNull
public @NotNull Pair<Integer,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 @NotNull Range baseLineRangeAtStart()

Specified by:

baseLineRangeAtStart in interface BasedSequence

baseLineColumnAtStart

@NotNull
public @NotNull Pair<Integer,Integer> baseLineColumnAtStart()

Specified by:

baseLineColumnAtStart in interface BasedSequence

create

static BasedSequence create(@Nullable
 @Nullable CharSequence charSequence)