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

Class InstallSample

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.docs.samples.internal.tasks.InstallSample
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="Copies sample files into a target directory and currently has no explicit caching contract.") public abstract class InstallSample extends org.gradle.api.DefaultTask
Installs the sample's zip to the given directory.

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    doInstall()
     
    abstract org.gradle.api.provider.ListProperty<String>
    getExcludes()
     
    protected abstract org.gradle.api.file.FileSystemOperations
    getFs()
     
    abstract org.gradle.api.file.DirectoryProperty
    getInstallDirectory()
     
    abstract org.gradle.api.provider.Property<String>
    getReadmeName()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getSource()
     
    protected org.gradle.api.file.FileTree
    getSourceAsTree()
     
    abstract org.gradle.internal.work.WorkerLeaseService
    getWorkerLeaseService()
     

    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

    • InstallSample

      public InstallSample()

  • Method Details

    • getSourceAsTree

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

    • getSource

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

    • getReadmeName

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getReadmeName()

    • getExcludes

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

    • getInstallDirectory

      @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getInstallDirectory()

    • getWorkerLeaseService

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

    • getFs

      @Inject protected abstract org.gradle.api.file.FileSystemOperations getFs()

    • doInstall

      public void doInstall()