Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * 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 java.util.Map;
 
 import  javax.annotation.Nullable;

A mapping from disjoint nonempty ranges to non-null values. Queries look up the value associated with the range (if any) that contains a specified key.

In contrast to RangeSet, no "coalescing" is done of Range.isConnected(Range) connected ranges, even if they are mapped to the same value.

Author(s):
Louis Wasserman
Since:
14.0
 
 public interface RangeMap<K extends Comparable, V> {
  
Returns the value associated with the specified key, or null if there is no such value.

Specifically, if any range in this range map contains the specified key, the value associated with that range is returned.

 
   @Nullable
   V get(K key);

  
Returns the range containing this key and its associated value, if such a range is present in the range map, or null otherwise.
 
   @Nullable
   Map.Entry<Range<K>, V> getEntry(K key);

  
Returns the minimal range enclosing the ranges in this RangeMap.

Throws:
NoSuchElementException if this range map is empty
 
   Range<K> span();

  
Maps a range to a specified value (optional operation).

Specifically, after a call to put(range, value), if range.contains(k), then get(k) will return value.

If range is empty, then this is a no-op.

 
   void put(Range<K> range, V value);

  
Puts all the associations from rangeMap into this range map (optional operation).
 
   void putAll(RangeMap<K, V> rangeMap);

  
Removes all associations from this range map (optional operation).
 
   void clear();

  
Removes all associations from this range map in the specified range (optional operation).

If !range.contains(k), get(k) will return the same result before and after a call to remove(range). If range.contains(k), then after a call to remove(range), get(k) will return null.

 
   void remove(Range<K> range);

  
Returns a view of this range map as an unmodifiable Map<Range<K>, V>. Modifications to this range map are guaranteed to read through to the returned Map.

It is guaranteed that no empty ranges will be in the returned Map.

 
   Map<Range<K>, V> asMapOfRanges();
  
  
Returns a view of the part of this range map that intersects with range.

For example, if rangeMap had the entries [1, 5] => "foo", (6, 8) => "bar", (10, \u2025) => "baz" then rangeMap.subRangeMap(Range.open(3, 12)) would return a range map with the entries (3, 5) => "foo", (6, 8) => "bar", (10, 12) => "baz".

The returned range map supports all optional operations that this range map supports, except for asMapOfRanges().iterator().remove().

The returned range map will throw an IllegalArgumentException on an attempt to insert a range not enclosed by range.

  RangeMap<K, V> subRangeMap(Range<K> range);

  
Returns true if obj is another RangeMap that has an equivalent asMapOfRanges().
  boolean equals(@Nullable Object o);

  
Returns asMapOfRanges().hashCode().
  int hashCode();

  
Returns a readable string representation of this range map.
New to GrepCode? Check out our FAQ X