SegmentedSequence (flexmark-java utilities 0.50.42 API)

java.lang.Object
- com.vladsch.flexmark.util.sequence.RichCharSequenceBase<BasedSequence>
- - com.vladsch.flexmark.util.sequence.BasedSequenceImpl
  - - com.vladsch.flexmark.util.sequence.SegmentedSequence

All Implemented Interfaces:

BasedSequence, RichCharSequence<BasedSequence>, CharSequence, Comparable<CharSequence>
```
public final class SegmentedSequence
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, EMPTY_ARRAY, EMPTY_LIST, EMPTY_SEGMENTS, EOL, NULL, 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BasedSequence`	`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
`int[]`	`getBaseOffsets()`
`BasedSequence`	`getBaseSequence()` Get the base sequence for the text
`int`	`getBaseStartOffset()`
`int`	`getEndOffset()` Get the last end in the base sequence, non-based sequences are skipped
`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`	`getIndexRange(int startOffset, int endOffset)` Get the range of indices that map into `BasedSequence.getBaseSequence()` with startOffset and endOffset
`Range`	`getSourceRange()` Get the range of this sequence in original `BasedSequence.getBaseSequence()` and `BasedSequence.getBase()` original text source.
`int`	`getStartOffset()` Get the first start in the base sequence, non-based sequences are skipped
`int`	`hashCode()`
`int`	`length()`
`static BasedSequence`	`of(BasedSequence... segments)`
`static BasedSequence`	`of(List<BasedSequence> segments)` removed empty and return BasedSequence.NULL when no segments which is the logical result however, this will mean empty node text in FencedCodeBlock will now return NULL sequence instead of an empty sequence from the document.
`BasedSequence`	`subSequence(int start, int end)` Get a portion of this sequence

Methods inherited from class com.vladsch.flexmark.util.sequence.BasedSequenceImpl
baseSubSequence, compareTo, containsAllOf, containsSomeOf, emptyArray, equals, equalsIgnoreCase, extendByAny, extendToAny, firstNonNull, getEmptyPrefix, getEmptySuffix, intersect, isContinuationOf, isContinuedBy, normalizeEndWithEOL, normalizeEOL, nullSequence, of, of, of, prefixOf, prefixWithIndent, safeBaseCharAt, safeCharAt, sequenceOf, spliceAtEnd, suffixOf, toMapped, unescape, unescape, unescapeNoEntities

Methods inherited from class com.vladsch.flexmark.util.sequence.RichCharSequenceBase
append, appendTo, appendTo, appendTo, columnsToNextTabStop, 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, endCharAt, endOfDelimitedBy, endOfDelimitedByAny, endOfDelimitedByAnyNot, endOfLine, endOfLineAnyEOL, endSequence, endSequence, endsWith, endsWith, endsWithIgnoreCase, eolLength, eolLength, expandTo, firstChar, firstNonNull, 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, padEnd, padEnd, padStart, padStart, removePrefix, removePrefix, removePrefixIgnoreCase, removeProperPrefix, removeProperPrefix, removeProperPrefixIgnoreCase, removeProperSuffix, removeProperSuffix, removeProperSuffixIgnoreCase, removeSuffix, removeSuffix, removeSuffixIgnoreCase, replace, sequenceOf, sequenceOf, split, split, split, split, split, split, split, split, startOfDelimitedBy, startOfDelimitedByAny, startOfDelimitedByAnyNot, startOfLine, startOfLineAnyEOL, startsWith, startsWith, startsWithIgnoreCase, subSequence, subSequence, toLowerCase, toLowerCase, toString, 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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vladsch.flexmark.util.sequence.BasedSequence
extendByAny, extendByOneOfAny, extendToAny, prefixWithIndent

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, endCharAt, endOfDelimitedBy, endOfDelimitedByAny, endOfDelimitedByAnyNot, endOfLine, endOfLineAnyEOL, endSequence, endSequence, endsWith, endsWith, endsWithIgnoreCase, eolLength, eolLength, 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, padEnd, padEnd, padStart, padStart, removePrefix, removePrefix, removePrefixIgnoreCase, removeProperPrefix, removeProperPrefix, removeProperPrefixIgnoreCase, removeProperSuffix, removeProperSuffix, removeProperSuffixIgnoreCase, removeSuffix, removeSuffix, removeSuffixIgnoreCase, replace, sequenceOf, sequenceOf, split, split, split, split, split, split, split, split, startOfDelimitedBy, startOfDelimitedByAny, startOfDelimitedByAnyNot, startOfLine, startOfLineAnyEOL, startsWith, startsWith, startsWithIgnoreCase, subSequence, subSequence, toLowerCase, toLowerCase, 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
chars, codePoints, toString

- Method Detail
  - 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
  - getBaseSequence
```
public BasedSequence getBaseSequence()
```
    Description copied from interface: BasedSequence
    
    Get the base sequence for the text
    
    Returns:
    
    base sequence
  - getStartOffset
```
public int getStartOffset()
```
    Get the first start in the base sequence, non-based sequences are skipped
    
    Returns:
    
    start in base sequence
  - getEndOffset
```
public int getEndOffset()
```
    Get the last end in the base sequence, non-based sequences are skipped
    
    Returns:
    
    end in base sequence
  - getIndexRange
```
public Range getIndexRange(int startOffset,
                           int endOffset)
```
    Description copied from interface: BasedSequence
    
    Get the range of indices that map into BasedSequence.getBaseSequence() with startOffset and endOffset
    
    Specified by:
    
    getIndexRange in interface BasedSequence
    
    Overrides:
    
    getIndexRange in class BasedSequenceImpl
    
    Parameters:
    
    startOffset - start offset into base sequence
    
    endOffset - end offset into base sequence
    
    Returns:
    
    range into this sequence that spans start and end offset.
  - getBaseOffsets
```
public int[] getBaseOffsets()
```
  - getBaseStartOffset
```
public int getBaseStartOffset()
```
  - 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
  - of
```
public static BasedSequence of(List<BasedSequence> segments)
```
    removed empty and return BasedSequence.NULL when no segments which is the logical result however, this will mean empty node text in FencedCodeBlock will now return NULL sequence instead of an empty sequence from the document.
    If you need the location where content would have been use the FencedCodeBlock.getOpeningMarker().getEndOffset() + 1
    
    Parameters:
    
    segments - list of based sequences to put into a based sequence
    
    Returns:
    
    based sequence of segments. Result is a sequence which looks like all the segments were concatenated, while still maintaining the original offset for each character when using getIndexOffset(int)(int index)
  - 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
  - charAt
```
public char charAt(int index)
```
  - baseSubSequence
```
public BasedSequence 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
  - subSequence
```
public BasedSequence subSequence(int start,
                                 int end)
```
    Description copied from interface: RichCharSequence
    
    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
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class BasedSequenceImpl
  - of
```
public static BasedSequence of(BasedSequence... segments)
```

Class SegmentedSequence

Nested Class Summary

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

Field Summary

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

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

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.lang.CharSequence

Method Detail

getBase

getBaseSequence

getStartOffset

getEndOffset

getIndexRange

getBaseOffsets

getBaseStartOffset

getIndexOffset

of

length

getSourceRange

charAt

baseSubSequence

subSequence

hashCode

equals

of