1 package org.apache.maven.model.building;
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 import org.apache.maven.model.Model;
25 import org.apache.maven.model.Profile;
26
27 /**
28 * Collects the output of the model builder.
29 *
30 * @author Benjamin Bentmann
31 */
32 public interface ModelBuildingResult
33 {
34
35 /**
36 * Gets the sequence of model identifiers that denote the lineage of models from which the effective model was
37 * constructed. Model identifiers have the form {@code <groupId>:<artifactId>:<version>}. The first identifier from
38 * the list denotes the model on which the model builder was originally invoked. The last identifier will always be
39 * an empty string that by definition denotes the super POM.
40 *
41 * @return The model identifiers from the lineage of models, never {@code null}.
42 */
43 List<String> getModelIds();
44
45 /**
46 * Gets the assembled model.
47 *
48 * @return The assembled model, never {@code null}.
49 */
50 Model getEffectiveModel();
51
52 /**
53 * Gets the raw model as it was read from the input model source. Apart from basic validation, the raw model has not
54 * undergone any updates by the model builder, e.g. reflects neither inheritance nor interpolation.
55 *
56 * @return The raw model, never {@code null}.
57 */
58 Model getRawModel();
59
60 /**
61 * Gets the specified raw model as it was read from a model source. Apart from basic validation, a raw model has not
62 * undergone any updates by the model builder, e.g. reflects neither inheritance nor interpolation. The model
63 * identifier should be from the collection obtained by {@link #getModelIds()}. As a special case, an empty string
64 * can be used as the identifier for the super POM.
65 *
66 * @param modelId The identifier of the desired raw model, must not be {@code null}.
67 * @return The raw model or {@code null} if the specified model id does not refer to a known model.
68 */
69 Model getRawModel( String modelId );
70
71 /**
72 * Gets the profiles from the specified model that were active during model building. The model identifier should be
73 * from the collection obtained by {@link #getModelIds()}. As a special case, an empty string can be used as the
74 * identifier for the super POM.
75 *
76 * @param modelId The identifier of the model whose active profiles should be retrieved, must not be {@code null}.
77 * @return The active profiles of the model or an empty list if none or {@code null} if the specified model id does
78 * not refer to a known model.
79 */
80 List<Profile> getActivePomProfiles( String modelId );
81
82 /**
83 * Gets the external profiles that were active during model building. External profiles are those that were
84 * contributed by {@link ModelBuildingRequest#getProfiles()}.
85 *
86 * @return The active external profiles or an empty list if none, never {@code null}.
87 */
88 List<Profile> getActiveExternalProfiles();
89
90 /**
91 * Gets the problems that were encountered during the model building. Note that only problems of severity
92 * {@link ModelProblem.Severity#WARNING} and below are reported here. Problems with a higher severity level cause
93 * the model builder to fail with a {@link ModelBuildingException}.
94 *
95 * @return The problems that were encountered during the model building, can be empty but never {@code null}.
96 */
97 List<ModelProblem> getProblems();
98
99 }