Package com.diffplug.spotless.java

Class GoogleJavaFormatStep

  • public class GoogleJavaFormatStep
extends java.lang.Object
    Wraps up google-java-format as a FormatterStep.

    • Field Summary

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

    • Method Summary

      All Methods Static Methods Concrete Methods 
      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, 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, Provisioner provisioner, boolean reflowLongStrings)
      Creates a step which formats everything - code, import order, and unused imports - and optionally reflows long strings.
      static FormatterStep create​(java.lang.String groupArtifact, java.lang.String version, java.lang.String style, Provisioner provisioner, boolean reflowLongStrings)  
      static FormatterStep create​(java.lang.String groupArtifact, java.lang.String version, java.lang.String style, Provisioner provisioner, boolean reflowLongStrings, boolean reorderImports)  
      static FormatterStep create​(java.lang.String groupArtifact, java.lang.String version, java.lang.String style, Provisioner provisioner, boolean reflowLongStrings, boolean reorderImports, boolean formatJavadoc)
      Creates a step which formats everything - groupArtifact, code, import order, and unused imports - and optionally reflows long strings.
      static boolean defaultFormatJavadoc()  
      static java.lang.String defaultGroupArtifact()  
      static boolean defaultReflowLongStrings()  
      static boolean defaultReorderImports()  
      static java.lang.String defaultStyle()  
      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 everything - code, import order, and unused imports.

      • create

        public static FormatterStep create​(java.lang.String version,
                                   java.lang.String style,
                                   Provisioner provisioner,
                                   boolean reflowLongStrings)
        Creates a step which formats everything - code, import order, and unused imports - and optionally reflows long strings.

      • create

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

      • create

        public static FormatterStep create​(java.lang.String groupArtifact,
                                   java.lang.String version,
                                   java.lang.String style,
                                   Provisioner provisioner,
                                   boolean reflowLongStrings,
                                   boolean reorderImports)

      • create

        public static FormatterStep create​(java.lang.String groupArtifact,
                                   java.lang.String version,
                                   java.lang.String style,
                                   Provisioner provisioner,
                                   boolean reflowLongStrings,
                                   boolean reorderImports,
                                   boolean formatJavadoc)
        Creates a step which formats everything - groupArtifact, code, import order, and unused imports - and optionally reflows long strings.

      • defaultGroupArtifact

        public static java.lang.String defaultGroupArtifact()

      • defaultVersion

        public static java.lang.String defaultVersion()
        Get default formatter version

      • defaultStyle

        public static java.lang.String defaultStyle()

      • defaultReflowLongStrings

        public static boolean defaultReflowLongStrings()

      • defaultReorderImports

        public static boolean defaultReorderImports()

      • defaultFormatJavadoc

        public static boolean defaultFormatJavadoc()