diff --git a/README.md b/README.md index 613539e..3c434f2 100644 --- a/README.md +++ b/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: diff --git a/pom.xml b/pom.xml index 6ad352d..5fe8f87 100644 --- a/pom.xml +++ b/pom.xml @@ -6,11 +6,11 @@ io.github.fontysvenlo informaticspom - 1.7 + 1.8 alda_sorting_api - 1.1.0 + 1.2.0 jar Sorting Service API diff --git a/src/main/java/sortingservice/SorterConfiguration.java b/src/main/java/sortingservice/SorterConfiguration.java index 52216ce..6e27d1a 100644 --- a/src/main/java/sortingservice/SorterConfiguration.java +++ b/src/main/java/sortingservice/SorterConfiguration.java @@ -49,4 +49,15 @@ public interface SorterConfiguration { * @return sorter */ Sorter 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; + } } diff --git a/src/main/java/sortingservice/SortingServiceFactory.java b/src/main/java/sortingservice/SortingServiceFactory.java index 9cb0990..0af2b05 100644 --- a/src/main/java/sortingservice/SortingServiceFactory.java +++ b/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 streamSorterConfigurations(); } \ No newline at end of file