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.
036public abstract class AbstractListIndexOfTester<E> extends AbstractListTester<E> {
037  /** Override to call {@code indexOf()} or {@code lastIndexOf()}. */
038  protected abstract int find(@Nullable Object o);
039
040  /** Override to return "indexOf" or "lastIndexOf()" for use in failure messages. */
041  protected abstract String getMethodName();
042
043  @CollectionSize.Require(absent = ZERO)
044  public void testFind_yes() {
045    assertEquals(
046        getMethodName() + "(firstElement) should return 0", 0, find(getOrderedElements().get(0)));
047  }
048
049  public void testFind_no() {
050    assertEquals(getMethodName() + "(notPresent) should return -1", -1, find(e3()));
051  }
052
053  @CollectionFeature.Require(ALLOWS_NULL_VALUES)
054  public void testFind_nullNotContainedButSupported() {
055    assertEquals(getMethodName() + "(nullNotPresent) should return -1", -1, find(null));
056  }
057
058  @CollectionFeature.Require(absent = ALLOWS_NULL_VALUES)
059  public void testFind_nullNotContainedAndUnsupported() {
060    try {
061      assertEquals(getMethodName() + "(nullNotPresent) should return -1 or throw", -1, find(null));
062    } catch (NullPointerException tolerated) {
063    }
064  }
065
066  @CollectionFeature.Require(ALLOWS_NULL_VALUES)
067  @CollectionSize.Require(absent = ZERO)
068  public void testFind_nonNullWhenNullContained() {
069    initCollectionWithNullElement();
070    assertEquals(getMethodName() + "(notPresent) should return -1", -1, find(e3()));
071  }
072
073  @CollectionFeature.Require(ALLOWS_NULL_VALUES)
074  @CollectionSize.Require(absent = ZERO)
075  public void testFind_nullContained() {
076    initCollectionWithNullElement();
077    assertEquals(
078        getMethodName() + "(null) should return " + getNullLocation(),
079        getNullLocation(),
080        find(null));
081  }
082
083  public void testFind_wrongType() {
084    try {
085      assertEquals(
086          getMethodName() + "(wrongType) should return -1 or throw", -1, find(WrongType.VALUE));
087    } catch (ClassCastException tolerated) {
088    }
089  }
090}