Java_common

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Utilitários para suporte à compilação Java no Starlark.

Membros

BootClassPathInfo

Provider java_common.BootClassPathInfo

O provedor usado para fornecer informações do 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 JAR/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 required
O contexto da regra.
source_jars Sequência de arquivos. O padrão é []
. Uma lista dos JARs a serem compilados. Pelo menos um entre source_jars ou source_files precisa ser especificado.
source_files Sequência de arquivos. O padrão é []
. Uma lista dos arquivos de origem Java a serem compilados. Pelo menos um entre source_jars ou source_files precisa ser especificado.
output obrigatório
output_source_jar File ou None. O padrão é None
. O jar de origem de saída. Opcional. O padrão é {output_jar}-src.jar se não for definido.
javac_opts sequência de strings. O padrão é []
Uma lista das opções javac desejadas. Opcional.
deps Sequência de structs; o padrão é []
. Uma lista de dependências. Opcional.
runtime_deps sequência de struct. O padrão é []
Uma lista de dependências do ambiente de execução. Opcional.
exports Sequência de structs; o padrão é []
Uma lista de exportações. Opcional.
plugins Sequência de struct ou Sequência de struct. O padrão é []
Uma lista de plug-ins. Opcional.
exported_plugins Sequência de structs ou sequência de structs. O padrão é []
. Uma lista de plug-ins exportados. Opcional.
native_libraries sequência de CcInfos. O padrão é []
dependências de bibliotecas nativas em CC necessárias para essa biblioteca.
annotation_processor_additional_inputs Sequência de Files. O padrão é []
Uma lista de entradas que a ação de compilação Java vai realizar, além das fontes Java para o processamento de anotações.
annotation_processor_additional_outputs Sequência de arquivos; 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 padrão é 'ERROR'
Uma string que especifica como lidar com dependências rígidas. Valores possíveis: 'OFF', 'ERROR', 'WARN' e 'DEFAULT'. Para mais detalhes, consulte /docs/user-manual#flag--strict_java_deps. Por padrão, "ERROR".
java_toolchain required
Um JavaToolchainInfo a ser usado para essa compilação. Obrigatório.
bootclasspath o padrão é None
Um BootClassPathInfo a ser usado para essa compilação. Se presente, substitui o bootclasspath associado ao java_datasets fornecido. Opcional.
host_javabase O padrão é None
Descontinuado. Esse parâmetro foi descontinuado e será removido em breve. Não dependa dele. Ele está desativado com --+incompatible_java_common_parameters. Use essa flag para verificar se o código é compatível com a remoção iminente.
Descontinuado: você pode excluir esse parâmetro (host_javabase é fornecido com java_toolchain)
sourcepath sequência de Arquivos. O padrão é []
.
resources sequência de arquivos; o padrão é []
.
resource_jars sequência de Arquivos. O padrão é []
.
classpath_resources sequência de arquivos; o padrão é []
.
O padrão é False
enable_annotation_processing O padrão é True
Desativa o processamento de anotações nessa compilação, fazendo com que todos os processadores de anotações fornecidos em plug-ins ou em exported_plugins de dependências sejam ignorados.
enable_compile_jar_action o padrão é True
Ativa a compilação de cabeçalho ou a criação de ijar. Se definido como falso, ele força o uso do jar de classe completo nos classpaths de compilação de todos os dependentes. Isso é destinado ao uso por destinos que não são bibliotecas, como binários que não têm dependentes.
add_exports Sequência de strings; o padrão é []
Permite que essa biblioteca acesse o / fornecido. Opcional.
add_opens sequência de strings. O padrão é []
Permite que essa biblioteca acesse de forma refletida o /fornecido. Opcional.

JavaRuntimeInfo

Provider java_common.JavaRuntimeInfo

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

JavaToolchainInfo

Provider java_common.JavaToolchainInfo

A chave usada para recuperar o provedor que contém informações sobre o conjunto de ferramentas Java que está sendo usado.

merge

struct java_common.merge(providers)

Mescla os provedores fornecidos em um único JavaInfo.

Parâmetros

Parâmetro Descrição
providers sequência de struct; obrigatório
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

.Pelo menos um dos parâmetros output_jar ou output_source_jar é obrigatório.

Parâmetros

Parâmetro Descrição
actions obrigatório
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 está desativado com --+incompatible_java_common_parameters. Use essa sinalização 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 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 sequência de arquivos; o padrão é []
Uma lista de arquivos de origem Java a serem empacotados no jar de origem.
source_jars Sequência de Files. O padrão é []
Uma lista de jars de origem a serem compactados no jar de origem.
java_toolchain obrigatório
Uma JavaToolchainInfo a ser usada 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 está desativado com --+incompatible_java_common_parameters. Use essa flag para verificar se o código é compatível com a remoção iminente.
Descontinuado: você pode excluir 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-o dos corpos do método. Isso ajuda a reduzir a recriação de jars dependentes durante as recompilações que consistem apenas em alterações simples nas implementações do método. O valor de retorno normalmente é transmitido para JavaInfo#compile_jar.

Parâmetros

Parâmetro Descrição
actions required
ctx.actions
jar obrigatório
O jar em que o ijar será executado.
target_label Rótulo; ou None; o padrão é None
: um rótulo de destino para carimbar o pote. Usado para suporte a add_dep. Normalmente, você transmite ctx.label para carimbar o jarro com o rótulo da regra atual.
java_toolchain required
Um JavaToolchainInfo usado para encontrar a ferramenta ijar.

stamp_jar

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

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

Parâmetros

Parâmetro Descrição
actions required
ctx.actions
jar required
O jar para executar o stamp_jar.
target_label required
Um rótulo de destino para carimbar o frasco. Usado para suporte a add_dep. Normalmente, você transmitiria ctx.label para incluir o rótulo da regra atual no jar.
java_toolchain obrigatório
Uma JavaToolchainInfo usada para encontrar a ferramenta stamp_jar.