Package org.nosphere.apache.rat

Class RatTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.nosphere.apache.rat.RatTask
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.api.tasks.util.PatternFilterable, org.gradle.util.Configurable<org.gradle.api.Task>
@CacheableTask public class RatTask extends org.gradle.api.DefaultTask implements org.gradle.api.tasks.util.PatternFilterable

  • 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
    RatTask(org.gradle.api.model.ObjectFactory objects, org.gradle.api.file.ProjectLayout layout, org.gradle.workers.WorkerExecutor workerExecutor, org.gradle.jvm.toolchain.JavaToolchainService toolchains)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    approvedLicense(String familyNameOrCategory)
     
    org.gradle.api.tasks.util.PatternFilterable
    exclude(groovy.lang.Closure excludeSpec)
     
    org.gradle.api.tasks.util.PatternFilterable
    exclude(Iterable<String> excludes)
     
    org.gradle.api.tasks.util.PatternFilterable
    exclude(String... excludes)
     
    org.gradle.api.tasks.util.PatternFilterable
    exclude(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> excludeSpec)
     
    org.gradle.api.provider.Property<Boolean>
    getAddDefaultMatchers()
     
    org.gradle.api.provider.ListProperty<String>
    getApprovedLicenses()
     
    Set<String>
    getExcludes()
     
    org.gradle.api.provider.Property<Boolean>
    getFailOnError()
    Whether unapproved licenses fail the build, defaults to true.
    Set<String>
    getIncludes()
     
    org.gradle.api.file.DirectoryProperty
    getInputDir()
     
    org.gradle.api.file.FileTree
    getInputFiles()
     
    org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLauncher>
    getJavaLauncher()
     
    protected org.gradle.api.file.FileCollection
    getRatClasspath()
     
    org.gradle.api.file.DirectoryProperty
    getReportDir()
     
    org.gradle.api.provider.ListProperty<SubstringMatcher>
    getSubstringMatchers()
     
    org.gradle.api.provider.Property<Boolean>
    getVerbose()
     
    org.gradle.api.tasks.util.PatternFilterable
    include(groovy.lang.Closure includeSpec)
     
    org.gradle.api.tasks.util.PatternFilterable
    include(Iterable<String> includes)
     
    org.gradle.api.tasks.util.PatternFilterable
    include(String... includes)
     
    org.gradle.api.tasks.util.PatternFilterable
    include(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> includeSpec)
     
    void
    rat()
     
    org.gradle.api.tasks.util.PatternFilterable
    setExcludes(Iterable<String> excludes)
     
    org.gradle.api.tasks.util.PatternFilterable
    setIncludes(Iterable<String> includes)
     
    void
    substringMatcher(String licenseFamilyCategory, String licenseFamilyName, String... substrings)
     

    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, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, 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, getConvention, notCompatibleWithConfigurationCache

  • Constructor Details

    • RatTask

      @Inject public RatTask(org.gradle.api.model.ObjectFactory objects, org.gradle.api.file.ProjectLayout layout, org.gradle.workers.WorkerExecutor workerExecutor, org.gradle.jvm.toolchain.JavaToolchainService toolchains)

  • Method Details

    • getVerbose

      @Console public org.gradle.api.provider.Property<Boolean> getVerbose()

    • getFailOnError

      @Input public org.gradle.api.provider.Property<Boolean> getFailOnError()
      Whether unapproved licenses fail the build, defaults to true.

      Configuration errors always fail the build, whatever this is set to.

    • getInputDir

      @Internal public org.gradle.api.file.DirectoryProperty getInputDir()

    • getAddDefaultMatchers

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

    • getSubstringMatchers

      public org.gradle.api.provider.ListProperty<SubstringMatcher> getSubstringMatchers()

    • substringMatcher

      public void substringMatcher(String licenseFamilyCategory, String licenseFamilyName, String... substrings)

    • getApprovedLicenses

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

    • approvedLicense

      public void approvedLicense(String familyNameOrCategory)

    • getIncludes

      @Internal public Set<String> getIncludes()
      Specified by:
      getIncludes in interface org.gradle.api.tasks.util.PatternFilterable

    • getExcludes

      @Internal public Set<String> getExcludes()
      Specified by:
      getExcludes in interface org.gradle.api.tasks.util.PatternFilterable

    • setIncludes

      public org.gradle.api.tasks.util.PatternFilterable setIncludes(Iterable<String> includes)
      Specified by:
      setIncludes in interface org.gradle.api.tasks.util.PatternFilterable

    • setExcludes

      public org.gradle.api.tasks.util.PatternFilterable setExcludes(Iterable<String> excludes)
      Specified by:
      setExcludes in interface org.gradle.api.tasks.util.PatternFilterable

    • include

      public org.gradle.api.tasks.util.PatternFilterable include(String... includes)
      Specified by:
      include in interface org.gradle.api.tasks.util.PatternFilterable

    • include

      public org.gradle.api.tasks.util.PatternFilterable include(Iterable<String> includes)
      Specified by:
      include in interface org.gradle.api.tasks.util.PatternFilterable

    • include

      public org.gradle.api.tasks.util.PatternFilterable include(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> includeSpec)
      Specified by:
      include in interface org.gradle.api.tasks.util.PatternFilterable

    • include

      public org.gradle.api.tasks.util.PatternFilterable include(groovy.lang.Closure includeSpec)
      Specified by:
      include in interface org.gradle.api.tasks.util.PatternFilterable

    • exclude

      public org.gradle.api.tasks.util.PatternFilterable exclude(String... excludes)
      Specified by:
      exclude in interface org.gradle.api.tasks.util.PatternFilterable

    • exclude

      public org.gradle.api.tasks.util.PatternFilterable exclude(Iterable<String> excludes)
      Specified by:
      exclude in interface org.gradle.api.tasks.util.PatternFilterable

    • exclude

      public org.gradle.api.tasks.util.PatternFilterable exclude(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> excludeSpec)
      Specified by:
      exclude in interface org.gradle.api.tasks.util.PatternFilterable

    • exclude

      public org.gradle.api.tasks.util.PatternFilterable exclude(groovy.lang.Closure excludeSpec)
      Specified by:
      exclude in interface org.gradle.api.tasks.util.PatternFilterable

    • getInputFiles

      @InputFiles @PathSensitive(RELATIVE) public org.gradle.api.file.FileTree getInputFiles()

    • getReportDir

      @OutputDirectory public org.gradle.api.file.DirectoryProperty getReportDir()

    • getJavaLauncher

      @Internal public org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLauncher> getJavaLauncher()

    • getRatClasspath

      @InputFiles @Classpath protected org.gradle.api.file.FileCollection getRatClasspath()

    • rat

      public void rat()