namespace BiMultiMap
A type-invariant immutable bi-directional MultiMap where keys and values have a many-to-many mapping. See the BiMultiMap documentation and the BiMultiMap API documentation
Companion interface: BiMultiMap<K,V>
Interfaces
| Name | Description |
|---|---|
BiMultiMap.Builder<K,V> | A mutable BiMultiMap builder used to efficiently create new immutable instances. See the BiMultiMap documentation and the BiMultiMap.Builder API documentation |
BiMultiMap.Context<UK,UV> | The BiMultiMap's Context instance that serves as a factory for all related immutable instances and builders. |
BiMultiMap.NonEmpty<K,V> | A non-empty type-invariant immutable bi-directional MultiMap where keys and values have a many-to-many mapping. See the BiMultiMap documentation and the BiMultiMap API documentation |
BiMultiMap.Types | Utility interface that provides higher-kinded types for this collection. |
Static Methods
createContext
Returns a new BiMultiMap context instance based on the given options.
createContextoptions.Definition
createContext<UK, UV>(options: {
keyValueMultiMapContext: MultiMap.Context<UK, UV>;
valueKeyMultiMapContext: MultiMap.Context<UV, UK>;
}): BiMultiMap.Context<UK, UV>;
Type parameters
| Name | Description |
|---|---|
| UK | the upper key type for which the context can create instances |
| UV | the upper value type for which the context can create instances |
Parameters
| Name | Type | Description |
|---|---|---|
options | {keyValueMultiMapContext: MultiMap.Context<UK, UV>;valueKeyMultiMapContext: MultiMap.Context<UV, UK>;} | an object containing the following properties: - keyValueMultiMapContext: the map context to use for key value multimaps - valueKeyMultiMapContext: the set context to use for value key multimaps |