net.digitalid.utility.collections.map

Interface FreezableMap<K,V>

All Superinterfaces:

net.digitalid.utility.casting.Castable, Cloneable, net.digitalid.utility.interfaces.Countable, net.digitalid.utility.freezable.FreezableInterface, Map<K,V>, net.digitalid.utility.freezable.ReadOnlyInterface, ReadOnlyMap<K,V>, net.digitalid.utility.rootclass.RootInterface, net.digitalid.utility.validation.validatable.Validatable

All Known Implementing Classes:

FreezableHashMap, FreezableLinkedHashMap

@Freezable(value=ReadOnlyMap.class)
public interface FreezableMap<K,V>
extends ReadOnlyMap<K,V>, Map<K,V>, net.digitalid.utility.freezable.FreezableInterface

This interface models a map that can be frozen. Please note that the method Map.entrySet() is only supported in a read-only mode. It is recommended to use only Immutable types for the keys and ReadOnly or Immutable types for the values.

See Also:

FreezableHashMap, FreezableLinkedHashMap

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
@Nonnull net.digitalid.utility.immutable.entry.ReadOnlyEntrySet<K,V>	entrySet()
@Nonnull @Frozen ReadOnlyMap<K,V>	freeze()
boolean	isEmpty()
@Nonnull FreezableSet<K>	keySet()
default void	putAll(@Nonnull ReadOnlyMap<? extends K,? extends V> map) Adds the entries of the given map to this map.
default V	putIfAbsentOrNullElseReturnPresent(K key, V value) Associates the given value with the given key, if the given key is not already associated with a value or null.
default void	removeAll(@Nonnull Collection<?> keys) Removes the given keys from this map.
default void	removeAll(@Nonnull net.digitalid.utility.functional.iterables.FiniteIterable<?> keys) Removes the given keys from this map.
default void	removeAll(@Nonnull FreezableCollection<?> keys) Removes the given keys from this map.
default void	removeAll(@Nonnull ReadOnlyMap<? extends K,? extends V> map) Removes the keys of the given map from this map.
@Nonnull FreezableCollection<V>	values()

Methods inherited from interface net.digitalid.utility.collections.map.ReadOnlyMap

clone, containsKey, containsValue, get

Methods inherited from interface net.digitalid.utility.interfaces.Countable

isEmptyOrSingle, isSingle, size

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

Methods inherited from interface net.digitalid.utility.freezable.ReadOnlyInterface

isFrozen

Methods inherited from interface net.digitalid.utility.rootclass.RootInterface

equals, hashCode, toString

Methods inherited from interface net.digitalid.utility.casting.Castable

castTo

Methods inherited from interface net.digitalid.utility.validation.validatable.Validatable

validate

Method Detail

isEmpty

@Pure
boolean isEmpty()

Specified by:

isEmpty in interface net.digitalid.utility.interfaces.Countable

Specified by:

isEmpty in interface Map<K,V>

freeze

@Impure
 @NonFrozenRecipient
 @Chainable
 @Nonnull
 @Frozen
@Nonnull @Frozen ReadOnlyMap<K,V> freeze()

Specified by:

freeze in interface net.digitalid.utility.freezable.FreezableInterface

keySet

@Pure
 @NonCapturable
 @Nonnull
@Nonnull FreezableSet<K> keySet()

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface ReadOnlyMap<K,V>

See Also:

Map.keySet()

values

@Pure
 @NonCapturable
 @Nonnull
@Nonnull FreezableCollection<V> values()

Specified by:

values in interface Map<K,V>

Specified by:

values in interface ReadOnlyMap<K,V>

See Also:

Map.values()

entrySet

@Pure
 @NonCapturable
 @Nonnull
@Nonnull net.digitalid.utility.immutable.entry.ReadOnlyEntrySet<K,V> entrySet()

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface ReadOnlyMap<K,V>

See Also:

Map.entrySet()

putAll

@Impure
 @NonFrozenRecipient
default void putAll(@Nonnull
                                                 @Nonnull ReadOnlyMap<? extends K,? extends V> map)

Adds the entries of the given map to this map.

removeAll

@Impure
 @NonFrozenRecipient
default void removeAll(@Nonnull
                                                    @Nonnull net.digitalid.utility.functional.iterables.FiniteIterable<?> keys)

Removes the given keys from this map.

removeAll

@Impure
 @NonFrozenRecipient
default void removeAll(@NonCaptured @Unmodified @Nonnull
                                                    @Nonnull Collection<?> keys)

Removes the given keys from this map.

removeAll

@Impure
 @NonFrozenRecipient
default void removeAll(@NonCaptured @Unmodified @Nonnull
                                                    @Nonnull FreezableCollection<?> keys)

Removes the given keys from this map.

removeAll

@Impure
 @NonFrozenRecipient
default void removeAll(@Nonnull
                                                    @Nonnull ReadOnlyMap<? extends K,? extends V> map)

Removes the keys of the given map from this map.

putIfAbsentOrNullElseReturnPresent

@Impure
 @NonFrozenRecipient
 @NonCapturable
 @Nonnull
default V putIfAbsentOrNullElseReturnPresent(@Captured
                                                                                                    K key,
                                                                                                    @Captured @Nonnull
                                                                                                    V value)

Associates the given value with the given key, if the given key is not already associated with a value or null.

Returns:

the value that is now associated with the given key.