Class IRichSequenceBase<T extends IRichSequence<T>>

java.lang.Object

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

All Implemented Interfaces:

IRichSequence<T>, SequenceUtils, CharSequence, Comparable<CharSequence>

Direct Known Subclasses:

BasedSequenceImpl, MappedRichSequence, RichSequenceImpl

public abstract class IRichSequenceBase<T extends IRichSequence<T>>
extends Object
implements IRichSequence<T>

An abstract base for RichSequence which implements most of the methods allowing subclasses to implement RichSequence with minimal support methods

Field Summary

Fields

Modifier and Type	Field	Description
private int	hash

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
IRichSequenceBase(int hash)	Constructor with pre-computed hash if available, 0 for lazy computation if length() not 0

Method Summary

Modifier and Type	Method	Description
final T	append(CharSequence... sequences)	Concatenate this sequence and list of others, returning sequence of result
final T	append(Iterable<? extends CharSequence> sequences)
final T	appendEOL()
final T	appendRangesTo(@NotNull StringBuilder out, @Nullable CharMapper charMapper, Range... ranges)	Append given ranges of this sequence to string builder
final T	appendRangesTo(@NotNull StringBuilder out, @Nullable CharMapper charMapper, Iterable<? extends Range> ranges)
final T	appendRangesTo(@NotNull StringBuilder out, Range... ranges)
final T	appendRangesTo(@NotNull StringBuilder out, Iterable<? extends Range> ranges)
final T	appendSpace()
final T	appendSpaces(int count)
final T	appendTo(@NotNull StringBuilder out)
final T	appendTo(@NotNull StringBuilder out, int startIndex)
final T	appendTo(@NotNull StringBuilder out, int startIndex, int endIndex)
final T	appendTo(@NotNull StringBuilder out, @Nullable CharMapper charMapper)
final T	appendTo(@NotNull StringBuilder out, @Nullable CharMapper charMapper, int startIndex)
final T	appendTo(@NotNull StringBuilder out, @Nullable CharMapper charMapper, int startIndex, int endIndex)	Append helpers
final @NotNull List<Range>	blankLinesRemovedRanges()
final @NotNull List<Range>	blankLinesRemovedRanges(int fromIndex)
final @NotNull List<Range>	blankLinesRemovedRanges(int fromIndex, int endIndex)
final @NotNull List<Range>	blankLinesRemovedRanges(@NotNull CharPredicate eolChars, int fromIndex, int endIndex)
final int	columnAtIndex(int index)
int	compareTo(@NotNull CharSequence o)
final int	countLeading(@NotNull CharPredicate chars)	Count leading/trailing characters of this sequence
final int	countLeading(@NotNull CharPredicate chars, int fromIndex)
final int	countLeading(@NotNull CharPredicate chars, int fromIndex, int endIndex)
final int	countLeadingColumns(int startColumn, @NotNull CharPredicate chars)	Count column of indent given by chars in the set in this sequence, expanding tabs to 4th column
final int	countLeadingNot(@NotNull CharPredicate chars)
final int	countLeadingNot(@NotNull CharPredicate chars, int fromIndex)
final int	countLeadingNot(@NotNull CharPredicate chars, int startIndex, int endIndex)
final int	countLeadingNotSpace()
final int	countLeadingNotSpace(int startIndex)
final int	countLeadingNotSpace(int startIndex, int endIndex)
final int	countLeadingNotSpaceTab()
final int	countLeadingNotSpaceTab(int startIndex)
final int	countLeadingNotSpaceTab(int startIndex, int endIndex)
final int	countLeadingNotWhitespace()
final int	countLeadingNotWhitespace(int startIndex)
final int	countLeadingNotWhitespace(int startIndex, int endIndex)
final int	countLeadingSpace()
final int	countLeadingSpace(int startIndex)
final int	countLeadingSpace(int startIndex, int endIndex)
final int	countLeadingSpaceTab()
final int	countLeadingSpaceTab(int startIndex)
final int	countLeadingSpaceTab(int startIndex, int endIndex)
final int	countLeadingWhitespace()
final int	countLeadingWhitespace(int startIndex)
final int	countLeadingWhitespace(int startIndex, int endIndex)
final int	countOfAny(@NotNull CharPredicate chars)
final int	countOfAny(@NotNull CharPredicate chars, int fromIndex)
final int	countOfAny(@NotNull CharPredicate s, int fromIndex, int endIndex)
final int	countOfAnyNot(@NotNull CharPredicate chars)
final int	countOfAnyNot(@NotNull CharPredicate chars, int fromIndex)
final int	countOfAnyNot(@NotNull CharPredicate chars, int startIndex, int endIndex)
final int	countOfNotSpaceTab()
final int	countOfNotWhitespace()
final int	countOfSpaceTab()
final int	countOfWhitespace()
final int	countTrailing(@NotNull CharPredicate chars)
final int	countTrailing(@NotNull CharPredicate chars, int fromIndex)
final int	countTrailing(@NotNull CharPredicate chars, int startIndex, int fromIndex)
final int	countTrailingNot(@NotNull CharPredicate chars)
final int	countTrailingNot(@NotNull CharPredicate chars, int fromIndex)
final int	countTrailingNot(@NotNull CharPredicate chars, int startIndex, int endIndex)
final int	countTrailingNotSpace()
final int	countTrailingNotSpace(int fromIndex)
final int	countTrailingNotSpace(int startIndex, int fromIndex)
final int	countTrailingNotSpaceTab()
final int	countTrailingNotSpaceTab(int fromIndex)
final int	countTrailingNotSpaceTab(int startIndex, int fromIndex)
final int	countTrailingNotWhitespace()
final int	countTrailingNotWhitespace(int fromIndex)
final int	countTrailingNotWhitespace(int startIndex, int fromIndex)
final int	countTrailingSpace()
final int	countTrailingSpace(int fromIndex)
final int	countTrailingSpace(int startIndex, int fromIndex)
final int	countTrailingSpaceTab()
final int	countTrailingSpaceTab(int fromIndex)
final int	countTrailingSpaceTab(int startIndex, int fromIndex)
final int	countTrailingWhitespace()
final int	countTrailingWhitespace(int fromIndex)
final int	countTrailingWhitespace(int startIndex, int fromIndex)
T	delete(int startIndex, int endIndex)	Delete range in sequence
final char	endCharAt(int index)	Convenience method to get characters offset from end of sequence.
final int	endOfDelimitedBy(@NotNull CharSequence s, int index)	Find start/end region in this sequence delimited by any characters in argument or the CharSequence
final int	endOfDelimitedByAny(@NotNull CharPredicate s, int index)
final int	endOfDelimitedByAnyNot(@NotNull CharPredicate s, int index)
final int	endOfLine(int index)	Get the offset of the end of line at given index, end of line delimited by \n
final int	endOfLineAnyEOL(int index)	Get the offset of the end of line at given index, end of line delimited by \n or any of \n \r \r\n for Any methods.
final T	endSequence(int startIndex)	Convenience method to get characters offset from endIndex of sequence.
final T	endSequence(int startIndex, int endIndex)	Convenience method to get characters offset from endIndex of sequence.
final boolean	endsWith(@NotNull CharPredicate chars)
final boolean	endsWith(@NotNull CharSequence suffix)	test if this sequence ends with given characters
final boolean	endsWith(@NotNull CharSequence suffix, boolean ignoreCase)	test if this sequence ends with given characters
final boolean	endsWithAnyEOL()
final boolean	endsWithEOL()
final boolean	endsWithIgnoreCase(@NotNull CharSequence suffix)	test if this sequence ends with given characters, ignoring case differences
final boolean	endsWithSpace()
final boolean	endsWithSpaceTab()
final boolean	endsWithWhitespace()
final int	eolEndLength()	Get the length of EOL character at the end of this sequence, if present.
final int	eolEndLength(int eolEnd)	Get the length of EOL character at the given index of this sequence, if present.
final @NotNull Range	eolEndRange(int eolEnd)	Return Range of eol at given index
final int	eolStartLength(int eolStart)	Get the length of EOL character at the given index of this sequence, if present.
@NotNull Range	eolStartRange(int eolStart)	Return Range of eol at given index
final boolean	equals(@Nullable Object other, boolean ignoreCase)	Test the sequence for a match to another CharSequence
final boolean	equals(Object o)	Equality comparison based on character content of this sequence, with quick fail resorting to content comparison only if length and hashCodes are equal
final boolean	equalsIgnoreCase(@Nullable Object other)	Test the sequence for a match to another CharSequence, ignoring case differences
final T	extractRanges(Range... ranges)	Build a sequence of ranges in this sequence
final T	extractRanges(Iterable<Range> ranges)
final char	firstChar()
final int	hashCode()	String hash code computation
final T	ifNull(T other)	If this sequence is the nullSequence() instance then returns other, otherwise returns this sequence.
final T	ifNullEmptyAfter(T other)	If this sequence is the nullSequence() instance then returns an empty subSequence from the end of other, otherwise returns this sequence.
final T	ifNullEmptyBefore(T other)	If this sequence is the nullSequence() instance then returns an empty subSequence from the start of other, otherwise returns this sequence.
final int	indexOf(char c)
final int	indexOf(char c, int fromIndex)
final int	indexOf(char c, int fromIndex, int endIndex)
final int	indexOf(@NotNull CharSequence s)	All index methods return the position or -1 if not found of the given character, characters or string.
final int	indexOf(@NotNull CharSequence s, int fromIndex)
final int	indexOf(@NotNull CharSequence s, int fromIndex, int endIndex)
final @NotNull int[]	indexOfAll(@NotNull CharSequence s)	Get indices of all occurrences of a sequence
final int	indexOfAny(@NotNull CharPredicate s)
final int	indexOfAny(@NotNull CharPredicate s, int index)
final int	indexOfAny(@NotNull CharPredicate s, int fromIndex, int endIndex)
final int	indexOfAnyNot(@NotNull CharPredicate s)
final int	indexOfAnyNot(@NotNull CharPredicate s, int fromIndex)
final int	indexOfAnyNot(@NotNull CharPredicate s, int fromIndex, int endIndex)
final int	indexOfNot(char c)
final int	indexOfNot(char c, int fromIndex)
final int	indexOfNot(char c, int fromIndex, int endIndex)
T	insert(int index, @NotNull CharSequence chars)	Insert char sequence at given index
final boolean	isBlank()
boolean	isCharAt(int index, @NotNull CharPredicate predicate)	Safe, if index out of range returns '\0'
final boolean	isEmpty()
boolean	isIn(@NotNull String[] texts)
boolean	isIn(@NotNull Collection<? extends CharSequence> texts)
final boolean	isNotBlank()
final boolean	isNotEmpty()
final boolean	isNotNull()
final boolean	isNull()
final char	lastChar()
final int	lastIndexOf(char c)
final int	lastIndexOf(char c, int fromIndex)
final int	lastIndexOf(char c, int startIndex, int fromIndex)
final int	lastIndexOf(@NotNull CharSequence s)
final int	lastIndexOf(@NotNull CharSequence s, int fromIndex)
final int	lastIndexOf(@NotNull CharSequence s, int startIndex, int fromIndex)
final int	lastIndexOfAny(@NotNull CharPredicate s)
final int	lastIndexOfAny(@NotNull CharPredicate s, int fromIndex)
final int	lastIndexOfAny(@NotNull CharPredicate s, int startIndex, int fromIndex)
final int	lastIndexOfAnyNot(@NotNull CharPredicate s)
final int	lastIndexOfAnyNot(@NotNull CharPredicate s, int fromIndex)
final int	lastIndexOfAnyNot(@NotNull CharPredicate s, int startIndex, int fromIndex)
final int	lastIndexOfNot(char c)
final int	lastIndexOfNot(char c, int fromIndex)
final int	lastIndexOfNot(char c, int startIndex, int fromIndex)
final @NotNull Range	leadingBlankLinesRange()
final @NotNull Range	leadingBlankLinesRange(int startIndex)
final @NotNull Range	leadingBlankLinesRange(int fromIndex, int endIndex)
final @NotNull Range	leadingBlankLinesRange(@NotNull CharPredicate eolChars, int fromIndex, int endIndex)	Get Range of leading blank lines at given index offsets in sequence
final T	lineAt(int index)	Get the line characters at given index, line delimited by \n
final T	lineAtAnyEOL(int index)	Get the line characters at given index, line delimited by \n, \r or \r\n
final @NotNull Pair<Integer,Integer>	lineColumnAtIndex(int index)	Get the line and column information from index into sequence
final @NotNull Range	lineRangeAt(int index)	Get the line characters at given index, line delimited by \n
final @NotNull Range	lineRangeAtAnyEOL(int index)	Get the line characters at given index, line delimited by \n, \r or \r\n
final boolean	matchChars(@NotNull CharSequence chars)	Test the sequence portion for a match to another CharSequence
final boolean	matchChars(@NotNull CharSequence chars, boolean ignoreCase)
final boolean	matchChars(@NotNull CharSequence chars, int startIndex)
final boolean	matchChars(@NotNull CharSequence chars, int startIndex, boolean ignoreCase)	Test the sequence portion for a match to another CharSequence
final boolean	matchCharsIgnoreCase(@NotNull CharSequence chars)
final boolean	matchCharsIgnoreCase(@NotNull CharSequence chars, int startIndex)
final boolean	matchCharsReversed(@NotNull CharSequence chars, int endIndex)
final boolean	matchCharsReversed(@NotNull CharSequence chars, int endIndex, boolean ignoreCase)	Test the sequence portion for a match to another CharSequence, reverse order
final boolean	matchCharsReversedIgnoreCase(@NotNull CharSequence chars, int endIndex)
final int	matchedCharCount(@NotNull CharSequence chars, int startIndex)
final int	matchedCharCount(@NotNull CharSequence chars, int startIndex, boolean ignoreCase)
final int	matchedCharCount(@NotNull CharSequence chars, int startIndex, int endIndex)
final int	matchedCharCount(@NotNull CharSequence chars, int startIndex, int endIndex, boolean ignoreCase)
final int	matchedCharCount(@NotNull CharSequence chars, int startIndex, int endIndex, boolean fullMatchOnly, boolean ignoreCase)	Test the sequence portion for a match to another CharSequence
final int	matchedCharCountIgnoreCase(@NotNull CharSequence chars, int startIndex)
final int	matchedCharCountIgnoreCase(@NotNull CharSequence chars, int startIndex, int endIndex)
final int	matchedCharCountReversed(@NotNull CharSequence chars, int fromIndex)
final int	matchedCharCountReversed(@NotNull CharSequence chars, int fromIndex, boolean ignoreCase)
final int	matchedCharCountReversed(@NotNull CharSequence chars, int startIndex, int fromIndex)
final int	matchedCharCountReversed(@NotNull CharSequence chars, int startIndex, int fromIndex, boolean ignoreCase)	Test the sequence portion for a match to another CharSequence, equivalent to taking this.subSequence(startIndex, fromIndex) and then count matching chars going from end of both sequences
final int	matchedCharCountReversedIgnoreCase(@NotNull CharSequence chars, int fromIndex)
final int	matchedCharCountReversedIgnoreCase(@NotNull CharSequence chars, int startIndex, int fromIndex)
final boolean	matches(@NotNull CharSequence chars)	Test the sequence for a match to another CharSequence
final boolean	matches(@NotNull CharSequence chars, boolean ignoreCase)
final boolean	matchesIgnoreCase(@NotNull CharSequence chars)
final char	midCharAt(int index)	Convenience method to get characters offset from start or end of sequence.
final T	midSequence(int startIndex)	Convenience method to get characters offset from start or end of sequence.
final T	midSequence(int startIndex, int endIndex)	Convenience method to get characters offset from start or end of sequence.
final @NotNull String	normalizeEndWithEOL()	replace any \r\n and \r by \n, append terminating EOL if one is not present
final @NotNull String	normalizeEOL()	replace any \r\n and \r by \n
final T	nullIf(boolean condition)	If condition is true return nullSequence() otherwise returns this sequence.
final T	nullIf(CharSequence... matches)	If this sequence matches one of given sequences return nullSequence() otherwise returns this sequence.
final T	nullIf(@NotNull BiPredicate<? super T, ? super CharSequence> predicate, CharSequence... matches)	If predicate returns true for this sequence and one of given sequences return nullSequence() otherwise returns this sequence.
final T	nullIf(@NotNull Predicate<? super CharSequence> predicate, CharSequence... matches)	If predicate returns true for one of given sequences return nullSequence() otherwise returns this sequence.
final T	nullIfBlank()	If this sequence is blank return nullSequence() otherwise returns this sequence.
final T	nullIfEmpty()	If this sequence is empty return nullSequence() otherwise returns this sequence.
final T	nullIfEndsWith(boolean ignoreCase, CharSequence... matches)
final T	nullIfEndsWith(CharSequence... matches)
final T	nullIfEndsWithIgnoreCase(CharSequence... matches)
final T	nullIfNot(CharSequence... matches)
final T	nullIfNot(@NotNull BiPredicate<? super T, ? super CharSequence> predicate, CharSequence... matches)
final T	nullIfNot(@NotNull Predicate<? super CharSequence> predicate, CharSequence... matches)
final T	nullIfNotEndsWith(boolean ignoreCase, CharSequence... matches)
final T	nullIfNotEndsWith(CharSequence... matches)
final T	nullIfNotEndsWithIgnoreCase(CharSequence... matches)
final T	nullIfNotStartsWith(boolean ignoreCase, CharSequence... matches)
final T	nullIfNotStartsWith(CharSequence... matches)
final T	nullIfNotStartsWithIgnoreCase(CharSequence... matches)
final T	nullIfStartsWith(boolean ignoreCase, CharSequence... matches)
final T	nullIfStartsWith(CharSequence... matches)
final T	nullIfStartsWithIgnoreCase(CharSequence... matches)
final T	padding(int length)
final T	padding(int length, char pad)	Get the chars needed for padding to length
T	padEnd(int length)
T	padEnd(int length, char pad)
T	padStart(int length)
T	padStart(int length, char pad)	Pad this sequence to given length
final T	prefixOnceWith(@Nullable CharSequence prefix)	Prefix this sequence with a char sequence if not already starting with prefix
final T	prefixOnceWithEOL()
final T	prefixOnceWithSpace()
T	prefixWith(@Nullable CharSequence prefix)	Prefix this sequence with a char sequence
final T	prefixWithEOL()
final T	prefixWithSpace()
final T	prefixWithSpaces(int count)
final T	removePrefix(@NotNull CharSequence prefix)	Remove prefix if present
final T	removePrefix(@NotNull CharSequence prefix, boolean ignoreCase)	Remove prefix if present
final T	removePrefixIgnoreCase(@NotNull CharSequence prefix)	Remove prefix if present, ignoring case differences
final T	removeProperPrefix(@NotNull CharSequence prefix)	Remove prefix if present but only if this sequence is longer than the suffix
final T	removeProperPrefix(@NotNull CharSequence prefix, boolean ignoreCase)	Remove prefix if present but only if this sequence is longer than the suffix
final T	removeProperPrefixIgnoreCase(@NotNull CharSequence prefix)	Remove prefix if present but only if this sequence is longer than the suffix, ignoring case differences
final T	removeProperSuffix(@NotNull CharSequence suffix)	Remove suffix if present but only if this sequence is longer than the suffix
final T	removeProperSuffix(@NotNull CharSequence suffix, boolean ignoreCase)	Remove suffix if present but only if this sequence is longer than the suffix
final T	removeProperSuffixIgnoreCase(@NotNull CharSequence suffix)	Remove suffix if present but only if this sequence is longer than the suffix, ignoring case differences
final T	removeSuffix(@NotNull CharSequence suffix)	Remove suffix if present
final T	removeSuffix(@NotNull CharSequence suffix, boolean ignoreCase)	Remove suffix if present
final T	removeSuffixIgnoreCase(@NotNull CharSequence suffix)	Remove suffix if present, ignoring case differences
final T	replace(int startIndex, int endIndex, @NotNull CharSequence replacement)	Replace part of the sequence with a char sequence
final T	replace(@NotNull CharSequence find, @NotNull CharSequence replace)	Replace all occurrences of one sequence with another
char	safeCharAt(int index)	return char at index or '\0' if index <0 or >=length()
T	safeSubSequence(int startIndex)	Get a portion of this sequence, if index < 0 use 0, if > length() use length
T	safeSubSequence(int startIndex, int endIndex)	Get a portion of this sequence, if index < 0 use 0, if > length() use length
final T	sequenceOf(@Nullable CharSequence charSequence)	Factory function
final T	sequenceOf(@Nullable CharSequence charSequence, int startIndex)	Factory function
final T[]	split(@NotNull CharSequence delimiter)
final T[]	split(@NotNull CharSequence delimiter, boolean includeDelims, @Nullable CharPredicate trimChars)
final T[]	split(@NotNull CharSequence delimiter, int limit, boolean includeDelims, @Nullable CharPredicate trimChars)
final T[]	split(@NotNull CharSequence delimiter, int limit, int flags)
final T[]	split(@NotNull CharSequence delimiter, int limit, int flags, @Nullable CharPredicate trimChars)
final T[]	splitEOL()
final T[]	splitEOL(boolean includeDelims)
final @NotNull List<T>	splitList(@NotNull CharSequence delimiter)
final @NotNull List<T>	splitList(@NotNull CharSequence delimiter, boolean includeDelims, @Nullable CharPredicate trimChars)
final @NotNull List<T>	splitList(@NotNull CharSequence delimiter, int limit, boolean includeDelims, @Nullable CharPredicate trimChars)	Split helpers based on delimiter character sets contained in CharPredicate
final @NotNull List<T>	splitList(@NotNull CharSequence delimiter, int limit, int flags)
final @NotNull List<T>	splitList(@NotNull CharSequence delimiter, int limit, int flags, @Nullable CharPredicate trimChars)	Split helpers based on delimiter character sets contained in CharSequence
final @NotNull List<T>	splitListEOL()
final @NotNull List<T>	splitListEOL(boolean includeDelims)
final @NotNull List<T>	splitListEOL(boolean includeDelims, @Nullable CharPredicate trimChars)
final int	startOfDelimitedBy(@NotNull CharSequence s, int index)
final int	startOfDelimitedByAny(@NotNull CharPredicate s, int index)
final int	startOfDelimitedByAnyNot(@NotNull CharPredicate s, int index)
final int	startOfLine(int index)	Get the offset of the start of line at given index, start of line delimited by \n
final int	startOfLineAnyEOL(int index)	Get the offset of the start of line at given index, start of line delimited by \n or any of \n \r \r\n for Any methods.
final boolean	startsWith(@NotNull CharPredicate chars)
final boolean	startsWith(@NotNull CharSequence prefix)	test if this sequence starts with given characters
final boolean	startsWith(@NotNull CharSequence prefix, boolean ignoreCase)	test if this sequence starts with given characters
final boolean	startsWithAnyEOL()
final boolean	startsWithEOL()
final boolean	startsWithIgnoreCase(@NotNull CharSequence prefix)	test if this sequence starts with given characters, ignoring case differences
final boolean	startsWithSpace()
final boolean	startsWithSpaceTab()
final boolean	startsWithWhitespace()
final T	subSequence(int startIndex)	Get a portion of this sequence starting from a given offset to endIndex of the sequence
final T	subSequence(@NotNull Range range)	Get a portion of this sequence selected by range
final T	subSequenceAfter(@NotNull Range range)	Get a portion of this sequence after one selected by range
final T	subSequenceBefore(@NotNull Range range)	Get a portion of this sequence before one selected by range
final Pair<T,T>	subSequenceBeforeAfter(Range range)	Get a portions of this sequence before and after one selected by range
final T	suffixOnceWith(@Nullable CharSequence suffix)	Suffix this sequence with a char sequence if not already ending with suffix
final T	suffixOnceWithEOL()
final T	suffixOnceWithSpace()
T	suffixWith(@Nullable CharSequence suffix)	Prefix this sequence with a char sequence
final T	suffixWithEOL()
final T	suffixWithSpace()
final T	suffixWithSpaces(int count)
final T	toLowerCase()	Map characters of this sequence to: Uppercase, Lowercase or use custom mapping
final T	toNbSp()	Map spaces to non break spaces
final T	toSpc()	Map non break spaces to spaces
@NotNull String	toString()
@Nullable String	toStringOrNull()	Return string or null if BaseSequence.NULL
final T	toUpperCase()
final @NotNull String	toVisibleWhitespaceString()
final @NotNull Range	trailingBlankLinesRange()
final @NotNull Range	trailingBlankLinesRange(int fromIndex)
final @NotNull Range	trailingBlankLinesRange(int startIndex, int fromIndex)
final @NotNull Range	trailingBlankLinesRange(CharPredicate eolChars, int startIndex, int fromIndex)	Get Range of trailing blank lines at given index offsets in sequence
final T	trim()
final T	trim(int keep)
final T	trim(int keep, @NotNull CharPredicate chars)
final T	trim(@NotNull CharPredicate chars)
final T	trimEnd()
final T	trimEnd(int keep)
final T	trimEnd(int keep, @NotNull CharPredicate chars)
final T	trimEnd(@NotNull CharPredicate chars)
final @NotNull Range	trimEndRange()
final @NotNull Range	trimEndRange(int keep)
final @NotNull Range	trimEndRange(int keep, @NotNull CharPredicate chars)
final @NotNull Range	trimEndRange(@NotNull CharPredicate chars)
final T	trimEOL()	Trim last eol at the end of this sequence,
final T	trimLeadBlankLines()
final @NotNull Pair<T,T>	trimmed()
final @NotNull Pair<T,T>	trimmed(int keep)
final @NotNull Pair<T,T>	trimmed(int keep, @NotNull CharPredicate chars)
final @NotNull Pair<T,T>	trimmed(@NotNull CharPredicate chars)
final T	trimmedEnd()
final T	trimmedEnd(int keep)
final T	trimmedEnd(int keep, @NotNull CharPredicate chars)
final T	trimmedEnd(@NotNull CharPredicate chars)
final T	trimmedEOL()	Get Trimmed part by IRichSequence.trimEOL()
final T	trimmedStart()
final T	trimmedStart(int keep)
final T	trimmedStart(int keep, @NotNull CharPredicate chars)	Get the characters Trimmed, Trimmed from start/end of this sequence, characters to trim are passed in the sequence argument
final T	trimmedStart(@NotNull CharPredicate chars)
final @NotNull Range	trimRange()
final @NotNull Range	trimRange(int keep)
final @NotNull Range	trimRange(int keep, @NotNull CharPredicate chars)
final @NotNull Range	trimRange(@NotNull CharPredicate chars)
final T	trimStart()
final T	trimStart(int keep)
final T	trimStart(int keep, @NotNull CharPredicate chars)	Trim, Trim start/end of this sequence, characters to trim are passed in the sequence argument
final T	trimStart(@NotNull CharPredicate chars)
final @NotNull Range	trimStartRange()
final @NotNull Range	trimStartRange(int keep)
final @NotNull Range	trimStartRange(int keep, @NotNull CharPredicate chars)	Range of kept sequence when trim start/end of this sequence is performed, characters to trim are passed in the sequence argument
final @NotNull Range	trimStartRange(@NotNull CharPredicate chars)
final T	trimTailBlankLines()	Trim leading trailing blank lines in this sequence
T	trimToEndOfLine()
T	trimToEndOfLine(boolean includeEol)
T	trimToEndOfLine(boolean includeEol, int index)
T	trimToEndOfLine(int index)
T	trimToEndOfLine(@NotNull CharPredicate eolChars, boolean includeEol, int index)	Trim end to end of line containing index
T	trimToStartOfLine()
T	trimToStartOfLine(boolean includeEol)
T	trimToStartOfLine(boolean includeEol, int index)
T	trimToStartOfLine(int index)
T	trimToStartOfLine(@NotNull CharPredicate eolChars, boolean includeEol, int index)	Trim start to start of line containing index
final void	validateIndex(int index)
final void	validateIndexInclusiveEnd(int index)
final void	validateStartEnd(int startIndex, int endIndex)

