#63: added API-annotations for junit4-runner

Author: Matthias Merdes

junit-tests/src/test/java/org/junit/gen5/AllJUnit5Tests.java

@@ -11,7 +11,7 @@
 package org.junit.gen5;
 
 import org.junit.gen5.engine.junit5.JUnit5TestEngine;
-import org.junit.gen5.junit4.runner.ClassNamePattern;
+import org.junit.gen5.junit4.runner.FilterClassName;
 import org.junit.gen5.junit4.runner.JUnit5;
 import org.junit.gen5.junit4.runner.Packages;
 import org.junit.gen5.junit4.runner.RequireEngine;
@@ -32,7 +32,7 @@
  */
 @RunWith(JUnit5.class)
 @Packages("org.junit.gen5")
-@ClassNamePattern(".*Tests?")
+@FilterClassName(".*Tests?")
 @RequireEngine(JUnit5TestEngine.ENGINE_ID)
 public class AllJUnit5Tests {
 }

junit-tests/src/test/java/org/junit/gen5/junit4/runner/JUnit5Tests.java

@@ -173,7 +173,7 @@ class TestCase {
 
 		@Test
 		void addsClassFilterToRequestWhenClassNamePatternAnnotationIsPresent() throws Exception {
-			@ClassNamePattern(".*Foo")
+			@FilterClassName(".*Foo")
 			class TestCase {
 			}
 			class Foo {

junit4-runner/src/main/java/org/junit/gen5/junit4/runner/Classes.java

@@ -10,13 +10,17 @@
 
 package org.junit.gen5.junit4.runner;
 
+import org.junit.gen5.commons.meta.API;
+
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static org.junit.gen5.commons.meta.API.Usage.Maintained;
+
 /**
  * {@code @Classes} specifies the test classes to be run when a class
  * annotated with {@code @RunWith(JUnit5.class)} is run.
@@ -27,6 +31,7 @@
 @Target(ElementType.TYPE)
 @Inherited
 @Documented
+@API(Maintained)
 public @interface Classes {
 
 	/**

junit4-runner/src/main/java/org/junit/gen5/junit4/runner/ExcludeTags.java

@@ -10,13 +10,17 @@
 
 package org.junit.gen5.junit4.runner;
 
+import org.junit.gen5.commons.meta.API;
+
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static org.junit.gen5.commons.meta.API.Usage.Maintained;
+
 /**
  * {@code @ExcludeTags} specifies tags to be filtered out when a class
  * annotated with {@code @RunWith(JUnit5.class)} is run.
@@ -27,6 +31,7 @@
 @Target(ElementType.TYPE)
 @Inherited
 @Documented
+@API(Maintained)
 public @interface ExcludeTags {
 
 	/**

…gen5/junit4/runner/ClassNamePattern.java …/gen5/junit4/runner/FilterClassName.javajunit4-runner/src/main/java/org/junit/gen5/junit4/runner/ClassNamePattern.java renamed to junit4-runner/src/main/java/org/junit/gen5/junit4/runner/FilterClassName.java junit4-runner/src/main/java/org/junit/gen5/junit4/runner/ClassNamePattern.java renamed to junit4-runner/src/main/java/org/junit/gen5/junit4/runner/FilterClassName.java

@@ -10,28 +10,33 @@
 
 package org.junit.gen5.junit4.runner;
 
+import org.junit.gen5.commons.meta.API;
+
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static org.junit.gen5.commons.meta.API.Usage.Maintained;
+
 /**
- * {@code @ClassNamePattern} specifies a regular expression that is used
- * to match against class names when a test class annotated with
- * {@code @RunWith(JUnit5.class)} is executed.
+ * {@code @FilterClassName} specifies a regular expression that is used
+ * to match against fully qualified class names
+ * when a test class annotated with {@code @RunWith(JUnit5.class)} is executed.
  *
  * @since 5.0
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 @Inherited
 @Documented
-public @interface ClassNamePattern {
+@API(Maintained)
+public @interface FilterClassName {
 
 	/**
-	 * Regular expression used to match against class names.
+	 * Regular expression used to match against fully qualified class names.
 	 */
 	String value();
 

junit4-runner/src/main/java/org/junit/gen5/junit4/runner/JUnit5.java

@@ -12,6 +12,7 @@
 
 import static java.util.Arrays.stream;
 import static java.util.stream.Collectors.toList;
+import static org.junit.gen5.commons.meta.API.Usage.Maintained;
 import static org.junit.gen5.launcher.main.TestDiscoveryRequestBuilder.request;
 
 import java.lang.annotation.Annotation;
@@ -20,6 +21,7 @@
 import java.util.Set;
 import java.util.function.Function;
 
+import org.junit.gen5.commons.meta.API;
 import org.junit.gen5.commons.util.Preconditions;
 import org.junit.gen5.commons.util.StringUtils;
 import org.junit.gen5.engine.DiscoverySelector;
@@ -57,13 +59,14 @@
  *
  * @since 5.0
  * @see Classes
- * @see ClassNamePattern
+ * @see FilterClassName
  * @see Packages
  * @see UniqueIds
  * @see RequireTags
  * @see ExcludeTags
  * @see RequireEngine
  */
+@API(Maintained)
 public class JUnit5 extends Runner implements Filterable {
 
 	private static final Class<?>[] EMPTY_CLASS_ARRAY = new Class<?>[0];
@@ -196,7 +199,7 @@ private String getExplicitEngineId() {
 	}
 
 	private String getClassNameRegExPattern() {
-		return getValueFromAnnotation(ClassNamePattern.class, ClassNamePattern::value, EMPTY_STRING).trim();
+		return getValueFromAnnotation(FilterClassName.class, FilterClassName::value, EMPTY_STRING).trim();
 	}
 
 	private <A extends Annotation, V> V getValueFromAnnotation(Class<A> annotationClass, Function<A, V> extractor,

junit4-runner/src/main/java/org/junit/gen5/junit4/runner/Packages.java

@@ -10,13 +10,17 @@
 
 package org.junit.gen5.junit4.runner;
 
+import org.junit.gen5.commons.meta.API;
+
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static org.junit.gen5.commons.meta.API.Usage.Maintained;
+
 /**
  * {@code @Packages} specifies the names of packages to be run when a class
  * annotated with {@code @RunWith(JUnit5.class)} is run.
@@ -27,6 +31,7 @@
 @Target(ElementType.TYPE)
 @Inherited
 @Documented
+@API(Maintained)
 public @interface Packages {
 
 	/**

junit4-runner/src/main/java/org/junit/gen5/junit4/runner/RequireEngine.java

@@ -10,13 +10,17 @@
 
 package org.junit.gen5.junit4.runner;
 
+import org.junit.gen5.commons.meta.API;
+
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static org.junit.gen5.commons.meta.API.Usage.Maintained;
+
 /**
  * {@code @RequireEngine} specifies the engine ID (e.g., {@code "junit5"}) of
  * the sole {@link org.junit.gen5.engine.TestEngine TestEngine} to be used
@@ -28,6 +32,7 @@
 @Target(ElementType.TYPE)
 @Inherited
 @Documented
+@API(Maintained)
 public @interface RequireEngine {
 
 	/**

junit4-runner/src/main/java/org/junit/gen5/junit4/runner/RequireTags.java

@@ -10,13 +10,17 @@
 
 package org.junit.gen5.junit4.runner;
 
+import org.junit.gen5.commons.meta.API;
+
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static org.junit.gen5.commons.meta.API.Usage.Maintained;
+
 /**
  * {@code @RequireTags} specifies tags to be considered when a class
  * annotated with {@code @RunWith(JUnit5.class)} is run.
@@ -27,6 +31,7 @@
 @Target(ElementType.TYPE)
 @Inherited
 @Documented
+@API(Maintained)
 public @interface RequireTags {
 
 	/**

junit4-runner/src/main/java/org/junit/gen5/junit4/runner/UniqueIds.java

@@ -10,13 +10,17 @@
 
 package org.junit.gen5.junit4.runner;
 
+import org.junit.gen5.commons.meta.API;
+
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static org.junit.gen5.commons.meta.API.Usage.Maintained;
+
 /**
  * {@code @UniqueIds} specifies the unique IDs of test classes or methods to be
  * run when a class annotated with {@code @RunWith(JUnit5.class)} is run.
@@ -27,6 +31,7 @@
 @Target(ElementType.TYPE)
 @Inherited
 @Documented
+@API(Maintained)
 public @interface UniqueIds {
 
 	/**