com.vladsch.flexmark.util.html

Class FormattingAppendableImpl

java.lang.Object

com.vladsch.flexmark.util.html.FormattingAppendableImpl

All Implemented Interfaces:

FormattingAppendable, Appendable

public class FormattingAppendableImpl
extends Object
implements FormattingAppendable

Field Summary

Fields inherited from interface com.vladsch.flexmark.util.html.FormattingAppendable

ALLOW_LEADING_WHITESPACE, COLLAPSE_WHITESPACE, CONVERT_TABS, FORMAT_ALL, PASS_THROUGH, PREFIX_AFTER_PENDING_EOL, SUPPRESS_TRAILING_WHITESPACE

Constructor Summary

Constructors

Constructor and Description
FormattingAppendableImpl(Appendable appendable, int formatOptions)
FormattingAppendableImpl(int formatOptions)

Method Summary

Modifier and Type	Method and Description
FormattingAppendableImpl	addAfterEolRunnable(int atPendingEOL, Runnable runnable) Add runnable to run after the given pending EOL is output to the stream.
FormattingAppendable	addLine() Add a new line or blank lines as needed.
FormattingAppendable	addPrefix(CharSequence prefix) Set prefix to append after a new line character for every line before the indent prefix in normal and after a new line in pre-formatted sections This appends the sequence to current prefix
FormattingAppendable	append(char c)
FormattingAppendable	append(CharSequence csq)
FormattingAppendable	append(CharSequence csq, int start, int end)
FormattingAppendable	blankLine() Add a blank line, if there is not one already appended.
FormattingAppendable	blankLine(int count) Add a blank lines, if there isn't already given number of blank lines appended.
FormattingAppendable	blankLineIf(boolean predicate) Add a blank line, if predicate is true and there isn't already blank lines appended.
FormattingAppendable	closeConditional(ConditionalFormatter closeFormatter) Close a conditional formatting region.
FormattingAppendable	closePreFormatted() Close a pre-formatted section.
int	column() Get column offset after last append, does not include any pending: EOLs, spaces nor indents
int	columnWith(CharSequence csq, int start, int end) Get column offset after last append, does not include any pending: EOLs, spaces nor indents
FormattingAppendable	flush() Flush all pending new lines, no blank lines will be output, if these are desired at the end of the output.
FormattingAppendable	flush(int maxBlankLines) Flush all pending new lines and blank lines, if these are desired at the end of the output.
FormattingAppendable	flushWhitespaces() Flush all pending whitespaces
Appendable	getAppendable() Get the underlying appendable
int	getIndent() Get the current indent level + indent offset
CharSequence	getIndentPrefix() Get prefix appended after a new line character for every indent level
IOException	getIOException()
int	getLineCount() Get the number of lines appended, does not include pending: EOLs
int	getModCount() Get the modification count.
int	getOptions() Get current options
int	getPendingEOL() see if there is a pending space
int	getPendingSpace()
BasedSequence	getPrefix() Get prefix being applied to all lines, even in pre-formatted sections
int	getPushedPrefixCount() Pop a prefix from the stack and set the current prefix
String	getText() get the resulting text from appendable
String	getText(int maxBlankLines) get the resulting text from appendable
CharSequence	getTotalIndentPrefix() Get the total indent prefix appended after a new line character, FormattingAppendable.getIndentPrefix() repeated FormattingAppendable.getIndent() times.
FormattingAppendable	indent() Increase the indent level, will terminate the current line if there is unterminated text
boolean	isPendingEOL() see if there is a pending space
boolean	isPendingSpace() see if there is a pending space
boolean	isPreFormatted()
int	lastOffset() Get offset before the last append, but right after pending: EOLs, spaces or indents were added
FormattingAppendable	lastOffset(Ref<Integer> refOffset) Get offset before the next append, but right after pending: EOLs, spaces or indents were added Next append of text (non EOL/spaces) will set the reference, following appends will have not effect Unlike FormattingAppendable.lastOffset() flush() does not change the value of the reference, only actual character appending.
FormattingAppendable	line() Add a new line, if there was any unterminated text appended
FormattingAppendable	line(Ref<Boolean> lineRef) Add a new line, if there was any unterminated text appended
FormattingAppendable	lineIf(boolean predicate) Add a new line, if predicate is true and there was any unterminated text appended
FormattingAppendable	lineIf(Ref<Boolean> lineRef) Add a new line, if lineRef is true, if false means that the new line in FormattingAppendable.line(Ref) was suppressed by conditionalFormatter and this new line will be suppressed too.
int	offset() Get offset after last append, does not include any pending: EOLs, spaces nor indents
int	offsetWithPending() Get offset after last append, include any pending: EOLs, and indents
FormattingAppendable	openConditional(ConditionalFormatter openFormatter) Open a conditional formatting region.
FormattingAppendable	openPreFormatted(boolean keepIndent) Open a pre-formatted section.
FormattingAppendable	popPrefix() Pop a prefix from the stack and set the current prefix
FormattingAppendable	pushPrefix() Save the current prefix on the stack
FormattingAppendable	repeat(char c, int count)
FormattingAppendable	repeat(CharSequence csq, int count)
FormattingAppendable	repeat(CharSequence csq, int start, int end, int count)
FormattingAppendable	setIndentOffset(int indentOffset) Set the current indent level.
FormattingAppendable	setIndentPrefix(CharSequence prefix) Set prefix to append after a new line character for every indent level
FormattingAppendable	setOptions(int options) Set options on processing text
void	setPendingEOL(int pendingEOL) Kludge to allow inserting spaces before the already pending EOL in HTML parser
void	setPendingEOLRaw(int pendingEOL)
FormattingAppendable	setPrefix(CharSequence prefix) Set prefix to append after a new line character for every line before the indent prefix in normal and after a new line in pre-formatted sections if PREFIX_AFTER_PENDING_EOL is enabled then prefix will take effect after pending EOLs are output
FormattingAppendable	unIndent() Decrease the indent level, min level is 0, will terminate the current line if there is unterminated text
FormattingAppendable	willIndent() Notify of the fact that after some appending some text, there will be an indent() call so that conditional formatting can kick in before the text is appended

