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