Class FormatJTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
zone.rong.formatj.gradle.FormatJTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@CacheableTask public abstract class FormatJTask extends org.gradle.api.DefaultTask
Formats or checks a set of Java sources.

Incremental by file: only sources Gradle reports as changed are re-formatted, and every rule is an input, so changing one option invalidates the results rather than leaving stale output behind.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.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

  • Constructor Summary

    Constructors
    Constructor
    Description
    FormatJTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute(org.gradle.work.InputChanges changes)
     
    abstract org.gradle.api.provider.Property<Boolean>
    getCheckOnly()
    When true the task reports files that would change instead of rewriting them.
    abstract org.gradle.api.provider.Property<zone.rong.formatj.api.LanguageLevel>
    getLanguageLevel()
     
    abstract org.gradle.api.file.RegularFileProperty
    getMarkerFile()
    A marker written when the task completes.
    abstract org.gradle.api.provider.Property<zone.rong.formatj.api.Preset>
    getPreset()
     
    abstract org.gradle.api.provider.Property<Boolean>
    getPreviewFeatures()
     
    abstract org.gradle.api.provider.MapProperty<String,String>
    getRules()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getSource()
    The Java sources to process.
    abstract org.gradle.api.file.RegularFileProperty
    getStyleFile()
    Style file applied on top of the preset.

    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, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

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

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • FormatJTask

      public FormatJTask()

  • Method Details

    • getSource

      @InputFiles @Incremental @IgnoreEmptyDirectories @PathSensitive(RELATIVE) public abstract org.gradle.api.file.ConfigurableFileCollection getSource()
      The Java sources to process.

    • getStyleFile

      @InputFiles @Optional @PathSensitive(NONE) public abstract org.gradle.api.file.RegularFileProperty getStyleFile()
      Style file applied on top of the preset.

    • getPreset

      @Input @Optional public abstract org.gradle.api.provider.Property<zone.rong.formatj.api.Preset> getPreset()

    • getRules

      @Input public abstract org.gradle.api.provider.MapProperty<String,String> getRules()

    • getLanguageLevel

      @Input public abstract org.gradle.api.provider.Property<zone.rong.formatj.api.LanguageLevel> getLanguageLevel()

    • getPreviewFeatures

      @Input public abstract org.gradle.api.provider.Property<Boolean> getPreviewFeatures()

    • getCheckOnly

      @Input public abstract org.gradle.api.provider.Property<Boolean> getCheckOnly()
      When true the task reports files that would change instead of rewriting them.

    • getMarkerFile

      @OutputFile public abstract org.gradle.api.file.RegularFileProperty getMarkerFile()
      A marker written when the task completes.

      Formatting rewrites its own inputs and produces no other output, but Gradle needs an output to track incremental state against, so the task declares this one.

    • execute

      public void execute(org.gradle.work.InputChanges changes)