flexmark-all 0.64.8 · com.vladsch.flexmark.util.sequence.builder.SequenceBuilder

Modifier and Type	Field and Description
private final @NotNull BasedSequence	altBase
private final @NotNull BasedSequence	baseSeq
private final @NotNull HashMap<BasedSequence, Boolean>	equivalentBases
private @Nullable BasedSequence	resultSeq
private final BasedSegmentBuilder	segments

Access	Constructor and Description
private	SequenceBuilder(@NotNull BasedSequence base sequence for which to create a builder base, @Nullable SegmentOptimizer optimizer for based segment builder, or default `CharRecoveryOptimizer` optimizer) Construct a base sequence builder for given base sequence with default options.
private	SequenceBuilder(@NotNull BasedSequence base, @Nullable SegmentOptimizer optimizer, @NotNull HashMap<BasedSequence, Boolean> equivalentBases)
private	SequenceBuilder(@NotNull BasedSequence base sequence for which to create a builder base, int builder options options, @Nullable SegmentOptimizer optimizer for based segment builder, or default `CharRecoveryOptimizer` optimizer, @NotNull HashMap<BasedSequence, Boolean> equivalentBases) Construct a base sequence builder for given base sequence with specific options.

Method Summary

Modifier and Type	Method and Description
public @NotNull SequenceBuilder	addByLength(int startOffset, int textLength)
public @NotNull SequenceBuilder	addByOffsets(int startOffset, int endOffset)
public @NotNull SequenceBuilder	addRange(@NotNull Range range)
public @NotNull SequenceBuilder	append(@Nullable CharSequence The character sequence from which a subsequence will be appended. If `csq` is `null`, then characters will be appended as if `csq` contained the four characters `"null"`. chars, int The index of the first character in the subsequence startIndex, int The index of the character following the last character in the subsequence endIndex) Implements java.lang.Appendable.append. Appends a subsequence of the specified character sequence to this `Appendable`.
public @NotNull SequenceBuilder	append(char The character to append c) Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.append. Appends the specified character to this `Appendable`.
public @NotNull SequenceBuilder	append(char c, int count) Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.append.
public @NotNull SequenceBuilder	append(int startOffset, int endOffset)
public @NotNull SequenceBuilder	append(@NotNull Range chars)
public char	charAt(int index) Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.charAt.
public static @NotNull SequenceBuilder	emptyBuilder(@NotNull BasedSequence base)
public static @NotNull SequenceBuilder	emptyBuilder(@NotNull BasedSequence base, @NotNull SegmentOptimizer optimizer)
public static @NotNull SequenceBuilder	emptyBuilder(@NotNull BasedSequence base, int options)
public static @NotNull SequenceBuilder	emptyBuilder(@NotNull BasedSequence base, int options, @NotNull SegmentOptimizer optimizer)
public @NotNull BasedSequence	getBaseSequence()
public @NotNull SequenceBuilder	getBuilder() Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.getBuilder.
public @Nullable Range	getLastRangeOrNull()
public @NotNull BasedSegmentBuilder	getSegmentBuilder()
public @Nullable BasedSequence	getSingleBasedSequence() Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.getSingleBasedSequence. Note returns non-null value if the underlying `IBasedSegmentBuilder#getBaseSubSequenceRange()` returns non-null value
pack-priv boolean	isCommonBaseSequence(@NotNull BasedSequence chars)
public int	length() Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.length.
public @NotNull BasedSequence	toSequence() Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.toSequence.
public @NotNull BasedSequence	Returns: builder with offsets mapped to altSequence toSequence(@NotNull BasedSequence based sequence which is character identical to this builder's baseSeq altSequence) Construct sequence from this builder using another based sequence which is character identical to this builder's baseSeq
public @NotNull BasedSequence	Returns: builder with offsets mapped to altSequence toSequence(@NotNull BasedSequence based sequence which is character identical to this builder's baseSeq altSequence, @Nullable CharPredicate character set of characters to trim trimStart, @Nullable CharPredicate chars which should be treated as equivalent for verification purposes (Space, Tab, EOL, usually) ignoreCharDiff) Construct sequence from this builder using another based sequence which is character identical to this builder's baseSeq
public @NotNull BasedSequence	Returns: builder with offsets mapped to altSequence toSequenceByIndex(@NotNull BasedSequence based sequence which is character identical to this builder's baseSeq altSequence, @Nullable CharPredicate character set of characters to trim trimStart, @Nullable CharPredicate chars which should be treated as equivalent for verification purposes (Space, Tab, EOL, usually) ignoreCharDiff) Construct sequence from this builder using another based sequence which is character identical to this builder's baseSeq by length
public @NotNull String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public @NotNull String	toStringNoAddedSpaces()
public @NotNull String	toStringWithRanges()
public @NotNull String	toStringWithRanges(boolean toVisibleWhiteSpace)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

altBase	back to summary
private final @NotNull BasedSequence altBase Annotations @NotNull

baseSeq	back to summary
private final @NotNull BasedSequence baseSeq Annotations @NotNull

equivalentBases	back to summary
private final @NotNull HashMap<BasedSequence, Boolean> equivalentBases Annotations @NotNull

resultSeq	back to summary
private @Nullable BasedSequence resultSeq Annotations @Nullable

segments	back to summary
private final BasedSegmentBuilder segments

Constructor Detail

SequenceBuilder back to summary

SequenceBuilder	back to summary
private SequenceBuilder(@NotNull BasedSequence base, @Nullable SegmentOptimizer optimizer) Construct a base sequence builder for given base sequence with default options. Note the builder is always constructed for the base sequence of the base. ie. for the based sequence returned by `BasedSequence#getBaseSequence()`, so any subsequence from a base can be used as argument for the constructor Parameters base:@NotNull BasedSequence base sequence for which to create a builder optimizer:@Nullable SegmentOptimizer optimizer for based segment builder, or default `CharRecoveryOptimizer`

private SequenceBuilder(@NotNull BasedSequence base, @Nullable SegmentOptimizer optimizer)

Construct a base sequence builder for given base sequence with default options.

Note

the builder is always constructed for the base sequence of the base. ie. for the based sequence returned by BasedSequence#getBaseSequence(), so any subsequence from a base can be used as argument for the constructor

Parameters

base:@NotNull BasedSequence: base sequence for which to create a builder
optimizer:@Nullable SegmentOptimizer: optimizer for based segment builder, or default CharRecoveryOptimizer

SequenceBuilder	back to summary
private SequenceBuilder(@NotNull BasedSequence base, @Nullable SegmentOptimizer optimizer, @NotNull HashMap<BasedSequence, Boolean> equivalentBases)

SequenceBuilder back to summary

SequenceBuilder	back to summary
private SequenceBuilder(@NotNull BasedSequence base, int options, @Nullable SegmentOptimizer optimizer, @NotNull HashMap<BasedSequence, Boolean> equivalentBases) Construct a base sequence builder for given base sequence with specific options. Note the builder is always constructed for the base sequence of the base. ie. for the based sequence returned by `BasedSequence#getBaseSequence()`, so any subsequence from a base can be used as argument for the constructor Parameters base:@NotNull BasedSequence base sequence for which to create a builder options:int builder options optimizer:@Nullable SegmentOptimizer optimizer for based segment builder, or default `CharRecoveryOptimizer`

private SequenceBuilder(@NotNull BasedSequence base, int options, @Nullable SegmentOptimizer optimizer, @NotNull HashMap<BasedSequence, Boolean> equivalentBases)

Construct a base sequence builder for given base sequence with specific options.

Note

Parameters

base:@NotNull BasedSequence: base sequence for which to create a builder
options:int: builder options
optimizer:@Nullable SegmentOptimizer: optimizer for based segment builder, or default CharRecoveryOptimizer

Method Detail

addByLength	back to summary
public @NotNull SequenceBuilder addByLength(int startOffset, int textLength) Annotations @NotNull

addByOffsets	back to summary
public @NotNull SequenceBuilder addByOffsets(int startOffset, int endOffset) Annotations @NotNull

addRange	back to summary
public @NotNull SequenceBuilder addRange(@NotNull Range range) Annotations @NotNull

append back to summary

append	back to summary
public @NotNull SequenceBuilder append(@Nullable CharSequence chars, int startIndex, int endIndex) Implements java.lang.Appendable.append. Doc from java.lang.Appendable.append. Appends a subsequence of the specified character sequence to this `Appendable`. An invocation of this method of the form `out.append(csq, start, end)` when `csq` is not `null`, behaves in exactly the same way as the invocation out.append(csq.subSequence(start, end)) The contents of this `Appendable` are unspecified if the `CharSequence` is modified during the method call or an exception is thrown when accessing the `CharSequence`. Parameters chars:@Nullable CharSequence The character sequence from which a subsequence will be appended. If `csq` is `null`, then characters will be appended as if `csq` contained the four characters `"null"`. startIndex:int The index of the first character in the subsequence endIndex:int The index of the character following the last character in the subsequence Returns:@NotNull SequenceBuilder A reference to this `Appendable` Annotations @NotNull @Override

public @NotNull SequenceBuilder append(@Nullable CharSequence chars, int startIndex, int endIndex)

Implements java.lang.Appendable.append.

Doc from java.lang.Appendable.append.

Appends a subsequence of the specified character sequence to this Appendable.

An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation

    out.append(csq.subSequence(start, end))

The contents of this Appendable are unspecified if the CharSequence is modified during the method call or an exception is thrown when accessing the CharSequence.

Parameters

chars:@Nullable CharSequence: The character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".
startIndex:int: The index of the first character in the subsequence
endIndex:int: The index of the character following the last character in the subsequence

Returns:@NotNull SequenceBuilder

A reference to this Appendable

Annotations

@NotNull
@Override

append back to summary

append	back to summary
public @NotNull SequenceBuilder append(char c) Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.append. Doc from java.lang.Appendable.append. Appends the specified character to this `Appendable`. Parameters c:char The character to append Returns:@NotNull SequenceBuilder A reference to this `Appendable` Annotations @NotNull

public @NotNull SequenceBuilder append(char c)

Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.append.

Doc from java.lang.Appendable.append.

Appends the specified character to this Appendable.

Parameters

c:char: The character to append

Returns:@NotNull SequenceBuilder

A reference to this Appendable

Annotations

@NotNull

append	back to summary
public @NotNull SequenceBuilder append(char c, int count) Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.append. Annotations @NotNull

append

back to summary

public @NotNull SequenceBuilder append(char c, int count)

Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.append.

Annotations

@NotNull

append	back to summary
public @NotNull SequenceBuilder append(int startOffset, int endOffset) Annotations @NotNull

append	back to summary
public @NotNull SequenceBuilder append(@NotNull Range chars) Annotations @NotNull

charAt	back to summary
public char charAt(int index) Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.charAt. Annotations @Override

charAt

back to summary

public char charAt(int index)

Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.charAt.

Annotations

@Override

emptyBuilder	back to summary
public static @NotNull SequenceBuilder emptyBuilder(@NotNull BasedSequence base) Annotations @NotNull

emptyBuilder	back to summary
public static @NotNull SequenceBuilder emptyBuilder(@NotNull BasedSequence base, @NotNull SegmentOptimizer optimizer) Annotations @NotNull

emptyBuilder	back to summary
public static @NotNull SequenceBuilder emptyBuilder(@NotNull BasedSequence base, int options) Annotations @NotNull

emptyBuilder	back to summary
public static @NotNull SequenceBuilder emptyBuilder(@NotNull BasedSequence base, int options, @NotNull SegmentOptimizer optimizer) Annotations @NotNull

getBaseSequence	back to summary
public @NotNull BasedSequence getBaseSequence() Annotations @NotNull

getBuilder	back to summary
public @NotNull SequenceBuilder getBuilder() Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.getBuilder. Annotations @NotNull @Override

getBuilder

back to summary

public @NotNull SequenceBuilder getBuilder()

Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.getBuilder.

Annotations

@NotNull
@Override

getLastRangeOrNull	back to summary
public @Nullable Range getLastRangeOrNull() Annotations @Nullable

getSegmentBuilder	back to summary
public @NotNull BasedSegmentBuilder getSegmentBuilder() Annotations @NotNull

getSingleBasedSequence back to summary

getSingleBasedSequence	back to summary
public @Nullable BasedSequence getSingleBasedSequence() Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.getSingleBasedSequence. Doc from com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.getSingleBasedSequence. Note returns non-null value if the underlying `IBasedSegmentBuilder#getBaseSubSequenceRange()` returns non-null value Returns:@Nullable BasedSequence sub-sequence of base representing the single segment or null if sequence not representable by a single subsequence Annotations @Nullable @Override

public @Nullable BasedSequence getSingleBasedSequence()

Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.getSingleBasedSequence.

Doc from com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.getSingleBasedSequence.

Note

returns non-null value if the underlying IBasedSegmentBuilder#getBaseSubSequenceRange() returns non-null value

Returns:@Nullable BasedSequence

sub-sequence of base representing the single segment or null if sequence not representable by a single subsequence

Annotations

@Nullable
@Override

isCommonBaseSequence	back to summary
pack-priv boolean isCommonBaseSequence(@NotNull BasedSequence chars)

length	back to summary
public int length() Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.length. Annotations @Override

length

back to summary

public int length()

Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.length.

Annotations

@Override

toSequence	back to summary
public @NotNull BasedSequence toSequence() Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.toSequence. Annotations @NotNull @Override

toSequence

back to summary

public @NotNull BasedSequence toSequence()

Implements com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder.toSequence.

Annotations

@NotNull
@Override

toSequence	back to summary
public @NotNull BasedSequence toSequence(@NotNull BasedSequence altSequence) Construct sequence from this builder using another based sequence which is character identical to this builder's baseSeq Parameters altSequence:@NotNull BasedSequence based sequence which is character identical to this builder's baseSeq Returns:@NotNull BasedSequence builder with offsets mapped to altSequence Annotations @NotNull

toSequence

back to summary

public @NotNull BasedSequence toSequence(@NotNull BasedSequence altSequence)

Construct sequence from this builder using another based sequence which is character identical to this builder's baseSeq

Parameters

altSequence:@NotNull BasedSequence: based sequence which is character identical to this builder's baseSeq

Returns:@NotNull BasedSequence

builder with offsets mapped to altSequence

Annotations

@NotNull

toSequence	back to summary
public @NotNull BasedSequence toSequence(@NotNull BasedSequence altSequence, @Nullable CharPredicate trimStart, @Nullable CharPredicate ignoreCharDiff) Construct sequence from this builder using another based sequence which is character identical to this builder's baseSeq Parameters altSequence:@NotNull BasedSequence based sequence which is character identical to this builder's baseSeq trimStart:@Nullable CharPredicate character set of characters to trim ignoreCharDiff:@Nullable CharPredicate chars which should be treated as equivalent for verification purposes (Space, Tab, EOL, usually) Returns:@NotNull BasedSequence builder with offsets mapped to altSequence Annotations @NotNull

toSequence

back to summary

public @NotNull BasedSequence toSequence(@NotNull BasedSequence altSequence, @Nullable CharPredicate trimStart, @Nullable CharPredicate ignoreCharDiff)

Construct sequence from this builder using another based sequence which is character identical to this builder's baseSeq

Parameters

altSequence:@NotNull BasedSequence: based sequence which is character identical to this builder's baseSeq
trimStart:@Nullable CharPredicate: character set of characters to trim
ignoreCharDiff:@Nullable CharPredicate: chars which should be treated as equivalent for verification purposes (Space, Tab, EOL, usually)

Returns:@NotNull BasedSequence

builder with offsets mapped to altSequence

Annotations

@NotNull

toSequenceByIndex	back to summary
public @NotNull BasedSequence toSequenceByIndex(@NotNull BasedSequence altSequence, @Nullable CharPredicate trimStart, @Nullable CharPredicate ignoreCharDiff) Construct sequence from this builder using another based sequence which is character identical to this builder's baseSeq by length Parameters altSequence:@NotNull BasedSequence based sequence which is character identical to this builder's baseSeq trimStart:@Nullable CharPredicate character set of characters to trim ignoreCharDiff:@Nullable CharPredicate chars which should be treated as equivalent for verification purposes (Space, Tab, EOL, usually) Returns:@NotNull BasedSequence builder with offsets mapped to altSequence Annotations @NotNull

toSequenceByIndex

back to summary

public @NotNull BasedSequence toSequenceByIndex(@NotNull BasedSequence altSequence, @Nullable CharPredicate trimStart, @Nullable CharPredicate ignoreCharDiff)

Construct sequence from this builder using another based sequence which is character identical to this builder's baseSeq by length

Parameters

altSequence:@NotNull BasedSequence: based sequence which is character identical to this builder's baseSeq
trimStart:@Nullable CharPredicate: character set of characters to trim
ignoreCharDiff:@Nullable CharPredicate: chars which should be treated as equivalent for verification purposes (Space, Tab, EOL, usually)

Returns:@NotNull BasedSequence

builder with offsets mapped to altSequence

Annotations

@NotNull

toString back to summary

toString	back to summary
public @NotNull String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:@NotNull String a string representation of the object Annotations @NotNull

public @NotNull String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:@NotNull String

a string representation of the object

Annotations

@NotNull

toStringNoAddedSpaces	back to summary
public @NotNull String toStringNoAddedSpaces() Annotations @NotNull

toStringWithRanges	back to summary
public @NotNull String toStringWithRanges() Annotations @NotNull

toStringWithRanges	back to summary
public @NotNull String toStringWithRanges(boolean toVisibleWhiteSpace) Annotations @NotNull

public Class SequenceBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail