001/*
002 * Copyright (C) 2012 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.collect.testing.google;
018
019import com.google.common.annotations.GwtCompatible;
020import com.google.common.collect.Multimap;
021import com.google.common.collect.testing.SampleElements;
022import com.google.common.collect.testing.TestContainerGenerator;
023import java.util.Collection;
024import java.util.Map.Entry;
025import org.jspecify.annotations.NullMarked;
026import org.jspecify.annotations.Nullable;
027
028/**
029 * Creates multimaps, containing sample elements, to be tested.
030 *
031 * @author Louis Wasserman
032 */
033@GwtCompatible
034@NullMarked
035public interface TestMultimapGenerator<
036        K extends @Nullable Object, V extends @Nullable Object, M extends Multimap<K, V>>
037    extends TestContainerGenerator<M, Entry<K, V>> {
038
039  K[] createKeyArray(int length);
040
041  V[] createValueArray(int length);
042
043  SampleElements<K> sampleKeys();
044
045  SampleElements<V> sampleValues();
046
047  Collection<V> createCollection(Iterable<? extends V> values);
048}