// Copyright 2019 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.proto;

import com.google.devtools.build.docgen.annot.DocCategory;
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.StarlarkBuiltin;
import net.starlark.java.annot.StarlarkMethod;
import net.starlark.java.eval.Sequence;

/** Provides information about flavors for all built protos. */
@StarlarkBuiltin(
    name = "ProtoRegistryProvider",
    doc = "Information about flavors for all built protos.",
    category = DocCategory.PROVIDER)
public interface ProtoRegistryProviderApi<FileT extends FileApi> extends StructApi {

  @StarlarkMethod(name = "jars", documented = false, doc = "", structField = true)
  Depset /*<FileT>*/ getJars();

  @StarlarkMethod(name = "flavors", documented = false, doc = "", structField = true)
  Sequence<String> getFlavors();

  @StarlarkMethod(
      name = "errorMessage",
      documented = false,
      doc = "",
      structField = true,
      allowReturnNones = true)
  @Nullable
  String getError();
}