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  /**
23   * Toolchain interface.
24   *
25   * @author Milos Kleint
26   * @author Jason van Zyl
27   * @since 2.0.9
28   */
29  public interface Toolchain
30  {
31  
32      /**
33       * get the type of toolchain.
34       *
35       * @return the toolchain type
36       */
37      String getType();
38  
39      /**
40       * Gets the platform tool executable.
41       *
42       * @param toolName the tool platform independent tool name.
43       * @return file representing the tool executable, or null if the tool can not be found
44       */
45      String findTool( String toolName );
46  }