org.gradle.BuildListener Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.5 API redistribution.
There is a newer version: 8.6
/*
 * Copyright 2007-2008 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;

import org.gradle.api.Incubating;
import org.gradle.api.initialization.Settings;
import org.gradle.api.invocation.Gradle;
import org.gradle.internal.service.scopes.EventScope;
import org.gradle.internal.service.scopes.Scopes;

/**
 * A {@code BuildListener} is notified of the major lifecycle events as a build is executed.
 *
 * @see org.gradle.api.invocation.Gradle#addListener(Object)
 */
@EventScope(Scopes.Build)
public interface BuildListener {
    /**
     * Called when the build is started.
     *
     * @param gradle The build which is being started. Never null.
     */
    @Deprecated
    void buildStarted(Gradle gradle);

    /**
     * Called when the build settings are about to be loaded and evaluated.
     *
     * @param settings The settings. Never null.
     * @since 6.0
     */
    @Incubating
    default void beforeSettings(Settings settings) {}

    /**
     * Called when the build settings have been loaded and evaluated. The settings object is fully configured and is
     * ready to use to load the build projects.
     *
     * @param settings The settings. Never null.
     */
    void settingsEvaluated(Settings settings);

    /**
     * Called when the projects for the build have been created from the settings. None of the projects have been
     * evaluated.
     *
     * @param gradle The build which has been loaded. Never null.
     */
    void projectsLoaded(Gradle gradle);

    /**
     * Called when all projects for the build have been evaluated. The project objects are fully configured and are
     * ready to use to populate the task graph.
     *
     * @param gradle The build which has been evaluated. Never null.
     */
    void projectsEvaluated(Gradle gradle);

    /**
     * Called when the build is completed. All selected tasks have been executed.
     *
     * @param result The result of the build. Never null.
     */
    void buildFinished(BuildResult result);
}