api/maven-api-core/src/main/java/org/apache/maven/api/ProjectScope.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.api;

import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.annotations.Immutable;

import static org.apache.maven.api.ExtensibleEnums.projectScope;

/**
 * Project scope.
 * Defines the type of source files to compile, usually either the one that compose the output package
 * (i.e. the <i>main</i> artifact) or the ones that will be used when building <i>tests</i>).
 * <p>
 * This extensible enum has two defined values, {@link #MAIN} and {@link #TEST},
 * but can be extended by registering a {@code org.apache.maven.api.spi.ProjectScopeProvider}.
 * <p>
 * Implementation must have {@code equals()} and {@code hashCode()} implemented, so implementations of this interface
 * can be used as keys.
 *
 * @since 4.0.0
 */
@Experimental
@Immutable
@SuppressWarnings("checkstyle:InterfaceIsType")
public interface ProjectScope extends ExtensibleEnum {

    /**
     * Main scope.
     */
    ProjectScope MAIN = projectScope("main");

    /**
     * Test scope.
     */
    ProjectScope TEST = projectScope("test");
}