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