org.apache.maven.plugins.annotations.ResolutionScope Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.maven.plugins.annotations;

/**
 * Dependencies resolution scopes available before
 * mojo execution.
 *
 * Important note: The {@code id} values of this enum correspond to constants of
 * {@code org.apache.maven.artifact.Artifact} class and MUST BE KEPT IN SYNC.
 *
 * @author Hervé Boutemy
 * @since 3.0
 */
public enum ResolutionScope {
    /**
     * empty resolution scope
     */
    NONE(null),
    /**
     * compile resolution scope
     * = compile + system + provided dependencies
     */
    COMPILE("compile"),
    /**
     * compile+runtime resolution scope (Maven 3 only)
     * = compile + system + provided + runtime dependencies
     */
    COMPILE_PLUS_RUNTIME("compile+runtime"),
    /**
     * runtime resolution scope
     * = compile + runtime dependencies
     */
    RUNTIME("runtime"),
    /**
     * runtime+system resolution scope (Maven 3 only)
     * = compile + system + runtime dependencies
     */
    RUNTIME_PLUS_SYSTEM("runtime+system"),
    /**
     * test resolution scope
     * = compile + system + provided + runtime + test
     * dependencies
     */
    TEST("test");

    private final String id;

    ResolutionScope(String id) {
        this.id = id;
    }

    public String id() {
        return this.id;
    }
}