flexmark-all 0.64.8 · com.vladsch.flexmark.util.sequence.MappedBasedSequence

Modifier and Type	Field and Description
private final BasedSequence	baseSeq
private final CharMapper	mapper

Access	Constructor and Description
private	MappedBasedSequence(BasedSequence baseSeq, CharMapper mapper)

Method Summary

Modifier and Type	Method and Description
public void	addSegments(@NotNull IBasedSegmentBuilder<?> builder)
public boolean	allOptions(int option flags options) Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.allOptions. Options test for options for this sequence default reports true for global default options (if any) , variation available on BasedSequenceWithOptions
public boolean	anyOptions(int option flags options) Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.anyOptions. Options test for options for this sequence default reports true for global default options (if any) , variation available on BasedSequenceWithOptions
public char	charAt(int the index of the `char` value to be returned index) Implements java.lang.CharSequence.charAt. Returns the `char` value at the specified index.
public @NotNull Object	getBase() Implements com.vladsch.flexmark.util.sequence.BasedSequence.getBase. Get the underlying object on which this sequence contents are based
public @NotNull BasedSequence	getBaseSequence() Implements com.vladsch.flexmark.util.sequence.BasedSequence.getBaseSequence. Get the base sequence for the text
public @NotNull CharMapper	getCharMapper() Implements com.vladsch.flexmark.util.sequence.MappedSequence.getCharMapper.
public @NotNull BasedSequence	getCharSequence() Implements com.vladsch.flexmark.util.sequence.MappedSequence.getCharSequence.
public int	getEndOffset() Implements com.vladsch.flexmark.util.sequence.BasedSequence.getEndOffset. Get the end offset of this sequence into `getBaseSequence()` and `getBase()` original text source.
public int	getIndexOffset(int index for which to get the offset in original source index) Implements com.vladsch.flexmark.util.sequence.BasedSequence.getIndexOffset. Get the offset of index in this sequence mapped to offset into `getBaseSequence()` and `getBase()` original text source.
public <T> T	getOption(DataKeyBase<T> in options dataKey) Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOption. Options holder, default has none, only available on BasedSequenceWithOptions
public int	getOptionFlags() Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptionFlags. Options test for options for this sequence default reports true for global default options (if any) , variation available on BasedSequenceWithOptions
public @Nullable DataHolder	getOptions() Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptions. Options holder, default has none, only available on BasedSequenceWithOptions
public @NotNull Range	getSourceRange() Implements com.vladsch.flexmark.util.sequence.BasedSequence.getSourceRange. Get the range of this sequence in original `getBaseSequence()` and `getBase()` original text source.
public int	getStartOffset() Implements com.vladsch.flexmark.util.sequence.BasedSequence.getStartOffset. Get the start offset of this sequence into `getBaseSequence()` and `getBase()` original text source.
public int	length() Implements java.lang.CharSequence.length. Returns the length of this character sequence.
public static @NotNull BasedSequence	mappedOf(@NotNull BasedSequence baseSeq, @NotNull CharMapper mapper)
public @NotNull BasedSequence	sequenceOf(@Nullable CharSequence baseSeq, int startIndex, int endIndex)
public @NotNull BasedSequence	subSequence(int the start index, inclusive startIndex, int the end index, exclusive endIndex) Implements java.lang.CharSequence.subSequence, com.vladsch.flexmark.util.sequence.BasedSequence.subSequence, com.vladsch.flexmark.util.sequence.IRichSequence.subSequence. Returns a `CharSequence` that is a subsequence of this sequence.
public @NotNull BasedSequence	toMapped(CharMapper mapper) Overrides com.vladsch.flexmark.util.sequence.BasedSequenceImpl.toMapped. Implements com.vladsch.flexmark.util.sequence.IRichSequence.toMapped.

