com.google.common.collect.AbstractNavigableMap Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* Copyright (C) 2012 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 com.google.common.annotations.GwtIncompatible;
import com.google.common.collect.Maps.IteratorBasedAbstractMap;
import java.util.Iterator;
import java.util.NavigableMap;
import java.util.NavigableSet;
import java.util.NoSuchElementException;
import java.util.Set;
import java.util.SortedMap;
import javax.annotation.CheckForNull;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* Skeletal implementation of {@link NavigableMap}.
*
* @author Louis Wasserman
*/
@GwtIncompatible
@ElementTypesAreNonnullByDefault
abstract class AbstractNavigableMap
extends IteratorBasedAbstractMap implements NavigableMap {
@Override
@CheckForNull
public abstract V get(@CheckForNull Object key);
@Override
@CheckForNull
public Entry firstEntry() {
return Iterators.getNext(entryIterator(), null);
}
@Override
@CheckForNull
public Entry lastEntry() {
return Iterators.getNext(descendingEntryIterator(), null);
}
@Override
@CheckForNull
public Entry pollFirstEntry() {
return Iterators.pollNext(entryIterator());
}
@Override
@CheckForNull
public Entry pollLastEntry() {
return Iterators.pollNext(descendingEntryIterator());
}
@Override
@ParametricNullness
public K firstKey() {
Entry entry = firstEntry();
if (entry == null) {
throw new NoSuchElementException();
} else {
return entry.getKey();
}
}
@Override
@ParametricNullness
public K lastKey() {
Entry entry = lastEntry();
if (entry == null) {
throw new NoSuchElementException();
} else {
return entry.getKey();
}
}
@Override
@CheckForNull
public Entry lowerEntry(@ParametricNullness K key) {
return headMap(key, false).lastEntry();
}
@Override
@CheckForNull
public Entry floorEntry(@ParametricNullness K key) {
return headMap(key, true).lastEntry();
}
@Override
@CheckForNull
public Entry ceilingEntry(@ParametricNullness K key) {
return tailMap(key, true).firstEntry();
}
@Override
@CheckForNull
public Entry higherEntry(@ParametricNullness K key) {
return tailMap(key, false).firstEntry();
}
@Override
@CheckForNull
public K lowerKey(@ParametricNullness K key) {
return Maps.keyOrNull(lowerEntry(key));
}
@Override
@CheckForNull
public K floorKey(@ParametricNullness K key) {
return Maps.keyOrNull(floorEntry(key));
}
@Override
@CheckForNull
public K ceilingKey(@ParametricNullness K key) {
return Maps.keyOrNull(ceilingEntry(key));
}
@Override
@CheckForNull
public K higherKey(@ParametricNullness K key) {
return Maps.keyOrNull(higherEntry(key));
}
abstract Iterator> descendingEntryIterator();
@Override
public SortedMap subMap(@ParametricNullness K fromKey, @ParametricNullness K toKey) {
return subMap(fromKey, true, toKey, false);
}
@Override
public SortedMap headMap(@ParametricNullness K toKey) {
return headMap(toKey, false);
}
@Override
public SortedMap tailMap(@ParametricNullness K fromKey) {
return tailMap(fromKey, true);
}
@Override
public NavigableSet navigableKeySet() {
return new Maps.NavigableKeySet<>(this);
}
@Override
public Set keySet() {
return navigableKeySet();
}
@Override
public NavigableSet descendingKeySet() {
return descendingMap().navigableKeySet();
}
@Override
public NavigableMap descendingMap() {
return new DescendingMap();
}
private final class DescendingMap extends Maps.DescendingMap {
@Override
NavigableMap forward() {
return AbstractNavigableMap.this;
}
@Override
Iterator> entryIterator() {
return descendingEntryIterator();
}
}
}