Modifier and Type	Class and Description
public static enum	PrettyPrinterConfiguration.IndentType

Modifier and Type	Field and Description
private boolean	columnAlignFirstMethodChain
private boolean	columnAlignParameters
public static final int	DEFAULT_MAX_ENUM_CONSTANTS_TO_ALIGN_HORIZONTALLY
private String	endOfLineCharacter
private int	indentSize
private PrettyPrinterConfiguration.IndentType	indentType
private int	maxEnumConstantsToAlignHorizontally
private boolean	orderImports
private boolean	printComments
private boolean	printJavadoc
private int	tabWidth
private Function<PrettyPrinterConfiguration, VoidVisitor<Void>>	visitorFactory

Access	Constructor and Description
public	PrettyPrinterConfiguration()

Method Summary

Modifier and Type	Method and Description
public String	getEndOfLineCharacter()
public String	Returns: the string that will be used to indent. getIndent()
public int	getIndentSize()
public PrettyPrinterConfiguration.IndentType	getIndentType() Get the type of indent to produce.
public int	getMaxEnumConstantsToAlignHorizontally()
public int	getTabWidth() Get the tab width for pretty aligning.
public Function<PrettyPrinterConfiguration, VoidVisitor<Void>>	getVisitorFactory()
public boolean	isColumnAlignFirstMethodChain()
public boolean	isColumnAlignParameters()
public boolean	isIgnoreComments()
public boolean	isOrderImports()
public boolean	isPrintComments()
public boolean	isPrintJavadoc()
public PrettyPrinterConfiguration	setColumnAlignFirstMethodChain(boolean columnAlignFirstMethodChain)
public PrettyPrinterConfiguration	setColumnAlignParameters(boolean columnAlignParameters)
public PrettyPrinterConfiguration	setEndOfLineCharacter(String endOfLineCharacter) Set the character to append when a line should end.
public PrettyPrinterConfiguration	setIndentSize(int indentSize) Set the size of the indent in characters.
public PrettyPrinterConfiguration	setIndentType(PrettyPrinterConfiguration.IndentType indentType) Set the type of indent to produce.
public PrettyPrinterConfiguration	setMaxEnumConstantsToAlignHorizontally(int maxEnumConstantsToAlignHorizontally) By default enum constants get aligned like this: enum X { A, B, C, D }
public PrettyPrinterConfiguration	setOrderImports(boolean orderImports) When true, orders imports by alphabetically.
public PrettyPrinterConfiguration	setPrintComments(boolean printComments) When true, all comments will be printed, unless printJavadoc is false, then only line and block comments will be printed.
public PrettyPrinterConfiguration	setPrintJavadoc(boolean printJavadoc) When true, Javadoc will be printed.
public PrettyPrinterConfiguration	setTabWidth(int tabWidth) Set the tab width for pretty aligning.
public PrettyPrinterConfiguration	setVisitorFactory(Function<PrettyPrinterConfiguration, VoidVisitor<Void>> visitorFactory) Set the factory that creates the PrettyPrintVisitor.

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

Field Detail

columnAlignFirstMethodChain	back to summary
private boolean columnAlignFirstMethodChain

columnAlignParameters	back to summary
private boolean columnAlignParameters

DEFAULT_MAX_ENUM_CONSTANTS_TO_ALIGN_HORIZONTALLY	back to summary
public static final int DEFAULT_MAX_ENUM_CONSTANTS_TO_ALIGN_HORIZONTALLY

endOfLineCharacter	back to summary
private String endOfLineCharacter

indentSize	back to summary
private int indentSize

indentType	back to summary
private PrettyPrinterConfiguration.IndentType indentType

maxEnumConstantsToAlignHorizontally	back to summary
private int maxEnumConstantsToAlignHorizontally

orderImports	back to summary
private boolean orderImports

printComments	back to summary
private boolean printComments

printJavadoc	back to summary
private boolean printJavadoc

tabWidth	back to summary
private int tabWidth

visitorFactory	back to summary
private Function<PrettyPrinterConfiguration, VoidVisitor<Void>> visitorFactory

Constructor Detail

PrettyPrinterConfiguration	back to summary
public PrettyPrinterConfiguration()

Method Detail

getEndOfLineCharacter	back to summary
public String getEndOfLineCharacter()

getIndent	back to summary
public String getIndent() Returns:String the string that will be used to indent.

getIndentSize	back to summary
public int getIndentSize()

getIndentType	back to summary
public PrettyPrinterConfiguration.IndentType getIndentType() Get the type of indent to produce.

getMaxEnumConstantsToAlignHorizontally	back to summary
public int getMaxEnumConstantsToAlignHorizontally()

getTabWidth	back to summary
public int getTabWidth() Get the tab width for pretty aligning.

getVisitorFactory	back to summary
public Function<PrettyPrinterConfiguration, VoidVisitor<Void>> getVisitorFactory()

isColumnAlignFirstMethodChain	back to summary
public boolean isColumnAlignFirstMethodChain()

isColumnAlignParameters	back to summary
public boolean isColumnAlignParameters()

isIgnoreComments	back to summary
public boolean isIgnoreComments()

isOrderImports	back to summary
public boolean isOrderImports()

isPrintComments	back to summary
public boolean isPrintComments()

isPrintJavadoc	back to summary
public boolean isPrintJavadoc()

