View Javadoc

1   package org.apache.maven.toolchain;
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 java.io.File;
23  
24  import org.apache.maven.toolchain.model.PersistedToolchains;
25  
26  /**
27   * Builds the toolchains model from a previously configured filesystem path to the toolchains file.
28   * <strong>Note:</strong> This is an internal component whose interface can change without prior notice.
29   * 
30   * @author Benjamin Bentmann
31   */
32  public interface ToolchainsBuilder
33  {
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 )
44          throws MisconfiguredToolchainException;
45  
46  }