Java_common

Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6
Utilitários para suporte à compilação Java no Starlark.

Membros

BootClassPathInfo

Provider java_common.BootClassPathInfo

O provedor usado para fornecer informações 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 arquivos/jars de origem Java da implementação de uma regra do Starlark e retorna um provedor que representa os resultados da compilação e pode ser adicionado ao conjunto de provedores emitidos por essa regra.

Parâmetros

Parâmetro Descrição
ctx ctx; required
O contexto da regra.
source_jars sequence de Files; o padrão é []
Uma lista dos jars a serem compilados. É necessário especificar pelo menos um de "source_jars" ou "source_files".
source_files sequence de Files; o padrão é []
Uma lista dos arquivos de origem Java a serem compilados. É necessário especificar pelo menos um de "source_jars" ou "source_files".
output Arquivo; required
output_source_jar Arquivo ou None; o padrão é None
O jar de origem de saída. O padrão é `{output_jar}-src.jar` se não for definido.
javac_opts sequence de strings; o padrão é []
Uma lista das opções javac desejadas.
deps sequence de structs; o padrão é []
Uma lista de dependências.
runtime_deps sequence de structs; o padrão é []
Uma lista de dependências de tempo de execução.
exports sequence de structs; o padrão é []
Uma lista de exportações.
plugins sequência de structs ou sequência de structs; o padrão é []
Uma lista de plug-ins.
exported_plugins sequence de structs ou sequence de structs. O padrão é []
. Uma lista de plug-ins exportados.
native_libraries sequence de CcInfos; o padrão é []
Dependências de biblioteca nativa do CC necessárias para essa biblioteca.
annotation_processor_additional_inputs sequence de Files; o padrão é []
Uma lista de entradas que a ação de compilação do Java vai usar, além das fontes Java para o processamento de anotações.
annotation_processor_additional_outputs Sequência de Files; o padrão é []
Uma lista de saídas que a ação de compilação Java vai gerar além do jar de classe do processamento de anotações.
strict_deps string; o padrão é 'ERROR'
Uma string que especifica como processar dependências estritas. Valores possíveis: "OFF", "ERROR", "WARN" e "DEFAULT". Para mais detalhes, consulte --strict_java_deps flag. By default 'ERROR'.
java_toolchain Info; required
Uma JavaToolchainInfo a ser usada para esta compilação. Obrigatório.
bootclasspath O padrão é None
Um BootClassPathInfo a ser usado para esta compilação. Se presente, substitui o bootclasspath associado à java_toolchain fornecida.
host_javabase O padrão é None
Descontinuado. Esse parâmetro foi descontinuado e será removido em breve. Não dependa dele. Ele fica desativado com --incompatible_java_common_parameters. Use essa flag para verificar se seu código é compatível com a remoção iminente.
Descontinuado: é possível descartar esse parâmetro (host_javabase é fornecido com java_toolchain)
sourcepath sequência de Files; o padrão é []
resources sequência de Files; o padrão é []
resource_jars sequência de Files; o padrão é []
classpath_resources sequência de Files; o padrão é []
bool; o padrão é False
enable_annotation_processing bool; o padrão é True
Desativa o processamento de anotações nesta compilação, fazendo com que todos os processadores de anotações fornecidos em plug-ins ou em exported_plugins de deps sejam ignorados.
enable_compile_jar_action bool; o padrão é True
Ativa a compilação de cabeçalho ou a criação de ijar. Se definido como "False", força o uso do jar da classe completa nos caminhos de classe de compilação de todos os dependentes. Isso é destinado ao uso por destinos que não são de biblioteca, como binários sem dependentes.
add_exports sequência de strings; o padrão é []
Permite que essa biblioteca acesse o /especificado.
add_opens sequência de strings; o padrão é []
. Permite que essa biblioteca acesse de forma reflexiva o /especificado.

JavaRuntimeInfo

Provider java_common.JavaRuntimeInfo

A chave usada para recuperar o provedor que contém informações sobre o ambiente de execução do Java em uso.

JavaToolchainInfo

Provider java_common.JavaToolchainInfo

A chave usada para recuperar o provedor que contém informações sobre a cadeia de ferramentas Java em uso.

merge

struct java_common.merge(providers)

Mescla os provedores especificados em um único JavaInfo.

Parâmetros

Parâmetro Descrição
providers sequence de structs; required
A lista de provedores a serem mesclados.

pack_sources

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

Empacota fontes e jars de origem em um único arquivo jar de origem. O valor de retorno normalmente é transmitido para

JavaInfo#source_jar

.É necessário incluir pelo menos um dos parâmetros output_jar ou output_source_jar.

Parâmetros

Parâmetro Descrição
actions actions; required
ctx.actions
output_jar Arquivo ou None; o padrão é None
Descontinuado. Esse parâmetro foi descontinuado e será removido em breve. Não dependa dele. Ele fica desativado com --incompatible_java_common_parameters. Use essa flag para verificar se seu código é compatível com a remoção iminente.
Descontinuado: o jar de saída da regra. Usado para nomear o jar de origem resultante. O parâmetro define o parâmetro output_source_jar como `{output_jar}-src.jar`.Use o parâmetro output_source_jar diretamente.
output_source_jar Arquivo ou None; o padrão é None
O jar de origem de saída.
sources sequence de Files; o padrão é []
Uma lista de arquivos de origem Java a serem empacotados no jar de origem.
source_jars sequence de Files; o padrão é []
Uma lista de jars de origem a serem empacotados no jar de origem.
java_toolchain Info; required
Um JavaToolchainInfo usado para encontrar a ferramenta ijar.
host_javabase O padrão é None
Descontinuado. Esse parâmetro foi descontinuado e será removido em breve. Não dependa dele. Ele fica desativado com --incompatible_java_common_parameters. Use essa flag para verificar se seu código é compatível com a remoção iminente.
Descontinuado: é possível descartar esse parâmetro (host_javabase é fornecido com java_toolchain)

run_ijar

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

Executa o ijar em um jar, removendo os corpos de método dele. Isso ajuda a reduzir a recriação de jars dependentes durante qualquer recompilação que consista apenas em mudanças simples nas implementações de métodos. O valor de retorno geralmente é transmitido para JavaInfo#compile_jar.

Parâmetros

Parâmetro Descrição
actions actions; required
ctx.actions
jar Arquivo; obrigatório
O jar para executar o ijar.
target_label Rótulo ou None. O padrão é None
. Um rótulo de destino para marcar o jar. Usado para suporte do add_dep. Normalmente, você transmite ctx.label para marcar o jar com o rótulo da regra atual.
java_toolchain Info; required
Um JavaToolchainInfo usado para encontrar a ferramenta ijar.

stamp_jar

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

Marca um pote com um rótulo de destino para suporte a add_dep. O valor de retorno geralmente é transmitido para JavaInfo#compile_jar. Prefira usar run_ijar sempre que possível.

Parâmetros

Parâmetro Descrição
actions actions; required
ctx.actions
jar File; required
O jar para executar stamp_jar.
target_label Rótulo; required
Um rótulo de destino para marcar o frasco. Usado para suporte do add_dep. Normalmente, você transmite ctx.label para marcar o jar com o rótulo da regra atual.
java_toolchain Info; required
Um JavaToolchainInfo usado para encontrar a ferramenta stamp_jar.