Para obtener documentación sobre versiones estables, usa el menú desplegable "Documentos con versiones". La vista predeterminada refleja la versión más reciente en el encabezado.

Se usó la API de Cloud Translation para traducir esta página.

java_common

Informar un problema Ver fuente

Utilidades para la compatibilidad de compilación de Java en Starlark.

BootClassPathInfo

Provider java_common.BootClassPathInfo

El proveedor que se usa para proporcionar información de bootclasspath

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

Compila archivos de origen o jar de Java a partir de la implementación de una regla de Starlark y muestra un proveedor que representa los resultados de la compilación y se puede agregar al conjunto de proveedores que emite esta regla.

Parámetros

Parámetro	Descripción
`ctx`	required El contexto de la regla.
`source_jars`	secuencia de Archivos; el valor predeterminado es `[]` Una lista de los archivos jar que se compilarán. Se debe especificar al menos uno de los archivos source_jars o source_files.
`source_files`	secuencia de Archivos; el valor predeterminado es `[]` Una lista de los archivos de origen Java que se compilarán. Se debe especificar al menos uno de los archivos source_jars o source_files.
`output`	obligatorio
`output_source_jar`	File o `None`; el valor predeterminado es `None` El jar de origen de salida. Opcional. Si no se configura, el valor predeterminado es `{output_jar}-src.jar`.
`javac_opts`	secuencia de strings; el valor predeterminado es `[]` Una lista de las opciones de javac deseadas. Opcional.
`deps`	secuencia de structs; el valor predeterminado es `[]` Una lista de dependencias. Opcional.
`runtime_deps`	secuencia de structs; el valor predeterminado es `[]` Una lista de dependencias del entorno de ejecución. Opcional.
`exports`	secuencia de structs; el valor predeterminado es `[]` Una lista de exportaciones. Opcional.
`plugins`	secuencia de struct o secuencia de struct; el valor predeterminado es `[]` Una lista de complementos. Opcional.
`exported_plugins`	secuencia de struct o secuencia de struct; el valor predeterminado es `[]` Una lista de complementos exportados. Opcional.
`native_libraries`	secuencia de CcInfo; el valor predeterminado es `[]` dependencias de la biblioteca nativa de CC que se necesitan para esta biblioteca.
`annotation_processor_additional_inputs`	secuencia de Archivos; el valor predeterminado es `[]` Una lista de entradas que tomará la acción de compilación de Java, además de las fuentes de Java, para el procesamiento de anotaciones.
`annotation_processor_additional_outputs`	secuencia de archivos; el valor predeterminado es `[]` Una lista de resultados que generará la acción de compilación de Java además del archivo jar de clase del procesamiento de anotaciones.
`strict_deps`	el valor predeterminado es `'ERROR'` Es una cadena que especifica cómo controlar las dependencias estrictas. Valores posibles: “OFF”, “ERROR”, “WARN” y “DEFAULT”. Para ver más detalles, consulte /docs/user-manual#flag--strict_java_deps. De forma predeterminada, “ERROR”.
`java_toolchain`	required Un JavaToolchainInfo que se usará en esta compilación. Obligatoria.
`bootclasspath`	el valor predeterminado es `None` Es un BootClassPathInfo que se usará para esta compilación. Si está presente, anula la bootclasspath asociada con el java_toolchain proporcionado. Opcional.
`host_javabase`	el valor predeterminado es `None` Obsoleto. Este parámetro dejó de estar disponible y se quitará pronto. No dependas de ello. Está inhabilitada con `--+incompatible_java_common_parameters`. Usa esta marca para verificar que tu código sea compatible con la eliminación inminente. Obsoleto: Puedes descartar este parámetro (host_javabase se proporciona con java_toolchain).
`sourcepath`	secuencia de Archivos; el valor predeterminado es `[]`
`resources`	secuencia de Archivos; el valor predeterminado es `[]`
`resource_jars`	secuencia de Archivos; el valor predeterminado es `[]`
`classpath_resources`	secuencia de Archivos; el valor predeterminado es `[]`
`neverlink`	la configuración predeterminada es `False`
`enable_annotation_processing`	el valor predeterminado es `True` Inhabilita el procesamiento de anotaciones en esta compilación, lo que provoca que se ignoren los procesadores de anotaciones proporcionados en los complementos o en export_plugins de dependencias.
`enable_compile_jar_action`	el valor predeterminado es `True` Habilita la compilación de encabezados o la creación de ijar. Si se configura como falsa, fuerza el uso del archivo jar de clase completo en las rutas de clase de la compilación de cualquier dependencia. Esto está diseñado para que lo usen objetivos no pertenecientes a la biblioteca, como objetos binarios que no tienen dependientes.
`add_exports`	secuencia de strings; el valor predeterminado es `[]` Permite que esta biblioteca acceda a las /dadas. Opcional.
`add_opens`	secuencia de strings; el valor predeterminado es `[]` Permite que esta biblioteca acceda de manera reflexiva a los /especificados. Opcional.

JavaRuntimeInfo

Provider java_common.JavaRuntimeInfo

La clave que se usa para recuperar el proveedor que contiene información sobre el entorno de ejecución de Java que se usa.

JavaToolchainInfo

Provider java_common.JavaToolchainInfo

La clave usada para recuperar el proveedor que contiene información sobre la cadena de herramientas de Java utilizada.

merge

struct java_common.merge(providers)

Combina los proveedores dados en un solo JavaInfo.

Parámetros

Parámetro	Descripción
`providers`	secuencia de structs; obligatoria Es la lista de proveedores que se combinarán.

pack_sources

File java_common.pack_sources(actions, *, output_jar=None, output_source_jar=None, sources=[], source_jars=[], java_toolchain, host_javabase=None)

Empaqueta los archivos jar de origen y de origen en un solo archivo jar de origen. Por lo general, el valor que se muestra se pasa

JavaInfo#source_jar

.Al menos uno de los parámetros output_jar o output_source_jar es obligatorio.

Parámetros

Parámetro	Descripción
`actions`	acciones ctx.actions obligatorias
`output_jar`	File o `None`; el valor predeterminado es `None` Obsoleto. Este parámetro dejó de estar disponible y se quitará pronto. No dependas de ello. Está inhabilitada con `--+incompatible_java_common_parameters`. Usa esta marca para verificar que tu código sea compatible con la eliminación inminente. Obsoleto: Es el jar de salida de la regla. Se usa para nombrar el jar de origen resultante. El parámetro establece el parámetro output_source_jar en `{output_jar}-src.jar`.En su lugar, usa el parámetro output_source_jar directamente.
`output_source_jar`	File o `None`; el valor predeterminado es `None` El jar de origen de salida.
`sources`	secuencia de Archivos; el valor predeterminado es `[]` Una lista de archivos de origen de Java que se empaquetarán en el jar de origen.
`source_jars`	secuencia de Archivos; el valor predeterminado es `[]` Una lista de archivos jar de origen que se empaquetarán en el jar de origen.
`java_toolchain`	required Es un JavaToolchainInfo que se usará para encontrar la herramienta ijar.
`host_javabase`	el valor predeterminado es `None` Obsoleto. Este parámetro dejó de estar disponible y se quitará pronto. No dependas de ello. Está inhabilitada con `--+incompatible_java_common_parameters`. Usa esta marca para verificar que tu código sea compatible con la eliminación inminente. Obsoleto: Puedes descartar este parámetro (host_javabase se proporciona con java_toolchain).

run_ijar

File java_common.run_ijar(actions, *, jar, target_label=None, java_toolchain)

Ejecuta ijar en un frasco y lo quita de los cuerpos del método. Esto ayuda a reducir la recompilación de archivos jar dependientes durante cualquier recompilación que consista solo en cambios simples en las implementaciones de métodos. Por lo general, el valor que se muestra se pasa a JavaInfo#compile_jar.

Parámetros

Parámetro	Descripción
`actions`	acciones ctx.actions obligatorias
`jar`	required El jar en el que se ejecutará ijar.
`target_label`	Etiqueta; o `None`; la configuración predeterminada es `None` Es una etiqueta objetivo para sellar el frasco. Se usa para la compatibilidad con `add_dep`. Por lo general, pasarías `ctx.label` para sellar el jar con la etiqueta de la regla actual.
`java_toolchain`	required Es un JavaToolchainInfo que se usará para encontrar la herramienta ijar.

stamp_jar

File java_common.stamp_jar(actions, *, jar, target_label, java_toolchain)

Sella un frasco con una etiqueta de destino para admitir add_dep. Por lo general, el valor que se muestra se pasa a JavaInfo#compile_jar. Prefiere usar run_ijar cuando sea posible.

Parámetros

Parámetro	Descripción
`actions`	acciones ctx.actions obligatorias
`jar`	required El jar en el que se ejecutará stamp_jar.
`target_label`	obligatorio Una etiqueta de destino para sellar el frasco Se usa para la compatibilidad con `add_dep`. Por lo general, pasarías `ctx.label` para sellar el jar con la etiqueta de la regla actual.
`java_toolchain`	required Es un JavaToolchainInfo que se usará para encontrar la herramienta stamp_jar.