Package io.spring.javaformat.gradle

Class CheckTask

  • 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>
    @CacheableTask
public class CheckTask
extends org.gradle.api.tasks.SourceTask
    FormatterTask to check formatting.

    • Nested Class Summary

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

        org.gradle.api.Task.Namer

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DESCRIPTION
      The description of the task.
      static java.lang.String NAME
      The name of the task.

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      CheckTask()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void checkFormatting()  
      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.
      java.io.File getReportLocation()  
      org.gradle.api.file.FileTree getSource()  
      void setEncoding​(java.lang.String encoding)
      Set the file encoding in use.
      void setReportLocation​(java.io.File reportLocation)  

      • 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

    • Field Detail

      • DESCRIPTION

        public static final java.lang.String DESCRIPTION
        The description of the task.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CheckTask

        public CheckTask()

    • Method Detail

      • checkFormatting

        public void checkFormatting()
                     throws java.io.IOException,
                            java.lang.InterruptedException
        Throws:
        java.io.IOException
        java.lang.InterruptedException

      • getSource

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

      • getReportLocation

        @OutputFile
public java.io.File getReportLocation()

      • setReportLocation

        public void setReportLocation​(java.io.File reportLocation)

      • 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

      • 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