#63: added API-annotations for junit5-api

Author: Matthias Merdes

junit5-api/src/main/java/org/junit/gen5/api/AfterAll.java

@@ -10,12 +10,16 @@
 
 package org.junit.gen5.api;
 
+import static org.junit.gen5.commons.meta.API.Usage.Maintained;
+
 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;
 
+import org.junit.gen5.commons.meta.API;
+
 /**
  * {@code @AfterAll} is used to signal that the annotated method should be
  * executed <em>after</em> <strong>all</strong> tests in the current test
@@ -41,5 +45,6 @@
 @Target({ ElementType.ANNOTATION_TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
+@API(Maintained)
 public @interface AfterAll {
 }

junit5-api/src/main/java/org/junit/gen5/api/AfterEach.java

@@ -10,12 +10,16 @@
 
 package org.junit.gen5.api;
 
+import static org.junit.gen5.commons.meta.API.Usage.Stable;
+
 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;
 
+import org.junit.gen5.commons.meta.API;
+
 /**
  * {@code @AfterEach} is used to signal that the annotated method should be
  * executed <em>after</em> <strong>each</strong> {@code @Test} method in
@@ -40,5 +44,6 @@
 @Target({ ElementType.ANNOTATION_TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
+@API(Stable)
 public @interface AfterEach {
 }

junit5-api/src/main/java/org/junit/gen5/api/Assertions.java

@@ -10,10 +10,14 @@
 
 package org.junit.gen5.api;
 
+import static org.junit.gen5.commons.meta.API.Usage.Experimental;
+import static org.junit.gen5.commons.meta.API.Usage.Maintained;
+
 import java.util.Objects;
 import java.util.function.BooleanSupplier;
 import java.util.function.Supplier;
 
+import org.junit.gen5.commons.meta.API;
 import org.junit.gen5.commons.util.ExceptionUtils;
 import org.junit.gen5.commons.util.StringUtils;
 import org.opentest4j.AssertionFailedError;
@@ -28,6 +32,7 @@
  * @see AssertionFailedError
  * @see Assumptions
  */
