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.Helpers.getMethod;
020import static com.google.common.collect.testing.features.CollectionFeature.ALLOWS_NULL_VALUES;
021import static com.google.common.collect.testing.features.CollectionFeature.SUPPORTS_ADD;
022import static com.google.common.collect.testing.features.CollectionSize.ZERO;
023
024import com.google.common.annotations.GwtCompatible;
025import com.google.common.annotations.GwtIncompatible;
026import com.google.common.annotations.J2ktIncompatible;
027import com.google.common.collect.testing.features.CollectionFeature;
028import com.google.common.collect.testing.features.CollectionSize;
029import java.lang.reflect.Method;
030
031/**
032 * A generic JUnit test which tests add operations on a set. Can't be invoked directly; please see
033 * {@link com.google.common.collect.testing.SetTestSuiteBuilder}.
034 *
035 * @author Kevin Bourrillion
036 */
037@GwtCompatible
038public class SetAddTester<E> extends AbstractSetTester<E> {
039  @CollectionFeature.Require(SUPPORTS_ADD)
040  @CollectionSize.Require(absent = ZERO)
041  public void testAdd_supportedPresent() {
042    assertFalse("add(present) should return false", getSet().add(e0()));
043    expectUnchanged();
044  }
045
046  @CollectionFeature.Require(value = {SUPPORTS_ADD, ALLOWS_NULL_VALUES})
047  @CollectionSize.Require(absent = ZERO)
048  public void testAdd_supportedNullPresent() {
049    E[] array = createArrayWithNullElement();
050    collection = getSubjectGenerator().create(array);
051    assertFalse("add(nullPresent) should return false", getSet().add(null));
052    expectContents(array);
053  }
054
055  /**
056   * Returns the {@link Method} instance for {@link #testAdd_supportedNullPresent()} so that tests
057   * can suppress it. See {@link CollectionAddTester#getAddNullSupportedMethod()} for details.
058   */
059  @J2ktIncompatible
060  @GwtIncompatible // reflection
061  public static Method getAddSupportedNullPresentMethod() {
062    return getMethod(SetAddTester.class, "testAdd_supportedNullPresent");
063  }
064}