Package eu.bandm.tools.util.java

Class Collections

java.lang.Object

eu.bandm.tools.util.java.Collections

public abstract class Collections
extends Object

Library of constants and combinators for classes implementing Collection and similars.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Collections.MapBuilder<A,B>

Method Summary

Modifier and Type	Method	Description
static <A, B> Map<A,B>	asGraph(Function<? super A,? extends B> fun, Set<? extends A> things)
static <A, B> Collection<B>	asMap(Function<? super A,? extends B> fun, Collection<? extends A> things)	Deprecated, for removal: This API element is subject to removal in a future version. use java.util.stream instead; see the first example at Collectors.
static <A, B, C extends B> Map<A,B>	castValues(Class<? extends C> cls, Map<A,C> things)
static <A> Collection<A>	concat(Collection<? extends A> some, Collection<? extends A> other)
static <A, B> Map<B,A>	converse(Map<A,B> map)
static <A, B> boolean	doFilterKey(Predicate<? super A> p, Map<A,B> m)
static <A, B> boolean	doFilterValue(Predicate<? super B> p, Map<A,B> m)
static <A> void	doPairwise(List<A> list, BiConsumer<A,A> code)	Execute the given code to all neighouring pairs of elements.
static <A> Set<A>	elements(Collection<? extends A> things)
static <A> SortedSet<A>	elements(Collection<? extends A> things, Comparator<? super A> comparator)
static <A, B> SortedMap<A,B>	emptySortedMap()
static <A> SortedSet<A>	emptySortedSet()
static <K, V> Map.Entry<K,V>	entry(K key, V value)
static <A> Collection<A>	flatten(Collection<? extends Collection<A>> colls)
static <D> D	infimum(SortedSet<D> set, D value)	Return the highest member of the set which is less or equal the given value.
static <D> D	infimumKey(SortedMap<D,?> map, D value)	Return the highest key in the domain of the map which is less or equal the given value.
static <A> Set<A>	intersection(Collection<? extends A> some, Collection<? extends A> other)
static <A> A	lastOf(List<A> list)	Return the last element in a list.
static <A> List<A>	literalList(A... values)	Returns an unmodifiable list of the given elements.
static <A, B> Collections.MapBuilder<A,B>	literalMap(A a, B b)
static <A> Set<A>	literalSet(A... values)	Returns an unmodifiable set of the given elements.
static <A, B> Collection<B>	map(Function<? super A,? extends B> fun, Collection<? extends A> things)	Deprecated, for removal: This API element is subject to removal in a future version. use asMap(java.util.function.Function<? super A, ? extends B>, java.util.Collection<? extends A>) or toMap(java.util.function.Function<? super A, ? extends B>, java.util.Collection<? extends A>) instead.
static <A, B, C> Map.Entry<A,C>	map(Function<? super B,? extends C> fun, Map.Entry<A,B> e)
static <A, B, C> Map<A,C>	map(Function<? super B,? extends C> fun, Map<A,B> things)
static <A, B, C> Function<Map.Entry<A,B>,Map.Entry<A,C>>	mapEntry(Function<? super B,? extends C> fun)
static <A, B, C> Function<Map.Entry<A,B>,Map.Entry<A,C>>	mapEntryWithKey(Function<? super Map.Entry<A,B>,? extends C> fun)
static <A, B, C> Map<A,C>	mapWithKey(BiFunction<? super A,? super B,? extends C> fun, Map<A,B> things)
static <A, B, C> Map<A,C>	mapWithKey(Function<? super Map.Entry<A,B>,? extends C> fun, Map<A,B> things)
static <A> Set<A>	setminus(Collection<? extends A> some, Collection<? extends A> other)
static <A extends Comparable<? super A>, B> SortedMap<A,B>	singletonSortedMap(A key, B value)
static <A, B> SortedMap<A,B>	singletonSortedMap(Comparator<? super A> comparator, A key, B value)
static <A extends Comparable<? super A>> SortedSet<A>	singletonSortedSet(A elem)
static <A> SortedSet<A>	singletonSortedSet(Comparator<? super A> comparator, A elem)
static <T> T	some(Collection<T> set)
static <T> T	the(Collection<T> set)
static <A> Collection<A>	toFilter(Predicate<? super A> pred, Collection<? extends A> things)
static <A> List<A>	toFilter(Predicate<? super A> pred, List<A> things)
static <A> Set<A>	toFilter(Predicate<? super A> pred, Set<? extends A> things)
static <A> SortedSet<A>	toFilter(Predicate<? super A> pred, SortedSet<A> things)
static <A, B> Map<A,B>	toGraph(Function<? super A,? extends B> fun, Set<? extends A> dom)
static <A, B> Collection<B>	toMap(Function<? super A,? extends B> fun, Collection<? extends A> things)	Deprecated, for removal: This API element is subject to removal in a future version. use java.util.stream instead; see the first example at Collectors.
static <A, B> Set<B>	toMap(Function<? super A,? extends B> fun, Set<? extends A> things)	Deprecated, for removal: This API element is subject to removal in a future version. use java.util.stream instead; see the first example at Collectors.
static <A, B> SortedSet<B>	toMap(Function<? super A,? extends B> fun, SortedSet<A> things, Comparator<? super B> comparator)	Deprecated, for removal: This API element is subject to removal in a future version. use java.util.stream instead; see the first example at Collectors.
static <A, B, C> Map<B,C>	toSpan(Function<? super A,? extends B> left, Function<? super A,? extends C> right, Collection<? extends A> gen)
static <A> Set<A>	union(Collection<? extends A> some, Collection<? extends A> other)
static <K, V> Map.Entry<K,V>	unmodifiableEntry(Map.Entry<? extends K,? extends V> entry)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

