spark/annotation/Experimental.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.annotation;
0019
0020 import java.lang.annotation.*;
0021
0022 /**
0023  * An experimental user-facing API.
0024  *
0025  * Experimental API's might change or be removed in minor versions of Spark, or be adopted as
0026  * first-class Spark API's.
0027  *
0028  * NOTE: If there exists a Scaladoc comment that immediately precedes this annotation, the first
0029  * line of the comment must be ":: Experimental ::" with no trailing blank line. This is because
0030  * of the known issue that Scaladoc displays only either the annotation or the comment, whichever
0031  * comes first.
0032  */
0033 @Documented
0034 @Retention(RetentionPolicy.RUNTIME)
0035 @Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
0036         ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE, ElementType.PACKAGE})
0037 public @interface Experimental {}