@Beta @GwtIncompatible public final class TreeRangeMap<K extends Comparable,V> extends Object implements RangeMap<K,V>
RangeMap
based on a TreeMap
, supporting all optional
operations.
Like all RangeMap
implementations, this supports neither null keys nor null values.
Modifier and Type | Method and Description |
---|---|
Map<Range<K>,V> |
asDescendingMapOfRanges()
Returns a view of this range map as an unmodifiable
Map<Range<K>, V> . |
Map<Range<K>,V> |
asMapOfRanges()
Returns a view of this range map as an unmodifiable
Map<Range<K>, V> . |
void |
clear()
Removes all associations from this range map (optional operation).
|
static <K extends Comparable,V> |
create() |
boolean |
equals(@Nullable 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. |
@Nullable 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.
|
void |
put(Range<K> range,
V value)
Maps a range to a specified value (optional operation).
|
void |
putAll(RangeMap<K,V> rangeMap)
Puts all the associations from
rangeMap into this range map (optional operation). |
void |
putCoalescing(Range<K> range,
V value)
Maps a range to a specified value, coalescing this range with any existing ranges with the same
value that are connected to this range.
|
void |
remove(Range<K> rangeToRemove)
Removes all associations from this range map in the specified range (optional operation).
|
Range<K> |
span()
Returns the minimal range enclosing the ranges in this
RangeMap . |
RangeMap<K,V> |
subRangeMap(Range<K> subRange)
Returns a view of the part of this range map that intersects with
range . |
String |
toString()
Returns a string representation of the object.
|
public static <K extends Comparable,V> TreeRangeMap<K,V> create()
public V get(K key)
RangeMap
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.
get
in interface RangeMap<K extends Comparable,V>
public @Nullable Map.Entry<Range<K>,V> getEntry(K key)
RangeMap
null
otherwise.getEntry
in interface RangeMap<K extends Comparable,V>
public void put(Range<K> range, V value)
RangeMap
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.
put
in interface RangeMap<K extends Comparable,V>
public void putCoalescing(Range<K> range, V value)
RangeMap
The behavior of get(k)
after calling this method is identical to
the behavior described in put(range, value)
, however the ranges
returned from RangeMap.asMapOfRanges()
will be different if there were existing entries which
connect to the given range and value.
Even if the input range is empty, if it is connected on both sides by ranges mapped to the same value those two ranges will be coalesced.
Note: coalescing requires calling .equals()
on any connected values, which
may be expensive depending on the value type. Using this method on range maps with large values
such as Collection
types is discouraged.
putCoalescing
in interface RangeMap<K extends Comparable,V>
public void putAll(RangeMap<K,V> rangeMap)
RangeMap
rangeMap
into this range map (optional operation).putAll
in interface RangeMap<K extends Comparable,V>
public void clear()
RangeMap
clear
in interface RangeMap<K extends Comparable,V>
public Range<K> span()
RangeMap
RangeMap
.span
in interface RangeMap<K extends Comparable,V>
public void remove(Range<K> rangeToRemove)
RangeMap
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
.
remove
in interface RangeMap<K extends Comparable,V>
public Map<Range<K>,V> asMapOfRanges()
RangeMap
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
.
asMapOfRanges
in interface RangeMap<K extends Comparable,V>
public Map<Range<K>,V> asDescendingMapOfRanges()
RangeMap
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
.
asDescendingMapOfRanges
in interface RangeMap<K extends Comparable,V>
public RangeMap<K,V> subRangeMap(Range<K> subRange)
RangeMap
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
.
subRangeMap
in interface RangeMap<K extends Comparable,V>
public boolean equals(@Nullable Object o)
java.lang.Object
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
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.
equals
in interface RangeMap<K extends Comparable,V>
equals
in class Object
o
- the reference object with which to compare.true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
HashMap
public int hashCode()
java.lang.Object
HashMap
.
The general contract of hashCode
is:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
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.)
hashCode
in interface RangeMap<K extends Comparable,V>
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
public String toString()
java.lang.Object
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())
Copyright © 2010–2019. All rights reserved.