1 package org.apache.maven.toolchain.building;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 /**
23 * Builds the effective toolchains from a user toolchains file and/or a global toolchains file.
24 *
25 * @author Robert Scholte
26 * @since 3.3.0
27 */
28 public interface ToolchainsBuilder
29 {
30
31 /**
32 * Builds the effective toolchains of the specified toolchains files.
33 *
34 * @param request The toolchains building request that holds the parameters, must not be {@code null}.
35 * @return The result of the toolchains building, never {@code null}.
36 * @throws ToolchainsBuildingException If the effective toolchains could not be built.
37 */
38 ToolchainsBuildingResult build( ToolchainsBuildingRequest request )
39 throws ToolchainsBuildingException;
40
41 }