Examples of org.gradle.api.Task

org.gradle.api.Task
A Task represents a single atomic piece of work for a build, such as compiling classes or generating javadoc.

Each task belongs to a {@link Project}. You can use the various methods on {@link org.gradle.api.tasks.TaskContainer} to create and lookup task instances. For example, {@link org.gradle.api.tasks.TaskContainer#add(String)} creates an empty task with the given name. You can also use the{@code task} keyword in your build file:
```
 task myTask task myTask { configure closure } task myType << { task action } task myTask(type: SomeType) task myTask(type: SomeType) { configure closure } 
```
Each task has a name, which can be used to refer to the task within its owning project, and a fully qualified path, which is unique across all tasks in all projects. The path is the concatenation of the owning project's path and the task's name. Path elements are separated using the {@value org.gradle.api.Project#PATH_SEPARATOR}character.

Task Actions

A Task is made up of a sequence of {@link Action} objects. When the task is executed, each of theactions is executed in turn, by calling {@link Action#execute}. You can add actions to a task by calling {@link #doFirst(Action)} or {@link #doLast(Action)}.

Groovy closures can also be used to provide a task action. When the action is executed, the closure is called with the task as parameter. You can add action closures to a task by calling {@link #doFirst(groovy.lang.Closure)} or{@link #doLast(groovy.lang.Closure)} or using the left-shift << operator.
There are 2 special exceptions which a task action can throw to abort execution and continue without failing the build. A task action can abort execution of the action and continue to the next action of the task by throwing a {@link org.gradle.api.tasks.StopActionException}. A task action can abort execution of the task and continue to the next task by throwing a {@link org.gradle.api.tasks.StopExecutionException}. Using these exceptions allows you to have precondition actions which skip execution of the task, or part of the task, if not true.
Dependencies

A task may have dependencies on other tasks. Gradle ensures that tasks are executed in dependency order, so that the dependencies of a task are executed before the task is executed. You can add dependencies to a task using {@link #dependsOn(Object)} or {@link #setDependsOn(Iterable)}. You can add objects of any of the following types as a dependency:
- A {@code String} task path or name. A relative path is interpreted relative to the task's {@link Project}. This allows you to refer to tasks in other projects.
- A {@link Task}.
- A closure. The closure may take a {@code Task} as parameter. It may return any of the types listed here. Itsreturn value is recursively converted to tasks. A {@code null} return value is treated as an empty collection.
- A {@link TaskDependency} object.
- A {@link Buildable} object.
- A {@code Collection}, {@code Map} or an array. May contain any of the types listed here. The elements of thecollection/map/array are recursively converted to tasks.
- A {@code Callable}. The {@code call()} method may return any of the types listed here. Its return value isrecursively converted to tasks. A {@code null} return value is treated as an empty collection.
- An {@code Object}. The object's {@code toString()} method is interpreted as a task path or name.
Using a Task in a Build File
Dynamic Properties

A {@code Task} has 3 'scopes' for properties. You can access these properties by name from the build file or bycalling the {@link #property(String)} method.
- The {@code Task} object itself. This includes any property getters and setters declared by the {@code Task}implementation class. The properties of this scope are readable or writable based on the presence of the corresponding getter and setter methods.
- The additional properties of the task. Each task object maintains a map of additional properties. These are arbitrary name -> value pairs which you can use to dynamically add properties to a task object. The properties of this scope are readable and writable.
- The convention properties added to the task by each {@link Plugin} applied to the project. A {@link Plugin} can add properties and methods to a task through the task's {@link Convention} object. The properties ofthis scope may be readable or writable, depending on the convention objects.
Dynamic Methods

A {@link Plugin} may add methods to a {@code Task} using its {@link Convention} object.
@author Hans Dockter

    public Task createTask(Project project, String name) {
        return createTask(getTask().getClass(), project, name);
    }


    public <T extends AbstractTask> T createTask(Class<T> type, Project project, String name) {
        Task task = TASK_FACTORY.createTask((ProjectInternal) project,
                GUtil.map(Task.TASK_TYPE, type,
                        Task.TASK_NAME, name));
        assertTrue(type.isAssignableFrom(task.getClass()));
        return type.cast(task);
    }

View Full Code Here

        DefaultProject childProject = HelperUtil.createChildProject(rootProject, "child");
        childProject.getProjectDir().mkdirs();
        DefaultProject childchildProject = HelperUtil.createChildProject(childProject, "childchild");
        childchildProject.getProjectDir().mkdirs();


        Task task = createTask(rootProject, TEST_TASK_NAME);
        assertEquals(Project.PATH_SEPARATOR + TEST_TASK_NAME, task.getPath());
        task = createTask(childProject, TEST_TASK_NAME);
        assertEquals(Project.PATH_SEPARATOR + "child" + Project.PATH_SEPARATOR + TEST_TASK_NAME, task.getPath());
        task = createTask(childchildProject, TEST_TASK_NAME);
        assertEquals(Project.PATH_SEPARATOR + "child" + Project.PATH_SEPARATOR + "childchild" + Project.PATH_SEPARATOR + TEST_TASK_NAME, task.getPath());
    }

View Full Code Here

        assertEquals(Project.PATH_SEPARATOR + "child" + Project.PATH_SEPARATOR + "childchild" + Project.PATH_SEPARATOR + TEST_TASK_NAME, task.getPath());
    }


    @Test
    public void testDependsOn() {
        Task dependsOnTask = createTask(project, "somename");
        Task task = createTask(project, TEST_TASK_NAME);
        project.getTasks().add("path1");
        project.getTasks().add("path2");


        task.dependsOn(Project.PATH_SEPARATOR + "path1");
        assertThat(task, dependsOn("path1"));
        task.dependsOn("path2", dependsOnTask);
        assertThat(task, dependsOn("path1", "path2", "somename"));
    }

View Full Code Here

        assertTrue(task.getOnlyIf().isSatisfiedBy(task));
    }


    @Test
    public void testDependentTaskDidWork() {
        final Task task1 = context.mock(Task.class, "task1");
        final Task task2 = context.mock(Task.class, "task2");
        final TaskDependency dependencyMock = context.mock(TaskDependency.class);
        getTask().dependsOn(dependencyMock);
        context.checking(new Expectations() {{
            allowing(dependencyMock).getDependencies(getTask()); will(returnValue(WrapUtil.toSet(task1, task2)));

View Full Code Here


    @Before
    public void setUp() throws Exception {
        context = new JUnit4Mockery();


        Task subsubCompileTask = TestUtility.createTask(context, "compile", "compile description");
        Task subsubLibTask = TestUtility.createTask(context, "lib", "lib description");
        Task subsubDocTask = TestUtility.createTask(context, "doc", "doc description");
        Project subsubProject = TestUtility.createMockProject(context, "mysubsubproject", "filepath3", 2, null,
                new Task[]{subsubCompileTask, subsubLibTask, subsubDocTask}, null, (Project[]) null);


        Task subCompileTask1 = TestUtility.createTask(context, "compile", "compile description");
        Task subLibTask1 = TestUtility.createTask(context, "lib", "lib description");
        Task subDocTask1 = TestUtility.createTask(context, "doc", "doc description");
        Project subProject1 = TestUtility.createMockProject(context, "mysubproject1", "filepath2a", 1,
                new Project[]{subsubProject}, new Task[]{subCompileTask1, subLibTask1, subDocTask1}, null,
                (Project[]) null);


        Task subCompileTask2 = TestUtility.createTask(context, "compile", "compile description");
        Task subLibTask2 = TestUtility.createTask(context, "lib", "lib description");
        Task subDocTask2 = TestUtility.createTask(context, "doc", "doc description");
        Project subProject2 = TestUtility.createMockProject(context, "mysubproject2", "filepath2b", 1, null,
                new Task[]{subCompileTask2, subLibTask2, subDocTask2}, null, (Project[]) null);


        Project rootProject = TestUtility.createMockProject(context, "myrootproject", "filepath1", 0,
                new Project[]{subProject1, subProject2}, null, null, (Project[]) null);

View Full Code Here

        assertTrue(testTask.executed);
    }


    @Test
    public void dependsOnTargetDependencies() {
        Task a = project.getTasks().add("a");
        Task b = project.getTasks().add("b");
        antTarget.setDepends("a, b");


        task.setTarget(antTarget);
        Set dependencies = task.getTaskDependencies().getDependencies(task);
        assertThat(dependencies, equalTo((Set) toSet(a, b)));

View Full Code Here

    public static final String PROPERTIES_TASK = "properties";


    public void execute(ProjectInternal project) {
        TaskContainerInternal tasks = project.getImplicitTasks();


        Task task = tasks.add(HELP_TASK, Help.class);
        task.setDescription("Displays a help message");
        task.setGroup(HELP_GROUP);


        task = tasks.add(PROJECTS_TASK, ProjectReportTask.class);
        task.setDescription(String.format("Displays the sub-projects of %s.", project));
        task.setGroup(HELP_GROUP);


        task = tasks.add(TASKS_TASK, TaskReportTask.class);
        task.setDescription(String.format("Displays the tasks in %s.", project));
        task.setGroup(HELP_GROUP);


        task = tasks.add(DEPENDENCIES_TASK, DependencyReportTask.class);
        task.setDescription(String.format("Displays the dependencies of %s.", project));
        task.setGroup(HELP_GROUP);


        task = tasks.add(PROPERTIES_TASK, PropertyReportTask.class);
        task.setDescription(String.format("Displays the properties of %s.", project));
        task.setGroup(HELP_GROUP);
    }

View Full Code Here

        projectDependency.setTransitive(false);
        projectDependency.resolve(resolveContext);
    }


    private Task taskInTargetProject(final String name) {
        final Task task = context.mock(Task.class, name);
        context.checking(new Expectations(){{
            allowing(dependencyProjectTaskContainerStub).getByName(name);
            will(returnValue(task));
        }});
        return task;

View Full Code Here

        return task;
    }


    @Test
    public void dependsOnTargetConfigurationAndArtifactsOfTargetConfiguration() {
        Task a = taskInTargetProject("a");
        Task b = taskInTargetProject("b");
        Task c = taskInTargetProject("c");
        expectTargetConfigurationHasDependencies(a, b);
        expectTargetConfigurationHasArtifacts(c);


        assertThat(projectDependency.getBuildDependencies().getDependencies(null), equalTo((Set) toSet(a, b, c)));
    }

View Full Code Here


    @Test
    public void dependsOnAdditionalTasksFromTargetProject() {
        expectTargetConfigurationHasNoDependencies();


        Task a = taskInTargetProject("a");
        Task b = taskInTargetProject("b");


        DefaultProjectDependency dependency = new DefaultProjectDependency(dependencyProjectStub,
                new ProjectDependenciesBuildInstruction(toList("a", "b")));
        assertThat(dependency.getBuildDependencies().getDependencies(null), equalTo((Set) toSet(a, b)));
    }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.gradle.api.Task

co.tomlee.gradle.plugins.release.ReleasePlugin

com.android.build.gradle.internal.VariantManager

edu.sc.seis.launch4j.Launch4jPlugin

net.minecraftforge.gradle.dev.DevBasePlugin

net.minecraftforge.gradle.dev.FmlDevPlugin

net.minecraftforge.gradle.dev.ForgeDevPlugin

net.minecraftforge.gradle.dev.McpcDevPlugin

net.minecraftforge.gradle.tasks.abstractutil.CachedTask

net.minecraftforge.gradle.user.lib.UserLibBasePlugin

net.minecraftforge.gradle.user.UserBasePlugin

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.

Examples of org.gradle.api.Task

Task Actions

Dependencies

Using a Task in a Build File

Dynamic Properties

Dynamic Methods

Related Classes of org.gradle.api.Task