Package org.jenkinsci.gradle.plugins.jpi2

Class GenerateLicenseInfoTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.jenkinsci.gradle.plugins.jpi2.GenerateLicenseInfoTask
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 GenerateLicenseInfoTask extends org.gradle.api.DefaultTask
Generates licenses.xml for libraries bundled into the plugin package.

  • Nested Class Summary

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

    org.gradle.api.Named.Namer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
    Standard name under which this task is registered.

    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
    GenerateLicenseInfoTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    generateLicenseInfo()
    Collects POM files and writes a licenses.xml describing their license metadata.
    abstract org.gradle.api.file.DirectoryProperty
    getOutputDirectory()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getPomFiles()
     
    abstract org.gradle.api.provider.Property<String>
    getProjectDescription()
     
    abstract org.gradle.api.provider.Property<String>
    getProjectGroup()
     
    abstract org.gradle.api.provider.Property<String>
    getProjectName()
     
    abstract org.gradle.api.provider.Property<String>
    getProjectUrl()
     
    abstract org.gradle.api.provider.Property<String>
    getProjectVersion()
     

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

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Field Details

  • Constructor Details

    • GenerateLicenseInfoTask

      public GenerateLicenseInfoTask()

  • Method Details

    • getOutputDirectory

      @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getOutputDirectory()
      Returns:
      directory where licenses.xml is written

    • getPomFiles

      @InputFiles @Classpath public abstract org.gradle.api.file.ConfigurableFileCollection getPomFiles()
      Returns:
      POM files for all bundled runtime dependencies

    • getProjectVersion

      @Input public abstract org.gradle.api.provider.Property<String> getProjectVersion()
      Returns:
      version of the plugin project, written into the root dependency entry

    • getProjectName

      @Input public abstract org.gradle.api.provider.Property<String> getProjectName()
      Returns:
      Maven artifact ID of the plugin project

    • getProjectGroup

      @Input public abstract org.gradle.api.provider.Property<String> getProjectGroup()
      Returns:
      Maven group ID of the plugin project

    • getProjectDescription

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getProjectDescription()
      Returns:
      optional human-readable description included in the root dependency entry

    • getProjectUrl

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getProjectUrl()
      Returns:
      optional project URL included in the root dependency entry

    • generateLicenseInfo

      public void generateLicenseInfo()
      Collects POM files and writes a licenses.xml describing their license metadata.