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} 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 public static final ArtifactScopeEnum checkScope( ArtifactScopeEnum scope )
54 {
55 return scope == null ? DEFAULT_SCOPE : scope;
56 }
57
58 /**
59 *
60 * @return unsafe String representation of this scope.
61 */
62 public String getScope()
63 {
64 if ( id == 1 )
65 {
66 return Artifact.SCOPE_COMPILE;
67 }
68 else if ( id == 2 )
69 {
70 return Artifact.SCOPE_TEST;
71
72 }
73 else if ( id == 3 )
74 {
75 return Artifact.SCOPE_RUNTIME;
76
77 }
78 else if ( id == 4 )
79 {
80 return Artifact.SCOPE_PROVIDED;
81 }
82 else if ( id == 5 )
83 {
84 return Artifact.SCOPE_SYSTEM;
85 }
86 else
87 {
88 return Artifact.SCOPE_RUNTIME_PLUS_SYSTEM;
89 }
90 }
91
92 private static final ArtifactScopeEnum [][][] COMPLIANCY_SETS = {
93 { { compile }, { compile, provided, system } }
94 , { { test }, { compile, test, provided, system } }
95 , { { runtime }, { compile, runtime, system } }
96 , { { provided }, { compile, test, provided } }
97 };
98
99 /**
100 * scope relationship function. Used by the graph conflict resolution policies
101 *
102 * @param scope
103 * @return true is supplied scope is an inclusive sub-scope of current one.
104 */
105 public boolean encloses( ArtifactScopeEnum scope )
106 {
107 final ArtifactScopeEnum s = checkScope( scope );
108
109 // system scope is historic only - and simple
110 if ( id == system.id )
111 {
112 return scope.id == system.id;
113 }
114
115 for ( ArtifactScopeEnum[][] set : COMPLIANCY_SETS )
116 {
117 if ( id == set[0][0].id )
118 {
119 for ( ArtifactScopeEnum ase : set[1] )
120 {
121 if ( s.id == ase.id )
122 {
123 return true;
124 }
125 }
126 break;
127 }
128 }
129 return false;
130 }
131 }