Interface LineAppendable
- All Superinterfaces:
Appendable
,Iterable<LineInfo>
- All Known Subinterfaces:
HtmlAppendable
- All Known Implementing Classes:
HtmlAppendableBase
,HtmlBuilder
,HtmlMarkdownWriter
,HtmlWriter
,LineAppendableImpl
,MarkdownWriter
,MarkdownWriterBase
control output of new lines limiting them to terminate text but not create blank lines, and control number of blank lines output, eliminate spaces before and after an \n, except in prefixes and indents controlled by this class.
allows appending unmodified text in preformatted regions created by openPreFormatted(boolean)
and closePreFormatted()
consecutive \n in the data are going go be collapsed to a single \n. To get blank lines use blankLine()
or blankLine(int)
tab is converted to spaces if F_CONVERT_TABS
or F_COLLAPSE_WHITESPACE
option is selected
spaces before and after \n are removed controlled by F_TRIM_TRAILING_WHITESPACE
and F_TRIM_LEADING_WHITESPACE
use line()
, lineIf(boolean)
, blankLine()
as an alternative to appending \n.
use blankLineIf(boolean)
and blankLine(int)
for appending blank lines.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Deprecated.ALLOW_LEADING_EOL is now inverted and named F_TRIM_LEADING_EOLstatic final int
Deprecated.ALLOW_LEADING_WHITESPACE is now inverted and named F_TRIM_LEADING_WHITESPACEstatic final int
Deprecated.static final int
Deprecated.static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Deprecated.static final LineAppendable.Options
static final LineAppendable.Options
static final BitFieldSet
<LineAppendable.Options> static final LineAppendable.Options
static final LineAppendable.Options
static final LineAppendable.Options
static final LineAppendable.Options
static final LineAppendable.Options
static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated. -
Method Summary
Modifier and TypeMethodDescription@NotNull LineAppendable
addIndentOnFirstEOL
(@NotNull Runnable listener) Add an indent on first EOL appended and run runnabledefault @NotNull LineAppendable
addOptions
(int flags) default @NotNull LineAppendable
addPrefix
(@NotNull CharSequence prefix) Add to prefix appended after a new line character for every line and after a new line in pre-formatted sections@NotNull LineAppendable
addPrefix
(@NotNull CharSequence prefix, boolean afterEol) Add to prefix appended after a new line character for every line and after a new line in pre-formatted sections@NotNull LineAppendable
append
(char c) @NotNull LineAppendable
append
(char c, int count) default @NotNull LineAppendable
append
(@NotNull LineAppendable lineAppendable) Append lines from another line formatting appendable.default @NotNull LineAppendable
append
(@NotNull LineAppendable lineAppendable, boolean withPrefixes) Append lines from another line formatting appendable.@NotNull LineAppendable
append
(@NotNull LineAppendable lineAppendable, int startLine, int endLine, boolean withPrefixes) Append lines from another line formatting appendable.@NotNull LineAppendable
append
(@NotNull CharSequence csq) @NotNull LineAppendable
append
(@NotNull CharSequence csq, int start, int end) default @NotNull LineAppendable
appendAll
(@NotNull Iterable<CharSequence> sequences) default <T extends Appendable>
TappendTo
(T out) append lines to appendable with 0 blank lines, if these are desired at the end of the output useappendTo(Appendable, int, int)
.<T extends Appendable>
TappendTo
(T out, boolean withPrefixes, int maxBlankLines, int maxTrailingBlankLines, int startLine, int endLine) append lines to appendable with given maximum trailing blank lines and given prefix to add to all linesdefault <T extends Appendable>
TappendTo
(T out, int maxTrailingBlankLines) Deprecated.default <T extends Appendable>
TappendTo
(T out, int maxBlankLines, int maxTrailingBlankLines) default <T extends Appendable>
TappendTo
(T out, int maxBlankLines, int maxTrailingBlankLines, int startLine, int endLine) default <T extends Appendable>
TappendToSilently
(T out) default <T extends Appendable>
TappendToSilently
(T out, boolean withPrefixes, int maxBlankLines, int maxTrailingBlankLines, int startLine, int endLine) default <T extends Appendable>
TappendToSilently
(T out, int maxBlankLines, int maxTrailingBlankLines) default <T extends Appendable>
TappendToSilently
(T out, int maxBlankLines, int maxTrailingBlankLines, int startLine, int endLine) @NotNull LineAppendable
Add a blank line, if there is not one already appended.@NotNull LineAppendable
blankLine
(int count) Add a blank lines, if there isn't already given number of blank lines appended.@NotNull LineAppendable
blankLineIf
(boolean predicate) Add a blank line, if predicate is true and there isn't already blank lines appended.@NotNull LineAppendable
changeOptions
(int addFlags, int removeFlags) default @NotNull LineAppendable
@NotNull LineAppendable
Close preformatted section and suspend content modificationint
column()
Get column offset after last appendstatic CharSequence
combinedPrefix
(@Nullable CharSequence prefix, @Nullable CharSequence suffix) default @NotNull LineAppendable
default @NotNull LineAppendable
copyAppendable
(boolean withPrefixes) default @NotNull LineAppendable
copyAppendable
(int startLine) default @NotNull LineAppendable
copyAppendable
(int startLine, int endLine) default @NotNull LineAppendable
copyAppendable
(int startLine, int endLine, boolean withPrefixes) Make a copy of this appendable with the given line rangeboolean
default @NotNull LineInfo
get
(int lineIndex) Kotlin index operatorint
Get pending prefix after EOL@NotNull BasedSequence
Get prefix used before EOL@NotNull ISequenceBuilder
<?, ?> Get builder used for accumulation@NotNull LineAppendable
@NotNull BasedSequence
Get prefix appended after a new line character for every indent level@NotNull BasedSequence
getLine
(int lineIndex) Get Line at given line indexdefault @NotNull BasedSequence
getLineContent
(int lineIndex) Get Line content of given lineint
Get the number of lines appended, not including any unterminated onesint
Get the number of lines appended, including any unterminated ones@NotNull LineInfo
getLineInfo
(int lineIndex) Get Line information at given line indexdefault @NotNull BasedSequence
getLinePrefix
(int lineIndex) Get prefix of given linedefault @NotNull Iterable
<BasedSequence> getLines()
default @NotNull Iterable
<BasedSequence> getLines
(boolean withPrefixes) default @NotNull Iterable
<BasedSequence> getLines
(int maxTrailingBlankLines) default @NotNull Iterable
<BasedSequence> getLines
(int maxTrailingBlankLines, boolean withPrefixes) @NotNull Iterable
<BasedSequence> getLines
(int maxTrailingBlankLines, int startLine, int endLine, boolean withPrefixes) Full line iterator over some linesgetLinesInfo
(int maxTrailingBlankLines) getLinesInfo
(int maxTrailingBlankLines, int startLine, int endLine) Full line iterator with line infodefault int
Get current options as bit mask flags@NotNull BitFieldSet
<LineAppendable.Options> Get current options as set which can be used to modify optionsint
Get number of EOLs at end of appendable, this is actually number of tail blank linesint
Get number of spaces at end of pending text@NotNull BasedSequence
Get prefix being applied to all lines, even in pre-formatted sections This is the prefix that will be set after EOLdefault int
int
getTrailingBlankLines
(int endLine) Get trailing blank line count ending on given line@NotNull LineAppendable
indent()
Increase the indent level, will terminate the current line if there is unterminated textvoid
insertLine
(int lineIndex, @NotNull CharSequence prefix, @NotNull CharSequence text) Insert a line at the index with given content and prefix for a linedefault boolean
isEmpty()
Kotlin compatibilitydefault boolean
Kotlin compatibilityboolean
Test if trailing text ends in space or tabboolean
iterator()
Full line iterator NOTE: will not issue line() to terminate any unterminated lines before iteration and will not include unterminated lines in iteration@NotNull LineAppendable
line()
Add a new line if there was any unterminated text appended or if this is a preformatted region@NotNull LineAppendable
lineIf
(boolean predicate) Add a new line, if predicate is true and line() would add an EOL.@NotNull LineAppendable
lineOnFirstText
(boolean value) @NotNull LineAppendable
lineWithTrailingSpaces
(int count) Add a new line, keep trailing spaces if there was any unterminated text appendeddefault @NotNull LineAppendable
default @NotNull LineAppendable
int
offset()
Get text offset of all output lines, excluding any text for the last line being accumulatedint
Get offset after last append as if EOL was added but without the EOL itself@NotNull LineAppendable
openPreFormatted
(boolean addPrefixToFirstLine) Open preformatted section and suspend content modification@NotNull LineAppendable
default @NotNull LineAppendable
Pop a prefix from the stack and set the current prefix@NotNull LineAppendable
popPrefix
(boolean afterEol) Pop a prefix from the stack and set the current prefixdefault @NotNull LineAppendable
@NotNull LineAppendable
@NotNull LineAppendable
Save the current prefix on the stackdefault LineAppendable
removeExtraBlankLines
(int maxBlankLines, int maxTrailingBlankLines) removeExtraBlankLines
(int maxBlankLines, int maxTrailingBlankLines, int startLine, int endLine) Normalize the appendable by removing extra blank lines in the body or at the end of given line range@NotNull LineAppendable
removeIndentOnFirstEOL
(@NotNull Runnable listener) Remove runnable, has no effect if EOL was already appended and runnable was run@NotNull LineAppendable
removeLines
(int startLine, int endLine) default @NotNull LineAppendable
removeOptions
(int flags) @NotNull LineAppendable
setIndentPrefix
(@Nullable CharSequence prefix) Set prefix to append after a new line character for every indent levelvoid
setLine
(int lineIndex, @NotNull CharSequence prefix, @NotNull CharSequence text) Set content and prefix for a linedefault @NotNull LineAppendable
default @NotNull LineAppendable
setOptions
(int flags) Set options on processing textdefault @NotNull LineAppendable
setOptions
(BitFieldSet<LineAppendable.Options> options) Set options on processing textdefault @NotNull LineAppendable
setOptions
(LineAppendable.Options... options) default @NotNull LineAppendable
setPrefix
(@NotNull CharSequence prefix) Set prefix appended after a new line character for every line and after a new line in pre-formatted sections@NotNull LineAppendable
setPrefix
(@Nullable CharSequence prefix, boolean afterEol) Set prefix appended after a new line character for every line and after a new line in pre-formatted sectionsvoid
setPrefixLength
(int lineIndex, int prefixLength) Change prefix length for a given line without changing the line contentstatic BitFieldSet
<LineAppendable.Options> toOptionSet
(int options) static BitFieldSet
<LineAppendable.Options> toOptionSet
(LineAppendable.Options... options) default @NotNull CharSequence
default @NotNull CharSequence
toSequence
(boolean withPrefixes) default @NotNull CharSequence
toSequence
(int maxBlankLines, boolean withPrefixes) default @NotNull CharSequence
toSequence
(int maxBlankLines, int maxTrailingBlankLines) @NotNull CharSequence
toSequence
(int maxBlankLines, int maxTrailingBlankLines, boolean withPrefixes) get the resulting text for all linesdefault @NotNull String
toString
(boolean withPrefixes) default @NotNull String
toString
(int maxBlankLines) get the resulting text for all linesdefault @NotNull String
toString
(int maxBlankLines, boolean withPrefixes) default @NotNull String
toString
(int maxBlankLines, int maxTrailingBlankLines) @NotNull String
toString
(int maxBlankLines, int maxTrailingBlankLines, boolean withPrefixes) get the resulting text for all linesdefault @NotNull LineAppendable
@NotNull LineAppendable
unIndent()
Decrease the indent level, min level is 0, will terminate the current line if there is unterminated text@NotNull LineAppendable
Decrease the indent level, if there is unterminated text then unindented prefix is to be applied after the next EOL.Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Field Details
-
O_CONVERT_TABS
-
O_COLLAPSE_WHITESPACE
-
O_TRIM_TRAILING_WHITESPACE
-
O_PASS_THROUGH
-
O_TRIM_LEADING_WHITESPACE
-
O_TRIM_LEADING_EOL
-
O_PREFIX_PRE_FORMATTED
-
O_FORMAT_ALL
-
F_CONVERT_TABS
static final int F_CONVERT_TABS -
F_COLLAPSE_WHITESPACE
static final int F_COLLAPSE_WHITESPACE -
F_TRIM_TRAILING_WHITESPACE
static final int F_TRIM_TRAILING_WHITESPACE -
F_PASS_THROUGH
static final int F_PASS_THROUGH -
F_TRIM_LEADING_WHITESPACE
static final int F_TRIM_LEADING_WHITESPACE -
F_TRIM_LEADING_EOL
static final int F_TRIM_LEADING_EOL -
F_PREFIX_PRE_FORMATTED
static final int F_PREFIX_PRE_FORMATTED -
F_FORMAT_ALL
static final int F_FORMAT_ALL -
F_WHITESPACE_REMOVAL
static final int F_WHITESPACE_REMOVAL -
CONVERT_TABS
Deprecated. -
COLLAPSE_WHITESPACE
Deprecated. -
TRIM_TRAILING_WHITESPACE
Deprecated. -
PASS_THROUGH
Deprecated. -
ALLOW_LEADING_WHITESPACE
Deprecated.ALLOW_LEADING_WHITESPACE is now inverted and named F_TRIM_LEADING_WHITESPACE- See Also:
-
TRIM_LEADING_WHITESPACE
Deprecated. -
ALLOW_LEADING_EOL
Deprecated.ALLOW_LEADING_EOL is now inverted and named F_TRIM_LEADING_EOL- See Also:
-
PREFIX_PRE_FORMATTED
Deprecated. -
FORMAT_ALL
Deprecated.
-
-
Method Details
-
toOptionSet
-
toOptionSet
-
getOptions
default int getOptions()Get current options as bit mask flags- Returns:
- option flags
-
getEmptyAppendable
-
copyAppendable
@NotNull default @NotNull LineAppendable copyAppendable(int startLine, int endLine, boolean withPrefixes) Make a copy of this appendable with the given line range- Parameters:
startLine
- start lineendLine
- end linewithPrefixes
- true if to include prefixes- Returns:
- copy of appendable with requested content
-
copyAppendable
-
copyAppendable
-
copyAppendable
-
copyAppendable
-
getOptionSet
Get current options as set which can be used to modify options- Returns:
- mutable option set
-
pushOptions
-
popOptions
-
noTrimLeading
-
trimLeading
-
preserveSpaces
-
noPreserveSpaces
-
removeOptions
-
addOptions
-
changeOptions
-
setOptions
Set options on processing text- Parameters:
flags
- option flags- Returns:
- this
-
setOptions
-
setOptions
Set options on processing text- Parameters:
options
- option set- Returns:
- this
-
getBuilder
Get builder used for accumulation- Returns:
- builder used for accumulation
-
getTrailingBlankLines
int getTrailingBlankLines(int endLine) Get trailing blank line count ending on given line- Parameters:
endLine
- end line- Returns:
- number of trailing blank lines
-
getTrailingBlankLines
default int getTrailingBlankLines() -
endsWithEOL
boolean endsWithEOL()- Returns:
- true if not empty and have no unterminated lines
-
append
- Specified by:
append
in interfaceAppendable
-
append
- Specified by:
append
in interfaceAppendable
-
append
- Specified by:
append
in interfaceAppendable
-
append
-
appendAll
@NotNull default @NotNull LineAppendable appendAll(@NotNull @NotNull Iterable<CharSequence> sequences) -
append
@NotNull @NotNull LineAppendable append(@NotNull @NotNull LineAppendable lineAppendable, int startLine, int endLine, boolean withPrefixes) Append lines from another line formatting appendable.NOTE: does not apply formatting options. Instead, appends already formatted lines as is
If there is an accumulating line, it will be terminated by an EOL before appending lines
- Parameters:
lineAppendable
- lines to append, any unterminated lines will be terminated by aline()
invocation.startLine
- start line to appendendLine
- end line to append, endLine is excluded.withPrefixes
- true if to include prefixes from the lineAppendable.- Returns:
- this
-
append
Append lines from another line formatting appendable.NOTE: does not apply formatting options other than prefix. Line text is used as is.
If there is an unterminated line its contents will be used as leading text of the first appended line
- Parameters:
lineAppendable
- lines to append- Returns:
- this
-
append
@NotNull default @NotNull LineAppendable append(@NotNull @NotNull LineAppendable lineAppendable, boolean withPrefixes) Append lines from another line formatting appendable.NOTE: does not apply formatting options other than prefix. Line text is used as is.
If there is an unterminated line its contents will be used as leading text of the first appended line
- Parameters:
lineAppendable
- lines to appendwithPrefixes
- true if to include prefixes from the lineAppendable.- Returns:
- this
-
line
Add a new line if there was any unterminated text appended or if this is a preformatted region- Returns:
- this
-
lineWithTrailingSpaces
Add a new line, keep trailing spaces if there was any unterminated text appendedNOTE: only applies in preformatted region or if the line is not empty
- Parameters:
count
- number of trailing spaces to add- Returns:
- this
-
lineIf
Add a new line, if predicate is true and line() would add an EOL.- Parameters:
predicate
- callline()
if value is true.- Returns:
- this
-
blankLine
Add a blank line, if there is not one already appended.- Returns:
- this
-
blankLineIf
Add a blank line, if predicate is true and there isn't already blank lines appended.- Parameters:
predicate
- when true append blank line- Returns:
- this
-
blankLine
Add a blank lines, if there isn't already given number of blank lines appended. Will append only enough blank lines to increase it to given level. If more are already in the wings then nothing is done.- Parameters:
count
- number of blank lines to append- Returns:
- this
-
isPreFormatted
boolean isPreFormatted()- Returns:
- true if in pre-formatted region
-
openPreFormatted
Open preformatted section and suspend content modification- Parameters:
addPrefixToFirstLine
- if true will add the current prefix to first line- Returns:
- this
-
closePreFormatted
Close preformatted section and suspend content modification- Returns:
- this
-
indent
Increase the indent level, will terminate the current line if there is unterminated textNOTE: this is equivalent to pushPrefix(), addPrefix(getIndentPrefix()) but adds a flag to validate that
unIndent()
is called only on prefixes added by this method- Returns:
- this
-
unIndent
Decrease the indent level, min level is 0, will terminate the current line if there is unterminated textNOTE: this is equivalent to popPrefix() but with validation that it is called only on prefixes added by
indent()
- Returns:
- this
-
unIndentNoEol
Decrease the indent level, if there is unterminated text then unindented prefix is to be applied after the next EOL.Will NOT terminate the current line if there is unterminated text
NOTE: should be used with
addIndentOnFirstEOL(Runnable)
if callback is invoked- Returns:
- this
-
getIndentPrefix
Get prefix appended after a new line character for every indent level- Returns:
- char sequence of the current indent prefix used for each indent level
-
setIndentPrefix
Set prefix to append after a new line character for every indent level- Parameters:
prefix
- prefix characters for new lines appended after this is set- Returns:
- this
-
getPrefix
Get prefix being applied to all lines, even in pre-formatted sections This is the prefix that will be set after EOL- Returns:
- char sequence of the current prefix
-
getBeforeEolPrefix
Get prefix used before EOL- Returns:
- char sequence of the current prefix
-
addPrefix
Add to prefix appended after a new line character for every line and after a new line in pre-formatted sectionsThis appends the sequence to current prefix
- Parameters:
prefix
- prefix characters to add to current prefix for new lines appended after this is setafterEol
- if true prefix will take effect after EOL- Returns:
- this
-
setPrefix
@NotNull @NotNull LineAppendable setPrefix(@Nullable @Nullable CharSequence prefix, boolean afterEol) Set prefix appended after a new line character for every line and after a new line in pre-formatted sectionsThis appends the sequence to current prefix
- Parameters:
prefix
- prefix characters to add to current prefix for new lines appended after this is setafterEol
- if true prefix will take effect after EOL- Returns:
- this
-
addPrefix
Add to prefix appended after a new line character for every line and after a new line in pre-formatted sectionsThis appends the sequence to current prefix
- Parameters:
prefix
- prefix characters to add to current prefix for new lines appended after this is set- Returns:
- this
-
setPrefix
Set prefix appended after a new line character for every line and after a new line in pre-formatted sectionsThis appends the sequence to current prefix
- Parameters:
prefix
- prefix characters to add to current prefix for new lines appended after this is set- Returns:
- this
-
pushPrefix
Save the current prefix on the stack- Returns:
- this
-
popPrefix
Pop a prefix from the stack and set the current prefix- Parameters:
afterEol
- if true prefix will take effect after EOL- Returns:
- this
-
popPrefix
Pop a prefix from the stack and set the current prefix- Returns:
- this
-
getAfterEolPrefixDelta
int getAfterEolPrefixDelta()Get pending prefix after EOL- Returns:
- change in prefix length after next eol
-
column
int column()Get column offset after last append- Returns:
- column offset after last append
-
offset
int offset()Get text offset of all output lines, excluding any text for the last line being accumulated- Returns:
- offset of text as would be returned for all
-
offsetWithPending
int offsetWithPending()Get offset after last append as if EOL was added but without the EOL itself- Returns:
- offset as would be returned by
offset()
after line() call less 1 for EOL
-
isPendingSpace
boolean isPendingSpace()Test if trailing text ends in space or tab- Returns:
- true if ending in space or tab
-
getPendingSpace
int getPendingSpace()Get number of spaces at end of pending text- Returns:
- number of eols at end of text
-
getPendingEOL
int getPendingEOL()Get number of EOLs at end of appendable, this is actually number of tail blank lines- Returns:
- number of eols at end of text
-
lineOnFirstText
-
setLineOnFirstText
-
clearLineOnFirstText
-
addIndentOnFirstEOL
Add an indent on first EOL appended and run runnable- Parameters:
listener
- runnable to run if adding indent on first EOL- Returns:
- this
-
removeIndentOnFirstEOL
Remove runnable, has no effect if EOL was already appended and runnable was run- Parameters:
listener
- runnable added with addIndentOnFirstEOL- Returns:
- this
-
getLineCount
int getLineCount()Get the number of lines appended, not including any unterminated ones- Returns:
- number of full lines appended
-
isEmpty
default boolean isEmpty()Kotlin compatibility- Returns:
- true if have no terminated lines
-
isNotEmpty
default boolean isNotEmpty()Kotlin compatibility- Returns:
- true if have terminated lines
-
getLineCountWithPending
int getLineCountWithPending()Get the number of lines appended, including any unterminated onesNOTE: if there is an unterminated line it will be available as the last line, without being terminated explicitly
- Returns:
- number of lines appended
-
getLineInfo
Get Line information at given line indexNOTE: if there is an unterminated line it will be available as the last line, without being terminated explicitly
- Parameters:
lineIndex
- line index for the info to get- Returns:
- line info
-
get
Kotlin index operator- Parameters:
lineIndex
- line index- Returns:
- line info
-
getLine
Get Line at given line indexNOTE: if there is an unterminated line it will be available as the last line, without being terminated explicitly
- Parameters:
lineIndex
- line index- Returns:
- line char sequence
-
iterator
Full line iterator NOTE: will not issue line() to terminate any unterminated lines before iteration and will not include unterminated lines in iteration -
getLines
@NotNull @NotNull Iterable<BasedSequence> getLines(int maxTrailingBlankLines, int startLine, int endLine, boolean withPrefixes) Full line iterator over some linesNOTE: will issue line() to terminate any unterminated lines before iteration
- Parameters:
maxTrailingBlankLines
- maximum trailing blank lines, -1 if trailing EOL should be removedstartLine
- start line indexendLine
- end line index, exclusivewithPrefixes
- true if prefixes should be included, else only non-prefix line text- Returns:
- iterator over lines
-
getLines
-
getLines
-
getLines
@NotNull default @NotNull Iterable<BasedSequence> getLines(int maxTrailingBlankLines, boolean withPrefixes) -
getLines
-
getLinesInfo
@NotNull @NotNull Iterable<LineInfo> getLinesInfo(int maxTrailingBlankLines, int startLine, int endLine) Full line iterator with line infoNOTE: will issue line() to terminate any unterminated lines before iteration
- Parameters:
maxTrailingBlankLines
- maximum trailing blank lines, -1 if trailing EOL should be removedstartLine
- start line indexendLine
- end line index, exclusive- Returns:
- iterator over lines
-
getLinesInfo
-
getLinesInfo
-
getLineContent
Get Line content of given line- Parameters:
lineIndex
- line index- Returns:
- char sequence for the line
-
getLinePrefix
Get prefix of given line- Parameters:
lineIndex
- line index- Returns:
- line prefix char sequence
-
setPrefixLength
void setPrefixLength(int lineIndex, int prefixLength) Change prefix length for a given line without changing the line content- Parameters:
lineIndex
- index of the lineprefixLength
- new prefix length
-
setLine
void setLine(int lineIndex, @NotNull @NotNull CharSequence prefix, @NotNull @NotNull CharSequence text) Set content and prefix for a line- Parameters:
lineIndex
- index of the lineprefix
- prefix of the linetext
- content text of the line
-
insertLine
void insertLine(int lineIndex, @NotNull @NotNull CharSequence prefix, @NotNull @NotNull CharSequence text) Insert a line at the index with given content and prefix for a line- Parameters:
lineIndex
- index of the lineprefix
- prefix of the linetext
- content text of the line
-
removeLines
-
toString
@NotNull @NotNull String toString(int maxBlankLines, int maxTrailingBlankLines, boolean withPrefixes) get the resulting text for all lines- Parameters:
maxBlankLines
- maximum blank lines to allow in the textmaxTrailingBlankLines
- maximum trailing blank lineswithPrefixes
- true if to include prefixes- Returns:
- resulting text
-
toString
-
toString
-
toString
-
toString
get the resulting text for all lines- Parameters:
maxBlankLines
- maximum blank lines to allow, if -1 then no trailing EOL will be generated- Returns:
- resulting text
-
toSequence
@NotNull @NotNull CharSequence toSequence(int maxBlankLines, int maxTrailingBlankLines, boolean withPrefixes) get the resulting text for all lines- Parameters:
maxBlankLines
- maximum blank lines to allow in the textmaxTrailingBlankLines
- maximum trailing blank lineswithPrefixes
- true if to include prefixes- Returns:
- resulting text
-
toSequence
-
toSequence
-
toSequence
-
toSequence
-
appendTo
@Deprecated default <T extends Appendable> T appendTo(@NotNull T out, int maxTrailingBlankLines) throws IOException Deprecated.- Throws:
IOException
-
appendTo
<T extends Appendable> T appendTo(@NotNull T out, boolean withPrefixes, int maxBlankLines, int maxTrailingBlankLines, int startLine, int endLine) throws IOException append lines to appendable with given maximum trailing blank lines and given prefix to add to all linesNOTE:
- Type Parameters:
T
- type of out- Parameters:
out
- appendable to output the resulting lineswithPrefixes
- true if to include prefixesmaxBlankLines
- maximum blank lines to allow in the body,maxTrailingBlankLines
- maximum trailing blank lines at the end, if <maxBlankLines then maxBlankLines will be used, if -1 then no trailing EOL will be addedstartLine
- line from which to start outputendLine
- line at which to stop output- Returns:
- out
- Throws:
IOException
- if thrown by appendable
-
appendTo
default <T extends Appendable> T appendTo(@NotNull T out, int maxBlankLines, int maxTrailingBlankLines, int startLine, int endLine) throws IOException - Throws:
IOException
-
appendTo
default <T extends Appendable> T appendTo(@NotNull T out, int maxBlankLines, int maxTrailingBlankLines) throws IOException - Throws:
IOException
-
appendTo
append lines to appendable with 0 blank lines, if these are desired at the end of the output useappendTo(Appendable, int, int)
.- Type Parameters:
T
- type of out- Parameters:
out
- appendable to output the resulting lines- Returns:
- out
- Throws:
IOException
- thrown byout
.
-
appendToSilently
default <T extends Appendable> T appendToSilently(@NotNull T out, boolean withPrefixes, int maxBlankLines, int maxTrailingBlankLines, int startLine, int endLine) -
appendToSilently
default <T extends Appendable> T appendToSilently(@NotNull T out, int maxBlankLines, int maxTrailingBlankLines, int startLine, int endLine) -
appendToSilently
default <T extends Appendable> T appendToSilently(@NotNull T out, int maxBlankLines, int maxTrailingBlankLines) -
appendToSilently
-
removeExtraBlankLines
LineAppendable removeExtraBlankLines(int maxBlankLines, int maxTrailingBlankLines, int startLine, int endLine) Normalize the appendable by removing extra blank lines in the body or at the end of given line range- Parameters:
maxBlankLines
- maximum blank lines to allow in the bodymaxTrailingBlankLines
- maximum trailing blank lines ending on endLine, if <maxBlankLines then maxBlankLines will be usedstartLine
- line from which to start outputendLine
- line at which to stop output- Returns:
- this
-
removeExtraBlankLines
-
combinedPrefix
static CharSequence combinedPrefix(@Nullable @Nullable CharSequence prefix, @Nullable @Nullable CharSequence suffix)
-