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 /**
22 * Label for "build path", like "compile", "runtime", etc.
23 *
24 * @since 2.0.0
25 *
26 * @noimplement This interface is not intended to be implemented by clients.
27 * @noextend This interface is not intended to be extended by clients.
28 */
29 public interface BuildPath {
30 /**
31 * The label.
32 */
33 String getId();
34
35 /**
36 * A flag denoting that this build path "reverses" the expected order of project paths.
37 * <p>
38 * For example: "compile" step expects "main" then "test" order (compile them in this order).
39 * On the other hand, "runtime" expects "test" to have run first. In this sense, "runtime" is reverse.
40 * <p>
41 * If {@code false}, then {@link ProjectPath#order()} is used to sort project paths, otherwise the
42 * {@link ProjectPath#reverseOrder()} is used to sort them.
43 */
44 boolean isReverse();
45
46 /**
47 * Returns the "order" of this path, usable to sort against other instances.
48 * Expected natural order is "compile", "runtime"... (basically like the processing order).
49 */
50 int order();
51 }