Methods inherited from class Object

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

Methods inherited from interface CharSequence

charAt, chars, codePoints, getChars, length

Methods inherited from interface IRichSequence

countLeading, countLeading, countOf, countTrailing, emptyArray, eolLength, eolStartLength, getBuilder, getColumnAtIndex, getLineColumnAtIndex, insert, nullIfEndsWithNot, nullIfStartsWithNot, nullSequence, sequenceOf, split, split, split, subSequence, toMapped

Field Details

hash

private int hash

Constructor Details

IRichSequenceBase

public IRichSequenceBase(int hash)

Constructor with pre-computed hash if available, 0 for lazy computation if length() not 0

NOTE: the hash code computed for this class is equivalent to the string hash of the same characters to ensure that equals can use the hash code for quick failure. CharSequence hash code is not specified therefore when in doubt about how it is computed then 0 should be passed to this constructor to compute one that is equal to the string content.

Parameters:

hash - hash code for the char sequence.

Method Details

equals

@Contract(pure=true,
          value="null -> false")
public final boolean equals(Object o)

Equality comparison based on character content of this sequence, with quick fail resorting to content comparison only if length and hashCodes are equal

Specified by:

equals in interface IRichSequence<T extends IRichSequence<T>>

Overrides:

equals in class Object

Parameters:

