11d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2007 The Guava Authors 31d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 41d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Licensed under the Apache License, Version 2.0 (the "License"); 51d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * you may not use this file except in compliance with the License. 61d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * You may obtain a copy of the License at 71d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 81d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * http://www.apache.org/licenses/LICENSE-2.0 91d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Unless required by applicable law or agreed to in writing, software 111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * distributed under the License is distributed on an "AS IS" BASIS, 121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See the License for the specific language governing permissions and 141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * limitations under the License. 151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpackage com.google.common.collect.testing; 181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 197dd252788645e940eada959bdde927426e2531c9Paul Duffinimport com.google.common.annotations.GwtCompatible; 207dd252788645e940eada959bdde927426e2531c9Paul Duffin 211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.AbstractCollection; 221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Arrays; 231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Collection; 241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Iterator; 251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/** 271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * A simplistic collection which implements only the bare minimum allowed by the 281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * spec, and throws exceptions whenever it can. 291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author Kevin Bourrillion 311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 327dd252788645e940eada959bdde927426e2531c9Paul Duffin@GwtCompatible 331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpublic class MinimalCollection<E> extends AbstractCollection<E> { 341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // TODO: expose allow nulls parameter? 351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public static <E> MinimalCollection<E> of(E... contents) { 371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return new MinimalCollection<E>(Object.class, true, contents); 381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // TODO: use this 411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public static <E> MinimalCollection<E> ofClassAndContents( 421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Class<? super E> type, E... contents) { 431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return new MinimalCollection<E>(type, true, contents); 441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private final E[] contents; 471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private final Class<? super E> type; 481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private final boolean allowNulls; 491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // Package-private so that it can be extended. 511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert MinimalCollection(Class<? super E> type, boolean allowNulls, E... contents) { 521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // TODO: consider making it shuffle the contents to test iteration order. 531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert this.contents = Platform.clone(contents); 541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert this.type = type; 551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert this.allowNulls = allowNulls; 561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (!allowNulls) { 581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert for (Object element : contents) { 591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (element == null) { 601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert throw new NullPointerException(); 611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public int size() { 671d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return contents.length; 681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public boolean contains(Object object) { 711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (!allowNulls) { 721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // behave badly 731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (object == null) { 741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert throw new NullPointerException(); 751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Platform.checkCast(type, object); // behave badly 781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return Arrays.asList(contents).contains(object); 791d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public boolean containsAll(Collection<?> collection) { 821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (!allowNulls) { 831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert for (Object object : collection) { 841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // behave badly 851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (object == null) { 861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert throw new NullPointerException(); 871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 891d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 901d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return super.containsAll(collection); 911d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 921d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 931d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public Iterator<E> iterator() { 941d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return Arrays.asList(contents).iterator(); 951d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 961d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 971d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public Object[] toArray() { 981d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Object[] result = new Object[contents.length]; 997dd252788645e940eada959bdde927426e2531c9Paul Duffin System.arraycopy(contents, 0, result, 0, contents.length); 1001d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return result; 1011d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1021d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1031d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /* 1041d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * a "type A" unmodifiable collection freaks out proactively, even if there 1051d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * wasn't going to be any actual work to do anyway 1061d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 1071d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1081d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public boolean addAll(Collection<? extends E> elementsToAdd) { 1091d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert throw up(); 1101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public boolean removeAll(Collection<?> elementsToRemove) { 1121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert throw up(); 1131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public boolean retainAll(Collection<?> elementsToRetain) { 1151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert throw up(); 1161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public void clear() { 1181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert throw up(); 1191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private static UnsupportedOperationException up() { 1211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert throw new UnsupportedOperationException(); 1221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert} 124