// Copyright 2017 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;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
import com.google.devtools.build.lib.skylarkinterface.SkylarkValue;
/** Interface for provider objects (constructors for {@link StructApi} objects). */
@SkylarkModule(
name = "Provider",
doc =
"A constructor for simple value objects, known as provider instances."
+ "
"
+ "This value has a dual purpose:"
+ "
DataInfo = provider()\n" + "d = DataInfo(x = 2, y = 3)\n" + "print(d.x + d.y) # prints 5" + " Note: Some providers, defined internally, do not allow instance creation" + "
DataInfo = provider()\n" + "def _rule_impl(ctx)\n" + " ... ctx.attr.dep[DataInfo]" + "
Provider
using the "
+ "provider function."
)
public interface ProviderApi extends SkylarkValue {}