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