001/*
002 * Copyright (C) 2013 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 java.util.SortedSet;
021import org.jspecify.annotations.NullMarked;
022import org.jspecify.annotations.Nullable;
023
024/**
025 * Creates sorted sets, containing sample elements, to be tested.
026 *
027 * @author Louis Wasserman
028 */
029@GwtCompatible
030@NullMarked
031public interface TestSortedSetGenerator<E extends @Nullable Object> extends TestSetGenerator<E> {
032  @Override
033  SortedSet<E> create(Object... elements);
034
035  /**
036   * Returns an element less than the {@link #samples()} and less than {@link
037   * #belowSamplesGreater()}.
038   */
039  E belowSamplesLesser();
040
041  /**
042   * Returns an element less than the {@link #samples()} but greater than {@link
043   * #belowSamplesLesser()}.
044   */
045  E belowSamplesGreater();
046
047  /**
048   * Returns an element greater than the {@link #samples()} but less than {@link
049   * #aboveSamplesGreater()}.
050   */
051  E aboveSamplesLesser();
052
053  /**
054   * Returns an element greater than the {@link #samples()} and greater than {@link
055   * #aboveSamplesLesser()}.
056   */
057  E aboveSamplesGreater();
058}