Package uk.ac.ebi.utils.collections

Class MapCollection<K,V>

java.lang.Object

uk.ac.ebi.utils.collections.MapCollection<K,V>

All Implemented Interfaces:

Iterable<V>, Collection<V>

public class MapCollection<K,V>
extends Object
implements Collection<V>

Creates a view of a Map that is a collection. Does so by using a keyFunc function, which applies to map values. WARNING: Not fully tested yet!

Author:

brandizi

Date:

15 Oct 2015

Constructor Summary

Constructors

Constructor	Description
MapCollection(Map<K,V> base, com.google.common.base.Function<V,K> keyFunc)

Method Summary

Modifier and Type	Method	Description
boolean	add(V e)	Adds the entry (keyFunc.apply(e), e)
boolean	addAll(Collection<? extends V> c)	Iteratively calls add(Object).
void	clear()
boolean	contains(Object o)	Checks the entry (keyFunc.apply(e), e)
boolean	containsAll(Collection<?> c)	Iteratively calls contains(Object).
Map<K,V>	getBase()	The underlining map.
com.google.common.base.Function<V,K>	getKeyFunction()	The key function should return different values for different arguments and should always return the same value when an argument is presented multiple times.
boolean	isEmpty()
Iterator<V>	iterator()	Refers to getBase().Map.values() (the map's values).
boolean	remove(Object o)	Removes the entry (keyFunc.apply(e), e)
boolean	removeAll(Collection<?> c)	Iteratively calls remove(Object).
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()	Refers to getBase().Map.values() (the map's values).
<T> T[]	toArray(T[] a)	Refers to getBase().Map.values() (the map's values).

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Details

MapCollection

public MapCollection(Map<K,V> base,
 com.google.common.base.Function<V,K> keyFunc)

See Also:

• #getKey()

Method Details

size

public int size()

Specified by:

size in interface Collection<K>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<K>

contains

public boolean contains(Object o)

Checks the entry (keyFunc.apply(e), e)

Specified by:

contains in interface Collection<K>

iterator

public Iterator<V> iterator()

Refers to getBase().Map.values() (the map's values).

Specified by:

iterator in interface Collection<K>

Specified by:

iterator in interface Iterable<K>

toArray

public Object[] toArray()

Refers to getBase().Map.values() (the map's values).

Specified by:

toArray in interface Collection<K>

toArray

public <T> T[] toArray(T[] a)

Refers to getBase().Map.values() (the map's values).

Specified by:

toArray in interface Collection<K>

add

public boolean add(V e)

Adds the entry (keyFunc.apply(e), e)

Specified by:

add in interface Collection<K>

remove

public boolean remove(Object o)

Removes the entry (keyFunc.apply(e), e)

Specified by:

remove in interface Collection<K>

containsAll

public boolean containsAll(Collection<?> c)

Iteratively calls contains(Object).

Specified by:

containsAll in interface Collection<K>

addAll

public boolean addAll(Collection<? extends V> c)

Iteratively calls add(Object).

Specified by:

addAll in interface Collection<K>

removeAll

public boolean removeAll(Collection<?> c)

Iteratively calls remove(Object).

Specified by:

removeAll in interface Collection<K>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<K>

clear

public void clear()

Specified by:

clear in interface Collection<K>

getBase

public Map<K,V> getBase()

The underlining map.

getKeyFunction

public com.google.common.base.Function<V,K> getKeyFunction()

The key function should return different values for different arguments and should always return the same value when an argument is presented multiple times.