Note
'\0' changed to '�' use com. mapper to get original null chars.
Since equals is used for comparison of sequences and strings by base sequence manager, a base sequence with NUL may not compare equal to an equivalent unwrapped sequence because NUL chars are not converted. For Strings this is handled by using String.equals() for comparison. For other CharacterSequence types the match will fail if original has NUL in it.
a subSequence() returns a sub-sequence from the original base sequence with corresponding offsets
| Modifier and Type | Class and Description |
|---|---|
| public static class |
| Modifier and Type | Field and Description |
|---|---|
| public static final BasedSequence | |
| public static final BasedSequence[] | |
| public static final List | |
| public static final BasedSequence[] | |
| public static final BasedSequence | |
| public static final BasedSequence | |
| public static final BasedSequence | |
| public static final BasedSequence |
| Modifier and Type | Method and Description |
|---|---|
| public void | addSegments(@NotNull IBasedSegmentBuilder<?>
builder builder)Add segments for this sequence, replacing out of base characters with strings |
| public int | |
| public int | |
| public int | |
| public int | |
| public int | |
| public int | |
| public int | |
| public @NotNull Pair | |
| public @NotNull Pair | |
| public @NotNull Pair | |
| public @NotNull Range | |
| public @NotNull Range | |
| public @NotNull Range | |
| public int | |
| public int | |
| public int | |
| public int | |
| public @NotNull BasedSequence | Returns: based sequence whose contents reflect the selected portionoffset from 0 of original sequence startIndex, int offset from 0 of original sequence endIndex)Get a portion of this sequence's base sequence Note this means that if this sequence applies modifications to the original sequence then these modifications are NOT be applied to the returned sequence. |
| public @NotNull BasedSequence | Returns: based sequence from startIndex to the endIndexoffset from 0 of original sequence startIndex)Get a portion of the original sequence that this sequence is based on |
| public boolean | Returns: true if other is contained in thisbased sequence from the same base other)start/end offset based containment, not textual |
| public boolean | Returns: true if line contains some characters from the setset of characters to be tested charSet)Test for line contains only characters from the set |
| public boolean | Returns: true if line contains some characters from the setset of characters to be tested charSet)Test for line containing only characters not in the set |
| public boolean | Returns: true if line contains some characters in the setset of characters to be tested charSet)Test for line containing some of the characters in the set |
| public boolean | Returns: true if line contains some characters not in the setset of characters to be tested charSet)Test for line containing some characters not in the set |
| public boolean | Returns: true if other is contained in thisbased sequence from the same base other)start/end offset based containment, not textual |
| public @NotNull BasedSequence | Returns: sequence whichset of characters to include charSet, int maximum extra characters to include maxCount)Extend this based sequence to include characters from underlying based sequence |
| public @NotNull BasedSequence | |
| public @NotNull BasedSequence | Returns: sequence whichset of characters to include charSet, int maximum extra characters to include maxCount)Extend this based sequence to include characters from underlying based sequence not in character set |
| public @NotNull BasedSequence | |
| public @NotNull BasedSequence | |
| public @NotNull BasedSequence | |
| public default @NotNull BasedSequence | |
| public default @NotNull BasedSequence | |
| public @NotNull BasedSequence | Returns: resulting sequence after extension. If already spanning the line then this sequence is returned. if the last character of this sequence are found in eolChars then no extension will be performed since it already includes the line endcharacters to consider as EOL, note eolChars, boolean eolStartLength(int) eolEndLength(int) should report length of EOL found if length > 1if to include the eol in the string includeEol)Extend in contained based sequence |
| public @NotNull BasedSequence | |
| public @NotNull BasedSequence | |
| public @NotNull BasedSequence | |
| public @NotNull BasedSequence | Returns: resulting sequence after extension. If already spanning the line then this sequence is returned. if the first character of this sequence are found in eolChars then no extension will be performed since it already includes the line endcharacters to consider as EOL, note eolChars, boolean eolStartLength(int) eolEndLength(int) should report length of EOL found if length > 1if to include the eol in the string includeEol)Extend in contained based sequence |
| public @NotNull BasedSequence | |
| public @NotNull BasedSequence | |
| public @NotNull BasedSequence | |
| public @NotNull Object | Returns: underlying object containing original textGet the underlying object on which this sequence contents are based |
| public @NotNull BasedSequence | |
| public @NotNull SequenceBuilder | getBuilder()
Redeclares com. Get a sequence builder for this sequence type |
| public @NotNull BasedSequence | |
| public @NotNull BasedSequence | |
| public int | Returns: end offset in original textGet the end offset of this sequence into |
| public int | Returns: offset of index of this sequence in original textindex for which to get the offset in original source index)Get the offset of index in this sequence mapped to offset into |
| public @NotNull SegmentTree | |
| public @NotNull Range | Returns: Range of start offset and end offsetGet the range of this sequence in original |
| public int | Returns: start offset in original textGet the start offset of this sequence into |
| public @NotNull BasedSequence | Returns: sequence which is the intersection of the range of this and otherbased sequence from the same parent other)start/end offset based intersection, not textual |
| public boolean | Returns: true if character at index tests trueindex in string index, @NotNull CharPredicate character set predicate predicate)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 |
| public boolean | Returns: true if this sequence is a continuation of the given sequence in original source textsequence to test other)Test if this sequence is a continuation of the given sequence in original source text |
| public boolean | Returns: true if the given sequence is a continuation of this one in the original textsequence to test other)Test if the given sequence is a continuation of this sequence in original source text |
| public @NotNull BasedSequence | Returns: based sequence with only \n for line separators and terminated by \nreplaced text mapper which will be uses to map unescaped index to original source index textMapper)replace any \r\n and \r by \n, append terminating EOL if one is not present |
| public @NotNull BasedSequence | Returns: based sequence with only \n for line separatorsreplaced text mapper which will be uses to map unescaped index to original source index textMapper)replace any \r\n and \r by \n |
| public static @NotNull BasedSequence | |
| public static @NotNull BasedSequence | |
| public @NotNull BasedSequence | Returns: prefix part of this as compared to other, start/end offset based, not contentbased sequence from the same base other)Get the prefix part of this from other, start/end offset based containment, not textual |
| public @NotNull BasedSequence | Returns: sequence whichmaximum columns to include, default maxColumns)Integer#MAX_VALUEExtend this based sequence to include characters from underlying based sequence taking tab expansion to 4th spaces into account |
| public @NotNull BasedSequence | |
| public static @NotNull BasedSequence | |
| public static @NotNull BasedSequence | |
| public static @NotNull BasedSequence | |
| public char | Returns: character or '\0' if index out of base sequenceindex in string 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 |
| public @NotNull BasedSequence | Returns: based sequence that contains the span from start of this sequence and end of otherassertion will fail if the other sequence is not a continuation of this one sequence to append to end of this one other)Splice the given sequence to the end of this one and return a BasedSequence of the result. |
| public @NotNull BasedSequence | Returns: based sequence which represents the requested range of this sequence.offset from startIndex of this sequence startIndex, int offset from startIndex of this sequence endIndex)Redeclares com. Get a portion of this sequence |
| public @NotNull BasedSequence | Returns: suffix part of this as compared to other, start/end offset based, not contentbased sequence from the same base other)Get the suffix part of this from other, start/end offset based containment, not textual |
| public @NotNull String | |
| public @NotNull BasedSequence | Returns: unescaped text in based sequencereplaced text mapper which will be uses to map unescaped index to original source index textMapper)Get the unescaped string of this sequence content |
| public @NotNull String | Returns: unescaped textGet the unescaped string of this sequence content without unescaping entities |