Package com.github.larseckart.objectcalisthenics.gradle

Class ObjectCalisthenicsReportTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.github.larseckart.objectcalisthenics.gradle.ObjectCalisthenicsReportTask
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 ObjectCalisthenicsReportTask extends org.gradle.api.DefaultTask
Gradle task that analyses Java source and writes a JSON report.

Unlike ObjectCalisthenicsCheckTask, this task never fails the build, so it can be used to inspect the current state of a legacy codebase.

  • 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
    ObjectCalisthenicsReportTask(org.gradle.api.file.ProjectLayout projectLayout)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.ListProperty<String>
    getClassNamePatterns()
     
    abstract org.gradle.api.provider.Property<Boolean>
    getConsoleSummary()
     
    abstract org.gradle.api.file.RegularFileProperty
    getJson()
     
    abstract org.gradle.api.file.DirectoryProperty
    getProjectDirectory()
     
    abstract ObjectCalisthenicsRules
    getRules()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getSourceFiles()
     
    void
    report()
     

    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, getLoggingManager, 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 java.lang.Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • ObjectCalisthenicsReportTask

      @Inject public ObjectCalisthenicsReportTask(org.gradle.api.file.ProjectLayout projectLayout)

  • Method Details

    • getSourceFiles

      @InputFiles @SkipWhenEmpty @PathSensitive(RELATIVE) public abstract org.gradle.api.file.ConfigurableFileCollection getSourceFiles()

    • getRules

      public abstract ObjectCalisthenicsRules getRules()

    • getClassNamePatterns

      @Input public abstract org.gradle.api.provider.ListProperty<String> getClassNamePatterns()

    • getJson

      @OutputFile public abstract org.gradle.api.file.RegularFileProperty getJson()

    • getConsoleSummary

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

    • getProjectDirectory

      @Internal public abstract org.gradle.api.file.DirectoryProperty getProjectDirectory()

    • report

      public void report()