com.vladsch.flexmark.util.sequence

Class SubSequence

java.lang.Object

com.vladsch.flexmark.util.sequence.BasedSequenceImpl

com.vladsch.flexmark.util.sequence.SubSequence

All Implemented Interfaces:

BasedSequence, CharSequence, Comparable<CharSequence>

public final class SubSequence
extends BasedSequenceImpl

A CharSequence that references original char sequence and maps '\0' to '�' a subSequence() returns a sub-sequence from the original base sequence

Nested Class Summary

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

BasedSequence.EmptyBasedSequence

Field Summary

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

EMPTY_ARRAY, EMPTY_LIST, EMPTY_SEGMENTS, EOL, EOL_CHAR, EOL_CHAR1, EOL_CHAR2, EOL_CHARS, NULL, SPACE, SPLIT_INCLUDE_DELIM_PARTS, SPLIT_INCLUDE_DELIMS, SPLIT_SKIP_EMPTY, SPLIT_TRIM_PARTS, SPLIT_TRIM_SKIP_EMPTY, WHITESPACE_CHARS, WHITESPACE_NBSP_CHARS, WHITESPACE_NO_EOL_CHARS

Method Summary

Modifier and Type	Method and Description
BasedSequence	appendTo(StringBuilder out, int start, int end)
SubSequence	baseSubSequence(int start, int end) Get a portion of the original sequence that this sequence is based on
char	charAt(int index)
boolean	equals(Object obj)
Object	getBase() Get the underlying object on which this sequence contents are based
SubSequence	getBaseSequence() Get the base sequence for the text
int	getEndOffset() Get the end offset of this sequence into BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source.
int	getIndexOffset(int index) Get the offset of index in this sequence mapped to offset into BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source.
Range	getSourceRange() Get the range of this sequence in original BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source.
int	getStartOffset() Get the start offset of this sequence into BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source.
int	hashCode()
int	length()
static BasedSequence	of(CharSequence charSequence)
static BasedSequence	of(CharSequence charSequence, int start)
static BasedSequence	of(CharSequence charSequence, int start, int end)
SubSequence	subSequence(int start) Get a portion of this sequence starting from a given offset to end of the sequence
SubSequence	subSequence(int start, int end) Get a portion of this sequence
SubSequence	subSequence(Range range) Get a portion of this sequence
String	toString()

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

append, appendTo, appendTo, baseSubSequence, columnsToNextTabStop, compareTo, containsAllOf, containsSomeOf, countChars, countChars, countChars, countChars, countChars, countChars, countCharsReversed, countCharsReversed, countCharsReversed, countCharsReversed, countCharsReversed, countCharsReversed, countLeading, countLeading, countLeading, countLeading, countLeading, countLeading, countLeading, countLeadingColumns, countLeadingNot, countLeadingNot, countLeadingNot, countLeadingNot, countLeadingNot, countLeadingNot, countLeadingNot, countNotChars, countNotChars, countNotChars, countNotChars, countNotChars, countNotChars, countNotCharsReversed, countNotCharsReversed, countNotCharsReversed, countNotCharsReversed, countNotCharsReversed, countNotCharsReversed, countOf, countOf, countOf, countOf, countOfAny, countOfAny, countOfAny, countOfAnyNot, countOfAnyNot, countOfAnyNot, countOfNot, countOfNot, countOfNot, countOfNot, countTrailing, countTrailing, countTrailing, countTrailing, countTrailing, countTrailing, countTrailing, countTrailingNot, countTrailingNot, countTrailingNot, countTrailingNot, countTrailingNot, countTrailingNot, countTrailingNot, endCharAt, endOfDelimitedBy, endOfDelimitedByAny, endOfDelimitedByAnyNot, endOfLine, endOfLineAnyEOL, endSequence, endSequence, endsWith, endsWith, endsWithIgnoreCase, eolLength, eolLength, equals, equalsIgnoreCase, expandTo, firstChar, firstNonNull, getColumnAtIndex, getIndexRange, getLineColumnAtIndex, ifNull, ifNullEmptyAfter, ifNullEmptyBefore, indexOf, indexOf, indexOf, indexOf, indexOf, indexOf, indexOfAll, indexOfAny, indexOfAny, indexOfAny, indexOfAny, indexOfAny, indexOfAny, indexOfAny, indexOfAny, indexOfAny, indexOfAnyNot, indexOfAnyNot, indexOfAnyNot, indexOfAnyNot, indexOfAnyNot, indexOfAnyNot, indexOfAnyNot, indexOfAnyNot, indexOfAnyNot, indexOfNot, indexOfNot, indexOfNot, intersect, isBlank, isContinuationOf, isContinuedBy, isEmpty, isNotNull, isNull, lastChar, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOfAny, lastIndexOfAny, lastIndexOfAny, lastIndexOfAny, lastIndexOfAny, lastIndexOfAny, lastIndexOfAny, lastIndexOfAny, lastIndexOfAny, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfAnyNot, lastIndexOfNot, lastIndexOfNot, lastIndexOfNot, lineAt, lineAtAnyEOL, matchChars, matchChars, matchChars, matchChars, matchCharsIgnoreCase, matchCharsIgnoreCase, matchCharsReversed, matchCharsReversed, matchCharsReversedIgnoreCase, matches, matches, matchesIgnoreCase, midCharAt, midSequence, midSequence, normalizeEndWithEOL, normalizeEndWithEOL, normalizeEOL, normalizeEOL, nullIf, nullIf, nullIfBlank, nullIfEmpty, nullIfEndsWith, nullIfEndsWithNot, nullIfNot, nullIfStartsWith, nullIfStartsWithNot, padEnd, padEnd, padStart, padStart, prefixOf, removePrefix, removePrefix, removePrefixIgnoreCase, removeProperPrefix, removeProperPrefix, removeProperPrefixIgnoreCase, removeProperSuffix, removeProperSuffix, removeProperSuffixIgnoreCase, removeSuffix, removeSuffix, removeSuffixIgnoreCase, replace, spliceAtEnd, split, split, split, split, split, split, split, split, startOfDelimitedBy, startOfDelimitedByAny, startOfDelimitedByAnyNot, startOfLine, startOfLineAnyEOL, startsWith, startsWith, startsWithIgnoreCase, suffixOf, toLowerCase, toLowerCase, toMapped, toUpperCase, toUpperCase, toVisibleWhitespaceString, trim, trim, trimEnd, trimEnd, trimEnd, trimEnd, trimEOL, trimLeadBlankLines, trimmedEnd, trimmedEnd, trimmedEnd, trimmedEnd, trimmedEOL, trimmedStart, trimmedStart, trimmedStart, trimmedStart, trimStart, trimStart, trimStart, trimStart, trimTailBlankLines, truncateTo, unescape, unescape, unescapeNoEntities

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Method Detail