+@API(Maintained)
 public final class Assertions {
 
 	private Assertions() {
@@ -318,6 +323,7 @@ public static void assertNotSame(Object unexpected, Object actual, Supplier<Stri
 	 * Asserts that <em>all</em> assertions contained in {@code asserts} do not fail.
 	 * Report a failure of at least one in a {@link MultipleFailuresError}.
 	 */
+	@API(Experimental)
 	public static void assertAll(Executable... asserts) throws MultipleFailuresError {
 		assertAll(null, asserts);
 	}
@@ -328,6 +334,7 @@ public static void assertAll(Executable... asserts) throws MultipleFailuresError
 	 *
 	 * <p>Include {@code heading} in the exception's message string.</p>
 	 */
+	@API(Experimental)
 	public static void assertAll(String heading, Executable... asserts) throws MultipleFailuresError {
 		MultipleFailuresError multipleFailuresError = new MultipleFailuresError(heading);
 		for (Executable executable : asserts) {

junit5-api/src/main/java/org/junit/gen5/api/Assumptions.java

@@ -10,9 +10,13 @@
 
 package org.junit.gen5.api;
 
+import static org.junit.gen5.commons.meta.API.Usage.Experimental;
+import static org.junit.gen5.commons.meta.API.Usage.Maintained;
+
 import java.util.function.BooleanSupplier;
 import java.util.function.Supplier;
 
+import org.junit.gen5.commons.meta.API;
 import org.junit.gen5.commons.util.ExceptionUtils;
 import org.junit.gen5.commons.util.StringUtils;
 import org.opentest4j.TestAbortedException;
@@ -34,6 +38,7 @@
  * @see TestAbortedException
  * @see Assertions
  */
+@API(Maintained)
 public final class Assumptions {
 
 	private Assumptions() {
@@ -204,6 +209,7 @@ public static void assumeFalse(BooleanSupplier assumptionSupplier, Supplier<Stri
 	 * @param executable the block of code to execute if the assumption is valid
 	 * @see #assumingThat(boolean, Executable)
 	 */
+	@API(Experimental)
 	public static void assumingThat(BooleanSupplier assumptionSupplier, Executable executable) {
 		assumingThat(assumptionSupplier.getAsBoolean(), executable);
 	}
@@ -222,6 +228,7 @@ public static void assumingThat(BooleanSupplier assumptionSupplier, Executable e
 	 * @param executable the block of code to execute if the assumption is valid
 	 * @see #assumingThat(BooleanSupplier, Executable)
 	 */
+	@API(Experimental)
 	public static void assumingThat(boolean assumption, Executable executable) {
 		if (assumption) {
 			try {

junit5-api/src/main/java/org/junit/gen5/api/BeforeAll.java

@@ -10,12 +10,16 @@
 
 package org.junit.gen5.api;
 
+import static org.junit.gen5.commons.meta.API.Usage.Maintained;
+
 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;
 
+import org.junit.gen5.commons.meta.API;
+
 /**
  * {@code @BeforeAll} is used to signal that the annotated method should be
  * executed <em>before</em> <strong>all</strong> tests in the current test
@@ -41,5 +45,6 @@
 @Target({ ElementType.ANNOTATION_TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
+@API(Maintained)
 public @interface BeforeAll {
 }

junit5-api/src/main/java/org/junit/gen5/api/BeforeEach.java

@@ -10,12 +10,16 @@
 
 package org.junit.gen5.api;
 
+import static org.junit.gen5.commons.meta.API.Usage.Stable;
+
 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;
 
+import org.junit.gen5.commons.meta.API;
+
 /**
  * {@code @BeforeEach} is used to signal that the annotated method should be
  * executed <em>before</em> <strong>each</strong> {@code @Test} method in
@@ -40,5 +44,6 @@
 @Target({ ElementType.ANNOTATION_TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
+@API(Stable)
 public @interface BeforeEach {
 }

junit5-api/src/main/java/org/junit/gen5/api/Disabled.java

@@ -10,12 +10,16 @@
 
 package org.junit.gen5.api;
 
+import static org.junit.gen5.commons.meta.API.Usage.Stable;
+
 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;
 
+import org.junit.gen5.commons.meta.API;
+
 /**
  * {@code @Disabled} is used to signal that the annotated test class or
  * test method is currently <em>disabled</em> and should not be executed.
@@ -28,6 +32,7 @@
 @Target({ ElementType.TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
+@API(Stable)
 public @interface Disabled {
 
 	/**

junit5-api/src/main/java/org/junit/gen5/api/DisplayName.java

@@ -10,12 +10,16 @@
 
 package org.junit.gen5.api;
 
+import static org.junit.gen5.commons.meta.API.Usage.Experimental;
+
 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;
 
+import org.junit.gen5.commons.meta.API;
+
 /**
  * {@code @DisplayName} is used to declare a custom display name for the
  * annotated test class or test method.
@@ -30,6 +34,7 @@
 @Target({ ElementType.TYPE, ElementType.METHOD })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
+@API(Experimental)
 public @interface DisplayName {
 
 	String value();

junit5-api/src/main/java/org/junit/gen5/api/Executable.java

@@ -10,6 +10,10 @@
 
 package org.junit.gen5.api;
 
+import static org.junit.gen5.commons.meta.API.Usage.Stable;
+
+import org.junit.gen5.commons.meta.API;
+
 /**
  * {@code Executable} is a functional interface that can be used to
  * implement any generic block of code that potentially throws a
@@ -34,6 +38,7 @@
  * @see Assumptions#assumingThat(java.util.function.BooleanSupplier, Executable)
  */
 @FunctionalInterface
+@API(Stable)
 public interface Executable {
 
 	void execute() throws Throwable;

junit5-api/src/main/java/org/junit/gen5/api/Nested.java

@@ -10,12 +10,16 @@
 
 package org.junit.gen5.api;
 
+import static org.junit.gen5.commons.meta.API.Usage.Experimental;
+
 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;
 
+import org.junit.gen5.commons.meta.API;
+
 /**
  * {@code @Nested} is used to signal that the annotated class is a nested,
  * non-static test class.
@@ -25,5 +29,6 @@
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
+@API(Experimental)
 public @interface Nested {
 }