001/*
002 * Copyright (C) 2007 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 static com.google.common.collect.testing.features.CollectionFeature.ALLOWS_NULL_VALUES;
020import static com.google.common.collect.testing.features.CollectionSize.ZERO;
021
022import com.google.common.annotations.GwtCompatible;
023import com.google.common.collect.testing.WrongType;
024import com.google.common.collect.testing.features.CollectionFeature;
025import com.google.common.collect.testing.features.CollectionSize;
026import org.checkerframework.checker.nullness.qual.Nullable;
027import org.junit.Ignore;
028
029/**
030 * Common parent class for {@link ListIndexOfTester} and {@link ListLastIndexOfTester}.
031 *
032 * @author Chris Povirk
033 */
034@GwtCompatible
035@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
036@SuppressWarnings("JUnit4ClassUsedInJUnit3")
037public abstract class AbstractListIndexOfTester<E> extends AbstractListTester<E> {
038  /** Override to call {@code indexOf()} or {@code lastIndexOf()}. */
039  protected abstract int find(@Nullable Object o);
040
041  /** Override to return "indexOf" or "lastIndexOf()" for use in failure messages. */
042  protected abstract String getMethodName();
043
044  @CollectionSize.Require(absent = ZERO)
045  public void testFind_yes() {
046    assertEquals(
047        getMethodName() + "(firstElement) should return 0", 0, find(getOrderedElements().get(0)));
048  }
049
050  public void testFind_no() {
051    assertEquals(getMethodName() + "(notPresent) should return -1", -1, find(e3()));
052  }
053
054  @CollectionFeature.Require(ALLOWS_NULL_VALUES)
055  public void testFind_nullNotContainedButSupported() {
056    assertEquals(getMethodName() + "(nullNotPresent) should return -1", -1, find(null));
057  }
058
059  @CollectionFeature.Require(absent = ALLOWS_NULL_VALUES)
060  public void testFind_nullNotContainedAndUnsupported() {
061    try {
062      assertEquals(getMethodName() + "(nullNotPresent) should return -1 or throw", -1, find(null));
063    } catch (NullPointerException tolerated) {
064    }
065  }
066
067  @CollectionFeature.Require(ALLOWS_NULL_VALUES)
068  @CollectionSize.Require(absent = ZERO)
069  public void testFind_nonNullWhenNullContained() {
070    initCollectionWithNullElement();
071    assertEquals(getMethodName() + "(notPresent) should return -1", -1, find(e3()));
072  }
073
074  @CollectionFeature.Require(ALLOWS_NULL_VALUES)
075  @CollectionSize.Require(absent = ZERO)
076  public void testFind_nullContained() {
077    initCollectionWithNullElement();
078    assertEquals(
079        getMethodName() + "(null) should return " + getNullLocation(),
080        getNullLocation(),
081        find(null));
082  }
083
084  public void testFind_wrongType() {
085    try {
086      assertEquals(
087          getMethodName() + "(wrongType) should return -1 or throw", -1, find(WrongType.VALUE));
088    } catch (ClassCastException tolerated) {
089    }
090  }
091}