Home | History | Annotate | Download | only in testers
      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.testers;
     18 
     19 import static com.google.common.collect.testing.features.CollectionFeature.ALLOWS_NULL_VALUES;
     20 import static com.google.common.collect.testing.features.CollectionFeature.SUPPORTS_ADD;
     21 import static com.google.common.collect.testing.features.CollectionSize.ZERO;
     22 
     23 import com.google.common.collect.testing.Helpers;
     24 import com.google.common.collect.testing.features.CollectionFeature;
     25 import com.google.common.collect.testing.features.CollectionSize;
     26 
     27 import java.lang.reflect.Method;
     28 import java.util.List;
     29 
     30 /**
     31  * A generic JUnit test which tests {@code add(Object)} operations on a list.
     32  * Can't be invoked directly; please see
     33  * {@link com.google.common.collect.testing.ListTestSuiteBuilder}.
     34  *
     35  * <p>This class is GWT compatible.
     36  *
     37  * @author Chris Povirk
     38  */
     39 @SuppressWarnings("unchecked") // too many "unchecked generic array creations"
     40 public class ListAddTester<E> extends AbstractListTester<E> {
     41   @CollectionFeature.Require(SUPPORTS_ADD)
     42   @CollectionSize.Require(absent = ZERO)
     43   public void testAdd_supportedPresent() {
     44     assertTrue("add(present) should return true", getList().add(samples.e0));
     45     expectAdded(samples.e0);
     46   }
     47 
     48   @CollectionFeature.Require(absent = SUPPORTS_ADD)
     49   @CollectionSize.Require(absent = ZERO)
     50   /*
     51    * absent = ZERO isn't required, since unmodList.add() must
     52    * throw regardless, but it keeps the method name accurate.
     53    */
     54   public void testAdd_unsupportedPresent() {
     55     try {
     56       getList().add(samples.e0);
     57       fail("add(present) should throw");
     58     } catch (UnsupportedOperationException expected) {
     59     }
     60   }
     61 
     62   @CollectionFeature.Require(value = {SUPPORTS_ADD, ALLOWS_NULL_VALUES})
     63   @CollectionSize.Require(absent = ZERO)
     64   public void testAdd_supportedNullPresent() {
     65     E[] array = createArrayWithNullElement();
     66     collection = getSubjectGenerator().create(array);
     67     assertTrue("add(nullPresent) should return true", getList().add(null));
     68 
     69     List<E> expected = Helpers.copyToList(array);
     70     expected.add(null);
     71     expectContents(expected);
     72   }
     73 
     74   /**
     75    * Returns the {@link Method} instance for
     76    * {@link #testAdd_supportedNullPresent()} so that tests can suppress it. See
     77    * {@link CollectionAddTester#getAddNullSupportedMethod()} for details.
     78    */
     79   public static Method getAddSupportedNullPresentMethod() {
     80     return Platform.getMethod(ListAddTester.class, "testAdd_supportedNullPresent");
     81   }
     82 }
     83