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.Session;
23 import org.apache.maven.api.annotations.Experimental;
24 import org.apache.maven.api.annotations.Nonnull;
25
26 /**
27 * Builds the effective toolchains from a user toolchains file and/or a global toolchains file.
28 *
29 * @since 4.0.0
30 */
31 @Experimental
32 public interface ToolchainsBuilder extends Service {
33
34 /**
35 * Builds the effective toolchains for the specified toolchains files.
36 *
37 * @param request the toolchains building request that holds the parameters, must not be {@code null}
38 * @return the result of the toolchains building, never {@code null}
39 * @throws ToolchainsBuilderException if the effective toolchains could not be built
40 */
41 ToolchainsBuilderResult build(ToolchainsBuilderRequest request);
42
43 /**
44 * Builds the effective toolchains for the specified toolchains sources.
45 *
46 * @param session the {@link Session}, must not be {@code null}
47 * @param globalToolchainsSource The {@link Source} pointing to the global toolchains, must not be {@code null}
48 * @param userToolchainsSource The {@link Source} pointing to the user toolchains, must not be {@code null}
49 * @throws ToolchainsBuilderException if the project cannot be created
50 * @throws IllegalArgumentException if an argument is {@code null} or invalid
51 * @see #build(ToolchainsBuilderRequest)
52 */
53 @Nonnull
54 default ToolchainsBuilderResult build(
55 @Nonnull Session session, @Nonnull Source globalToolchainsSource, @Nonnull Source userToolchainsSource) {
56 return build(ToolchainsBuilderRequest.build(session, globalToolchainsSource, userToolchainsSource));
57 }
58 }