001    package org.apache.maven.settings.building;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import java.util.List;
023    
024    import org.apache.maven.settings.Settings;
025    
026    /**
027     * Collects the output of the settings builder.
028     * 
029     * @author Benjamin Bentmann
030     */
031    public interface SettingsBuildingResult
032    {
033    
034        /**
035         * Gets the assembled settings.
036         * 
037         * @return The assembled settings, never {@code null}.
038         */
039        Settings getEffectiveSettings();
040    
041        /**
042         * Gets the problems that were encountered during the settings building. Note that only problems of severity
043         * {@link SettingsProblem.Severity#WARNING} and below are reported here. Problems with a higher severity level cause
044         * the settings builder to fail with a {@link SettingsBuildingException}.
045         * 
046         * @return The problems that were encountered during the settings building, can be empty but never {@code null}.
047         */
048        List<SettingsProblem> getProblems();
049    
050    }