1 package org.apache.maven.classrealm;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.util.List;
23
24 /**
25 * Describes the requirements for a new class realm.
26 *
27 * @author Benjamin Bentmann
28 */
29 public interface ClassRealmRequest
30 {
31
32 /**
33 * The type of a class realm.
34 */
35 enum RealmType
36 {
37 /**
38 * The class realm for the public API of the Maven core.
39 */
40 Core,
41
42 /**
43 * A class realm for a project to aggregates its build extensions.
44 */
45 Project,
46
47 /**
48 * A class realm for a build extension.
49 */
50 Extension,
51
52 /**
53 * A class realm for a plugin.
54 */
55 Plugin,
56 }
57
58 /**
59 * Gets the type of the class realm.
60 *
61 * @return The type of the class realm, never {@code null}.
62 */
63 RealmType getType();
64
65 /**
66 * Gets the parent class realm (if any).
67 *
68 * @return The parent class realm or {@code null} if using the Maven core realm as parent.
69 */
70 ClassLoader getParent();
71
72 /**
73 * Gets the packages/types to import from the parent realm.
74 *
75 * @return The modifiable list of packages/types to import from the parent realm, never {@code null}.
76 */
77 List<String> getImports();
78
79 /**
80 * Gets the constituents for the class realm.
81 *
82 * @return The modifiable list of constituents for the class realm, never {@code null}.
83 */
84 List<ClassRealmConstituent> getConstituents();
85
86 }