Package org.cyclonedx.gradle

Class BaseCyclonedxTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.cyclonedx.gradle.BaseCyclonedxTask
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>
Direct Known Subclasses:
CyclonedxAggregateTask, CyclonedxDirectTask
@CacheableTask public abstract class BaseCyclonedxTask extends org.gradle.api.DefaultTask

  • 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
    BaseCyclonedxTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.Property<String>
    getComponentGroup()
     
    abstract org.gradle.api.provider.Property<String>
    getComponentName()
     
    abstract org.gradle.api.provider.Property<String>
    getComponentVersion()
     
    abstract org.gradle.api.provider.ListProperty<org.cyclonedx.model.ExternalReference>
    getExternalReferences()
     
    abstract org.gradle.api.file.RegularFileProperty
    getJsonOutput()
    The output file for the JSON report.
    abstract org.gradle.api.provider.Property<org.cyclonedx.model.LicenseChoice>
    getLicenseChoice()
     
    abstract org.gradle.api.provider.Property<org.cyclonedx.model.OrganizationalEntity>
    getOrganizationalEntity()
     
    abstract org.gradle.api.provider.Property<org.cyclonedx.model.Component.Type>
    getProjectType()
     
    abstract org.gradle.api.file.RegularFileProperty
    getXmlOutput()
    The output file for the XML 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, getAsDynamicObject, 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, notCompatibleWithConfigurationCache

  • Constructor Details

    • BaseCyclonedxTask

      public BaseCyclonedxTask()

  • Method Details

    • getComponentGroup

      @Input public abstract org.gradle.api.provider.Property<String> getComponentGroup()
      See Also:

    • getComponentName

      @Input public abstract org.gradle.api.provider.Property<String> getComponentName()
      See Also:

    • getComponentVersion

      @Input public abstract org.gradle.api.provider.Property<String> getComponentVersion()
      See Also:

    • getXmlOutput

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

      The output file for the XML report.

      If not set, the default is "${project.buildDir}/reports/cyclonedx/bom.xml".

      To disable the XML output, you need to unset convention: xmlOutput.unsetConvention()

      Returns:
      the XML output file property
      See Also:

    • getJsonOutput

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

      The output file for the JSON report.

      If not set, the default is "${project.buildDir}/reports/cyclonedx/bom.json".

      To disable the JSON output, you need to unset convention: jsonOutput.unsetConvention()

      Returns:
      the JSON output file property
      See Also:

    • getProjectType

      @Input public abstract org.gradle.api.provider.Property<org.cyclonedx.model.Component.Type> getProjectType()
      See Also:

    • getOrganizationalEntity

      @Internal public abstract org.gradle.api.provider.Property<org.cyclonedx.model.OrganizationalEntity> getOrganizationalEntity()
      See Also:

    • getLicenseChoice

      @Internal public abstract org.gradle.api.provider.Property<org.cyclonedx.model.LicenseChoice> getLicenseChoice()
      See Also:

    • getExternalReferences

      @Internal public abstract org.gradle.api.provider.ListProperty<org.cyclonedx.model.ExternalReference> getExternalReferences()
      See Also: