bookkeeper-common/src/main/java/org/apache/bookkeeper/common/annotation/InterfaceAudience.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.bookkeeper.common.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Annotation to inform users of a package, class or method's intended audience.
 */
@InterfaceAudience.Public
@InterfaceStability.Stable
public class InterfaceAudience {

    /**
     * Intended for use by any project or application.
     */
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Public {}

    /**
     * Intended for use only within the project(s) specified in the annotation.
     * For example, "distributedlog", "pulsar".
     */
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    public @interface LimitedPrivate {}

    /**
     * Intended for use only within bookkeeper itself.
     */
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Private {}

    private InterfaceAudience() {} // Audience can't exist on its own

}