ci: use reusable workflows

.github/workflows/deploy.yml

@@ -0,0 +1,12 @@
+name: Publish package to the Maven Central Repository
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    uses: FontysVenlo/alda_api_workflows/.github/workflows/deploy.yml@main
+    secrets: inherit
+    with:
+      tag: ${{ github.event.release.tag_name }}

.github/workflows/pullrequest.yml

@@ -0,0 +1,9 @@
+name: Java CI with Maven
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    uses: FontysVenlo/alda_api_workflows/.github/workflows/pullrequest.yml@main

src/main/java/io/github/fontysvenlo/alda/stacks_queues_api/Queue.java

@@ -7,7 +7,7 @@
  */
 public interface Queue<E> {
     /**
-     * Check if the stack contains any elements
+     * Check if the stack contains any elements.
      *
      * @return true if stack is empty
      */

src/main/java/io/github/fontysvenlo/alda/stacks_queues_api/Stack.java

@@ -29,7 +29,7 @@ public interface Stack<E> {
     E peek();
 
     /**
-     * Check if the stack contains any elements
+     * Check if the stack contains any elements.
      *
      * @return true if stack is empty
      */

src/main/java/io/github/fontysvenlo/alda/stacks_queues_api/factory/StackQueueConfiguration.java

@@ -3,10 +3,44 @@
 import io.github.fontysvenlo.alda.stacks_queues_api.Queue;
 import io.github.fontysvenlo.alda.stacks_queues_api.Stack;
 
+/**
+ * Configuration for stacks and queues.
+ */
 public interface StackQueueConfiguration {
+    /**
+     * Wether the configuration is active (should be tested).
+     * @return true if active
+     */
     boolean isActive();
+
+    /**
+     * Get the name of the configuration.
+     * 
+     * @return the name
+     */
     String getName();
+
+    /**
+     * For which type is this configuration.
+     * @return the type
+     */
     StackQueue getType();
+
+    /**
+     * Get the stack if a stack configuration.
+     * 
+     * @param <E> the generic type for the stack
+     * @return the stack
+     * @throws NullPointerException if not a stack type
+     */
     <E> Stack<E> getStack();
+
+    /**
+     * Get the queue if a queue configuration.
+     * 
+     * @param <E> the generic type for the queue
+     * @return the queue
+     * @throws NullPointerException if not a queue type
+     */
     <E> Queue<E> getQueue();
 }

src/main/java/io/github/fontysvenlo/alda/stacks_queues_api/factory/StackQueueFactory.java

@@ -2,6 +2,14 @@
 
 import java.util.stream.Stream;
 
+/**
+ * Factory to get all configurations.
+ */
 public interface StackQueueFactory {
+
+    /**
+     * Get all the configurations.
+     * @return Stream of configurations
+     */
     Stream<StackQueueConfiguration> streamConfigurations();
 }