net.digitalid.utility.collections.map

Interface ReadOnlyMap<K,V>

All Superinterfaces:

net.digitalid.utility.casting.Castable, Cloneable, net.digitalid.utility.interfaces.Countable, net.digitalid.utility.freezable.ReadOnlyInterface, net.digitalid.utility.rootclass.RootInterface, net.digitalid.utility.validation.validatable.Validatable

All Known Subinterfaces:

FreezableMap<K,V>

All Known Implementing Classes:

FreezableHashMap, FreezableLinkedHashMap

@ReadOnly(value=FreezableMap.class)
public interface ReadOnlyMap<K,V>
extends net.digitalid.utility.freezable.ReadOnlyInterface, net.digitalid.utility.interfaces.Countable

This interface provides read-only access to maps and should never be cast away (unless external code requires it). It is recommended to use only ReadOnly or Immutable types for the elements.

Method Summary

Modifier and Type	Method and Description
@Nonnull @NonFrozen FreezableMap<K,V>	clone()
boolean	containsKey(@Nullable Object key)
boolean	containsValue(@Nullable Object value)
@Nonnull net.digitalid.utility.immutable.entry.ReadOnlyEntrySet<K,V>	entrySet()
V	get(@Nullable Object key)
@Nonnull ReadOnlySet<K>	keySet()
@Nonnull ReadOnlyCollection<V>	values()

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

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

isEmpty, isEmptyOrSingle, isSingle, size

Method Detail

containsKey

@Pure
boolean containsKey(@NonCaptured @Unmodified @Nullable
                          @Nullable Object key)

See Also:

Map.containsKey(java.lang.Object)

containsValue

@Pure
boolean containsValue(@NonCaptured @Unmodified @Nullable
                            @Nullable Object value)

See Also:

Map.containsValue(java.lang.Object)

get

@Pure
 @NonCapturable
 @Nullable
V get(@NonCaptured @Unmodified @Nullable
                                       @Nullable Object key)

See Also:

Map.get(java.lang.Object)

keySet

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

See Also:

Map.keySet()

values

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

See Also:

Map.values()

entrySet

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

See Also:

Map.entrySet()

clone

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

Specified by:

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