com.google.common.collect

Class ImmutableRangeMap<K extends Comparable<?>,V>

java.lang.Object

com.google.common.collect.ImmutableRangeMap<K,V>

All Implemented Interfaces:

RangeMap<K,V>, Serializable

@Beta
 @GwtIncompatible
public class ImmutableRangeMap<K extends Comparable<?>,V>
extends Object
implements RangeMap<K,V>, Serializable

A RangeMap whose contents will never change, with many other important properties detailed at ImmutableCollection.

Since:

14.0

Author:

Louis Wasserman

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableRangeMap.Builder<K extends Comparable<?>,V> A builder for immutable range maps.

Method Summary

Modifier and Type	Method and Description
ImmutableMap<Range<K>,V>	asDescendingMapOfRanges() Returns a view of this range map as an unmodifiable Map<Range<K>, V>.
ImmutableMap<Range<K>,V>	asMapOfRanges() Returns a view of this range map as an unmodifiable Map<Range<K>, V>.
static <K extends Comparable<?>,V> ImmutableRangeMap.Builder<K,V>	builder() Returns a new builder for an immutable range map.
void	clear() Deprecated. Unsupported operation.
static <K extends Comparable<?>,V> ImmutableRangeMap<K,V>	copyOf(RangeMap<K,? extends V> rangeMap)
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
V	get(K key) Returns the value associated with the specified key, or null if there is no such value.
Map.Entry<Range<K>,V>	getEntry(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.
int	hashCode() Returns a hash code value for the object.
static <K extends Comparable<?>,V> ImmutableRangeMap<K,V>	of() Returns an empty immutable range map.
static <K extends Comparable<?>,V> ImmutableRangeMap<K,V>	of(Range<K> range, V value) Returns an immutable range map mapping a single range to a single value.
void	put(Range<K> range, V value) Deprecated. Unsupported operation.
void	putAll(RangeMap<K,V> rangeMap) Deprecated. Unsupported operation.
void	putCoalescing(Range<K> range, V value) Deprecated. Unsupported operation.
void	remove(Range<K> range) Deprecated. Unsupported operation.
Range<K>	span() Returns the minimal range enclosing the ranges in this RangeMap.
ImmutableRangeMap<K,V>	subRangeMap(Range<K> range) Returns a view of the part of this range map that intersects with range.
static <T,K extends Comparable<? super K>,V> Collector<T,?,ImmutableRangeMap<K,V>>	toImmutableRangeMap(Function<? super T,Range<K>> keyFunction, Function<? super T,? extends V> valueFunction) Returns a Collector that accumulates the input elements into a new ImmutableRangeMap.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

toImmutableRangeMap

@Beta
public static <T,K extends Comparable<? super K>,V> Collector<T,?,ImmutableRangeMap<K,V>> toImmutableRangeMap(Function<? super T,Range<K>> keyFunction,
                                                                                                                    Function<? super T,? extends V> valueFunction)

Returns a Collector that accumulates the input elements into a new ImmutableRangeMap. As in ImmutableRangeMap.Builder, overlapping ranges are not permitted.

Since:

23.1

of

public static <K extends Comparable<?>,V> ImmutableRangeMap<K,V> of()

Returns an empty immutable range map.

of

public static <K extends Comparable<?>,V> ImmutableRangeMap<K,V> of(Range<K> range,
                                                                    V value)

Returns an immutable range map mapping a single range to a single value.

copyOf

public static <K extends Comparable<?>,V> ImmutableRangeMap<K,V> copyOf(RangeMap<K,? extends V> rangeMap)

builder

public static <K extends Comparable<?>,V> ImmutableRangeMap.Builder<K,V> builder()

Returns a new builder for an immutable range map.

get

@NullableDecl
public V get(K key)

Description copied from interface: RangeMap

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.

Specified by:

get in interface RangeMap<K extends Comparable<?>,V>

getEntry

@NullableDecl
public Map.Entry<Range<K>,V> getEntry(K key)

Description copied from interface: RangeMap

Returns the range containing this key and its associated value, if such a range is present in the range map, or null otherwise.

Specified by:

getEntry in interface RangeMap<K extends Comparable<?>,V>

span

public Range<K> span()

Description copied from interface: RangeMap

Returns the minimal range enclosing the ranges in this RangeMap.

Specified by:

span in interface RangeMap<K extends Comparable<?>,V>

put

@Deprecated
public void put(Range<K> range,
                            V value)

Deprecated. Unsupported operation.

Guaranteed to throw an exception and leave the RangeMap unmodified.

Specified by:

put in interface RangeMap<K extends Comparable<?>,V>

Throws:

UnsupportedOperationException - always

putCoalescing

@Deprecated
public void putCoalescing(Range<K> range,
                                      V value)

Deprecated. Unsupported operation.

Guaranteed to throw an exception and leave the RangeMap unmodified.

Specified by:

putCoalescing in interface RangeMap<K extends Comparable<?>,V>

Throws:

UnsupportedOperationException - always

putAll

@Deprecated
public void putAll(RangeMap<K,V> rangeMap)

Deprecated. Unsupported operation.

Guaranteed to throw an exception and leave the RangeMap unmodified.

Specified by:

putAll in interface RangeMap<K extends Comparable<?>,V>

Throws:

UnsupportedOperationException - always

clear

@Deprecated
public void clear()

Deprecated. Unsupported operation.

Guaranteed to throw an exception and leave the RangeMap unmodified.

Specified by:

clear in interface RangeMap<K extends Comparable<?>,V>

Throws:

UnsupportedOperationException - always

remove

@Deprecated
public void remove(Range<K> range)

Deprecated. Unsupported operation.

Guaranteed to throw an exception and leave the RangeMap unmodified.

Specified by:

remove in interface RangeMap<K extends Comparable<?>,V>

Throws:

UnsupportedOperationException - always

asMapOfRanges

public ImmutableMap<Range<K>,V> asMapOfRanges()

Description copied from interface: RangeMap

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.

The returned Map iterates over entries in ascending order of the bounds of the Range entries.

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

Specified by:

asMapOfRanges in interface RangeMap<K extends Comparable<?>,V>

asDescendingMapOfRanges

public ImmutableMap<Range<K>,V> asDescendingMapOfRanges()

Description copied from interface: RangeMap

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.

The returned Map iterates over entries in descending order of the bounds of the Range entries.

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

Specified by:

asDescendingMapOfRanges in interface RangeMap<K extends Comparable<?>,V>

subRangeMap

public ImmutableRangeMap<K,V> subRangeMap(Range<K> range)

Description copied from interface: RangeMap

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, ∞) => "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.

Specified by:

subRangeMap in interface RangeMap<K extends Comparable<?>,V>

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Specified by:

hashCode in interface RangeMap<K extends Comparable<?>,V>

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public boolean equals(@NullableDecl
                      Object o)

Description copied from class: java.lang.Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Specified by:

equals in interface RangeMap<K extends Comparable<?>,V>

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

toString

public String toString()

Description copied from class: java.lang.Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Specified by:

toString in interface RangeMap<K extends Comparable<?>,V>

Overrides:

toString in class Object

Returns:

a string representation of the object.