Package org.gradle.api.tasks
Class SourceTask
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.SourceTask
- All Implemented Interfaces:
- Comparable<Task>,- org.gradle.api.internal.DynamicObjectAware,- org.gradle.api.internal.IConventionAware,- org.gradle.api.internal.TaskInternal,- Named,- ExtensionAware,- Task,- PatternFilterable,- Configurable<Task>
- Direct Known Subclasses:
- AbstractCodeQualityTask,- AbstractCompile,- AntlrTask,- Groovydoc,- Javadoc,- ScalaDoc
@NonNullApi
@DisableCachingByDefault(because="Super-class, not to be instantiated directly")
public abstract class SourceTask
extends org.gradle.api.internal.ConventionTask
implements PatternFilterable
A 
SourceTask performs some operation on source files.- 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionAdds an exclude spec.Adds an ANT style exclude pattern.Adds an ANT style exclude pattern.exclude(Spec<FileTreeElement> excludeSpec) Adds an exclude spec.Returns the set of exclude patterns.Returns the set of include patterns.protected PatternFilterableprotected org.gradle.api.tasks.util.internal.PatternSetFactoryReturns the source for this task, after the include and exclude patterns have been applied.Adds an include spec.Adds an ANT style include pattern.Adds an ANT style include pattern.include(Spec<FileTreeElement> includeSpec) Adds an include spec.setExcludes(Iterable<String> excludes) Set the allowable exclude patterns.setIncludes(Iterable<String> includes) Set the allowable include patterns.voidSets the source for this task.voidSets the source for this task.Adds some source to this task.Methods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, 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, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
SourceTaskpublic SourceTask()
 
- 
- 
Method Details- 
getPatternSetFactory@Inject protected org.gradle.api.tasks.util.internal.PatternSetFactory getPatternSetFactory()
- 
getPatternSet
- 
getSource@InputFiles @SkipWhenEmpty @IgnoreEmptyDirectories @PathSensitive(ABSOLUTE) public FileTree getSource()Returns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.The PathSensitivityfor the sources is configured to bePathSensitivity.ABSOLUTE. If your sources are less strict, please change it accordingly by overriding this method in your subclass.- Returns:
- The source.
 
- 
setSourceSets the source for this task.- Parameters:
- source- The source.
- Since:
- 4.0
 
- 
setSourceSets the source for this task. The given source object is evaluated as perProject.files(Object...).- Parameters:
- source- The source.
 
- 
sourceAdds some source to this task. The given source objects will be evaluated as perProject.files(Object...).- Parameters:
- sources- The source to add
- Returns:
- this
 
- 
includeAdds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.- Specified by:
- includein interface- PatternFilterable
- Parameters:
- includes- a vararg list of include patterns
- Returns:
- this
- See Also:
 
- 
includeAdds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.- Specified by:
- includein interface- PatternFilterable
- Parameters:
- includes- a Iterable providing more include patterns
- Returns:
- this
- See Also:
 
- 
includeAdds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.- Specified by:
- includein interface- PatternFilterable
- Parameters:
- includeSpec- the spec to add
- Returns:
- this
- See Also:
 
- 
includeAdds an include spec. This method may be called multiple times to append new specs. The given closure is passed aFileTreeElementas its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.- Specified by:
- includein interface- PatternFilterable
- Parameters:
- includeSpec- the spec to add
- Returns:
- this
- See Also:
 
- 
excludeAdds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.- Specified by:
- excludein interface- PatternFilterable
- Parameters:
- excludes- a vararg list of exclude patterns
- Returns:
- this
- See Also:
 
- 
excludeAdds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.- Specified by:
- excludein interface- PatternFilterable
- Parameters:
- excludes- a Iterable providing new exclude patterns
- Returns:
- this
- See Also:
 
- 
excludeAdds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.- Specified by:
- excludein interface- PatternFilterable
- Parameters:
- excludeSpec- the spec to add
- Returns:
- this
- See Also:
 
- 
excludeAdds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed aFileTreeElementas its parameter. The closure should return true or false. Example:copySpec { from 'source' into 'destination' //an example of excluding files from certain configuration: exclude { it.file in configurations.someConf.files } }If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.- Specified by:
- excludein interface- PatternFilterable
- Parameters:
- excludeSpec- the spec to add
- Returns:
- this
- See Also:
 
- 
getIncludesReturns the set of include patterns.- Specified by:
- getIncludesin interface- PatternFilterable
- Returns:
- The include patterns. Returns an empty set when there are no include patterns.
 
- 
setIncludesSet the allowable include patterns. Note that unlikePatternFilterable.include(Iterable)this replaces any previously defined includes.- Specified by:
- setIncludesin interface- PatternFilterable
- Parameters:
- includes- an Iterable providing new include patterns
- Returns:
- this
- See Also:
 
- 
getExcludesReturns the set of exclude patterns.- Specified by:
- getExcludesin interface- PatternFilterable
- Returns:
- The exclude patterns. Returns an empty set when there are no exclude patterns.
 
- 
setExcludesSet the allowable exclude patterns. Note that unlikePatternFilterable.exclude(Iterable)this replaces any previously defined excludes.- Specified by:
- setExcludesin interface- PatternFilterable
- Parameters:
- excludes- an Iterable providing new exclude patterns
- Returns:
- this
- See Also:
 
 
-