o - any char sequence

Returns:

true if character contents are equal

hashCode

@Contract(pure=true)
public final int hashCode()

String hash code computation

Specified by:

hashCode in interface IRichSequence<T extends IRichSequence<T>>

Overrides:

hashCode in class Object

Returns:

hash code of equivalent string

equalsIgnoreCase

@Contract(pure=true,
          value="null -> false")
public final boolean equalsIgnoreCase(@Nullable
 @Nullable Object other)

Description copied from interface: IRichSequence

Test the sequence for a match to another CharSequence, ignoring case differences

Specified by:

equalsIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

other - characters to match against

Returns:

true if match

equals

@Contract(pure=true,
          value="null, _ ->false")
public final boolean equals(@Nullable
 @Nullable Object other,
 boolean ignoreCase)

Description copied from interface: IRichSequence

Test the sequence for a match to another CharSequence

Specified by:

equals in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

other - characters to match against

ignoreCase - case ignored when true

Returns:

true if match

compareTo

public int compareTo(@NotNull
 @NotNull CharSequence o)

Specified by:

compareTo in interface Comparable<T extends IRichSequence<T>>

sequenceOf

@NotNull
public final T sequenceOf(@Nullable
 @Nullable CharSequence charSequence)

Description copied from interface: IRichSequence

Factory function

Specified by:

sequenceOf in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

charSequence - char sequence from which to construct a rich char sequence

Returns:

rich char sequence from given inputs

sequenceOf

@NotNull
public final T sequenceOf(@Nullable
 @Nullable CharSequence charSequence,
 int startIndex)

Description copied from interface: IRichSequence

Factory function

Specified by:

sequenceOf in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

charSequence - char sequence from which to construct a rich char sequence

startIndex - start index of the sequence to use

Returns:

rich char sequence from given inputs

subSequence

@NotNull
public final T subSequence(int startIndex)

Description copied from interface: IRichSequence

Get a portion of this sequence starting from a given offset to endIndex of the sequence

Specified by:

subSequence in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

startIndex - offset from startIndex of this sequence

Returns:

based sequence whose contents reflect the selected portion

subSequence

@NotNull
public final T subSequence(@NotNull
 @NotNull Range range)

Get a portion of this sequence selected by range

Specified by:

subSequence in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

range - range to get, coordinates offset form start of this sequence

Returns:

sequence whose contents reflect the selected portion, if range.isNull() then this is returned

subSequenceBefore

@NotNull
public final T subSequenceBefore(@NotNull
 @NotNull Range range)

Get a portion of this sequence before one selected by range

Specified by:

subSequenceBefore in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

range - range to get, coordinates offset form start of this sequence

Returns:

sequence whose contents come before the selected range, if range.isNull() then IRichSequence.nullSequence()

subSequenceAfter

@NotNull
public final T subSequenceAfter(@NotNull
 @NotNull Range range)

Get a portion of this sequence after one selected by range

Specified by:

subSequenceAfter in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

range - range to get, coordinates offset form start of this sequence

Returns:

sequence whose contents come after the selected range, if range.isNull() then IRichSequence.nullSequence()

subSequenceBeforeAfter

public final Pair<T,T> subSequenceBeforeAfter(Range range)

Get a portions of this sequence before and after one selected by range

Parameters:

range - range to get, coordinates offset form start of this sequence

Returns:

sequence whose contents come before and after the selected range, if range.isNull() then IRichSequence.nullSequence()

endSequence

@NotNull
public final T endSequence(int startIndex,
 int endIndex)

Description copied from interface: IRichSequence

Convenience method to get characters offset from endIndex of sequence. no exceptions are thrown, instead a \0 is returned for an invalid index positions

Specified by:

endSequence in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

startIndex - offset from endIndex of sequence [ 0..length() )

endIndex - offset from endIndex of sequence [ 0..length() )

Returns:

selected portion spanning length() - startIndex to length() - endIndex of this sequence

endSequence

@NotNull
public final T endSequence(int startIndex)

Description copied from interface: IRichSequence

Convenience method to get characters offset from endIndex of sequence. no exceptions are thrown, instead a \0 is returned for an invalid index positions

Specified by:

endSequence in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

startIndex - offset from endIndex of sequence [ 0..length() )

Returns:

selected portion spanning length() - startIndex to length() of this sequence

endCharAt

public final char endCharAt(int index)

Description copied from interface: IRichSequence

Convenience method to get characters offset from end of sequence. no exceptions are thrown, instead a \0 is returned for an invalid index positions

Specified by:

endCharAt in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - offset from end of sequence

Returns:

character located at length() - index in this sequence

midSequence

@NotNull
public final T midSequence(int startIndex,
 int endIndex)

Description copied from interface: IRichSequence

Convenience method to get characters offset from start or end of sequence. when offset >=0 then it is offset from the start of the sequence, when <0 then from the end

no exceptions are thrown, instead a \0 is returned for an invalid index positions

Specified by:

midSequence in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

startIndex - offset into this sequence

endIndex - offset into this sequence

Returns:

selected portion spanning startIndex to endIndex of this sequence. If offset is <0 then it is taken as relative to length()

midSequence

@NotNull
public final T midSequence(int startIndex)

Description copied from interface: IRichSequence

Convenience method to get characters offset from start or end of sequence. when offset >= then it is offset from the start of the sequence, when <0 then from the end

no exceptions are thrown, instead a \0 is returned for an invalid index positions

Specified by:

midSequence in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

startIndex - offset into this sequence

Returns:

selected portion spanning startIndex to length() of this sequence. If offset is <0 then it is taken as relative to length()

midCharAt

public final char midCharAt(int index)

Description copied from interface: IRichSequence

Convenience method to get characters offset from start or end of sequence. when index >= then it is offset from the start of the sequence, when <0 then from the end no exceptions are thrown, instead a \0 is returned for an invalid index positions

Specified by:

midCharAt in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - of character to get

Returns:

character at index or \0 if index is outside valid range for this sequence

lastChar

public final char lastChar()

Specified by:

lastChar in interface IRichSequence<T extends IRichSequence<T>>

Returns:

the last character of the sequence or '\0' if empty

firstChar

public final char firstChar()

Specified by:

firstChar in interface IRichSequence<T extends IRichSequence<T>>

Returns:

the first character of the sequence or '\0' if empty

validateIndex

public final void validateIndex(int index)

validateIndexInclusiveEnd

public final void validateIndexInclusiveEnd(int index)

validateStartEnd

public final void validateStartEnd(int startIndex,
 int endIndex)

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<T extends IRichSequence<T>>

Parameters:

index - index

Returns:

char or '\0'

safeSubSequence

@NotNull
public T safeSubSequence(int startIndex,
 int endIndex)

Description copied from interface: IRichSequence

Get a portion of this sequence, if index < 0 use 0, if > length() use length

NOTE: the returned value should only depend on start/end indices. If a subsequence of this sequence with matching start/end should equal (using equals()) all such subsequences of this sequence.

Specified by:

safeSubSequence in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

startIndex - offset from startIndex of this sequence

endIndex - offset from startIndex of this sequence

Returns:

based sequence whose contents reflect the selected portion

safeSubSequence

@NotNull
public T safeSubSequence(int startIndex)

Description copied from interface: IRichSequence

Get a portion of this sequence, if index < 0 use 0, if > length() use length

NOTE: the returned value should only depend on start/end indices. If a subsequence of this sequence with matching start/end should equal (using equals()) all such subsequences of this sequence.

Specified by:

safeSubSequence in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

startIndex - offset from startIndex of this sequence

Returns:

based sequence whose contents reflect the selected portion

isCharAt

public boolean isCharAt(int index,
 @NotNull
 @NotNull CharPredicate predicate)

Description copied from interface: IRichSequence

Safe, if index out of range returns '\0'

Specified by:

isCharAt in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - index in string

predicate - character set predicate

Returns:

true if character at index tests true

toStringOrNull

@Nullable
public @Nullable String toStringOrNull()

Description copied from interface: IRichSequence

Return string or null if BaseSequence.NULL

Specified by:

toStringOrNull in interface IRichSequence<T extends IRichSequence<T>>

Returns:

string or null if BaseSequence.NULL

indexOf

public final int indexOf(@NotNull
 @NotNull CharSequence s)

Description copied from interface: IRichSequence

All index methods return the position or -1 if not found of the given character, characters or string.

The basic methods have overloads for 1, 2, or 3 characters and CharSequence parameters. If fromIndex is not given then for forward searching methods 0 is taken as the value, for reverse searching methods length() is taken as the value

For forward searching methods fromIndex is the minimum start position for search and endIndex is the maximum end position, if not given the length() of string is assumed.

For reverse searching methods fromIndex is the maximum start position for search and startIndex is the minimum end position, if not given then 0 is assumed.

Specified by:

indexOf in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

s - character pre whose occurrence to find

Returns:

index where found or -1

indexOf

public final int indexOf(@NotNull
 @NotNull CharSequence s,
 int fromIndex)

Specified by:

indexOf in interface IRichSequence<T extends IRichSequence<T>>

indexOf

public final int indexOf(@NotNull
 @NotNull CharSequence s,
 int fromIndex,
 int endIndex)

Specified by:

indexOf in interface IRichSequence<T extends IRichSequence<T>>

indexOf

public final int indexOf(char c)

Specified by:

indexOf in interface IRichSequence<T extends IRichSequence<T>>

indexOf

public final int indexOf(char c,
 int fromIndex)

Specified by:

indexOf in interface IRichSequence<T extends IRichSequence<T>>

indexOfAny

public final int indexOfAny(@NotNull
 @NotNull CharPredicate s)

Specified by:

indexOfAny in interface IRichSequence<T extends IRichSequence<T>>

indexOfAny

public final int indexOfAny(@NotNull
 @NotNull CharPredicate s,
 int index)

Specified by:

indexOfAny in interface IRichSequence<T extends IRichSequence<T>>

indexOfAnyNot

public final int indexOfAnyNot(@NotNull
 @NotNull CharPredicate s)

Specified by:

indexOfAnyNot in interface IRichSequence<T extends IRichSequence<T>>

indexOfAnyNot

public final int indexOfAnyNot(@NotNull
 @NotNull CharPredicate s,
 int fromIndex)

Specified by:

indexOfAnyNot in interface IRichSequence<T extends IRichSequence<T>>

indexOfAnyNot

public final int indexOfAnyNot(@NotNull
 @NotNull CharPredicate s,
 int fromIndex,
 int endIndex)

Specified by:

indexOfAnyNot in interface IRichSequence<T extends IRichSequence<T>>

indexOfNot

public final int indexOfNot(char c)

Specified by:

indexOfNot in interface IRichSequence<T extends IRichSequence<T>>

indexOfNot

public final int indexOfNot(char c,
 int fromIndex)

Specified by:

indexOfNot in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOf

public final int lastIndexOf(char c)

Specified by:

lastIndexOf in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOf

public final int lastIndexOf(char c,
 int fromIndex)

Specified by:

lastIndexOf in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOfNot

public final int lastIndexOfNot(char c)

Specified by:

lastIndexOfNot in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOfNot

public final int lastIndexOfNot(char c,
 int fromIndex)

Specified by:

lastIndexOfNot in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOf

public final int lastIndexOf(@NotNull
 @NotNull CharSequence s)

Specified by:

lastIndexOf in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOf

public final int lastIndexOf(@NotNull
 @NotNull CharSequence s,
 int fromIndex)

Specified by:

lastIndexOf in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOfAny

public final int lastIndexOfAny(@NotNull
 @NotNull CharPredicate s,
 int fromIndex)

Specified by:

lastIndexOfAny in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOfAny

public final int lastIndexOfAny(@NotNull
 @NotNull CharPredicate s)

Specified by:

lastIndexOfAny in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOfAnyNot

public final int lastIndexOfAnyNot(@NotNull
 @NotNull CharPredicate s)

Specified by:

lastIndexOfAnyNot in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOfAnyNot

public final int lastIndexOfAnyNot(@NotNull
 @NotNull CharPredicate s,
 int fromIndex)

Specified by:

lastIndexOfAnyNot in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOfAnyNot

public final int lastIndexOfAnyNot(@NotNull
 @NotNull CharPredicate s,
 int startIndex,
 int fromIndex)

Specified by:

lastIndexOfAnyNot in interface IRichSequence<T extends IRichSequence<T>>

indexOf

public final int indexOf(char c,
 int fromIndex,
 int endIndex)

Specified by:

indexOf in interface IRichSequence<T extends IRichSequence<T>>

indexOfNot

public final int indexOfNot(char c,
 int fromIndex,
 int endIndex)

Specified by:

indexOfNot in interface IRichSequence<T extends IRichSequence<T>>

indexOfAny

public final int indexOfAny(@NotNull
 @NotNull CharPredicate s,
 int fromIndex,
 int endIndex)

Specified by:

indexOfAny in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOf

public final int lastIndexOf(@NotNull
 @NotNull CharSequence s,
 int startIndex,
 int fromIndex)

Specified by:

lastIndexOf in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOf

