Top Fields Constructors Methods
com.vladsch.flexmark.util.collection

public Class OrderedMultiMap<K, V>

extends Object
implements Map<K, V>, Iterable<Map.Entry<K, V>>
Class Inheritance
All Implemented Interfaces
java.lang.Iterable, java.util.Map
Imports
com.vladsch.flexmark.util.collection.iteration.*, com.vladsch.flexmark.util.misc.Pair, .Paired, org.jetbrains.annotations.NotNull, .Nullable, java.util.*, java.util.function.Consumer

Field Summary

Modifier and TypeField and Description
private final @Nullable CollectionHost<Paired<K, V>>
private @Nullable Indexed<Map.Entry<K, V>>
pack-priv boolean
pack-priv boolean
private final @NotNull OrderedSet<K>
private final @NotNull OrderedSet<V>

Constructor Summary

AccessConstructor and Description
public
public
OrderedMultiMap(int capacity)

public
public
OrderedMultiMap(int capacity, @Nullable CollectionHost<Paired<K, V>> host)

Method Summary

Modifier and TypeMethod and Description
pack-priv void
addingKey(int index, K k, @Nullable Object v)

pack-priv void
addingNullKey(int index)

pack-priv void
addingNullValue(int index)

pack-priv void
addingValue(int index, V v, @Nullable Object k)

private boolean
addKeyValue(K k, V v)

public void
addNullEntry(int index)

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(@Nullable 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 OrderedSet<Map.Entry<K, V>>
entrySet()

Implements java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map.

public ReversibleIterable<Map.Entry<K, V>>
public ReversibleIndexedIterator<Map.Entry<K, V>>
public boolean
equals(Object
object to be compared for equality with this map
o
)

Overrides java.lang.Object.equals.

Implements java.util.Map.equals.

Compares the specified object with this map for equality.

public void
forEach(Consumer<? super Map.Entry<K, V>>
The action to be performed for each element
consumer
)

Overrides default java.lang.Iterable.forEach.

Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception.

public V
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.

pack-priv Map.Entry<K, V>
getEntry(int index)

public Indexed<Map.Entry<K, V>>
public K
getKey(int index)

public V
private BitSet
private BitSet
public int
public V
getValue(int index)

public K
public int
hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.hashCode.

Returns the hash code value for this map.

public boolean
isEmpty()

Implements java.util.Map.isEmpty.

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

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

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

public ReversibleIterable<K>
public ReversibleIndexedIterator<K>
public Collection<K>
keys()

public @NotNull OrderedSet<K>
keySet()

Implements java.util.Map.keySet.

Returns a Set view of the keys contained in this map.

public OrderedSet<Map.Entry<K, V>>
public V
put(K
key with which the specified value is to be associated
k
,
V
value to be associated with the specified key
v
)

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 V>
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 void
putAllKeyValues(Map<? extends K, ? extends V> map)

public void
putAllValueKeys(Map<? extends V, ? extends K> map)

public boolean
putEntry(Map.Entry<K, V> e)

public V
putKeyValue(K k, V v)

public boolean
public boolean
public K
putValueKey(V v, K k)

public boolean
public boolean
public V
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 Map.Entry<K, V>
pack-priv boolean
removeEntryIndex(int index)

private boolean
removeEntryIndex(int index, K k, V v)

public V
public K
pack-priv Object
removingKey(int index, K k)

pack-priv Object
removingValue(int index, V v)

public ReversibleIterable<Map.Entry<K, V>>
public ReversibleIndexedIterator<Map.Entry<K, V>>
public ReversibleIterable<K>
public ReversibleIndexedIterator<K>
public ReversibleIterable<V>
public ReversibleIndexedIterator<V>
public int
size()

Implements java.util.Map.size.

Returns the number of key-value mappings in this map.

public ReversibleIterable<V>
public ReversibleIndexedIterator<V>
public @NotNull Collection<V>
values()

Implements java.util.Map.values.

Returns a Collection view of the values contained in this map.

public OrderedSet<V>
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

hostback to summary
private final @Nullable CollectionHost<Paired<K, V>> host
Annotations
@Nullable
indexedProxyback to summary
private @Nullable Indexed<Map.Entry<K, V>> indexedProxy
Annotations
@Nullable
isInKeyUpdateback to summary
pack-priv boolean isInKeyUpdate
isInValueUpdateback to summary
pack-priv boolean isInValueUpdate
keySetback to summary
private final @NotNull OrderedSet<K> keySet
Annotations
@NotNull
valueSetback to summary
private final @NotNull OrderedSet<V> valueSet
Annotations
@NotNull

Constructor Detail

OrderedMultiMapback to summary
public OrderedMultiMap()
OrderedMultiMapback to summary
public OrderedMultiMap(int capacity)
OrderedMultiMapback to summary
public OrderedMultiMap(@NotNull CollectionHost<Paired<K, V>> host)
OrderedMultiMapback to summary
public OrderedMultiMap(int capacity, @Nullable CollectionHost<Paired<K, V>> host)

Method Detail

addingKeyback to summary
pack-priv void addingKey(int index, K k, @Nullable Object v)
Annotations
@SuppressWarnings:unchecked
addingNullKeyback to summary
pack-priv void addingNullKey(int index)
addingNullValueback to summary
pack-priv void addingNullValue(int index)
addingValueback to summary
pack-priv void addingValue(int index, V v, @Nullable Object k)
Annotations
@SuppressWarnings:unchecked
addKeyValueback to summary
private boolean addKeyValue(K k, V v)
addNullEntryback to summary
public void addNullEntry(int index)
clearback 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
containsKeyback 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
containsValueback to summary
public boolean containsValue(@Nullable 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:@Nullable 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
entrySetback to summary
public @NotNull OrderedSet<Map.Entry<K, V>> 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 OrderedSet<Map.Entry<K, V>>

a set view of the mappings contained in this map

Annotations
@NotNull
@Override
entrySetIterableback to summary
public ReversibleIterable<Map.Entry<K, V>> entrySetIterable()
entrySetIteratorback to summary
public ReversibleIndexedIterator<Map.Entry<K, V>> entrySetIterator()
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Implements java.util.Map.equals.

Doc from java.util.Map.equals.

Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.

Parameters
o:Object

object to be compared for equality with this map

Returns:boolean

true if the specified object is equal to this map

Annotations
@Override
forEachback to summary
public void forEach(Consumer<? super Map.Entry<K, V>> consumer)

Overrides default java.lang.Iterable.forEach.

Doc from java.lang.Iterable.forEach.

Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.

The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy.

Parameters
consumer:Consumer<? super Map.Entry<K, V>>

The action to be performed for each element

getback to summary
public V 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:V

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

Annotations
@Override
@Nullable
getEntryback to summary
pack-priv Map.Entry<K, V> getEntry(int index)
getIndexedProxyback to summary
public Indexed<Map.Entry<K, V>> getIndexedProxy()
getKeyback to summary
public K getKey(int index)
getKeyValueback to summary
public V getKeyValue(@Nullable Object o)
Annotations
@Nullable
getKeyValueIntersectionSetback to summary
private BitSet getKeyValueIntersectionSet()
getKeyValueUnionSetback to summary
private BitSet getKeyValueUnionSet()
getModificationCountback to summary
public int getModificationCount()
getValueback to summary
public V getValue(int index)
getValueKeyback to summary
public K getValueKey(@Nullable Object o)
Annotations
@Nullable
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.hashCode.

Doc from java.util.Map.hashCode.

Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract of Object#hashCode.

Returns:int

the hash code value for this map

Annotations
@Override
isEmptyback 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
iteratorback to summary
public @NotNull Iterator<Map.Entry<K, V>> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:@NotNull Iterator<Map.Entry<K, V>>

an Iterator.

Annotations
@NotNull
@Override
keyIterableback to summary
public ReversibleIterable<K> keyIterable()
keyIteratorback to summary
public ReversibleIndexedIterator<K> keyIterator()
keysback to summary
public Collection<K> keys()
keySetback to summary
public @NotNull OrderedSet<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 OrderedSet<K>

a set view of the keys contained in this map

Annotations
@NotNull
@Override
keyValueEntrySetback to summary
public OrderedSet<Map.Entry<K, V>> keyValueEntrySet()
putback to summary
public V put(K k, V v)

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

v:V

value to be associated with the specified key

Returns:V

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
putAllback to summary
public void putAll(@NotNull Map<? extends K, ? extends V> 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 V>

mappings to be stored in this map

Annotations
@Override
putAllKeyValuesback to summary
public void putAllKeyValues(Map<? extends K, ? extends V> map)
putAllValueKeysback to summary
public void putAllValueKeys(Map<? extends V, ? extends K> map)
putEntryback to summary
public boolean putEntry(Map.Entry<K, V> e)
putKeyValueback to summary
public V putKeyValue(K k, V v)
putKeyValueEntryback to summary
public boolean putKeyValueEntry(Map.Entry<K, V> e)
putKeyValuePairback to summary
public boolean putKeyValuePair(@NotNull Paired<K, V> e)
putValueKeyback to summary
public K putValueKey(V v, K k)
putValueKeyEntryback to summary
public boolean putValueKeyEntry(Map.Entry<V, K> e)
putValueKeyPairback to summary
public boolean putValueKeyPair(@NotNull Paired<V, K> e)
removeback to summary
public V 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:V

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

Annotations
@Override
@Nullable
removeEntryback to summary
public Map.Entry<K, V> removeEntry(Map.Entry<K, V> e)
Annotations
@Nullable
removeEntryIndexback to summary
pack-priv boolean removeEntryIndex(int index)
Annotations
@SuppressWarnings:UnusedReturnValue
removeEntryIndexback to summary
private boolean removeEntryIndex(int index, K k, V v)
removeKeyback to summary
public V removeKey(Object o)
removeValueback to summary
public K removeValue(Object o)
removingKeyback to summary
pack-priv Object removingKey(int index, K k)
removingValueback to summary
pack-priv Object removingValue(int index, V v)
reversedEntrySetIterableback to summary
public ReversibleIterable<Map.Entry<K, V>> reversedEntrySetIterable()
reversedEntrySetIteratorback to summary
public ReversibleIndexedIterator<Map.Entry<K, V>> reversedEntrySetIterator()
reversedKeyIterableback to summary
public ReversibleIterable<K> reversedKeyIterable()
reversedKeyIteratorback to summary
public ReversibleIndexedIterator<K> reversedKeyIterator()
reversedValueIterableback to summary
public ReversibleIterable<V> reversedValueIterable()
reversedValueIteratorback to summary
public ReversibleIndexedIterator<V> reversedValueIterator()
sizeback 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
valueIterableback to summary
public ReversibleIterable<V> valueIterable()
valueIteratorback to summary
public ReversibleIndexedIterator<V> valueIterator()
valuesback to summary
public @NotNull Collection<V> 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<V>

a collection view of the values contained in this map

Annotations
@NotNull
@Override
valueSetback to summary
public OrderedSet<V> valueSet()