Package com.polarion.alm.shared.api.utils.collections

Class ImmutableStrictMap<K,V>

java.lang.Object

com.polarion.alm.shared.api.utils.collections.ImmutableStrictMap<K,V>

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, ReadOnlyStrictMap<K,V>, Serializable

public final class ImmutableStrictMap<K,V>
extends Object
implements ReadOnlyStrictMap<K,V>, com.google.gwt.user.client.rpc.IsSerializable, Serializable

Map backed by LinkedHashMap. "Strict" means that it does not allow null keys, and that all methods use generics unlike for example Map.containsKey(Object)

Since:

3.9.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static ImmutableStrictMap	EMPTY

Constructor Summary

Constructors

Constructor	Description
ImmutableStrictMap()
ImmutableStrictMap(StrictMap<K,V> map)
ImmutableStrictMap(Map<K,V> map)
ImmutableStrictMap(K key, V value)
ImmutableStrictMap(K key1, V value1, K key2, V value2)
ImmutableStrictMap(K key1, V value1, K key2, V value2, K key3, V value3)
ImmutableStrictMap(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4)
ImmutableStrictMap(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4, K key5, V value5)

Method Summary

Modifier and Type	Method	Description
Map<K,V>	asMap()	Returns the adapter to Map interface for use with 3rd party code or standard Java libraries.
boolean	containsKey(K key)
boolean	containsValue(V value)
Set<Map.Entry<K,V>>	entrySet()
K	findKeyForValueIfSame(V value)	Finds first key for the given value found by iterating over the ReadOnlyStrictMap.entrySet(), the value must be the same instance as the one contained in the map, so the equals() is NOT called by this method on the values.
V	get(K key)
boolean	isEmpty()
Set<K>	keySet()
void	putAllTo(Map<? super K,? super V> m)
int	size()
ImmutableStrictMap<K,V>	toImmutable()	Returns the same instance if the original map is already immutable, otherwise returns new instance containing the same mappings.
Map<K,V>	toMap()	Returns new map containing the same mappings, so modifying the returned map does not modify the original map.
String	toString()
Collection<V>	values()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

EMPTY

public static ImmutableStrictMap EMPTY

Constructor Details

ImmutableStrictMap

public ImmutableStrictMap()

ImmutableStrictMap

public ImmutableStrictMap(@NotNull
 Map<K,V> map)

ImmutableStrictMap

public ImmutableStrictMap(@NotNull
 StrictMap<K,V> map)

ImmutableStrictMap

public ImmutableStrictMap(@NotNull
 K key,
 @Nullable
 V value)

ImmutableStrictMap

public ImmutableStrictMap(@NotNull
 K key1,
 @Nullable
 V value1,
 @NotNull
 K key2,
 @Nullable
 V value2)

ImmutableStrictMap

public ImmutableStrictMap(@NotNull
 K key1,
 @Nullable
 V value1,
 @NotNull
 K key2,
 @Nullable
 V value2,
 @NotNull
 K key3,
 @Nullable
 V value3)

ImmutableStrictMap

public ImmutableStrictMap(@NotNull
 K key1,
 @Nullable
 V value1,
 @NotNull
 K key2,
 @Nullable
 V value2,
 @NotNull
 K key3,
 @Nullable
 V value3,
 @NotNull
 K key4,
 @Nullable
 V value4)

ImmutableStrictMap

public ImmutableStrictMap(@NotNull
 K key1,
 @Nullable
 V value1,
 @NotNull
 K key2,
 @Nullable
 V value2,
 @NotNull
 K key3,
 @Nullable
 V value3,
 @NotNull
 K key4,
 @Nullable
 V value4,
 @NotNull
 K key5,
 @Nullable
 V value5)

Method Details

size

public int size()

Specified by:

size in interface ReadOnlyStrictMap<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ReadOnlyStrictMap<K,V>

containsKey

public boolean containsKey(@NotNull
 K key)

Specified by:

containsKey in interface ReadOnlyStrictMap<K,V>

containsValue

public boolean containsValue(@Nullable
 V value)

Specified by:

containsValue in interface ReadOnlyStrictMap<K,V>

get

@Nullable
public V get(@NotNull
 K key)

Specified by:

get in interface ReadOnlyStrictMap<K,V>

findKeyForValueIfSame

@Nullable
public K findKeyForValueIfSame(@NotNull
 V value)

Description copied from interface: ReadOnlyStrictMap

Finds first key for the given value found by iterating over the ReadOnlyStrictMap.entrySet(), the value must be the same instance as the one contained in the map, so the equals() is NOT called by this method on the values.

Specified by:

findKeyForValueIfSame in interface ReadOnlyStrictMap<K,V>

Parameters:

value - - value to be found, it is found only if it is the same instance.

Returns:

key associated with this value if it was found

putAllTo

public void putAllTo(@NotNull
 Map<? super K,? super V> m)

Specified by:

putAllTo in interface ReadOnlyStrictMap<K,V>

keySet

@NotNull
public Set<K> keySet()

Specified by:

keySet in interface ReadOnlyStrictMap<K,V>

values

@NotNull
public Collection<V> values()

Specified by:

values in interface ReadOnlyStrictMap<K,V>

entrySet

@NotNull
public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface ReadOnlyStrictMap<K,V>

toString

public String toString()

Overrides:

toString in class Object

toMap

@NotNull
public Map<K,V> toMap()

Description copied from interface: ReadOnlyStrictMap

Returns new map containing the same mappings, so modifying the returned map does not modify the original map.

Specified by:

toMap in interface ReadOnlyStrictMap<K,V>

asMap

@NotNull
public Map<K,V> asMap()

Description copied from interface: ReadOnlyStrictMap

Returns the adapter to Map interface for use with 3rd party code or standard Java libraries. Unlike the ReadOnlyStrictMap.toMap() which returns new map containing the same elements, this method returns live "view" of this map instance meaning that changes done to the returned instance are reflected also in the original map. Unless the original map is immutable, in which case all methods modifying the content throw UnsupportedOperationException The returned map is Serializable

Specified by:

asMap in interface ReadOnlyStrictMap<K,V>

toImmutable

@NotNull
public ImmutableStrictMap<K,V> toImmutable()

Description copied from interface: ReadOnlyStrictMap

Returns the same instance if the original map is already immutable, otherwise returns new instance containing the same mappings.

Specified by:

toImmutable in interface ReadOnlyStrictMap<K,V>