Inherited from com.vladsch.flexmark.util.sequence.BasedSequenceImpl:: addSegments baseColumnAtEnd baseColumnAtIndex baseColumnAtStart baseEndOfLine baseEndOfLine baseEndOfLineAnyEOL baseEndOfLineAnyEOL baseLineColumnAtEnd baseLineColumnAtIndex baseLineColumnAtStart baseLineRangeAtEnd baseLineRangeAtIndex baseLineRangeAtStart baseStartOfLine baseStartOfLine baseStartOfLineAnyEOL baseStartOfLineAnyEOL baseSubSequence baseSubSequence containsAllOf containsOnlyIn containsOnlyNotIn containsSomeIn containsSomeNotIn containsSomeOf create emptyArray extendByAny extendByAny extendByAnyNot extendByAnyNot extendByOneOfAny extendByOneOfAnyNot extendToEndOfLine extendToEndOfLine extendToEndOfLine extendToEndOfLine extendToStartOfLine extendToStartOfLine extendToStartOfLine extendToStartOfLine firstNonNull getBuilder getEmptyPrefix getEmptySuffix getSegmentTree intersect isBaseCharAt isContinuationOf isContinuedBy normalizeEndWithEOL normalizeEOL nullSequence prefixOf prefixWith prefixWithIndent prefixWithIndent safeBaseCharAt safeCharAt sequenceOf spliceAtEnd suffixOf toStringOrNull unescape unescape unescapeNoEntities

Field Detail

baseSeq	back to summary
private final BasedSequence baseSeq

mapper	back to summary
private final CharMapper mapper

Constructor Detail

MappedBasedSequence	back to summary
private MappedBasedSequence(BasedSequence baseSeq, CharMapper mapper)

Method Detail

addSegments	back to summary
public void addSegments(@NotNull IBasedSegmentBuilder<?> builder) Annotations @Override

allOptions	back to summary
public boolean allOptions(int options) Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.allOptions. Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.allOptions. Options test for options for this sequence default reports true for global default options (if any) , variation available on BasedSequenceWithOptions Parameters options:int option flags Returns:boolean true if all option flags passed are set for this sequence Annotations @Override

allOptions

back to summary

public boolean allOptions(int options)

Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.allOptions.

Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.allOptions.

Options test for options for this sequence

default reports true for global default options (if any) , variation available on BasedSequenceWithOptions

Parameters

options:int: option flags

Returns:boolean

true if all option flags passed are set for this sequence

Annotations

@Override

anyOptions	back to summary
public boolean anyOptions(int options) Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.anyOptions. Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.anyOptions. Options test for options for this sequence default reports true for global default options (if any) , variation available on BasedSequenceWithOptions Parameters options:int option flags Returns:boolean true if any option flags passed are set for this sequence Annotations @Override

anyOptions

back to summary

public boolean anyOptions(int options)

Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.anyOptions.

Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.anyOptions.

Options test for options for this sequence

default reports true for global default options (if any) , variation available on BasedSequenceWithOptions

Parameters

options:int: option flags

Returns:boolean

true if any option flags passed are set for this sequence

Annotations

@Override

charAt back to summary

charAt	back to summary
public char charAt(int index) Implements java.lang.CharSequence.charAt. Doc from java.lang.CharSequence.charAt. Returns the `char` value at the specified index. An index ranges from zero to `length() - 1`. The first `char` value of the sequence is at index zero, the next at index one, and so on, as for array indexing. If the `char` value specified by the index is a surrogate, the surrogate value is returned. Parameters index:int the index of the `char` value to be returned Returns:char the specified `char` value Annotations @Override

public char charAt(int index)

Implements java.lang.CharSequence.charAt.

Doc from java.lang.CharSequence.charAt.

Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Parameters

index:int: the index of the char value to be returned

Returns:char

the specified char value

Annotations

@Override

getBase	back to summary
public @NotNull Object getBase() Implements com.vladsch.flexmark.util.sequence.BasedSequence.getBase. Doc from com.vladsch.flexmark.util.sequence.BasedSequence.getBase. Get the underlying object on which this sequence contents are based Returns:@NotNull Object underlying object containing original text Annotations @NotNull @Override

getBase

back to summary

public @NotNull Object getBase()

Implements com.vladsch.flexmark.util.sequence.BasedSequence.getBase.

Doc from com.vladsch.flexmark.util.sequence.BasedSequence.getBase.

Get the underlying object on which this sequence contents are based

Returns:@NotNull Object

underlying object containing original text

Annotations

@NotNull
@Override

getBaseSequence	back to summary
public @NotNull BasedSequence getBaseSequence() Implements com.vladsch.flexmark.util.sequence.BasedSequence.getBaseSequence. Doc from com.vladsch.flexmark.util.sequence.BasedSequence.getBaseSequence. Get the base sequence for the text Returns:@NotNull BasedSequence base sequence Annotations @NotNull @Override

