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.api;
20
21 import java.util.Map;
22
23 import org.apache.maven.api.annotations.Experimental;
24
25 /**
26 * Toolchain interface.
27 *
28 * @since 4.0.0
29 */
30 @Experimental
31 public interface Toolchain {
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 cannot be found
44 */
45 String findTool(String toolName);
46
47 /**
48 * Let the toolchain decide if it matches requirements defined
49 * in the toolchain plugin configuration.
50 * @param requirements Map<String, String> key value pair, may not be {@code null}
51 * @return {@code true} if the requirements match, otherwise {@code false}
52 */
53 boolean matchesRequirements(Map<String, String> requirements);
54 }