|  | 
|  | 1 | +/* | 
|  | 2 | + * Licensed to the Apache Software Foundation (ASF) under one or more | 
|  | 3 | + * contributor license agreements.  See the NOTICE file distributed with | 
|  | 4 | + * this work for additional information regarding copyright ownership. | 
|  | 5 | + * The ASF licenses this file to You under the Apache License, Version 2.0 | 
|  | 6 | + * (the "License"); you may not use this file except in compliance with | 
|  | 7 | + * the License.  You may obtain a copy of the License at | 
|  | 8 | + * | 
|  | 9 | + *    http://www.apache.org/licenses/LICENSE-2.0 | 
|  | 10 | + * | 
|  | 11 | + * Unless required by applicable law or agreed to in writing, software | 
|  | 12 | + * distributed under the License is distributed on an "AS IS" BASIS, | 
|  | 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | 
|  | 14 | + * See the License for the specific language governing permissions and | 
|  | 15 | + * limitations under the License. | 
|  | 16 | + */ | 
|  | 17 | + | 
|  | 18 | +package org.apache.spark.annotation; | 
|  | 19 | + | 
|  | 20 | +import java.lang.annotation.ElementType; | 
|  | 21 | +import java.lang.annotation.Retention; | 
|  | 22 | +import java.lang.annotation.RetentionPolicy; | 
|  | 23 | +import java.lang.annotation.Target; | 
|  | 24 | + | 
|  | 25 | +/** | 
|  | 26 | + * A class that is considered private to the internals of Spark -- there is a high-likelihood | 
|  | 27 | + * they will be changed in future versions of Spark. | 
|  | 28 | + * | 
|  | 29 | + * This should be used only when the standard Scala / Java means of protecting classes are | 
|  | 30 | + * insufficient.  In particular, Java has no equivalent of private[spark], so we use this annotation | 
|  | 31 | + * in its place. | 
|  | 32 | + * | 
|  | 33 | + * NOTE: If there exists a Scaladoc comment that immediately precedes this annotation, the first | 
|  | 34 | + * line of the comment must be ":: Private ::" with no trailing blank line. This is because | 
|  | 35 | + * of the known issue that Scaladoc displays only either the annotation or the comment, whichever | 
|  | 36 | + * comes first. | 
|  | 37 | + */ | 
|  | 38 | +@Retention(RetentionPolicy.RUNTIME) | 
|  | 39 | +@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, | 
|  | 40 | +        ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE, ElementType.PACKAGE}) | 
|  | 41 | +public @interface Private {} | 
0 commit comments