Merge pull request #179 from cicirello/junit-migration

Migrated test cases to JUnit Jupiter 5.8.2

Author: cicirello

CHANGELOG.md

@@ -4,13 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased] - 2022-02-14
+## [Unreleased] - 2022-02-15
 
 ### Added
 
 ### Changed
 * Bumped dependency rho-mu to 1.2.0
 * Bumped dependency org.cicirello.core to 1.1.0
+* Migrated test cases to JUnit 5 (specifically JUnit Jupiter 5.8.2).
 
 ### Deprecated
 

pom.xml

@@ -165,12 +165,10 @@
 
 	<dependencies>
 		<dependency>
-			<groupId>junit</groupId>
-			<artifactId>junit</artifactId>
-			<version>4.13.2</version>
-			<type>jar</type>
+			<groupId>org.junit.jupiter</groupId>
+			<artifactId>junit-jupiter</artifactId>
+			<version>5.8.2</version>
 			<scope>test</scope>
-			<optional>true</optional>
 		</dependency>
 		<dependency>
 			<groupId>org.cicirello</groupId>

src/main/java/org/cicirello/permutations/PermutationIterator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018-2021 Vincent A. Cicirello, <https://www.cicirello.org/>.
+ * Copyright 2018-2022 Vincent A. Cicirello, <https://www.cicirello.org/>.
  *
  * This file is part of JavaPermutationTools (https://jpt.cicirello.org/).
  *
@@ -17,7 +17,6 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with JavaPermutationTools.  If not, see <http://www.gnu.org/licenses/>.
- *
  */
 
 package org.cicirello.permutations;
@@ -33,7 +32,6 @@
  * modify the returned Permutation without risk of interfering with the operation of the Iterator.
  *
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, <a href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a> 
- * @version 5.24.2021
  */
 public class PermutationIterator implements Iterator<Permutation> {
 
@@ -67,15 +65,18 @@ public PermutationIterator(Permutation p) {
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Checks if this PermutationIterator has more Permutations.
+	 * @return true if and only if this PermutationIterator has more Permutations to iterate over.
 	 */
 	@Override
 	public boolean hasNext() {
 		return !done;
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Gets the Permutation for the next iteration.
+	 * @return The Permutation for the next iteration.
+	 * @throws NoSuchElementException if hasNext() is false 
 	 */
 	@Override
 	public Permutation next() {