| // Copyright 2018 The Bazel Authors. All rights reserved. |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| package com.google.devtools.build.lib.starlarkbuildapi.java; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.devtools.build.docgen.annot.DocCategory; |
| import com.google.devtools.build.lib.cmdline.Label; |
| import com.google.devtools.build.lib.collect.nestedset.Depset; |
| import net.starlark.java.annot.StarlarkBuiltin; |
| import net.starlark.java.annot.StarlarkMethod; |
| import net.starlark.java.eval.EvalException; |
| import net.starlark.java.eval.StarlarkThread; |
| import net.starlark.java.eval.StarlarkValue; |
| |
| /** A java compiler configuration. */ |
| @StarlarkBuiltin( |
| name = "java", |
| doc = "A java compiler configuration.", |
| category = DocCategory.CONFIGURATION_FRAGMENT) |
| public interface JavaConfigurationApi extends StarlarkValue { |
| |
| @StarlarkMethod( |
| name = "default_javac_flags", |
| structField = true, |
| doc = "The default flags for the Java compiler.") |
| // TODO(bazel-team): this is the command-line passed options, we should remove from Starlark |
| // probably. |
| ImmutableList<String> getDefaultJavacFlagsForStarlarkAsList(); |
| |
| @StarlarkMethod( |
| name = "default_javac_flags_depset", |
| structField = true, |
| doc = "The default flags for the Java compiler.") |
| // TODO(bazel-team): this is the command-line passed options, we should remove from Starlark |
| // probably. |
| Depset getDefaultJavacFlagsStarlark(); |
| |
| @StarlarkMethod( |
| name = "strict_java_deps", |
| structField = true, |
| doc = "The value of the strict_java_deps flag.") |
| String getStrictJavaDepsName(); |
| |
| @StarlarkMethod(name = "use_header_compilation", useStarlarkThread = true, documented = false) |
| boolean useHeaderCompilationStarlark(StarlarkThread thread) throws EvalException; |
| |
| @StarlarkMethod(name = "generate_java_deps", useStarlarkThread = true, documented = false) |
| boolean getGenerateJavaDepsStarlark(StarlarkThread thread) throws EvalException; |
| |
| @StarlarkMethod(name = "reduce_java_classpath", useStarlarkThread = true, documented = false) |
| String getReduceJavaClasspathStarlark(StarlarkThread thread) throws EvalException; |
| |
| @StarlarkMethod( |
| name = "default_jvm_opts", |
| structField = true, |
| doc = "Additional options to pass to the Java VM for each java_binary target") |
| ImmutableList<String> getDefaultJvmFlags(); |
| |
| @StarlarkMethod( |
| name = "one_version_enforcement_level", |
| structField = true, |
| doc = "The value of the --experimental_one_version_enforcement flag.") |
| String starlarkOneVersionEnforcementLevel(); |
| |
| @StarlarkMethod( |
| name = "one_version_enforcement_on_java_tests", |
| structField = true, |
| documented = false) |
| boolean enforceOneVersionOnJavaTests(); |
| |
| @StarlarkMethod(name = "add_test_support_to_compile_deps", structField = true, documented = false) |
| boolean addTestSupportToCompileTimeDeps(); |
| |
| @StarlarkMethod( |
| name = "run_android_lint", |
| structField = true, |
| doc = "The value of the --experimental_run_android_lint_on_java_rules flag.") |
| boolean runAndroidLint(); |
| |
| @StarlarkMethod( |
| name = "enforce_explicit_java_test_deps", |
| useStarlarkThread = true, |
| documented = false) |
| boolean explicitJavaTestDepsStarlark(StarlarkThread thread) throws EvalException; |
| |
| @StarlarkMethod( |
| name = "multi_release_deploy_jars", |
| structField = true, |
| doc = "The value of the --incompatible_multi_release_deploy_jars flag.") |
| boolean multiReleaseDeployJars(); |
| |
| @StarlarkMethod( |
| name = "plugins", |
| structField = true, |
| doc = "A list containing the labels provided with --plugins, if any.") |
| ImmutableList<Label> getPlugins(); |
| |
| @StarlarkMethod( |
| name = "disallow_java_import_empty_jars", |
| doc = "Returns true if empty java_import jars are not allowed.", |
| useStarlarkThread = true) |
| boolean getDisallowJavaImportEmptyJarsInStarlark(StarlarkThread thread) throws EvalException; |
| |
| @StarlarkMethod( |
| name = "use_ijars", |
| doc = "Returns true iff Java compilation should use ijars.", |
| useStarlarkThread = true) |
| boolean getUseIjarsInStarlark(StarlarkThread thread) throws EvalException; |
| |
| @StarlarkMethod( |
| name = "disallow_java_import_exports", |
| doc = "Returns true if java_import exports are not allowed.", |
| useStarlarkThread = true) |
| boolean getDisallowJavaImportExportsInStarlark(StarlarkThread thread) throws EvalException; |
| |
| @StarlarkMethod( |
| name = "bytecode_optimizer_mnemonic", |
| structField = true, |
| doc = "The mnemonic for the bytecode optimizer.") |
| String getBytecodeOptimizerMnemonic(); |
| |
| @StarlarkMethod( |
| name = "split_bytecode_optimization_pass", |
| structField = true, |
| doc = |
| "Returns whether the OPTIMIZATION stage of the bytecode optimizer will be split across" |
| + " two actions.") |
| boolean splitBytecodeOptimizationPass(); |
| |
| @StarlarkMethod( |
| name = "bytecode_optimization_pass_actions", |
| structField = true, |
| doc = |
| "This specifies the number of actions to divide the OPTIMIZATION stage of the bytecode" |
| + " optimizer into. Note that if split_bytecode_optimization_pass is set, this will" |
| + " only change behavior if it is > 2.") |
| int bytecodeOptimizationPassActions(); |
| |
| @StarlarkMethod( |
| name = "auto_create_java_test_deploy_jars", |
| useStarlarkThread = true, |
| documented = false) |
| boolean autoCreateJavaTestDeployJars(StarlarkThread thread) throws EvalException; |
| } |