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.eclipse.aether.impl.scope;
20
21 import java.util.Set;
22
23 /**
24 * Build scope is certain combination of {@link ProjectPath} and {@link BuildPath}.
25 *
26 * @since 2.0.0
27 *
28 * @noimplement This interface is not intended to be implemented by clients.
29 * @noextend This interface is not intended to be extended by clients.
30 */
31 public interface BuildScope {
32 /**
33 * The label.
34 */
35 String getId();
36
37 /**
38 * The project paths this scope belongs to.
39 */
40 Set<ProjectPath> getProjectPaths();
41
42 /**
43 * The build paths this scope belongs to.
44 */
45 Set<BuildPath> getBuildPaths();
46
47 /**
48 * Returns the "order" of this scope, usable to sort against other instances.
49 * Expected natural order is "main-compile", "test-compile"... (basically like the processing order).
50 * <p>
51 * Note: this order is unrelated to {@link ProjectPath#order()} and {@link BuildPath#order()} and
52 * should be used only to sort build scope instances.
53 */
54 int order();
55 }