Package io.spring.javaformat.gradle.tasks

Class FormatterTask

  • All Implemented Interfaces:
    java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.util.Configurable<org.gradle.api.Task>
    Direct Known Subclasses:
    CheckFormat, Format
    public abstract class FormatterTask
extends org.gradle.api.tasks.SourceTask
    Abstract base class for formatter tasks.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.gradle.api.Task

        org.gradle.api.Task.Namer

    • Field Summary

      • Fields inherited from interface org.gradle.api.Task

        TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.util.stream.Stream<io.spring.javaformat.formatter.FileEdit> formatFiles()
      Format the source files and provide a Stream of FileEdit instances.
      java.lang.String getEncoding()
      Get the file encoding in use.
      org.gradle.api.provider.Property<io.spring.javaformat.config.IndentationStyle> getIndentationStyle()
      The indentation style used for formatting.
      org.gradle.api.provider.Property<io.spring.javaformat.config.JavaBaseline> getJavaBaseline()
      The Java baseline used for formatting.
      org.gradle.api.file.FileTree getSource()  
      void setEncoding​(java.lang.String encoding)
      Set the file encoding in use.

      • Methods inherited from class org.gradle.api.tasks.SourceTask

        exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, source

      • Methods inherited from class org.gradle.api.internal.ConventionTask

        conventionMapping, conventionMapping, getConventionMapping

      • Methods inherited from class org.gradle.api.DefaultTask

        compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

      • Methods inherited from class org.gradle.api.internal.AbstractTask

        appendParallelSafeAction, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, prependParallelSafeAction, replaceLogger, setImpliesSubProjects

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.gradle.api.Task

        getConvention

    • Method Detail

      • getEncoding

        @Input
@Optional
public java.lang.String getEncoding()
        Get the file encoding in use.
        Returns:
        the encoding the file encoding

      • setEncoding

        public void setEncoding​(java.lang.String encoding)
        Set the file encoding in use.
        Parameters:
        encoding - the encoding to set

      • getIndentationStyle

        @Input
public org.gradle.api.provider.Property<io.spring.javaformat.config.IndentationStyle> getIndentationStyle()
        The indentation style used for formatting.
        Returns:
        the indentation style

      • getJavaBaseline

        @Input
public org.gradle.api.provider.Property<io.spring.javaformat.config.JavaBaseline> getJavaBaseline()
        The Java baseline used for formatting.
        Returns:
        the Java baseline

      • getSource

        @InputFiles
@PathSensitive(RELATIVE)
public org.gradle.api.file.FileTree getSource()
        Overrides:
        getSource in class org.gradle.api.tasks.SourceTask

      • formatFiles

        protected final java.util.stream.Stream<io.spring.javaformat.formatter.FileEdit> formatFiles()
        Format the source files and provide a Stream of FileEdit instances.
        Returns:
        the file edits