com.vladsch.flexmark.util.sequence

Interface BasedSequence

All Superinterfaces:

CharSequence, Comparable<CharSequence>, RichCharSequence<BasedSequence>

All Known Implementing Classes:

BasedSequence.EmptyBasedSequence, BasedSequenceImpl, CharSubSequence, MappedSequence, PrefixedSubSequence, SegmentedSequence, SubSequence

public interface BasedSequence
extends RichCharSequence<BasedSequence>

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

Modifier and Type	Interface and Description
static class	BasedSequence.EmptyBasedSequence

Field Summary

Fields

Modifier and Type	Field and Description
static BasedSequence	EMPTY
static BasedSequence[]	EMPTY_ARRAY
static List<BasedSequence>	EMPTY_LIST
static BasedSequence[]	EMPTY_SEGMENTS
static BasedSequence	EOL
static BasedSequence	NULL
static BasedSequence	SPACE

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

EOL_CHAR, EOL_CHAR1, EOL_CHAR2, EOL_CHARS, 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	baseSubSequence(int start) Get a portion of the original sequence that this sequence is based on
BasedSequence	baseSubSequence(int start, int end) Get a portion of the original sequence that this sequence is based on
boolean	containsAllOf(BasedSequence other) start/end offset based containment, not textual
boolean	containsSomeOf(BasedSequence other) start/end offset based containment, not textual
default BasedSequence	extendByAny(CharSequence charSet)
BasedSequence	extendByAny(CharSequence charSet, int maxCount) Extend this based sequence to include characters from underlying based sequence
default BasedSequence	extendByOneOfAny(CharSequence charSet)
default BasedSequence	extendToAny(CharSequence charSet)
BasedSequence	extendToAny(CharSequence charSet, int maxCount) Extend this based sequence to include up to the next character from underlying based sequence
Object	getBase() Get the underlying object on which this sequence contents are based
BasedSequence	getBaseSequence() Get the base sequence for the text
BasedSequence	getEmptyPrefix() Get empty prefix to this sequence
BasedSequence	getEmptySuffix() Get empty suffix to this sequence
int	getEndOffset() Get the end offset of this sequence into getBaseSequence() and getBase() original text source.
int	getIndexOffset(int index) Get the offset of index in this sequence mapped to offset into getBaseSequence() and getBase() original text source.
Range	getIndexRange(int startOffset, int endOffset) Get the range of indices that map into getBaseSequence() with startOffset and endOffset
Range	getSourceRange() Get the range of this sequence in original getBaseSequence() and getBase() original text source.
int	getStartOffset() Get the start offset of this sequence into getBaseSequence() and getBase() original text source.
BasedSequence	intersect(BasedSequence other) start/end offset based intersection, not textual
boolean	isContinuationOf(BasedSequence other) Test if this sequence is a continuation of the given sequence in original source text
boolean	isContinuedBy(BasedSequence other) Test if the given sequence is a continuation of this sequence in original source text
BasedSequence	normalizeEndWithEOL(ReplacedTextMapper textMapper) replace any \r\n and \r by \n, append terminating EOL if one is not present
BasedSequence	normalizeEOL(ReplacedTextMapper textMapper) replace any \r\n and \r by \n
BasedSequence	prefixOf(BasedSequence other) Get the prefix part of this from other, start/end offset based containment, not textual
default BasedSequence	prefixWithIndent()
BasedSequence	prefixWithIndent(int maxColumns) Extend this based sequence to include characters from underlying based sequence taking tab expansion to 4th spaces into account
char	safeBaseCharAt(int index) Safe, if index out of range but based sequence has characters will return those, else returns '\0'
char	safeCharAt(int index) Safe, if index out of range returns '\0'
BasedSequence	spliceAtEnd(BasedSequence other) Splice the given sequence to the end of this one and return a BasedSequence of the result.
BasedSequence	suffixOf(BasedSequence other) Get the suffix part of this from other, start/end offset based containment, not textual
String	unescape() Get the unescaped string of this sequence content
BasedSequence	unescape(ReplacedTextMapper textMapper) Get the unescaped string of this sequence content
String	unescapeNoEntities() Get the unescaped string of this sequence content without unescaping entities

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

append, appendTo, appendTo, appendTo, countLeading, countLeading, countLeading, countLeading, countLeading, countLeading, countLeading, countLeadingColumns, countLeadingNot, countLeadingNot, countLeadingNot, countLeadingNot, countLeadingNot, countLeadingNot, countLeadingNot, 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, emptyArray, endCharAt, endOfDelimitedBy, endOfDelimitedByAny, endOfDelimitedByAnyNot, endOfLine, endOfLineAnyEOL, endSequence, endSequence, endsWith, endsWith, endsWithIgnoreCase, eolLength, eolLength, equals, equalsIgnoreCase, firstChar, getColumnAtIndex, 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, isBlank, 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, normalizeEOL, nullIf, nullIf, nullIfBlank, nullIfEmpty, nullIfEndsWith, nullIfEndsWithNot, nullIfNot, nullIfStartsWith, nullIfStartsWithNot, nullSequence, padEnd, padEnd, padStart, padStart, removePrefix, removePrefix, removePrefixIgnoreCase, removeProperPrefix, removeProperPrefix, removeProperPrefixIgnoreCase, removeProperSuffix, removeProperSuffix, removeProperSuffixIgnoreCase, removeSuffix, removeSuffix, removeSuffixIgnoreCase, replace, sequenceOf, sequenceOf, sequenceOf, split, split, split, split, split, split, split, split, startOfDelimitedBy, startOfDelimitedByAny, startOfDelimitedByAnyNot, startOfLine, startOfLineAnyEOL, startsWith, startsWith, startsWithIgnoreCase, subSequence, subSequence, subSequence, 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

