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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/*
* Copyright (C) 2007 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;
import static com.google.common.base.Preconditions.checkArgument;
import com.google.common.annotations.GwtCompatible;
import java.util.Comparator;
import java.util.NoSuchElementException;
import java.util.SortedMap;
import javax.annotation.CheckForNull;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* A sorted map which forwards all its method calls to another sorted map. Subclasses should
* override one or more methods to modify the behavior of the backing sorted map as desired per the
* <a href="http://en.wikipedia.org/wiki/Decorator_pattern">decorator pattern</a>.
*
* <p><b>Warning:</b> The methods of {@code ForwardingSortedMap} forward <i>indiscriminately</i> to
* the methods of the delegate. For example, overriding {@link #put} alone <i>will not</i> change
* the behavior of {@link #putAll}, which can lead to unexpected behavior. In this case, you should
* override {@code putAll} as well, either providing your own implementation, or delegating to the
* provided {@code standardPutAll} method.
*
* <p><b>{@code default} method warning:</b> This class does <i>not</i> forward calls to {@code
* default} methods. Instead, it inherits their default implementations. When those implementations
* invoke methods, they invoke methods on the {@code ForwardingSortedMap}.
*
* <p>Each of the {@code standard} methods, where appropriate, use the comparator of the map to test
* equality for both keys and values, unlike {@code ForwardingMap}.
*
* <p>The {@code standard} methods and the collection views they return are not guaranteed to be
* thread-safe, even when all of the methods that they depend on are thread-safe.
*
* @author Mike Bostock
* @author Louis Wasserman
* @since 2.0
*/
@GwtCompatible
@ElementTypesAreNonnullByDefault
public abstract class ForwardingSortedMap<K extends @Nullable Object, V extends @Nullable Object>
extends ForwardingMap<K, V> implements SortedMap<K, V> {
// TODO(lowasser): identify places where thread safety is actually lost
/** Constructor for use by subclasses. */
protected ForwardingSortedMap() {}
@Override
protected abstract SortedMap<K, V> delegate();
@Override
@CheckForNull
public Comparator<? super K> comparator() {
return delegate().comparator();
}
@Override
@ParametricNullness
public K firstKey() {
return delegate().firstKey();
}
@Override
public SortedMap<K, V> headMap(@ParametricNullness K toKey) {
return delegate().headMap(toKey);
}
@Override
@ParametricNullness
public K lastKey() {
return delegate().lastKey();
}
@Override
public SortedMap<K, V> subMap(@ParametricNullness K fromKey, @ParametricNullness K toKey) {
return delegate().subMap(fromKey, toKey);
}
@Override
public SortedMap<K, V> tailMap(@ParametricNullness K fromKey) {
return delegate().tailMap(fromKey);
}
/**
* A sensible implementation of {@link SortedMap#keySet} in terms of the methods of {@code
* ForwardingSortedMap}. In many cases, you may wish to override {@link
* ForwardingSortedMap#keySet} to forward to this implementation or a subclass thereof.
*
* @since 15.0
*/
protected class StandardKeySet extends Maps.SortedKeySet<K, V> {
/** Constructor for use by subclasses. */
public StandardKeySet() {
super(ForwardingSortedMap.this);
}
}
// unsafe, but worst case is a CCE or NPE is thrown, which callers will be expecting
@SuppressWarnings({"unchecked", "nullness"})
static int unsafeCompare(
@CheckForNull Comparator<?> comparator, @CheckForNull Object o1, @CheckForNull Object o2) {
if (comparator == null) {
return ((Comparable<@Nullable Object>) o1).compareTo(o2);
} else {
return ((Comparator<@Nullable Object>) comparator).compare(o1, o2);
}
}
/**
* A sensible definition of {@link #containsKey} in terms of the {@code firstKey()} method of
* {@link #tailMap}. If you override {@link #tailMap}, you may wish to override {@link
* #containsKey} to forward to this implementation.
*
* @since 7.0
*/
@Override
protected boolean standardContainsKey(@CheckForNull Object key) {
try {
// any CCE or NPE will be caught
@SuppressWarnings({"unchecked", "nullness"})
SortedMap<@Nullable Object, V> self = (SortedMap<@Nullable Object, V>) this;
Object ceilingKey = self.tailMap(key).firstKey();
return unsafeCompare(comparator(), ceilingKey, key) == 0;
} catch (ClassCastException | NoSuchElementException | NullPointerException e) {
return false;
}
}
/**
* A sensible default implementation of {@link #subMap(Object, Object)} in terms of {@link
* #headMap(Object)} and {@link #tailMap(Object)}. In some situations, you may wish to override
* {@link #subMap(Object, Object)} to forward to this implementation.
*
* @since 7.0
*/
protected SortedMap<K, V> standardSubMap(K fromKey, K toKey) {
checkArgument(unsafeCompare(comparator(), fromKey, toKey) <= 0, "fromKey must be <= toKey");
return tailMap(fromKey).headMap(toKey);
}
}
|
