org.gradle.api.internal.tasks.DefaultTaskOutputs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.5 API redistribution.
/*
* Copyright 2010 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.internal.tasks;
import com.google.common.collect.ImmutableSortedSet;
import groovy.lang.Closure;
import org.gradle.api.Describable;
import org.gradle.api.NonNullApi;
import org.gradle.api.Task;
import org.gradle.api.file.FileCollection;
import org.gradle.api.internal.FilePropertyContainer;
import org.gradle.api.internal.TaskInternal;
import org.gradle.api.internal.TaskOutputsInternal;
import org.gradle.api.internal.file.CompositeFileCollection;
import org.gradle.api.internal.file.FileCollectionFactory;
import org.gradle.api.internal.file.collections.FileCollectionResolveContext;
import org.gradle.api.internal.tasks.execution.SelfDescribingSpec;
import org.gradle.api.internal.tasks.properties.GetOutputFilesVisitor;
import org.gradle.api.internal.tasks.properties.OutputFilePropertySpec;
import org.gradle.api.internal.tasks.properties.OutputFilePropertyType;
import org.gradle.api.internal.tasks.properties.PropertyValue;
import org.gradle.api.internal.tasks.properties.PropertyVisitor;
import org.gradle.api.internal.tasks.properties.PropertyWalker;
import org.gradle.api.specs.AndSpec;
import org.gradle.api.specs.Spec;
import org.gradle.api.tasks.TaskOutputFilePropertyBuilder;
import javax.annotation.Nullable;
import java.io.File;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import java.util.concurrent.Callable;
@NonNullApi
public class DefaultTaskOutputs implements TaskOutputsInternal {
private final FileCollection allOutputFiles;
private final PropertyWalker propertyWalker;
private final FileCollectionFactory fileCollectionFactory;
private AndSpec upToDateSpec = AndSpec.empty();
private List> cacheIfSpecs = new LinkedList>();
private List> doNotCacheIfSpecs = new LinkedList>();
private FileCollection previousOutputFiles;
private final FilePropertyContainer registeredFileProperties = FilePropertyContainer.create();
private final TaskInternal task;
private final TaskMutator taskMutator;
public DefaultTaskOutputs(final TaskInternal task, TaskMutator taskMutator, PropertyWalker propertyWalker, FileCollectionFactory fileCollectionFactory) {
this.task = task;
this.taskMutator = taskMutator;
this.allOutputFiles = new TaskOutputUnionFileCollection(task);
this.propertyWalker = propertyWalker;
this.fileCollectionFactory = fileCollectionFactory;
}
@Override
public void visitRegisteredProperties(PropertyVisitor visitor) {
for (TaskOutputFilePropertyRegistration registration : registeredFileProperties) {
visitor.visitOutputFileProperty(registration.getPropertyName(), registration.isOptional(), registration.getValue(), registration.getPropertyType());
}
}
@Override
public AndSpec getUpToDateSpec() {
return upToDateSpec;
}
@Override
public void upToDateWhen(final Closure upToDateClosure) {
taskMutator.mutate("TaskOutputs.upToDateWhen(Closure)", new Runnable() {
@Override
public void run() {
upToDateSpec = upToDateSpec.and(upToDateClosure);
}
});
}
@Override
public void upToDateWhen(final Spec spec) {
taskMutator.mutate("TaskOutputs.upToDateWhen(Spec)", new Runnable() {
@Override
public void run() {
upToDateSpec = upToDateSpec.and(spec);
}
});
}
@Override
public void cacheIf(final Spec spec) {
cacheIf("Task outputs cacheable", spec);
}
@Override
public void cacheIf(final String cachingEnabledReason, final Spec spec) {
taskMutator.mutate("TaskOutputs.cacheIf(Spec)", new Runnable() {
@Override
public void run() {
cacheIfSpecs.add(new SelfDescribingSpec(spec, cachingEnabledReason));
}
});
}
@Override
public void doNotCacheIf(final String cachingDisabledReason, final Spec spec) {
taskMutator.mutate("TaskOutputs.doNotCacheIf(Spec)", new Runnable() {
@Override
public void run() {
doNotCacheIfSpecs.add(new SelfDescribingSpec(spec, cachingDisabledReason));
}
});
}
@Override
public List> getCacheIfSpecs() {
return cacheIfSpecs;
}
@Override
public List> getDoNotCacheIfSpecs() {
return doNotCacheIfSpecs;
}
@Override
public boolean getHasOutput() {
if (!upToDateSpec.isEmpty()) {
return true;
}
HasDeclaredOutputsVisitor visitor = new HasDeclaredOutputsVisitor();
TaskPropertyUtils.visitProperties(propertyWalker, task, visitor);
return visitor.hasDeclaredOutputs();
}
@Override
public FileCollection getFiles() {
return allOutputFiles;
}
public ImmutableSortedSet getFileProperties() {
GetOutputFilesVisitor visitor = new GetOutputFilesVisitor(task.toString(), fileCollectionFactory);
TaskPropertyUtils.visitProperties(propertyWalker, task, visitor);
return visitor.getFileProperties();
}
@Override
public TaskOutputFilePropertyBuilder file(final Object path) {
return taskMutator.mutate("TaskOutputs.file(Object)", new Callable() {
@Override
public TaskOutputFilePropertyBuilder call() {
StaticValue value = new StaticValue(path);
value.attachProducer(task);
TaskOutputFilePropertyRegistration registration = new DefaultTaskOutputFilePropertyRegistration(value, OutputFilePropertyType.FILE);
registeredFileProperties.add(registration);
return registration;
}
});
}
@Override
public TaskOutputFilePropertyBuilder dir(final Object path) {
return taskMutator.mutate("TaskOutputs.dir(Object)", new Callable() {
@Override
public TaskOutputFilePropertyBuilder call() {
StaticValue value = new StaticValue(path);
value.attachProducer(task);
TaskOutputFilePropertyRegistration registration = new DefaultTaskOutputFilePropertyRegistration(value, OutputFilePropertyType.DIRECTORY);
registeredFileProperties.add(registration);
return registration;
}
});
}
@Override
public TaskOutputFilePropertyBuilder files(final @Nullable Object... paths) {
return taskMutator.mutate("TaskOutputs.files(Object...)", new Callable() {
@Override
public TaskOutputFilePropertyBuilder call() {
StaticValue value = new StaticValue(resolveSingleArray(paths));
TaskOutputFilePropertyRegistration registration = new DefaultTaskOutputFilePropertyRegistration(value, OutputFilePropertyType.FILES);
registeredFileProperties.add(registration);
return registration;
}
});
}
@Override
public TaskOutputFilePropertyBuilder dirs(final Object... paths) {
return taskMutator.mutate("TaskOutputs.dirs(Object...)", new Callable() {
@Override
public TaskOutputFilePropertyBuilder call() {
StaticValue value = new StaticValue(resolveSingleArray(paths));
TaskOutputFilePropertyRegistration registration = new DefaultTaskOutputFilePropertyRegistration(value, OutputFilePropertyType.DIRECTORIES);
registeredFileProperties.add(registration);
return registration;
}
});
}
@Nullable
private static Object resolveSingleArray(@Nullable Object[] paths) {
return (paths != null && paths.length == 1) ? paths[0] : paths;
}
@Override
public void setPreviousOutputFiles(FileCollection previousOutputFiles) {
this.previousOutputFiles = previousOutputFiles;
}
@Override
public Set getPreviousOutputFiles() {
if (previousOutputFiles == null) {
throw new IllegalStateException("Task history is currently not available for this task.");
}
return previousOutputFiles.getFiles();
}
private static class HasDeclaredOutputsVisitor extends PropertyVisitor.Adapter {
boolean hasDeclaredOutputs;
@Override
public void visitOutputFileProperty(String propertyName, boolean optional, PropertyValue value, OutputFilePropertyType filePropertyType) {
hasDeclaredOutputs = true;
}
public boolean hasDeclaredOutputs() {
return hasDeclaredOutputs;
}
}
private class TaskOutputUnionFileCollection extends CompositeFileCollection implements Describable {
private final TaskInternal buildDependencies;
public TaskOutputUnionFileCollection(TaskInternal buildDependencies) {
this.buildDependencies = buildDependencies;
}
@Override
public String getDisplayName() {
return "task '" + task.getName() + "' output files";
}
@Override
public void visitContents(FileCollectionResolveContext context) {
for (OutputFilePropertySpec propertySpec : getFileProperties()) {
context.add(propertySpec.getPropertyFiles());
}
}
@Override
public void visitDependencies(TaskDependencyResolveContext context) {
context.add(buildDependencies);
super.visitDependencies(context);
}
}
}