Coverage Summary for Class: AbstractCollectionTester (com.google.common.collect.testing)

1 /*
2  * Copyright (C) 2007 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.GwtCompatible;
20 import java.util.Collection;
21 import org.junit.Ignore;
22 
23 /**
24  * Base class for collection testers.
25  *
26  * @param <E> the element type of the collection to be tested.
27  * @author Kevin Bourrillion
28  */
29 @GwtCompatible
30 @Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
31 public abstract class AbstractCollectionTester<E>
32     extends AbstractContainerTester<Collection<E>, E> {
33 
34   // TODO: replace this with an accessor.
35   protected Collection<E> collection;
36 
37   @Override
38   protected Collection<E> actualContents() {
39     return collection;
40   }
41 
42   // TODO: dispose of this once collection is encapsulated.
43   @Override
44   protected Collection<E> resetContainer(Collection<E> newContents) {
45     collection = super.resetContainer(newContents);
46     return collection;
47   }
48 
49   /** @see AbstractContainerTester#resetContainer() */
50   protected void resetCollection() {
51     resetContainer();
52   }
53 
54   /** @return an array of the proper size with {@code null} inserted into the middle element. */
55   protected E[] createArrayWithNullElement() {
56     E[] array = createSamplesArray();
57     array[getNullLocation()] = null;
58     return array;
59   }
60 
61   protected void initCollectionWithNullElement() {
62     E[] array = createArrayWithNullElement();
63     resetContainer(getSubjectGenerator().create(array));
64   }
65 
66   /**
67    * Equivalent to {@link #expectMissing(Object[]) expectMissing}{@code (null)} except that the call
68    * to {@code contains(null)} is permitted to throw a {@code NullPointerException}.
69    *
70    * @param message message to use upon assertion failure
71    */
72   protected void expectNullMissingWhenNullUnsupported(String message) {
73     try {
74       assertFalse(message, actualContents().contains(null));
75     } catch (NullPointerException tolerated) {
76       // Tolerated
77     }
78   }
79 }