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 import java.util.Collection;
22 import java.util.Optional;
23
24 /**
25 * Scope manager.
26 *
27 * @since 2.0.0
28 *
29 * @noimplement This interface is not intended to be implemented by clients.
30 * @noextend This interface is not intended to be extended by clients.
31 */
32 public interface ScopeManager {
33 /**
34 * The label.
35 */
36 String getId();
37
38 /**
39 * Returns the "system" scope, if exists.
40 * <p>
41 * This is a special scope. In this scope case, Resolver should handle it specially, as it has no POM (so is
42 * always a leaf on graph), is not in any repository, but is actually hosted on host OS file system. On resolution
43 * resolver merely checks is file present or not.
44 */
45 Optional<SystemDependencyScope> getSystemDependencyScope();
46
47 /**
48 * Returns a specific dependency scope by label.
49 * <p>
50 * Note: despite returns optional, this method may throw as well, if manager set in "strict" mode.
51 */
52 Optional<DependencyScope> getDependencyScope(String id);
53
54 /**
55 * Returns the "universe" (all) of dependency scopes.
56 */
57 Collection<DependencyScope> getDependencyScopeUniverse();
58
59 /**
60 * Returns a specific resolution scope by label.
61 * <p>
62 * Note: despite returns optional, this method may throw as well, if manager set in "strict" mode.
63 */
64 Optional<ResolutionScope> getResolutionScope(String id);
65
66 /**
67 * Returns the "universe" (all) of resolution scopes.
68 */
69 Collection<ResolutionScope> getResolutionScopeUniverse();
70 }