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       * empty resolution scope
35       */
36      NONE( null ),
37      /**
38       * <code>compile</code> resolution scope
39       * = <code>compile</code> + <code>system</code> + <code>provided</code> dependencies
40       */
41      COMPILE( Artifact.SCOPE_COMPILE ),
42      /**
43       * <code>compile+runtime</code> resolution scope (Maven 3 only)
44       * = <code>compile</code> + <code>system</code> + <code>provided</code> + <code>runtime</code> dependencies
45       */
46      COMPILE_PLUS_RUNTIME( Artifact.SCOPE_COMPILE_PLUS_RUNTIME ),
47      /**
48       * <code>runtime</code> resolution scope
49       * = <code>compile</code> + <code>runtime</code> dependencies
50       */
51      RUNTIME( Artifact.SCOPE_RUNTIME ),
52      /**
53       * <code>runtime+system</code> resolution scope (Maven 3 only)
54       * = <code>compile</code> + <code>system</code> + <code>runtime</code> dependencies
55       */
56      RUNTIME_PLUS_SYSTEM( Artifact.SCOPE_RUNTIME_PLUS_SYSTEM ),
57      /**
58       * <code>test</code> resolution scope
59       * = <code>compile</code> + <code>system</code> + <code>provided</code> + <code>runtime</code> + <code>test</code>
60       * dependencies
61       */
62      TEST( Artifact.SCOPE_TEST );
63  
64      private final String id;
65  
66      ResolutionScope( String id )
67      {
68          this.id = id;
69      }
70  
71      public String id()
72      {
73          return this.id;
74      }
75  }