setColumnAlignFirstMethodChain	back to summary
public PrettyPrinterConfiguration setColumnAlignFirstMethodChain(boolean columnAlignFirstMethodChain)

setColumnAlignParameters	back to summary
public PrettyPrinterConfiguration setColumnAlignParameters(boolean columnAlignParameters)

setEndOfLineCharacter	back to summary
public PrettyPrinterConfiguration setEndOfLineCharacter(String endOfLineCharacter) Set the character to append when a line should end. Example values: "\n", "\r\n", "".

setIndentSize	back to summary
public PrettyPrinterConfiguration setIndentSize(int indentSize) Set the size of the indent in characters.

setIndentType	back to summary
public PrettyPrinterConfiguration setIndentType(PrettyPrinterConfiguration.IndentType indentType) Set the type of indent to produce.

setMaxEnumConstantsToAlignHorizontally	back to summary
public PrettyPrinterConfiguration setMaxEnumConstantsToAlignHorizontally(int maxEnumConstantsToAlignHorizontally) By default enum constants get aligned like this: enum X { A, B, C, D } until the amount of constants passes this value (5 by default). Then they get aligned like this: enum X { A, B, C, D, E, F, G } Set it to a large number to always align horizontally. Set it to 1 or less to always align vertically.

setMaxEnumConstantsToAlignHorizontally

back to summary

public PrettyPrinterConfiguration setMaxEnumConstantsToAlignHorizontally(int maxEnumConstantsToAlignHorizontally)

By default enum constants get aligned like this:

    enum X {
       A, B, C, D
    }

until the amount of constants passes this value (5 by default). Then they get aligned like this:

    enum X {
       A,
       B,
       C,
       D,
       E,
       F,
       G
    }

Set it to a large number to always align horizontally. Set it to 1 or less to always align vertically.

setOrderImports	back to summary
public PrettyPrinterConfiguration setOrderImports(boolean orderImports) When true, orders imports by alphabetically.

setPrintComments	back to summary
public PrettyPrinterConfiguration setPrintComments(boolean printComments) When true, all comments will be printed, unless printJavadoc is false, then only line and block comments will be printed.

setPrintJavadoc	back to summary
public PrettyPrinterConfiguration setPrintJavadoc(boolean printJavadoc) When true, Javadoc will be printed.

setTabWidth	back to summary
public PrettyPrinterConfiguration setTabWidth(int tabWidth) Set the tab width for pretty aligning.

setVisitorFactory	back to summary
public PrettyPrinterConfiguration setVisitorFactory(Function<PrettyPrinterConfiguration, VoidVisitor<Void>> visitorFactory) Set the factory that creates the PrettyPrintVisitor. By changing this you can make the PrettyPrinter use a custom PrettyPrinterVisitor.

com.github.javaparser.printer back to summary

public final Enum PrettyPrinterConfiguration.IndentType

Class Inheritance

extends Enum<PrettyPrinterConfiguration.IndentType>

java.lang.Object
java.lang.Enum
com.github.javaparser.printer.PrettyPrinterConfiguration.IndentType

Field Summary

Modifier and Type	Field and Description
public static final PrettyPrinterConfiguration.IndentType	SPACES Indent with spaces.
public static final PrettyPrinterConfiguration.IndentType	TABS Indent with tabs as far as possible.
public static final PrettyPrinterConfiguration.IndentType	TABS_WITH_SPACE_ALIGN Indent with tabs but align with spaces when wrapping and aligning method call chains and method call parameters.

Constructor Summary

Access	Constructor and Description
private	IndentType()

Method Summary

Modifier and Type	Method and Description
public static PrettyPrinterConfiguration.IndentType	valueOf(String name)
public static PrettyPrinterConfiguration.IndentType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

SPACES	back to summary
public static final PrettyPrinterConfiguration.IndentType SPACES Indent with spaces.

TABS	back to summary
public static final PrettyPrinterConfiguration.IndentType TABS Indent with tabs as far as possible. For proper aligning, the tab width is necessary and by default 4.

TABS_WITH_SPACE_ALIGN	back to summary
public static final PrettyPrinterConfiguration.IndentType TABS_WITH_SPACE_ALIGN Indent with tabs but align with spaces when wrapping and aligning method call chains and method call parameters. Example result: class Foo { \tvoid bar() { \t\tfoo().bar() \t\t......baz(() -> { \t\t..........\tboo().baa() \t\t..........\t......bee(a, \t\t..........\t..........b, \t\t..........\t..........c); \t\t..........}) \t\t......bam(); \t} }

TABS_WITH_SPACE_ALIGN

back to summary

public static final PrettyPrinterConfiguration.IndentType TABS_WITH_SPACE_ALIGN

Indent with tabs but align with spaces when wrapping and aligning method call chains and method call parameters.

Example result:

class Foo {

\tvoid bar() {
\t\tfoo().bar()
\t\t......baz(() -> {
\t\t..........\tboo().baa()
\t\t..........\t......bee(a,
\t\t..........\t..........b,
\t\t..........\t..........c);
\t\t..........})
\t\t......bam();
\t}
}

Constructor Detail

IndentType	back to summary
private IndentType()

Method Detail

valueOf	back to summary
public static PrettyPrinterConfiguration.IndentType valueOf(String name)

values	back to summary
public static PrettyPrinterConfiguration.IndentType[] values()

public Class PrettyPrinterConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum PrettyPrinterConfiguration.IndentType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail