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.api.services;
20
21 import org.apache.maven.api.Service;
22 import org.apache.maven.api.annotations.Experimental;
23
24 /**
25 * Builds the effective toolchains from a user toolchains file and/or a global toolchains file.
26 */
27 @Experimental
28 public interface ToolchainsBuilder extends Service {
29
30 /**
31 * Builds the effective toolchains of the specified toolchains files.
32 *
33 * @param request the toolchains building request that holds the parameters, must not be {@code null}
34 * @return the result of the toolchains building, never {@code null}
35 * @throws ToolchainsBuilderException if the effective toolchains could not be built
36 */
37 ToolchainsBuilderResult build(ToolchainsBuilderRequest request);
38 }