Class ManualCopyTask

  • All Implemented Interfaces:
    java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.file.ContentFilterable, org.gradle.api.file.CopyProcessingSpec, org.gradle.api.file.CopySourceSpec, org.gradle.api.file.CopySpec, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.file.copy.CopySpecSource, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.util.Configurable<org.gradle.api.Task>

    @DisableCachingByDefault(because="Not worth caching")
    public abstract class ManualCopyTask
    extends org.gradle.api.tasks.AbstractCopyTask
    Copies files into a destination directory. This task can also rename and filter files as it copies. The task implements CopySpec for specifying what to copy.

    Examples:

     task copyDocs(type: Copy) {
         from 'src/main/doc'
         into 'build/target/doc'
     }
    
     //for Ant filter
     import org.apache.tools.ant.filters.ReplaceTokens
    
     //for including in the copy task
     def dataContent = copySpec {
         from 'src/data'
         include '*.data'
     }
    
     task initConfig(type: Copy) {
         from('src/main/config') {
             include '**/*.properties'
             include '**/*.xml'
             filter(ReplaceTokens, tokens: [version: '2.3.1'])
         }
         from('src/main/config') {
             exclude '**/*.properties', '**/*.xml'
         }
         from('src/main/languages') {
             rename 'EN_US_(.*)', '$1'
         }
         into 'build/target/config'
         exclude '**/*.bak'
    
         includeEmptyDirs = false
    
         with dataContent
     }
     
    • 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
      ManualCopyTask()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.gradle.api.internal.file.copy.CopyAction createCopyAction()  
      protected org.gradle.api.internal.file.copy.CopySpecInternal createRootSpec()  
      java.io.File getDestinationDir()
      Returns the directory to copy files into.
      org.gradle.api.internal.file.copy.DestinationRootCopySpec getRootSpec()  
      void setDestinationDir​(java.io.File destinationDir)
      Sets the directory to copy files into.
      • Methods inherited from class org.gradle.api.tasks.AbstractCopyTask

        copy, createCopyActionExecuter, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirMode, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getObjectFactory, getSource, include, include, include, include, into, into, into, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with
      • Methods inherited from class org.gradle.api.internal.ConventionTask

        conventionMapping, conventionMapping, getConventionMapping
      • 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

        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 Detail

      • ManualCopyTask

        public ManualCopyTask()
    • Method Detail

      • createCopyAction

        protected org.gradle.api.internal.file.copy.CopyAction createCopyAction()
        Specified by:
        createCopyAction in class org.gradle.api.tasks.AbstractCopyTask
      • createRootSpec

        protected org.gradle.api.internal.file.copy.CopySpecInternal createRootSpec()
        Overrides:
        createRootSpec in class org.gradle.api.tasks.AbstractCopyTask
      • getRootSpec

        public org.gradle.api.internal.file.copy.DestinationRootCopySpec getRootSpec()
        Specified by:
        getRootSpec in interface org.gradle.api.internal.file.copy.CopySpecSource
        Overrides:
        getRootSpec in class org.gradle.api.tasks.AbstractCopyTask
      • getDestinationDir

        @Internal
        public java.io.File getDestinationDir()
        Returns the directory to copy files into.
        Returns:
        The destination dir.
      • setDestinationDir

        public void setDestinationDir​(java.io.File destinationDir)
        Sets the directory to copy files into. This is the same as calling AbstractCopyTask.into(Object) on this task.
        Parameters:
        destinationDir - The destination directory. Must not be null.