org.eclipse.xtext.xbase.lib.CollectionExtensions Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2011 itemis AG (http://www.itemis.eu) and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*******************************************************************************/
package org.eclipse.xtext.xbase.lib;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.SortedSet;
import com.google.common.annotations.GwtCompatible;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSortedMap;
import com.google.common.collect.ImmutableSortedSet;
import com.google.common.collect.Iterables;
import static com.google.common.collect.Sets.*;
/**
* This is an extension library for {@link Collection collections}.
*
* @author Sven Efftinge - Initial contribution and API
* @author Sebastian Zarnekow
*/
@GwtCompatible public class CollectionExtensions {
/**
* The operator mapping from {@code +=} to {@link Collection#add(Object)}. Returns true if the
* collection changed due to this operation.
*
* @param collection
* the to-be-changed collection. May not be null.
* @param value
* the value that should be added to the collection.
* @return true if the collection changed due to this operation.
* @see Collection#add(Object)
*/
@Inline(value="$1.add($2)")
public static boolean operator_add(Collection collection, E value) {
return collection.add(value);
}
/**
* The operator mapping from {@code +=} to {@link #addAll(Collection, Iterable)}. Returns true if the
* collection changed due to this operation.
*
* @param collection
* the to-be-changed collection. May not be null.
* @param newElements
* elements to be inserted into the collection. May not be null but may contain
* null elements if the the target collection supports null elements.
* @return true if the collection changed due to this operation.
* @see #addAll(Collection, Iterable)
*/
@Inline(value="$3.$4addAll($1, $2)", imported=Iterables.class)
public static boolean operator_add(Collection collection, Iterable newElements) {
return addAll(collection, newElements);
}
/**
* The operator mapping from {@code -=} to {@link Collection#remove(Object)}. Returns true if the
* collection changed due to this operation.
*
* @param collection
* the to-be-changed collection. May not be null.
* @param value
* the value that should be removed from the collection.
* @return true if the collection changed due to this operation.
* @see Collection#remove(Object)
* @since 2.4
*/
@Inline(value="$1.remove($2)")
public static boolean operator_remove(Collection collection, E value) {
return collection.remove(value);
}
/**
* The operator mapping from {@code -=} to {@link #removeAll(Collection, Collection)}. Returns true if the
* collection changed due to this operation.
*
* @param collection
* the to-be-changed collection. May not be null.
* @param newElements
* elements to be removed from the collection. May not be null but may contain
* null elements if the the target collection supports null elements.
* @return true if the collection changed due to this operation.
* @see #removeAll(Collection, Collection)
* @since 2.4
*/
@Inline(value="$3.removeAll($1, $2)", imported=Iterables.class)
public static boolean operator_remove(Collection collection, Collection newElements) {
return removeAll(collection, newElements);
}
/**
* Returns an unmodifiable view of the specified {@code list}.
*
* @param list
* the list for which an unmodifiable view is to be returned. May not be null.
* @return an unmodifiable view of the specified list.
* @see Collections#unmodifiableList(List)
*/
@Inline(value="$2.$3unmodifiableList($1)", imported=Collections.class)
public static List unmodifiableView(List list) {
return Collections.unmodifiableList(list);
}
/**
* Returns an unmodifiable view of the specified {@code collection}.
*
* @param collection
* the collection for which an unmodifiable view is to be returned. May not be null.
* @return an unmodifiable view of the specified collection.
* @see Collections#unmodifiableCollection(Collection)
*/
@Inline(value="$2.$3unmodifiableCollection($1)", imported=Collections.class)
public static Collection unmodifiableView(Collection collection) {
return Collections.unmodifiableCollection(collection);
}
/**
* Returns an unmodifiable view of the specified {@code set}.
*
* @param set
* the set for which an unmodifiable view is to be returned. May not be null.
* @return an unmodifiable view of the specified set.
* @see Collections#unmodifiableSet(Set)
*/
@Inline(value="$2.$3unmodifiableSet($1)", imported=Collections.class)
public static Set unmodifiableView(Set set) {
return Collections.unmodifiableSet(set);
}
/**
* Returns an unmodifiable view of the specified sorted {@code set}.
*
* @param set
* the sorted set for which an unmodifiable view is to be returned. May not be null.
* @return an unmodifiable view of the specified sorted set.
* @see Collections#unmodifiableSortedSet(SortedSet)
*/
@Inline(value="$2.$3unmodifiableSortedSet($1)", imported=Collections.class)
public static SortedSet unmodifiableView(SortedSet set) {
return Collections.unmodifiableSortedSet(set);
}
/**
* Returns an unmodifiable view of the specified {@code map}.
*
* @param map
* the map for which an unmodifiable view is to be returned. May not be null.
* @return an unmodifiable view of the specified map.
* @see Collections#unmodifiableMap(Map)
*/
@Inline(value="$2.$3unmodifiableMap($1)", imported=Collections.class)
public static Map unmodifiableView(Map map) {
return Collections.unmodifiableMap(map);
}
/**
* Returns an unmodifiable view of the specified sorted {@code map}.
*
* @param map
* the sorted map for which an unmodifiable view is to be returned. May not be null.
* @return an unmodifiable view of the specified sorted map.
* @see Collections#unmodifiableSortedMap(SortedMap)
*/
@Inline(value="$2.$3unmodifiableSortedMap($1)", imported=Collections.class)
public static SortedMap unmodifiableView(SortedMap map) {
return Collections.unmodifiableSortedMap(map);
}
/**
* Returns an immutable copy of the specified {@code list}.
*
* @param list
* the list for which an immutable copy should be created. May not be null.
* @return an immutable copy of the specified list.
*/
@Inline(value="$2.$3copyOf($1)", imported=ImmutableList.class)
public static List immutableCopy(List list) {
return ImmutableList.copyOf(list);
}
/**
* Returns an immutable copy of the specified {@code set}.
*
* @param set
* the set for which an immutable copy should be created. May not be null.
* @return an immutable copy of the specified set.
*/
@Inline(value="$2.$3copyOf($1)", imported=ImmutableSet.class)
public static Set immutableCopy(Set set) {
return ImmutableSet.copyOf(set);
}
/**
* Returns an immutable copy of the specified sorted {@code set}.
*
* @param set
* the sorted set for which an immutable copy should be created. May not be null.
* @return an immutable copy of the specified sorted set.
*/
@Inline(value="$2.$3copyOfSorted($1)", imported=ImmutableSortedSet.class)
public static SortedSet immutableCopy(SortedSet set) {
return ImmutableSortedSet.copyOfSorted(set);
}
/**
* Returns an immutable copy of the specified {@code map}.
*
* @param map
* the map for which an immutable copy should be created. May not be null.
* @return an immutable copy of the specified map.
*/
@Inline(value="$2.$3copyOf($1)", imported=ImmutableMap.class)
public static Map immutableCopy(Map map) {
return ImmutableMap.copyOf(map);
}
/**
* Returns an immutable copy of the specified sorted {@code map}.
*
* @param map
* the sorted map for which an immutable copy should be created. May not be null.
* @return an immutable copy of the specified sorted map.
*/
@Inline(value="$2.$3copyOfSorted($1)", imported=ImmutableSortedMap.class)
public static SortedMap immutableCopy(SortedMap map) {
return ImmutableSortedMap.copyOfSorted(map);
}
/**
* Adds all of the specified elements to the specified collection.
*
* @param collection
* the collection into which the {@code elements} are to be inserted. May not be null.
* @param elements
* the elements to insert into the {@code collection}. May not be null but may contain
* null entries if the {@code collection} allows that.
* @return true if the collection changed as a result of the call
*/
public static boolean addAll(Collection collection, T... elements) {
return collection.addAll(Arrays.asList(elements));
}
/**
* Adds all of the specified elements to the specified collection.
*
* @param collection
* the collection into which the {@code elements} are to be inserted. May not be null.
* @param elements
* the elements to insert into the {@code collection}. May not be null but may contain
* null entries if the {@code collection} allows that.
* @return true if the collection changed as a result of the call
*/
@Inline(value="$3.$4addAll($1, $2)", imported=Iterables.class)
public static boolean addAll(Collection collection, Iterable elements) {
return Iterables.addAll(collection, elements);
}
/**
* Removes all of the specified elements from the specified collection.
*
* @param collection
* the collection from which the {@code elements} are to be removed. May not be null.
* @param elements
* the elements be remove from the {@code collection}. May not be null but may contain
* null entries if the {@code collection} allows that.
* @return true if the collection changed as a result of the call
* @since 2.4
*/
public static boolean removeAll(Collection collection, T... elements) {
return collection.removeAll(Arrays.asList(elements));
}
/**
* Removes all of the specified elements from the specified collection.
*
* @param collection
* the collection from which the {@code elements} are to be removed. May not be null.
* @param elements
* the elements to remove from the {@code collection}. May not be null but may contain
* null entries if the {@code collection} allows that.
* @return true if the collection changed as a result of the call
* @since 2.4
*/
@Inline(value="$3.$4removeAll($1, $2)", imported=Iterables.class)
public static boolean removeAll(Collection collection, Collection elements) {
return Iterables.removeAll(collection, elements);
}
/**
* Removes all of the specified elements from the specified collection.
*
* @param collection
* the collection from which the {@code elements} are to be removed. May not be null.
* @param elements
* the elements to remove from the {@code collection}. May not be null but may contain
* null entries if the {@code collection} allows that.
* @return true if the collection changed as a result of the call
* @since 2.4
*/
public static boolean removeAll(Collection collection, Iterable elements) {
return Iterables.removeAll(collection, newHashSet(elements));
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy