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