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