toFilter

public static <A> Collection<A> toFilter(Predicate<? super A> pred,
 Collection<? extends A> things)

toFilter

public static <A> Set<A> toFilter(Predicate<? super A> pred,
 Set<? extends A> things)

toFilter

public static <A> SortedSet<A> toFilter(Predicate<? super A> pred,
 SortedSet<A> things)

toFilter

public static <A> List<A> toFilter(Predicate<? super A> pred,
 List<A> things)

the

public static <T> T the(Collection<T> set)

some

public static <T> T some(Collection<T> set)

map

@Deprecated(forRemoval=true)
public static <A,
B> Collection<B> map(Function<? super A,? extends B> fun,
 Collection<? extends A> things)

Deprecated, for removal: This API element is subject to removal in a future version.

use asMap(java.util.function.Function<? super A, ? extends B>, java.util.Collection<? extends A>) or toMap(java.util.function.Function<? super A, ? extends B>, java.util.Collection<? extends A>) instead.

asMap

@Deprecated(forRemoval=true)
public static <A,
B> Collection<B> asMap(Function<? super A,? extends B> fun,
 Collection<? extends A> things)

Deprecated, for removal: This API element is subject to removal in a future version.

use java.util.stream instead; see the first example at Collectors.

toMap

@Deprecated(forRemoval=true)
public static <A,
B> Collection<B> toMap(Function<? super A,? extends B> fun,
 Collection<? extends A> things)

Deprecated, for removal: This API element is subject to removal in a future version.

use java.util.stream instead; see the first example at Collectors.

toMap

@Deprecated(forRemoval=true)
public static <A,
B> Set<B> toMap(Function<? super A,? extends B> fun,
 Set<? extends A> things)

Deprecated, for removal: This API element is subject to removal in a future version.

use java.util.stream instead; see the first example at Collectors.

toMap

@Deprecated(forRemoval=true)
public static <A,
B> SortedSet<B> toMap(Function<? super A,? extends B> fun,
 SortedSet<A> things,
 Comparator<? super B> comparator)

Deprecated, for removal: This API element is subject to removal in a future version.

use java.util.stream instead; see the first example at Collectors.

literalSet

@SafeVarargs
public static <A> Set<A> literalSet(A... values)

Returns an unmodifiable set of the given elements. The competitor Set.of(Object[]) is not recommended due to its peculiar interface.

See Also:

• Collections.emptySet()
• Collections.singleton(T)

literalList

@SafeVarargs
public static <A> List<A> literalList(A... values)

Returns an unmodifiable list of the given elements. The competitor List.of(Object[]) is not recommended because it does not accept null values.

map

