// 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.android;

import com.google.devtools.build.lib.skylarkbuildapi.core.ProviderApi;
import com.google.devtools.build.lib.skylarkbuildapi.core.StructApi;
import com.google.devtools.build.lib.skylarkinterface.Param;
import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;

/**
 * Supplies the pregenerate_oat_files_for_tests attribute of type boolean provided by android_device
 * rule.
 */
@SkylarkModule(
    name = "AndroidDex2OatInfo",
    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)
public interface AndroidDex2OatInfoApi extends StructApi {
  /** The name of the provider for this info object. */
  String NAME = "AndroidDex2OatInfo";

  /** Provider for {@link AndroidDex2OatInfoApi} objects. */
  @SkylarkModule(name = "Provider", documented = false, doc = "")
  interface Provider extends ProviderApi {
    @SkylarkCallable(
        name = "AndroidDex2OatInfo",
        doc = "The <code>AndroidDex2OatInfo</code> constructor.",
        documented = false,
        parameters = {
          @Param(name = "enabled", positional = false, named = true, type = Boolean.class),
        },
        selfCall = true)
    AndroidDex2OatInfoApi androidDex2OatInfo(Boolean enabled);
  }
}