Add applyTeacherTests() to SorterConfiguration (1.2.0)

README.md

@@ -1,6 +1,6 @@
 # ALDA Sorting API
 
-This repository houses the API source code of of the appointment planner exercise.
+This repository houses the API source code of the sorting exercise.
 
 The JavaDoc can be found at [https://fontysvenlo.github.io/alda_sorting_api/latest](https://fontysvenlo.github.io/alda_sorting_api/latest)
 
@@ -10,4 +10,4 @@ The main instructions for the exercise can be found in your **own** repository.
 
 ## Issues
 
-If you encounter any problems with the appointment planner exercise, please create an issue on this repository, so we can fix it for the next year :raised_hands:
+If you encounter any problems with the sorting exercise, please create an issue on this repository, so we can fix it for the next year :raised_hands:

pom.xml

@@ -6,11 +6,11 @@
     <parent>
         <groupId>io.github.fontysvenlo</groupId>
         <artifactId>informaticspom</artifactId>
-        <version>1.7</version>
+        <version>1.8</version>
         <relativePath/>
     </parent>
     <artifactId>alda_sorting_api</artifactId>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
     <packaging>jar</packaging>
     <name>Sorting Service API</name>
     <properties>

src/main/java/sortingservice/SorterConfiguration.java

@@ -49,4 +49,15 @@ public interface SorterConfiguration {
      * @return sorter
      */
     <T> Sorter<T> getSorter();
+
+    /**
+     * Indicates whether the teacher tests should test this configuration.
+     * Your own tests should test all configurations.
+     *
+     * @return true if the teacher tests should test this configuration,
+     * true by default.
+     */
+    default boolean applyTeacherTests() {
+        return true;
+    }
 }

src/main/java/sortingservice/SortingServiceFactory.java

@@ -3,19 +3,20 @@
 import java.util.stream.Stream;
 
 /**
- * Factory service for sorter configurations to test.
+ * Factory service for sorter configurations.
  *
- * Provides The implementing class provides sorter configurations that a
- * student wants to be tested by the teacher tests.
+ * The implementing class provides all sorter configurations that a student
+ * implemented. Whether the teacher tests test a configuration is decided by
+ * {@link SorterConfiguration#applyTeacherTests()}.
  *
  * @author Pieter van den Hombergh / Richard van den Ham.
  */
 public interface SortingServiceFactory {
 
     /**
-     * Get all sorter configurations that should be tested.
+     * Get all configured sorter configurations.
      *
-     * @return a stream of sorter configurations that should be tested.
+     * @return a stream of all configured sorter configurations.
      */
     Stream<SorterConfiguration> streamSorterConfigurations();
 }