Methods inherited from interface java.lang.CharSequence

charAt, chars, codePoints, length, toString

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

NULL

static final BasedSequence NULL

EMPTY

static final BasedSequence EMPTY

EOL

static final BasedSequence EOL

SPACE

static final BasedSequence SPACE

EMPTY_LIST

static final List<BasedSequence> EMPTY_LIST

EMPTY_ARRAY

static final BasedSequence[] EMPTY_ARRAY

EMPTY_SEGMENTS

static final BasedSequence[] EMPTY_SEGMENTS

Method Detail

getBase

Object getBase()

Get the underlying object on which this sequence contents are based

Returns:

underlying object containing original text

getBaseSequence

BasedSequence getBaseSequence()

Get the base sequence for the text

Returns:

base sequence

getStartOffset

int getStartOffset()

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

Returns:

start offset in original text

getEndOffset

int getEndOffset()

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

Returns:

end offset in original text

getIndexOffset

int getIndexOffset(int index)

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

Parameters:

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

Returns:

offset of index of this sequence in original text

getIndexRange

Range getIndexRange(int startOffset,
                    int endOffset)

Get the range of indices that map into getBaseSequence() with startOffset and endOffset

Parameters:

startOffset - start offset into base sequence

endOffset - end offset into base sequence

Returns:

range into this sequence that spans start and end offset.

getSourceRange

Range getSourceRange()

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

Returns:

Range of start offset and end offset

baseSubSequence

BasedSequence baseSubSequence(int start,
                              int end)

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

baseSubSequence

BasedSequence baseSubSequence(int start)

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

Parameters:

start - offset from 0 of original sequence

Returns:

based sequence from start to the end

safeCharAt

char safeCharAt(int index)

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

Parameters:

index - index in string

Returns:

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

safeBaseCharAt

char safeBaseCharAt(int index)

Safe, if index out of range but based sequence has characters will return those, else returns '\0'

Allows peeking into preceding/following characters to the ones contained in this sequence

Parameters:

index - index in string

Returns:

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

getEmptyPrefix

BasedSequence getEmptyPrefix()

Get empty prefix to this sequence

Returns:

same as subSequence(0,0)

getEmptySuffix

BasedSequence getEmptySuffix()

Get empty suffix to this sequence

Returns:

same as subSequence(length())

unescape

String unescape()

Get the unescaped string of this sequence content

Returns:

unescaped text

unescapeNoEntities

String unescapeNoEntities()

Get the unescaped string of this sequence content without unescaping entities

Returns:

unescaped text

unescape

BasedSequence unescape(ReplacedTextMapper textMapper)

Get the unescaped string of this sequence content

Parameters:

textMapper - replaced text mapper which will be uses to map unescaped index to original source index

Returns:

unescaped text in based sequence

normalizeEOL

BasedSequence normalizeEOL(ReplacedTextMapper textMapper)

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

Parameters:

textMapper - replaced text mapper which will be uses to map unescaped index to original source index

Returns:

based sequence with only \n for line separators

normalizeEndWithEOL

BasedSequence normalizeEndWithEOL(ReplacedTextMapper textMapper)

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

Parameters:

textMapper - replaced text mapper which will be uses to map unescaped index to original source index

Returns:

based sequence with only \n for line separators and terminated by \n

isContinuedBy

boolean isContinuedBy(BasedSequence other)

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

Parameters:

other - sequence to test

Returns:

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

isContinuationOf

boolean isContinuationOf(BasedSequence other)

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

Parameters:

other - sequence to test

Returns:

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

spliceAtEnd

BasedSequence spliceAtEnd(BasedSequence other)

Splice the given sequence to the end of this one and return a BasedSequence of the result. Does not copy anything, creates a new based sequence of the original text but one that spans characters of this sequence and other

Parameters:

other - sequence to append to end of this one

Returns:

based sequence that contains the span from start of this sequence and end of other

assertion will fail if the other sequence is not a continuation of this one

containsAllOf

boolean containsAllOf(BasedSequence other)

start/end offset based containment, not textual

Parameters:

other - based sequence from the same base

Returns:

true if other is contained in this

containsSomeOf

boolean containsSomeOf(BasedSequence other)

start/end offset based containment, not textual

Parameters:

other - based sequence from the same base

Returns:

true if other is contained in this

prefixOf

BasedSequence prefixOf(BasedSequence other)

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

Parameters:

other - based sequence from the same base

Returns:

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

suffixOf

BasedSequence suffixOf(BasedSequence other)

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

Parameters:

other - based sequence from the same base

Returns:

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

intersect

BasedSequence intersect(BasedSequence other)

start/end offset based intersection, not textual

Parameters:

other - based sequence from the same parent

Returns:

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

extendByAny

BasedSequence extendByAny(CharSequence charSet,
                          int maxCount)

Extend this based sequence to include characters from underlying based sequence

Parameters:

charSet - set of characters to include

maxCount - maximum extra characters to include

Returns:

sequence which

extendByAny

default BasedSequence extendByAny(CharSequence charSet)

extendByOneOfAny

default BasedSequence extendByOneOfAny(CharSequence charSet)

extendToAny

BasedSequence extendToAny(CharSequence charSet,
                          int maxCount)

Extend this based sequence to include up to the next character from underlying based sequence

Parameters:

charSet - set of characters to include

maxCount - maximum extra characters to include

Returns:

sequence which

extendToAny

default BasedSequence extendToAny(CharSequence charSet)

prefixWithIndent

BasedSequence prefixWithIndent(int maxColumns)

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

Parameters:

maxColumns - maximum columns to include

Returns:

sequence which

prefixWithIndent

default BasedSequence prefixWithIndent()