001/*
002 * Copyright (C) 2009 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;
018
019import com.google.common.annotations.GwtCompatible;
020import com.google.common.collect.testing.SampleElements.Unhashables;
021import java.util.Collection;
022import java.util.List;
023import org.jspecify.annotations.NullMarked;
024
025/**
026 * Creates collections containing unhashable sample elements, to be tested.
027 *
028 * @author Regina O'Dell
029 */
030@GwtCompatible
031@NullMarked
032public abstract class TestUnhashableCollectionGenerator<T extends Collection<UnhashableObject>>
033    implements TestCollectionGenerator<UnhashableObject> {
034  @Override
035  public SampleElements<UnhashableObject> samples() {
036    return new Unhashables();
037  }
038
039  @Override
040  public T create(Object... elements) {
041    UnhashableObject[] array = createArray(elements.length);
042    int i = 0;
043    for (Object e : elements) {
044      array[i++] = (UnhashableObject) e;
045    }
046    return create(array);
047  }
048
049  /**
050   * Creates a new collection containing the given elements; implement this method instead of {@link
051   * #create(Object...)}.
052   */
053  protected abstract T create(UnhashableObject[] elements);
054
055  @Override
056  public UnhashableObject[] createArray(int length) {
057    return new UnhashableObject[length];
058  }
059
060  @Override
061  public Iterable<UnhashableObject> order(List<UnhashableObject> insertionOrder) {
062    return insertionOrder;
063  }
064}