com.swirlds.common.test.map.MapPairs Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2021-2023 Hedera Hashgraph, LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.swirlds.common.test.map;

import com.swirlds.common.FastCopyable;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

/**
 * Holds the mutable map pair and immutable copies
 *
 * @param 
 * 		map type
 * @param 
 * 		key type
 * @param 
 * 		value type
 */
public class MapPairs & FastCopyable, K, V> {
    private final List> copies;
    private MapPair mutablePair;

    public MapPairs(MapPair mutablePair) {
        this.mutablePair = mutablePair;
        this.copies = new LinkedList<>();
    }

    /**
     * @return the current mutable pair
     */
    public MapPair getMutablePair() {
        return mutablePair;
    }

    /**
     * copies the mutable pair and adds it to the list of immatable pairs
     */
    public void copy() {
        MapPair copy = mutablePair.copy();
        copies.add(mutablePair);
        mutablePair = copy;
    }

    /**
     * @return the list of immutable copies
     */
    public List> getCopies() {
        return copies;
    }
}