-
Notifications
You must be signed in to change notification settings - Fork 10.8k
/
MapFeature.java
94 lines (85 loc) · 3.03 KB
/
MapFeature.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/*
* Copyright (C) 2008 The Guava Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.common.collect.testing.features;
import com.google.common.annotations.GwtCompatible;
import com.google.common.collect.testing.Helpers;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.Map;
import java.util.Set;
/**
* Optional features of classes derived from {@code Map}.
*
* @author George van den Driessche
*/
@SuppressWarnings("rawtypes") // maybe avoidable if we rework the whole package?
@GwtCompatible
public enum MapFeature implements Feature<Map> {
/**
* The map does not throw {@code NullPointerException} on calls such as {@code containsKey(null)},
* {@code get(null)}, {@code keySet().contains(null)} or {@code remove(null)}.
*/
ALLOWS_NULL_KEY_QUERIES,
ALLOWS_NULL_KEYS(ALLOWS_NULL_KEY_QUERIES),
/**
* The map does not throw {@code NullPointerException} on calls such as {@code
* containsValue(null)}, {@code values().contains(null)} or {@code values().remove(null)}.
*/
ALLOWS_NULL_VALUE_QUERIES,
ALLOWS_NULL_VALUES(ALLOWS_NULL_VALUE_QUERIES),
/**
* The map does not throw {@code NullPointerException} on calls such as {@code
* entrySet().contains(null)} or {@code entrySet().remove(null)}
*/
ALLOWS_NULL_ENTRY_QUERIES,
/**
* The map does not throw {@code NullPointerException} on any {@code null} queries.
*
* @see #ALLOWS_NULL_KEY_QUERIES
* @see #ALLOWS_NULL_VALUE_QUERIES
* @see #ALLOWS_NULL_ENTRY_QUERIES
*/
ALLOWS_ANY_NULL_QUERIES(
ALLOWS_NULL_ENTRY_QUERIES, ALLOWS_NULL_KEY_QUERIES, ALLOWS_NULL_VALUE_QUERIES),
RESTRICTS_KEYS,
RESTRICTS_VALUES,
SUPPORTS_PUT,
SUPPORTS_REMOVE,
FAILS_FAST_ON_CONCURRENT_MODIFICATION,
/**
* Indicates that the constructor or factory method of a map, usually an immutable map, throws an
* {@link IllegalArgumentException} when presented with duplicate keys instead of discarding all
* but one.
*/
REJECTS_DUPLICATES_AT_CREATION,
GENERAL_PURPOSE(SUPPORTS_PUT, SUPPORTS_REMOVE);
private final Set<Feature<? super Map>> implied;
MapFeature(Feature<? super Map>... implied) {
this.implied = Helpers.copyToSet(implied);
}
@Override
public Set<Feature<? super Map>> getImpliedFeatures() {
return implied;
}
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@TesterAnnotation
public @interface Require {
public abstract MapFeature[] value() default {};
public abstract MapFeature[] absent() default {};
}
}