Debian Codegraph @

guava-testlib/src/com/google/common/collect/testing/QueueTestSuiteBuilder.java

raw
1 /*
2 * Copyright (C) 2008 The Guava Authors
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package com.google.common.collect.testing;
18
19 import com.google.common.annotations.GwtIncompatible;
20 import com.google.common.collect.testing.testers.QueueElementTester;
21 import com.google.common.collect.testing.testers.QueueOfferTester;
22 import com.google.common.collect.testing.testers.QueuePeekTester;
23 import com.google.common.collect.testing.testers.QueuePollTester;
24 import com.google.common.collect.testing.testers.QueueRemoveTester;
25 import com.google.errorprone.annotations.CanIgnoreReturnValue;
26 import java.util.ArrayList;
27 import java.util.List;
28
29 /**
30 * Creates, based on your criteria, a JUnit test suite that exhaustively tests a queue
31 * implementation.
32 *
33 * @author Jared Levy
34 */
35 @GwtIncompatible
36 public final class QueueTestSuiteBuilder<E>
37 extends AbstractCollectionTestSuiteBuilder<QueueTestSuiteBuilder<E>, E> {
38 public static <E> QueueTestSuiteBuilder<E> using(TestQueueGenerator<E> generator) {
39 return new QueueTestSuiteBuilder<E>().usingGenerator(generator);
40 }
41
42 private boolean runCollectionTests = true;
43
44 /**
45 * Specify whether to skip the general collection tests. Call this method when testing a
46 * collection that's both a queue and a list, to avoid running the common collection tests twice.
47 * By default, collection tests do run.
48 */
49 @CanIgnoreReturnValue
50 public QueueTestSuiteBuilder<E> skipCollectionTests() {
51 runCollectionTests = false;
52 return this;
53 }
54
55 @Override
56 protected List<Class<? extends AbstractTester>> getTesters() {
57 List<Class<? extends AbstractTester>> testers = new ArrayList<>();
58 if (runCollectionTests) {
59 testers.addAll(super.getTesters());
60 }
61
62 testers.add(QueueElementTester.class);
63 testers.add(QueueOfferTester.class);
64 testers.add(QueuePeekTester.class);
65 testers.add(QueuePollTester.class);
66 testers.add(QueueRemoveTester.class);
67 return testers;
68 }
69 }