Promote APIs, add specifications and update Javadoc version numbers

Most common Ares API is STABLE now and won't change in an incompatible way in this major version (1.0.0).
ls1intum · Jan 17, 2022 · 5dce034 · 5dce034
1 parent d081f82
commit 5dce034
Show file tree

Hide file tree

Showing 62 changed files with 158 additions and 69 deletions.
diff --git a/src/main/java/de/tum/in/test/api/ActivateHiddenBefore.java b/src/main/java/de/tum/in/test/api/ActivateHiddenBefore.java
@@ -24,9 +24,9 @@
  * @author Christian Femers
  * @see Deadline
  * @since 0.1.2
- * @version 1.1.0
+ * @version 1.2.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/AddTrustedPackage.java b/src/main/java/de/tum/in/test/api/AddTrustedPackage.java
@@ -27,9 +27,9 @@
  *
  * @author Christian Femers
  * @since 1.3.1
- * @version 1.0.0
+ * @version 1.1.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/AddTrustedPackages.java b/src/main/java/de/tum/in/test/api/AddTrustedPackages.java
@@ -18,9 +18,9 @@
  * @see AddTrustedPackage
  * @author Christian Femers
  * @since 1.3.1
- * @version 1.0.0
+ * @version 1.1.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/AllowLocalPort.java b/src/main/java/de/tum/in/test/api/AllowLocalPort.java
@@ -19,9 +19,9 @@
  *
  * @author Christian Femers
  * @since 0.3.6
- * @version 1.0.0
+ * @version 1.1.0
  */
-@API(status = Status.EXPERIMENTAL)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/AllowThreads.java b/src/main/java/de/tum/in/test/api/AllowThreads.java
@@ -8,13 +8,17 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+import org.apiguardian.api.API;
+import org.apiguardian.api.API.Status;
+
 /**
  * Allows starting and modifying own Threads.
  *
  * @author Christian Femers
  * @since 0.4.0
  * @version 1.0.0
  */
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/BlacklistPackage.java b/src/main/java/de/tum/in/test/api/BlacklistPackage.java
@@ -40,9 +40,9 @@
  *
  * @author Christian Femers
  * @since 0.5.1
- * @version 1.1.0
+ * @version 1.2.0
  */
-@API(status = Status.EXPERIMENTAL)
+@API(status = Status.MAINTAINED)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/BlacklistPackages.java b/src/main/java/de/tum/in/test/api/BlacklistPackages.java
@@ -18,9 +18,9 @@
  * @see BlacklistPackage
  * @author Christian Femers
  * @since 0.5.1
- * @version 1.0.0
+ * @version 1.1.0
  */
-@API(status = Status.EXPERIMENTAL)
+@API(status = Status.MAINTAINED)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/BlacklistPath.java b/src/main/java/de/tum/in/test/api/BlacklistPath.java
@@ -30,9 +30,9 @@
  * @see Path
  * @author Christian Femers
  * @since 0.2.0
- * @version 1.1.0
+ * @version 1.2.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/BlacklistPaths.java b/src/main/java/de/tum/in/test/api/BlacklistPaths.java
@@ -20,9 +20,9 @@
  * @see Path
  * @author Christian Femers
  * @since 0.2.0
- * @version 1.0.0
+ * @version 1.1.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/Deadline.java b/src/main/java/de/tum/in/test/api/Deadline.java
@@ -49,9 +49,9 @@
  *
  * @author Christian Femers
  * @since 0.1.0
- * @version 1.1.0
+ * @version 1.2.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/ExtendedDeadline.java b/src/main/java/de/tum/in/test/api/ExtendedDeadline.java
@@ -30,9 +30,9 @@
  * @see Deadline
  * @author Christian Femers
  * @since 0.1.0
- * @version 1.0.1
+ * @version 1.1.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/MirrorOutput.java b/src/main/java/de/tum/in/test/api/MirrorOutput.java
@@ -27,9 +27,9 @@
  *
  * @author Christian Femers
  * @since 0.1.0
- * @version 1.1.0
+ * @version 1.2.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/PathActionLevel.java b/src/main/java/de/tum/in/test/api/PathActionLevel.java
@@ -1,5 +1,9 @@
 package de.tum.in.test.api;
 