public final int lastIndexOf(char c,
 int startIndex,
 int fromIndex)

Specified by:

lastIndexOf in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOfNot

public final int lastIndexOfNot(char c,
 int startIndex,
 int fromIndex)

Specified by:

lastIndexOfNot in interface IRichSequence<T extends IRichSequence<T>>

lastIndexOfAny

public final int lastIndexOfAny(@NotNull
 @NotNull CharPredicate s,
 int startIndex,
 int fromIndex)

Specified by:

lastIndexOfAny in interface IRichSequence<T extends IRichSequence<T>>

countOfSpaceTab

public final int countOfSpaceTab()

Specified by:

countOfSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countOfNotSpaceTab

public final int countOfNotSpaceTab()

Specified by:

countOfNotSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countOfWhitespace

public final int countOfWhitespace()

Specified by:

countOfWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countOfNotWhitespace

public final int countOfNotWhitespace()

Specified by:

countOfNotWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countOfAny

public final int countOfAny(@NotNull
 @NotNull CharPredicate chars,
 int fromIndex)

Specified by:

countOfAny in interface IRichSequence<T extends IRichSequence<T>>

countOfAny

public final int countOfAny(@NotNull
 @NotNull CharPredicate chars)

Specified by:

countOfAny in interface IRichSequence<T extends IRichSequence<T>>

countOfAnyNot

public final int countOfAnyNot(@NotNull
 @NotNull CharPredicate chars,
 int fromIndex)

Specified by:

countOfAnyNot in interface IRichSequence<T extends IRichSequence<T>>

countOfAnyNot

public final int countOfAnyNot(@NotNull
 @NotNull CharPredicate chars)

Specified by:

countOfAnyNot in interface IRichSequence<T extends IRichSequence<T>>

countOfAny

public final int countOfAny(@NotNull
 @NotNull CharPredicate s,
 int fromIndex,
 int endIndex)

Specified by:

countOfAny in interface IRichSequence<T extends IRichSequence<T>>

countOfAnyNot

public final int countOfAnyNot(@NotNull
 @NotNull CharPredicate chars,
 int startIndex,
 int endIndex)

Specified by:

countOfAnyNot in interface IRichSequence<T extends IRichSequence<T>>

countLeading

public final int countLeading(@NotNull
 @NotNull CharPredicate chars)

Description copied from interface: IRichSequence

Count leading/trailing characters of this sequence

Parameters can be CharPredicate, counts any contiguous leading/trailing characters in the sequence which are contained in the given char set.

All functions have overloads: with no fromIndex then 0 is taken for leading and length() for trailing methods with fromIndex then this is taken as the start for leading and end for trailing methods with fromIndex and endIndex, counting will start at fromIndex and stop at endIndex

countLeading(CharPredicate): count contiguous leading characters from set in this sequence countLeadingNot(CharPredicate): count contiguous leading characters not from set in this sequence countTrailing(CharPredicate): count contiguous leading characters from set in this sequence countTrailingNot(CharPredicate): count contiguous leading characters not from set in this sequence

Specified by:

countLeading in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

chars - predicate for set of contiguous characters which should be counted

Returns:

number of chars in contiguous span at start of sequence

countLeading

public final int countLeading(@NotNull
 @NotNull CharPredicate chars,
 int fromIndex)

Specified by:

countLeading in interface IRichSequence<T extends IRichSequence<T>>

countLeadingNot

public final int countLeadingNot(@NotNull
 @NotNull CharPredicate chars)

Specified by:

countLeadingNot in interface IRichSequence<T extends IRichSequence<T>>

countLeadingNot

public final int countLeadingNot(@NotNull
 @NotNull CharPredicate chars,
 int fromIndex)

Specified by:

countLeadingNot in interface IRichSequence<T extends IRichSequence<T>>

countTrailing

public final int countTrailing(@NotNull
 @NotNull CharPredicate chars)

Specified by:

countTrailing in interface IRichSequence<T extends IRichSequence<T>>

countTrailing

public final int countTrailing(@NotNull
 @NotNull CharPredicate chars,
 int fromIndex)

Specified by:

countTrailing in interface IRichSequence<T extends IRichSequence<T>>

countTrailingNot

public final int countTrailingNot(@NotNull
 @NotNull CharPredicate chars)

Specified by:

countTrailingNot in interface IRichSequence<T extends IRichSequence<T>>

countTrailingNot

public final int countTrailingNot(@NotNull
 @NotNull CharPredicate chars,
 int fromIndex)

Specified by:

countTrailingNot in interface IRichSequence<T extends IRichSequence<T>>

countLeadingNot

public final int countLeadingNot(@NotNull
 @NotNull CharPredicate chars,
 int startIndex,
 int endIndex)

Specified by:

countLeadingNot in interface IRichSequence<T extends IRichSequence<T>>

countTrailingNot

public final int countTrailingNot(@NotNull
 @NotNull CharPredicate chars,
 int startIndex,
 int endIndex)

Specified by:

countTrailingNot in interface IRichSequence<T extends IRichSequence<T>>

countLeading

public final int countLeading(@NotNull
 @NotNull CharPredicate chars,
 int fromIndex,
 int endIndex)

Specified by:

countLeading in interface IRichSequence<T extends IRichSequence<T>>

countLeadingColumns

public final int countLeadingColumns(int startColumn,
 @NotNull
 @NotNull CharPredicate chars)

Description copied from interface: IRichSequence

Count column of indent given by chars in the set in this sequence, expanding tabs to 4th column

Specified by:

countLeadingColumns in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

startColumn - column of where this sequence starts

chars - whitespace characters

Returns:

column of first non-whitespace as given by chars

countTrailing

public final int countTrailing(@NotNull
 @NotNull CharPredicate chars,
 int startIndex,
 int fromIndex)

Specified by:

countTrailing in interface IRichSequence<T extends IRichSequence<T>>

countLeadingSpace

public final int countLeadingSpace()

Specified by:

countLeadingSpace in interface IRichSequence<T extends IRichSequence<T>>

countLeadingNotSpace

public final int countLeadingNotSpace()

Specified by:

countLeadingNotSpace in interface IRichSequence<T extends IRichSequence<T>>

countLeadingSpace

public final int countLeadingSpace(int startIndex)

Specified by:

countLeadingSpace in interface IRichSequence<T extends IRichSequence<T>>

countLeadingNotSpace

public final int countLeadingNotSpace(int startIndex)

Specified by:

countLeadingNotSpace in interface IRichSequence<T extends IRichSequence<T>>

countLeadingSpace

public final int countLeadingSpace(int startIndex,
 int endIndex)

Specified by:

countLeadingSpace in interface IRichSequence<T extends IRichSequence<T>>

countLeadingNotSpace

public final int countLeadingNotSpace(int startIndex,
 int endIndex)

Specified by:

countLeadingNotSpace in interface IRichSequence<T extends IRichSequence<T>>

countTrailingSpace

public final int countTrailingSpace()

Specified by:

countTrailingSpace in interface IRichSequence<T extends IRichSequence<T>>

countTrailingNotSpace

public final int countTrailingNotSpace()

Specified by:

countTrailingNotSpace in interface IRichSequence<T extends IRichSequence<T>>

countTrailingSpace

public final int countTrailingSpace(int fromIndex)

Specified by:

countTrailingSpace in interface IRichSequence<T extends IRichSequence<T>>

countTrailingNotSpace

public final int countTrailingNotSpace(int fromIndex)

Specified by:

countTrailingNotSpace in interface IRichSequence<T extends IRichSequence<T>>

countTrailingSpace

public final int countTrailingSpace(int startIndex,
 int fromIndex)

Specified by:

countTrailingSpace in interface IRichSequence<T extends IRichSequence<T>>

countTrailingNotSpace

public final int countTrailingNotSpace(int startIndex,
 int fromIndex)

Specified by:

countTrailingNotSpace in interface IRichSequence<T extends IRichSequence<T>>

countLeadingSpaceTab

public final int countLeadingSpaceTab()

Specified by:

countLeadingSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countLeadingNotSpaceTab

public final int countLeadingNotSpaceTab()

Specified by:

countLeadingNotSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countLeadingSpaceTab

public final int countLeadingSpaceTab(int startIndex)

Specified by:

countLeadingSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countLeadingNotSpaceTab

public final int countLeadingNotSpaceTab(int startIndex)

Specified by:

countLeadingNotSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countLeadingSpaceTab

public final int countLeadingSpaceTab(int startIndex,
 int endIndex)

Specified by:

countLeadingSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countLeadingNotSpaceTab

public final int countLeadingNotSpaceTab(int startIndex,
 int endIndex)

Specified by:

countLeadingNotSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countTrailingSpaceTab

public final int countTrailingSpaceTab()

Specified by:

countTrailingSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countTrailingNotSpaceTab

public final int countTrailingNotSpaceTab()

Specified by:

countTrailingNotSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countTrailingSpaceTab

public final int countTrailingSpaceTab(int fromIndex)

Specified by:

countTrailingSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countTrailingNotSpaceTab

public final int countTrailingNotSpaceTab(int fromIndex)

Specified by:

countTrailingNotSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countTrailingSpaceTab

public final int countTrailingSpaceTab(int startIndex,
 int fromIndex)

Specified by:

countTrailingSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countTrailingNotSpaceTab

public final int countTrailingNotSpaceTab(int startIndex,
 int fromIndex)

Specified by:

countTrailingNotSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

countLeadingWhitespace

public final int countLeadingWhitespace()

Specified by:

countLeadingWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countLeadingNotWhitespace

public final int countLeadingNotWhitespace()

Specified by:

countLeadingNotWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countLeadingWhitespace

public final int countLeadingWhitespace(int startIndex)

Specified by:

countLeadingWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countLeadingNotWhitespace

public final int countLeadingNotWhitespace(int startIndex)

Specified by:

countLeadingNotWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countLeadingWhitespace

public final int countLeadingWhitespace(int startIndex,
 int endIndex)

Specified by:

countLeadingWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countLeadingNotWhitespace

public final int countLeadingNotWhitespace(int startIndex,
 int endIndex)

Specified by:

countLeadingNotWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countTrailingWhitespace

public final int countTrailingWhitespace()

Specified by:

countTrailingWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countTrailingNotWhitespace

public final int countTrailingNotWhitespace()

Specified by:

countTrailingNotWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countTrailingWhitespace

public final int countTrailingWhitespace(int fromIndex)

Specified by:

countTrailingWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countTrailingNotWhitespace

public final int countTrailingNotWhitespace(int fromIndex)

Specified by:

countTrailingNotWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countTrailingWhitespace

public final int countTrailingWhitespace(int startIndex,
 int fromIndex)

Specified by:

countTrailingWhitespace in interface IRichSequence<T extends IRichSequence<T>>

countTrailingNotWhitespace

public final int countTrailingNotWhitespace(int startIndex,
 int fromIndex)

Specified by:

countTrailingNotWhitespace in interface IRichSequence<T extends IRichSequence<T>>

trimStart

@NotNull
public final T trimStart(@NotNull
 @NotNull CharPredicate chars)

Specified by:

trimStart in interface IRichSequence<T extends IRichSequence<T>>

trimmedStart

@NotNull
public final T trimmedStart(@NotNull
 @NotNull CharPredicate chars)

Specified by:

trimmedStart in interface IRichSequence<T extends IRichSequence<T>>

trimEnd

@NotNull
public final T trimEnd(@NotNull
 @NotNull CharPredicate chars)

Specified by:

trimEnd in interface IRichSequence<T extends IRichSequence<T>>

trimmedEnd

@NotNull
public final T trimmedEnd(@NotNull
 @NotNull CharPredicate chars)

Specified by:

trimmedEnd in interface IRichSequence<T extends IRichSequence<T>>

trim

@NotNull
public final T trim(@NotNull
 @NotNull CharPredicate chars)

Specified by:

trim in interface IRichSequence<T extends IRichSequence<T>>

trimmed

@NotNull
public final @NotNull Pair<T,T> trimmed(@NotNull
 @NotNull CharPredicate chars)

Specified by:

trimmed in interface IRichSequence<T extends IRichSequence<T>>

trimStart

@NotNull
public final T trimStart(int keep)

Specified by:

trimStart in interface IRichSequence<T extends IRichSequence<T>>

trimmedStart

@NotNull
public final T trimmedStart(int keep)

Specified by:

trimmedStart in interface IRichSequence<T extends IRichSequence<T>>

trimEnd

@NotNull
public final T trimEnd(int keep)

Specified by:

trimEnd in interface IRichSequence<T extends IRichSequence<T>>

trimmedEnd

@NotNull
public final T trimmedEnd(int keep)

Specified by:

trimmedEnd in interface IRichSequence<T extends IRichSequence<T>>

trim

@NotNull
public final T trim(int keep)

Specified by:

trim in interface IRichSequence<T extends IRichSequence<T>>

trimmed

@NotNull
public final @NotNull Pair<T,T> trimmed(int keep)

Specified by:

trimmed in interface IRichSequence<T extends IRichSequence<T>>

trimStart

@NotNull
public final T trimStart()

Specified by:

trimStart in interface IRichSequence<T extends IRichSequence<T>>

trimmedStart

@NotNull
public final T trimmedStart()

Specified by:

trimmedStart in interface IRichSequence<T extends IRichSequence<T>>

trimEnd

@NotNull
public final T trimEnd()

Specified by:

trimEnd in interface IRichSequence<T extends IRichSequence<T>>

trimmedEnd

@NotNull
public final T trimmedEnd()

Specified by:

trimmedEnd in interface IRichSequence<T extends IRichSequence<T>>

trim

@NotNull
public final T trim()

Specified by:

trim in interface IRichSequence<T extends IRichSequence<T>>

trimmed

@NotNull
public final @NotNull Pair<T,T> trimmed()

Specified by:

trimmed in interface IRichSequence<T extends IRichSequence<T>>

trimStart

@NotNull
public final T trimStart(int keep,
 @NotNull
 @NotNull CharPredicate chars)

Description copied from interface: IRichSequence

Trim, Trim start/end of this sequence, characters to trim are passed in the sequence argument

returns trimmed sequence or if nothing matched the original sequence

If character set in the form of character sequence is not passed in the SequenceUtils.WHITESPACE are assumed.

