com.google.common.collect.ForwardingSortedSet Maven / Gradle / Ivy
Show all versions of guava Show documentation
/*
* 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.collect.ForwardingSortedMap.unsafeCompare;
import com.google.common.annotations.GwtCompatible;
import java.util.Comparator;
import java.util.Iterator;
import java.util.NoSuchElementException;
import java.util.SortedSet;
import javax.annotation.CheckForNull;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* A sorted set which forwards all its method calls to another sorted set. Subclasses should
* override one or more methods to modify the behavior of the backing sorted set as desired per the
* decorator pattern.
*
* Warning: The methods of {@code ForwardingSortedSet} forward indiscriminately to
* the methods of the delegate. For example, overriding {@link #add} alone will not change
* the behavior of {@link #addAll}, which can lead to unexpected behavior. In this case, you should
* override {@code addAll} as well, either providing your own implementation, or delegating to the
* provided {@code standardAddAll} method.
*
*
{@code default} method warning: This class does not forward calls to {@code
* default} methods. Instead, it inherits their default implementations. When those implementations
* invoke methods, they invoke methods on the {@code ForwardingSortedSet}.
*
*
Each of the {@code standard} methods, where appropriate, uses the set's comparator (or the
* natural ordering of the elements, if there is no comparator) to test element equality. As a
* result, if the comparator is not consistent with equals, some of the standard implementations may
* violate the {@code Set} contract.
*
*
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 ForwardingSortedSet extends ForwardingSet
implements SortedSet {
/** Constructor for use by subclasses. */
protected ForwardingSortedSet() {}
@Override
protected abstract SortedSet delegate();
@Override
@CheckForNull
public Comparator comparator() {
return delegate().comparator();
}
@Override
@ParametricNullness
public E first() {
return delegate().first();
}
@Override
public SortedSet headSet(@ParametricNullness E toElement) {
return delegate().headSet(toElement);
}
@Override
@ParametricNullness
public E last() {
return delegate().last();
}
@Override
public SortedSet subSet(@ParametricNullness E fromElement, @ParametricNullness E toElement) {
return delegate().subSet(fromElement, toElement);
}
@Override
public SortedSet tailSet(@ParametricNullness E fromElement) {
return delegate().tailSet(fromElement);
}
/**
* A sensible definition of {@link #contains} in terms of the {@code first()} method of {@link
* #tailSet}. If you override {@link #tailSet}, you may wish to override {@link #contains} to
* forward to this implementation.
*
* @since 7.0
*/
@Override
protected boolean standardContains(@CheckForNull Object object) {
try {
// any ClassCastExceptions and NullPointerExceptions are caught
@SuppressWarnings({"unchecked", "nullness"})
SortedSet<@Nullable Object> self = (SortedSet<@Nullable Object>) this;
Object ceiling = self.tailSet(object).first();
return unsafeCompare(comparator(), ceiling, object) == 0;
} catch (ClassCastException | NoSuchElementException | NullPointerException e) {
return false;
}
}
/**
* A sensible definition of {@link #remove} in terms of the {@code iterator()} method of {@link
* #tailSet}. If you override {@link #tailSet}, you may wish to override {@link #remove} to
* forward to this implementation.
*
* @since 7.0
*/
@Override
protected boolean standardRemove(@CheckForNull Object object) {
try {
// any ClassCastExceptions and NullPointerExceptions are caught
@SuppressWarnings({"unchecked", "nullness"})
SortedSet<@Nullable Object> self = (SortedSet<@Nullable Object>) this;
Iterator iterator = self.tailSet(object).iterator();
if (iterator.hasNext()) {
Object ceiling = iterator.next();
if (unsafeCompare(comparator(), ceiling, object) == 0) {
iterator.remove();
return true;
}
}
} catch (ClassCastException | NullPointerException e) {
return false;
}
return false;
}
/**
* A sensible default implementation of {@link #subSet(Object, Object)} in terms of {@link
* #headSet(Object)} and {@link #tailSet(Object)}. In some situations, you may wish to override
* {@link #subSet(Object, Object)} to forward to this implementation.
*
* @since 7.0
*/
protected SortedSet standardSubSet(
@ParametricNullness E fromElement, @ParametricNullness E toElement) {
return tailSet(fromElement).headSet(toElement);
}
}