View Javadoc
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;
20  
21  import java.io.File;
22  
23  import org.apache.maven.toolchain.model.PersistedToolchains;
24  
25  /**
26   * Builds the toolchains model from a previously configured filesystem path to the toolchains file.
27   * <strong>Note:</strong> This is an internal component whose interface can change without prior notice.
28   *
29   * @author Benjamin Bentmann
30   * @deprecated use {@link org.apache.maven.toolchain.building.ToolchainsBuilder} instead
31   */
32  @Deprecated
33  public interface ToolchainsBuilder {
34  
35      /**
36       * Builds the toolchains model from the configured toolchain files.
37       *
38       * @param userToolchainsFile The path to the toolchains file, may be <code>null</code> to disable parsing.
39       * @return The toolchains model or <code>null</code> if no toolchain file was configured or the configured file does
40       *         not exist.
41       * @throws MisconfiguredToolchainException If the toolchain file exists but cannot be parsed.
42       */
43      PersistedToolchains build(File userToolchainsFile) throws MisconfiguredToolchainException;
44  }