001/*
002 * Copyright (C) 2012 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.collect;
018
019import com.google.common.annotations.Beta;
020
021import java.util.Map;
022
023import javax.annotation.Nullable;
024
025/**
026 * A mapping from disjoint nonempty ranges to non-null values. Queries look up the value
027 * associated with the range (if any) that contains a specified key.
028 *
029 * <p>In contrast to {@link RangeSet}, no "coalescing" is done of {@linkplain
030 * Range#isConnected(Range) connected} ranges, even if they are mapped to the same value.
031 *
032 * @author Louis Wasserman
033 * @since 14.0
034 */
035@Beta
036public interface RangeMap<K extends Comparable, V> {
037  /**
038   * Returns the value associated with the specified key, or {@code null} if there is no
039   * such value.
040   *
041   * <p>Specifically, if any range in this range map contains the specified key, the value
042   * associated with that range is returned.
043   */
044  @Nullable
045  V get(K key);
046
047  /**
048   * Returns the range containing this key and its associated value, if such a range is present
049   * in the range map, or {@code null} otherwise.
050   */
051  @Nullable
052  Map.Entry<Range<K>, V> getEntry(K key);
053
054  /**
055   * Returns the minimal range {@linkplain Range#encloses(Range) enclosing} the ranges
056   * in this {@code RangeMap}.
057   *
058   * @throws NoSuchElementException if this range map is empty
059   */
060  Range<K> span();
061
062  /**
063   * Maps a range to a specified value (optional operation).
064   *
065   * <p>Specifically, after a call to {@code put(range, value)}, if
066   * {@link Range#contains(Comparable) range.contains(k)}, then {@link #get(Comparable) get(k)}
067   * will return {@code value}.
068   *
069   * <p>If {@code range} {@linkplain Range#isEmpty() is empty}, then this is a no-op.
070   */
071  void put(Range<K> range, V value);
072
073  /**
074   * Puts all the associations from {@code rangeMap} into this range map (optional operation).
075   */
076  void putAll(RangeMap<K, V> rangeMap);
077
078  /**
079   * Removes all associations from this range map (optional operation).
080   */
081  void clear();
082
083  /**
084   * Removes all associations from this range map in the specified range (optional operation).
085   *
086   * <p>If {@code !range.contains(k)}, {@link #get(Comparable) get(k)} will return the same result
087   * before and after a call to {@code remove(range)}.  If {@code range.contains(k)}, then
088   * after a call to {@code remove(range)}, {@code get(k)} will return {@code null}.
089   */
090  void remove(Range<K> range);
091
092  /**
093   * Returns a view of this range map as an unmodifiable {@code Map<Range<K>, V>}.
094   * Modifications to this range map are guaranteed to read through to the returned {@code Map}.
095   *
096   * <p>It is guaranteed that no empty ranges will be in the returned {@code Map}.
097   */
098  Map<Range<K>, V> asMapOfRanges();
099  
100  /**
101   * Returns a view of the part of this range map that intersects with {@code range}.
102   * 
103   * <p>For example, if {@code rangeMap} had the entries 
104   * {@code [1, 5] => "foo", (6, 8) => "bar", (10, \u2025) => "baz"}
105   * then {@code rangeMap.subRangeMap(Range.open(3, 12))} would return a range map
106   * with the entries {@code (3, 5) => "foo", (6, 8) => "bar", (10, 12) => "baz"}.
107   * 
108   * <p>The returned range map supports all optional operations that this range map supports,
109   * except for {@code asMapOfRanges().iterator().remove()}.
110   * 
111   * <p>The returned range map will throw an {@link IllegalArgumentException} on an attempt to 
112   * insert a range not {@linkplain Range#encloses(Range) enclosed} by {@code range}. 
113   */
114  RangeMap<K, V> subRangeMap(Range<K> range);
115
116  /**
117   * Returns {@code true} if {@code obj} is another {@code RangeMap} that has an equivalent
118   * {@link #asMapOfRanges()}.
119   */
120  @Override
121  boolean equals(@Nullable Object o);
122
123  /**
124   * Returns {@code asMapOfRanges().hashCode()}.
125   */
126  @Override
127  int hashCode();
128
129  /**
130   * Returns a readable string representation of this range map.
131   */
132  @Override
133  String toString();
134}