Package io.usethesource.capsule

Interface SetMultimap<K,V>

All Known Subinterfaces:

BinaryRelation<T,U>, BinaryRelation.Immutable<K,V>, BinaryRelation.Transient<K,V>, SetMultimap.Immutable<K,V>, SetMultimap.Transient<K,V>, SetMultimapEq<K,V>, SetMultimapEq.Immutable<K,V>, SetMultimapEq.Transient<K,V>

All Known Implementing Classes:

AbstractPersistentTrieSetMultimap, AbstractTransientTrieSetMultimap, AbstractTrieSetMultimap, PersistentBidirectionalTrieSetMultimap, PersistentTrieSetMultimap, PersistentTrieSetMultimap.TransientTrieSetMultimap, TransientBidirectionalTrieSetMultimap

@Experimental
public interface SetMultimap<K,V>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SetMultimap.Immutable<K,V>
static interface	SetMultimap.Transient<K,V>

Method Summary

Modifier and Type	Method	Description
boolean	containsEntry(java.lang.Object o0, java.lang.Object o1)
boolean	containsKey(java.lang.Object o)
boolean	containsValue(java.lang.Object o)
java.util.Iterator<java.util.Map.Entry<K,V>>	entryIterator()
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
boolean	equals(java.lang.Object other)	Compares the specified object for equality against this multimap.
Set.Immutable<V>	get(java.lang.Object o)
int	hashCode()	Returns the hash code for this multimap.
boolean	isEmpty()
java.util.Iterator<K>	keyIterator()
java.util.Set<K>	keySet()
default java.util.Iterator<java.util.Map.Entry<K,java.lang.Object>>	nativeEntryIterator()	Iterates over the raw internal structure.
int	size()	Return the number of key-value pairs contained in this multimap.
default int	sizeDistinct()
<T> java.util.Iterator<T>	tupleIterator(java.util.function.BiFunction<K,V,T> dataConverter)
default <T> java.util.stream.Stream<T>	tupleStream(java.util.function.BiFunction<K,V,T> dataConverter)
java.util.Iterator<V>	valueIterator()
java.util.Collection<V>	values()

Method Detail

size

int size()

Return the number of key-value pairs contained in this multimap.

Returns:

number of key-value pairs in this multimap

sizeDistinct

default int sizeDistinct()

isEmpty

boolean isEmpty()

containsKey

boolean containsKey(java.lang.Object o)

containsValue

boolean containsValue(java.lang.Object o)

containsEntry

boolean containsEntry(java.lang.Object o0,
                      java.lang.Object o1)

get

Set.Immutable<V> get(java.lang.Object o)

keySet

java.util.Set<K> keySet()

values

java.util.Collection<V> values()

entrySet

java.util.Set<java.util.Map.Entry<K,V>> entrySet()

keyIterator

java.util.Iterator<K> keyIterator()

valueIterator

java.util.Iterator<V> valueIterator()

entryIterator

java.util.Iterator<java.util.Map.Entry<K,V>> entryIterator()

nativeEntryIterator

default java.util.Iterator<java.util.Map.Entry<K,java.lang.Object>> nativeEntryIterator()
                                                                                       throws java.lang.UnsupportedOperationException

Iterates over the raw internal structure. Optional operation.

Returns:

native iterator, if supported

Throws:

java.lang.UnsupportedOperationException

tupleIterator

<T> java.util.Iterator<T> tupleIterator(java.util.function.BiFunction<K,V,T> dataConverter)

tupleStream

default <T> java.util.stream.Stream<T> tupleStream(java.util.function.BiFunction<K,V,T> dataConverter)

hashCode

int hashCode()

Returns the hash code for this multimap. The hash code is defined to equal the hash of a Set view (rather than to equal the hash code of Map).

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code for this multimap

equals

boolean equals(java.lang.Object other)

Compares the specified object for equality against this multimap. The notion of equality is equal to the Set view of a multimap, i.e., all key-value pairs have to equal.

Overrides:

equals in class java.lang.Object

Parameters:

other - the object that is checked for equality against this multimap

Returns:

true if the specified object is equal to this map