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 import org.apache.maven.building.Source;
22
23 /**
24 * Collects toolchains that control the building of effective toolchains.
25 *
26 * @since 3.3.0
27 */
28 public interface ToolchainsBuildingRequest {
29
30 /**
31 * Gets the global toolchains source.
32 *
33 * @return The global toolchains source or {@code null} if none.
34 */
35 Source getGlobalToolchainsSource();
36
37 /**
38 * Sets the global toolchains source. If both user toolchains and a global toolchains are given, the user toolchains
39 * take precedence.
40 *
41 * @param globalToolchainsSource The global toolchains source, may be {@code null} to disable global toolchains.
42 * @return This request, never {@code null}.
43 */
44 ToolchainsBuildingRequest setGlobalToolchainsSource(Source globalToolchainsSource);
45
46 /**
47 * Gets the user toolchains source.
48 *
49 * @return The user toolchains source or {@code null} if none.
50 */
51 Source getUserToolchainsSource();
52
53 /**
54 * Sets the user toolchains source. If both user toolchains and a global toolchains are given, the user toolchains
55 * take precedence.
56 *
57 * @param userToolchainsSource The user toolchains source, may be {@code null} to disable user toolchains.
58 * @return This request, never {@code null}.
59 */
60 ToolchainsBuildingRequest setUserToolchainsSource(Source userToolchainsSource);
61 }