11d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2008 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.features; 181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.Helpers; 201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.lang.annotation.Inherited; 221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.lang.annotation.Retention; 231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.lang.annotation.RetentionPolicy; 241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Map; 251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Set; 261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/** 281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Optional features of classes derived from {@code Map}. 291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * <p>This class is GWT compatible. 311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author George van den Driessche 331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert// Enum values use constructors with generic varargs. 351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert@SuppressWarnings("unchecked") 361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpublic enum MapFeature implements Feature<Map> { 371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * The map does not throw {@code NullPointerException} on calls such as 391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * {@code containsKey(null)}, {@code get(null)}, or {@code remove(null)}. 401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert ALLOWS_NULL_QUERIES, 421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert ALLOWS_NULL_KEYS (ALLOWS_NULL_QUERIES), 431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert ALLOWS_NULL_VALUES, 441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert RESTRICTS_KEYS, 451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert RESTRICTS_VALUES, 461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert SUPPORTS_PUT, 471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert SUPPORTS_PUT_ALL, 481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert SUPPORTS_REMOVE, 491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert SUPPORTS_CLEAR, 501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Indicates that the constructor or factory method of a map, usually an 521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * immutable map, throws an {@link IllegalArgumentException} when presented 531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * with duplicate keys instead of discarding all but one. 541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert REJECTS_DUPLICATES_AT_CREATION, 561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert GENERAL_PURPOSE( 581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert SUPPORTS_PUT, 591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert SUPPORTS_PUT_ALL, 601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert SUPPORTS_REMOVE, 611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert SUPPORTS_CLEAR 621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert ), 631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** Features supported by maps where only removal is allowed. */ 651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert REMOVE_OPERATIONS( 661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert SUPPORTS_REMOVE, 671d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert SUPPORTS_CLEAR 681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert ); 691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private final Set<Feature<? super Map>> implied; 711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert MapFeature(Feature<? super Map> ... implied) { 731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert this.implied = Helpers.copyToSet(implied); 741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override 771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public Set<Feature<? super Map>> getImpliedFeatures() { 781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return implied; 791d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Retention(RetentionPolicy.RUNTIME) 821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Inherited 831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @TesterAnnotation 841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public @interface Require { 851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public abstract MapFeature[] value() default {}; 861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public abstract MapFeature[] absent() default {}; 871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert} 89