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