net.digitalid.utility.collections.map

Class FreezableLinkedHashMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<K,V>

net.digitalid.utility.collections.map.FreezableLinkedHashMap<K,V>

All Implemented Interfaces:

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

@GenerateBuilder
 @GenerateSubclass
 @Freezable(value=ReadOnlyMap.class)
public abstract class FreezableLinkedHashMap<K,V>
extends LinkedHashMap<K,V>
implements FreezableMap<K,V>

This class extends the LinkedHashMap and makes it freezable. It is recommended to use only Immutable types for the keys and ReadOnly or Immutable types for the values.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FreezableLinkedHashMap(@NonNegative int initialCapacity, @Positive float loadFactor, boolean accessOrder)
protected	FreezableLinkedHashMap(@Nonnull Map<? extends K,? extends V> map)

Method Summary

Modifier and Type	Method and Description
void	clear()
@Nonnull @NonFrozen FreezableLinkedHashMap<K,V>	clone()
@Nonnull net.digitalid.utility.immutable.entry.ReadOnlyEntrySet<K,V>	entrySet()
@Nonnull @Frozen ReadOnlyMap<K,V>	freeze()
boolean	isEmpty()
boolean	isFrozen()
@Nonnull @NullableElements FreezableSet<K>	keySet()
V	put(K key, V value)
void	putAll(@Nonnull Map<? extends K,? extends V> map)
V	remove(@Nullable Object object)
@Nonnull String	toString()
@Nonnull @NullableElements FreezableCollection<V>	values()
static <K,V> @NonFrozen FreezableLinkedHashMap<K,V>	withMappingsOf(FreezableMap<? extends K,? extends V> map) Returns a new freezable linked hash map with the mappings of the given map or null if the given map is null.
static <K,V> @NonFrozen FreezableLinkedHashMap<K,V>	withMappingsOf(Map<? extends K,? extends V> map) Returns a new freezable linked hash map with the mappings of the given map or null if the given map is null.
static <K,V> @NonFrozen FreezableLinkedHashMap<K,V>	withMappingsOf(ReadOnlyMap<? extends K,? extends V> map) Returns a new freezable linked hash map with the mappings of the given map or null if the given map is null.

Methods inherited from class java.util.LinkedHashMap

containsValue, forEach, get, getOrDefault, removeEldestEntry, replaceAll

Methods inherited from class java.util.HashMap

compute, computeIfAbsent, computeIfPresent, containsKey, merge, putIfAbsent, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

putAll, putIfAbsentOrNullElseReturnPresent, removeAll, removeAll, removeAll, removeAll

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

containsKey, containsValue, get

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

isEmptyOrSingle, isSingle, size

Methods inherited from interface java.util.Map

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

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

equals, hashCode

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

castTo

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

validate

Constructor Detail

FreezableLinkedHashMap

@Recover
protected FreezableLinkedHashMap(@NonNegative @Default(value="16")
                                          @NonNegative int initialCapacity,
                                          @Positive @Default(value="0.75f")
                                          @Positive float loadFactor,
                                          @Default(value="false")
                                          boolean accessOrder)

FreezableLinkedHashMap

protected FreezableLinkedHashMap(@NonCaptured @Unmodified @Nonnull
                                 @Nonnull Map<? extends K,? extends V> map)

Method Detail

isEmpty

@Pure
 @TODO(task="For some reasons, the SubclassGenerator treats this method as abstract and generates a required field for it if this method is removed.",
      date="2016-04-29",
      author=KASPAR_ETTER,
      assignee=STEPHANIE_STROKA,
      priority=HIGH)
public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

Specified by:

isEmpty in interface FreezableMap<K,V>

Specified by:

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

Overrides:

isEmpty in class HashMap<K,V>

withMappingsOf

@Pure
 @Capturable
 @NonFrozen
public static <K,V> @NonFrozen FreezableLinkedHashMap<K,V> withMappingsOf(ReadOnlyMap<? extends K,? extends V> map)

Returns a new freezable linked hash map with the mappings of the given map or null if the given map is null.

withMappingsOf

@Pure
 @Capturable
 @NonFrozen
public static <K,V> @NonFrozen FreezableLinkedHashMap<K,V> withMappingsOf(@NonCaptured @Unmodified
                                                                                                         Map<? extends K,? extends V> map)

Returns a new freezable linked hash map with the mappings of the given map or null if the given map is null.

withMappingsOf

@Pure
 @Capturable
 @NonFrozen
public static <K,V> @NonFrozen FreezableLinkedHashMap<K,V> withMappingsOf(@NonCaptured @Unmodified
                                                                                                         FreezableMap<? extends K,? extends V> map)

Returns a new freezable linked hash map with the mappings of the given map or null if the given map is null.

isFrozen

@Pure
public boolean isFrozen()

Specified by:

isFrozen in interface net.digitalid.utility.freezable.ReadOnlyInterface

freeze

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

Specified by:

freeze in interface FreezableMap<K,V>

Specified by:

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

clone

@Pure
 @Capturable
 @Nonnull
 @NonFrozen
public @Nonnull @NonFrozen FreezableLinkedHashMap<K,V> clone()

Specified by:

clone in interface ReadOnlyMap<K,V>

Specified by:

clone in interface net.digitalid.utility.freezable.ReadOnlyInterface

Overrides:

clone in class HashMap<K,V>

keySet

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

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface FreezableMap<K,V>

Specified by:

keySet in interface ReadOnlyMap<K,V>

Overrides:

keySet in class LinkedHashMap<K,V>

See Also:

Map.keySet()

values

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

Specified by:

values in interface Map<K,V>

Specified by:

values in interface FreezableMap<K,V>

Specified by:

values in interface ReadOnlyMap<K,V>

Overrides:

values in class LinkedHashMap<K,V>

See Also:

Map.values()

entrySet

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

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface FreezableMap<K,V>

Specified by:

entrySet in interface ReadOnlyMap<K,V>

Overrides:

entrySet in class LinkedHashMap<K,V>

See Also:

Map.entrySet()

put

@Impure
 @NonFrozenRecipient
 @Capturable
 @Nullable
public V put(@Captured
                                                                  K key,
                                                                  @Captured
                                                                  V value)

Specified by:

put in interface Map<K,V>

Overrides:

put in class HashMap<K,V>

putAll

@Impure
 @NonFrozenRecipient
public void putAll(@NonCaptured @Unmodified @Nonnull
                                                @Nonnull Map<? extends K,? extends V> map)

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class HashMap<K,V>

remove

@Impure
 @NonFrozenRecipient
 @Capturable
 @Nullable
public V remove(@NonCaptured @Unmodified @Nullable
                                                                     @Nullable Object object)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class HashMap<K,V>

clear

@Impure
 @NonFrozenRecipient
public void clear()

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class LinkedHashMap<K,V>

toString

@Pure
 @Nonnull
public @Nonnull String toString()

Specified by:

toString in interface net.digitalid.utility.rootclass.RootInterface

Overrides:

toString in class AbstractMap<K,V>