src/main/java/com/google/devtools/build/lib/skylarkinterface/SkylarkGlobalLibrary.java

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

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * An annotation to mark a class whose methods are global (top-level) Skylark functions.
 *
 * <p>A class or interface annotated with this annotation indicates that all of its methods
 * which are annotated with {@link SkylarkCallable} should be treated as global top-level
 * functions.
 *
 * <p>Global libraries should be stateless, and must have a public zero-arg constructor.
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface SkylarkGlobalLibrary {}