All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.gradle.api.internal.tasks.CachingTaskDependencyResolveContext Maven / Gradle / Ivy

    There is a newer version: 8.11.1
    Show newest version
    /*
 * 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.base.Preconditions;
import org.gradle.api.Action;
import org.gradle.api.Buildable;
import org.gradle.api.NonNullApi;
import org.gradle.api.Task;
import org.gradle.internal.graph.CachingDirectedGraphWalker;
import org.gradle.internal.graph.DirectedGraph;

import javax.annotation.Nullable;
import java.util.ArrayDeque;
import java.util.Collection;
import java.util.Deque;
import java.util.Set;

/**
 * 
    A {@link TaskDependencyResolveContext} which caches the dependencies for each {@link
 * org.gradle.api.tasks.TaskDependency} and {@link org.gradle.api.Buildable} instance during traversal of task
 * dependencies.
    
 *
 * 
    Supported types:
     
      
 *
 * 
    • {@link org.gradle.api.Task}
      • 
 *
 * 
    • {@link org.gradle.api.tasks.TaskDependency}
      • 
 *
 * 
    • {@link org.gradle.api.internal.tasks.TaskDependencyInternal}
      • 
 *
 * 
    • {@link org.gradle.api.Buildable}
      • 
 *
 * 
    
 */
@NonNullApi
public class CachingTaskDependencyResolveContext extends AbstractTaskDependencyResolveContext {
    private final Deque queue = new ArrayDeque();
    private final CachingDirectedGraphWalker walker;
    private final Collection> workResolvers;
    private Task task;

    public CachingTaskDependencyResolveContext(Collection> workResolvers) {
        this.walker = new CachingDirectedGraphWalker(new TaskGraphImpl(workResolvers));
        this.workResolvers = workResolvers;
    }

    public Set getDependencies(@Nullable Task task, Object dependencies) {
        this.task = task;
        try {
            walker.add(dependencies);
            return walker.findValues();
        } catch (Exception e) {
            throw new TaskDependencyResolveException(String.format("Could not determine the dependencies of %s.", task), e);
        } finally {
            queue.clear();
            this.task = null;
        }
    }

    @Nullable
    public Task getTask() {
        return task;
    }

    @Override
    public void add(Object dependency) {
        Preconditions.checkNotNull(dependency);
        queue.add(dependency);
    }

    private void attachFinalizerTo(T value, Action action) {
        for (WorkDependencyResolver resolver : workResolvers) {
            if (resolver.attachActionTo(value, action)) {
                break;
            }
        }
    }

    private class TaskGraphImpl implements DirectedGraph {
        private final Collection> workResolvers;

        public TaskGraphImpl(Collection> workResolvers) {
            this.workResolvers = workResolvers;
        }

        @Override
        public void getNodeValues(Object node, final Collection values, Collection connectedNodes) {
            if (node instanceof TaskDependencyContainer) {
                TaskDependencyContainer taskDependency = (TaskDependencyContainer) node;
                queue.clear();
                taskDependency.visitDependencies(CachingTaskDependencyResolveContext.this);
                connectedNodes.addAll(queue);
            } else if (node instanceof Buildable) {
                Buildable buildable = (Buildable) node;
                connectedNodes.add(buildable.getBuildDependencies());
            } else if (node instanceof FinalizeAction) {
                FinalizeAction finalizeAction = (FinalizeAction) node;
                TaskDependencyContainer dependencies = finalizeAction.getDependencies();
                Set deps = new CachingTaskDependencyResolveContext(workResolvers).getDependencies(task, dependencies);
                for (T dep : deps) {
                    attachFinalizerTo(dep, finalizeAction);
                    values.add(dep);
                }
            } else {
                boolean handled = false;
                for (WorkDependencyResolver workResolver : workResolvers) {
                    if (workResolver.resolve(task, node, new Action() {
                        @Override
                        public void execute(T resolvedValue) {
                            values.add(resolvedValue);
                        }
                    })) {
                        handled = true;
                        break;
                    }
                }
                if (!handled) {
                    throw new IllegalArgumentException(String.format("Cannot resolve object of unknown type %s to a Task.",
                        node.getClass().getSimpleName()));
                }
            }
        }
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy