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 org.apache.maven.api.annotations.Experimental;
22
23 /**
24 * Represents a Java toolchain in the Maven build system.
25 *
26 * <p>A Java toolchain is a specific type of toolchain that provides access
27 * to Java development tools, such as the Java compiler and Java runtime
28 * environment. This interface allows users to define and configure
29 * Java-related toolchains that can be utilized during the build process
30 * in Maven.</p>
31 *
32 * <p>Java toolchains are defined in the Maven toolchains.xml file and can
33 * be referenced in the project's POM file. This enables developers to
34 * specify the exact versions of Java tools they wish to use, ensuring
35 * consistency across different build environments.</p>
36 *
37 * @since 4.0.0
38 * @see Toolchain
39 * @see org.apache.maven.api.services.ToolchainManager
40 */
41 @Experimental
42 public interface JavaToolchain extends Toolchain {
43
44 String getJavaHome();
45 }