java_common

Utilidades para admitir la compilación de Java en Starlark

Miembros

BootClassPathInfo

Provider java_common.BootClassPathInfo

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

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

Compila archivos/jars de origen Java de la implementación de una regla de Starlark y muestra un proveedor que representa los resultados de la compilación y que se puede agregar al conjunto de proveedores emitidos por esta regla.

Parámetros

Parámetro Descripción
ctx obligatorio
El contexto de la regla.
source_jars sequence of Files; predeterminado = []
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 sequence of Files; predeterminado = []
Es una lista de los archivos de origen de 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; or None; predeterminado = Ninguno
El archivo jar fuente de salida. Opcional. Si no se configura, el valor predeterminado es “{output_jar}-src.jar”.
javac_opts sequence of strings; predeterminado = []
Una lista de las opciones de javac deseadas. Opcional.
deps sequence of JavaInfos; predeterminado = []
Una lista de dependencias. Opcional.
runtime_deps sequence of JavaInfos; predeterminado = []
Una lista de dependencias del entorno de ejecución. Opcional.
exports sequence of JavaInfos; predeterminado = []
Una lista de exportaciones. Opcional.
plugins sequence of JavaPluginInfos; or sequence of JavaInfos; predeterminado = []
Una lista de complementos. Opcional.
exported_plugins sequence of JavaPluginInfos; or sequence of JavaInfos; predeterminado = []
Una lista de complementos exportados. Opcional.
native_libraries sequence of CcInfos; predeterminado = []
Agrega en Cc las dependencias de bibliotecas nativas que se necesiten para esta biblioteca.
annotation_processor_additional_inputs sequence of Files; predeterminado = []
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 sequence of Files; predeterminado = []
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 predeterminado = 'ERROR'
Es una cadena que especifica cómo controlar las dependencias estrictas. Valores posibles: "OFF", "ERROR", "WARN" y 'DEFAULT'. Para obtener más información, consulta /docs/user-manual#flag--strict_java_deps. El valor predeterminado es "ERROR".
java_toolchain obligatorio
Una JavaToolchainInfo que se usará para esta compilación. Obligatoria.
host_javabase valor predeterminado = Ninguno
Obsoleto. Este parámetro dejó de estar disponible y se quitará pronto. No dependa de él. Está inhabilitada con --+incompatible_java_common_parameters. Usa esta función experimental para verificar que tu código sea compatible con su eliminación inminente.
Obsoleto: Puedes descartar este parámetro (host_javabase se proporciona con java_toolchain).
sourcepath sequence of Files; predeterminado = []
resources sequence of Files; predeterminado = []
resource_jars sequence of Files; predeterminado = []
classpath_resources sequence of Files; predeterminado = []
predeterminado = Falso
enable_annotation_processing default = True
Inhabilita el procesamiento de anotaciones en esta compilación, lo que hace que se ignoren los procesadores de anotaciones proporcionados en complementos o en export_plugins de dependencias.
enable_compile_jar_action default = True
Habilita la compilación de encabezados o la creación de ijar. Si se configura como falsa, se fuerza el uso del archivo jar de la clase completa en las rutas de clase de compilación de cualquier dependiente. Esto está diseñado para que lo usen los destinos que no pertenecen a la biblioteca, como los objetos binarios que no tienen dependientes.
add_exports sequence of strings; predeterminado = []
Permite que esta biblioteca acceda a la /especificada. Opcional.
add_opens sequence of strings; predeterminado = []
Permite que esta biblioteca acceda de manera reflectiva a la clase /especificada. Opcional.

JavaPluginInfo

Provider java_common.JavaPluginInfo

La clave que se usa para recuperar el proveedor que contiene información sobre los complementos de Java. Se puede acceder al mismo valor que JavaPluginInfo.
Prefieres usar JavaPluginInfo en un código nuevo.

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

Es la clave que se usa para recuperar el proveedor que contiene información sobre la cadena de herramientas de Java que se está usando.

make_non_strict

JavaInfo java_common.make_non_strict(java_info)

Muestra un proveedor de Java nuevo cuya parte de jars directos es la unión de los archivos jar indirectos y directos del proveedor de Java determinado.

Parámetros

Parámetro Descripción
java_info obligatorio
La información de Java.

combinar

JavaInfo java_common.merge(providers, *, merge_java_outputs=True, merge_source_jars=True)

Combina los proveedores especificados en un solo JavaInfo.

Parámetros

Parámetro Descripción
providers sequence of JavaInfos; obligatorio
Es la lista de proveedores que se combinarán.
merge_java_outputs default = True
merge_source_jars default = True

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 los de origen en un solo archivo JAR de origen. Por lo general, el valor que se devuelve se pasa a

JavaInfo#source_jar

.Se requiere al menos uno de los parámetros output_jar o output_source_jar.

Parámetros

Parámetro Descripción
actions obligatorio
ctx.actions
output_jar File; or None; predeterminado = Ninguno
Obsoleto. Este parámetro dejó de estar disponible y se quitará pronto. No dependa de él. Está inhabilitada con --+incompatible_java_common_parameters. Usa esta función experimental para verificar que tu código sea compatible con su eliminación inminente.
Obsoleto: Es el jar resultante de la regla. Se usa para asignar un nombre al archivo 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; or None; predeterminado = Ninguno
El archivo jar fuente de salida.
sources sequence of Files; predeterminado = []
Lista de archivos de origen de Java que se empaquetarán en el archivo jar de origen.
source_jars sequence of Files; predeterminado = []
Una lista de archivos jar de origen para empaquetar en el jar de origen.
java_toolchain obligatorio
Un JavaToolchainInfo que se usa para encontrar la herramienta ijar.
host_javabase valor predeterminado = Ninguno
Obsoleto. Este parámetro dejó de estar disponible y se quitará pronto. No dependa de él. Está inhabilitada con --+incompatible_java_common_parameters. Usa esta función experimental para verificar que tu código sea compatible con su eliminación inminente.
Obsoleto: Puedes descartar este parámetro (host_javabase se proporciona con java_toolchain).
Es posible que se muestre None.

proveedor

Provider java_common.provider

Muestra el proveedor declarado de Java.
Se puede acceder al mismo valor que JavaInfo.
Prefieres usar JavaInfo en un código nuevo.

run_ijar

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

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

Parámetros

Parámetro Descripción
actions obligatorio
ctx.actions
jar obligatorio
El jar en el que se ejecutará ijar.
target_label Label; or None; predeterminado = Ninguno
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 obligatorio
Un JavaToolchainInfo que se usa 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 la compatibilidad con add_dep. Por lo general, el valor que se muestra se pasa a JavaInfo#compile_jar. Prefieres usar run_ijar cuando sea posible.

Parámetros

Parámetro Descripción
actions obligatorio
ctx.actions
jar obligatorio
El jar en el que se ejecutará stamp_jar.
target_label obligatorio
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 obligatorio
Una JavaToolchainInfo que se usa para encontrar la herramienta stamp_jar.

to_java_binary_info

JavaInfo java_common.to_java_binary_info(java_info)

Muestra una copia del JavaInfo proporcionado con información mínima mostrada por un objeto java_binary.

Parámetros

Parámetro Descripción
java_info obligatorio
El JavaInfo para mejorar.