com.wl4g.component.common.collection.CollectionUtils2 Maven / Gradle / Ivy
/*
* Copyright 2017 ~ 2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.wl4g.component.common.collection;
import static com.wl4g.component.common.lang.Assert2.isTrue;
import static java.lang.String.format;
import static java.util.Arrays.asList;
import static java.util.Collections.emptyList;
import static java.util.Collections.emptyMap;
import static java.util.Collections.emptySet;
import static java.util.Objects.isNull;
import java.io.Serializable;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.collections.EnumerationUtils;
import javax.annotation.Nullable;
import com.wl4g.component.common.collection.multimap.MultiValueMap;
import com.wl4g.component.common.lang.Assert2;
import com.wl4g.component.common.lang.ObjectUtils2;
/**
* Miscellaneous collection utility methods. Mainly for internal use within the
* framework.
*
* @author Wangl.sir
* @version v1.0 2018年11月4日
* @since
*/
public abstract class CollectionUtils2 extends CollectionUtils {
// ----------------------------------------------
// --- Spring collection util methods. ---
// ----------------------------------------------
/**
* Return {@code true} if the supplied Map is {@code null} or empty.
* Otherwise, return {@code false}.
*
* @param map
* the Map to check
* @return whether the given Map is empty
*/
public static boolean isEmpty(Map map) {
return (map == null || map.isEmpty());
}
/**
* Convert the supplied array into a List. A primitive array gets converted
* into a List of the appropriate wrapper type.
*
* NOTE: Generally prefer the standard {@link Arrays#asList} method.
* This {@code arrayToList} method is just meant to deal with an incoming
* Object value that might be an {@code Object[]} or a primitive array at
* runtime.
*
* A {@code null} source value will be converted to an empty List.
*
* @param source
* the (potentially primitive) array
* @return the converted List result
* @see ObjectUtils2#toObjectArray(Object)
* @see Arrays#asList(Object[])
*/
@SuppressWarnings("rawtypes")
public static List arrayToList(Object source) {
return Arrays.asList(ObjectUtils2.toObjectArray(source));
}
/**
* Merge the given array into the given Collection.
*
* @param array
* the array to merge (may be {@code null})
* @param collection
* the target Collection to merge the array into
*/
@SuppressWarnings("unchecked")
public static void mergeArrayIntoCollection(Object array, Collection collection) {
if (collection == null) {
throw new IllegalArgumentException("Collection must not be null");
}
Object[] arr = ObjectUtils2.toObjectArray(array);
for (Object elem : arr) {
collection.add((E) elem);
}
}
/**
* Merge the given Properties instance into the given Map, copying all
* properties (key-value pairs) over.
*
* Uses {@code Properties.propertyNames()} to even catch default properties
* linked into the original Properties instance.
*
* @param props
* the Properties instance to merge (may be {@code null})
* @param map
* the target Map to merge the properties into
*/
@SuppressWarnings("unchecked")
public static void mergePropertiesIntoMap(Properties props, Map map) {
if (map == null) {
throw new IllegalArgumentException("Map must not be null");
}
if (props != null) {
for (Enumeration en = props.propertyNames(); en.hasMoreElements();) {
String key = (String) en.nextElement();
Object value = props.get(key);
if (value == null) {
// Allow for defaults fallback or potentially overridden
// accessor...
value = props.getProperty(key);
}
map.put((K) key, (V) value);
}
}
}
/**
* Check whether the given Iterator contains the given element.
*
* @param iterator
* the Iterator to check
* @param element
* the element to look for
* @return {@code true} if found, {@code false} else
*/
public static boolean contains(Iterator iterator, Object element) {
if (iterator != null) {
while (iterator.hasNext()) {
Object candidate = iterator.next();
if (ObjectUtils2.nullSafeEquals(candidate, element)) {
return true;
}
}
}
return false;
}
/**
* Check whether the given Enumeration contains the given element.
*
* @param enumeration
* the Enumeration to check
* @param element
* the element to look for
* @return {@code true} if found, {@code false} else
*/
public static boolean contains(Enumeration enumeration, Object element) {
if (enumeration != null) {
while (enumeration.hasMoreElements()) {
Object candidate = enumeration.nextElement();
if (ObjectUtils2.nullSafeEquals(candidate, element)) {
return true;
}
}
}
return false;
}
/**
* Check whether the given Collection contains the given element instance.
*
* Enforces the given instance to be present, rather than returning
* {@code true} for an equal element as well.
*
* @param collection
* the Collection to check
* @param element
* the element to look for
* @return {@code true} if found, {@code false} else
*/
public static boolean containsInstance(Collection collection, Object element) {
if (collection != null) {
for (Object candidate : collection) {
if (candidate == element) {
return true;
}
}
}
return false;
}
/**
* Return the first element in '{@code candidates}' that is contained in
* '{@code source}'. If no element in '{@code candidates}' is present in
* '{@code source}' returns {@code null}. Iteration order is
* {@link Collection} implementation specific.
*
* @param source
* the source Collection
* @param candidates
* the candidates to search for
* @return the first present object, or {@code null} if not found
*/
@SuppressWarnings("unchecked")
public static E findFirstMatch(Collection source, Collection candidates) {
if (isEmpty(source) || isEmpty(candidates)) {
return null;
}
for (Object candidate : candidates) {
if (source.contains(candidate)) {
return (E) candidate;
}
}
return null;
}
/**
* Find a single value of the given type in the given Collection.
*
* @param collection
* the Collection to search
* @param type
* the type to look for
* @return a value of the given type found if there is a clear match, or
* {@code null} if none or more than one such value found
*/
@SuppressWarnings("unchecked")
public static T findValueOfType(Collection collection, Class type) {
if (isEmpty(collection)) {
return null;
}
T value = null;
for (Object element : collection) {
if (type == null || type.isInstance(element)) {
if (value != null) {
// More than one value found... no clear single value.
return null;
}
value = (T) element;
}
}
return value;
}
/**
* Find a single value of one of the given types in the given Collection:
* searching the Collection for a value of the first type, then searching
* for a value of the second type, etc.
*
* @param collection
* the collection to search
* @param types
* the types to look for, in prioritized order
* @return a value of one of the given types found if there is a clear
* match, or {@code null} if none or more than one such value found
*/
public static Object findValueOfType(Collection collection, Class[] types) {
if (isEmpty(collection) || ObjectUtils2.isEmpty(types)) {
return null;
}
for (Class type : types) {
Object value = findValueOfType(collection, type);
if (value != null) {
return value;
}
}
return null;
}
/**
* Determine whether the given Collection only contains a single unique
* object.
*
* @param collection
* the Collection to check
* @return {@code true} if the collection contains a single reference or
* multiple references to the same instance, {@code false} else
*/
public static boolean hasUniqueObject(Collection collection) {
if (isEmpty(collection)) {
return false;
}
boolean hasCandidate = false;
Object candidate = null;
for (Object elem : collection) {
if (!hasCandidate) {
hasCandidate = true;
candidate = elem;
} else if (candidate != elem) {
return false;
}
}
return true;
}
/**
* Find the common element type of the given Collection, if any.
*
* @param collection
* the Collection to check
* @return the common element type, or {@code null} if no clear common type
* has been found (or the collection was empty)
*/
public static Class findCommonElementType(Collection collection) {
if (isEmpty(collection)) {
return null;
}
Class candidate = null;
for (Object val : collection) {
if (val != null) {
if (candidate == null) {
candidate = val.getClass();
} else if (candidate != val.getClass()) {
return null;
}
}
}
return candidate;
}
/**
* Marshal the elements from the given enumeration into an array of the
* given type. Enumeration elements must be assignable to the type of the
* given array. The array returned will be a different instance than the
* array given.
*/
public static A[] toArray(Enumeration enumeration, A[] array) {
ArrayList elements = new ArrayList();
while (enumeration.hasMoreElements()) {
elements.add(enumeration.nextElement());
}
return elements.toArray(array);
}
/**
* Adapt a {@code Map>} to an {@code MultiValueMap}.
*
* @param map
* the original map
* @return the multi-value map
* @since 3.1
*/
public static MultiValueMap toMultiValueMap(Map> map) {
return new MultiValueMapAdapter<>(map);
}
/**
* Return an unmodifiable view of the specified multi-value map.
*
* @param map
* the map for which an unmodifiable view is to be returned.
* @return an unmodifiable view of the specified multi-value map.
* @since 3.1
*/
@SuppressWarnings("unchecked")
public static MultiValueMap unmodifiableMultiValueMap(MultiValueMap map) {
Assert2.notNull(map, "'map' must not be null");
Map> result = new LinkedHashMap<>(map.size());
map.forEach((key, value) -> {
List values = Collections.unmodifiableList(value);
result.put(key, (List) values);
});
Map> unmodifiableMap = Collections.unmodifiableMap(result);
return toMultiValueMap(unmodifiableMap);
}
/**
* Adapts a Map to the MultiValueMap contract.
*/
@SuppressWarnings("serial")
private static class MultiValueMapAdapter implements MultiValueMap, Serializable {
private final Map> map;
public MultiValueMapAdapter(Map> map) {
Assert2.notNull(map, "'map' must not be null");
this.map = map;
}
@Override
@Nullable
public V getFirst(K key) {
List values = this.map.get(key);
return (values != null ? values.get(0) : null);
}
@Override
public void add(K key, @Nullable V value) {
List values = this.map.computeIfAbsent(key, k -> new LinkedList<>());
values.add(value);
}
@Override
public void addAll(K key, List values) {
List currentValues = this.map.computeIfAbsent(key, k -> new LinkedList<>());
currentValues.addAll(values);
}
@Override
public void addAll(MultiValueMap values) {
for (Entry> entry : values.entrySet()) {
addAll(entry.getKey(), entry.getValue());
}
}
@Override
public void set(K key, @Nullable V value) {
List values = new LinkedList<>();
values.add(value);
this.map.put(key, values);
}
@Override
public void setAll(Map values) {
values.forEach(this::set);
}
@Override
public Map toSingleValueMap() {
LinkedHashMap singleValueMap = new LinkedHashMap<>(this.map.size());
this.map.forEach((key, value) -> singleValueMap.put(key, value.get(0)));
return singleValueMap;
}
@Override
public int size() {
return this.map.size();
}
@Override
public boolean isEmpty() {
return this.map.isEmpty();
}
@Override
public boolean containsKey(Object key) {
return this.map.containsKey(key);
}
@Override
public boolean containsValue(Object value) {
return this.map.containsValue(value);
}
@Override
public List get(Object key) {
return this.map.get(key);
}
@Override
public List put(K key, List value) {
return this.map.put(key, value);
}
@Override
public List remove(Object key) {
return this.map.remove(key);
}
@Override
public void putAll(Map> map) {
this.map.putAll(map);
}
@Override
public void clear() {
this.map.clear();
}
@Override
public Set keySet() {
return this.map.keySet();
}
@Override
public Collection> values() {
return this.map.values();
}
@Override
public Set>> entrySet() {
return this.map.entrySet();
}
@Override
public boolean equals(@Nullable Object other) {
if (this == other) {
return true;
}
return this.map.equals(other);
}
@Override
public int hashCode() {
return this.map.hashCode();
}
@Override
public String toString() {
return this.map.toString();
}
}
// ----------------------------------------------
// --- Customization extensions util methods. ---
// ----------------------------------------------
/**
* Is empty array.
*
* @param collection
* @return
*/
@SuppressWarnings("unchecked")
public static boolean isEmptyArray(T... array) {
return isNull(array) || array.length <= 0;
}
/**
* Safe collection list.
*
* @param collection
* @return
*/
@SuppressWarnings("unchecked")
public static T[] safeArray(Class componentType, T... array) {
return isNull(array) ? (T[]) Array.newInstance(componentType, 0) : array;
}
/**
* Ensure that the default is at least an ArrayList instance (when the
* parameter is empty)
*
* @param array
* @return
*/
public static List safeArrayToList(T[] array) {
if (isNull(array)) {
return new ArrayList<>(2);
}
List list = new ArrayList<>(array.length);
for (T t : array)
list.add(t);
return list;
}
/**
* Ensure that the default is at least an ArrayList instance (when the
* parameter is empty)
*
* @param array
* @return
*/
public static Set safeArrayToSet(T[] array) {
return isNull(array) ? new HashSet<>(2) : new HashSet<>(asList(array));
}
/**
* Safe enumeration to list.
*
* @param enum
* @return
*/
@SuppressWarnings("unchecked")
public static List safeEnumerationToList(Enumeration enumeration) {
return isNull(enumeration) ? emptyList() : EnumerationUtils.toList(enumeration);
}
/**
* Safe collection list.
*
* @param list
* @return
*/
public static List safeList(List list) {
return isEmpty(list) ? emptyList() : list;
}
/**
* Safe array to list.
*
* @param array
* @return
*/
public static List safeToList(Class componentType, T[] array) {
return safeArrayToList(safeArray(componentType, array));
}
/**
* Safe collection set.
*
* @param set
* @return
*/
public static Set safeSet(Set set) {
return isEmpty(set) ? emptySet() : set;
}
/**
* Safe collection map.
*
* @param map
* @return
*/
public static Map safeMap(Map map) {
return CollectionUtils2.isEmpty(map) ? emptyMap() : map;
}
/**
* Ensure that the default is at least an ArrayList instance (when the
* parameter is empty)
*
* @param list
* @return
*/
public static List ensureList(List list) {
return isEmpty(list) ? new ArrayList() : list;
}
/**
* Ensure that the default is at least an fallback list instance (when the
* parameter is empty)
*
* @param list
* @param fallback
* @return
*/
public static List ensureList(List list, List fallback) {
return isEmpty(list) ? fallback : list;
}
/**
* Ensure that the default is at least an HashSet instance (when the
* parameter is empty)
*
* @param set
* @return
*/
public static Set ensureSet(Set set) {
return isEmpty(set) ? new HashSet() : set;
}
/**
* Ensure that the default is at least an fallback set instance (when the
* parameter is empty)
*
* @param set
* @param fallback
* @return
*/
public static Set ensureSet(Set set, Set fallback) {
return isEmpty(set) ? fallback : set;
}
/**
* Ensure that the default is at least an HashMap instance (when the
* parameter is empty)
*
* @param map
* @return
*/
public static Map ensureMap(Map map) {
return isEmpty(map) ? new HashMap<>() : map;
}
/**
* Ensure that the default is at least an fallback map instance (when the
* parameter is empty)
*
* @param map
* @param fallback
* @return
*/
public static Map ensureMap(Map map, Map fallback) {
return isEmpty(map) ? fallback : map;
}
/**
* Remove duplicate collection elements.
*
* @param collection
* @return
*/
public static Collection disDupCollection(Collection collection) {
Set disSet = new HashSet<>(collection);
collection.clear();
collection.addAll(disSet);
return collection;
}
/**
* Extract iterable element by iterations(index).
*
* @param iter
* @param defaultValue
* @return
*/
@Nullable
public static T extractFirst(@Nullable Iterable iter) {
return extractElement(iter, 0, null);
}
/**
* Extract iterable element by iterations(index).
*
* @param iter
* @param defaultValue
* @return
*/
@Nullable
public static T extractFirst(@Nullable Iterable iter, @Nullable T defaultValue) {
return extractElement(iter, 0, defaultValue);
}
/**
* Extract iterable element by iterations(index).
*
* @param iter
* Target collection iterable
* @param byIndex
* The element to be extracted belongs to that iteration
* @param defaultValue
* Default value.
* @return
*/
@Nullable
public static T extractElement(@Nullable Iterable iter, int byIndex, @Nullable T defaultValue) {
isTrue(byIndex >= 0, format("byIterations(%s) must >= 0", byIndex));
if (isNull(iter)) {
return defaultValue;
}
int i = 0;
Iterator it = iter.iterator();
while (it.hasNext()) {
T t = it.next();
if (byIndex == i++) {
return t;
}
}
return defaultValue;
}
}