Added clear() method

- Added test for clear() behaviour

- Version bump to 0.7

Author: lewysDavies

pom.xml

@@ -5,7 +5,7 @@
 
 	<groupId>com.lewdev</groupId>
 	<artifactId>probability-lib</artifactId>
-	<version>0.6</version>
+	<version>0.7</version>
 	<packaging>jar</packaging>
 
 	<name>probability-lib</name>

src/main/java/com/lewdev/probabilitylib/ProbabilityCollection.java

@@ -45,7 +45,7 @@
  * </ul>
  * 
  * @author Lewys Davies
- * @version 0.6
+ * @version 0.7
  *
  * @param <E> Type of elements
  */
@@ -152,6 +152,14 @@ public boolean remove(E object) {
 		return removed;
 	}
 
+	/**
+	 * Remove all objects from this collection
+	 */
+	public void clear() {
+		this.collection.clear();
+		this.totalProbability = 0;
+	}
+	
 	/**
 	 * Get a random object from this collection, based on probability.
 	 * 
@@ -161,7 +169,7 @@ public boolean remove(E object) {
 	 */
 	public E get() {
 		if(this.isEmpty()) {
-			throw new IllegalStateException("Cannot get an element out of a empty collection");
+			throw new IllegalStateException("Cannot get an object out of a empty collection");
 		}
 
 		ProbabilitySetElement<E> toFind = new ProbabilitySetElement<>(null, 0);

src/test/java/com/lewdev/probabilitylib/ProbabilityCollectionTest.java

@@ -133,6 +133,58 @@ public void test_remove_duplicates() {
 		assertTrue(collection.isEmpty());
 		assertEquals(0, collection.getTotalProbability());
 	}
+	
+	@RepeatedTest(value = 10_000)
+	public void test_clear() {
+		ProbabilityCollection<String> collection = new ProbabilityCollection<>();
+		assertEquals(0, collection.size());
+		assertTrue(collection.isEmpty());
+		assertEquals(0, collection.getTotalProbability());
+		
+		collection.clear();
+		
+		assertEquals(0, collection.size());
+		assertTrue(collection.isEmpty());
+		assertEquals(0, collection.getTotalProbability());
+		
+		collection.add("tmp", 1);
+		
+		assertEquals(1, collection.size());
+		assertFalse(collection.isEmpty());
+		assertEquals(1, collection.getTotalProbability());
+		
+		collection.clear();
+		
+		assertEquals(0, collection.size());
+		assertTrue(collection.isEmpty());
+		assertEquals(0, collection.getTotalProbability());
+		
+		String t1 = "Hello";
+		String t2 = "World";
+		String t3 = "!";
+		
+		for(int i = 0; i < 10; i++) {
+			collection.add(t1, 10);
+		}
+		
+		for(int i = 0; i < 10; i++) {
+			collection.add(t2, 10);
+		}
+		
+		for(int i = 0; i < 10; i++) {
+			collection.add(t3, 10);
+		}
+		
+		assertEquals(30, collection.size());
+		assertFalse(collection.isEmpty());
+		assertEquals(300, collection.getTotalProbability());
+		
+		collection.clear();
+		
+		assertEquals(0, collection.getTotalProbability());
+		assertEquals(0, collection.size());
+		assertTrue(collection.isEmpty());
+	}
 
 	@RepeatedTest(1_000_000)
 	public void test_probability() {