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.toolchain.building;
20  
21  /**
22   * Builds the effective toolchains from a user toolchains file and/or a global toolchains file.
23   *
24   * @author Robert Scholte
25   * @since 3.3.0
26   */
27  public interface ToolchainsBuilder {
28  
29      /**
30       * Builds the effective toolchains of the specified toolchains files.
31       *
32       * @param request The toolchains building request that holds the parameters, must not be {@code null}.
33       * @return The result of the toolchains building, never {@code null}.
34       * @throws ToolchainsBuildingException If the effective toolchains could not be built.
35       */
36      ToolchainsBuildingResult build(ToolchainsBuildingRequest request) throws ToolchainsBuildingException;
37  }