Class TreeMap<K, V>

Type parameters

K
V

Hierarchy

TreeMap

Implements

NavigableMap<K, V>

Index

Constructors

constructor

Methods

Constructors

constructor

new TreeMap(iComparator: Comparator<K>, initialElements?: ImmutableMap<K, V>): TreeMap

- Defined in TreeMap.ts:36
Parameters
- iComparator: Comparator<K>
- Default value initialElements: ImmutableMap<K, V> = null
Returns TreeMap

Methods

__@iterator

__@iterator(): Iterator<K>

Implementation of NavigableMap.__@iterator
- Defined in TreeMap.ts:127
Returns Iterator<K>

an iterator for the entry set

ceilingEntry

ceilingEntry(key: K): MapEntry<K, V>

Implementation of NavigableMap.ceilingEntry
- Defined in TreeMap.ts:486
Parameters
- key: K
Returns MapEntry<K, V>

an entry with the least key greater than or equal to key, or null if there is no such key

ceilingKey

ceilingKey(key: K): K

Implementation of NavigableMap.ceilingKey
- Defined in TreeMap.ts:499
Parameters
- key: K
Returns K

the least key greater than or equal to key, or null if there is no such key

clear

clear(): void

Implementation of NavigableMap.clear
- Defined in TreeMap.ts:134
Returns void

comparator

comparator(): Comparator<K>

- Defined in TreeMap.ts:149
Returns Comparator<K>

the comparator used to order the keys in this map

containsKey

containsKey(key: K): boolean

Implementation of NavigableMap.containsKey
- Defined in TreeMap.ts:349
Parameters
- key: K
Returns boolean

true if this map contains a mapping for the specified key

containsValue

containsValue(value: V): boolean

Implementation of NavigableMap.containsValue
- Defined in TreeMap.ts:304
Parameters
- value: V
Returns boolean

entrySet

entrySet(): ImmutableSet<MapEntry<K, V>>

Implementation of NavigableMap.entrySet
- Defined in TreeMap.ts:786
Returns ImmutableSet<MapEntry<K, V>>

an entry with the greatest key, or null if this map is empty

firstEntry

firstEntry(): MapEntry<K, V>

Implementation of NavigableMap.firstEntry
- Defined in TreeMap.ts:722
Returns MapEntry<K, V>

an entry with the least key, or null if this map is empty

firstKey

firstKey(): K

Implementation of NavigableMap.firstKey
- Defined in TreeMap.ts:711
Returns K

the first (lowest) key currently in this map, returns null if the Map is empty

floorEntry

floorEntry(key: K): MapEntry<K, V>

Implementation of NavigableMap.floorEntry
- Defined in TreeMap.ts:577
Parameters
- key: K
Returns MapEntry<K, V>

an entry with the greatest key less than or equal to key, or null if there is no such key

floorKey

floorKey(key: K): K

Implementation of NavigableMap.floorKey
- Defined in TreeMap.ts:564
Parameters
- key: K
Returns K

the greatest key less than or equal to key, or null if there is no such key

get

get(key: K): V

Implementation of NavigableMap.get
- Defined in TreeMap.ts:386
Parameters
- key: K
Returns V

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

getNextHigherKey

getNextHigherKey(key: K): K

- Defined in TreeMap.ts:287
Parameters
- key: K
Returns K

the least key greater than key, or null if there is no such key

higherEntry

higherEntry(key: K): MapEntry<K, V>

Implementation of NavigableMap.higherEntry
- Defined in TreeMap.ts:525
Parameters
- key: K
Returns MapEntry<K, V>

an entry with the least key greater than key, or null if there is no such key

higherKey

higherKey(key: K): K

Implementation of NavigableMap.higherKey
- Defined in TreeMap.ts:512
Parameters
- key: K
Returns K

the least key greater than key, or null if there is no such key

immutableMap

immutableMap(): ImmutableMap<K, V>

Implementation of NavigableMap.immutableMap
- Defined in TreeMap.ts:793
Returns ImmutableMap<K, V>

isEmpty

isEmpty(): boolean

Implementation of NavigableMap.isEmpty
- Defined in TreeMap.ts:168
Returns boolean

true if this map contains no key-value mappings

keySet

keySet(): ImmutableSet<K>

Implementation of NavigableMap.keySet
- Defined in TreeMap.ts:774
Returns ImmutableSet<K>

an entry with the greatest key, or null if this map is empty

lastEntry

lastEntry(): MapEntry<K, V>

Implementation of NavigableMap.lastEntry
- Defined in TreeMap.ts:760
Returns MapEntry<K, V>

an entry with the greatest key, or null if this map is empty

lastKey

lastKey(): K

Implementation of NavigableMap.lastKey
- Defined in TreeMap.ts:749
Returns K

the last (highest) key currently in this map, returns null if the Map is empty

lowerEntry

lowerEntry(key: K): MapEntry<K, V>

Implementation of NavigableMap.lowerEntry
- Defined in TreeMap.ts:551
Parameters
- key: K
Returns MapEntry<K, V>

an entry with the highest key lower than key, or null if there is no such key

lowerKey

lowerKey(key: K): K

Implementation of NavigableMap.lowerKey
- Defined in TreeMap.ts:538
Parameters
- key: K
Returns K

the highest key lower than key, or null if there is no such key

put

put(key: K, value: V): V

Implementation of NavigableMap.put
- Defined in TreeMap.ts:186
Parameters
- key: K
- value: V
Returns V

the previous value associated with key, or undefined if there was no mapping for key. (An undefined return can also indicate that the map previously associated undefined with key.)

remove

remove(key: K): V

Implementation of NavigableMap.remove
- Defined in TreeMap.ts:402
Parameters
- key: K
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.)

size

size(): number

Implementation of NavigableMap.size
- Defined in TreeMap.ts:157
Returns number

the number of key-value mappings in this map

toJSON

toJSON(): Array<MapEntry<K, V>>

- Defined in TreeMap.ts:800
Returns Array<MapEntry<K, V>>

validateMap

validateMap(): boolean

- Defined in TreeMap.ts:92
Returns boolean

Generated using TypeDoc