1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.api;
20
21 import org.apache.maven.api.annotations.Experimental;
22 import org.apache.maven.api.annotations.Immutable;
23
24 import static org.apache.maven.api.ExtensibleEnums.projectScope;
25
26 /**
27 * Project scope.
28 * Defines the type of source files to compile, usually either the one that compose the output package
29 * (i.e. the <i>main</i> artifact) or the ones that will be used when building <i>tests</i>).
30 * <p>
31 * This extensible enum has two defined values, {@link #MAIN} and {@link #TEST},
32 * but can be extended by registering a {@code org.apache.maven.api.spi.ProjectScopeProvider}.
33 * <p>
34 * Implementation must have {@code equals()} and {@code hashCode()} implemented, so implementations of this interface
35 * can be used as keys.
36 *
37 * @since 4.0.0
38 */
39 @Experimental
40 @Immutable
41 @SuppressWarnings("checkstyle:InterfaceIsType")
42 public interface ProjectScope extends ExtensibleEnum {
43
44 /**
45 * Main scope.
46 */
47 ProjectScope MAIN = projectScope("main");
48
49 /**
50 * Test scope.
51 */
52 ProjectScope TEST = projectScope("test");
53 }