Module swim.util

Package swim.util

Interface OrderedMap<K,V>

All Superinterfaces:

Iterable<Map.Entry<K,V>>, IterableMap<K,V>, Map<K,V>, SortedMap<K,V>

All Known Subinterfaces:

MapData<K,V>, MapDataBinding, MapDownlink<K,V>, MapLane<K,V>, ObservableOrderedMap<K,V>, ReducedMap<K,V,U>

All Known Implementing Classes:

BTree, BTreeMap, BTreeMap, BTreeMapView, JoinMapLaneDownlink, MapDataModel, MapDataModel, MapDataProxy, MapDataView, MapDownlinkView, MapLaneView, ValueOrderedMap, ValueReducedMap

public interface OrderedMap<K,V>
extends IterableMap<K,V>, SortedMap<K,V>

Nested Class Summary

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

Map.Entry<K extends Object,V extends Object>

Method Summary

Modifier and Type	Method	Description
void	clear()
Comparator<? super K>	comparator()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
default Set<Map.Entry<K,V>>	entrySet()
Map.Entry<K,V>	firstEntry()
K	firstKey()
V	firstValue()
V	get(Object key)
Map.Entry<K,V>	getEntry(Object key)
Map.Entry<K,V>	getIndex(int index)
default OrderedMap<K,V>	headMap(K toKey)
int	indexOf(Object key)
boolean	isEmpty()
OrderedMapCursor<K,V>	iterator()
default Cursor<K>	keyIterator()
default Set<K>	keySet()
Map.Entry<K,V>	lastEntry()
K	lastKey()
V	lastValue()
Map.Entry<K,V>	nextEntry(K key)
K	nextKey(K key)
V	nextValue(K key)
Map.Entry<K,V>	previousEntry(K key)
K	previousKey(K key)
V	previousValue(K key)
V	put(K key, V newValue)
default void	putAll(Map<? extends K,? extends V> map)
V	remove(Object key)
int	size()
default OrderedMap<K,V>	subMap(K fromKey, K toKey)
default OrderedMap<K,V>	tailMap(K fromKey)
default Cursor<V>	valueIterator()
default Collection<V>	values()

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Details

isEmpty

boolean isEmpty()

Specified by:

isEmpty in interface IterableMap<K,V>

Specified by:

isEmpty in interface Map<K,V>

size

int size()

Specified by:

size in interface IterableMap<K,V>

Specified by:

size in interface Map<K,V>

containsKey

boolean containsKey(Object key)

Specified by:

containsKey in interface IterableMap<K,V>

Specified by:

containsKey in interface Map<K,V>

containsValue

boolean containsValue(Object value)

Specified by:

containsValue in interface IterableMap<K,V>

Specified by:

containsValue in interface Map<K,V>

indexOf

int indexOf(Object key)

get

V get(Object key)

Specified by:

get in interface IterableMap<K,V>

Specified by:

get in interface Map<K,V>

getEntry

Map.Entry<K,V> getEntry(Object key)

getIndex

Map.Entry<K,V> getIndex(int index)

firstEntry

Map.Entry<K,V> firstEntry()

firstKey

K firstKey()

Specified by:

firstKey in interface SortedMap<K,V>

firstValue

V firstValue()

lastEntry

Map.Entry<K,V> lastEntry()

lastKey

K lastKey()

Specified by:

lastKey in interface SortedMap<K,V>

lastValue

V lastValue()

nextEntry

Map.Entry<K,V> nextEntry(K key)

nextKey

K nextKey(K key)

nextValue

V nextValue(K key)

previousEntry

Map.Entry<K,V> previousEntry(K key)

previousKey

K previousKey(K key)

previousValue

V previousValue(K key)

put

V put(K key,
 V newValue)

Specified by:

put in interface IterableMap<K,V>

Specified by:

put in interface Map<K,V>

putAll

default void putAll(Map<? extends K,? extends V> map)

Specified by:

putAll in interface IterableMap<K,V>

Specified by:

putAll in interface Map<K,V>

remove

V remove(Object key)

Specified by:

remove in interface IterableMap<K,V>

Specified by:

remove in interface Map<K,V>

clear

void clear()

Specified by:

clear in interface IterableMap<K,V>

Specified by:

clear in interface Map<K,V>

headMap

default OrderedMap<K,V> headMap(K toKey)

Specified by:

headMap in interface SortedMap<K,V>

tailMap

default OrderedMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface SortedMap<K,V>

subMap

default OrderedMap<K,V> subMap(K fromKey,
 K toKey)

Specified by:

subMap in interface SortedMap<K,V>

entrySet

default Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface IterableMap<K,V>

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface SortedMap<K,V>

keySet

default Set<K> keySet()

Specified by:

keySet in interface IterableMap<K,V>

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface SortedMap<K,V>

values

default Collection<V> values()

Specified by:

values in interface IterableMap<K,V>

Specified by:

values in interface Map<K,V>

Specified by:

values in interface SortedMap<K,V>

iterator

OrderedMapCursor<K,V> iterator()

Specified by:

iterator in interface Iterable<K>

Specified by:

iterator in interface IterableMap<K,V>

keyIterator

default Cursor<K> keyIterator()

Specified by:

keyIterator in interface IterableMap<K,V>

valueIterator

default Cursor<V> valueIterator()

Specified by:

valueIterator in interface IterableMap<K,V>

comparator

Comparator<? super K> comparator()

Specified by:

comparator in interface SortedMap<K,V>