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
021/**
022 * Label for "build path", like "compile", "runtime", etc.
023 *
024 * @since 2.0.0
025 *
026 * @noimplement This interface is not intended to be implemented by clients.
027 * @noextend This interface is not intended to be extended by clients.
028 */
029public interface BuildPath {
030    /**
031     * The label.
032     */
033    String getId();
034
035    /**
036     * A flag denoting that this build path "reverses" the expected order of project paths.
037     * <p>
038     * For example: "compile" step expects "main" then "test" order (compile them in this order).
039     * On the other hand, "runtime" expects "test" to have run first. In this sense, "runtime" is reverse.
040     * <p>
041     * If {@code false}, then {@link ProjectPath#order()} is used to sort project paths, otherwise the
042     * {@link ProjectPath#reverseOrder()} is used to sort them.
043     */
044    boolean isReverse();
045
046    /**
047     * Returns the "order" of this path, usable to sort against other instances.
048     * Expected natural order is "compile", "runtime"... (basically like the processing order).
049     */
050    int order();
051}