/*
 * Copyright (c) 2022 Goldman Sachs and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v. 1.0 which accompany this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 */

package org.eclipse.collections.impl.block.procedure;

import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.multimap.MutableMultimap;

/**
 * MultimapPutProcedure uses a Function to calculate the key for an object and puts the object with the key
 * into the specified {@link MutableMultimap}.
 */
public final class MultimapPutProcedure<K, V> implements Procedure<V>
{
    private static final long serialVersionUID = 1L;

    private final MutableMultimap<K, V> multimap;
    private final Function<? super V, ? extends K> keyFunction;

    public MultimapPutProcedure(
            MutableMultimap<K, V> multimap,
            Function<? super V, ? extends K> keyFunction)
    {
        this.multimap = multimap;
        this.keyFunction = keyFunction;
    }

    public static <K, V> MultimapPutProcedure<K, V> on(
            MutableMultimap<K, V> multimap,
            Function<? super V, ? extends K> keyFunction)
    {
        return new MultimapPutProcedure<>(multimap, keyFunction);
    }

    @Override
    public void value(V each)
    {
        K key = this.keyFunction.valueOf(each);
        this.multimap.put(key, each);
    }
}
