From 571653184fc16ca705c5f284f1d4ba8a22ad23bf Mon Sep 17 00:00:00 2001 From: Tim Meehan Date: Sun, 19 May 2019 21:40:06 -0700 Subject: [PATCH] Add Experimental annotation in SPI --- .../facebook/presto/spi/api/Experimental.java | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 presto-spi/src/main/java/com/facebook/presto/spi/api/Experimental.java diff --git a/presto-spi/src/main/java/com/facebook/presto/spi/api/Experimental.java b/presto-spi/src/main/java/com/facebook/presto/spi/api/Experimental.java new file mode 100644 index 0000000000000..ee5b6f3f8d612 --- /dev/null +++ b/presto-spi/src/main/java/com/facebook/presto/spi/api/Experimental.java @@ -0,0 +1,43 @@ +/* + * 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.facebook.presto.spi.api; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Indicates a public API that can change at any time, and has no guarantee of API stability and + * backward-compatibility. + * + *

Usage guidelines: + *

    + *
  1. This annotation is used only on public API. Internal interfaces should not use it.
  2. + *
  3. This annotation should only be added to new APIs. Adding it to an existing API is + * considered API-breaking.
  4. + *
  5. Removing this annotation from an API gives it stable status.
  6. + *
+ */ +@Retention(RetentionPolicy.SOURCE) +@Target({ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.PACKAGE, ElementType.TYPE}) +@Documented +public @interface Experimental +{ + /** + * Context information such as links to discussion thread, tracking issue etc. + */ + String value() default ""; +}