1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
package org.apache.maven.toolchain;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.List;
import java.util.Map;
import org.apache.maven.execution.MavenSession;
/**
* Public API for a toolchain-aware plugin to get expected toolchain instance.
*
* @author mkleint
* @author Robert Scholte
* @since 2.0.9
*/
public interface ToolchainManager
{
// NOTE: Some plugins like Surefire access this field directly!
@Deprecated
String ROLE = ToolchainManager.class.getName();
/**
* Retrieve toolchain of specified type from build context. It is expected that
* <code>maven-toolchains-plugin</code> contains the configuration to select the appropriate
* toolchain and is executed at the beginning of the build.
*
* @param session the Maven session, must not be {@code null}
* @param type the type, must not be {@code null}
* @return the toolchain selected by <code>maven-toolchains-plugin</code>
*/
Toolchain getToolchainFromBuildContext( String type, MavenSession context );
/**
* Select all toolchains available in user settings matching the type and requirements,
* independently from <code>maven-toolchains-plugin</code>.
*
* @param session the Maven session, must not be {@code null}
* @param type the type, must not be {@code null}
* @param requirements the requirements, may be {@code null}
* @return the matching toolchains, never {@code null}
* @since 3.3.0
*/
List<Toolchain> getToolchains( MavenSession session, String type, Map<String, String> requirements );
}
|
