// 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.skylarkbuildapi.android;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.skylarkbuildapi.FileApi;
import com.google.devtools.build.lib.skylarkbuildapi.ProviderApi;
import com.google.devtools.build.lib.skylarkbuildapi.StructApi;
import com.google.devtools.build.lib.skylarkinterface.Param;
import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
import com.google.devtools.build.lib.skylarkinterface.SkylarkConstructor;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.lib.syntax.SkylarkList;
/**
* An interface for a provider that exposes the use of data binding.
*/
@SkylarkModule(name = "UsesDataBindingInfo", doc = "", documented = false)
public interface UsesDataBindingProviderApi extends StructApi {
/** Name of this info object. */
public static String NAME = "UsesDataBindingInfo";
/**
* Returns the metadata outputs from this rule's annotation processing that describe how it
* applies data binding. See {@link DataBinding#getMetadataOutputs} for details.
*/
@SkylarkCallable(name = "metadata_outputs", structField = true, doc = "", documented = false)
ImmutableList getMetadataOutputs();
/** The provider implementing this can construct the UsesDataBindingInfo provider. */
@SkylarkModule(name = "Provider", doc = "", documented = false)
public interface Provider extends ProviderApi {
@SkylarkCallable(
name = NAME,
doc = "The UsesDataBindingInfo
constructor.",
parameters = {
@Param(
name = "metadata_outputs",
doc = "A list of artifacts of the metadata outputs.",
positional = true,
named = false,
type = SkylarkList.class,
generic1 = FileApi.class),
},
selfCall = true)
@SkylarkConstructor(objectType = UsesDataBindingProviderApi.class)
UsesDataBindingProviderApi createInfo(SkylarkList metadataOutputs) throws EvalException;
}
}