View Javadoc
1   package org.apache.maven.artifact;
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  /**
23   * Type safe reincarnation of Artifact scope. Also supplies the <code>DEFAULT_SCOPE<code> as well
24   * as convenience method to deal with scope relationships.
25   *
26   * @author <a href="oleg@codehaus.org">Oleg Gusakov</a>
27   *
28   */
29  
30  public enum ArtifactScopeEnum
31  {
32      compile( 1 ), test( 2 ), runtime( 3 ), provided( 4 ), system( 5 ), runtime_plus_system( 6 );
33  
34      public static final ArtifactScopeEnum DEFAULT_SCOPE = compile;
35  
36      private int id;
37  
38      // Constructor
39      ArtifactScopeEnum( int id )
40      {
41          this.id = id;
42      }
43  
44      int getId()
45      {
46          return id;
47      }
48  
49  
50      /**
51       * Helper method to simplify null processing
52       *
53       * @return
54       */
55      public static final ArtifactScopeEnum checkScope( ArtifactScopeEnum scope )
56      {
57          return scope == null ? DEFAULT_SCOPE : scope;
58      }
59  
60      /**
61       *
62       * @return unsafe String representation of this scope.
63       */
64      public String getScope()
65      {
66          if ( id == 1 )
67          {
68              return Artifact.SCOPE_COMPILE;
69          }
70          else if ( id == 2 )
71          {
72              return Artifact.SCOPE_TEST;
73  
74          }
75          else if ( id == 3 )
76          {
77              return Artifact.SCOPE_RUNTIME;
78  
79          }
80          else if ( id == 4 )
81          {
82              return Artifact.SCOPE_PROVIDED;
83          }
84          else if ( id == 5 )
85          {
86              return Artifact.SCOPE_SYSTEM;
87          }
88          else
89          {
90              return Artifact.SCOPE_RUNTIME_PLUS_SYSTEM;
91          }
92      }
93  
94      private static final ArtifactScopeEnum [][][] COMPLIANCY_SETS = {
95            { { compile  }, { compile,                provided, system } }
96          , { { test     }, { compile, test,          provided, system } }
97          , { { runtime  }, { compile,       runtime,           system } }
98          , { { provided }, { compile, test,          provided         } }
99      };
100 
101     /**
102      * scope relationship function. Used by the graph conflict resolution policies
103      *
104      * @param scope
105      * @return true is supplied scope is an inclusive sub-scope of current one.
106      */
107     public boolean encloses( ArtifactScopeEnum scope )
108     {
109         final ArtifactScopeEnum s = checkScope( scope );
110 
111         // system scope is historic only - and simple
112         if ( id == system.id )
113         {
114             return scope.id == system.id;
115         }
116 
117         for ( ArtifactScopeEnum[][] set : COMPLIANCY_SETS )
118         {
119             if ( id == set[0][0].id )
120             {
121                 for ( ArtifactScopeEnum ase : set[1] )
122                 {
123                     if ( s.id == ase.id )
124                     {
125                         return true;
126                     }
127                 }
128                 break;
129             }
130         }
131         return false;
132     }
133 }