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.settings.building;
20  
21  /**
22   * Builds the effective settings from a user settings file, a project settings file
23   * and/or a global settings file.
24   *
25   */
26  public interface SettingsBuilder {
27  
28      /**
29       * Builds the effective settings of the specified settings files.
30       *
31       * @param request The settings building request that holds the parameters, must not be {@code null}.
32       * @return The result of the settings building, never {@code null}.
33       * @throws SettingsBuildingException If the effective settings could not be built.
34       */
35      SettingsBuildingResult build(SettingsBuildingRequest request) throws SettingsBuildingException;
36  }