getBaseSequence

back to summary

public @NotNull BasedSequence getBaseSequence()

Implements com.vladsch.flexmark.util.sequence.BasedSequence.getBaseSequence.

Doc from com.vladsch.flexmark.util.sequence.BasedSequence.getBaseSequence.

Get the base sequence for the text

Returns:@NotNull BasedSequence

base sequence

Annotations

@NotNull
@Override

getCharMapper	back to summary
public @NotNull CharMapper getCharMapper() Implements com.vladsch.flexmark.util.sequence.MappedSequence.getCharMapper. Annotations @NotNull @Override

getCharMapper

back to summary

public @NotNull CharMapper getCharMapper()

Implements com.vladsch.flexmark.util.sequence.MappedSequence.getCharMapper.

Annotations

@NotNull
@Override

getCharSequence	back to summary
public @NotNull BasedSequence getCharSequence() Implements com.vladsch.flexmark.util.sequence.MappedSequence.getCharSequence. Annotations @NotNull @Override

getCharSequence

back to summary

public @NotNull BasedSequence getCharSequence()

Implements com.vladsch.flexmark.util.sequence.MappedSequence.getCharSequence.

Annotations

@NotNull
@Override

getEndOffset back to summary

getEndOffset	back to summary
public int getEndOffset() Implements com.vladsch.flexmark.util.sequence.BasedSequence.getEndOffset. Doc from com.vladsch.flexmark.util.sequence.BasedSequence.getEndOffset. Get the end offset of this sequence into `getBaseSequence()` and `getBase()` original text source. Returns:int end offset in original text Annotations @Override

public int getEndOffset()

Implements com.vladsch.flexmark.util.sequence.BasedSequence.getEndOffset.

Doc from com.vladsch.flexmark.util.sequence.BasedSequence.getEndOffset.

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

Returns:int

end offset in original text

Annotations

@Override

getIndexOffset back to summary

getIndexOffset	back to summary
public int getIndexOffset(int index) Implements com.vladsch.flexmark.util.sequence.BasedSequence.getIndexOffset. Doc from com.vladsch.flexmark.util.sequence.BasedSequence.getIndexOffset. Get the offset of index in this sequence mapped to offset into `getBaseSequence()` and `getBase()` original text source. Note if the character at given index does not equal the corresponding character in the base sequence then this method should return -1 otherwise segmented based sequence will be created for original base character Parameters index:int index for which to get the offset in original source Returns:int offset of index of this sequence in original text Annotations @Override

public int getIndexOffset(int index)

Implements com.vladsch.flexmark.util.sequence.BasedSequence.getIndexOffset.

Doc from com.vladsch.flexmark.util.sequence.BasedSequence.getIndexOffset.

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

Note

if the character at given index does not equal the corresponding character in the base sequence then this method should return -1 otherwise segmented based sequence will be created for original base character

Parameters

index:int: index for which to get the offset in original source

Returns:int

offset of index of this sequence in original text

Annotations

@Override

getOption	back to summary
public <T> T getOption(DataKeyBase<T> dataKey) Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOption. Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOption. Options holder, default has none, only available on BasedSequenceWithOptions Parameters <T> type of value held by key dataKey:DataKeyBase<T> in options Returns:T true if data key is available Annotations @Override

getOptionFlags	back to summary
public int getOptionFlags() Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptionFlags. Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptionFlags. Options test for options for this sequence default reports true for global default options (if any) , variation available on BasedSequenceWithOptions Returns:int option flags for this sequence Annotations @Override

getOptionFlags

back to summary

public int getOptionFlags()

Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptionFlags.

Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptionFlags.

Options test for options for this sequence

default reports true for global default options (if any) , variation available on BasedSequenceWithOptions

Returns:int

option flags for this sequence

Annotations

@Override

getOptions	back to summary
public @Nullable DataHolder getOptions() Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptions. Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptions. Options holder, default has none, only available on BasedSequenceWithOptions Returns:@Nullable DataHolder data holder with options or null if none for this sequence Annotations @Override @Nullable

getOptions

back to summary

public @Nullable DataHolder getOptions()

Implements com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptions.

Doc from com.vladsch.flexmark.util.sequence.BasedOptionsHolder.getOptions.

Options holder, default has none, only available on BasedSequenceWithOptions

