| // 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.devtools.build.lib.collect.nestedset.Depset; |
| import com.google.devtools.build.lib.starlarkbuildapi.FileApi; |
| import com.google.devtools.build.lib.starlarkbuildapi.core.StructApi; |
| import javax.annotation.Nullable; |
| import net.starlark.java.annot.StarlarkMethod; |
| import net.starlark.java.eval.EvalException; |
| import net.starlark.java.eval.Starlark; |
| import net.starlark.java.eval.StarlarkSemantics; |
| |
| /** A tuple of a java classes jar and its associated source and interface archives. */ |
| public interface JavaOutputApi<FileT extends FileApi> extends StructApi { |
| |
| @StarlarkMethod(name = "class_jar", doc = "A classes jar file.", structField = true) |
| FileT getClassJar(); |
| |
| /** @deprecated Use {@link #getCompileJar}. */ |
| @StarlarkMethod( |
| name = "ijar", |
| doc = "Deprecated: Please use compile_jar.", |
| allowReturnNones = true, |
| structField = true) |
| @Deprecated |
| @Nullable |
| FileT getIJar(); |
| |
| @StarlarkMethod( |
| name = "compile_jar", |
| doc = "An interface jar file.", |
| allowReturnNones = true, |
| structField = true) |
| @Nullable |
| FileT getCompileJar(); |
| |
| @StarlarkMethod( |
| name = "compile_jdeps", |
| doc = "Compile time dependencies information (deps.proto file).", |
| allowReturnNones = true, |
| structField = true) |
| @Nullable |
| FileT getCompileJdeps(); |
| |
| @StarlarkMethod( |
| name = "generated_class_jar", |
| doc = |
| "A jar file containing class files compiled from sources generated during annotation" |
| + " processing.", |
| allowReturnNones = true, |
| structField = true) |
| @Nullable |
| FileT getGeneratedClassJar(); |
| |
| @StarlarkMethod( |
| name = "generated_source_jar", |
| doc = "The source jar that was created as a result of annotation processing.", |
| allowReturnNones = true, |
| structField = true) |
| @Nullable |
| FileT getGeneratedSourceJar(); |
| |
| @StarlarkMethod( |
| name = "native_headers_jar", |
| doc = "A jar containing CC header files supporting native method implementation.", |
| allowReturnNones = true, |
| structField = true) |
| @Nullable |
| FileT getNativeHeadersJar(); |
| |
| @StarlarkMethod( |
| name = "manifest_proto", |
| doc = |
| "A manifest proto file. The protobuf file containing the manifest generated from " |
| + "JavaBuilder.", |
| allowReturnNones = true, |
| structField = true) |
| @Nullable |
| FileT getManifestProto(); |
| |
| @StarlarkMethod( |
| name = "jdeps", |
| doc = |
| "A manifest proto file. The protobuf file containing the manifest generated from " |
| + "JavaBuilder.", |
| allowReturnNones = true, |
| structField = true) |
| @Nullable |
| FileT getJdeps(); |
| |
| @StarlarkMethod( |
| name = "source_jar", |
| doc = "Deprecated: Please use source_jars instead.", |
| allowReturnNones = true, |
| structField = true) |
| @Deprecated |
| @Nullable |
| FileT getSrcJar(); |
| |
| @StarlarkMethod( |
| name = "source_jars", |
| doc = "A depset of sources archive files.", |
| allowReturnNones = true, |
| useStarlarkSemantics = true, |
| structField = true) |
| @Nullable |
| Depset getSrcJarsStarlark(StarlarkSemantics semantics); |
| |
| @Override |
| default String toProto() throws EvalException { |
| throw Starlark.errorf("unsupported method"); |
| } |
| |
| @Override |
| default String toJson() throws EvalException { |
| throw Starlark.errorf("unsupported method"); |
| } |
| } |