View Javadoc

1   package org.apache.maven.plugins.annotations;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.artifact.Artifact;
23  
24  /**
25   * Dependencies resolution scopes available before
26   * <a href="/ref/current/maven-core/apidocs/org/apache/maven/lifecycle/internal/MojoExecutor.html">mojo execution</a>.
27   *
28   * @author Hervé Boutemy
29   * @since 3.0
30   */
31  public enum ResolutionScope
32  {
33      /**
34       * <code>compile</code> resolution scope
35       * = <code>compile</code> + <code>system</code> + <code>provided</code> dependencies
36       */
37      COMPILE( Artifact.SCOPE_COMPILE ),
38      /**
39       * <code>compile+runtime</code> resolution scope (Maven 3 only)
40       * = <code>compile</code> + <code>system</code> + <code>provided</code> + <code>runtime</code> dependencies
41       */
42      COMPILE_PLUS_RUNTIME( Artifact.SCOPE_COMPILE_PLUS_RUNTIME ),
43      /**
44       * <code>runtime</code> resolution scope
45       * = <code>compile</code> + <code>runtime</code> dependencies
46       */
47      RUNTIME( Artifact.SCOPE_RUNTIME ),
48      /**
49       * <code>runtime+system</code> resolution scope (Maven 3 only)
50       * = <code>compile</code> + <code>system</code> + <code>runtime</code> dependencies
51       */
52      RUNTIME_PLUS_SYSTEM( Artifact.SCOPE_RUNTIME_PLUS_SYSTEM ),
53      /**
54       * <code>test</code> resolution scope
55       * = <code>compile</code> + <code>system</code> + <code>provided</code> + <code>runtime</code> + <code>test</code>
56       * dependencies
57       */
58      TEST( Artifact.SCOPE_TEST );
59  
60      private final String id;
61  
62      ResolutionScope( String id )
63      {
64          this.id = id;
65      }
66  
67      public String id()
68      {
69          return this.id;
70      }
71  }