Package com.vladsch.flexmark.util.html

Class HtmlAppendableBase<T extends HtmlAppendableBase<T>>

java.lang.Object

com.vladsch.flexmark.util.html.HtmlAppendableBase<T>

All Implemented Interfaces:

HtmlAppendable, LineAppendable, java.lang.Appendable, java.lang.Iterable<LineInfo>

Direct Known Subclasses:

HtmlBuilder, HtmlWriter

public class HtmlAppendableBase<T extends HtmlAppendableBase<T>>
extends java.lang.Object
implements HtmlAppendable

Nested Class Summary

Nested classes/interfaces inherited from interface com.vladsch.flexmark.util.sequence.LineAppendable

LineAppendable.Options

Field Summary

Fields

Modifier and Type	Field	Description
private LineAppendable	appendable
private @Nullable MutableAttributes	currentAttributes
private boolean	indentOnFirstEol
private boolean	lineOnChildText
private @NotNull java.util.Stack<java.lang.String>	openTags
private boolean	suppressCloseTagLine
private boolean	suppressOpenTagLine
private boolean	withAttributes

Fields inherited from interface com.vladsch.flexmark.util.sequence.LineAppendable

ALLOW_LEADING_EOL, ALLOW_LEADING_WHITESPACE, COLLAPSE_WHITESPACE, CONVERT_TABS, F_COLLAPSE_WHITESPACE, F_CONVERT_TABS, F_FORMAT_ALL, F_PASS_THROUGH, F_PREFIX_PRE_FORMATTED, F_TRIM_LEADING_EOL, F_TRIM_LEADING_WHITESPACE, F_TRIM_TRAILING_WHITESPACE, F_WHITESPACE_REMOVAL, FORMAT_ALL, O_COLLAPSE_WHITESPACE, O_CONVERT_TABS, O_FORMAT_ALL, O_PASS_THROUGH, O_PREFIX_PRE_FORMATTED, O_TRIM_LEADING_EOL, O_TRIM_LEADING_WHITESPACE, O_TRIM_TRAILING_WHITESPACE, PASS_THROUGH, PREFIX_PRE_FORMATTED, TRIM_LEADING_WHITESPACE, TRIM_TRAILING_WHITESPACE

Constructor Summary

Constructors

Constructor	Description
HtmlAppendableBase(int indentSize, int formatOptions)
HtmlAppendableBase(@Nullable java.lang.Appendable other, int indentSize, int formatOptions)
HtmlAppendableBase(LineAppendable other, boolean inheritIndent)

Method Summary

Modifier and Type	Method	Description
T	addIndentOnFirstEOL(@NotNull java.lang.Runnable listener)	Add an indent on first EOL appended and run runnable
T	addPrefix(@NotNull java.lang.CharSequence prefix)	Add to prefix appended after a new line character for every line and after a new line in pre-formatted sections
T	addPrefix(@NotNull java.lang.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
T	append(char c)
T	append(char c, int count)
T	append(@NotNull LineAppendable lines, int startLine, int endLine, boolean withPrefixes)	Append lines from another line formatting appendable.
T	append(@NotNull java.lang.CharSequence csq)
T	append(@NotNull java.lang.CharSequence csq, int start, int end)
<T extends java.lang.Appendable> T	appendTo(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 lines
T	attr(@NotNull Attribute... attribute)
T	attr(@NotNull Attributes attributes)
T	attr(@NotNull java.lang.CharSequence attrName, @NotNull java.lang.CharSequence value)
T	blankLine()	Add a blank line, if there is not one already appended.
T	blankLine(int count)	Add a blank lines, if there isn't already given number of blank lines appended.
T	blankLineIf(boolean predicate)	Add a blank line, if predicate is true and there isn't already blank lines appended.
T	changeOptions(int addFlags, int removeFlags)
T	closePre()
T	closePreFormatted()	Close preformatted section and suspend content modification
T	closeTag(@NotNull java.lang.CharSequence tagName)
int	column()	Get column offset after last append
boolean	endsWithEOL()
int	getAfterEolPrefixDelta()	Get pending prefix after EOL
Attributes	getAttributes()
@NotNull BasedSequence	getBeforeEolPrefix()	Get prefix used before EOL
@NotNull ISequenceBuilder<?,?>	getBuilder()	Get builder used for accumulation
@NotNull HtmlAppendable	getEmptyAppendable()
@NotNull BasedSequence	getIndentPrefix()	Get prefix appended after a new line character for every indent level
@NotNull BasedSequence	getLine(int lineIndex)	Get Line at given line index
int	getLineCount()	Get the number of lines appended, not including any unterminated ones
int	getLineCountWithPending()	Get the number of lines appended, including any unterminated ones
@NotNull LineInfo	getLineInfo(int lineIndex)	Get Line information at given line index
@NotNull java.lang.Iterable<BasedSequence>	getLines(int maxTrailingBlankLines, int startLine, int endLine, boolean withPrefixes)	Full line iterator over some lines
@NotNull java.lang.Iterable<LineInfo>	getLinesInfo(int maxTrailingBlankLines, int startLine, int endLine)	Full line iterator with line info
@NotNull java.util.Stack<java.lang.String>	getOpenTags()
@NotNull java.util.List<java.lang.String>	getOpenTagsAfterLast(@NotNull java.lang.CharSequence latestTag)
protected java.lang.String	getOpenTagText()
int	getOptions()	Get current options as bit mask flags
@NotNull BitFieldSet<LineAppendable.Options>	getOptionSet()	Get current options as set which can be used to modify options
int	getPendingEOL()	Get number of EOLs at end of appendable, this is actually number of tail blank lines
int	getPendingSpace()	Get number of spaces at end of pending text
@NotNull BasedSequence	getPrefix()	Get prefix being applied to all lines, even in pre-formatted sections This is the prefix that will be set after EOL
int	getTrailingBlankLines(int endLine)	Get trailing blank line count ending on given line
private boolean	haveOptions(int options)
T	indent()	Increase the indent level, will terminate the current line if there is unterminated text
boolean	inPre()
void	insertLine(int lineIndex, @NotNull java.lang.CharSequence prefix, @NotNull java.lang.CharSequence text)	Insert a line at the index with given content and prefix for a line
boolean	isPendingSpace()	Test if trailing text ends in space or tab
boolean	isPreFormatted()
boolean	isSuppressCloseTagLine()
boolean	isSuppressOpenTagLine()
@NotNull java.util.Iterator<LineInfo>	iterator()	Full line iterator NOTE: will not issue line() to terminate any unterminated lines before iteration and will not include unterminated lines in iteration
T	line()	Add a new line if there was any unterminated text appended or if this is a preformatted region
T	lineIf(boolean predicate)	Add a new line, if predicate is true and line() would add an EOL.
T	lineOnFirstText(boolean value)
T	lineWithTrailingSpaces(int count)	Add a new line, keep trailing spaces if there was any unterminated text appended
int	offset()	Get text offset of all output lines, excluding any text for the last line being accumulated
int	offsetWithPending()	Get offset after last append as if EOL was added but without the EOL itself
T	openPre()
T	openPreFormatted(boolean keepIndent)	Open preformatted section and suspend content modification
T	popOptions()
T	popPrefix()	Pop a prefix from the stack and set the current prefix
T	popPrefix(boolean afterEol)	Pop a prefix from the stack and set the current prefix
protected void	popTag(java.lang.CharSequence tagName)
T	pushOptions()
T	pushPrefix()	Save the current prefix on the stack
protected void	pushTag(java.lang.CharSequence tagName)
T	raw(@NotNull java.lang.CharSequence s)
T	raw(@NotNull java.lang.CharSequence s, int count)
T	rawIndentedPre(@NotNull java.lang.CharSequence s)
T	rawPre(@NotNull java.lang.CharSequence s)
T	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
T	removeIndentOnFirstEOL(@NotNull java.lang.Runnable listener)	Remove runnable, has no effect if EOL was already appended and runnable was run
T	removeLines(int startLine, int endLine)
T	setAttributes(@NotNull Attributes attributes)
T	setIndentPrefix(@Nullable java.lang.CharSequence prefix)	Set prefix to append after a new line character for every indent level
void	setLine(int lineIndex, @NotNull java.lang.CharSequence prefix, @NotNull java.lang.CharSequence text)	Set content and prefix for a line
T	setOptions(int flags)	Set options on processing text
T	setPrefix(@NotNull java.lang.CharSequence prefix)	Set prefix appended after a new line character for every line and after a new line in pre-formatted sections
T	setPrefix(@Nullable java.lang.CharSequence prefix, boolean afterEol)	Set prefix appended after a new line character for every line and after a new line in pre-formatted sections
void	setPrefixLength(int lineIndex, int prefixEndIndex)	Change prefix length for a given line without changing the line content
T	setSuppressCloseTagLine(boolean suppressCloseTagLine)
void	setSuppressOpenTagLine(boolean suppressOpenTagLine)
T	tag(@NotNull java.lang.CharSequence tagName)
T	tag(@NotNull java.lang.CharSequence tagName, boolean voidElement)
T	tag(@NotNull java.lang.CharSequence tagName, boolean withIndent, boolean withLine, @NotNull java.lang.Runnable runnable)
T	tag(@NotNull java.lang.CharSequence tagName, @NotNull java.lang.Runnable runnable)
protected void	tagClosed(java.lang.CharSequence tagName)
T	tagIndent(@NotNull java.lang.CharSequence tagName, @NotNull java.lang.Runnable runnable)
T	tagLine(@NotNull java.lang.CharSequence tagName)
T	tagLine(@NotNull java.lang.CharSequence tagName, boolean voidElement)
T	tagLine(@NotNull java.lang.CharSequence tagName, @NotNull java.lang.Runnable runnable)
T	tagLineIndent(@NotNull java.lang.CharSequence tagName, @NotNull java.lang.Runnable runnable)
protected void	tagOpened(java.lang.CharSequence tagName)
T	tagVoid(@NotNull java.lang.CharSequence tagName)
T	tagVoidLine(@NotNull java.lang.CharSequence tagName)
T	text(@NotNull java.lang.CharSequence s)
@NotNull java.lang.CharSequence	toSequence(int maxBlankLines, int maxTrailingBlankLines, boolean withPrefixes)	get the resulting text for all lines
@NotNull java.lang.String	toString()
@NotNull java.lang.String	toString(int maxBlankLines, int maxTrailingBlankLines, boolean withPrefixes)	get the resulting text for all lines
T	unIndent()	Decrease the indent level, min level is 0, will terminate the current line if there is unterminated text
T	unIndentNoEol()	Decrease the indent level, if there is unterminated text then unindented prefix is to be applied after the next EOL.
T	withAttr()
T	withCondIndent()
T	withCondLineOnChildText()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vladsch.flexmark.util.sequence.LineAppendable

addOptions, append, append, appendAll, appendTo, appendTo, appendTo, appendTo, appendToSilently, appendToSilently, appendToSilently, appendToSilently, clearLineOnFirstText, copyAppendable, copyAppendable, copyAppendable, copyAppendable, copyAppendable, get, getLineContent, getLinePrefix, getLines, getLines, getLines, getLines, getLinesInfo, getLinesInfo, getTrailingBlankLines, isEmpty, isNotEmpty, noPreserveSpaces, noTrimLeading, preserveSpaces, removeExtraBlankLines, removeOptions, setLineOnFirstText, setOptions, setOptions, toSequence, toSequence, toSequence, toSequence, toString, toString, toString, toString, trimLeading

Field Detail

appendable

private final LineAppendable appendable

currentAttributes

@Nullable
private @Nullable MutableAttributes currentAttributes

indentOnFirstEol

private boolean indentOnFirstEol

lineOnChildText

private boolean lineOnChildText

withAttributes

private boolean withAttributes

suppressOpenTagLine

private boolean suppressOpenTagLine

suppressCloseTagLine

private boolean suppressCloseTagLine

openTags

@NotNull
private final @NotNull java.util.Stack<java.lang.String> openTags

Constructor Detail

HtmlAppendableBase

public HtmlAppendableBase(LineAppendable other,
                          boolean inheritIndent)

HtmlAppendableBase

public HtmlAppendableBase(int indentSize,
                          int formatOptions)

HtmlAppendableBase

public HtmlAppendableBase(@Nullable
                          @Nullable java.lang.Appendable other,
                          int indentSize,
                          int formatOptions)

Method Detail

getEmptyAppendable

@NotNull
public @NotNull HtmlAppendable getEmptyAppendable()

Specified by:

getEmptyAppendable in interface LineAppendable

isSuppressOpenTagLine

public boolean isSuppressOpenTagLine()

setSuppressOpenTagLine

public void setSuppressOpenTagLine(boolean suppressOpenTagLine)

isSuppressCloseTagLine

public boolean isSuppressCloseTagLine()

setSuppressCloseTagLine

@NotNull
public T setSuppressCloseTagLine(boolean suppressCloseTagLine)

toString

@NotNull
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Object

openPre

@NotNull
public T openPre()

Specified by:

openPre in interface HtmlAppendable

closePre

@NotNull
public T closePre()

Specified by:

closePre in interface HtmlAppendable

inPre

public boolean inPre()

Specified by:

inPre in interface HtmlAppendable

haveOptions

private boolean haveOptions(int options)

raw

@NotNull
public T raw(@NotNull
             @NotNull java.lang.CharSequence s)

Specified by:

raw in interface HtmlAppendable

raw

@NotNull
public T raw(@NotNull
             @NotNull java.lang.CharSequence s,
             int count)

Specified by:

raw in interface HtmlAppendable

rawPre

@NotNull
public T rawPre(@NotNull
                @NotNull java.lang.CharSequence s)

Specified by:

rawPre in interface HtmlAppendable

rawIndentedPre

@NotNull
public T rawIndentedPre(@NotNull
                        @NotNull java.lang.CharSequence s)

Specified by:

rawIndentedPre in interface HtmlAppendable

text

@NotNull
public T text(@NotNull
              @NotNull java.lang.CharSequence s)

Specified by:

text in interface HtmlAppendable

attr

@NotNull
public T attr(@NotNull
              @NotNull java.lang.CharSequence attrName,
              @NotNull
              @NotNull java.lang.CharSequence value)

Specified by:

attr in interface HtmlAppendable

attr

@NotNull
public T attr(@NotNull
              @NotNull Attribute... attribute)

Specified by:

attr in interface HtmlAppendable

attr

@NotNull
public T attr(@NotNull
              @NotNull Attributes attributes)

Specified by:

attr in interface HtmlAppendable

withAttr

@NotNull
public T withAttr()

Specified by:

withAttr in interface HtmlAppendable

getAttributes

public Attributes getAttributes()

Specified by:

getAttributes in interface HtmlAppendable

setAttributes

@NotNull
public T setAttributes(@NotNull
                       @NotNull Attributes attributes)

Specified by:

setAttributes in interface HtmlAppendable

withCondLineOnChildText

@NotNull
public T withCondLineOnChildText()

Specified by:

withCondLineOnChildText in interface HtmlAppendable

withCondIndent

@NotNull
public T withCondIndent()

Specified by:

withCondIndent in interface HtmlAppendable

tag

@NotNull
public T tag(@NotNull
             @NotNull java.lang.CharSequence tagName)

Specified by:

tag in interface HtmlAppendable

tag

@NotNull
public T tag(@NotNull
             @NotNull java.lang.CharSequence tagName,
             @NotNull
             @NotNull java.lang.Runnable runnable)

Specified by:

tag in interface HtmlAppendable

tagVoid

@NotNull
public T tagVoid(@NotNull
                 @NotNull java.lang.CharSequence tagName)

Specified by:

tagVoid in interface HtmlAppendable

getOpenTagText

protected java.lang.String getOpenTagText()

pushTag

protected void pushTag(java.lang.CharSequence tagName)

popTag

protected void popTag(java.lang.CharSequence tagName)

tagOpened

protected void tagOpened(java.lang.CharSequence tagName)

tagClosed

protected void tagClosed(java.lang.CharSequence tagName)

getOpenTags

@NotNull
public @NotNull java.util.Stack<java.lang.String> getOpenTags()

Specified by:

getOpenTags in interface HtmlAppendable

getOpenTagsAfterLast

@NotNull
public @NotNull java.util.List<java.lang.String> getOpenTagsAfterLast(@NotNull
                                                                      @NotNull java.lang.CharSequence latestTag)

Specified by:

getOpenTagsAfterLast in interface HtmlAppendable

tag

@NotNull
public T tag(@NotNull
             @NotNull java.lang.CharSequence tagName,
             boolean voidElement)

Specified by:

tag in interface HtmlAppendable

closeTag

@NotNull
public T closeTag(@NotNull
                  @NotNull java.lang.CharSequence tagName)

Specified by:

closeTag in interface HtmlAppendable

tag

@NotNull
public T tag(@NotNull
             @NotNull java.lang.CharSequence tagName,
             boolean withIndent,
             boolean withLine,
             @NotNull
             @NotNull java.lang.Runnable runnable)

Specified by:

tag in interface HtmlAppendable

tagVoidLine

@NotNull
public T tagVoidLine(@NotNull
                     @NotNull java.lang.CharSequence tagName)

Specified by:

tagVoidLine in interface HtmlAppendable

tagLine

@NotNull
public T tagLine(@NotNull
                 @NotNull java.lang.CharSequence tagName)

Specified by:

tagLine in interface HtmlAppendable

tagLine

@NotNull
public T tagLine(@NotNull
                 @NotNull java.lang.CharSequence tagName,
                 boolean voidElement)

Specified by:

tagLine in interface HtmlAppendable

tagLine

@NotNull
public T tagLine(@NotNull
                 @NotNull java.lang.CharSequence tagName,
                 @NotNull
                 @NotNull java.lang.Runnable runnable)

Specified by:

tagLine in interface HtmlAppendable

tagIndent

@NotNull
public T tagIndent(@NotNull
                   @NotNull java.lang.CharSequence tagName,
                   @NotNull
                   @NotNull java.lang.Runnable runnable)

Specified by:

tagIndent in interface HtmlAppendable

tagLineIndent

@NotNull
public T tagLineIndent(@NotNull
                       @NotNull java.lang.CharSequence tagName,
                       @NotNull
                       @NotNull java.lang.Runnable runnable)

Specified by:

tagLineIndent in interface HtmlAppendable

iterator

@NotNull
public @NotNull java.util.Iterator<LineInfo> iterator()

Description copied from interface: LineAppendable

Full line iterator NOTE: will not issue line() to terminate any unterminated lines before iteration and will not include unterminated lines in iteration

Specified by:

iterator in interface java.lang.Iterable<T extends HtmlAppendableBase<T>>

Specified by:

iterator in interface LineAppendable

Returns:

iterator over lines

getLines

@NotNull
public @NotNull java.lang.Iterable<BasedSequence> getLines(int maxTrailingBlankLines,
                                                           int startLine,
                                                           int endLine,
                                                           boolean withPrefixes)

Description copied from interface: LineAppendable

Full line iterator over some lines

NOTE: will issue line() to terminate any unterminated lines before iteration

Specified by:

getLines in interface LineAppendable

Parameters:

maxTrailingBlankLines - maximum trailing blank lines, -1 if trailing EOL should be removed

startLine - start line index

endLine - end line index, exclusive

withPrefixes - true if prefixes should be included, else only non-prefix line text

Returns:

iterator over lines

getLinesInfo

@NotNull
public @NotNull java.lang.Iterable<LineInfo> getLinesInfo(int maxTrailingBlankLines,
                                                          int startLine,
                                                          int endLine)

Description copied from interface: LineAppendable

Full line iterator with line info

NOTE: will issue line() to terminate any unterminated lines before iteration

Specified by:

getLinesInfo in interface LineAppendable

Parameters:

maxTrailingBlankLines - maximum trailing blank lines, -1 if trailing EOL should be removed

startLine - start line index

endLine - end line index, exclusive

Returns:

iterator over lines

setPrefixLength

public void setPrefixLength(int lineIndex,
                            int prefixEndIndex)

Description copied from interface: LineAppendable

Change prefix length for a given line without changing the line content

Specified by:

setPrefixLength in interface LineAppendable

Parameters:

lineIndex - index of the line

prefixEndIndex - new prefix length

insertLine

public void insertLine(int lineIndex,
                       @NotNull
                       @NotNull java.lang.CharSequence prefix,
                       @NotNull
                       @NotNull java.lang.CharSequence text)

Description copied from interface: LineAppendable

Insert a line at the index with given content and prefix for a line

Specified by:

insertLine in interface LineAppendable

Parameters:

lineIndex - index of the line

prefix - prefix of the line

text - content text of the line

setLine

public void setLine(int lineIndex,
                    @NotNull
                    @NotNull java.lang.CharSequence prefix,
                    @NotNull
                    @NotNull java.lang.CharSequence text)

Description copied from interface: LineAppendable

Set content and prefix for a line

Specified by:

setLine in interface LineAppendable

Parameters:

lineIndex - index of the line

prefix - prefix of the line

text - content text of the line

appendTo

public <T extends java.lang.Appendable> T appendTo(@NotNull
                                                   T out,
                                                   boolean withPrefixes,
                                                   int maxBlankLines,
                                                   int maxTrailingBlankLines,
                                                   int startLine,
                                                   int endLine)
                                            throws java.io.IOException

Description copied from interface: LineAppendable

append lines to appendable with given maximum trailing blank lines and given prefix to add to all lines

NOTE:

Specified by:

appendTo in interface LineAppendable

Type Parameters:

T - type of out

Parameters:

out - appendable to output the resulting lines

withPrefixes - true if to include prefixes

maxBlankLines - 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 added

startLine - line from which to start output

endLine - line at which to stop output

Returns:

out

Throws:

java.io.IOException - if thrown by appendable

endsWithEOL

public boolean endsWithEOL()

Specified by:

endsWithEOL in interface LineAppendable

Returns:

true if not empty and have no unterminated lines

isPendingSpace

public boolean isPendingSpace()

Description copied from interface: LineAppendable

Test if trailing text ends in space or tab

Specified by:

isPendingSpace in interface LineAppendable

Returns:

true if ending in space or tab

isPreFormatted

public boolean isPreFormatted()

Specified by:

isPreFormatted in interface LineAppendable

Returns:

true if in pre-formatted region

getTrailingBlankLines

public int getTrailingBlankLines(int endLine)

Description copied from interface: LineAppendable

Get trailing blank line count ending on given line

Specified by:

getTrailingBlankLines in interface LineAppendable

Parameters:

endLine - end line

Returns:

number of trailing blank lines

column

public int column()

Description copied from interface: LineAppendable

Get column offset after last append

Specified by:

column in interface LineAppendable

Returns:

column offset after last append

getLineCount

public int getLineCount()

Description copied from interface: LineAppendable

Get the number of lines appended, not including any unterminated ones

Specified by:

getLineCount in interface LineAppendable

Returns:

number of full lines appended

getLineCountWithPending

public int getLineCountWithPending()

Description copied from interface: LineAppendable

Get the number of lines appended, including any unterminated ones

NOTE: if there is an unterminated line it will be available as the last line, without being terminated explicitly

Specified by:

getLineCountWithPending in interface LineAppendable

Returns:

number of lines appended

getOptions

public int getOptions()

Description copied from interface: LineAppendable

Get current options as bit mask flags

Specified by:

getOptions in interface LineAppendable

Returns:

option flags

getPendingSpace

public int getPendingSpace()

Description copied from interface: LineAppendable

Get number of spaces at end of pending text

Specified by:

getPendingSpace in interface LineAppendable

Returns:

number of eols at end of text

getPendingEOL

public int getPendingEOL()

Description copied from interface: LineAppendable

Get number of EOLs at end of appendable, this is actually number of tail blank lines

Specified by:

getPendingEOL in interface LineAppendable

Returns:

number of eols at end of text

offset

public int offset()

Description copied from interface: LineAppendable

Get text offset of all output lines, excluding any text for the last line being accumulated

Specified by:

offset in interface LineAppendable

Returns:

offset of text as would be returned for all

offsetWithPending

public int offsetWithPending()

Description copied from interface: LineAppendable

Get offset after last append as if EOL was added but without the EOL itself

Specified by:

offsetWithPending in interface LineAppendable

Returns:

offset as would be returned by LineAppendable.offset() after line() call less 1 for EOL

getAfterEolPrefixDelta

public int getAfterEolPrefixDelta()

Description copied from interface: LineAppendable

Get pending prefix after EOL

Specified by:

getAfterEolPrefixDelta in interface LineAppendable

Returns:

change in prefix length after next eol

getBuilder

@NotNull
public @NotNull ISequenceBuilder<?,?> getBuilder()

Description copied from interface: LineAppendable

Get builder used for accumulation

Specified by:

getBuilder in interface LineAppendable

Returns:

builder used for accumulation

getPrefix

@NotNull
public @NotNull BasedSequence getPrefix()

Description copied from interface: LineAppendable

Get prefix being applied to all lines, even in pre-formatted sections This is the prefix that will be set after EOL

Specified by:

getPrefix in interface LineAppendable

Returns:

char sequence of the current prefix

getBeforeEolPrefix

@NotNull
public @NotNull BasedSequence getBeforeEolPrefix()

Description copied from interface: LineAppendable

Get prefix used before EOL

Specified by:

getBeforeEolPrefix in interface LineAppendable

Returns:

char sequence of the current prefix

getLineInfo

@NotNull
public @NotNull LineInfo getLineInfo(int lineIndex)

Description copied from interface: LineAppendable

Get Line information at given line index

NOTE: if there is an unterminated line it will be available as the last line, without being terminated explicitly

Specified by:

getLineInfo in interface LineAppendable

Parameters:

lineIndex - line index for the info to get

Returns:

line info

getLine

@NotNull
public @NotNull BasedSequence getLine(int lineIndex)

Description copied from interface: LineAppendable

Get Line at given line index

NOTE: if there is an unterminated line it will be available as the last line, without being terminated explicitly

Specified by:

getLine in interface LineAppendable

Parameters:

lineIndex - line index

Returns:

line char sequence

getIndentPrefix

@NotNull
public @NotNull BasedSequence getIndentPrefix()

Description copied from interface: LineAppendable

Get prefix appended after a new line character for every indent level

Specified by:

getIndentPrefix in interface LineAppendable

Returns:

char sequence of the current indent prefix used for each indent level

toSequence

@NotNull
public @NotNull java.lang.CharSequence toSequence(int maxBlankLines,
                                                  int maxTrailingBlankLines,
                                                  boolean withPrefixes)

Description copied from interface: LineAppendable

get the resulting text for all lines

Specified by:

toSequence in interface LineAppendable

Parameters:

maxBlankLines - maximum blank lines to allow in the text

maxTrailingBlankLines - maximum trailing blank lines

withPrefixes - true if to include prefixes

Returns:

resulting text

toString

@NotNull
public @NotNull java.lang.String toString(int maxBlankLines,
                                          int maxTrailingBlankLines,
                                          boolean withPrefixes)

Description copied from interface: LineAppendable

get the resulting text for all lines

Specified by:

toString in interface LineAppendable

Parameters:

maxBlankLines - maximum blank lines to allow in the text

maxTrailingBlankLines - maximum trailing blank lines

withPrefixes - true if to include prefixes

Returns:

resulting text

getOptionSet

@NotNull
public @NotNull BitFieldSet<LineAppendable.Options> getOptionSet()

Description copied from interface: LineAppendable

Get current options as set which can be used to modify options

Specified by:

getOptionSet in interface LineAppendable

Returns:

mutable option set

removeExtraBlankLines

@NotNull
public T removeExtraBlankLines(int maxBlankLines,
                               int maxTrailingBlankLines,
                               int startLine,
                               int endLine)

Description copied from interface: LineAppendable

Normalize the appendable by removing extra blank lines in the body or at the end of given line range

Specified by:

removeExtraBlankLines in interface LineAppendable

Parameters:

maxBlankLines - maximum blank lines to allow in the body

maxTrailingBlankLines - maximum trailing blank lines ending on endLine, if <maxBlankLines then maxBlankLines will be used

startLine - line from which to start output

endLine - line at which to stop output

Returns:

this

removeLines

@NotNull
public T removeLines(int startLine,
                     int endLine)

Specified by:

removeLines in interface LineAppendable

pushOptions

@NotNull
public T pushOptions()

Specified by:

pushOptions in interface LineAppendable

popOptions

@NotNull
public T popOptions()

Specified by:

popOptions in interface LineAppendable

changeOptions

@NotNull
public T changeOptions(int addFlags,
                       int removeFlags)

Specified by:

changeOptions in interface LineAppendable

addIndentOnFirstEOL

@NotNull
public T addIndentOnFirstEOL(@NotNull
                             @NotNull java.lang.Runnable listener)

Description copied from interface: LineAppendable

Add an indent on first EOL appended and run runnable

Specified by:

addIndentOnFirstEOL in interface LineAppendable

Parameters:

listener - runnable to run if adding indent on first EOL

Returns:

this

addPrefix

@NotNull
public T addPrefix(@NotNull
                   @NotNull java.lang.CharSequence prefix)

Description copied from interface: LineAppendable

Add to prefix appended after a new line character for every line and after a new line in pre-formatted sections

This appends the sequence to current prefix

Specified by:

addPrefix in interface LineAppendable

Parameters:

prefix - prefix characters to add to current prefix for new lines appended after this is set

Returns:

this

addPrefix

@NotNull
public T addPrefix(@NotNull
                   @NotNull java.lang.CharSequence prefix,
                   boolean afterEol)

Description copied from interface: LineAppendable

Add to prefix appended after a new line character for every line and after a new line in pre-formatted sections

This appends the sequence to current prefix

Specified by:

addPrefix in interface LineAppendable

Parameters:

prefix - prefix characters to add to current prefix for new lines appended after this is set

afterEol - if true prefix will take effect after EOL

Returns:

this

append

@NotNull
public T append(char c)

Specified by:

append in interface java.lang.Appendable

Specified by:

append in interface LineAppendable

append

@NotNull
public T append(@NotNull
                @NotNull java.lang.CharSequence csq)

Specified by:

append in interface java.lang.Appendable

Specified by:

append in interface LineAppendable

append

@NotNull
public T append(@NotNull
                @NotNull java.lang.CharSequence csq,
                int start,
                int end)

Specified by:

append in interface java.lang.Appendable

Specified by:

append in interface LineAppendable

append

@NotNull
public T append(@NotNull
                @NotNull LineAppendable lines,
                int startLine,
                int endLine,
                boolean withPrefixes)

Description copied from interface: LineAppendable

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

Specified by:

append in interface LineAppendable

Parameters:

lines - lines to append, any unterminated lines will be terminated by a LineAppendable.line() invocation.

startLine - start line to append

endLine - end line to append, endLine is excluded.

withPrefixes - true if to include prefixes from the lineAppendable.

Returns:

this

blankLine

@NotNull
public T blankLine()

Description copied from interface: LineAppendable

Add a blank line, if there is not one already appended.

Specified by:

blankLine in interface LineAppendable

Returns:

this

blankLine

@NotNull
public T blankLine(int count)

Description copied from interface: LineAppendable

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.

Specified by:

blankLine in interface LineAppendable

Parameters:

count - number of blank lines to append

Returns:

this

blankLineIf

@NotNull
public T blankLineIf(boolean predicate)

Description copied from interface: LineAppendable

Add a blank line, if predicate is true and there isn't already blank lines appended.

Specified by:

blankLineIf in interface LineAppendable

Parameters:

predicate - when true append blank line

Returns:

this

closePreFormatted

@NotNull
public T closePreFormatted()

Description copied from interface: LineAppendable

Close preformatted section and suspend content modification

Specified by:

closePreFormatted in interface LineAppendable

Returns:

this

indent

@NotNull
public T indent()

Description copied from interface: LineAppendable

Increase the indent level, will terminate the current line if there is unterminated text

NOTE: this is equivalent to pushPrefix(), addPrefix(getIndentPrefix()) but adds a flag to validate that LineAppendable.unIndent() is called only on prefixes added by this method

Specified by:

indent in interface LineAppendable

Returns:

this

line

@NotNull
public T line()

Description copied from interface: LineAppendable

Add a new line if there was any unterminated text appended or if this is a preformatted region

Specified by:

line in interface LineAppendable

Returns:

this

lineIf

@NotNull
public T lineIf(boolean predicate)

Description copied from interface: LineAppendable

Add a new line, if predicate is true and line() would add an EOL.

Specified by:

lineIf in interface LineAppendable

Parameters:

predicate - call LineAppendable.line() if value is true.

Returns:

this

lineOnFirstText

@NotNull
public T lineOnFirstText(boolean value)

Specified by:

lineOnFirstText in interface LineAppendable

lineWithTrailingSpaces

@NotNull
public T lineWithTrailingSpaces(int count)

Description copied from interface: LineAppendable

Add a new line, keep trailing spaces if there was any unterminated text appended

NOTE: only applies in preformatted region or if the line is not empty

Specified by:

lineWithTrailingSpaces in interface LineAppendable

Parameters:

count - number of trailing spaces to add

Returns:

this

openPreFormatted

@NotNull
public T openPreFormatted(boolean keepIndent)

Description copied from interface: LineAppendable

Open preformatted section and suspend content modification

Specified by:

openPreFormatted in interface LineAppendable

Parameters:

keepIndent - if true will add the current prefix to first line

Returns:

this

popPrefix

@NotNull
public T popPrefix()

Description copied from interface: LineAppendable

Pop a prefix from the stack and set the current prefix

Specified by:

popPrefix in interface LineAppendable

Returns:

this

popPrefix

@NotNull
public T popPrefix(boolean afterEol)

Description copied from interface: LineAppendable

Pop a prefix from the stack and set the current prefix

Specified by:

popPrefix in interface LineAppendable

Parameters:

afterEol - if true prefix will take effect after EOL

Returns:

this

pushPrefix

@NotNull
public T pushPrefix()

Description copied from interface: LineAppendable

Save the current prefix on the stack

Specified by:

pushPrefix in interface LineAppendable

Returns:

this

removeIndentOnFirstEOL

@NotNull
public T removeIndentOnFirstEOL(@NotNull
                                @NotNull java.lang.Runnable listener)

Description copied from interface: LineAppendable

Remove runnable, has no effect if EOL was already appended and runnable was run

Specified by:

removeIndentOnFirstEOL in interface LineAppendable

Parameters:

listener - runnable added with addIndentOnFirstEOL

Returns:

this

append

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

Specified by:

append in interface LineAppendable

setIndentPrefix

@NotNull
public T setIndentPrefix(@Nullable
                         @Nullable java.lang.CharSequence prefix)

Description copied from interface: LineAppendable

Set prefix to append after a new line character for every indent level

Specified by:

setIndentPrefix in interface LineAppendable

Parameters:

prefix - prefix characters for new lines appended after this is set

Returns:

this

setOptions

@NotNull
public T setOptions(int flags)

Description copied from interface: LineAppendable

Set options on processing text

Specified by:

setOptions in interface LineAppendable

Parameters:

flags - option flags

Returns:

this

setPrefix

@NotNull
public T setPrefix(@NotNull
                   @NotNull java.lang.CharSequence prefix)

Description copied from interface: LineAppendable

Set prefix appended after a new line character for every line and after a new line in pre-formatted sections

This appends the sequence to current prefix

Specified by:

setPrefix in interface LineAppendable

Parameters:

prefix - prefix characters to add to current prefix for new lines appended after this is set

Returns:

this

setPrefix

@NotNull
public T setPrefix(@Nullable
                   @Nullable java.lang.CharSequence prefix,
                   boolean afterEol)

Description copied from interface: LineAppendable

Set prefix appended after a new line character for every line and after a new line in pre-formatted sections

This appends the sequence to current prefix

Specified by:

setPrefix in interface LineAppendable

Parameters:

prefix - prefix characters to add to current prefix for new lines appended after this is set

afterEol - if true prefix will take effect after EOL

Returns:

this

unIndent

@NotNull
public T unIndent()

Description copied from interface: LineAppendable

Decrease the indent level, min level is 0, will terminate the current line if there is unterminated text

NOTE: this is equivalent to popPrefix() but with validation that it is called only on prefixes added by LineAppendable.indent()

Specified by:

unIndent in interface LineAppendable

Returns:

this

unIndentNoEol

@NotNull
public T unIndentNoEol()

Description copied from interface: LineAppendable

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 LineAppendable.addIndentOnFirstEOL(Runnable) if callback is invoked

Specified by:

unIndentNoEol in interface LineAppendable

Returns:

this