001/* 002 * Copyright (C) 2008 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.testers; 018 019import com.google.common.annotations.GwtCompatible; 020import com.google.common.collect.testing.AbstractCollectionTester; 021import com.google.common.collect.testing.Helpers; 022import java.util.Collection; 023import java.util.List; 024import org.checkerframework.checker.nullness.qual.Nullable; 025import org.junit.Ignore; 026 027/** 028 * Base class for list testers. 029 * 030 * @author George van den Driessche 031 */ 032@GwtCompatible 033@ElementTypesAreNonnullByDefault 034@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests. 035public class AbstractListTester<E extends @Nullable Object> extends AbstractCollectionTester<E> { 036 /* 037 * Previously we had a field named list that was initialized to the value of 038 * collection in setUp(), but that caused problems when a tester changed the 039 * value of list or collection but not both. 040 */ 041 protected final List<E> getList() { 042 return (List<E>) collection; 043 } 044 045 /** 046 * {@inheritDoc} 047 * 048 * <p>The {@code AbstractListTester} implementation overrides {@link 049 * AbstractCollectionTester#expectContents(Collection)} to verify that the order of the elements 050 * in the list under test matches what is expected. 051 */ 052 @Override 053 protected void expectContents(Collection<E> expectedCollection) { 054 List<E> expectedList = Helpers.copyToList(expectedCollection); 055 // Avoid expectEquals() here to delay reason manufacture until necessary. 056 if (getList().size() != expectedList.size()) { 057 fail("size mismatch: " + reportContext(expectedList)); 058 } 059 for (int i = 0; i < expectedList.size(); i++) { 060 E expected = expectedList.get(i); 061 E actual = getList().get(i); 062 if (expected != actual && (expected == null || !expected.equals(actual))) { 063 fail("mismatch at index " + i + ": " + reportContext(expectedList)); 064 } 065 } 066 } 067 068 /** 069 * Used to delay string formatting until actually required, as it otherwise shows up in the test 070 * execution profile when running an extremely large numbers of tests. 071 */ 072 private String reportContext(List<E> expected) { 073 return Platform.format( 074 "expected collection %s; actual collection %s", expected, this.collection); 075 } 076}