Specified by:

trimStart in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

keep - minimum length of would be trimmed characters to keep. ie. keep 4, will leave 0..4 as is but remove any >4

chars - set of characters to trim from start of line

Returns:

sequence after it is trimmed

trimmedStart

@NotNull
public final T trimmedStart(int keep,
 @NotNull
 @NotNull CharPredicate chars)

Description copied from interface: IRichSequence

Get the characters Trimmed, Trimmed from start/end of this sequence, characters to trim are passed in the sequence argument

returns trimmed sequence or if nothing matched the original sequence

The pair returning functions return before and after sequence

Specified by:

trimmedStart in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

keep - minimum length of would be trimmed characters to keep. ie. keep 4, will leave 0..4 as is but remove any >4

chars - set of characters to trim from start of line

Returns:

part of the sequence that was trimmed from the start

trimEnd

@NotNull
public final T trimEnd(int keep,
 @NotNull
 @NotNull CharPredicate chars)

Specified by:

trimEnd in interface IRichSequence<T extends IRichSequence<T>>

trimmedEnd

@NotNull
public final T trimmedEnd(int keep,
 @NotNull
 @NotNull CharPredicate chars)

Specified by:

trimmedEnd in interface IRichSequence<T extends IRichSequence<T>>

trim

@NotNull
public final T trim(int keep,
 @NotNull
 @NotNull CharPredicate chars)

Specified by:

trim in interface IRichSequence<T extends IRichSequence<T>>

trimmed

@NotNull
public final @NotNull Pair<T,T> trimmed(int keep,
 @NotNull
 @NotNull CharPredicate chars)

Specified by:

trimmed in interface IRichSequence<T extends IRichSequence<T>>

trimStartRange

@NotNull
public final @NotNull Range trimStartRange(int keep,
 @NotNull
 @NotNull CharPredicate chars)

Description copied from interface: IRichSequence

Range of kept sequence when trim start/end of this sequence is performed, characters to trim are passed in the sequence argument

returns range of kept sequence or if nothing matched then Range.NULL is returned, meaning keep all

If character set in the form of character sequence is not passed in the SequenceUtils.WHITESPACE are assumed.

Specified by:

trimStartRange in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

keep - minimum length of would be trimmed characters to keep. ie. keep 4, will leave 0..4 as is but remove any >4

chars - set of characters to trim from start of line

Returns:

range in this sequence to keep or Range.NULL if to keep all

trimEndRange

@NotNull
public final @NotNull Range trimEndRange(int keep,
 @NotNull
 @NotNull CharPredicate chars)

Specified by:

trimEndRange in interface IRichSequence<T extends IRichSequence<T>>

trimRange

@NotNull
public final @NotNull Range trimRange(int keep,
 @NotNull
 @NotNull CharPredicate chars)

Specified by:

trimRange in interface IRichSequence<T extends IRichSequence<T>>

trimStartRange

@NotNull
public final @NotNull Range trimStartRange(@NotNull
 @NotNull CharPredicate chars)

Specified by:

trimStartRange in interface IRichSequence<T extends IRichSequence<T>>

trimEndRange

@NotNull
public final @NotNull Range trimEndRange(@NotNull
 @NotNull CharPredicate chars)

Specified by:

trimEndRange in interface IRichSequence<T extends IRichSequence<T>>

trimRange

@NotNull
public final @NotNull Range trimRange(@NotNull
 @NotNull CharPredicate chars)

Specified by:

trimRange in interface IRichSequence<T extends IRichSequence<T>>

trimStartRange

@NotNull
public final @NotNull Range trimStartRange(int keep)

Specified by:

trimStartRange in interface IRichSequence<T extends IRichSequence<T>>

trimEndRange

@NotNull
public final @NotNull Range trimEndRange(int keep)

Specified by:

trimEndRange in interface IRichSequence<T extends IRichSequence<T>>

trimRange

@NotNull
public final @NotNull Range trimRange(int keep)

Specified by:

trimRange in interface IRichSequence<T extends IRichSequence<T>>

trimStartRange

@NotNull
public final @NotNull Range trimStartRange()

Specified by:

trimStartRange in interface IRichSequence<T extends IRichSequence<T>>

trimEndRange

@NotNull
public final @NotNull Range trimEndRange()

Specified by:

trimEndRange in interface IRichSequence<T extends IRichSequence<T>>

trimRange

@NotNull
public final @NotNull Range trimRange()

Specified by:

trimRange in interface IRichSequence<T extends IRichSequence<T>>

padding

@NotNull
public final T padding(int length,
 char pad)

Description copied from interface: IRichSequence

Get the chars needed for padding to length

Specified by:

padding in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

length - length

pad - char to use for padding

Returns:

padding chars

padding

@NotNull
public final T padding(int length)

Specified by:

padding in interface IRichSequence<T extends IRichSequence<T>>

padStart

@NotNull
public T padStart(int length,
 char pad)

Description copied from interface: IRichSequence

Pad this sequence to given length

Specified by:

padStart in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

length - length to pad

pad - char to use for padding

Returns:

sequence padded

padEnd

@NotNull
public T padEnd(int length,
 char pad)

Specified by:

padEnd in interface IRichSequence<T extends IRichSequence<T>>

padStart

@NotNull
public T padStart(int length)

Specified by:

padStart in interface IRichSequence<T extends IRichSequence<T>>

padEnd

@NotNull
public T padEnd(int length)

Specified by:

padEnd in interface IRichSequence<T extends IRichSequence<T>>

eolEndLength

public final int eolEndLength()

Description copied from interface: IRichSequence

Get the length of EOL character at the end of this sequence, if present.

\n - 1 \r - 1 \r\n - 2

Specified by:

eolEndLength in interface IRichSequence<T extends IRichSequence<T>>

Returns:

0 if no EOL, 1, or 2 depending on the EOL suffix of this sequence

eolEndLength

public final int eolEndLength(int eolEnd)

Description copied from interface: IRichSequence

Get the length of EOL character at the given index of this sequence, if present.

\n - 1 \r - 1 \r\n - 2

Specified by:

eolEndLength in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

eolEnd - index where the EOL ends, if any, any value can be passed for this argument. If > length of this sequence then it is the same as passing length(), if 0 or less then 0 is returned.

Returns:

0 if no EOL, 1, or 2 depending on the EOL suffix of this sequence

eolStartLength

public final int eolStartLength(int eolStart)

Description copied from interface: IRichSequence

Get the length of EOL character at the given index of this sequence, if present.

\n - 1 \r - 1 \r\n - 2

Specified by:

eolStartLength in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

eolStart - index where the EOL starts, if any, any value can be passed for this argument. If >= length of this sequence then 0 is returned if 0 or less then it is the same as 0

Returns:

0 if no EOL, 1, or 2 depending on the EOL suffix of this sequence

endOfLine

public final int endOfLine(int index)

Description copied from interface: IRichSequence

Get the offset of the end of line at given index, end of line delimited by \n

Specified by:

endOfLine in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - index where to start searching for end of line

Returns:

index of end of line delimited by \n

endOfLineAnyEOL

public final int endOfLineAnyEOL(int index)

Description copied from interface: IRichSequence

Get the offset of the end of line at given index, end of line delimited by \n or any of \n \r \r\n for Any methods.

Specified by:

endOfLineAnyEOL in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - index where to start searching for end of line

Returns:

index of end of line delimited by \n

startOfLine

public final int startOfLine(int index)

Description copied from interface: IRichSequence

Get the offset of the start of line at given index, start of line delimited by \n

Specified by:

startOfLine in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - index where to start searching for end of line

Returns:

index of end of line delimited by \n

startOfLineAnyEOL

public final int startOfLineAnyEOL(int index)

Description copied from interface: IRichSequence

Get the offset of the start of line at given index, start of line delimited by \n or any of \n \r \r\n for Any methods.

Specified by:

startOfLineAnyEOL in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - index where to start searching for end of line

Returns:

index of end of line delimited by \n

startOfDelimitedByAnyNot

public final int startOfDelimitedByAnyNot(@NotNull
 @NotNull CharPredicate s,
 int index)

Specified by:

startOfDelimitedByAnyNot in interface IRichSequence<T extends IRichSequence<T>>

endOfDelimitedByAnyNot

public final int endOfDelimitedByAnyNot(@NotNull
 @NotNull CharPredicate s,
 int index)

Specified by:

endOfDelimitedByAnyNot in interface IRichSequence<T extends IRichSequence<T>>

startOfDelimitedBy

public final int startOfDelimitedBy(@NotNull
 @NotNull CharSequence s,
 int index)

Specified by:

startOfDelimitedBy in interface IRichSequence<T extends IRichSequence<T>>

startOfDelimitedByAny

public final int startOfDelimitedByAny(@NotNull
 @NotNull CharPredicate s,
 int index)

Specified by:

startOfDelimitedByAny in interface IRichSequence<T extends IRichSequence<T>>

endOfDelimitedBy

public final int endOfDelimitedBy(@NotNull
 @NotNull CharSequence s,
 int index)

Description copied from interface: IRichSequence

Find start/end region in this sequence delimited by any characters in argument or the CharSequence

For Any and AnyNot methods uses the CharSequence argument as a character set of possible delimiting characters

Specified by:

endOfDelimitedBy in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

s - character sequence delimiting the region

index - from which to start looking for end of region

Returns:

index of end of region delimited by s

endOfDelimitedByAny

public final int endOfDelimitedByAny(@NotNull
 @NotNull CharPredicate s,
 int index)

Specified by:

endOfDelimitedByAny in interface IRichSequence<T extends IRichSequence<T>>

lineRangeAt

@NotNull
public final @NotNull Range lineRangeAt(int index)

Description copied from interface: IRichSequence

Get the line characters at given index, line delimited by \n

Specified by:

lineRangeAt in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - index at which to get the line

Returns:

range in sequence for the line delimited by '\n', containing index

lineRangeAtAnyEOL

@NotNull
public final @NotNull Range lineRangeAtAnyEOL(int index)

Description copied from interface: IRichSequence

Get the line characters at given index, line delimited by \n, \r or \r\n

Specified by:

lineRangeAtAnyEOL in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - index at which to get the line

Returns:

range in sequence for the line delimited by end of line, containing index

lineAt

@NotNull
public final T lineAt(int index)

Description copied from interface: IRichSequence

Get the line characters at given index, line delimited by \n

Specified by:

lineAt in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - index at which to get the line

Returns:

sub-sequence for the line containing index

lineAtAnyEOL

@NotNull
public final T lineAtAnyEOL(int index)

Description copied from interface: IRichSequence

Get the line characters at given index, line delimited by \n, \r or \r\n

Specified by:

lineAtAnyEOL in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - index at which to get the line

Returns:

sub-sequence for the line containing index

eolEndRange

@NotNull
public final @NotNull Range eolEndRange(int eolEnd)

Description copied from interface: IRichSequence

Return Range of eol at given index

Specified by:

eolEndRange in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

eolEnd - index where the EOL ends, if any, any value can be passed for this argument. If > length of this sequence then it is the same as passing length(), if 0 or less then 0 is returned.

Returns:

range of eol given by index of its end or Range.NULL if no eol ends at index

eolStartRange

@NotNull
public @NotNull Range eolStartRange(int eolStart)

Description copied from interface: IRichSequence

Return Range of eol at given index

Specified by:

eolStartRange in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

eolStart - index where the EOL starts, if any, any value can be passed for this argument. If >= length of this sequence then 0 is returned if 0 or less then it is the same as 0

Returns:

range of eol given by index of its end or Range.NULL if no eol starts at index

trimEOL

@NotNull
public final T trimEOL()

Description copied from interface: IRichSequence

Trim last eol at the end of this sequence,

Specified by:

trimEOL in interface IRichSequence<T extends IRichSequence<T>>

Returns:

sequence with one EOL trimmed off if it had one

trimmedEOL

@NotNull
public final T trimmedEOL()

Description copied from interface: IRichSequence

Get Trimmed part by IRichSequence.trimEOL()

Specified by:

trimmedEOL in interface IRichSequence<T extends IRichSequence<T>>

Returns:

trimmed off EOL if sequence had one or IRichSequence.nullSequence()

trimTailBlankLines

@NotNull
public final T trimTailBlankLines()

Description copied from interface: IRichSequence

Trim leading trailing blank lines in this sequence

Specified by:

trimTailBlankLines in interface IRichSequence<T extends IRichSequence<T>>

Returns:

return sequence with trailing blank lines trimmed off

trimLeadBlankLines

@NotNull
public final T trimLeadBlankLines()

Specified by:

trimLeadBlankLines in interface IRichSequence<T extends IRichSequence<T>>

leadingBlankLinesRange

@NotNull
public final @NotNull Range leadingBlankLinesRange()

Specified by:

leadingBlankLinesRange in interface IRichSequence<T extends IRichSequence<T>>

leadingBlankLinesRange

@NotNull
public final @NotNull Range leadingBlankLinesRange(int startIndex)

Specified by:

leadingBlankLinesRange in interface IRichSequence<T extends IRichSequence<T>>

leadingBlankLinesRange

@NotNull
public final @NotNull Range leadingBlankLinesRange(int fromIndex,
 int endIndex)

Specified by:

leadingBlankLinesRange in interface IRichSequence<T extends IRichSequence<T>>

trailingBlankLinesRange

@NotNull
public final @NotNull Range trailingBlankLinesRange()

Specified by:

trailingBlankLinesRange in interface IRichSequence<T extends IRichSequence<T>>

trailingBlankLinesRange

@NotNull
public final @NotNull Range trailingBlankLinesRange(int fromIndex)

Specified by:

trailingBlankLinesRange in interface IRichSequence<T extends IRichSequence<T>>

trailingBlankLinesRange

@NotNull
public final @NotNull Range trailingBlankLinesRange(int startIndex,
 int fromIndex)

Specified by:

trailingBlankLinesRange in interface IRichSequence<T extends IRichSequence<T>>

trailingBlankLinesRange

@NotNull
public final @NotNull Range trailingBlankLinesRange(CharPredicate eolChars,
 int startIndex,
 int fromIndex)

Description copied from interface: IRichSequence

Get Range of trailing blank lines at given index offsets in sequence

Specified by:

trailingBlankLinesRange in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

eolChars - characters to consider as EOL, note IRichSequence.eolStartLength(int) should report length of EOL found if length > 1

startIndex - index in sequence from which to start blank line search, also maximum index to include in blank lines range can be any value, if less than 0 it is the same as 0, if greater than length() it is the same as length()

fromIndex - maximum index in sequence to check and include in range of blank lines can be any value, if less than 0 it is the same as 0, if greater than length() it is the same as length()

Returns:

range of blank lines at or before fromIndex and ranging to minimum of startIndex if the range in sequence contains only whitespace characters then the whole range will be returned even if contains no EOL characters

leadingBlankLinesRange

@NotNull
public final @NotNull Range leadingBlankLinesRange(@NotNull
 @NotNull CharPredicate eolChars,
 int fromIndex,
 int endIndex)

Description copied from interface: IRichSequence

Get Range of leading blank lines at given index offsets in sequence

Specified by:

leadingBlankLinesRange in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

eolChars - characters to consider as EOL, note IRichSequence.eolStartLength(int) should report length of EOL found if length > 1

fromIndex - minimum index in sequence to check and include in range of blank lines can be any value, if less than 0 it is the same as 0, if greater than length() it is the same as length()

endIndex - index in sequence from which to start blank line search, also maximum index to include in blank lines range can be any value, if less than 0 it is the same as 0, if greater than length() it is the same as length()

Returns:

range of blank lines at or before fromIndex and ranging to minimum of startIndex, Range.NULL if none found if the range in sequence contains only whitespace characters then the whole range will be returned even if contains no EOL characters

blankLinesRemovedRanges

@NotNull
public final @NotNull List<Range> blankLinesRemovedRanges()

Specified by:

blankLinesRemovedRanges in interface IRichSequence<T extends IRichSequence<T>>

blankLinesRemovedRanges

@NotNull
public final @NotNull List<Range> blankLinesRemovedRanges(int fromIndex)

Specified by:

blankLinesRemovedRanges in interface IRichSequence<T extends IRichSequence<T>>

blankLinesRemovedRanges

@NotNull
public final @NotNull List<Range> blankLinesRemovedRanges(int fromIndex,
 int endIndex)

Specified by:

blankLinesRemovedRanges in interface IRichSequence<T extends IRichSequence<T>>

blankLinesRemovedRanges

@NotNull
public final @NotNull List<Range> blankLinesRemovedRanges(@NotNull
 @NotNull CharPredicate eolChars,
 int fromIndex,
 int endIndex)

Specified by:

blankLinesRemovedRanges in interface IRichSequence<T extends IRichSequence<T>>

trimToEndOfLine

@NotNull
public T trimToEndOfLine(boolean includeEol)

Specified by:

trimToEndOfLine in interface IRichSequence<T extends IRichSequence<T>>

trimToEndOfLine

@NotNull
public T trimToEndOfLine(int index)

Specified by:

trimToEndOfLine in interface IRichSequence<T extends IRichSequence<T>>

trimToEndOfLine

@NotNull
public T trimToEndOfLine()

Specified by:

trimToEndOfLine in interface IRichSequence<T extends IRichSequence<T>>

trimToEndOfLine

@NotNull
public T trimToEndOfLine(boolean includeEol,
 int index)

Specified by:

trimToEndOfLine in interface IRichSequence<T extends IRichSequence<T>>

trimToStartOfLine

@NotNull
public T trimToStartOfLine(boolean includeEol)

Specified by:

trimToStartOfLine in interface IRichSequence<T extends IRichSequence<T>>

trimToStartOfLine

@NotNull
public T trimToStartOfLine(int index)

Specified by:

trimToStartOfLine in interface IRichSequence<T extends IRichSequence<T>>

trimToStartOfLine

@NotNull
public T trimToStartOfLine()

Specified by:

trimToStartOfLine in interface IRichSequence<T extends IRichSequence<T>>

trimToStartOfLine

@NotNull
public T trimToStartOfLine(boolean includeEol,
 int index)

Specified by:

trimToStartOfLine in interface IRichSequence<T extends IRichSequence<T>>

trimToEndOfLine

@NotNull
public T trimToEndOfLine(@NotNull
 @NotNull CharPredicate eolChars,
 boolean includeEol,
 int index)

Description copied from interface: IRichSequence

Trim end to end of line containing index

Specified by:

trimToEndOfLine in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

eolChars - characters to consider as EOL, note IRichSequence.eolStartLength(int) should report length of EOL found if length > 1

includeEol - true if EOL is to be included in the line

index - index for offset contained by the line can be any value, if less than 0 it is the same as 0, if greater than length() it is the same as length()

Returns:

trimmed version of the sequence to given EOL or the original sequence

trimToStartOfLine

@NotNull
public T trimToStartOfLine(@NotNull
 @NotNull CharPredicate eolChars,
 boolean includeEol,
 int index)

Description copied from interface: IRichSequence

Trim start to start of line containing index

Specified by:

trimToStartOfLine in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

eolChars - characters to consider as EOL, note IRichSequence.eolStartLength(int) should report length of EOL found if length > 1

includeEol - true if EOL is to be included in the line

index - index for offset contained by the line can be any value, if less than 0 it is the same as 0, if greater than length() it is the same as length()

Returns:

trimmed version of the sequence to given EOL or the original sequence

ifNull

@NotNull
public final T ifNull(@NotNull
 T other)

Description copied from interface: IRichSequence

If this sequence is the nullSequence() instance then returns other, otherwise returns this sequence.

Specified by:

ifNull in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

other - based sequence to return if this is nullSequence()

Returns:

this or other

ifNullEmptyAfter

@NotNull
public final T ifNullEmptyAfter(@NotNull
 T other)

Description copied from interface: IRichSequence

If this sequence is the nullSequence() instance then returns an empty subSequence from the end of other, otherwise returns this sequence.

Specified by:

ifNullEmptyAfter in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

other - based sequence from which to take the empty sequence

Returns:

this or other.subSequence(other.length(), other.length())

ifNullEmptyBefore

@NotNull
public final T ifNullEmptyBefore(@NotNull
 T other)

Description copied from interface: IRichSequence

If this sequence is the nullSequence() instance then returns an empty subSequence from the start of other, otherwise returns this sequence.

Specified by:

ifNullEmptyBefore in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

other - based sequence from which to take the empty sequence

Returns:

this or other.subSequence(0, 0)

nullIfEmpty

@NotNull
public final T nullIfEmpty()

Description copied from interface: IRichSequence

If this sequence is empty return nullSequence() otherwise returns this sequence.

Specified by:

nullIfEmpty in interface IRichSequence<T extends IRichSequence<T>>

Returns:

this or nullSequence()

nullIfBlank

@NotNull
public final T nullIfBlank()

Description copied from interface: IRichSequence

If this sequence is blank return nullSequence() otherwise returns this sequence.

Specified by:

nullIfBlank in interface IRichSequence<T extends IRichSequence<T>>

Returns:

this or nullSequence()

nullIf

@NotNull
public final T nullIf(boolean condition)

Description copied from interface: IRichSequence

If condition is true return nullSequence() otherwise returns this sequence.

Specified by:

nullIf in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

condition - when true return NULL else this

Returns:

this or nullSequence()

nullIfNot

@NotNull
public final T nullIfNot(@NotNull
 @NotNull BiPredicate<? super T, ? super CharSequence> predicate,
 CharSequence... matches)

Specified by:

nullIfNot in interface IRichSequence<T extends IRichSequence<T>>

nullIf

@NotNull
public final T nullIf(@NotNull
 @NotNull Predicate<? super CharSequence> predicate,
 CharSequence... matches)

Description copied from interface: IRichSequence

If predicate returns true for one of given sequences return nullSequence() otherwise returns this sequence.

Specified by:

nullIf in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

predicate - sequence predicate

matches - match sequence list

Returns:

this or nullSequence()

nullIfNot

@NotNull
public final T nullIfNot(@NotNull
 @NotNull Predicate<? super CharSequence> predicate,
 CharSequence... matches)

Specified by:

nullIfNot in interface IRichSequence<T extends IRichSequence<T>>

nullIf

@NotNull
public final T nullIf(CharSequence... matches)

Description copied from interface: IRichSequence

If this sequence matches one of given sequences return nullSequence() otherwise returns this sequence.

Specified by:

nullIf in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

matches - match sequence list

Returns:

this or nullSequence()

nullIfNot

@NotNull
public final T nullIfNot(CharSequence... matches)

Specified by:

nullIfNot in interface IRichSequence<T extends IRichSequence<T>>

nullIfStartsWith

@NotNull
public final T nullIfStartsWith(CharSequence... matches)

Specified by:

nullIfStartsWith in interface IRichSequence<T extends IRichSequence<T>>

nullIfNotStartsWith

@NotNull
public final T nullIfNotStartsWith(CharSequence... matches)

Specified by:

nullIfNotStartsWith in interface IRichSequence<T extends IRichSequence<T>>

nullIfEndsWith

@NotNull
public final T nullIfEndsWith(CharSequence... matches)

Specified by:

nullIfEndsWith in interface IRichSequence<T extends IRichSequence<T>>

nullIfNotEndsWith

@NotNull
public final T nullIfNotEndsWith(CharSequence... matches)

Specified by:

nullIfNotEndsWith in interface IRichSequence<T extends IRichSequence<T>>

nullIfStartsWithIgnoreCase

@NotNull
public final T nullIfStartsWithIgnoreCase(CharSequence... matches)

Specified by:

nullIfStartsWithIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

nullIfNotStartsWithIgnoreCase

@NotNull
public final T nullIfNotStartsWithIgnoreCase(CharSequence... matches)

Specified by:

nullIfNotStartsWithIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

nullIfEndsWithIgnoreCase

@NotNull
public final T nullIfEndsWithIgnoreCase(CharSequence... matches)

Specified by:

nullIfEndsWithIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

nullIfNotEndsWithIgnoreCase

@NotNull
public final T nullIfNotEndsWithIgnoreCase(CharSequence... matches)

Specified by:

nullIfNotEndsWithIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

nullIfStartsWith

@NotNull
public final T nullIfStartsWith(boolean ignoreCase,
 CharSequence... matches)

Specified by:

nullIfStartsWith in interface IRichSequence<T extends IRichSequence<T>>

nullIfNotStartsWith

@NotNull
public final T nullIfNotStartsWith(boolean ignoreCase,
 CharSequence... matches)

Specified by:

nullIfNotStartsWith in interface IRichSequence<T extends IRichSequence<T>>

nullIfEndsWith

@NotNull
public final T nullIfEndsWith(boolean ignoreCase,
 CharSequence... matches)

Specified by:

nullIfEndsWith in interface IRichSequence<T extends IRichSequence<T>>

nullIfNotEndsWith

@NotNull
public final T nullIfNotEndsWith(boolean ignoreCase,
 CharSequence... matches)

Specified by:

nullIfNotEndsWith in interface IRichSequence<T extends IRichSequence<T>>

nullIf

@NotNull
public final T nullIf(@NotNull
 @NotNull BiPredicate<? super T, ? super CharSequence> predicate,
 CharSequence... matches)

Description copied from interface: IRichSequence

If predicate returns true for this sequence and one of given sequences return nullSequence() otherwise returns this sequence.

Specified by:

nullIf in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

predicate - bi predicate for test, first argument is always this, second is one of the match sequences

matches - match sequence list

Returns:

this or nullSequence()

isNull

public final boolean isNull()

Specified by:

isNull in interface IRichSequence<T extends IRichSequence<T>>

isNotNull

public final boolean isNotNull()

Specified by:

isNotNull in interface IRichSequence<T extends IRichSequence<T>>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface CharSequence

Specified by:

isEmpty in interface IRichSequence<T extends IRichSequence<T>>

isBlank

public final boolean isBlank()

Specified by:

isBlank in interface IRichSequence<T extends IRichSequence<T>>

isNotEmpty

public final boolean isNotEmpty()

Specified by:

isNotEmpty in interface IRichSequence<T extends IRichSequence<T>>

isNotBlank

public final boolean isNotBlank()

Specified by:

isNotBlank in interface IRichSequence<T extends IRichSequence<T>>

endsWith

public final boolean endsWith(@NotNull
 @NotNull CharSequence suffix)

Description copied from interface: IRichSequence

test if this sequence ends with given characters

Specified by:

endsWith in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

suffix - characters to test

Returns:

true if ends with suffix

endsWith

public final boolean endsWith(@NotNull
 @NotNull CharSequence suffix,
 boolean ignoreCase)

Description copied from interface: IRichSequence

test if this sequence ends with given characters

Specified by:

endsWith in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

suffix - characters to test

ignoreCase - case ignored when true

Returns:

true if ends with suffix

startsWith

public final boolean startsWith(@NotNull
 @NotNull CharSequence prefix)

Description copied from interface: IRichSequence

test if this sequence starts with given characters

Specified by:

startsWith in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

prefix - characters to test

Returns:

true if starts with prefix

startsWith

public final boolean startsWith(@NotNull
 @NotNull CharSequence prefix,
 boolean ignoreCase)

Description copied from interface: IRichSequence

test if this sequence starts with given characters

Specified by:

startsWith in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

prefix - characters to test

ignoreCase - case ignored when true

Returns:

true if starts with prefix

endsWith

public final boolean endsWith(@NotNull
 @NotNull CharPredicate chars)

Specified by:

endsWith in interface IRichSequence<T extends IRichSequence<T>>

startsWith

public final boolean startsWith(@NotNull
 @NotNull CharPredicate chars)

Specified by:

startsWith in interface IRichSequence<T extends IRichSequence<T>>

endsWithEOL

public final boolean endsWithEOL()

Specified by:

endsWithEOL in interface IRichSequence<T extends IRichSequence<T>>

endsWithAnyEOL

public final boolean endsWithAnyEOL()

Specified by:

endsWithAnyEOL in interface IRichSequence<T extends IRichSequence<T>>

endsWithSpace

public final boolean endsWithSpace()

Specified by:

endsWithSpace in interface IRichSequence<T extends IRichSequence<T>>

endsWithSpaceTab

public final boolean endsWithSpaceTab()

Specified by:

endsWithSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

endsWithWhitespace

public final boolean endsWithWhitespace()

Specified by:

endsWithWhitespace in interface IRichSequence<T extends IRichSequence<T>>

startsWithEOL

public final boolean startsWithEOL()

Specified by:

startsWithEOL in interface IRichSequence<T extends IRichSequence<T>>

startsWithAnyEOL

public final boolean startsWithAnyEOL()

Specified by:

startsWithAnyEOL in interface IRichSequence<T extends IRichSequence<T>>

startsWithSpace

public final boolean startsWithSpace()

Specified by:

startsWithSpace in interface IRichSequence<T extends IRichSequence<T>>

startsWithSpaceTab

public final boolean startsWithSpaceTab()

Specified by:

startsWithSpaceTab in interface IRichSequence<T extends IRichSequence<T>>

startsWithWhitespace

public final boolean startsWithWhitespace()

Specified by:

startsWithWhitespace in interface IRichSequence<T extends IRichSequence<T>>

removeSuffix

@NotNull
public final T removeSuffix(@NotNull
 @NotNull CharSequence suffix)

Description copied from interface: IRichSequence

Remove suffix if present

Specified by:

removeSuffix in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

suffix - characters to remove

Returns:

sequence with suffix removed, or same sequence if no suffix was present

removePrefix

@NotNull
public final T removePrefix(@NotNull
 @NotNull CharSequence prefix)

Description copied from interface: IRichSequence

Remove prefix if present

Specified by:

removePrefix in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

prefix - characters to remove

Returns:

sequence with prefix removed, or same sequence if no prefix was present

removeProperSuffix

@NotNull
public final T removeProperSuffix(@NotNull
 @NotNull CharSequence suffix)

Description copied from interface: IRichSequence

Remove suffix if present but only if this sequence is longer than the suffix

Specified by:

removeProperSuffix in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

suffix - characters to remove

Returns:

sequence with suffix removed, or same sequence if no suffix was present

removeProperPrefix

@NotNull
public final T removeProperPrefix(@NotNull
 @NotNull CharSequence prefix)

Description copied from interface: IRichSequence

Remove prefix if present but only if this sequence is longer than the suffix

Specified by:

removeProperPrefix in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

prefix - characters to remove

Returns:

sequence with prefix removed, or same sequence if no prefix was present

endsWithIgnoreCase

public final boolean endsWithIgnoreCase(@NotNull
 @NotNull CharSequence suffix)

Description copied from interface: IRichSequence

test if this sequence ends with given characters, ignoring case differences

Specified by:

endsWithIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

suffix - characters to test

Returns:

true if ends with suffix

startsWithIgnoreCase

public final boolean startsWithIgnoreCase(@NotNull
 @NotNull CharSequence prefix)

Description copied from interface: IRichSequence

test if this sequence starts with given characters, ignoring case differences

Specified by:

startsWithIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

prefix - characters to test

Returns:

true if starts with prefix

removeSuffixIgnoreCase

@NotNull
public final T removeSuffixIgnoreCase(@NotNull
 @NotNull CharSequence suffix)

Description copied from interface: IRichSequence

Remove suffix if present, ignoring case differences

Specified by:

removeSuffixIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

suffix - characters to remove

Returns:

sequence with suffix removed, or same sequence if no suffix was present

removePrefixIgnoreCase

@NotNull
public final T removePrefixIgnoreCase(@NotNull
 @NotNull CharSequence prefix)

Description copied from interface: IRichSequence

Remove prefix if present, ignoring case differences

Specified by:

removePrefixIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

prefix - characters to remove

Returns:

sequence with prefix removed, or same sequence if no prefix was present

removeProperSuffixIgnoreCase

@NotNull
public final T removeProperSuffixIgnoreCase(@NotNull
 @NotNull CharSequence suffix)

Description copied from interface: IRichSequence

Remove suffix if present but only if this sequence is longer than the suffix, ignoring case differences

Specified by:

removeProperSuffixIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

suffix - characters to remove

Returns:

sequence with suffix removed, or same sequence if no suffix was present

removeProperPrefixIgnoreCase

@NotNull
public final T removeProperPrefixIgnoreCase(@NotNull
 @NotNull CharSequence prefix)

Description copied from interface: IRichSequence

Remove prefix if present but only if this sequence is longer than the suffix, ignoring case differences

Specified by:

removeProperPrefixIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

prefix - characters to remove

Returns:

sequence with prefix removed, or same sequence if no prefix was present

removeSuffix

@NotNull
public final T removeSuffix(@NotNull
 @NotNull CharSequence suffix,
 boolean ignoreCase)

Description copied from interface: IRichSequence

Remove suffix if present

Specified by:

removeSuffix in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

suffix - characters to remove

ignoreCase - case ignored when true

Returns:

sequence with suffix removed, or same sequence if no suffix was present

removePrefix

@NotNull
public final T removePrefix(@NotNull
 @NotNull CharSequence prefix,
 boolean ignoreCase)

Description copied from interface: IRichSequence

Remove prefix if present

Specified by:

removePrefix in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

prefix - characters to remove

ignoreCase - case ignored when true

Returns:

sequence with prefix removed, or same sequence if no prefix was present

removeProperSuffix

@NotNull
public final T removeProperSuffix(@NotNull
 @NotNull CharSequence suffix,
 boolean ignoreCase)

Description copied from interface: IRichSequence

Remove suffix if present but only if this sequence is longer than the suffix

Specified by:

removeProperSuffix in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

suffix - characters to remove

ignoreCase - case ignored when true

Returns:

sequence with suffix removed, or same sequence if no suffix was present

removeProperPrefix

@NotNull
public final T removeProperPrefix(@NotNull
 @NotNull CharSequence prefix,
 boolean ignoreCase)

Description copied from interface: IRichSequence

Remove prefix if present but only if this sequence is longer than the suffix

Specified by:

removeProperPrefix in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

prefix - characters to remove

ignoreCase - case ignored when true

Returns:

sequence with prefix removed, or same sequence if no prefix was present

insert

@NotNull
public T insert(int index,
 @NotNull
 @NotNull CharSequence chars)

Description copied from interface: IRichSequence

Insert char sequence at given index

Specified by:

insert in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - index of insertion. if >length of this sequence then same as length, if <0 then same as 0

chars - char sequence to insert

Returns:

resulting sequence based sequence implementation may throw an IllegalArgumentException if inserting another based sequence out of order based on offsets

delete

@NotNull
public T delete(int startIndex,
 int endIndex)

Description copied from interface: IRichSequence

Delete range in sequence

Specified by:

delete in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

startIndex - start index of deletion

endIndex - end index, not inclusive, of insertion

Returns:

resulting sequence

toLowerCase

@NotNull
public final T toLowerCase()

Description copied from interface: IRichSequence

Map characters of this sequence to: Uppercase, Lowercase or use custom mapping

Specified by:

toLowerCase in interface IRichSequence<T extends IRichSequence<T>>

Returns:

lowercase version of sequence

toUpperCase

@NotNull
public final T toUpperCase()

Specified by:

toUpperCase in interface IRichSequence<T extends IRichSequence<T>>

toNbSp

@NotNull
public final T toNbSp()

Description copied from interface: IRichSequence

Map spaces to non break spaces

Specified by:

toNbSp in interface IRichSequence<T extends IRichSequence<T>>

Returns:

mapped sequence with spc changed to NbSp

toSpc

@NotNull
public final T toSpc()

Description copied from interface: IRichSequence

Map non break spaces to spaces

Specified by:

toSpc in interface IRichSequence<T extends IRichSequence<T>>

Returns:

mapped sequence with NbSp changed to spc

matches

public final boolean matches(@NotNull
 @NotNull CharSequence chars,
 boolean ignoreCase)

Specified by:

matches in interface IRichSequence<T extends IRichSequence<T>>

matches

public final boolean matches(@NotNull
 @NotNull CharSequence chars)

Description copied from interface: IRichSequence

Test the sequence for a match to another CharSequence

Specified by:

matches in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

chars - characters to match against

Returns:

true if match

matchesIgnoreCase

public final boolean matchesIgnoreCase(@NotNull
 @NotNull CharSequence chars)

Specified by:

matchesIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

matchChars

public final boolean matchChars(@NotNull
 @NotNull CharSequence chars,
 int startIndex,
 boolean ignoreCase)

Description copied from interface: IRichSequence

Test the sequence portion for a match to another CharSequence

Specified by:

matchChars in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

chars - characters to match against

startIndex - index from which to start the match

ignoreCase - if true match ignoring case differences

Returns:

true if characters at the start index of this sequence match

matchChars

public final boolean matchChars(@NotNull
 @NotNull CharSequence chars,
 int startIndex)

Specified by:

matchChars in interface IRichSequence<T extends IRichSequence<T>>

matchCharsIgnoreCase

public final boolean matchCharsIgnoreCase(@NotNull
 @NotNull CharSequence chars,
 int startIndex)

Specified by:

matchCharsIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

matchChars

public final boolean matchChars(@NotNull
 @NotNull CharSequence chars,
 boolean ignoreCase)

Specified by:

matchChars in interface IRichSequence<T extends IRichSequence<T>>

matchChars

public final boolean matchChars(@NotNull
 @NotNull CharSequence chars)

Description copied from interface: IRichSequence

Test the sequence portion for a match to another CharSequence

Specified by:

matchChars in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

chars - characters to match against

Returns:

true if characters at the start of this sequence match

matchCharsIgnoreCase

public final boolean matchCharsIgnoreCase(@NotNull
 @NotNull CharSequence chars)

Specified by:

matchCharsIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

matchCharsReversed

public final boolean matchCharsReversed(@NotNull
 @NotNull CharSequence chars,
 int endIndex,
 boolean ignoreCase)

Description copied from interface: IRichSequence

Test the sequence portion for a match to another CharSequence, reverse order

Specified by:

matchCharsReversed in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

chars - characters to match against

endIndex - index from which to start the match and proceed to 0

ignoreCase - if true match ignoring case differences

Returns:

true if characters at the start index of this sequence match

matchCharsReversed

public final boolean matchCharsReversed(@NotNull
 @NotNull CharSequence chars,
 int endIndex)

Specified by:

matchCharsReversed in interface IRichSequence<T extends IRichSequence<T>>

matchCharsReversedIgnoreCase

public final boolean matchCharsReversedIgnoreCase(@NotNull
 @NotNull CharSequence chars,
 int endIndex)

Specified by:

matchCharsReversedIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

matchedCharCount

public final int matchedCharCount(@NotNull
 @NotNull CharSequence chars,
 int startIndex,
 int endIndex,
 boolean ignoreCase)

Specified by:

matchedCharCount in interface IRichSequence<T extends IRichSequence<T>>

matchedCharCount

public final int matchedCharCount(@NotNull
 @NotNull CharSequence chars,
 int startIndex,
 boolean ignoreCase)

Specified by:

matchedCharCount in interface IRichSequence<T extends IRichSequence<T>>

matchedCharCount

public final int matchedCharCount(@NotNull
 @NotNull CharSequence chars,
 int startIndex,
 int endIndex)

Specified by:

matchedCharCount in interface IRichSequence<T extends IRichSequence<T>>

matchedCharCount

public final int matchedCharCount(@NotNull
 @NotNull CharSequence chars,
 int startIndex)

Specified by:

matchedCharCount in interface IRichSequence<T extends IRichSequence<T>>

matchedCharCountIgnoreCase

public final int matchedCharCountIgnoreCase(@NotNull
 @NotNull CharSequence chars,
 int startIndex)

Specified by:

matchedCharCountIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

matchedCharCountIgnoreCase

public final int matchedCharCountIgnoreCase(@NotNull
 @NotNull CharSequence chars,
 int startIndex,
 int endIndex)

Specified by:

matchedCharCountIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

matchedCharCountReversedIgnoreCase

public final int matchedCharCountReversedIgnoreCase(@NotNull
 @NotNull CharSequence chars,
 int startIndex,
 int fromIndex)

Specified by:

matchedCharCountReversedIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

matchedCharCountReversed

public final int matchedCharCountReversed(@NotNull
 @NotNull CharSequence chars,
 int startIndex,
 int fromIndex)

Specified by:

matchedCharCountReversed in interface IRichSequence<T extends IRichSequence<T>>

matchedCharCountReversed

public final int matchedCharCountReversed(@NotNull
 @NotNull CharSequence chars,
 int fromIndex,
 boolean ignoreCase)

Specified by:

matchedCharCountReversed in interface IRichSequence<T extends IRichSequence<T>>

matchedCharCountReversed

public final int matchedCharCountReversed(@NotNull
 @NotNull CharSequence chars,
 int fromIndex)

Specified by:

matchedCharCountReversed in interface IRichSequence<T extends IRichSequence<T>>

matchedCharCountReversedIgnoreCase

public final int matchedCharCountReversedIgnoreCase(@NotNull
 @NotNull CharSequence chars,
 int fromIndex)

Specified by:

matchedCharCountReversedIgnoreCase in interface IRichSequence<T extends IRichSequence<T>>

matchedCharCount

public final int matchedCharCount(@NotNull
 @NotNull CharSequence chars,
 int startIndex,
 int endIndex,
 boolean fullMatchOnly,
 boolean ignoreCase)

Description copied from interface: IRichSequence

Test the sequence portion for a match to another CharSequence

Specified by:

matchedCharCount in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

chars - characters to match against

startIndex - index from which to start the match

endIndex - index at which to end the matching

fullMatchOnly - if true will do quick fail if length of chars is longer than characters after startIndex in this sequence

ignoreCase - if true match ignoring case differences

Returns:

count of characters at the start index of this sequence matching corresponding characters in chars

matchedCharCountReversed

public final int matchedCharCountReversed(@NotNull
 @NotNull CharSequence chars,
 int startIndex,
 int fromIndex,
 boolean ignoreCase)

Description copied from interface: IRichSequence

Test the sequence portion for a match to another CharSequence, equivalent to taking this.subSequence(startIndex, fromIndex) and then count matching chars going from end of both sequences

Specified by:

matchedCharCountReversed in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

chars - characters to match against

startIndex - index at which to stop the match

fromIndex - index from which to start the match, not inclusive, matching starts at fromIndex-1 and proceeds towards 0