Returns:@Nullable DataHolder

data holder with options or null if none for this sequence

Annotations

@Override
@Nullable

getSourceRange back to summary

getSourceRange	back to summary
public @NotNull Range getSourceRange() Implements com.vladsch.flexmark.util.sequence.BasedSequence.getSourceRange. Doc from com.vladsch.flexmark.util.sequence.BasedSequence.getSourceRange. Get the range of this sequence in original `getBaseSequence()` and `getBase()` original text source. Returns:@NotNull Range Range of start offset and end offset Annotations @NotNull @Override

public @NotNull Range getSourceRange()

Implements com.vladsch.flexmark.util.sequence.BasedSequence.getSourceRange.

Doc from com.vladsch.flexmark.util.sequence.BasedSequence.getSourceRange.

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

Returns:@NotNull Range

Range of start offset and end offset

Annotations

@NotNull
@Override

getStartOffset back to summary

getStartOffset	back to summary
public int getStartOffset() Implements com.vladsch.flexmark.util.sequence.BasedSequence.getStartOffset. Doc from com.vladsch.flexmark.util.sequence.BasedSequence.getStartOffset. Get the start offset of this sequence into `getBaseSequence()` and `getBase()` original text source. Returns:int start offset in original text Annotations @Override

public int getStartOffset()

Implements com.vladsch.flexmark.util.sequence.BasedSequence.getStartOffset.

Doc from com.vladsch.flexmark.util.sequence.BasedSequence.getStartOffset.

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

Returns:int

start offset in original text

Annotations

@Override

length back to summary

length	back to summary
public int length() Implements java.lang.CharSequence.length. Doc from java.lang.CharSequence.length. Returns the length of this character sequence. The length is the number of 16-bit `char`s in the sequence. Returns:int the number of `char`s in this sequence Annotations @Override

public int length()

Implements java.lang.CharSequence.length.

Doc from java.lang.CharSequence.length.

Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.

Returns:int

the number of chars in this sequence

Annotations

@Override

mappedOf	back to summary
public static @NotNull BasedSequence mappedOf(@NotNull BasedSequence baseSeq, @NotNull CharMapper mapper) Annotations @NotNull

sequenceOf	back to summary
public @NotNull BasedSequence sequenceOf(@Nullable CharSequence baseSeq, int startIndex, int endIndex) Annotations @NotNull @Override

subSequence back to summary

subSequence	back to summary
public @NotNull BasedSequence subSequence(int startIndex, int endIndex) Implements java.lang.CharSequence.subSequence, com.vladsch.flexmark.util.sequence.BasedSequence.subSequence, com.vladsch.flexmark.util.sequence.IRichSequence.subSequence. Doc from java.lang.CharSequence.subSequence. Returns a `CharSequence` that is a subsequence of this sequence. The subsequence starts with the `char` value at the specified index and ends with the `char` value at index `end - 1`. The length (in `char`s) of the returned sequence is `end - start`, so if `start == end` then an empty sequence is returned. Parameters startIndex:int the start index, inclusive endIndex:int the end index, exclusive Returns:@NotNull BasedSequence the specified subsequence Annotations @NotNull @Override

public @NotNull BasedSequence subSequence(int startIndex, int endIndex)

Implements java.lang.CharSequence.subSequence, com.vladsch.flexmark.util.sequence.BasedSequence.subSequence, com.vladsch.flexmark.util.sequence.IRichSequence.subSequence.

Doc from java.lang.CharSequence.subSequence.

Returns a CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Parameters

startIndex:int: the start index, inclusive
endIndex:int: the end index, exclusive

Returns:@NotNull BasedSequence

the specified subsequence

Annotations

@NotNull
@Override

toMapped	back to summary
public @NotNull BasedSequence toMapped(CharMapper mapper) Overrides com.vladsch.flexmark.util.sequence.BasedSequenceImpl.toMapped. Implements com.vladsch.flexmark.util.sequence.IRichSequence.toMapped. Annotations @Override @NotNull

toMapped

back to summary

public @NotNull BasedSequence toMapped(CharMapper mapper)

Overrides com.vladsch.flexmark.util.sequence.BasedSequenceImpl.toMapped.

Implements com.vladsch.flexmark.util.sequence.IRichSequence.toMapped.

Annotations

@Override
@NotNull

public final Class MappedBasedSequence

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail