Haxe API Documentation
Back | Index
private class Map_Impl_
import Map
Available in flash8, neko, js, flash, php, cpp
static function _new() : IMap<Map.K, Map.V>

Creates a new Map.

This becomes a constructor call to one of the specialization types in the output. The rules for that are as follows: 1. if K is a String, haxe.ds.StringMap is used 2. if K is an Int, haxe.ds.IntMap is used 3. if K is a class or structure that has a hashCode() function which returns an Int, haxe.ds.HashMap is used 4. if K is any other class or structure, haxe.ds.ObjectMap is used 5. if K is any other type, it causes a compile-time error

(Cpp) Map does not use weak keys on ObjectMap by default.

static inline function arrayWrite(this : IMap<Map.K, Map.V>, k : Map.K, v : Map.V) : Map.V
static inline function exists(this : IMap<Map.K, Map.V>, key : Map.K) : Bool

Returns true if key has a mapping, false otherwise.

If key is null, the result is unspecified.

static inline function get(this : IMap<Map.K, Map.V>, key : Map.K) : Null<Map.V>

Returns the current mapping of key.

If no such mapping exists, null is returned.

Note that a check like map.get(key) == null can hold for two reasons: 1. the map has no mapping for key 2. the map has a mapping with a value of null If it is important to distinguish these cases, exists() should be used.

If key is null, the result is unspecified.

static inline function iterator(this : IMap<Map.K, Map.V>) : Iterator<Map.V>

Returns an Iterator over the values of this Map.

The order of values is undefined.

static inline function keys(this : IMap<Map.K, Map.V>) : Iterator<Map.K>

Returns an Iterator over the keys of this Map.

The order of keys is undefined.

static inline function remove(this : IMap<Map.K, Map.V>, key : Map.K) : Bool

Removes the mapping of key and returns true if such a mapping existed, false otherwise.

If key is null, the result is unspecified.

static inline function set(this : IMap<Map.K, Map.V>, key : Map.K, value : Map.V) : Void

Maps key to value.

If key already has a mapping, the previous value disappears.

If key is null, the result is unspecified.

static inline function toString(this : IMap<Map.K, Map.V>) : String

Returns a String representation of this Map.

The exact representation depends on the platform and key-type.

Back | Index