001/*
002 * Copyright (C) 2008 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 static java.util.Collections.sort;
020
021import com.google.common.annotations.GwtCompatible;
022import java.util.List;
023import java.util.SortedSet;
024import org.jspecify.annotations.NullMarked;
025
026/**
027 * Create integer sets for testing collections that are sorted by natural ordering.
028 *
029 * @author Chris Povirk
030 * @author Jared Levy
031 */
032@GwtCompatible
033@NullMarked
034public abstract class TestIntegerSortedSetGenerator extends TestIntegerSetGenerator {
035  @Override
036  protected abstract SortedSet<Integer> create(Integer[] elements);
037
038  /** Sorts the elements by their natural ordering. */
039  /*
040   * While the current implementation returns `this`, that's not something we mean to guarantee.
041   * Callers of TestContainerGenerator.order need to be prepared for implementations to return a new
042   * collection.
043   */
044  @SuppressWarnings("CanIgnoreReturnValueSuggester")
045  @Override
046  public List<Integer> order(List<Integer> insertionOrder) {
047    sort(insertionOrder);
048    return insertionOrder;
049  }
050}