| // 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.android; |
| |
| import com.google.devtools.build.docgen.annot.DocCategory; |
| import com.google.devtools.build.docgen.annot.StarlarkConstructor; |
| 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.ProviderApi; |
| import com.google.devtools.build.lib.starlarkbuildapi.core.StructApi; |
| import javax.annotation.Nullable; |
| import net.starlark.java.annot.Param; |
| import net.starlark.java.annot.StarlarkBuiltin; |
| import net.starlark.java.annot.StarlarkMethod; |
| import net.starlark.java.eval.EvalException; |
| import net.starlark.java.eval.Sequence; |
| |
| /** A target that can provide the aar artifact of Android libraries */ |
| @StarlarkBuiltin( |
| name = "AndroidLibraryAarInfo", |
| doc = |
| "Do not use this module. It is intended for migration purposes only. If you depend on it, " |
| + "you will be broken when it is removed." |
| + "Android AARs provided by a library rule and its dependencies", |
| documented = false, |
| category = DocCategory.PROVIDER) |
| public interface AndroidLibraryAarInfoApi<FileT extends FileApi> extends StructApi { |
| |
| /** The name of the provider for this info object. */ |
| String NAME = "AndroidLibraryAarInfo"; |
| |
| @StarlarkMethod( |
| name = "aar", |
| doc = "", |
| documented = false, |
| structField = true, |
| allowReturnNones = true) |
| @Nullable |
| FileT getAarArtifact(); |
| |
| @StarlarkMethod( |
| name = "transitive_aar_artifacts", |
| doc = "", |
| documented = false, |
| structField = true) |
| Depset /*<FileT>*/ getTransitiveAarArtifactsForStarlark(); |
| |
| /** The provider implementing this can construct the AndroidLibraryAarInfoApi provider. */ |
| @StarlarkBuiltin( |
| name = "Provider", |
| doc = |
| "Do not use this module. It is intended for migration purposes only. If you depend on " |
| + "it, you will be broken when it is removed.", |
| documented = false) |
| interface Provider<FileT extends FileApi> extends ProviderApi { |
| |
| @StarlarkMethod( |
| name = NAME, |
| doc = "The <code>AndroidLibraryAarInfoApi</code> constructor.", |
| documented = false, |
| parameters = { |
| @Param(name = "aar", doc = "resource_apk", positional = false, named = true), |
| @Param(name = "manifest", doc = "manifest", positional = false, named = true), |
| @Param( |
| name = "aars_from_deps", |
| doc = "List of AndroidLibraryAarInfo", |
| positional = false, |
| named = true), |
| @Param( |
| name = "defines_local_resources", |
| doc = "defines_local_resources", |
| positional = false, |
| named = true), |
| }, |
| selfCall = true) |
| @StarlarkConstructor |
| AndroidLibraryAarInfoApi<FileT> create( |
| FileT aar, |
| FileT manifest, |
| Sequence<? extends AndroidLibraryAarInfoApi<FileT>> infosFromDeps, |
| Boolean definesLocalResources) |
| throws EvalException; |
| } |
| } |