com.vladsch.flexmark.util.sequence.builder

Class SequenceBuilder

java.lang.Object

com.vladsch.flexmark.util.sequence.builder.SequenceBuilder

All Implemented Interfaces:

ISequenceBuilder<SequenceBuilder,BasedSequence>, Appendable

public class SequenceBuilder
extends Object
implements ISequenceBuilder<SequenceBuilder,BasedSequence>

A Builder for Segmented BasedSequences

Method Summary

Modifier and Type	Method and Description
@NotNull SequenceBuilder	addByLength(int startOffset, int textLength)
@NotNull SequenceBuilder	addByOffsets(int startOffset, int endOffset)
@NotNull SequenceBuilder	addRange(@NotNull Range range)
@NotNull SequenceBuilder	append(char c)
@NotNull SequenceBuilder	append(char c, int count)
@NotNull SequenceBuilder	append(@Nullable CharSequence chars, int startIndex, int endIndex)
@NotNull SequenceBuilder	append(int startOffset, int endOffset)
@NotNull SequenceBuilder	append(@NotNull Range chars)
char	charAt(int index)
static @NotNull SequenceBuilder	emptyBuilder(@NotNull BasedSequence base)
static @NotNull SequenceBuilder	emptyBuilder(@NotNull BasedSequence base, int options)
static @NotNull SequenceBuilder	emptyBuilder(@NotNull BasedSequence base, int options, @NotNull SegmentOptimizer optimizer)
static @NotNull SequenceBuilder	emptyBuilder(@NotNull BasedSequence base, @NotNull SegmentOptimizer optimizer)
@NotNull BasedSequence	getBaseSequence()
@NotNull SequenceBuilder	getBuilder()
@Nullable Range	getLastRangeOrNull()
@NotNull BasedSegmentBuilder	getSegmentBuilder()
@Nullable BasedSequence	getSingleBasedSequence() NOTE: returns non-null value if the underlying ISegmentBuilder.getBaseSubSequenceRange() returns non-null value
int	length()
@NotNull BasedSequence	toSequence()
@NotNull BasedSequence	toSequence(@NotNull BasedSequence altSequence) Construct sequence from this builder using another based sequence which is character identical to this builder's baseSeq
@NotNull BasedSequence	toSequence(@NotNull BasedSequence altSequence, @Nullable com.vladsch.flexmark.util.misc.CharPredicate trimStart, @Nullable com.vladsch.flexmark.util.misc.CharPredicate ignoreCharDiff) Construct sequence from this builder using another based sequence which is character identical to this builder's baseSeq
@NotNull BasedSequence	toSequenceByIndex(@NotNull BasedSequence altSequence, @Nullable com.vladsch.flexmark.util.misc.CharPredicate trimStart, @Nullable com.vladsch.flexmark.util.misc.CharPredicate ignoreCharDiff) Construct sequence from this builder using another based sequence which is character identical to this builder's baseSeq by length
@NotNull String	toString()
@NotNull String	toStringNoAddedSpaces()
@NotNull String	toStringWithRanges()
@NotNull String	toStringWithRanges(boolean toVisibleWhiteSpace)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vladsch.flexmark.util.sequence.builder.ISequenceBuilder

add, addAll, append, append, append, isEmpty, isNotEmpty

Method Detail

getBaseSequence

@NotNull
public @NotNull BasedSequence getBaseSequence()

getSegmentBuilder

@NotNull
public @NotNull BasedSegmentBuilder getSegmentBuilder()

getLastRangeOrNull

@Nullable
public @Nullable Range getLastRangeOrNull()

getSingleBasedSequence

@Nullable
public @Nullable BasedSequence getSingleBasedSequence()

Description copied from interface: ISequenceBuilder

NOTE: returns non-null value if the underlying ISegmentBuilder.getBaseSubSequenceRange() returns non-null value

Specified by:

getSingleBasedSequence in interface ISequenceBuilder<SequenceBuilder,BasedSequence>

Returns:

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

getBuilder

@NotNull
public @NotNull SequenceBuilder getBuilder()

Specified by:

getBuilder in interface ISequenceBuilder<SequenceBuilder,BasedSequence>

charAt

public char charAt(int index)

Specified by:

charAt in interface ISequenceBuilder<SequenceBuilder,BasedSequence>

append

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

Specified by:

append in interface ISequenceBuilder<SequenceBuilder,BasedSequence>

Specified by:

append in interface Appendable

append

@NotNull
public @NotNull SequenceBuilder append(char c)

Specified by:

append in interface ISequenceBuilder<SequenceBuilder,BasedSequence>

Specified by:

append in interface Appendable

append

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

Specified by:

append in interface ISequenceBuilder<SequenceBuilder,BasedSequence>

append

@NotNull
public @NotNull SequenceBuilder append(int startOffset,
                                                int endOffset)

append

@NotNull
public @NotNull SequenceBuilder append(@NotNull
                                                @NotNull Range chars)

addRange

@NotNull
public @NotNull SequenceBuilder addRange(@NotNull
                                                  @NotNull Range range)

addByOffsets

@NotNull
public @NotNull SequenceBuilder addByOffsets(int startOffset,
                                                      int endOffset)

addByLength

@NotNull
public @NotNull SequenceBuilder addByLength(int startOffset,
                                                     int textLength)

toSequence

@NotNull
public @NotNull BasedSequence toSequence()

Specified by:

toSequence in interface ISequenceBuilder<SequenceBuilder,BasedSequence>

toSequence

@NotNull
public @NotNull BasedSequence toSequence(@NotNull
                                                  @NotNull BasedSequence altSequence)

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

Parameters:

altSequence - based sequence which is character identical to this builder's baseSeq

Returns:

builder with offsets mapped to altSequence

toSequence

@NotNull
public @NotNull BasedSequence toSequence(@NotNull
                                                  @NotNull BasedSequence altSequence,
                                                  @Nullable
                                                  @Nullable com.vladsch.flexmark.util.misc.CharPredicate trimStart,
                                                  @Nullable
                                                  @Nullable com.vladsch.flexmark.util.misc.CharPredicate ignoreCharDiff)

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

Parameters:

altSequence - based sequence which is character identical to this builder's baseSeq

trimStart - character set of characters to trim

ignoreCharDiff - chars which should be treated as equivalent for verification purposes (Space, Tab, EOL, usually)

Returns:

builder with offsets mapped to altSequence

toSequenceByIndex

@NotNull
public @NotNull BasedSequence toSequenceByIndex(@NotNull
                                                         @NotNull BasedSequence altSequence,
                                                         @Nullable
                                                         @Nullable com.vladsch.flexmark.util.misc.CharPredicate trimStart,
                                                         @Nullable
                                                         @Nullable com.vladsch.flexmark.util.misc.CharPredicate ignoreCharDiff)

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

Parameters:

altSequence - based sequence which is character identical to this builder's baseSeq

trimStart - character set of characters to trim

ignoreCharDiff - chars which should be treated as equivalent for verification purposes (Space, Tab, EOL, usually)

Returns:

builder with offsets mapped to altSequence

length

public int length()

Specified by:

length in interface ISequenceBuilder<SequenceBuilder,BasedSequence>

toStringWithRanges

@NotNull
public @NotNull String toStringWithRanges()

toStringWithRanges

@NotNull
public @NotNull String toStringWithRanges(boolean toVisibleWhiteSpace)

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

toStringNoAddedSpaces

@NotNull
public @NotNull String toStringNoAddedSpaces()

emptyBuilder

@NotNull
public static @NotNull SequenceBuilder emptyBuilder(@NotNull
                                                             @NotNull BasedSequence base)

emptyBuilder

@NotNull
public static @NotNull SequenceBuilder emptyBuilder(@NotNull
                                                             @NotNull BasedSequence base,
                                                             @NotNull
                                                             @NotNull SegmentOptimizer optimizer)

emptyBuilder

@NotNull
public static @NotNull SequenceBuilder emptyBuilder(@NotNull
                                                             @NotNull BasedSequence base,
                                                             int options)

emptyBuilder

@NotNull
public static @NotNull SequenceBuilder emptyBuilder(@NotNull
                                                             @NotNull BasedSequence base,
                                                             int options,
                                                             @NotNull
                                                             @NotNull SegmentOptimizer optimizer)