getBaseSequence

public SubSequence getBaseSequence()

Description copied from interface: BasedSequence

Get the base sequence for the text

Returns:

base sequence

getBase

public Object getBase()

Description copied from interface: BasedSequence

Get the underlying object on which this sequence contents are based

Returns:

underlying object containing original text

getStartOffset

public int getStartOffset()

Description copied from interface: BasedSequence

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

Returns:

start offset in original text

getEndOffset

public int getEndOffset()

Description copied from interface: BasedSequence

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

Returns:

end offset in original text

length

public int length()

getSourceRange

public Range getSourceRange()

Description copied from interface: BasedSequence

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

Returns:

Range of start offset and end offset

getIndexOffset

public int getIndexOffset(int index)

Description copied from interface: BasedSequence

Get the offset of index in this sequence mapped to offset into BasedSequence.getBaseSequence() and BasedSequence.getBase() original text source.

Parameters:

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

Returns:

offset of index of this sequence in original text

charAt

public char charAt(int index)

subSequence

public SubSequence subSequence(Range range)

Description copied from interface: BasedSequence

Get a portion of this sequence

Specified by:

subSequence in interface BasedSequence

Overrides:

subSequence in class BasedSequenceImpl

Parameters:

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

Returns:

based sequence whose contents reflect the selected portion

subSequence

public SubSequence subSequence(int start)

Description copied from interface: BasedSequence

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

Specified by:

subSequence in interface BasedSequence

Overrides:

subSequence in class BasedSequenceImpl

Parameters:

start - offset from start of this sequence

Returns:

based sequence whose contents reflect the selected portion

subSequence

public SubSequence subSequence(int start,
                               int end)

Description copied from interface: BasedSequence

Get a portion of this sequence

Parameters:

start - offset from start of this sequence

end - offset from start of this sequence

Returns:

based sequence whose contents reflect the selected portion

baseSubSequence

public SubSequence baseSubSequence(int start,
                                   int end)

Description copied from interface: BasedSequence

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

Parameters:

start - offset from 0 of original sequence

end - offset from 0 of original sequence

Returns:

based sequence whose contents reflect the selected portion

appendTo

public BasedSequence appendTo(StringBuilder out,
                              int start,
                              int end)

Specified by:

appendTo in interface BasedSequence

Overrides:

appendTo in class BasedSequenceImpl

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class BasedSequenceImpl

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class BasedSequenceImpl

of

public static BasedSequence of(CharSequence charSequence)

of

public static BasedSequence of(CharSequence charSequence,
                               int start)

of

public static BasedSequence of(CharSequence charSequence,
                               int start,
                               int end)