+import org.apiguardian.api.API;
+import org.apiguardian.api.API.Status;
+
+@API(status = Status.STABLE)
 public enum PathActionLevel {
 	READ,
 	READLINK,

diff --git a/src/main/java/de/tum/in/test/api/PathType.java b/src/main/java/de/tum/in/test/api/PathType.java
@@ -13,8 +13,18 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.apiguardian.api.API;
+import org.apiguardian.api.API.Status;
+
 import de.tum.in.test.api.util.LruCache;
 
+/**
+ * Defines different path pattern matching notations which can be converted into
+ * {@link PathMatcher}s.
+ *
+ * @author Christian Femers
+ */
+@API(status = Status.STABLE)
 public enum PathType {
 	/**
 	 * Absolute path must match exactly; given path may be specified relative

diff --git a/src/main/java/de/tum/in/test/api/PrivilegedExceptionsOnly.java b/src/main/java/de/tum/in/test/api/PrivilegedExceptionsOnly.java
@@ -48,9 +48,9 @@
  * @see TestUtils#privilegedThrow(java.util.concurrent.Callable)
  * @author Christian Femers
  * @since 0.5.2
- * @version 1.0.1
+ * @version 1.1.0
  */
-@API(status = Status.EXPERIMENTAL)
+@API(status = Status.STABLE)
 @Inherited
 @Retention(RUNTIME)
 @Target({ TYPE, METHOD, ANNOTATION_TYPE })

diff --git a/src/main/java/de/tum/in/test/api/StrictTimeout.java b/src/main/java/de/tum/in/test/api/StrictTimeout.java
@@ -34,9 +34,9 @@
  *
  * @author Christian Femers
  * @since 0.1.0
- * @version 2.0.0
+ * @version 2.1.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/TestUtils.java b/src/main/java/de/tum/in/test/api/TestUtils.java
@@ -11,7 +11,12 @@
 import de.tum.in.test.api.internal.BlacklistedInvoker;
 import de.tum.in.test.api.internal.PrivilegedException;
 
-@API(status = Status.EXPERIMENTAL)
+/**
+ * Utilities for writing tests with Ares in the form of static methods.
+ *
+ * @author Christian Femers
+ */
+@API(status = Status.MAINTAINED)
 public final class TestUtils {
 
 	private TestUtils() {

diff --git a/src/main/java/de/tum/in/test/api/TrustedThreads.java b/src/main/java/de/tum/in/test/api/TrustedThreads.java
@@ -54,7 +54,7 @@
  * {@link ArtemisSecurityManager#requestThreadWhitelisting(Thread)}.
  *
  * @since 1.7.3
- * @version 1.0.0
+ * @version 1.1.0
  * @author Christian Femers
  */
 @API(status = Status.MAINTAINED)

diff --git a/src/main/java/de/tum/in/test/api/WhitelistClass.java b/src/main/java/de/tum/in/test/api/WhitelistClass.java
@@ -19,9 +19,9 @@
  *
  * @author Christian Femers
  * @since 0.4.4
- * @version 1.0.0
+ * @version 1.1.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/WhitelistClasses.java b/src/main/java/de/tum/in/test/api/WhitelistClasses.java
@@ -18,9 +18,9 @@
  * @see WhitelistClass
  * @author Christian Femers
  * @since 0.4.4
- * @version 1.0.0
+ * @version 1.1.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/WhitelistPackage.java b/src/main/java/de/tum/in/test/api/WhitelistPackage.java
@@ -34,9 +34,9 @@
  *
  * @author Christian Femers
  * @since 0.5.1
- * @version 1.1.1
+ * @version 1.2.0
  */
-@API(status = Status.EXPERIMENTAL)
+@API(status = Status.MAINTAINED)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/WhitelistPackages.java b/src/main/java/de/tum/in/test/api/WhitelistPackages.java
@@ -18,9 +18,9 @@
  * @see WhitelistPackage
  * @author Christian Femers
  * @since 0.5.1
- * @version 1.0.0
+ * @version 1.1.0
  */
-@API(status = Status.EXPERIMENTAL)
+@API(status = Status.MAINTAINED)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/WhitelistPath.java b/src/main/java/de/tum/in/test/api/WhitelistPath.java
@@ -30,9 +30,9 @@
  * @see Path
  * @author Christian Femers
  * @since 0.2.0
- * @version 1.1.0
+ * @version 1.2.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/WhitelistPaths.java b/src/main/java/de/tum/in/test/api/WhitelistPaths.java
@@ -20,9 +20,9 @@
  * @see Path
  * @author Christian Femers
  * @since 0.2.0
- * @version 1.0.0
+ * @version 1.1.0
  */
-@API(status = Status.MAINTAINED)
+@API(status = Status.STABLE)
 @Inherited
 @Documented
 @Retention(RUNTIME)

diff --git a/src/main/java/de/tum/in/test/api/dynamic/Check.java b/src/main/java/de/tum/in/test/api/dynamic/Check.java
@@ -7,7 +7,7 @@
 import org.apiguardian.api.API;
 import org.apiguardian.api.API.Status;
 
-@API(status = Status.EXPERIMENTAL)
+@API(status = Status.MAINTAINED)
 public enum Check {
 
 	STATIC {

diff --git a/src/main/java/de/tum/in/test/api/dynamic/Checkable.java b/src/main/java/de/tum/in/test/api/dynamic/Checkable.java
@@ -3,7 +3,7 @@
 import org.apiguardian.api.API;
 import org.apiguardian.api.API.Status;
 
-@API(status = Status.EXPERIMENTAL)
+@API(status = Status.MAINTAINED)
 public interface Checkable {
 
 	boolean exists();

diff --git a/src/main/java/de/tum/in/test/api/dynamic/DynamicClass.java b/src/main/java/de/tum/in/test/api/dynamic/DynamicClass.java
@@ -13,7 +13,7 @@
 import org.apiguardian.api.API;
 import org.apiguardian.api.API.Status;
 
-@API(status = Status.EXPERIMENTAL)
+@API(status = Status.MAINTAINED)
 public class DynamicClass<T> implements Checkable {
 
 	private static final Map<Class<?>, Class<?>> primitiveWrappers = Map.of(Boolean.TYPE, Boolean.class, Byte.TYPE,

diff --git a/src/main/java/de/tum/in/test/api/dynamic/DynamicConstructor.java b/src/main/java/de/tum/in/test/api/dynamic/DynamicConstructor.java
@@ -12,7 +12,7 @@
 
 import de.tum.in.test.api.util.UnexpectedExceptionError;
 
-@API(status = Status.EXPERIMENTAL)
+@API(status = Status.MAINTAINED)
 public class DynamicConstructor<T> implements Checkable {
 
 	private final DynamicClass<T> owner;

diff --git a/src/main/java/de/tum/in/test/api/dynamic/DynamicField.java b/src/main/java/de/tum/in/test/api/dynamic/DynamicField.java
@@ -13,7 +13,7 @@
 import org.apiguardian.api.API;
 import org.apiguardian.api.API.Status;
 
-@API(status = Status.EXPERIMENTAL)
+@API(status = Status.MAINTAINED)
 public class DynamicField<T> implements Checkable {
 
 	private final DynamicClass<?> owner;

diff --git a/src/main/java/de/tum/in/test/api/dynamic/DynamicMethod.java b/src/main/java/de/tum/in/test/api/dynamic/DynamicMethod.java
@@ -15,7 +15,7 @@
 
 import de.tum.in.test.api.util.UnexpectedExceptionError;
 
-@API(status = Status.EXPERIMENTAL)
+@API(status = Status.MAINTAINED)
 public class DynamicMethod<T> implements Checkable {
 	private final DynamicClass<?> owner;
 	private final String name;

diff --git a/src/main/java/de/tum/in/test/api/internal/ConfigurationUtils.java b/src/main/java/de/tum/in/test/api/internal/ConfigurationUtils.java
@@ -10,6 +10,9 @@
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 
+import org.apiguardian.api.API;
+import org.apiguardian.api.API.Status;
+
 import de.tum.in.test.api.AddTrustedPackage;
 import de.tum.in.test.api.AllowLocalPort;
 import de.tum.in.test.api.AllowThreads;
@@ -29,6 +32,7 @@
 import de.tum.in.test.api.util.PathRule;
 import de.tum.in.test.api.util.RuleType;
 
+@API(status = Status.INTERNAL)
 public final class ConfigurationUtils {
 
 	private ConfigurationUtils() {

diff --git a/src/main/java/de/tum/in/test/api/internal/IOTesterManager.java b/src/main/java/de/tum/in/test/api/internal/IOTesterManager.java
@@ -1,8 +1,12 @@
 package de.tum.in.test.api.internal;
 
+import org.apiguardian.api.API;
+import org.apiguardian.api.API.Status;
+
 import de.tum.in.test.api.io.IOTester;
 import de.tum.in.test.api.security.ArtemisSecurityManager;
 
+@API(status = Status.INTERNAL)
 public final class IOTesterManager {
 
 	static {

diff --git a/src/main/java/de/tum/in/test/api/internal/ReportingUtils.java b/src/main/java/de/tum/in/test/api/internal/ReportingUtils.java
@@ -5,6 +5,8 @@
 import java.util.Objects;
 import java.util.Optional;
 
+import org.apiguardian.api.API;
+import org.apiguardian.api.API.Status;
 import org.junit.jupiter.api.extension.InvocationInterceptor.Invocation;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -19,6 +21,7 @@
  *
  * @author Christian Femers
  */
+@API(status = Status.INTERNAL)
 public final class ReportingUtils {
 
 	private static final Logger LOG = LoggerFactory.getLogger(ReportingUtils.class);