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