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