public static <A,
B,
C> Map<A,C> map(Function<? super B,? extends C> fun,
 Map<A,B> things)

asGraph

public static <A,
B> Map<A,B> asGraph(Function<? super A,? extends B> fun,
 Set<? extends A> things)

mapWithKey

public static <A,
B,
C> Map<A,C> mapWithKey(Function<? super Map.Entry<A,B>,? extends C> fun,
 Map<A,B> things)

mapWithKey

public static <A,
B,
C> Map<A,C> mapWithKey(BiFunction<? super A,? super B,? extends C> fun,
 Map<A,B> things)

map

public static <A,
B,
C> Map.Entry<A,C> map(Function<? super B,? extends C> fun,
 Map.Entry<A,B> e)

mapEntry

public static <A,
B,
C>
Function<Map.Entry<A,B>,Map.Entry<A,C>> mapEntry(Function<? super B,? extends C> fun)

mapEntryWithKey

public static <A,
B,
C>
Function<Map.Entry<A,B>,Map.Entry<A,C>> mapEntryWithKey(Function<? super Map.Entry<A,B>,? extends C> fun)

doFilterKey

public static <A,
B> boolean doFilterKey(Predicate<? super A> p,
 Map<A,B> m)

doFilterValue

public static <A,
B> boolean doFilterValue(Predicate<? super B> p,
 Map<A,B> m)

toSpan

public static <A,
B,
C> Map<B,C> toSpan(Function<? super A,? extends B> left,
 Function<? super A,? extends C> right,
 Collection<? extends A> gen)

toGraph

public static <A,
B> Map<A,B> toGraph(Function<? super A,? extends B> fun,
 Set<? extends A> dom)

concat

public static <A> Collection<A> concat(Collection<? extends A> some,
 Collection<? extends A> other)

union

public static <A> Set<A> union(Collection<? extends A> some,
 Collection<? extends A> other)

setminus

public static <A> Set<A> setminus(Collection<? extends A> some,
 Collection<? extends A> other)

intersection

public static <A> Set<A> intersection(Collection<? extends A> some,
 Collection<? extends A> other)

flatten

public static <A> Collection<A> flatten(Collection<? extends Collection<A>> colls)

unmodifiableEntry

public static <K,
V> Map.Entry<K,V> unmodifiableEntry(Map.Entry<? extends K,? extends V> entry)

entry

public static <K,
V> Map.Entry<K,V> entry(K key,
 V value)

elements

public static <A> Set<A> elements(Collection<? extends A> things)

elements

public static <A> SortedSet<A> elements(Collection<? extends A> things,
 Comparator<? super A> comparator)

castValues

public static <A,
B,
C extends B> Map<A,B> castValues(Class<? extends C> cls,
 Map<A,C> things)

literalMap

public static <A,
B> Collections.MapBuilder<A,B> literalMap(A a,
 B b)

emptySortedSet

public static <A> SortedSet<A> emptySortedSet()

singletonSortedSet

public static <A extends Comparable<? super A>>
SortedSet<A> singletonSortedSet(A elem)

singletonSortedSet

public static <A> SortedSet<A> singletonSortedSet(Comparator<? super A> comparator,
 A elem)

emptySortedMap

public static <A,
B> SortedMap<A,B> emptySortedMap()

singletonSortedMap

public static <A extends Comparable<? super A>,
B>
SortedMap<A,B> singletonSortedMap(A key,
 B value)

singletonSortedMap

public static <A,
B> SortedMap<A,B> singletonSortedMap(Comparator<? super A> comparator,
 A key,
 B value)

infimum

public static <D> D infimum(SortedSet<D> set,
 D value)

Return the highest member of the set which is less or equal the given value.

infimumKey

public static <D> D infimumKey(SortedMap<D,?> map,
 D value)

Return the highest key in the domain of the map which is less or equal the given value. Please note that "aSortedSet.keySet()" is not a SortedSet, so this method is really necessary.

converse

public static <A,
B> Map<B,A> converse(Map<A,B> map)

lastOf

public static <A> A lastOf(List<A> list)

Return the last element in a list. Assume the list is NOT empty.

doPairwise

public static <A> void doPairwise(List<A> list,
 BiConsumer<A,A> code)

Execute the given code to all neighouring pairs of elements.