FloatObjectMapKt

Added in 1.4.0

public final class FloatObjectMapKt

Summary

Public methods
static final @NonNull FloatObjectMap<@NonNull V>
<V extends Object> buildFloatObjectMap(
    @ExtensionFunctionType @NonNull Function1<@NonNull MutableFloatObjectMap<@NonNull V>, Unit> builderAction
)

Builds a new FloatObjectMap by populating a MutableFloatObjectMap using the given builderAction.
static final @NonNull FloatObjectMap<@NonNull V>
<V extends Object> buildFloatObjectMap(
    int initialCapacity,
    @ExtensionFunctionType @NonNull Function1<@NonNull MutableFloatObjectMap<@NonNull V>, Unit> builderAction
)

Builds a new FloatObjectMap by populating a MutableFloatObjectMap using the given builderAction.
static final @NonNull FloatObjectMap<@NonNull V>
<V extends Object> emptyFloatObjectMap()

Returns an empty, read-only FloatObjectMap.
static final @NonNull FloatObjectMap<@NonNull V>
<V extends Object> floatObjectMapOf()

Returns an empty, read-only FloatObjectMap.
static final @NonNull FloatObjectMap<@NonNull V>
<V extends Object> floatObjectMapOf(float key1, @NonNull V value1)

Returns a new FloatObjectMap with key1 associated with value1.
static final @NonNull FloatObjectMap<@NonNull V>
<V extends Object> floatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2
)

Returns a new FloatObjectMap with key1, and key2 associated with value1, and value2, respectively.
static final @NonNull FloatObjectMap<@NonNull V>
<V extends Object> floatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2,
    float key3,
    @NonNull V value3
)

Returns a new FloatObjectMap with key1, key2, and key3 associated with value1, value2, and value3, respectively.
static final @NonNull FloatObjectMap<@NonNull V>
<V extends Object> floatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2,
    float key3,
    @NonNull V value3,
    float key4,
    @NonNull V value4
)

Returns a new FloatObjectMap with key1, key2, key3, and key4 associated with value1, value2, value3, and value4, respectively.
static final @NonNull FloatObjectMap<@NonNull V>
<V extends Object> floatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2,
    float key3,
    @NonNull V value3,
    float key4,
    @NonNull V value4,
    float key5,
    @NonNull V value5
)

Returns a new FloatObjectMap with key1, key2, key3, key4, and key5 associated with value1, value2, value3, value4, and value5, respectively.
static final @NonNull MutableFloatObjectMap<@NonNull V>

Returns a new MutableFloatObjectMap.
static final @NonNull MutableFloatObjectMap<@NonNull V>
<V extends Object> mutableFloatObjectMapOf(float key1, @NonNull V value1)

Returns a new MutableFloatObjectMap with key1 associated with value1.
static final @NonNull MutableFloatObjectMap<@NonNull V>
<V extends Object> mutableFloatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2
)

Returns a new MutableFloatObjectMap with key1, and key2 associated with value1, and value2, respectively.
static final @NonNull MutableFloatObjectMap<@NonNull V>
<V extends Object> mutableFloatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2,
    float key3,
    @NonNull V value3
)

Returns a new MutableFloatObjectMap with key1, key2, and key3 associated with value1, value2, and value3, respectively.
static final @NonNull MutableFloatObjectMap<@NonNull V>
<V extends Object> mutableFloatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2,
    float key3,
    @NonNull V value3,
    float key4,
    @NonNull V value4
)

Returns a new MutableFloatObjectMap with key1, key2, key3, and key4 associated with value1, value2, value3, and value4, respectively.
static final @NonNull MutableFloatObjectMap<@NonNull V>
<V extends Object> mutableFloatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2,
    float key3,
    @NonNull V value3,
    float key4,
    @NonNull V value4,
    float key5,
    @NonNull V value5
)

Returns a new MutableFloatObjectMap with key1, key2, key3, key4, and key5 associated with value1, value2, value3, value4, and value5, respectively.

Public methods

buildFloatObjectMap

public static final @NonNull FloatObjectMap<@NonNull V> <V extends Object> buildFloatObjectMap(
    @ExtensionFunctionType @NonNull Function1<@NonNull MutableFloatObjectMap<@NonNull V>, Unit> builderAction
)

Builds a new FloatObjectMap by populating a MutableFloatObjectMap using the given builderAction.

The instance passed as a receiver to the builderAction is valid only inside that function. Using it outside of the function produces an unspecified behavior.

Parameters
@ExtensionFunctionType @NonNull Function1<@NonNull MutableFloatObjectMap<@NonNull V>, Unit> builderAction

Lambda in which the MutableFloatObjectMap can be populated.

buildFloatObjectMap

public static final @NonNull FloatObjectMap<@NonNull V> <V extends Object> buildFloatObjectMap(
    int initialCapacity,
    @ExtensionFunctionType @NonNull Function1<@NonNull MutableFloatObjectMap<@NonNull V>, Unit> builderAction
)

Builds a new FloatObjectMap by populating a MutableFloatObjectMap using the given builderAction.

The instance passed as a receiver to the builderAction is valid only inside that function. Using it outside of the function produces an unspecified behavior.

Parameters
int initialCapacity

Hint for the expected number of pairs added in the builderAction.
@ExtensionFunctionType @NonNull Function1<@NonNull MutableFloatObjectMap<@NonNull V>, Unit> builderAction

Lambda in which the MutableFloatObjectMap can be populated.

emptyFloatObjectMap

public static final @NonNull FloatObjectMap<@NonNull V> <V extends Object> emptyFloatObjectMap()

Returns an empty, read-only FloatObjectMap.

floatObjectMapOf

public static final @NonNull FloatObjectMap<@NonNull V> <V extends Object> floatObjectMapOf()

Returns an empty, read-only FloatObjectMap.

floatObjectMapOf

public static final @NonNull FloatObjectMap<@NonNull V> <V extends Object> floatObjectMapOf(float key1, @NonNull V value1)

Returns a new FloatObjectMap with key1 associated with value1.

floatObjectMapOf

public static final @NonNull FloatObjectMap<@NonNull V> <V extends Object> floatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2
)

Returns a new FloatObjectMap with key1, and key2 associated with value1, and value2, respectively.

floatObjectMapOf

public static final @NonNull FloatObjectMap<@NonNull V> <V extends Object> floatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2,
    float key3,
    @NonNull V value3
)

Returns a new FloatObjectMap with key1, key2, and key3 associated with value1, value2, and value3, respectively.

floatObjectMapOf

public static final @NonNull FloatObjectMap<@NonNull V> <V extends Object> floatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2,
    float key3,
    @NonNull V value3,
    float key4,
    @NonNull V value4
)

Returns a new FloatObjectMap with key1, key2, key3, and key4 associated with value1, value2, value3, and value4, respectively.

floatObjectMapOf

public static final @NonNull FloatObjectMap<@NonNull V> <V extends Object> floatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2,
    float key3,
    @NonNull V value3,
    float key4,
    @NonNull V value4,
    float key5,
    @NonNull V value5
)

Returns a new FloatObjectMap with key1, key2, key3, key4, and key5 associated with value1, value2, value3, value4, and value5, respectively.

mutableFloatObjectMapOf

public static final @NonNull MutableFloatObjectMap<@NonNull V> <V extends Object> mutableFloatObjectMapOf()

Returns a new MutableFloatObjectMap.

mutableFloatObjectMapOf

public static final @NonNull MutableFloatObjectMap<@NonNull V> <V extends Object> mutableFloatObjectMapOf(float key1, @NonNull V value1)

Returns a new MutableFloatObjectMap with key1 associated with value1.

mutableFloatObjectMapOf

public static final @NonNull MutableFloatObjectMap<@NonNull V> <V extends Object> mutableFloatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2
)

Returns a new MutableFloatObjectMap with key1, and key2 associated with value1, and value2, respectively.

mutableFloatObjectMapOf

public static final @NonNull MutableFloatObjectMap<@NonNull V> <V extends Object> mutableFloatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2,
    float key3,
    @NonNull V value3
)

Returns a new MutableFloatObjectMap with key1, key2, and key3 associated with value1, value2, and value3, respectively.

mutableFloatObjectMapOf

public static final @NonNull MutableFloatObjectMap<@NonNull V> <V extends Object> mutableFloatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2,
    float key3,
    @NonNull V value3,
    float key4,
    @NonNull V value4
)

Returns a new MutableFloatObjectMap with key1, key2, key3, and key4 associated with value1, value2, value3, and value4, respectively.

mutableFloatObjectMapOf

public static final @NonNull MutableFloatObjectMap<@NonNull V> <V extends Object> mutableFloatObjectMapOf(
    float key1,
    @NonNull V value1,
    float key2,
    @NonNull V value2,
    float key3,
    @NonNull V value3,
    float key4,
    @NonNull V value4,
    float key5,
    @NonNull V value5
)

Returns a new MutableFloatObjectMap with key1, key2, key3, key4, and key5 associated with value1, value2, value3, value4, and value5, respectively.