Package com.github.spotbugs.snom

Class SpotBugsTask

  • All Implemented Interfaces:
    java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
    Direct Known Subclasses:
    SpotBugsTaskForAndroid, SpotBugsTaskForJava
    public abstract class SpotBugsTask
extends org.gradle.api.DefaultTask

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      SpotBugsTask​(org.gradle.api.model.ObjectFactory objects)  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract org.gradle.api.file.FileCollection getAuxClassPaths()  
      abstract org.gradle.api.file.FileCollection getClassDirs()  
      org.gradle.api.provider.Property<Effort> getEffort()  
      java.util.Optional<SpotBugsReport> getFirstEnabledReport()  
      org.gradle.api.provider.Property<java.lang.Boolean> getIgnoreFailures()  
      org.gradle.api.provider.ListProperty<java.lang.String> getOmitVisitors()  
      org.gradle.api.provider.Property<Confidence> getReportLevel()  
      org.gradle.api.NamedDomainObjectContainer<? extends org.gradle.api.reporting.SingleFileReport> getReports()  
      org.gradle.api.provider.Property<java.io.File> getReportsDir()  
      org.gradle.api.provider.Property<java.lang.Boolean> getShowProgress()  
      abstract org.gradle.api.file.FileCollection getSourceDirs()  
      org.gradle.api.provider.ListProperty<java.lang.String> getVisitors()  
      protected void init​(SpotBugsExtension extension)
      Set properties from extension right after the task creation.
      org.gradle.api.NamedDomainObjectContainer<? extends SpotBugsReport> reports​(groovy.lang.Closure<org.gradle.api.NamedDomainObjectContainer<? extends SpotBugsReport>> closure)  
      org.gradle.api.NamedDomainObjectContainer<? extends SpotBugsReport> reports​(org.gradle.api.Action<org.gradle.api.NamedDomainObjectContainer<? extends SpotBugsReport>> configureAction)  
      void run()  
      void setReportsDir​(org.gradle.api.provider.Provider<java.io.File> provider)  

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

        appendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getSharedResources, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, requiresResource, requiresResource, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SpotBugsTask

        public SpotBugsTask​(org.gradle.api.model.ObjectFactory objects)

    • Method Detail

      • getSourceDirs

        @InputFiles
@PathSensitive(RELATIVE)
@NonNull
public abstract org.gradle.api.file.FileCollection getSourceDirs()

      • getClassDirs

        @InputFiles
@PathSensitive(RELATIVE)
@NonNull
public abstract org.gradle.api.file.FileCollection getClassDirs()

      • getAuxClassPaths

        @InputFiles
@PathSensitive(RELATIVE)
@NonNull
public abstract org.gradle.api.file.FileCollection getAuxClassPaths()

      • getIgnoreFailures

        @Input
@Optional
@NonNull
public org.gradle.api.provider.Property<java.lang.Boolean> getIgnoreFailures()

      • getShowProgress

        @Input
@Optional
@NonNull
public org.gradle.api.provider.Property<java.lang.Boolean> getShowProgress()

      • getReportLevel

        @Input
@Optional
@NonNull
public org.gradle.api.provider.Property<Confidence> getReportLevel()

      • getEffort

        @Input
@Optional
@NonNull
public org.gradle.api.provider.Property<Effort> getEffort()

      • getVisitors

        @Input
@NonNull
public org.gradle.api.provider.ListProperty<java.lang.String> getVisitors()

      • getOmitVisitors

        @Input
@NonNull
public org.gradle.api.provider.ListProperty<java.lang.String> getOmitVisitors()

      • getReportsDir

        @NonNull
@Internal("Refer the destination of each report instead.")
public org.gradle.api.provider.Property<java.io.File> getReportsDir()

      • setReportsDir

        public void setReportsDir​(org.gradle.api.provider.Provider<java.io.File> provider)

      • init

        @OverrideMustInvoke
protected void init​(SpotBugsExtension extension)
        Set properties from extension right after the task creation. User may overwrite these properties by build script.
        Parameters:
        extension - the source extension to copy the properties.

      • run

        public void run()

      • getReports

        public final org.gradle.api.NamedDomainObjectContainer<? extends org.gradle.api.reporting.SingleFileReport> getReports()

      • reports

        public final org.gradle.api.NamedDomainObjectContainer<? extends SpotBugsReport> reports​(groovy.lang.Closure<org.gradle.api.NamedDomainObjectContainer<? extends SpotBugsReport>> closure)

      • reports

        public final org.gradle.api.NamedDomainObjectContainer<? extends SpotBugsReport> reports​(org.gradle.api.Action<org.gradle.api.NamedDomainObjectContainer<? extends SpotBugsReport>> configureAction)

      • getFirstEnabledReport

        @NonNull
public java.util.Optional<SpotBugsReport> getFirstEnabledReport()