Map0.27.0

Overview
Properties
Methods

external class Map<out Key, out Value> extends Any

An unordered mapping from keys to values.

Known subtypes:
Known usages:
All versions:

The following operators are supported for maps:

map[key]     // subscript; similar to `getOrNull` but throws if key not found
map1 + map2  // merge; if both maps have an entry with the same key, the entry in map2 wins

Properties

link

length: Int

The number of entries in this map.
link

isEmpty: Boolean

Tells whether this map is empty.
link

keys: Set<Key>

The keys contained in this map.
link

values: List<Value>

The values contained in this map.
link

entries: List<Pair<Key, Value>>

The entries contained in this map.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)

Returns the class of this.
link

function

Any.toString(): String (pkl.base)

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

getOrNull(key: Any): Value?

Returns the value for key.

Returns null if this map does not contain key.
link

function

containsKey(key: Any): Boolean

Tells if this map contains an entry with the given key.
link

function

containsValue(value: Any): Boolean

Tells if this map contains an entry with the given value.
link

function

put<NewKey, NewValue>(key: NewKey, value: NewValue): Map<(NewKey|Key), (NewValue|Value)>

Adds or updates key to value.
link

function

remove(key: Any): Map<Key, Value>

Removes the map entry with the given key.

Returns this map unchanged if it does not contain an entry with the given key.
link

function

filter(predicate: (Key, Value) -> Boolean): Map<Key, Value>

Removes all entries for which predicate does not hold.
link

function

fold<Result>(initial: Result, operator: (Result, Key, Value) -> Result): Result

Folds the entries of this map in iteration order using operator, starting with initial.
link

function

map<NewKey, NewValue>(transform: (Key, Value) -> Pair<NewKey, NewValue>): Map<NewKey, NewValue>

Transforms the entries of this map using transform.
link

function

mapKeys<NewKey>(transform: (Key, Value) -> NewKey): Map<NewKey, Value>

Transforms the keys of this map using transform.
link

function

mapValues<NewValue>(transform: (Key, Value) -> NewValue): Map<Key, NewValue>

Transforms the values of this map using transform.
link

function

flatMap<NewKey, NewValue>(transform: (Key, Value) -> Map<NewKey, NewValue>): Map<NewKey, NewValue>

Applies a map-generating transform to each map entry and concatenates the resulting maps.
link

function

every(predicate: (Key, Value) -> Boolean): Boolean

Tells if predicate holds for every entry of this map.

Returns true for an empty map.
link

function

any(predicate: (Key, Value) -> Boolean): Boolean

Tells if predicate holds for at least one entry of this map.

Returns false for an empty map.
link

function

toMap(): Map

Returns this map.
link

function

toDynamic(): Dynamic

Converts this map to a Dynamic object.
link

function
toTyped<Type>(clazz: Class): Type(this is Typed)

Converts this map to a typed object of class clazz.
Conforms to the semantics of the following manual conversion:
```
class Person { name: String; age: Int }
map = Map(name, "Pigeon", age, 42)
function toTyped(map: Map): Person = new {
  name = map.getOrNull("name") ?? super.name
  age = map.getOrNull("age") ?? super.age
}
```
Notable behavior:
- Entries of this that have no corresponding property in clazz are ignored.
- clazz properties that have no corresponding entry in this have their defaults preserved.
- clazz properties that have neither a default nor a corresponding entry in this throw an "undefined property" error (only) when accessed.
Throws if clazz is abstract or not a subclass of Typed.
link

function

toMapping(): Mapping<Key, Value>

Converts this map to a Mapping.