org.frameworkset.util.CollectionUtils Maven / Gradle / Ivy
Show all versions of bboss-util Show documentation
/*
* Copyright 2008 biaoping.yin
*
* 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 org.frameworkset.util;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
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;
/**
* Title: CollectionUtils.java
* Description:
* bboss workgroup
* Copyright (c) 2008
* @Date 2010-9-22
* @author biaoping.yin
* @version 1.0
*/
public abstract class CollectionUtils {
/**
* 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);
}
/**
* Adapts a Map to the MultiValueMap contract.
*/
@SuppressWarnings("serial")
private static class MultiValueMapAdapter implements MultiValueMap, Serializable {
private final Map> map;
public MultiValueMapAdapter(Map> map) {
Assert.notNull(map, "'map' must not be null");
this.map = map;
}
@Override
public void add(K key, V value) {
List values = this.map.get(key);
if (values == null) {
values = new LinkedList();
this.map.put(key, values);
}
values.add(value);
}
@Override
public V getFirst(K key) {
List values = this.map.get(key);
return (values != null ? values.get(0) : null);
}
@Override
public void set(K key, V value) {
List values = new LinkedList();
values.add(value);
this.map.put(key, values);
}
@Override
public void setAll(Map values) {
for (Entry entry : values.entrySet()) {
set(entry.getKey(), entry.getValue());
}
}
@Override
public Map toSingleValueMap() {
LinkedHashMap singleValueMap = new LinkedHashMap(this.map.size());
for (Entry> entry : map.entrySet()) {
singleValueMap.put(entry.getKey(), entry.getValue().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(Object other) {
if (this == other) {
return true;
}
return map.equals(other);
}
@Override
public int hashCode() {
return this.map.hashCode();
}
@Override
public String toString() {
return this.map.toString();
}
}
/**
* 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) {
Assert.notNull(map, "'map' must not be null");
Map> result = new LinkedHashMap>(map.size());
for (Map.Entry> entry : map.entrySet()) {
List values = Collections.unmodifiableList(entry.getValue());
result.put(entry.getKey(), (List) values);
}
Map> unmodifiableMap = Collections.unmodifiableMap(result);
return toMultiValueMap(unmodifiableMap);
}
/**
* Return true if the supplied Collection is null
* or empty. Otherwise, return false.
* @param collection the Collection to check
* @return whether the given Collection is empty
*/
public static boolean isEmpty(Collection collection) {
return (collection == null || collection.isEmpty());
}
/**
* Return true if the supplied Map is null
* or empty. Otherwise, return 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.
* A null source value will be converted to an
* empty List.
* @param source the (potentially primitive) array
* @return the converted List result
* @see ObjectUtils#toObjectArray(Object)
*/
public static List arrayToList(Object source) {
return Arrays.asList(ObjectUtils.toObjectArray(source));
}
/**
* Merge the given array into the given Collection.
* @param array the array to merge (may be null)
* @param collection the target Collection to merge the array into
*/
public static void mergeArrayIntoCollection(Object array, Collection collection) {
if (collection == null) {
throw new IllegalArgumentException("Collection must not be null");
}
Object[] arr = ObjectUtils.toObjectArray(array);
for (int i = 0; i < arr.length; i++) {
collection.add(arr[i]);
}
}
/**
* Merge the given Properties instance into the given Map,
* copying all properties (key-value pairs) over.
*
Uses Properties.propertyNames() to even catch
* default properties linked into the original Properties instance.
* @param props the Properties instance to merge (may be null)
* @param map the target Map to merge the properties into
*/
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();
map.put(key, props.getProperty(key));
}
}
}
/**
* Check whether the given Iterator contains the given element.
* @param iterator the Iterator to check
* @param element the element to look for
* @return true if found, false else
*/
public static boolean contains(Iterator iterator, Object element) {
if (iterator != null) {
while (iterator.hasNext()) {
Object candidate = iterator.next();
if (ObjectUtils.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 true if found, false else
*/
public static boolean contains(Enumeration enumeration, Object element) {
if (enumeration != null) {
while (enumeration.hasMoreElements()) {
Object candidate = enumeration.nextElement();
if (ObjectUtils.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
* true for an equal element as well.
* @param collection the Collection to check
* @param element the element to look for
* @return true if found, false else
*/
public static boolean containsInstance(Collection collection, Object element) {
if (collection != null) {
for (Iterator it = collection.iterator(); it.hasNext();) {
Object candidate = it.next();
if (candidate == element) {
return true;
}
}
}
return false;
}
/**
* Return true if any element in 'candidates' is
* contained in 'source'; otherwise returns false.
* @param source the source Collection
* @param candidates the candidates to search for
* @return whether any of the candidates has been found
*/
public static boolean containsAny(Collection source, Collection candidates) {
if (isEmpty(source) || isEmpty(candidates)) {
return false;
}
for (Iterator it = candidates.iterator(); it.hasNext();) {
if (source.contains(it.next())) {
return true;
}
}
return false;
}
/**
* Return the first element in 'candidates' that is contained in
* 'source'. If no element in 'candidates' is present in
* 'source' returns 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 null if not found
*/
public static Object findFirstMatch(Collection source, Collection candidates) {
if (isEmpty(source) || isEmpty(candidates)) {
return null;
}
for (Iterator it = candidates.iterator(); it.hasNext();) {
Object candidate = it.next();
if (source.contains(candidate)) {
return 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 null if none or more than one such value found
// */
// public static Object findValueOfType(Collection collection, Class type) {
// if (isEmpty(collection)) {
// return null;
// }
// Object value = null;
// for (Iterator it = collection.iterator(); it.hasNext();) {
// Object obj = it.next();
// if (type == null || type.isInstance(obj)) {
// if (value != null) {
// // More than one value found... no clear single value.
// return null;
// }
// value = obj;
// }
// }
// return value;
// }
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 null if none or more than one such value found
*/
public static Object findValueOfType(Collection collection, Class[] types) {
if (isEmpty(collection) || ObjectUtils.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 true if the collection contains a single reference or
* multiple references to the same instance, false else
*/
public static boolean hasUniqueObject(Collection collection) {
if (isEmpty(collection)) {
return false;
}
boolean hasCandidate = false;
Object candidate = null;
for (Iterator it = collection.iterator(); it.hasNext();) {
Object elem = it.next();
if (!hasCandidate) {
hasCandidate = true;
candidate = elem;
}
else if (candidate != elem) {
return false;
}
}
return true;
}
/**
* Adapt an enumeration to an iterator.
* @param enumeration the enumeration
* @return the iterator
*/
public static Iterator toIterator(Enumeration enumeration) {
return new EnumerationIterator(enumeration);
}
/**
* Iterator wrapping an Enumeration.
*/
private static class EnumerationIterator implements Iterator {
private final Enumeration enumeration;
public EnumerationIterator(Enumeration enumeration) {
this.enumeration = enumeration;
}
@Override
public boolean hasNext() {
return this.enumeration.hasMoreElements();
}
@Override
public E next() {
return this.enumeration.nextElement();
}
@Override
public void remove() throws UnsupportedOperationException {
throw new UnsupportedOperationException("Not supported");
}
}
}