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