001package 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/**
023 * Builds the effective settings from a user settings file and/or a global settings file.
024 * 
025 * @author Benjamin Bentmann
026 */
027public interface SettingsBuilder
028{
029
030    /**
031     * Builds the effective settings of the specified settings files.
032     * 
033     * @param request The settings building request that holds the parameters, must not be {@code null}.
034     * @return The result of the settings building, never {@code null}.
035     * @throws SettingsBuildingException If the effective settings could not be built.
036     */
037    SettingsBuildingResult build( SettingsBuildingRequest request )
038        throws SettingsBuildingException;
039
040}