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