aboutsummaryrefslogtreecommitdiffstats
path: root/javaparser-core/src/main/java/com/github/javaparser/printer/PrettyPrinterConfiguration.java
diff options
context:
space:
mode:
Diffstat (limited to 'javaparser-core/src/main/java/com/github/javaparser/printer/PrettyPrinterConfiguration.java')
-rw-r--r--javaparser-core/src/main/java/com/github/javaparser/printer/PrettyPrinterConfiguration.java188
1 files changed, 188 insertions, 0 deletions
diff --git a/javaparser-core/src/main/java/com/github/javaparser/printer/PrettyPrinterConfiguration.java b/javaparser-core/src/main/java/com/github/javaparser/printer/PrettyPrinterConfiguration.java
new file mode 100644
index 000000000..1c650d2ec
--- /dev/null
+++ b/javaparser-core/src/main/java/com/github/javaparser/printer/PrettyPrinterConfiguration.java
@@ -0,0 +1,188 @@
+/*
+ * Copyright (C) 2007-2010 JĂșlio Vilmar Gesser.
+ * Copyright (C) 2011, 2013-2016 The JavaParser Team.
+ *
+ * This file is part of JavaParser.
+ *
+ * JavaParser can be used either under the terms of
+ * a) the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * b) the terms of the Apache License
+ *
+ * You should have received a copy of both licenses in LICENCE.LGPL and
+ * LICENCE.APACHE. Please refer to those files for details.
+ *
+ * JavaParser is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ */
+
+package com.github.javaparser.printer;
+
+import java.util.function.Function;
+
+import static com.github.javaparser.utils.Utils.EOL;
+import static com.github.javaparser.utils.Utils.assertNotNull;
+
+/**
+ * Configuration options for the {@link PrettyPrinter}.
+ */
+public class PrettyPrinterConfiguration {
+ public static final int DEFAULT_MAX_ENUM_CONSTANTS_TO_ALIGN_HORIZONTALLY = 5;
+
+ private boolean orderImports = false;
+ private boolean printComments = true;
+ private boolean printJavadoc = true;
+ private boolean columnAlignParameters = false;
+ private boolean columnAlignFirstMethodChain = false;
+ private String indent = " ";
+ private String endOfLineCharacter = EOL;
+ private Function<PrettyPrinterConfiguration, PrettyPrintVisitor> visitorFactory = PrettyPrintVisitor::new;
+ private int maxEnumConstantsToAlignHorizontally = DEFAULT_MAX_ENUM_CONSTANTS_TO_ALIGN_HORIZONTALLY;
+
+ public String getIndent() {
+ return indent;
+ }
+
+ /**
+ * Set the string to use for indenting. For example: "\t", " ", "".
+ */
+ public PrettyPrinterConfiguration setIndent(String indent) {
+ this.indent = assertNotNull(indent);
+ return this;
+ }
+
+ public boolean isOrderImports() {
+ return orderImports;
+ }
+
+ /**
+ * @deprecated this is always on.
+ */
+ @Deprecated
+ public boolean isNormalizeEolInComment() {
+ return true;
+ }
+
+ /**
+ * @deprecated this is always on.
+ */
+ @Deprecated
+ public PrettyPrinterConfiguration setNormalizeEolInComment(boolean normalizeEolInComment) {
+ return this;
+ }
+
+ public boolean isPrintComments() {
+ return printComments;
+ }
+
+ public boolean isIgnoreComments() {
+ return !printComments;
+ }
+
+ public boolean isPrintJavadoc() {
+ return printJavadoc;
+ }
+
+ public boolean isColumnAlignParameters() {
+ return columnAlignParameters;
+ }
+
+ public boolean isColumnAlignFirstMethodChain() {
+ return columnAlignFirstMethodChain;
+ }
+
+ /**
+ * When true, all comments will be printed, unless printJavadoc is false, then only line and block comments will be
+ * printed.
+ */
+ public PrettyPrinterConfiguration setPrintComments(boolean printComments) {
+ this.printComments = printComments;
+ return this;
+ }
+
+ /**
+ * When true, Javadoc will be printed.
+ */
+ public PrettyPrinterConfiguration setPrintJavadoc(boolean printJavadoc) {
+ this.printJavadoc = printJavadoc;
+ return this;
+ }
+
+ public PrettyPrinterConfiguration setColumnAlignParameters(boolean columnAlignParameters) {
+ this.columnAlignParameters = columnAlignParameters;
+ return this;
+ }
+
+ public PrettyPrinterConfiguration setColumnAlignFirstMethodChain(boolean columnAlignFirstMethodChain) {
+ this.columnAlignFirstMethodChain = columnAlignFirstMethodChain;
+ return this;
+ }
+
+ public Function<PrettyPrinterConfiguration, PrettyPrintVisitor> getVisitorFactory() {
+ return visitorFactory;
+ }
+
+ /**
+ * Set the factory that creates the PrettyPrintVisitor. By changing this you can make the PrettyPrinter use a custom
+ * PrettyPrinterVisitor.
+ */
+ public PrettyPrinterConfiguration setVisitorFactory(Function<PrettyPrinterConfiguration, PrettyPrintVisitor> visitorFactory) {
+ this.visitorFactory = assertNotNull(visitorFactory);
+ return this;
+ }
+
+ public String getEndOfLineCharacter() {
+ return endOfLineCharacter;
+ }
+
+ /**
+ * Set the character to append when a line should end. Example values: "\n", "\r\n", "".
+ */
+ public PrettyPrinterConfiguration setEndOfLineCharacter(String endOfLineCharacter) {
+ this.endOfLineCharacter = assertNotNull(endOfLineCharacter);
+ return this;
+ }
+
+ /**
+ * When true, orders imports by alphabetically.
+ */
+ public PrettyPrinterConfiguration setOrderImports(boolean orderImports) {
+ this.orderImports = orderImports;
+ return this;
+ }
+
+ public int getMaxEnumConstantsToAlignHorizontally() {
+ return maxEnumConstantsToAlignHorizontally;
+ }
+
+ /**
+ * By default enum constants get aligned like this:
+ * <pre>
+ * enum X {
+ * A, B, C, D
+ * }
+ * </pre>
+ * until the amount of constants passes this value (5 by default).
+ * Then they get aligned like this:
+ * <pre>
+ * enum X {
+ * A,
+ * B,
+ * C,
+ * D,
+ * E,
+ * F,
+ * G
+ * }
+ * </pre>
+ * Set it to a large number to always align horizontally.
+ * Set it to 1 or less to always align vertically.
+ */
+ public PrettyPrinterConfiguration setMaxEnumConstantsToAlignHorizontally(int maxEnumConstantsToAlignHorizontally) {
+ this.maxEnumConstantsToAlignHorizontally = maxEnumConstantsToAlignHorizontally;
+ return this;
+ }
+}