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