Skip to content

Commit 99b223a

Browse files
committed
Cleaning up annotations
1 parent e849f64 commit 99b223a

File tree

3 files changed

+18
-6
lines changed

3 files changed

+18
-6
lines changed

core/src/main/scala/org/apache/spark/annotations/AlphaComponent.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919

2020
import java.lang.annotation.*;
2121

22-
@Retention(RetentionPolicy.SOURCE)
23-
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD,
22+
/** A new component of Spark which may have unstable API's. */
23+
@Retention(RetentionPolicy.RUNTIME)
24+
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
2425
ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE, ElementType.PACKAGE})
2526
public @interface AlphaComponent {}

core/src/main/scala/org/apache/spark/annotations/DeveloperApi.java

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,12 @@
1919

2020
import java.lang.annotation.*;
2121

22-
@Retention(RetentionPolicy.SOURCE)
23-
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD,
22+
/**
23+
* A lower-level, unstable API intended for developers.
24+
*
25+
* Developer API's might change or be removed in minor versions of Spark.
26+
*/
27+
@Retention(RetentionPolicy.RUNTIME)
28+
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
2429
ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE, ElementType.PACKAGE})
2530
public @interface DeveloperApi {}

core/src/main/scala/org/apache/spark/annotations/Experimental.java

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,13 @@
1919

2020
import java.lang.annotation.*;
2121

22-
@Retention(RetentionPolicy.SOURCE)
23-
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD,
22+
/**
23+
* An experimental user-facing API.
24+
*
25+
* Experimental API's might change or be removed in minor versions of Spark, or be adopted as
26+
* first-class Spark API's.
27+
*/
28+
@Retention(RetentionPolicy.RUNTIME)
29+
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
2430
ElementType.CONSTRUCTOR, ElementType.LOCAL_VARIABLE, ElementType.PACKAGE})
2531
public @interface Experimental {}

0 commit comments

Comments
 (0)