This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git
The following commit(s) were added to refs/heads/master by this push:
new 6ee9dd78c Synchronize forEach() in SynchronizedCollection (#720)
6ee9dd78c is described below
commit 6ee9dd78c79f367dd8e3e1655e4664bcec960ad6
Author: Naveed Khan <[email protected]>
AuthorDate: Sat Aug 1 11:51:55 2026 +0000
Synchronize forEach() in SynchronizedCollection (#720)
* synchronize forEach in SynchronizedCollection
* Clarify comment on elements used in tests
---------
Co-authored-by: Gary Gregory <[email protected]>
---
.../collection/SynchronizedCollection.java | 11 +++++
.../collection/SynchronizedCollectionTest.java | 48 ++++++++++++++++++++++
2 files changed, 59 insertions(+)
diff --git
a/src/main/java/org/apache/commons/collections4/collection/SynchronizedCollection.java
b/src/main/java/org/apache/commons/collections4/collection/SynchronizedCollection.java
index 0a77da8f4..71b83669c 100644
---
a/src/main/java/org/apache/commons/collections4/collection/SynchronizedCollection.java
+++
b/src/main/java/org/apache/commons/collections4/collection/SynchronizedCollection.java
@@ -21,6 +21,7 @@ import java.io.Serializable;
import java.util.Collection;
import java.util.Iterator;
import java.util.Objects;
+import java.util.function.Consumer;
import java.util.function.Predicate;
/**
@@ -143,6 +144,16 @@ public class SynchronizedCollection<E> implements
Collection<E>, Serializable {
}
}
+ /**
+ * @since 4.6.0
+ */
+ @Override
+ public void forEach(final Consumer<? super E> action) {
+ synchronized (lock) {
+ decorated().forEach(action);
+ }
+ }
+
@Override
public int hashCode() {
synchronized (lock) {
diff --git
a/src/test/java/org/apache/commons/collections4/collection/SynchronizedCollectionTest.java
b/src/test/java/org/apache/commons/collections4/collection/SynchronizedCollectionTest.java
index bfd265d25..2292f7245 100644
---
a/src/test/java/org/apache/commons/collections4/collection/SynchronizedCollectionTest.java
+++
b/src/test/java/org/apache/commons/collections4/collection/SynchronizedCollectionTest.java
@@ -16,9 +16,29 @@
*/
package org.apache.commons.collections4.collection;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.params.provider.Arguments.arguments;
+
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.stream.Stream;
+
+import org.apache.commons.collections4.bag.HashBag;
+import org.apache.commons.collections4.bag.SynchronizedBag;
+import org.apache.commons.collections4.bag.SynchronizedSortedBag;
+import org.apache.commons.collections4.bag.TreeBag;
+import org.apache.commons.collections4.multiset.HashMultiSet;
+import org.apache.commons.collections4.multiset.SynchronizedMultiSet;
+import org.apache.commons.collections4.multiset.SynchronizedSortedMultiSet;
+import org.apache.commons.collections4.multiset.TreeMultiSet;
+import org.apache.commons.collections4.queue.SynchronizedQueue;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
/**
* Extension of {@link AbstractCollectionTest} for exercising the
@@ -26,6 +46,22 @@ import java.util.Collection;
*/
public class SynchronizedCollectionTest<E> extends AbstractCollectionTest<E> {
+ /** The elements used to populate each decorator under test. */
+ private static final List<String> ELEMENTS = Arrays.asList("a", "b");
+
+ /**
+ * Every decorator that inherits {@link
SynchronizedCollection#forEach(java.util.function.Consumer)}.
+ */
+ static Stream<Arguments> getSynchronizedDecorators() {
+ return Stream.of(
+ arguments("SynchronizedCollection",
SynchronizedCollection.synchronizedCollection(new ArrayList<>(ELEMENTS))),
+ arguments("SynchronizedBag",
SynchronizedBag.synchronizedBag(new HashBag<>(ELEMENTS))),
+ arguments("SynchronizedSortedBag",
SynchronizedSortedBag.synchronizedSortedBag(new TreeBag<>(ELEMENTS))),
+ arguments("SynchronizedMultiSet",
SynchronizedMultiSet.synchronizedMultiSet(new HashMultiSet<>(ELEMENTS))),
+ arguments("SynchronizedSortedMultiSet",
SynchronizedSortedMultiSet.synchronizedSortedMultiSet(new
TreeMultiSet<>(ELEMENTS))),
+ arguments("SynchronizedQueue",
SynchronizedQueue.synchronizedQueue(new LinkedList<>(ELEMENTS))));
+ }
+
@Override
public String getCompatibilityVersion() {
return "4";
@@ -46,6 +82,18 @@ public class SynchronizedCollectionTest<E> extends
AbstractCollectionTest<E> {
return SynchronizedCollection.synchronizedCollection(new
ArrayList<>());
}
+ @ParameterizedTest(name = "{0}")
+ @MethodSource("getSynchronizedDecorators")
+ void testForEachHoldsLock(final String description, final
Collection<String> decorator) {
+ final List<String> visited = new ArrayList<>();
+ decorator.forEach(element -> {
+ assertTrue(Thread.holdsLock(decorator), () -> description + " ran
forEach without holding its lock");
+ visited.add(element);
+ });
+ assertEquals(ELEMENTS.size(), visited.size());
+ assertTrue(visited.containsAll(ELEMENTS));
+ }
+
// void testCreate() throws Exception {
// resetEmpty();
// writeExternalFormToDisk((java.io.Serializable) getCollection(),
"src/test/resources/data/test/SynchronizedCollection.emptyCollection.version4.obj");
