com.atlassian.bamboo.plan.cache.index.util

Class ManyToManyIndex<K,V>

java.lang.Object

com.atlassian.bamboo.plan.cache.index.util.ManyToManyIndex<K,V>

@Internal
 @ThreadSafe
public class ManyToManyIndex<K,V>
extends Object

A class that allows to index any key <-> value, many-to-many relationship. The key characteristics of this class is that, unlike Multimap, it doesn't require linear scan when removing by value. Both K and V _must_ have hashCode() and equals() correctly defined. The class is, for the most part, thread safe. Important: if accessing forward and backward mapping directly, calling code should synchronize on this object.

Constructor Summary

Constructors

Constructor and Description
ManyToManyIndex()

Method Summary

Modifier and Type	Method and Description
void	clear()
@NotNull Map<V,Set<K>>	getBackwardMapping() You need to synchronize on this object if using this method.
@NotNull Set<V>	getByKey(K key)
@NotNull Set<K>	getByValue(V value)
@NotNull Map<K,Set<V>>	getForwardMapping() You need to synchronize on this object if using this method.
void	index(K key, V value)
@Nullable Set<V>	removeByKey(K key)
@Nullable Set<K>	removeByValue(V value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ManyToManyIndex

public ManyToManyIndex()

Method Detail

index

public void index(@NotNull
                  K key,
                  @NotNull
                  V value)

getForwardMapping

@NotNull
public @NotNull Map<K,Set<V>> getForwardMapping()

You need to synchronize on this object if using this method.

getBackwardMapping

@NotNull
public @NotNull Map<V,Set<K>> getBackwardMapping()

You need to synchronize on this object if using this method.

removeByKey

@Nullable
public @Nullable Set<V> removeByKey(@NotNull
                                              K key)

removeByValue

@Nullable
public @Nullable Set<K> removeByValue(@NotNull
                                                V value)

getByKey

@NotNull
public @NotNull Set<V> getByKey(@NotNull
                                         K key)

getByValue

@NotNull
public @NotNull Set<K> getByValue(@NotNull
                                           V value)

clear

public void clear()