001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.impl.scope;
020
021import java.util.Set;
022
023/**
024 * Build scope is certain combination of {@link ProjectPath} and {@link BuildPath}.
025 *
026 * @since 2.0.0
027 *
028 * @noimplement This interface is not intended to be implemented by clients.
029 * @noextend This interface is not intended to be extended by clients.
030 */
031public interface BuildScope {
032    /**
033     * The label.
034     */
035    String getId();
036
037    /**
038     * The project paths this scope belongs to.
039     */
040    Set<ProjectPath> getProjectPaths();
041
042    /**
043     * The build paths this scope belongs to.
044     */
045    Set<BuildPath> getBuildPaths();
046
047    /**
048     * Returns the "order" of this scope, usable to sort against other instances.
049     * Expected natural order is "main-compile", "test-compile"... (basically like the processing order).
050     * <p>
051     * Note: this order is unrelated to {@link ProjectPath#order()} and {@link BuildPath#order()} and
052     * should be used only to sort build scope instances.
053     */
054    int order();
055}