spark/annotation/Private.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  * A class that is considered private to the internals of Spark -- there is a high-likelihood
0024  * they will be changed in future versions of Spark.
0025  *
0026  * This should be used only when the standard Scala / Java means of protecting classes are
0027  * insufficient.  In particular, Java has no equivalent of private[spark], so we use this annotation
0028  * in its place.
0029  *
0030  * NOTE: If there exists a Scaladoc comment that immediately precedes this annotation, the first
0031  * line of the comment must be ":: Private ::" with no trailing blank line. This is because
0032  * of the known issue that Scaladoc displays only either the annotation or the comment, whichever
0033  * comes first.
0034  */
0035 @Documented
0036 @Retention(RetentionPolicy.RUNTIME)
0037 @Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
0038         ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE, ElementType.PACKAGE})
0039 public @interface Private {}