package htsjdk.annotations;

import static java.lang.annotation.ElementType.*;

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

/**
 * Annotation indicating that a package, class, method, or type is release level "internal", even if the
 * access modifier is "public". {@link InternalAPI} types are intended to be for internal use only, and
 * should not be used by external consumers. Classes and methods with this annotation are subject to
 * modification or removal in future releases without a deprecation warning.
 */
@Target({CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
@Retention(RetentionPolicy.SOURCE)
@Inherited
@Documented
public @interface InternalAPI {}
