Package com.diffplug.spotless.java

Class PalantirJavaFormatStep

java.lang.Object

com.diffplug.spotless.java.PalantirJavaFormatStep

public class PalantirJavaFormatStep
extends java.lang.Object

Wraps up palantir-java-format fork of google-java-format as a FormatterStep.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	MAVEN_COORDINATE

Method Summary

Modifier and Type	Method	Description
static FormatterStep	create(Provisioner provisioner)	Creates a step which formats everything - code, import order, and unused imports.
static FormatterStep	create(java.lang.String version, Provisioner provisioner)	Creates a step which formats everything - code, import order, and unused imports.
static FormatterStep	create(java.lang.String version, java.lang.String style, boolean formatJavadoc, Provisioner provisioner)	Creates a step which formats everything - code, import order, unused imports, and Java docs.
static FormatterStep	create(java.lang.String version, java.lang.String style, Provisioner provisioner)	Creates a step which formats code, import order, and unused imports, but not Java docs.
static boolean	defaultFormatJavadoc()	Get default for whether Java docs should be formatted
static java.lang.String	defaultStyle()	Get default style
static java.lang.String	defaultVersion()	Get default formatter version

Methods inherited from class java.lang.Object

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

Field Detail

MAVEN_COORDINATE

public static final java.lang.String MAVEN_COORDINATE

See Also:

Constant Field Values

Method Detail

create

public static FormatterStep create(Provisioner provisioner)

Creates a step which formats everything - code, import order, and unused imports.

create

public static FormatterStep create(java.lang.String version,
                                   Provisioner provisioner)

Creates a step which formats everything - code, import order, and unused imports.

create

public static FormatterStep create(java.lang.String version,
                                   java.lang.String style,
                                   Provisioner provisioner)

Creates a step which formats code, import order, and unused imports, but not Java docs. And with the given format style.

create

public static FormatterStep create(java.lang.String version,
                                   java.lang.String style,
                                   boolean formatJavadoc,
                                   Provisioner provisioner)

Creates a step which formats everything - code, import order, unused imports, and Java docs. And with the given format style.

defaultVersion

public static java.lang.String defaultVersion()

Get default formatter version

defaultStyle

public static java.lang.String defaultStyle()

Get default style

defaultFormatJavadoc

public static boolean defaultFormatJavadoc()

Get default for whether Java docs should be formatted