View Javadoc
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.java;
20  
21  import org.apache.maven.artifact.versioning.ArtifactVersion;
22  import org.apache.maven.toolchain.Toolchain;
23  
24  /**
25   * JDK toolchain interface.
26   *
27   * @author Jason van Zyl
28   * @author Milos Kleint
29   * @since 2.0.9, renamed from JavaToolChain in 3.2.4
30   */
31  public interface JavaToolchain extends Toolchain {
32      //    /**
33      //     * Returns a list of {@link java.io.File}s which represents the bootstrap libraries for the
34      //     * runtime environment. The Bootstrap libraries include libraries in JRE's
35      //     * extension directory, if there are any.
36      //     *
37      //     * @return List
38      //     */
39      //    List getBootstrapLibraries();
40      //
41      //    /**
42      //     * Returns a list of {@link java.io.File}s which represent the libraries recognized by
43      //     * default by the platform. Usually it corresponds to contents of CLASSPATH
44      //     * environment variable.
45      //     *
46      //     * @return List
47      //     */
48      //    List getStandardLibraries();
49      //
50      //    /**
51      //     * Returns a {@link java.io.File}s which represent the locations of the source of the JDK,
52      //     * or an empty collection when the location is not set or is invalid.
53      //     *
54      //     * @return List
55      //     */
56      //    List getSourceDirectories();
57      //
58      //    /**
59      //     * Returns a {@link java.io.File}s which represent the locations of the Javadoc for this platform,
60      //     * or empty collection if the location is not set or invalid
61      //     *
62      //     * @return List
63      //     */
64      //    List getJavadocDirectories();
65  
66      /**
67       * Returns the home directory of the JDK.
68       *
69       * @since 3.10.0
70       */
71      String getJavaHome();
72  
73      /**
74       * Returns the version of the JDK.
75       *
76       * @since 3.10.0
77       */
78      ArtifactVersion getJavaVersion();
79  }