Package org.gradle.docs.samples.internal.tasks

Class ZipSample

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.docs.samples.internal.tasks.ZipSample
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>
@DisableCachingByDefault(because="Creates zip archives from file trees and currently has no explicit caching contract.") public abstract class ZipSample extends org.gradle.api.DefaultTask
Zips a sample to the given location.

Skips execution if there are no "main" content. This is usually DSL-specific content.

Removes references to the documentation (e.g. the lines starting with // tag::) and // end::)

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

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.RegularFileProperty
    getArchiveFile()
     
    abstract org.gradle.api.provider.ListProperty<String>
    getExcludes()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getMainSource()
     
    protected org.gradle.api.file.FileTree
    getMainSourceAsTree()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getSource()
     
    protected org.gradle.api.file.FileTree
    getSourceAsTree()
     
    abstract org.gradle.internal.work.WorkerLeaseService
    getWorkerLeaseService()
     
    void
    zip()
     

    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

  • Constructor Details

    • ZipSample

      public ZipSample()

  • Method Details

    • getSourceAsTree

      @InputFiles @PathSensitive(RELATIVE) protected org.gradle.api.file.FileTree getSourceAsTree()

    • getMainSourceAsTree

      @InputFiles @PathSensitive(RELATIVE) @SkipWhenEmpty protected org.gradle.api.file.FileTree getMainSourceAsTree()

    • getSource

      @Internal public abstract org.gradle.api.file.ConfigurableFileCollection getSource()

    • getMainSource

      @Internal public abstract org.gradle.api.file.ConfigurableFileCollection getMainSource()

    • getExcludes

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

    • getArchiveFile

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

    • getWorkerLeaseService

      @Inject public abstract org.gradle.internal.work.WorkerLeaseService getWorkerLeaseService()

    • zip

      public void zip()