Methods inherited from class java.lang.Object

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

Constructor Detail

FormattingAppendableImpl

public FormattingAppendableImpl(int formatOptions)

FormattingAppendableImpl

public FormattingAppendableImpl(Appendable appendable,
                                int formatOptions)

Method Detail

getOptions

public int getOptions()

Description copied from interface: FormattingAppendable

Get current options

Specified by:

getOptions in interface FormattingAppendable

Returns:

option flags

setOptions

public FormattingAppendable setOptions(int options)

Description copied from interface: FormattingAppendable

Set options on processing text

Specified by:

setOptions in interface FormattingAppendable

Parameters:

options - option flags

Returns:

this

setPendingEOLRaw

public void setPendingEOLRaw(int pendingEOL)

setPendingEOL

public void setPendingEOL(int pendingEOL)

Description copied from interface: FormattingAppendable

Kludge to allow inserting spaces before the already pending EOL in HTML parser

Specified by:

setPendingEOL in interface FormattingAppendable

Parameters:

pendingEOL - how many pending EOLs to set

addAfterEolRunnable

public FormattingAppendableImpl addAfterEolRunnable(int atPendingEOL,
                                                    Runnable runnable)

Description copied from interface: FormattingAppendable

Add runnable to run after the given pending EOL is output to the stream. if current pendingEOL is N then will run after pendingEOL == atPendingEOL and EOL is output

Specified by:

addAfterEolRunnable in interface FormattingAppendable

Parameters:

atPendingEOL - pending EOL level

runnable - runnable to run once this EOL is output

Returns:

this

getIOException

public IOException getIOException()

Specified by:

getIOException in interface FormattingAppendable

append

public FormattingAppendable append(CharSequence csq)

Specified by:

append in interface FormattingAppendable

Specified by:

append in interface Appendable

append

public FormattingAppendable append(CharSequence csq,
                                   int start,
                                   int end)

Specified by:

append in interface FormattingAppendable

Specified by:

append in interface Appendable

append

public FormattingAppendable append(char c)

Specified by:

append in interface FormattingAppendable

Specified by:

append in interface Appendable

repeat

public FormattingAppendable repeat(char c,
                                   int count)

Specified by:

repeat in interface FormattingAppendable

repeat

public FormattingAppendable repeat(CharSequence csq,
                                   int count)

Specified by:

repeat in interface FormattingAppendable

repeat

public FormattingAppendable repeat(CharSequence csq,
                                   int start,
                                   int end,
                                   int count)

Specified by:

repeat in interface FormattingAppendable

getAppendable

public Appendable getAppendable()

Description copied from interface: FormattingAppendable

