ContextQMD
Back to Bazel

JavaToolchainInfo

docs/versions/8.1.0/rules/lib/providers/JavaToolchainInfo.mdx

9.1.04.0 KB
Original Source
<html devsite> <head> <meta name="project_path" value="/_project.yaml"> <meta name="book_path" value="/versions/8.1.0/_book.yaml"> </head> <body> <h1 class="page-title" id="modules.JavaToolchainInfo">JavaToolchainInfo</h1>

{% dynamic setvar source_file "src/main/java/com/google/devtools/build/lib/starlarkbuildapi/java/JavaToolchainStarlarkApiProviderApi.java" %} {% dynamic setvar version "8.1.0" %} {% dynamic setvar original_path "/rules/lib/providers/JavaToolchainInfo" %} {% include "_buttons.html" %}

<!-- {% raw %} -->

Provides access to information about the Java toolchain rule. Accessible as a 'java_toolchain' field on a Target struct.

<h2>Members</h2> <ul> <li> <a href="#bootclasspath">bootclasspath</a> </li> <li> <a href="#ijar">ijar</a> </li> <li> <a href="#jacocorunner">jacocorunner</a> </li> <li> <a href="#java_runtime">java_runtime</a> </li> <li> <a href="#jvm_opt">jvm_opt</a> </li> <li> <a href="#label">label</a> </li> <li> <a href="#proguard_allowlister">proguard_allowlister</a> </li> <li> <a href="#single_jar">single_jar</a> </li> <li> <a href="#source_version">source_version</a> </li> <li> <a href="#target_version">target_version</a> </li> <li> <a href="#tools">tools</a> </li> </ul> 
  <h2 id="bootclasspath">bootclasspath</h2>
    <p><pre class="rule-signature"><a class="anchor" href="../builtins/depset.html">depset</a> JavaToolchainInfo.bootclasspath</pre></p>

The Java target bootclasspath entries. Corresponds to javac's -bootclasspath flag.


    <h2 id="ijar">ijar</h2>
    <p><pre class="rule-signature"><a class="anchor" href="../providers/FilesToRunProvider.html">FilesToRunProvider</a> JavaToolchainInfo.ijar</pre></p>

A FilesToRunProvider representing the ijar executable.


    <h2 id="jacocorunner">jacocorunner</h2>
    <p><pre class="rule-signature"><a class="anchor" href="../providers/FilesToRunProvider.html">FilesToRunProvider</a> JavaToolchainInfo.jacocorunner</pre></p>

The jacocorunner used by the toolchain.

     May return <code>None</code>.

    <h2 id="java_runtime">java_runtime</h2>
    <p><pre class="rule-signature"><a class="anchor" href="../providers/JavaRuntimeInfo.html">JavaRuntimeInfo</a> JavaToolchainInfo.java_runtime</pre></p>

The java runtime information.


    <h2 id="jvm_opt">jvm_opt</h2>
    <p><pre class="rule-signature"><a class="anchor" href="../builtins/depset.html">depset</a> JavaToolchainInfo.jvm_opt</pre></p>

The default options for the JVM running the java compiler and associated tools.


    <h2 id="label">label</h2>
    <p><pre class="rule-signature"><a class="anchor" href="../builtins/Label.html">Label</a> JavaToolchainInfo.label</pre></p>

The toolchain label.


    <h2 id="proguard_allowlister">proguard_allowlister</h2>
    <p><pre class="rule-signature"><a class="anchor" href="../providers/FilesToRunProvider.html">FilesToRunProvider</a> JavaToolchainInfo.proguard_allowlister</pre></p>

Return the binary to validate proguard configuration

     May return <code>None</code>.

    <h2 id="single_jar">single_jar</h2>
    <p><pre class="rule-signature"><a class="anchor" href="../providers/FilesToRunProvider.html">FilesToRunProvider</a> JavaToolchainInfo.single_jar</pre></p>

The SingleJar deploy jar.


    <h2 id="source_version">source_version</h2>
    <p><pre class="rule-signature"><a class="anchor" href="../core/string.html">string</a> JavaToolchainInfo.source_version</pre></p>

The java source version.


    <h2 id="target_version">target_version</h2>
    <p><pre class="rule-signature"><a class="anchor" href="../core/string.html">string</a> JavaToolchainInfo.target_version</pre></p>

The java target version.


    <h2 id="tools">tools</h2>
    <p><pre class="rule-signature"><a class="anchor" href="../builtins/depset.html">depset</a> JavaToolchainInfo.tools</pre></p>

The compilation tools.
</body> </html> <!-- {% endraw %} -->