001/*
002 * Copyright (C) 2007 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.Strings;
021import java.util.List;
022import java.util.Set;
023import org.jspecify.annotations.NullMarked;
024
025/**
026 * Create string sets for collection tests.
027 *
028 * @author Kevin Bourrillion
029 */
030@GwtCompatible
031@NullMarked
032public abstract class TestStringSetGenerator implements TestSetGenerator<String> {
033  @Override
034  public SampleElements<String> samples() {
035    return new Strings();
036  }
037
038  @Override
039  public Set<String> create(Object... elements) {
040    String[] array = new String[elements.length];
041    int i = 0;
042    for (Object e : elements) {
043      array[i++] = (String) e;
044    }
045    return create(array);
046  }
047
048  protected abstract Set<String> create(String[] elements);
049
050  @Override
051  public String[] createArray(int length) {
052    return new String[length];
053  }
054
055  /**
056   * {@inheritDoc}
057   *
058   * <p>By default, returns the supplied elements in their given order; however, generators for
059   * containers with a known order other than insertion order must override this method.
060   *
061   * <p>Note: This default implementation is overkill (but valid) for an unordered container. An
062   * equally valid implementation for an unordered container is to throw an exception. The chosen
063   * implementation, however, has the advantage of working for insertion-ordered containers, as
064   * well.
065   */
066  @Override
067  public List<String> order(List<String> insertionOrder) {
068    return insertionOrder;
069  }
070}