ScatterMapKt

Added in 1.4.0

public final class ScatterMapKt

Summary

Public methods
static final @NonNull ScatterMap<@NonNull K, @NonNull V>
<K extends Object, V extends Object> emptyScatterMap()

Returns an empty, read-only ScatterMap.
static final @NonNull MutableScatterMap<@NonNull K, @NonNull V>
<K extends Object, V extends Object> mutableScatterMapOf()

Returns a new MutableScatterMap.
static final @NonNull MutableScatterMap<@NonNull K, @NonNull V>
<K extends Object, V extends Object> mutableScatterMapOf(
    @NonNull Pair<@NonNull K, @NonNull V>... pairs
)

Returns a new MutableScatterMap with the specified contents, given as a list of pairs where the first component is the key and the second is the value.
static final @NonNull MutableScatterMap<@NonNull K, @NonNull V>
<K extends Object, V extends Object> toMutableScatterMap(
    @NonNull Map<@NonNull K, @NonNull V> receiver
)

Returns a new MutableScatterMap with the specified mappings.
static final @NonNull MutableScatterMap<@NonNull K, @NonNull V>
<K extends Object, V extends Object> toMutableScatterMap(
    @NonNull ScatterMap<@NonNull K, @NonNull V> receiver
)

Returns a new MutableScatterMap with the specified mappings.
static final @NonNull ScatterMap<@NonNull K, @NonNull V>
<K extends Object, V extends Object> toScatterMap(
    @NonNull Map<@NonNull K, @NonNull V> receiver
)

Returns a new read-only ScatterMap with the specified mappings.
static final @NonNull ScatterMap<@NonNull K, @NonNull V>
<K extends Object, V extends Object> toScatterMap(
    @NonNull ScatterMap<@NonNull K, @NonNull V> receiver
)

Returns a new read-only ScatterMap with the specified mappings.

Public methods

emptyScatterMap

public static final @NonNull ScatterMap<@NonNull K, @NonNull V> <K extends Object, V extends Object> emptyScatterMap()

Returns an empty, read-only ScatterMap.

mutableScatterMapOf

public static final @NonNull MutableScatterMap<@NonNull K, @NonNull V> <K extends Object, V extends Object> mutableScatterMapOf()

Returns a new MutableScatterMap.

mutableScatterMapOf

public static final @NonNull MutableScatterMap<@NonNull K, @NonNull V> <K extends Object, V extends Object> mutableScatterMapOf(
    @NonNull Pair<@NonNull K, @NonNull V>... pairs
)

Returns a new MutableScatterMap with the specified contents, given as a list of pairs where the first component is the key and the second is the value. If multiple pairs have the same key, the resulting map will contain the value from the last of those pairs.

toMutableScatterMap

public static final @NonNull MutableScatterMap<@NonNull K, @NonNull V> <K extends Object, V extends Object> toMutableScatterMap(
    @NonNull Map<@NonNull K, @NonNull V> receiver
)

Returns a new MutableScatterMap with the specified mappings.

The MutableScatterMap is created with an initial capacity sufficient to hold the mappings in the specified Map.

toMutableScatterMap

public static final @NonNull MutableScatterMap<@NonNull K, @NonNull V> <K extends Object, V extends Object> toMutableScatterMap(
    @NonNull ScatterMap<@NonNull K, @NonNull V> receiver
)

Returns a new MutableScatterMap with the specified mappings.

The MutableScatterMap is created with an initial capacity sufficient to hold the mappings in the specified ScatterMap.

toScatterMap

public static final @NonNull ScatterMap<@NonNull K, @NonNull V> <K extends Object, V extends Object> toScatterMap(
    @NonNull Map<@NonNull K, @NonNull V> receiver
)

Returns a new read-only ScatterMap with the specified mappings.

toScatterMap

public static final @NonNull ScatterMap<@NonNull K, @NonNull V> <K extends Object, V extends Object> toScatterMap(
    @NonNull ScatterMap<@NonNull K, @NonNull V> receiver
)

Returns a new read-only ScatterMap with the specified mappings.