2
* Copyright (C) 2010 The Guava Authors
4
* Licensed under the Apache License, Version 2.0 (the "License");
5
* you may not use this file except in compliance with the License.
6
* You may obtain a copy of the License at
8
* http://www.apache.org/licenses/LICENSE-2.0
10
* Unless required by applicable law or agreed to in writing, software
11
* distributed under the License is distributed on an "AS IS" BASIS,
12
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
* See the License for the specific language governing permissions and
14
* limitations under the License.
17
package com.google.common.collect.testing;
19
import com.google.common.annotations.GwtIncompatible;
20
import com.google.errorprone.annotations.CanIgnoreReturnValue;
21
import java.io.Serializable;
22
import java.util.Collection;
23
import java.util.Comparator;
24
import java.util.Iterator;
25
import java.util.NavigableSet;
26
import java.util.SortedSet;
27
import java.util.TreeSet;
28
import org.checkerframework.checker.nullness.qual.Nullable;
31
* A wrapper around {@code TreeSet} that aggressively checks to see if elements are mutually
32
* comparable. This implementation passes the navigable set test suites.
34
* @author Louis Wasserman
37
public final class SafeTreeSet<E> implements Serializable, NavigableSet<E> {
38
@SuppressWarnings("unchecked")
39
private static final Comparator<Object> NATURAL_ORDER =
40
new Comparator<Object>() {
42
public int compare(Object o1, Object o2) {
43
return ((Comparable<Object>) o1).compareTo(o2);
47
private final NavigableSet<E> delegate;
49
public SafeTreeSet() {
50
this(new TreeSet<E>());
53
public SafeTreeSet(Collection<? extends E> collection) {
54
this(new TreeSet<E>(collection));
57
public SafeTreeSet(Comparator<? super E> comparator) {
58
this(new TreeSet<E>(comparator));
61
public SafeTreeSet(SortedSet<E> set) {
62
this(new TreeSet<E>(set));
65
private SafeTreeSet(NavigableSet<E> delegate) {
66
this.delegate = delegate;
73
public boolean add(E element) {
74
return delegate.add(checkValid(element));
78
public boolean addAll(Collection<? extends E> collection) {
79
for (E e : collection) {
82
return delegate.addAll(collection);
86
public @Nullable E ceiling(E e) {
87
return delegate.ceiling(checkValid(e));
96
public Comparator<? super E> comparator() {
97
Comparator<? super E> comparator = delegate.comparator();
98
if (comparator == null) {
99
comparator = (Comparator<? super E>) NATURAL_ORDER;
105
public boolean contains(Object object) {
106
return delegate.contains(checkValid(object));
110
public boolean containsAll(Collection<?> c) {
111
return delegate.containsAll(c);
115
public Iterator<E> descendingIterator() {
116
return delegate.descendingIterator();
120
public NavigableSet<E> descendingSet() {
121
return new SafeTreeSet<>(delegate.descendingSet());
126
return delegate.first();
130
public @Nullable E floor(E e) {
131
return delegate.floor(checkValid(e));
135
public SortedSet<E> headSet(E toElement) {
136
return headSet(toElement, false);
140
public NavigableSet<E> headSet(E toElement, boolean inclusive) {
141
return new SafeTreeSet<>(delegate.headSet(checkValid(toElement), inclusive));
145
public @Nullable E higher(E e) {
146
return delegate.higher(checkValid(e));
150
public boolean isEmpty() {
151
return delegate.isEmpty();
155
public Iterator<E> iterator() {
156
return delegate.iterator();
161
return delegate.last();
165
public @Nullable E lower(E e) {
166
return delegate.lower(checkValid(e));
170
public @Nullable E pollFirst() {
171
return delegate.pollFirst();
175
public @Nullable E pollLast() {
176
return delegate.pollLast();
180
public boolean remove(Object object) {
181
return delegate.remove(checkValid(object));
185
public boolean removeAll(Collection<?> c) {
186
return delegate.removeAll(c);
190
public boolean retainAll(Collection<?> c) {
191
return delegate.retainAll(c);
196
return delegate.size();
200
public NavigableSet<E> subSet(
201
E fromElement, boolean fromInclusive, E toElement, boolean toInclusive) {
202
return new SafeTreeSet<>(
204
checkValid(fromElement), fromInclusive, checkValid(toElement), toInclusive));
208
public SortedSet<E> subSet(E fromElement, E toElement) {
209
return subSet(fromElement, true, toElement, false);
213
public SortedSet<E> tailSet(E fromElement) {
214
return tailSet(fromElement, true);
218
public NavigableSet<E> tailSet(E fromElement, boolean inclusive) {
219
return new SafeTreeSet<>(delegate.tailSet(checkValid(fromElement), inclusive));
223
public Object[] toArray() {
224
return delegate.toArray();
228
public <T> T[] toArray(T[] a) {
229
return delegate.toArray(a);
232
@CanIgnoreReturnValue
233
private <T> T checkValid(T t) {
234
// a ClassCastException is what's supposed to happen!
235
@SuppressWarnings("unchecked")
237
int unused = comparator().compare(e, e);
242
public boolean equals(@Nullable Object obj) {
243
return delegate.equals(obj);
247
public int hashCode() {
248
return delegate.hashCode();
252
public String toString() {
253
return delegate.toString();
256
private static final long serialVersionUID = 0L;