flexmark-all 0.64.8 · com.vladsch.flexmark.experimental.util.collection.KeyedItemFactoryMap

Modifier and Type	Field and Description
protected final @NotNull HashMap<K, Function<P, I>>	factoryMap
protected final @NotNull HashMap<K, I>	itemMap
protected final P	param

Access	Constructor and Description
public	KeyedItemFactoryMap(P param)
public	KeyedItemFactoryMap(P param, int capacity)

Method Summary

Modifier and Type	Method and Description
public void	clear() Implements java.util.Map.clear. Removes all of the mappings from this map (optional operation).
public boolean	containsKey(@Nullable Object key whose presence in this map is to be tested o) Implements java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key.
public boolean	containsValue(Object value whose presence in this map is to be tested o) Implements java.util.Map.containsValue. Returns `true` if this map maps one or more keys to the specified value.
public @NotNull Set<Map.Entry<K, Function<P, I>>>	entrySet() Implements java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map.
public @Nullable Function<P, I>	get(@Nullable Object the key whose associated value is to be returned o) Implements java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
public I	getItem(K key)
public boolean	isEmpty() Implements java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings.
public @NotNull Set<K>	keySet() Implements java.util.Map.keySet. Returns a `Set` view of the keys contained in this map.
public @Nullable Function<P, I>	put(K key with which the specified value is to be associated k, @NotNull Function<P, I> value to be associated with the specified key factory) Implements java.util.Map.put. Associates the specified value with the specified key in this map (optional operation).
public void	putAll(@NotNull Map<? extends K, ? extends Function<P, I>> mappings to be stored in this map map) Implements java.util.Map.putAll. Copies all of the mappings from the specified map to this map (optional operation).
public @Nullable Function<P, I>	remove(@Nullable Object key whose mapping is to be removed from the map o) Implements java.util.Map.remove. Removes the mapping for a key from this map if it is present (optional operation).
public int	size() Implements java.util.Map.size. Returns the number of key-value mappings in this map.
public @NotNull Collection<Function<P, I>>	values() Implements java.util.Map.values. Returns a `Collection` view of the values contained in this map.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

factoryMap	back to summary
protected final @NotNull HashMap<K, Function<P, I>> factoryMap Annotations @NotNull

itemMap	back to summary
protected final @NotNull HashMap<K, I> itemMap Annotations @NotNull

param	back to summary
protected final P param Annotations @NotNull

KeyedItemFactoryMap	back to summary
public KeyedItemFactoryMap(P param)

KeyedItemFactoryMap	back to summary
public KeyedItemFactoryMap(P param, int capacity)

Method Detail

clear	back to summary
public void clear() Implements java.util.Map.clear. Doc from java.util.Map.clear. Removes all of the mappings from this map (optional operation). The map will be empty after this call returns. Annotations @Override

clear

back to summary

public void clear()

Implements java.util.Map.clear.

Doc from java.util.Map.clear.

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Annotations

@Override

containsKey back to summary

containsKey	back to summary
public boolean containsKey(@Nullable Object o) Implements java.util.Map.containsKey. Doc from java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key. More formally, returns `true` if and only if this map contains a mapping for a key `k` such that `Objects.equals(key, k)`. (There can be at most one such mapping.) Parameters o:@Nullable Object key whose presence in this map is to be tested Returns:boolean `true` if this map contains a mapping for the specified key Annotations @Override

public boolean containsKey(@Nullable Object o)

Implements java.util.Map.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters

o:@Nullable Object: key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

Annotations

@Override

containsValue back to summary

containsValue	back to summary
public boolean containsValue(Object o) Implements java.util.Map.containsValue. Doc from java.util.Map.containsValue. Returns `true` if this map maps one or more keys to the specified value. More formally, returns `true` if and only if this map contains at least one mapping to a value `v` such that `Objects.equals(value, v)`. This operation will probably require time linear in the map size for most implementations of the `Map` interface. Parameters o:Object value whose presence in this map is to be tested Returns:boolean `true` if this map maps one or more keys to the specified value Annotations @Override

public boolean containsValue(Object o)

Implements java.util.Map.containsValue.

Doc from java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

Parameters

o:Object: value whose presence in this map is to be tested

Returns:boolean

true if this map maps one or more keys to the specified value

Annotations

@Override

entrySet back to summary

entrySet	back to summary
public @NotNull Set<Map.Entry<K, Function<P, I>>> entrySet() Implements java.util.Map.entrySet. Doc from java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation, or through the `setValue` operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:@NotNull Set<Map.Entry<K, Function<P, I>>> a set view of the mappings contained in this map Annotations @NotNull @Override

public @NotNull Set<Map.Entry<K, Function<P, I>>> entrySet()

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:@NotNull Set<Map.Entry<K, Function<P, I>>>

a set view of the mappings contained in this map

Annotations

@NotNull
@Override

get back to summary

get	back to summary
public @Nullable Function<P, I> get(@Nullable Object o) Implements java.util.Map.get. Doc from java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. More formally, if this map contains a mapping from a key `k` to a value `v` such that `Objects.equals(key, k)`, then this method returns `v`; otherwise it returns `null`. (There can be at most one such mapping.) If this map permits null values, then a return value of `null` does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to `null`. The `containsKey` operation may be used to distinguish these two cases. Parameters o:@Nullable Object the key whose associated value is to be returned Returns:@Nullable Function<P, I> the value to which the specified key is mapped, or `null` if this map contains no mapping for the key Annotations @Override @Nullable

public @Nullable Function<P, I> get(@Nullable Object o)

Implements java.util.Map.get.

Doc from java.util.Map.get.

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

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters

o:@Nullable Object: the key whose associated value is to be returned

Returns:@Nullable Function<P, I>

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations

@Override
@Nullable

getItem	back to summary
public I getItem(K key) Annotations @Nullable

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements java.util.Map.isEmpty. Doc from java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings. Returns:boolean `true` if this map contains no key-value mappings Annotations @Override

public boolean isEmpty()

Implements java.util.Map.isEmpty.

Doc from java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

Returns:boolean

true if this map contains no key-value mappings

Annotations

@Override

keySet back to summary

keySet	back to summary
public @NotNull Set<K> keySet() Implements java.util.Map.keySet. Doc from java.util.Map.keySet. Returns a `Set` view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll`, and `clear` operations. It does not support the `add` or `addAll` operations. Returns:@NotNull Set<K> a set view of the keys contained in this map Annotations @NotNull @Override

public @NotNull Set<K> keySet()

Implements java.util.Map.keySet.

Doc from java.util.Map.keySet.

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:@NotNull Set<K>

a set view of the keys contained in this map

Annotations

@NotNull
@Override

put back to summary

put	back to summary
public @Nullable Function<P, I> put(K k, @NotNull Function<P, I> factory) Implements java.util.Map.put. Doc from java.util.Map.put. Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map `m` is said to contain a mapping for a key `k` if and only if `m.containsKey(k)` would return `true`.) Parameters k:K key with which the specified value is to be associated factory:@NotNull Function<P, I> value to be associated with the specified key Returns:@Nullable Function<P, I> the previous value associated with `key`, or `null` if there was no mapping for `key`. (A `null` return can also indicate that the map previously associated `null` with `key`, if the implementation supports `null` values.) Annotations @Override @Nullable

public @Nullable Function<P, I> put(K k, @NotNull Function<P, I> factory)

Implements java.util.Map.put.

Doc from java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters

k:K: key with which the specified value is to be associated
factory:@NotNull Function<P, I>: value to be associated with the specified key

Returns:@Nullable Function<P, I>

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

Annotations

@Override
@Nullable

putAll back to summary

putAll	back to summary
public void putAll(@NotNull Map<? extends K, ? extends Function<P, I>> map) Implements java.util.Map.putAll. Doc from java.util.Map.putAll. Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling `put(k, v)` on this map once for each mapping from key `k` to value `v` in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order. Parameters map:@NotNull Map<? extends K, ? extends Function<P, I>> mappings to be stored in this map Annotations @Override

public void putAll(@NotNull Map<? extends K, ? extends Function<P, I>> map)

Implements java.util.Map.putAll.

Doc from java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

Parameters

map:@NotNull Map<? extends K, ? extends Function<P, I>>: mappings to be stored in this map

Annotations

@Override

remove back to summary

remove	back to summary
public @Nullable Function<P, I> remove(@Nullable Object o) Implements java.util.Map.remove. Doc from java.util.Map.remove. Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key `k` to value `v` such that `Objects.equals(key, k)`, that mapping is removed. (The map can contain at most one such mapping.) Returns the value to which this map previously associated the key, or `null` if the map contained no mapping for the key. If this map permits null values, then a return value of `null` does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to `null`. The map will not contain a mapping for the specified key once the call returns. Parameters o:@Nullable Object key whose mapping is to be removed from the map Returns:@Nullable Function<P, I> the previous value associated with `key`, or `null` if there was no mapping for `key`. Annotations @Override @Nullable

public @Nullable Function<P, I> remove(@Nullable Object o)

Implements java.util.Map.remove.

Doc from java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters

o:@Nullable Object: key whose mapping is to be removed from the map

Returns:@Nullable Function<P, I>

the previous value associated with key, or null if there was no mapping for key.

Annotations

@Override
@Nullable

size back to summary

size	back to summary
public int size() Implements java.util.Map.size. Doc from java.util.Map.size. Returns the number of key-value mappings in this map. If the map contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of key-value mappings in this map Annotations @Override

public int size()

Implements java.util.Map.size.

Doc from java.util.Map.size.

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of key-value mappings in this map

Annotations

@Override

values back to summary

values	back to summary
public @NotNull Collection<Function<P, I>> values() Implements java.util.Map.values. Doc from java.util.Map.values. Returns a `Collection` view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own `remove` operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Collection.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:@NotNull Collection<Function<P, I>> a collection view of the values contained in this map Annotations @NotNull @Override

public @NotNull Collection<Function<P, I>> values()

Implements java.util.Map.values.

Doc from java.util.Map.values.

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:@NotNull Collection<Function<P, I>>

a collection view of the values contained in this map

Annotations

@NotNull
@Override

public Class KeyedItemFactoryMap<K, I, P>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail