org.gradle.internal.service.scopes.Scopes Maven / Gradle / Ivy

/*
 * Copyright 2020 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.internal.service.scopes;

/**
 * @see ServiceScope
 */
public interface Scopes {
    /**
     * These services are reused across builds in the same process while the Gradle user home directory remains unchanged.
     * The services are closed when the Gradle user home directory changes.
     *
     * <{@link Scope.Global} and parent scope services are visible to {@link UserHome} scope services, but not vice versa.
     */
    interface UserHome extends Scope.Global {}

    /**
     * These services are reused across build invocations in a session.
     *
     * A build session can be long-lived in a continuous build (where these services would be reused) or short-lived in a
     * regular, single build.
     *
     * They are closed at the end of the build session.
     *
     * {@link UserHome} and parent scope services are visible to {@link BuildSession} scope services, but not vice versa.
     */
    interface BuildSession extends UserHome {}

    /**
     * These services are recreated when in continuous build and shared across all nested builds.
     * They are closed when the build invocation is completed.
     *
     * {@link BuildSession} and parent scope services are visible to {@link BuildTree} scope services, but not vice versa.
     */
    interface BuildTree extends BuildSession {}

    /**
     * These services are created once per {@link org.gradle.api.initialization.Settings} the beginning of the build invocation
     * These services are closed at the end of the build invocation.
     *
     * {@link BuildTree} and parent scope services are visible to {@link Build} scope services, but not vice versa.
     */
    interface Build extends BuildTree {}

    /**
     * These services are created once per {@link org.gradle.api.invocation.Gradle} at the beginning of the build invocation.
     * These services are closed at the end of the build invocation.
     *
     * {@link Build} and parent scope services are visible to {@link Gradle} scope services, but not vice versa.
     */
    interface Gradle extends Build {}

    /**
     * These services are created once per project per build invocation.
     * These services are closed at the end of the build invocation.
     *
     * {@link Gradle} and parent scope services are visible to {@link Project} scope services, but not vice versa.
     */
    interface Project extends Gradle {}
}