ISegmentBuilder (flexmark-java sequence utilities 0.62.2 API)

All Superinterfaces:

Iterable<Object>

All Known Subinterfaces:

IBasedSegmentBuilder<S>

All Known Implementing Classes:

BasedSegmentBuilder, PlainSegmentBuilder, SegmentBuilderBase
```
public interface ISegmentBuilder<S extends ISegmentBuilder<S>>
extends Iterable<Object>
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ISegmentBuilder.Options

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ISegmentBuilder.Options`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`F_DEFAULT`
`static int`	`F_INCLUDE_ANCHORS`
`static int`	`F_TRACK_FIRST256`
`static ISegmentBuilder.Options`	`O_INCLUDE_ANCHORS`
`static ISegmentBuilder.Options`	`O_TRACK_FIRST256`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`S`	`append(CharSequence text)`
`S`	`append(int startOffset, int endOffset)`
`S`	`append(@NotNull Range range)`
`S`	`appendAnchor(int offset)`
`@Nullable Range`	`getBaseSubSequenceRange()`
`int`	`getEndOffset()`
`int`	`getOptions()`
`@NotNull Iterable<Seg>`	`getSegments()` Return iterator over segments
`int`	`getSpan()`
`int`	`getStartOffset()`
`CharSequence`	`getText()`
`int`	`getTextFirst256Length()`
`int`	`getTextFirst256Segments()`
`int`	`getTextLength()`
`int`	`getTextSegments()`
`int`	`getTextSpaceLength()`
`int`	`getTextSpaceSegments()`
`boolean`	`haveOffsets()`
`boolean`	`isBaseSubSequenceRange()`
`boolean`	`isEmpty()`
`boolean`	`isIncludeAnchors()`
`boolean`	`isTrackTextFirst256()`
`@NotNull Iterator<Object>`	`iterator()` Return iterator over segment parts Range - BASE CharSequence - TEXT
`int`	`length()`
`int`	`noAnchorsSize()`
`int`	`size()`
`@NotNull String`	`toString(@NotNull CharSequence chars)`
`@NotNull String`	`toStringWithRanges(@NotNull CharSequence chars)`
`@NotNull String`	`toStringWithRangesVisibleWhitespace(@NotNull CharSequence chars)`

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Field Detail

O_INCLUDE_ANCHORS

static final ISegmentBuilder.Options O_INCLUDE_ANCHORS

O_TRACK_FIRST256

static final ISegmentBuilder.Options O_TRACK_FIRST256

F_INCLUDE_ANCHORS
```
static final int F_INCLUDE_ANCHORS
```

F_TRACK_FIRST256
```
static final int F_TRACK_FIRST256
```

F_DEFAULT
```
static final int F_DEFAULT
```

Method Detail

getOptions
```
int getOptions()
```

isIncludeAnchors
```
boolean isIncludeAnchors()
```

isEmpty
```
boolean isEmpty()
```

isBaseSubSequenceRange
```
boolean isBaseSubSequenceRange()
```

getBaseSubSequenceRange

@Nullable
@Nullable Range getBaseSubSequenceRange()

haveOffsets
```
boolean haveOffsets()
```

getSpan
```
int getSpan()
```

getStartOffset
```
int getStartOffset()
```

getEndOffset
```
int getEndOffset()
```

size
```
int size()
```

getText
```
CharSequence getText()
```

noAnchorsSize
```
int noAnchorsSize()
```

length
```
int length()
```

isTrackTextFirst256
```
boolean isTrackTextFirst256()
```

getTextLength
```
int getTextLength()
```

getTextSegments
```
int getTextSegments()
```

getTextSpaceLength
```
int getTextSpaceLength()
```

getTextSpaceSegments
```
int getTextSpaceSegments()
```

getTextFirst256Length
```
int getTextFirst256Length()
```

getTextFirst256Segments
```
int getTextFirst256Segments()
```

iterator
```
@NotNull
@NotNull Iterator<Object> iterator()
```
Return iterator over segment parts Range - BASE CharSequence - TEXT

Specified by:

iterator in interface Iterable<Object>

Returns:

iterator over segment builder parts

getSegments
```
@NotNull
@NotNull Iterable<Seg> getSegments()
```
Return iterator over segments

Returns:

iterator over segment builder segments

append

@NotNull
S append(int startOffset,
                  int endOffset)

append
```
@NotNull
S append(CharSequence text)
```

appendAnchor
```
@NotNull
S appendAnchor(int offset)
```

append

@NotNull
S append(@NotNull
                  @NotNull Range range)

toStringWithRangesVisibleWhitespace

@NotNull
@NotNull String toStringWithRangesVisibleWhitespace(@NotNull
                                                             @NotNull CharSequence chars)

toStringWithRanges

@NotNull
@NotNull String toStringWithRanges(@NotNull
                                            @NotNull CharSequence chars)

toString

@NotNull
@NotNull String toString(@NotNull
                                  @NotNull CharSequence chars)

Interface ISegmentBuilder<S extends ISegmentBuilder<S>>

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Field Detail

O_INCLUDE_ANCHORS

O_TRACK_FIRST256

F_INCLUDE_ANCHORS

F_TRACK_FIRST256

F_DEFAULT

Method Detail

getOptions

isIncludeAnchors

isEmpty

isBaseSubSequenceRange

getBaseSubSequenceRange

haveOffsets

getSpan

getStartOffset

getEndOffset

size

getText

noAnchorsSize

length

isTrackTextFirst256

getTextLength

getTextSegments

getTextSpaceLength

getTextSpaceSegments

getTextFirst256Length

getTextFirst256Segments

iterator

getSegments

append

append

appendAnchor

append

toStringWithRangesVisibleWhitespace

toStringWithRanges

toString