Class ImmutableRangeMap<K extends <?>,V>
-
- com.google.common.collect.ImmutableRangeMap<K,V>
-
- All Implemented Interfaces:
@Beta @GwtIncompatible public class <?>,V> extends implements
ARangeMap
whose contents will never change, with many other important properties detailed atImmutableCollection
.- Since:
- 14.0
- Author:
- Louis Wasserman
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
<?>,V>
A builder for immutable range maps.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ImmutableMap<Range<K>,V>
asDescendingMapOfRanges()
Returns a view of this range map as an unmodifiableMap<Range<K>, V>
.ImmutableMap<Range<K>,V>
asMapOfRanges()
Returns a view of this range map as an unmodifiableMap<Range<K>, V>
.static <K extends <?>,V>
ImmutableRangeMap.Builder<K,V>builder()
Returns a new builder for an immutable range map.void
clear()
Deprecated.Unsupported operation.static <K extends <?>,V>
ImmutableRangeMap<K,V>copyOf(RangeMap<K,? extends V> rangeMap)
boolean
o)
Indicates whether some other object is "equal to" this one.V
get(K key)
Returns the value associated with the specified key, ornull
if there is no such value.<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, ornull
otherwise.int
hashCode()
Returns a hash code value for the object.void
merge(Range<K> range, V value, <? super V,? super V,? extends V> remappingFunction)
Deprecated.Unsupported operation.static <K extends <?>,V>
ImmutableRangeMap<K,V>of()
Returns an empty immutable range map.static <K extends <?>,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 thisRangeMap
.ImmutableRangeMap<K,V>
subRangeMap(Range<K> range)
Returns a view of the part of this range map that intersects withrange
.static <T,K extends <? super K>,V>
<T,?,ImmutableRangeMap<K,V>><? super T,Range<K>> keyFunction, <? super T,? extends V> valueFunction)
Returns aCollector
that accumulates the input elements into a newImmutableRangeMap
.toString()
Returns a string representation of the object.
-
-
-
Method Detail
-
toImmutableRangeMap
public static <T,K extends <? super K>,V> <T,?,<? super T,Range<K>> keyFunction, <? super T,? extends V> valueFunction)
Returns aCollector
that accumulates the input elements into a newImmutableRangeMap
. As inImmutableRangeMap.Builder
, overlapping ranges are not permitted.- Since:
- 23.1
-
of
public static <K extends <?>,V> ImmutableRangeMap<K,V> of()
Returns an empty immutable range map.
-
of
public static <K extends <?>,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 <?>,V> ImmutableRangeMap<K,V> copyOf(RangeMap<K,? extends V> rangeMap)
-
builder
public static <K extends <?>,V> ImmutableRangeMap.Builder<K,V> builder()
Returns a new builder for an immutable range map.
-
get
public V get(K key)
Description copied from interface:RangeMap
Returns the value associated with the specified key, ornull
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:
<?>,V>
-
getEntry
public <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, ornull
otherwise.- Specified by:
<?>,V>
-
span
public Range<K> span()
Description copied from interface:RangeMap
Returns the minimal range enclosing the ranges in thisRangeMap
.- Specified by:
<?>,V>
-
put
public final void put(Range<K> range, V value)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
<?>,V>
- Throws:
- always
-
putCoalescing
public final void putCoalescing(Range<K> range, V value)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
<?>,V>
- Throws:
- always
-
putAll
public final void putAll(RangeMap<K,V> rangeMap)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
<?>,V>
- Throws:
- always
-
clear
public final void clear()
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
<?>,V>
- Throws:
- always
-
remove
public final void remove(Range<K> range)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
<?>,V>
- Throws:
- always
-
merge
public final void merge(Range<K> range, V value, <? super V,? super V,? extends V> remappingFunction)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave theRangeMap
unmodified.- Specified by:
<?>,V>
- Throws:
- always
-
asMapOfRanges
public ImmutableMap<Range<K>,V> asMapOfRanges()
Description copied from interface:RangeMap
Returns a view of this range map as an unmodifiableMap<Range<K>, V>
. Modifications to this range map are guaranteed to read through to the returnedMap
.The returned
Map
iterates over entries in ascending order of the bounds of theRange
entries.It is guaranteed that no empty ranges will be in the returned
Map
.- Specified by:
<?>,V>
-
asDescendingMapOfRanges
public ImmutableMap<Range<K>,V> asDescendingMapOfRanges()
Description copied from interface:RangeMap
Returns a view of this range map as an unmodifiableMap<Range<K>, V>
. Modifications to this range map are guaranteed to read through to the returnedMap
.The returned
Map
iterates over entries in descending order of the bounds of theRange
entries.It is guaranteed that no empty ranges will be in the returned
Map
.- Specified by:
<?>,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 withrange
.For example, if
rangeMap
had the entries[1, 5] => "foo", (6, 8) => "bar", (10, ∞) => "baz"
thenrangeMap.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 on an attempt to insert a range not enclosed by
range
.- Specified by:
<?>,V>
-
hashCode
public int hashCode()
Description copied from class:Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by .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 inequals
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 thehashCode
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
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. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)- Specified by:
<?>,V>
- Overrides:
in class
- Returns:
- a hash code value for this object.
- See Also:
- ,
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
equals
public boolean o)
Description copied from class: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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The
equals
method for classObject
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference valuesx
andy
, this method returnstrue
if and only ifx
andy
refer to the same object (x == y
has the valuetrue
).Note that it is generally necessary to override the
hashCode
method whenever this method is overridden, so as to maintain the general contract for thehashCode
method, which states that equal objects must have equal hash codes.- Specified by:
<?>,V>
- Overrides:
in class
- 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:
- ,
- It is reflexive: for any non-null reference value
-
toString
public toString()
Description copied from class:Returns a string representation of the object. In general, thetoString
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 classObject
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:
<?>,V>
- Overrides:
in class
- Returns:
- a string representation of the object.
-
-