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.scope;
20
21 /**
22 * Generic dependency scope.
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 DependencyScope {
30 /**
31 * The label.
32 *
33 * @return The identifier of this dependency scope, never {@code null}.
34 */
35 String getId();
36
37 /**
38 * Shorthand method of {@code getId().equals(String label)}.
39 *
40 * @param label The label to compare against, must not be {@code null}.
41 * @return {@code true} if this scope's identifier equals the given label, {@code false} otherwise.
42 */
43 default boolean is(String label) {
44 return getId().equals(label);
45 }
46
47 /**
48 * Is it transitive scope?
49 *
50 * @return {@code true} if dependencies in this scope are transitive, {@code false} otherwise.
51 */
52 boolean isTransitive();
53 }