Get the underlying appendable

Specified by:

getAppendable in interface FormattingAppendable

Returns:

appendable being used for accumulating output

getText

public String getText()

Description copied from interface: FormattingAppendable

get the resulting text from appendable

Specified by:

getText in interface FormattingAppendable

Returns:

appendable toString() result after flushing

getText

public String getText(int maxBlankLines)

Description copied from interface: FormattingAppendable

get the resulting text from appendable

Specified by:

getText in interface FormattingAppendable

Parameters:

maxBlankLines - maximum blank lines to allow at end, -1 will suppress the last EOL

Returns:

appendable toString() result after flushing

flush

public FormattingAppendable flush()

Description copied from interface: FormattingAppendable

Flush all pending new lines, no blank lines will be output, if these are desired at the end of the output.

All preFormatted and conditional regions should be exited prior to this call

Specified by:

flush in interface FormattingAppendable

Returns:

this

flushWhitespaces

public FormattingAppendable flushWhitespaces()

Description copied from interface: FormattingAppendable

Flush all pending whitespaces

All preFormatted and conditional regions should be exited prior to this call

Specified by:

flushWhitespaces in interface FormattingAppendable

Returns:

this

flush

public FormattingAppendable flush(int maxBlankLines)

Description copied from interface: FormattingAppendable

Flush all pending new lines and blank lines, if these are desired at the end of the output.

All preFormatted and conditional regions should be exited prior to this call

Specified by:

flush in interface FormattingAppendable

Parameters:

maxBlankLines - maximum blank lines to allow at end, -1 will suppress the last EOL

Returns:

this

getIndentPrefix

public CharSequence getIndentPrefix()

Description copied from interface: FormattingAppendable

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

Specified by:

getIndentPrefix in interface FormattingAppendable

Returns:

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

setIndentPrefix

public FormattingAppendable setIndentPrefix(CharSequence prefix)

Description copied from interface: FormattingAppendable

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

Specified by:

setIndentPrefix in interface FormattingAppendable

Parameters:

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

Returns:

this

getPrefix

public BasedSequence getPrefix()

Description copied from interface: FormattingAppendable

Get prefix being applied to all lines, even in pre-formatted sections

Specified by:

getPrefix in interface FormattingAppendable

Returns:

char sequence of the current prefix

getTotalIndentPrefix

public CharSequence getTotalIndentPrefix()

Description copied from interface: FormattingAppendable

Get the total indent prefix appended after a new line character, FormattingAppendable.getIndentPrefix() repeated FormattingAppendable.getIndent() times.

Specified by:

getTotalIndentPrefix in interface FormattingAppendable

Returns:

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

setPrefix

public FormattingAppendable setPrefix(CharSequence prefix)

Description copied from interface: FormattingAppendable

Set prefix to append after a new line character for every line before the indent prefix in normal and after a new line in pre-formatted sections if PREFIX_AFTER_PENDING_EOL is enabled then prefix will take effect after pending EOLs are output

Specified by:

setPrefix in interface FormattingAppendable

Parameters:

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

Returns:

this

addPrefix

public FormattingAppendable addPrefix(CharSequence prefix)

Description copied from interface: FormattingAppendable

Set prefix to append after a new line character for every line before the indent prefix in normal and after a new line in pre-formatted sections This appends the sequence to current prefix

Specified by:

addPrefix in interface FormattingAppendable

Parameters:

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

Returns:

this

pushPrefix

public FormattingAppendable pushPrefix()

Description copied from interface: FormattingAppendable

Save the current prefix on the stack

Specified by:

pushPrefix in interface FormattingAppendable

Returns:

this

popPrefix

public FormattingAppendable popPrefix()

Description copied from interface: FormattingAppendable

Pop a prefix from the stack and set the current prefix

Specified by:

popPrefix in interface FormattingAppendable

Returns:

this

getPushedPrefixCount

public int getPushedPrefixCount()

Description copied from interface: FormattingAppendable

Pop a prefix from the stack and set the current prefix

Specified by:

getPushedPrefixCount in interface FormattingAppendable

Returns:

count of prefixes on stack

line

public FormattingAppendable line()

Description copied from interface: FormattingAppendable

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

Actual new line character is only appended if there is real data appended and it did not contain a new line as the last character

Specified by:

line in interface FormattingAppendable

Returns:

this

addLine

public FormattingAppendable addLine()

Description copied from interface: FormattingAppendable

