cz.gyarab.util.collection

Class BidirectionalMap<K,V>

java.lang.Object

cz.gyarab.util.collection.BidirectionalMap<K,V>

Type Parameters:

K - typ klíče mapy

V - typ hodnoty mapy

public class BidirectionalMap<K,V>
extends java.lang.Object

Obousměrná mapa pracuje na principu rychlé vazby z klíče na hodnotu (obyčejná mapa) i z hodnoty na klíč (obyčejné mapy takovou vazbu vždy hledají) a je bezpečné jí použít ve vícevláknovém prostředí (je thread-safe). Zatímco pro rozlišení klíčů tato mapa používá porovnání hash/equals (viz též HashMap), pro porovnání hodnot je to hash/== (viz IdentityHashMap). Tato mapa podporuje i iterátory klíčů a hodnot a také jejich read-only kolekce. Klíč ani hodnota však nesmějí být null.

Since:

1.4

Constructor Summary

Constructors

Constructor and Description
BidirectionalMap()

Method Summary

Modifier and Type	Method and Description
V	ensure(K key, java.util.function.Supplier<V> value) Zajistí přítomnost vztahu určeného poskytnutým klíčem.
K	getKey(V value) Hledá klíč k hodnotě.
V	getValue(K key) Hledá hodnotu ke klíči.
java.util.Collection<K>	keys() Poskytne neměnitelnou kolekci klíčů.
void	put(K key, V value) Vloží do kolekce vztah klíč->hodnota.
void	removeKey(K key) Odstraní klíč a připojenou hodnotu z kolekce.
void	removeValue(V value) Odstraní hodnotu a připojeným klíčem z kolekce.
java.util.Collection<V>	values() Poskytne neměnitelnou kolekci hodnot.

Methods inherited from class java.lang.Object

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

Constructor Detail

BidirectionalMap

public BidirectionalMap()

Method Detail

put

public void put(K key,
                V value)

Vloží do kolekce vztah klíč->hodnota.

Pokud v kolekci už takový klíč byl (čili existuje takové K k, pro které je pravdivý výraz k.equals(key)), je předchozí vztah z kolekce odstraněn (včetně zpětné vazby hodnota->klíč).

Podobně, pokud existuje taková hodnota (tedy {code V v}, pro které je pravdivý výraz v == value) je i tento předchozí vztah odstraněn (včetně příslušného klíče).

To je důležitý rozdíl mezi touto a jinými mapami. Přidáním vztahu se obvykle buď zachová počet záznamů v mapě (protože klíč už existoval) nebo zvýší o (tento) jeden vztah. V této mapě však může dojít i ke snížení počtu, to kdyby i klíč i hodnota v kolekci již existovaly a nebyly spojeny mezi sebou (v takovém případě se odstraní dva staré vztahy a jeden nový vloží).

Parameters:

key - klíč vkládaného vztahu (duplicita je vyloučena pomocí objektové ekvivalence)

value - hodnota vkládaného vztahu (duplicita je vyloučena pomocí referenční ekvivalence)

ensure

public V ensure(K key,
                java.util.function.Supplier<V> value)

Zajistí přítomnost vztahu určeného poskytnutým klíčem. Pokud dosud žádný vztah v kolekci nebyl, vytvoří se. Jen v takovém případě je aktivován dodavatel.

Parameters:

key - klíč vztahu

value - dodavatel hodnoty v případě, že klíč dosud nebyl nalezen

Returns:

původní (a stávající) hodnotu vztaženou ke klíči, nebo nově přidanou, pokud dosud v kolekci chyběla

getValue

public V getValue(K key)

Hledá hodnotu ke klíči. Pokud pro klíč neexistuje žádný vztah, vrací null.

Parameters:

key - klíč, pro nějž se hledá hodnota

Returns:

null, pokud nebyl klíč nalezen, nebo příslušnou hodnotu

getKey

public K getKey(V value)

Hledá klíč k hodnotě. Pokud pro hodnotu neexistuje žádný vztah, vrací null.

Parameters:

value - hodnota, pro níž se hledá klíč

Returns:

null, pokud nebyla hodnota nalezena, nebo příslušný klíč

removeKey

public void removeKey(K key)

Odstraní klíč a připojenou hodnotu z kolekce. Pokud takový vztah neexistuje, kolekce se nezmění.

Parameters:

key - klíč z odstraňovaného vztahu

removeValue

public void removeValue(V value)

Odstraní hodnotu a připojeným klíčem z kolekce. Pokud takový vztah neexistuje, kolekce se nezmění.

Parameters:

value - hodnota z odstraňovaného vztahu

keys

public java.util.Collection<K> keys()

Poskytne neměnitelnou kolekci klíčů. Ani případný iterátor nepovolí změnu.

Returns:

neměnnou kolekci klíčů

values

public java.util.Collection<V> values()

Poskytne neměnitelnou kolekci hodnot. Ani případný iterátor nepovolí změnu.

Returns:

neměnnou kolekci hodnot