IMPORTANT: The Bazel docs have moved! Please update your bookmark to https://bazel.build/rules/lib/java_common
You can read about the migration, and let us know what you think.
Extensions >
API reference >
java_common
java_common
Utilities for Java compilation support in Starlark.Members
BootClassPathInfo
Provider java_common.BootClassPathInfoThe provider used to supply bootclasspath information
compile
JavaInfo java_common.compile(ctx, *, source_jars=[], source_files=[], output, output_source_jar=None, javac_opts=[], deps=[], runtime_deps=[], exports=[], plugins=[], exported_plugins=[], native_libraries=[], annotation_processor_additional_inputs=[], annotation_processor_additional_outputs=[], strict_deps='ERROR', java_toolchain, host_javabase=None, sourcepath=[], resources=[], classpath_resources=[], neverlink=False, enable_annotation_processing=True, enable_compile_jar_action=True)Compiles Java source files/jars from the implementation of a Starlark rule and returns a provider that represents the results of the compilation and can be added to the set of providers emitted by this rule.
Parameters
Parameter | Description |
---|---|
ctx
|
required The rule context. |
source_jars
|
sequence of Files ;
default = []A list of the jars to be compiled. At least one of source_jars or source_files should be specified. |
source_files
|
sequence of Files ;
default = []A list of the Java source files to be compiled. At least one of source_jars or source_files should be specified. |
output
|
required |
output_source_jar
|
File; or None ;
default = NoneThe output source jar. Optional. Defaults to `{output_jar}-src.jar` if unset. |
javac_opts
|
sequence of strings ;
default = []A list of the desired javac options. Optional. |
deps
|
sequence of JavaInfos ;
default = []A list of dependencies. Optional. |
runtime_deps
|
sequence of JavaInfos ;
default = []A list of runtime dependencies. Optional. |
exports
|
sequence of JavaInfos ;
default = []A list of exports. Optional. |
plugins
|
sequence of JavaPluginInfos; or sequence of JavaInfos ;
default = []A list of plugins. Optional. |
exported_plugins
|
sequence of JavaPluginInfos; or sequence of JavaInfos ;
default = []A list of exported plugins. Optional. |
native_libraries
|
sequence of CcInfos ;
default = []CC native library dependencies that are needed for this library. |
annotation_processor_additional_inputs
|
sequence of Files ;
default = []A list of inputs that the Java compilation action will take in addition to the Java sources for annotation processing. |
annotation_processor_additional_outputs
|
sequence of Files ;
default = []A list of outputs that the Java compilation action will output in addition to the class jar from annotation processing. |
strict_deps
|
default = 'ERROR' A string that specifies how to handle strict deps. Possible values: 'OFF', 'ERROR', 'WARN' and 'DEFAULT'. For more details see https://docs.bazel.build/versions/main/bazel-user-manual.html#flag--strict_java_deps. By default 'ERROR'. |
java_toolchain
|
required A JavaToolchainInfo to be used for this compilation. Mandatory. |
host_javabase
|
default = None Deprecated. This parameter is deprecated and will be removed soon. Please do not depend on it. It is disabled with --+incompatible_java_common_parameters . Use this flag to verify your code is compatible with its imminent removal. Deprecated: You can drop this parameter (host_javabase is provided with java_toolchain) |
sourcepath
|
sequence of Files ;
default = [] |
resources
|
sequence of Files ;
default = [] |
classpath_resources
|
sequence of Files ;
default = [] |
neverlink
|
default = False |
enable_annotation_processing
|
default = True Disables annotation processing in this compilation, causing any annotation processors provided in plugins or in exported_plugins of deps to be ignored. |
enable_compile_jar_action
|
default = True Enables header compilation or ijar creation. If set to False, it forces use of the full class jar in the compilation classpaths of any dependants. Doing so is intended for use by non-library targets such as binaries that do not have dependants. |
JavaPluginInfo
Provider java_common.JavaPluginInfoThe key used to retrieve the provider that contains information about the Java plugins. The same value is accessible as
JavaPluginInfo
. Prefer using
JavaPluginInfo
in new code.
JavaRuntimeInfo
Provider java_common.JavaRuntimeInfoThe key used to retrieve the provider that contains information about the Java runtime being used.
JavaToolchainInfo
Provider java_common.JavaToolchainInfoThe key used to retrieve the provider that contains information about the Java toolchain being used.
make_non_strict
JavaInfo java_common.make_non_strict(java_info)Returns a new Java provider whose direct-jars part is the union of both the direct and indirect jars of the given Java provider.
Parameters
Parameter | Description |
---|---|
java_info
|
required The java info. |
merge
JavaInfo java_common.merge(providers, runtime_deps=[])Merges the given providers into a single JavaInfo.
Parameters
Parameter | Description |
---|---|
providers
|
sequence of JavaInfos ;
requiredThe list of providers to merge. |
runtime_deps
|
sequence of JavaInfos ;
default = []A list of runtime dependencies. Optional. |
pack_sources
File java_common.pack_sources(actions, *, output_jar=None, output_source_jar=None, sources=[], source_jars=[], java_toolchain, host_javabase=None)Packs sources and source jars into a single source jar file. The return value is typically passed to
JavaInfo#source_jar
Parameters
Parameter | Description |
---|---|
actions
|
required ctx.actions |
output_jar
|
File; or None ;
default = NoneDeprecated. This parameter is deprecated and will be removed soon. Please do not depend on it. It is disabled with --+incompatible_java_common_parameters . Use this flag to verify your code is compatible with its imminent removal. Deprecated: The output jar of the rule. Used to name the resulting source jar. The parameter sets output_source_jar parameter to `{output_jar}-src.jar`.Use output_source_jar parameter directly instead. |
output_source_jar
|
File; or None ;
default = NoneThe output source jar. |
sources
|
sequence of Files ;
default = []A list of Java source files to be packed into the source jar. |
source_jars
|
sequence of Files ;
default = []A list of source jars to be packed into the source jar. |
java_toolchain
|
required A JavaToolchainInfo to used to find the ijar tool. |
host_javabase
|
default = None Deprecated. This parameter is deprecated and will be removed soon. Please do not depend on it. It is disabled with --+incompatible_java_common_parameters . Use this flag to verify your code is compatible with its imminent removal. Deprecated: You can drop this parameter (host_javabase is provided with java_toolchain) |
None
.
provider
Provider java_common.providerReturns the Java declared provider.
The same value is accessible as
JavaInfo
. Prefer using
JavaInfo
in new code.
run_ijar
File java_common.run_ijar(actions, *, jar, target_label=None, java_toolchain)Runs ijar on a jar, stripping it of its method bodies. This helps reduce rebuilding of dependent jars during any recompiles consisting only of simple changes to method implementations. The return value is typically passed to
JavaInfo#compile_jar
.
Parameters
Parameter | Description |
---|---|
actions
|
required ctx.actions |
jar
|
required The jar to run ijar on. |
target_label
|
Label; or None ;
default = NoneA target label to stamp the jar with. Used for add_dep support. Typically, you would pass ctx.label to stamp the jar with the current rule's label.
|
java_toolchain
|
required A JavaToolchainInfo to used to find the ijar tool. |
stamp_jar
File java_common.stamp_jar(actions, *, jar, target_label, java_toolchain)Stamps a jar with a target label for
add_dep
support. The return value is typically passed to JavaInfo#compile_jar
. Prefer to use run_ijar
when possible.
Parameters
Parameter | Description |
---|---|
actions
|
required ctx.actions |
jar
|
required The jar to run stamp_jar on. |
target_label
|
required A target label to stamp the jar with. Used for add_dep support. Typically, you would pass ctx.label to stamp the jar with the current rule's label.
|
java_toolchain
|
required A JavaToolchainInfo to used to find the stamp_jar tool. |
to_java_binary_info
JavaInfo java_common.to_java_binary_info(java_info)Returns a copy of the given JavaInfo with minimal info returned by a java_binary
Parameters
Parameter | Description |
---|---|
java_info
|
required The JavaInfo to enhance. |