001package org.apache.maven.toolchain;
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 java.io.File;
023
024import org.apache.maven.toolchain.model.PersistedToolchains;
025
026/**
027 * Builds the toolchains model from a previously configured filesystem path to the toolchains file.
028 * <strong>Note:</strong> This is an internal component whose interface can change without prior notice.
029 *
030 * @author Benjamin Bentmann
031 */
032public interface ToolchainsBuilder
033{
034
035    /**
036     * Builds the toolchains model from the configured toolchain files.
037     *
038     * @param userToolchainsFile The path to the toolchains file, may be <code>null</code> to disable parsing.
039     * @return The toolchains model or <code>null</code> if no toolchain file was configured or the configured file does
040     *         not exist.
041     * @throws MisconfiguredToolchainException If the toolchain file exists but cannot be parsed.
042     */
043    PersistedToolchains build( File userToolchainsFile )
044        throws MisconfiguredToolchainException;
045
046}