View Javadoc

1   package org.apache.maven.settings.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.settings.Settings;
25  
26  /**
27   * Collects the output of the settings builder.
28   * 
29   * @author Benjamin Bentmann
30   */
31  public interface SettingsBuildingResult
32  {
33  
34      /**
35       * Gets the assembled settings.
36       * 
37       * @return The assembled settings, never {@code null}.
38       */
39      Settings getEffectiveSettings();
40  
41      /**
42       * Gets the problems that were encountered during the settings building. Note that only problems of severity
43       * {@link SettingsProblem.Severity#WARNING} and below are reported here. Problems with a higher severity level cause
44       * the settings builder to fail with a {@link SettingsBuildingException}.
45       * 
46       * @return The problems that were encountered during the settings building, can be empty but never {@code null}.
47       */
48      List<SettingsProblem> getProblems();
49  
50  }