javaparser-parent 3.14.14 · com.github.javaparser.printer.SourcePrinter

Modifier and Type	Field and Description
private final StringBuilder	buf
private Position	cursor
private final String	endOfLineCharacter
private final String	indentation
private boolean	indented
private final Deque<String>	indents
private final PrettyPrinterConfiguration.IndentType	indentType
private String	lastPrintedIndent
private final Deque<String>	reindentedIndents
private final int	tabWidth

Access	Constructor and Description
pack-priv	SourcePrinter()
pack-priv	SourcePrinter(final PrettyPrinterConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
private void	append(String arg)
private String	calculateIndentWithAlignTo(int column)
public void	duplicateIndent() Adds an indent to the top of the stack that is a copy of the current top indent.
public Position	Returns: the current cursor position (line, column). getCursor() Return the current cursor position (line, column) in the source printer buffer.
public String	Returns: the currently printed source code. getSource() Deprecated use toString()
public SourcePrinter	indent() Add the default indentation to the current indentation and push it on the indentation stack.
public SourcePrinter	indentWithAlignTo(int column) Add to the current indentation until it is reaches "column" and push it on the indentation stack.
public String	normalizeEolInTextBlock(String content) Changes all EOL characters in "content" to the EOL character this SourcePrinter is using.
public SourcePrinter	Returns: this instance, for nesting calls to method as fluent interface print(final String source line to be printed (should not contain newline/carriage-return characters) arg) Append the source string passed as argument to the buffer.
public SourcePrinter	Returns: this instance, for nesting calls to method as fluent interface println(final String source line to be printed (should not contain newline/carriage-return characters) arg) Append the source string passed as argument to the buffer, then append a newline.
public SourcePrinter	Returns: this instance, for nesting calls to method as fluent interface println() Append a newline to the buffer.
public void	reindentToPreviousLevel() Set the top-most indent to the column the cursor was before the last `reindentWithAlignToCursor()` call.
public void	reindentWithAlignToCursor() Set the top-most indent to the column the cursor is currently in, can be undone with `reindentToPreviousLevel()`.
public String	Returns: the currently printed source code. toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public SourcePrinter	unindent() Pop the last indentation of the indentation stack.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

buf	back to summary
private final StringBuilder buf

cursor	back to summary
private Position cursor

endOfLineCharacter	back to summary
private final String endOfLineCharacter

indentation	back to summary
private final String indentation

indented	back to summary
private boolean indented

indents	back to summary
private final Deque<String> indents

indentType	back to summary
private final PrettyPrinterConfiguration.IndentType indentType

lastPrintedIndent	back to summary
private String lastPrintedIndent

reindentedIndents	back to summary
private final Deque<String> reindentedIndents

tabWidth	back to summary
private final int tabWidth

SourcePrinter	back to summary
pack-priv SourcePrinter()

SourcePrinter	back to summary
pack-priv SourcePrinter(final PrettyPrinterConfiguration configuration)

Method Detail

append	back to summary
private void append(String arg)

calculateIndentWithAlignTo	back to summary
private String calculateIndentWithAlignTo(int column)

duplicateIndent	back to summary
public void duplicateIndent() Adds an indent to the top of the stack that is a copy of the current top indent. With this you announce "I'm going to indent the next line(s)" but not how far yet. Once you do know, you can pop this indent ("unindent") and indent to the right column. (Does not actually output anything.)

getCursor back to summary

getCursor	back to summary
public Position getCursor() Return the current cursor position (line, column) in the source printer buffer. Please notice in order to guarantee a correct computation of the cursor position, this printer expect the contracts of the methods `print(String)` and `println(String)` has been respected through all method calls, meaning the source string passed as argument to those method calls did not contain newline/carriage-return characters. Returns:Position the current cursor position (line, column).

public Position getCursor()

Return the current cursor position (line, column) in the source printer buffer.

Please notice in order to guarantee a correct computation of the cursor position, this printer expect the contracts of the methods print(String) and println(String) has been respected through all method calls, meaning the source string passed as argument to those method calls did not contain newline/carriage-return characters.

Returns:Position: the current cursor position (line, column).

getSource	back to summary
public String getSource() Deprecated use toString() Returns:String the currently printed source code. Annotations @Deprecated

indent	back to summary
public SourcePrinter indent() Add the default indentation to the current indentation and push it on the indentation stack. Does not actually output anything.

indentWithAlignTo	back to summary
public SourcePrinter indentWithAlignTo(int column) Add to the current indentation until it is reaches "column" and push it on the indentation stack. Does not actually output anything.

normalizeEolInTextBlock	back to summary
public String normalizeEolInTextBlock(String content) Changes all EOL characters in "content" to the EOL character this SourcePrinter is using.

print back to summary

print	back to summary
public SourcePrinter print(final String arg) Append the source string passed as argument to the buffer. If this is being appended at the beginning of a line, performs indentation first. The source line to be printed should not contain newline/carriage-return characters; use `println(String)` to automatically append a newline at the end of the source string. If the source line passed as argument contains newline/carriage-return characters would impredictably affect a correct computation of the current `getCursor()` position. Parameters arg:String source line to be printed (should not contain newline/carriage-return characters) Returns:SourcePrinter this instance, for nesting calls to method as fluent interface See Also `SourcePrinter#println(String)`

public SourcePrinter print(final String arg)

Append the source string passed as argument to the buffer. If this is being appended at the beginning of a line, performs indentation first.

The source line to be printed should not contain newline/carriage-return characters; use println(String) to automatically append a newline at the end of the source string. If the source line passed as argument contains newline/carriage-return characters would impredictably affect a correct computation of the current getCursor() position.

Parameters

arg:String: source line to be printed (should not contain newline/carriage-return characters)

Returns:SourcePrinter

this instance, for nesting calls to method as fluent interface

See Also

SourcePrinter#println(String)

println back to summary

println	back to summary
public SourcePrinter println(final String arg) Append the source string passed as argument to the buffer, then append a newline. If this is being appended at the beginning of a line, performs indentation first. The source line to be printed should not contain newline/carriage-return characters. If the source line passed as argument contains newline/carriage-return characters would impredictably affect a correct computation of the current `getCursor()` position. Parameters arg:String source line to be printed (should not contain newline/carriage-return characters) Returns:SourcePrinter this instance, for nesting calls to method as fluent interface

public SourcePrinter println(final String arg)

Append the source string passed as argument to the buffer, then append a newline. If this is being appended at the beginning of a line, performs indentation first.

The source line to be printed should not contain newline/carriage-return characters. If the source line passed as argument contains newline/carriage-return characters would impredictably affect a correct computation of the current getCursor() position.

Parameters

arg:String: source line to be printed (should not contain newline/carriage-return characters)

Returns:SourcePrinter

this instance, for nesting calls to method as fluent interface

println	back to summary
public SourcePrinter println() Append a newline to the buffer. Returns:SourcePrinter this instance, for nesting calls to method as fluent interface

println

back to summary

public SourcePrinter println()

Append a newline to the buffer.

Returns:SourcePrinter: this instance, for nesting calls to method as fluent interface

reindentToPreviousLevel	back to summary
public void reindentToPreviousLevel() Set the top-most indent to the column the cursor was before the last `reindentWithAlignToCursor()` call. Does not actually output anything.

reindentWithAlignToCursor	back to summary
public void reindentWithAlignToCursor() Set the top-most indent to the column the cursor is currently in, can be undone with `reindentToPreviousLevel()`. Does not actually output anything.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String the currently printed source code. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

the currently printed source code.

Annotations