eu.bandm.tools.ops

Class AbstractMultimap<A,B>

java.lang.Object

java.util.AbstractCollection<Map.Entry<A,B>>

eu.bandm.tools.ops.AbstractMultimap<A,B>

All Implemented Interfaces:

Multimap<A,B>, Relation<A,B>, Serializable, Iterable<Map.Entry<A,B>>, Collection<Map.Entry<A,B>>, Set<Map.Entry<A,B>>

Direct Known Subclasses:

IndexMultimap, MapMultimap

public abstract class AbstractMultimap<A,B>
extends AbstractCollection<Map.Entry<A,B>>
implements Multimap<A,B>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractMultimap()

Method Summary

Modifier and Type	Method and Description
boolean	add(A a, B b) Adds a pair to this this multimap.
boolean	contains(A a, B b)
boolean	containsUnchecked(Object a, Object b)
Set<A>	domain() Returns the set of left components of pairs in this multimap.
Set<B>	image(A a) Returns the set of right components of pairs with a given left component in this multimap.
Set<B>	imageAll(Collection<? extends A> c)
Set<B>	imageAllUnchecked(Collection<?> c)
Map<A,Set<B>>	imageMap()
Set<B>	imageUnchecked(Object a)
Set<A>	preimage(B b) Returns the set of left components of pairs with a given right component in this multimap.
Set<A>	preimageAll(Collection<? extends B> c)
Set<A>	preimageAllUnchecked(Collection<?> c)
Map<B,Set<A>>	preimageMap()
Set<A>	preimageUnchecked(Object b)
Set<B>	range() Returns the set of right components of pairs in this multimap.
boolean	relates(A a, B b)
boolean	remove(A a, B b) Removes a pair from this this multimap.
boolean	removeAllDomain(Collection<? extends A> c)
boolean	removeAllDomainUnchecked(Collection<?> c)
boolean	removeAllRange(Collection<? extends B> c)
boolean	removeAllRangeUnchecked(Collection<?> c)
boolean	removeDomain(A a) Removes all pairs with a given left component from this multimap.
boolean	removeDomainUnchecked(Object a)
boolean	removeRange(B b) Removes all pairs with a given right component from this multimap.
boolean	removeRangeUnchecked(Object b)
boolean	removeUnchecked(Object a, Object b)
boolean	retainAllDomain(Collection<? extends A> c)
boolean	retainAllDomainUnchecked(Collection<?> c)
boolean	retainAllRange(Collection<? extends B> c)
boolean	retainAllRangeUnchecked(Collection<?> c)

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

AbstractMultimap

public AbstractMultimap()

Method Detail

relates

public boolean relates(A a,
                       B b)

Specified by:

relates in interface Relation<A,B>

add

public boolean add(A a,
                   B b)

Description copied from interface: Multimap

Adds a pair to this this multimap. This operation must be stable: adding a pair that equals any pair contained in this multimap componentwise must not change this multimap.

Specified by:

add in interface Multimap<A,B>

Parameters:

a - the left component of the pair to add.

b - the right component of the pair to add.

Returns:

true if this multimap has been changed by this operation, false otherwise.

remove

public boolean remove(A a,
                      B b)

Description copied from interface: Multimap

Removes a pair from this this multimap. Removing a pair that equals no pair contained in this multimap componentwise must not change this multimap.

Specified by:

remove in interface Multimap<A,B>

Parameters:

a - the left component of the pair to remove.

b - the right component of the pair to remove.

Returns:

true if this multimap has been changed by this operation, false otherwise.

removeUnchecked

public boolean removeUnchecked(Object a,
                               Object b)

Specified by:

removeUnchecked in interface Multimap<A,B>

contains

public boolean contains(A a,
                        B b)

Specified by:

contains in interface Multimap<A,B>

containsUnchecked

public boolean containsUnchecked(Object a,
                                 Object b)

Specified by:

containsUnchecked in interface Multimap<A,B>

domain

public Set<A> domain()

Description copied from interface: Multimap

Returns the set of left components of pairs in this multimap.

The returned set is backed by this multimap, such that changes to this multimap are reflected by the set. The behavior of modifications of this multimap concurrent to iteration of the set is unspecified.

If this multimap supports the removeDomain operation, then the returned set and its iterators must support the remove operation, and changes by these operations must be reflected by this multimap.

Specified by:

domain in interface Multimap<A,B>

Returns:

the set of left components of pairs in this multimap.

range

public Set<B> range()

Description copied from interface: Multimap

Returns the set of right components of pairs in this multimap.

If this multimap supports the removeRange operation, then the returned set and its iterators must support the remove operation.

Specified by:

range in interface Multimap<A,B>

Returns:

the set of right components of pairs in this multimap.

removeDomain

public boolean removeDomain(A a)

Description copied from interface: Multimap

Removes all pairs with a given left component from this multimap. The effect of the implementation on this multimap must be equivalent to the following code:

 removeDomain(final A a) {
   for (B b : new HashSet<B>(range())) remove(a, b) ;
 }
 

Specified by:

removeDomain in interface Multimap<A,B>

Parameters:

a - the left component of all pairs to remove.

Returns:

true if this multimap has been changed by this operation, false otherwise.

removeDomainUnchecked

public boolean removeDomainUnchecked(Object a)

removeRange

public boolean removeRange(B b)

Description copied from interface: Multimap

Removes all pairs with a given right component from this multimap. The effect of the implementation on this multimap must be equivalent to the following code:

 removeRange(final B b) {
   for (A a : new HashSet<A>(domain())) remove(a, b) ;
 }
 

Specified by:

removeRange in interface Multimap<A,B>

Parameters:

b - the right component of all pairs to remove.

Returns:

true if this multimap has been changed by this operation, false otherwise.

removeRangeUnchecked

public boolean removeRangeUnchecked(Object b)

removeAllDomain

public boolean removeAllDomain(Collection<? extends A> c)

Specified by:

removeAllDomain in interface Multimap<A,B>

removeAllDomainUnchecked

public boolean removeAllDomainUnchecked(Collection<?> c)

Specified by:

removeAllDomainUnchecked in interface Multimap<A,B>

retainAllDomain

public boolean retainAllDomain(Collection<? extends A> c)

Specified by:

retainAllDomain in interface Multimap<A,B>

retainAllDomainUnchecked

public boolean retainAllDomainUnchecked(Collection<?> c)

Specified by:

retainAllDomainUnchecked in interface Multimap<A,B>

removeAllRange

public boolean removeAllRange(Collection<? extends B> c)

Specified by:

removeAllRange in interface Multimap<A,B>

removeAllRangeUnchecked

public boolean removeAllRangeUnchecked(Collection<?> c)

Specified by:

removeAllRangeUnchecked in interface Multimap<A,B>

retainAllRange

public boolean retainAllRange(Collection<? extends B> c)

Specified by:

retainAllRange in interface Multimap<A,B>

retainAllRangeUnchecked

public boolean retainAllRangeUnchecked(Collection<?> c)

Specified by:

retainAllRangeUnchecked in interface Multimap<A,B>

image

public Set<B> image(A a)

Description copied from interface: Multimap

Returns the set of right components of pairs with a given left component in this multimap.

The returned set need not be modifiable. The behaviour of this multimap after successfully modifying the returned set is unspecified.

Specified by:

image in interface Multimap<A,B>

Parameters:

a - a left component.

Returns:

the set of right components of pairs with a left component that equals(a) in this multimap.

imageUnchecked

public Set<B> imageUnchecked(Object a)

Specified by:

imageUnchecked in interface Multimap<A,B>

imageAll

public Set<B> imageAll(Collection<? extends A> c)

Specified by:

imageAll in interface Multimap<A,B>

imageAllUnchecked

public Set<B> imageAllUnchecked(Collection<?> c)

Specified by:

imageAllUnchecked in interface Multimap<A,B>

imageMap

public Map<A,Set<B>> imageMap()

Specified by:

imageMap in interface Multimap<A,B>

preimage

public Set<A> preimage(B b)

Description copied from interface: Multimap

Returns the set of left components of pairs with a given right component in this multimap.

The returned set need not be modifiable. The behaviour of this multimap after successfully modifying the returned set is unspecified.

Specified by:

preimage in interface Multimap<A,B>

Parameters:

b - a right component.

Returns:

the set of left components of pairs with a right component that equals(b) in this multimap.

preimageUnchecked

public Set<A> preimageUnchecked(Object b)

Specified by:

preimageUnchecked in interface Multimap<A,B>

preimageAll

public Set<A> preimageAll(Collection<? extends B> c)

Specified by:

preimageAll in interface Multimap<A,B>

preimageAllUnchecked

public Set<A> preimageAllUnchecked(Collection<?> c)

Specified by:

preimageAllUnchecked in interface Multimap<A,B>

preimageMap

public Map<B,Set<A>> preimageMap()

Specified by:

preimageMap in interface Multimap<A,B>