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.checkerframework.checker.nullness.qual.Nullable;
026
027/**
028 * Creates multimaps, containing sample elements, to be tested.
029 *
030 * @author Louis Wasserman
031 */
032@GwtCompatible
033@ElementTypesAreNonnullByDefault
034public interface TestMultimapGenerator<
035        K extends @Nullable Object, V extends @Nullable Object, M extends Multimap<K, V>>
036    extends TestContainerGenerator<M, Entry<K, V>> {
037
038  K[] createKeyArray(int length);
039
040  V[] createValueArray(int length);
041
042  SampleElements<K> sampleKeys();
043
044  SampleElements<V> sampleValues();
045
046  Collection<V> createCollection(Iterable<? extends V> values);
047}