Add a new line or blank lines as needed.

Actual new line character is only appended if there is real data appended and it did not contain a new line as the last character

Specified by:

addLine in interface FormattingAppendable

Returns:

this

lineIf

public FormattingAppendable lineIf(boolean predicate)

Description copied from interface: FormattingAppendable

Add a new line, if predicate is true and there was any unterminated text appended

Actual new line character is only appended if and when text is appended appended and it did not contain a new line as the last character

Specified by:

lineIf in interface FormattingAppendable

Parameters:

predicate - if true then new line will be started

Returns:

this

line

public FormattingAppendable line(Ref<Boolean> lineRef)

Description copied from interface: FormattingAppendable

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

Actual new line character is only appended if there is real data appended and it did not contain a new line as the last character

Specified by:

line in interface FormattingAppendable

Parameters:

lineRef - predicate storage will be set to false if conditionalFormatter suppressed a new line

Returns:

this

lineIf

public FormattingAppendable lineIf(Ref<Boolean> lineRef)

Description copied from interface: FormattingAppendable

Add a new line, if lineRef is true, if false means that the new line in FormattingAppendable.line(Ref) was suppressed by conditionalFormatter and this new line will be suppressed too.

Actual new line character is only appended if and when text is appended appended and it did not contain a new line as the last character

Specified by:

lineIf in interface FormattingAppendable

Parameters:

lineRef - predicate storage for conditionalFormatter suppressed new line condition

Returns:

this

blankLine

public FormattingAppendable blankLine()

Description copied from interface: FormattingAppendable

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

Actual blank line characters are only appended if there is real data appended and it did not contain a blank line as the last part of its text

Specified by:

blankLine in interface FormattingAppendable

Returns:

this

blankLineIf

public FormattingAppendable blankLineIf(boolean predicate)

Description copied from interface: FormattingAppendable

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

Actual blank line characters are only appended if and when there text is appended appended and it did not contain a blank line as the last part of its text

Specified by:

blankLineIf in interface FormattingAppendable

Parameters:

predicate - when true append blank line

Returns:

this

blankLine

public FormattingAppendable blankLine(int count)

Description copied from interface: FormattingAppendable

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.

On real data being appended, will append enough new lines to ensure that there are given number of blank lines between previous append and the next one.

Actual blank line characters are only appended if there is real data appended and it did not contain a blank line as the last part of its text

Specified by:

blankLine in interface FormattingAppendable

Parameters:

count - number of blank lines to append

Returns:

this

getIndent

public int getIndent()

Description copied from interface: FormattingAppendable

Get the current indent level + indent offset

Specified by:

getIndent in interface FormattingAppendable

Returns:

indent level

setIndentOffset

public FormattingAppendable setIndentOffset(int indentOffset)

Description copied from interface: FormattingAppendable

Set the current indent level. Not for indenting use. This does not do any calls or validation. Intended use is to set initial indent

Specified by:

setIndentOffset in interface FormattingAppendable

Parameters:

indentOffset - minimum indent that will be used

Returns:

this

indent

public FormattingAppendable indent()

Description copied from interface: FormattingAppendable

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

Specified by:

indent in interface FormattingAppendable

Returns:

this

willIndent

public FormattingAppendable willIndent()

Description copied from interface: FormattingAppendable

Notify of the fact that after some appending some text, there will be an indent() call so that conditional formatting can kick in before the text is appended

Specified by:

willIndent in interface FormattingAppendable

Returns:

this

unIndent

public FormattingAppendable unIndent()

Description copied from interface: FormattingAppendable

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

Specified by:

unIndent in interface FormattingAppendable

Returns:

this

getModCount

public int getModCount()

Description copied from interface: FormattingAppendable

Get the modification count. Incremented every time there is actual text appended

Specified by:

getModCount in interface FormattingAppendable

Returns:

modification count

getLineCount

public int getLineCount()

Description copied from interface: FormattingAppendable

Get the number of lines appended, does not include pending: EOLs

Specified by:

getLineCount in interface FormattingAppendable

Returns:

number of lines appended

lastOffset

public FormattingAppendable lastOffset(Ref<Integer> refOffset)

Description copied from interface: FormattingAppendable

Get offset before the next append, but right after pending: EOLs, spaces or indents were added Next append of text (non EOL/spaces) will set the reference, following appends will have not effect Unlike FormattingAppendable.lastOffset() flush() does not change the value of the reference, only actual character appending.

Specified by:

lastOffset in interface FormattingAppendable

Parameters:

refOffset - reference where to store offset, if no appending was done then value is not changed

Returns:

this

lastOffset

public int lastOffset()

Description copied from interface: FormattingAppendable

Get offset before the last append, but right after pending: EOLs, spaces or indents were added

Specified by:

lastOffset in interface FormattingAppendable

Returns:

character offset before last append or flush

offset

public int offset()

Description copied from interface: FormattingAppendable

Get offset after last append, does not include any pending: EOLs, spaces nor indents

Specified by:

offset in interface FormattingAppendable

Returns:

character offset after last append or flush

offsetWithPending

public int offsetWithPending()

Description copied from interface: FormattingAppendable

Get offset after last append, include any pending: EOLs, and indents

Specified by:

offsetWithPending in interface FormattingAppendable

Returns:

character offset after last append or flush

column

public int column()

Description copied from interface: FormattingAppendable

Get column offset after last append, does not include any pending: EOLs, spaces nor indents

Specified by:

column in interface FormattingAppendable

Returns:

column offset after last append or flush from previous EOL

columnWith

public int columnWith(CharSequence csq,
                      int start,
                      int end)

Description copied from interface: FormattingAppendable

Get column offset after last append, does not include any pending: EOLs, spaces nor indents

Specified by:

columnWith in interface FormattingAppendable

Parameters:

csq - sequence to use for computation

start - start offset in csq

end - end offset in csq

Returns:

column offset which would result from appending csq

openPreFormatted

public FormattingAppendable openPreFormatted(boolean keepIndent)

Description copied from interface: FormattingAppendable

Open a pre-formatted section. No monitoring of text is done, all text is output as is while nesting count >0

Specified by:

openPreFormatted in interface FormattingAppendable

Parameters:

keepIndent - if true, if there is pending indent it will be appended before entering pre-format mode

Returns:

this

closePreFormatted

public FormattingAppendable closePreFormatted()

Description copied from interface: FormattingAppendable

Close a pre-formatted section. No monitoring of text is done, all text is output as is while nesting count >0

Specified by:

closePreFormatted in interface FormattingAppendable

Returns:

this

isPendingSpace

public boolean isPendingSpace()

Description copied from interface: FormattingAppendable

see if there is a pending space

Specified by:

isPendingSpace in interface FormattingAppendable

Returns:

true if space is pending

getPendingSpace

public int getPendingSpace()

Specified by:

getPendingSpace in interface FormattingAppendable

isPendingEOL

public boolean isPendingEOL()

Description copied from interface: FormattingAppendable

see if there is a pending space

Specified by:

isPendingEOL in interface FormattingAppendable

Returns:

true if space is pending

getPendingEOL

public int getPendingEOL()

Description copied from interface: FormattingAppendable

see if there is a pending space

Specified by:

getPendingEOL in interface FormattingAppendable

Returns:

number of pending EOLs

isPreFormatted

public boolean isPreFormatted()

Specified by:

isPreFormatted in interface FormattingAppendable

Returns:

true if in pre-formatted region

openConditional

public FormattingAppendable openConditional(ConditionalFormatter openFormatter)

Description copied from interface: FormattingAppendable

Open a conditional formatting region.

After opening if and when text is appended the ConditionalFormatter.apply(boolean, boolean, boolean, boolean) will be invoked before appending the text with parameters specifying whether indent or line were invoked before appending text. The onText is always true for opening conditional formatter or the apply() method would not be called

the firstAppend will be set if this is the first call, if onIndent is false on first call then the apply() method will be invoked again if any indent() is performed before the conditional is closed.

Specified by:

openConditional in interface FormattingAppendable

Parameters:

openFormatter - to invoke before text is appended

Returns:

this

closeConditional

public FormattingAppendable closeConditional(ConditionalFormatter closeFormatter)

Description copied from interface: FormattingAppendable

Close a conditional formatting region.

ConditionalFormatter.apply(boolean, boolean, boolean, boolean) will be invoked with parameters specifying whether indent, line or text was appended when FormattingAppendable.openConditional(ConditionalFormatter) invoked before appending text. If onText is false then openFormatter passed to FormattingAppendable.openConditional(ConditionalFormatter) was not invoked.

Specified by:

closeConditional in interface FormattingAppendable

Parameters:

closeFormatter - to invoke with parameters informing with what parameters the openFormatter was invoked, if at all

Returns:

this