Skip to main content
Utilities for Java compilation support in Starlark.

​
Members

​
BootClassPathInfo

Provider java_common.BootClassPathInfo
The provider used to supply bootclasspath information

​
compile

struct 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, bootclasspath=None, sourcepath=[], resources=[], resource_jars=[], classpath_resources=[], neverlink=False, enable_annotation_processing=True, enable_compile_jar_action=True, add_exports=[], add_opens=[])
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

ParameterDescriptionctxctx; required The rule context. source_jarssequence of File s; default is [] A list of the jars to be compiled. At least one of source_jars or source_files should be specified. source_filessequence of File s; default is [] A list of the Java source files to be compiled. At least one of source_jars or source_files should be specified. outputFile; required output_source_jarFile; or None; default is None The output source jar. Defaults to {output_jar}-src.jar if unset. javac_optssequence of string s; default is [] A list of the desired javac options. depssequence of struct s; default is [] A list of dependencies. runtime_depssequence of struct s; default is [] A list of runtime dependencies. exportssequence of struct s; default is [] A list of exports. pluginssequence of struct s; or sequence of struct s; default is [] A list of plugins. exported_pluginssequence of struct s; or sequence of struct s; default is [] A list of exported plugins. native_librariessequence of CcInfo s; default is [] CC native library dependencies that are needed for this library. annotation_processor_additional_inputssequence of File s; default is [] A list of inputs that the Java compilation action will take in addition to the Java sources for annotation processing. annotation_processor_additional_outputssequence of File s; default is [] A list of outputs that the Java compilation action will output in addition to the class jar from annotation processing. strict_depsstring; default is 'ERROR' A string that specifies how to handle strict deps. Possible values: ‘OFF’, ‘ERROR’, ‘WARN’ and ‘DEFAULT’. For more details see --strict_java_deps flag . By default 'ERROR'. ``java_toolchain Info; required A JavaToolchainInfo to be used for this compilation. Mandatory. bootclasspath default is None A BootClassPathInfo to be used for this compilation. If present, overrides the bootclasspath associated with the provided java_toolchain. sourcepathsequence of File s; default is [] resourcessequence of File s; default is [] resource_jarssequence of File s; default is [] classpath_resourcessequence of File s; default is [] neverlinkbool; default is False enable_annotation_processingbool; default is 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_actionbool; default is 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. add_exportssequence of string s; default is [] Allow this library to access the given /. add_openssequence of string s; default is [] Allow this library to reflectively access the given /.

​
JavaRuntimeInfo

Provider java_common.JavaRuntimeInfo
The key used to retrieve the provider that contains information about the Java runtime being used.

​
JavaToolchainInfo

Provider java_common.JavaToolchainInfo
The key used to retrieve the provider that contains information about the Java toolchain being used.

​
merge

struct java_common.merge(providers)
Merges the given providers into a single JavaInfo.

​
Parameters

ParameterDescriptionproviderssequence of struct s; required The list of providers to merge.

​
pack_sources

File java_common.pack_sources(actions, *, output_source_jar=None, sources=[], source_jars=[], java_toolchain)
Packs sources and source jars into a single source jar file. The return value is typically passed to JavaInfo#source_jar .At least one of parameters output_jar or output_source_jar is required.

​
Parameters

ParameterDescriptionactionsactions; required ctx.actions output_source_jarFile; or None; default is None The output source jar. sourcessequence of File s; default is [] A list of Java source files to be packed into the source jar. source_jarssequence of File s; default is [] A list of source jars to be packed into the source jar. java_toolchain Info; required A JavaToolchainInfo to used to find the ijar tool.

​
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

ParameterDescriptionactionsactions; required ctx.actions jarFile; required The jar to run ijar on. target_labelLabel; or None; default is None 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 Info; 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

ParameterDescriptionactionsactions; required ctx.actions jarFile; required The jar to run stamp_jar on. target_labelLabel; 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 Info; required A JavaToolchainInfo to used to find the stamp_jar tool.