Module org.jhotdraw8.icollection

Package org.jhotdraw8.icollection.facade

Class ReadOnlyMapFacade<K,V>

java.lang.Object

org.jhotdraw8.icollection.facade.ReadOnlyMapFacade<K,V>

Type Parameters:

K - the key type

V - the value type

All Implemented Interfaces:

Iterable<Map.Entry<K,V>>, ReadOnlyMap<K,V>

Direct Known Subclasses:

ReadOnlyNavigableMapFacade, ReadOnlySequencedMapFacade, ReadOnlySortedMapFacade

public class ReadOnlyMapFacade<K,V>
extends Object
implements ReadOnlyMap<K,V>

Provides a ReadOnlyMap facade to a set of ReadOnlyMap functions.

Author:

Werner Randelshofer

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NonNull Predicate<Object>	containsKeyFunction
protected final @NonNull Function<K,V>	getFunction
protected final @NonNull Supplier<Iterator<Map.Entry<K,V>>>	iteratorFunction
protected final @NonNull IntSupplier	sizeFunction

Constructor Summary

Constructors

Constructor	Description
ReadOnlyMapFacade(@NonNull Map<K,V> m)
ReadOnlyMapFacade(@NonNull Supplier<Iterator<Map.Entry<K,V>>> iteratorFunction, @NonNull IntSupplier sizeFunction, @NonNull Predicate<Object> containsKeyFunction, @NonNull Function<K,V> getFunction)
ReadOnlyMapFacade(@NonNull ReadOnlyMap<K,V> m)

Method Summary

Modifier and Type	Method	Description
boolean	containsEntry(@Nullable Object o)	Returns true if this map contains the specified entry.
boolean	containsKey(Object key)	Returns true if this map contains a entry for the specified key.
@Nullable V	get(Object key)	Returns the value to which the key is mapped, or null if this map contains no entry for the key.
boolean	isEmpty()	Returns true if this map contains no entries.
@NonNull Iterator<Map.Entry<K,V>>	iterator()	Returns an iterator over the entries contained in this map.
int	size()	Returns the number of entries contained in this map..

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.jhotdraw8.icollection.readonly.ReadOnlyMap

asMap, characteristics, containsValue, equals, getOrDefault, hashCode, readOnlyEntrySet, readOnlyKeySet, readOnlyValues, spliterator

Field Details

iteratorFunction

protected final @NonNull Supplier<Iterator<Map.Entry<K,V>>> iteratorFunction

sizeFunction

protected final @NonNull IntSupplier sizeFunction

containsKeyFunction

protected final @NonNull Predicate<Object> containsKeyFunction

getFunction

protected final @NonNull Function<K,V> getFunction

Constructor Details

ReadOnlyMapFacade

public ReadOnlyMapFacade(@NonNull ReadOnlyMap<K,V> m)

ReadOnlyMapFacade

public ReadOnlyMapFacade(@NonNull Map<K,V> m)

ReadOnlyMapFacade

public ReadOnlyMapFacade(@NonNull Supplier<Iterator<Map.Entry<K,V>>> iteratorFunction,
 @NonNull IntSupplier sizeFunction,
 @NonNull Predicate<Object> containsKeyFunction,
 @NonNull Function<K,V> getFunction)

Method Details

get

public @Nullable V get(Object key)

Description copied from interface: ReadOnlyMap

Returns the value to which the key is mapped, or null if this map contains no entry for the key.

Specified by:

get in interface ReadOnlyMap<K,V>

Parameters:

key - a key

Returns:

the mapped value or null

containsKey

public boolean containsKey(Object key)

Description copied from interface: ReadOnlyMap

Returns true if this map contains a entry for the specified key.

Specified by:

containsKey in interface ReadOnlyMap<K,V>

Parameters:

key - a key

Returns:

true if this map contains a entry for the specified key

isEmpty

public boolean isEmpty()

Description copied from interface: ReadOnlyMap

Returns true if this map contains no entries.

Specified by:

isEmpty in interface ReadOnlyMap<K,V>

Returns:

true if empty

iterator

public @NonNull Iterator<Map.Entry<K,V>> iterator()

Description copied from interface: ReadOnlyMap

Returns an iterator over the entries contained in this map.

Specified by:

iterator in interface Iterable<K>

Specified by:

iterator in interface ReadOnlyMap<K,V>

Returns:

an iterator

size

public int size()

Description copied from interface: ReadOnlyMap

Returns the number of entries contained in this map..

Specified by:

size in interface ReadOnlyMap<K,V>

Returns:

the number of entries

containsEntry

public boolean containsEntry(@Nullable Object o)

Description copied from interface: ReadOnlyMap

Returns true if this map contains the specified entry.

Specified by:

containsEntry in interface ReadOnlyMap<K,V>

Parameters:

o - an entry (should be a Map.Entry).

Returns:

true if this map contains the entry