001package org.apache.maven.toolchain.building;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.building.Source;
023
024/**
025 * Collects toolchains that control the building of effective toolchains.
026 *
027 * @author Robert Scholte
028 * @since 3.3.0
029 */
030public interface ToolchainsBuildingRequest
031{
032
033    /**
034     * Gets the global toolchains source.
035     *
036     * @return The global toolchains source or {@code null} if none.
037     */
038    Source getGlobalToolchainsSource();
039
040    /**
041     * Sets the global toolchains source. If both user toolchains and a global toolchains are given, the user toolchains
042     * take precedence.
043     *
044     * @param globalToolchainsSource The global toolchains source, may be {@code null} to disable global toolchains.
045     * @return This request, never {@code null}.
046     */
047    ToolchainsBuildingRequest setGlobalToolchainsSource( Source globalToolchainsSource );
048
049    /**
050     * Gets the user toolchains source.
051     *
052     * @return The user toolchains source or {@code null} if none.
053     */
054    Source getUserToolchainsSource();
055
056    /**
057     * Sets the user toolchains source. If both user toolchains and a global toolchains are given, the user toolchains
058     * take precedence.
059     *
060     * @param userToolchainsSource The user toolchains source, may be {@code null} to disable user toolchains.
061     * @return This request, never {@code null}.
062     */
063    ToolchainsBuildingRequest setUserToolchainsSource( Source userToolchainsSource );
064}