ignoreCase - if true match ignoring case differences

Returns:

count of characters at the from index of this sequence matching corresponding characters in chars in reverse order

toString

@NotNull
public @NotNull String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

normalizeEOL

@NotNull
public final @NotNull String normalizeEOL()

Description copied from interface: IRichSequence

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

Specified by:

normalizeEOL in interface IRichSequence<T extends IRichSequence<T>>

Returns:

string with only \n for line separators

normalizeEndWithEOL

@NotNull
public final @NotNull String normalizeEndWithEOL()

Description copied from interface: IRichSequence

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

Specified by:

normalizeEndWithEOL in interface IRichSequence<T extends IRichSequence<T>>

Returns:

string with only \n for line separators and terminated by \n

toVisibleWhitespaceString

@NotNull
public final @NotNull String toVisibleWhitespaceString()

Specified by:

toVisibleWhitespaceString in interface IRichSequence<T extends IRichSequence<T>>

splitList

@NotNull
public final @NotNull List<T> splitList(@NotNull
 @NotNull CharSequence delimiter)

Specified by:

splitList in interface IRichSequence<T extends IRichSequence<T>>

splitList

@NotNull
public final @NotNull List<T> splitList(@NotNull
 @NotNull CharSequence delimiter,
 int limit,
 boolean includeDelims,
 @Nullable
 @Nullable CharPredicate trimChars)

Description copied from interface: IRichSequence

Split helpers based on delimiter character sets contained in CharPredicate

Specified by:

splitList in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

delimiter - sequence of chars on which to split this sequence

limit - max number of segments to split

includeDelims - if true include delimiters as part of split item

trimChars - set of characters that should be used for trimming individual split results

Returns:

List of split results

splitList

@NotNull
public final @NotNull List<T> splitList(@NotNull
 @NotNull CharSequence delimiter,
 int limit,
 int flags)

Specified by:

splitList in interface IRichSequence<T extends IRichSequence<T>>

splitList

@NotNull
public final @NotNull List<T> splitList(@NotNull
 @NotNull CharSequence delimiter,
 boolean includeDelims,
 @Nullable
 @Nullable CharPredicate trimChars)

Specified by:

splitList in interface IRichSequence<T extends IRichSequence<T>>

splitListEOL

@NotNull
public final @NotNull List<T> splitListEOL()

Specified by:

splitListEOL in interface IRichSequence<T extends IRichSequence<T>>

splitListEOL

@NotNull
public final @NotNull List<T> splitListEOL(boolean includeDelims)

Specified by:

splitListEOL in interface IRichSequence<T extends IRichSequence<T>>

splitListEOL

@NotNull
public final @NotNull List<T> splitListEOL(boolean includeDelims,
 @Nullable
 @Nullable CharPredicate trimChars)

Specified by:

splitListEOL in interface IRichSequence<T extends IRichSequence<T>>

splitList

@NotNull
public final @NotNull List<T> splitList(@NotNull
 @NotNull CharSequence delimiter,
 int limit,
 int flags,
 @Nullable
 @Nullable CharPredicate trimChars)

Description copied from interface: IRichSequence

Split helpers based on delimiter character sets contained in CharSequence

Specified by:

splitList in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

delimiter - delimiter char sequence to use for splitting

limit - max number of segments to split

flags - flags for desired options: SPLIT_INCLUDE_DELIMS: include delimiters as part of split item SPLIT_TRIM_PARTS: trim the segments, if trimChars is not null or empty then this flag is turned on automatically SPLIT_SKIP_EMPTY: skip empty segments (or empty after trimming if enabled) SPLIT_INCLUDE_DELIM_PARTS: include delimiters as separate split item of its own SPLIT_TRIM_SKIP_EMPTY: same as SPLIT_TRIM_PARTS | SPLIT_SKIP_EMPTY

trimChars - set of characters that should be used for trimming individual split results

Returns:

List of split results

splitEOL

@NotNull
public final T[] splitEOL()

Specified by:

splitEOL in interface IRichSequence<T extends IRichSequence<T>>

splitEOL

@NotNull
public final T[] splitEOL(boolean includeDelims)

Specified by:

splitEOL in interface IRichSequence<T extends IRichSequence<T>>

split

@NotNull
public final T[] split(@NotNull
 @NotNull CharSequence delimiter,
 boolean includeDelims,
 @Nullable
 @Nullable CharPredicate trimChars)

Specified by:

split in interface IRichSequence<T extends IRichSequence<T>>

split

@NotNull
public final T[] split(@NotNull
 @NotNull CharSequence delimiter)

Specified by:

split in interface IRichSequence<T extends IRichSequence<T>>

split

@NotNull
public final T[] split(@NotNull
 @NotNull CharSequence delimiter,
 int limit,
 boolean includeDelims,
 @Nullable
 @Nullable CharPredicate trimChars)

Specified by:

split in interface IRichSequence<T extends IRichSequence<T>>

split

@NotNull
public final T[] split(@NotNull
 @NotNull CharSequence delimiter,
 int limit,
 int flags)

Specified by:

split in interface IRichSequence<T extends IRichSequence<T>>

split

@NotNull
public final T[] split(@NotNull
 @NotNull CharSequence delimiter,
 int limit,
 int flags,
 @Nullable
 @Nullable CharPredicate trimChars)

Specified by:

split in interface IRichSequence<T extends IRichSequence<T>>

appendTo

@NotNull
public final T appendTo(@NotNull
 @NotNull StringBuilder out,
 @Nullable
 @Nullable CharMapper charMapper)

Specified by:

appendTo in interface IRichSequence<T extends IRichSequence<T>>

appendTo

@NotNull
public final T appendTo(@NotNull
 @NotNull StringBuilder out,
 @Nullable
 @Nullable CharMapper charMapper,
 int startIndex)

Specified by:

appendTo in interface IRichSequence<T extends IRichSequence<T>>

appendTo

@NotNull
public final T appendTo(@NotNull
 @NotNull StringBuilder out)

Specified by:

appendTo in interface IRichSequence<T extends IRichSequence<T>>

appendTo

@NotNull
public final T appendTo(@NotNull
 @NotNull StringBuilder out,
 int startIndex)

Specified by:

appendTo in interface IRichSequence<T extends IRichSequence<T>>

appendTo

@NotNull
public final T appendTo(@NotNull
 @NotNull StringBuilder out,
 int startIndex,
 int endIndex)

Specified by:

appendTo in interface IRichSequence<T extends IRichSequence<T>>

appendTo

@NotNull
public final T appendTo(@NotNull
 @NotNull StringBuilder out,
 @Nullable
 @Nullable CharMapper charMapper,
 int startIndex,
 int endIndex)

Description copied from interface: IRichSequence

Append helpers

Specified by:

appendTo in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

out - string builder

charMapper - mapping to use for output or null if none

startIndex - start index

endIndex - end index

Returns:

this

appendRangesTo

@NotNull
public final T appendRangesTo(@NotNull
 @NotNull StringBuilder out,
 @Nullable
 @Nullable CharMapper charMapper,
 Range... ranges)

Description copied from interface: IRichSequence

Append given ranges of this sequence to string builder

Specified by:

appendRangesTo in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

out - string builder to append to

charMapper - mapping to use for output or null if none

ranges - ranges to append, null range or one for which range.isNull() is true ranges are skipped

Returns:

this

appendRangesTo

@NotNull
public final T appendRangesTo(@NotNull
 @NotNull StringBuilder out,
 Range... ranges)

Specified by:

appendRangesTo in interface IRichSequence<T extends IRichSequence<T>>

appendRangesTo

@NotNull
public final T appendRangesTo(@NotNull
 @NotNull StringBuilder out,
 Iterable<? extends Range> ranges)

Specified by:

appendRangesTo in interface IRichSequence<T extends IRichSequence<T>>

appendRangesTo

@NotNull
public final T appendRangesTo(@NotNull
 @NotNull StringBuilder out,
 @Nullable
 @Nullable CharMapper charMapper,
 Iterable<? extends Range> ranges)

Specified by:

appendRangesTo in interface IRichSequence<T extends IRichSequence<T>>

indexOfAll

@NotNull
public final @NotNull int[] indexOfAll(@NotNull
 @NotNull CharSequence s)

Description copied from interface: IRichSequence

Get indices of all occurrences of a sequence

Specified by:

indexOfAll in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

s - sequence whose indices to find

Returns:

array of indices

appendEOL

@NotNull
public final T appendEOL()

Specified by:

appendEOL in interface IRichSequence<T extends IRichSequence<T>>

suffixWithEOL

@NotNull
public final T suffixWithEOL()

Specified by:

suffixWithEOL in interface IRichSequence<T extends IRichSequence<T>>

prefixWithEOL

@NotNull
public final T prefixWithEOL()

Specified by:

prefixWithEOL in interface IRichSequence<T extends IRichSequence<T>>

prefixOnceWithEOL

@NotNull
public final T prefixOnceWithEOL()

Specified by:

prefixOnceWithEOL in interface IRichSequence<T extends IRichSequence<T>>

suffixOnceWithEOL

@NotNull
public final T suffixOnceWithEOL()

Specified by:

suffixOnceWithEOL in interface IRichSequence<T extends IRichSequence<T>>

appendSpace

@NotNull
public final T appendSpace()

Specified by:

appendSpace in interface IRichSequence<T extends IRichSequence<T>>

suffixWithSpace

@NotNull
public final T suffixWithSpace()

Specified by:

suffixWithSpace in interface IRichSequence<T extends IRichSequence<T>>

prefixWithSpace

@NotNull
public final T prefixWithSpace()

Specified by:

prefixWithSpace in interface IRichSequence<T extends IRichSequence<T>>

appendSpaces

@NotNull
public final T appendSpaces(int count)

Specified by:

appendSpaces in interface IRichSequence<T extends IRichSequence<T>>

suffixWithSpaces

@NotNull
public final T suffixWithSpaces(int count)

Specified by:

suffixWithSpaces in interface IRichSequence<T extends IRichSequence<T>>

prefixWithSpaces

@NotNull
public final T prefixWithSpaces(int count)

Specified by:

prefixWithSpaces in interface IRichSequence<T extends IRichSequence<T>>

prefixOnceWithSpace

@NotNull
public final T prefixOnceWithSpace()

Specified by:

prefixOnceWithSpace in interface IRichSequence<T extends IRichSequence<T>>

suffixOnceWithSpace

@NotNull
public final T suffixOnceWithSpace()

Specified by:

suffixOnceWithSpace in interface IRichSequence<T extends IRichSequence<T>>

prefixWith

@NotNull
public T prefixWith(@Nullable
 @Nullable CharSequence prefix)

Description copied from interface: IRichSequence

Prefix this sequence with a char sequence

Specified by:

prefixWith in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

prefix - char sequence

Returns:

resulting sequence

suffixWith

@NotNull
public T suffixWith(@Nullable
 @Nullable CharSequence suffix)

Description copied from interface: IRichSequence

Prefix this sequence with a char sequence

Specified by:

suffixWith in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

suffix - char sequence

Returns:

resulting sequence

prefixOnceWith

@NotNull
public final T prefixOnceWith(@Nullable
 @Nullable CharSequence prefix)

Description copied from interface: IRichSequence

Prefix this sequence with a char sequence if not already starting with prefix

Specified by:

prefixOnceWith in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

prefix - char sequence

Returns:

resulting sequence

suffixOnceWith

@NotNull
public final T suffixOnceWith(@Nullable
 @Nullable CharSequence suffix)

Description copied from interface: IRichSequence

Suffix this sequence with a char sequence if not already ending with suffix

Specified by:

suffixOnceWith in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

suffix - char sequence

Returns:

resulting sequence

replace

@NotNull
public final T replace(int startIndex,
 int endIndex,
 @NotNull
 @NotNull CharSequence replacement)

Description copied from interface: IRichSequence

Replace part of the sequence with a char sequence

Specified by:

replace in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

startIndex - start index of replaced part

endIndex - end index of replaced part

replacement - char sequence

Returns:

resulting sequence

replace

@NotNull
public final T replace(@NotNull
 @NotNull CharSequence find,
 @NotNull
 @NotNull CharSequence replace)

Description copied from interface: IRichSequence

Replace all occurrences of one sequence with another

Specified by:

replace in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

find - sequence to find

replace - replacement sequence

Returns:

array of indices

append

@NotNull
public final T append(CharSequence... sequences)

Description copied from interface: IRichSequence

Concatenate this sequence and list of others, returning sequence of result

Specified by:

append in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

sequences - list of char sequences to append to this sequence, null sequences are skipped

Returns:

appended sequence

append

@NotNull
public final T append(Iterable<? extends CharSequence> sequences)

Specified by:

append in interface IRichSequence<T extends IRichSequence<T>>

extractRanges

@NotNull
public final T extractRanges(Range... ranges)

Description copied from interface: IRichSequence

Build a sequence of ranges in this sequence

NOTE: BasedSequence ranges must be non-overlapping and ordered by startOffset or IllegalArgumentException will be thrown

Specified by:

extractRanges in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

ranges - ranges to extract

Returns:

resulting sequence

extractRanges

@NotNull
public final T extractRanges(Iterable<Range> ranges)

Specified by:

extractRanges in interface IRichSequence<T extends IRichSequence<T>>

columnAtIndex

public final int columnAtIndex(int index)

Specified by:

columnAtIndex in interface IRichSequence<T extends IRichSequence<T>>

lineColumnAtIndex

@NotNull
public final @NotNull Pair<Integer,Integer> lineColumnAtIndex(int index)

Description copied from interface: IRichSequence

Get the line and column information from index into sequence

Specified by:

lineColumnAtIndex in interface IRichSequence<T extends IRichSequence<T>>

Parameters:

index - index for which to get line information

Returns:

Pair(line, column) where line and column are 0 based, throws IllegalArgumentException if index < 0 or > length.

isIn

public boolean isIn(@NotNull
 @NotNull String[] texts)

Specified by:

isIn in interface IRichSequence<T extends IRichSequence<T>>

isIn

public boolean isIn(@NotNull
 @NotNull Collection<? extends CharSequence> texts)

Specified by:

isIn in interface IRichSequence<T extends IRichSequence<T>>