From cb849d5acddb8dde204cff848221cbb6e9e531bd Mon Sep 17 00:00:00 2001
From: Sanne Grinovero <sanne@hibernate.org>
Date: Sun, 1 Nov 2020 21:31:48 +0000
Subject: [PATCH] HHH-14305 Introduce new method in CollectionsHelper to reduce
 size of long lived collections

---
 .../util/collections/CollectionHelper.java    | 69 +++++++++++++++++++
 1 file changed, 69 insertions(+)

diff --git a/hibernate-core/src/main/java/org/hibernate/internal/util/collections/CollectionHelper.java b/hibernate-core/src/main/java/org/hibernate/internal/util/collections/CollectionHelper.java
index eae21904f7..af4936bffb 100755
--- a/hibernate-core/src/main/java/org/hibernate/internal/util/collections/CollectionHelper.java
+++ b/hibernate-core/src/main/java/org/hibernate/internal/util/collections/CollectionHelper.java
@@ -211,4 +211,73 @@ public final class CollectionHelper {
 	public static boolean isEmpty(Object[] objects) {
 		return objects == null || objects.length == 0;
 	}
+
+	/**
+	 * Use to convert sets which will be retained for a long time,
+	 * such as for the lifetime of the Hibernate ORM instance.
+	 * The returned Set might be immutable, but there is no guarantee of this:
+	 * consider it immutable but don't rely on this.
+	 * The goal is to save memory.
+	 * @param set
+	 * @param <T>
+	 * @return
+	 */
+	public static <T> Set<T> toSmallSet(Set<T> set) {
+		switch ( set.size() ) {
+			case 0:
+				return Collections.EMPTY_SET;
+			case 1:
+				return Collections.singleton( set.iterator().next() );
+			default:
+				//TODO assert tests pass even if this is set to return an unmodifiable Set
+				return set;
+		}
+	}
+
+	/**
+	 * Use to convert Maps which will be retained for a long time,
+	 * such as for the lifetime of the Hibernate ORM instance.
+	 * The returned Map might be immutable, but there is no guarantee of this:
+	 * consider it immutable but don't rely on this.
+	 * The goal is to save memory.
+	 * @param map
+	 * @param <K>
+	 * @param <V>
+	 * @return
+	 */
+	public static <K, V> Map<K, V> toSmallMap(final Map<K, V> map) {
+		switch ( map.size() ) {
+			case 0:
+				return Collections.EMPTY_MAP;
+			case 1:
+				Map.Entry<K, V> entry = map.entrySet().iterator().next();
+				return Collections.singletonMap( entry.getKey(), entry.getValue() );
+			default:
+				//TODO assert tests pass even if this is set to return an unmodifiable Map
+				return map;
+		}
+	}
+
+	/**
+	 * Use to convert ArrayList instances which will be retained for a long time,
+	 * such as for the lifetime of the Hibernate ORM instance.
+	 * The returned List might be immutable, but there is no guarantee of this:
+	 * consider it immutable but don't rely on this.
+	 * The goal is to save memory.
+	 * @param arrayList
+	 * @param <V>
+	 * @return
+	 */
+	public static <V> List<V> toSmallList(ArrayList<V> arrayList) {
+		switch ( arrayList.size() ) {
+			case 0:
+				return Collections.EMPTY_LIST;
+			case 1:
+				return Collections.singletonList( arrayList.get( 0 ) );
+			default:
+				arrayList.trimToSize();
+				return arrayList;
+		}
+	}
+
 }