com.comphenix.xp.extra

Class IntervalTree<TKey extends java.lang.Comparable<TKey>,TValue>

java.lang.Object

com.comphenix.xp.extra.IntervalTree<TKey,TValue>

Type Parameters:

TKey - - type of the key. Must implement Comparable.

TValue - - type of the value to associate.

Direct Known Subclasses:

LevelingRate

public abstract class IntervalTree<TKey extends java.lang.Comparable<TKey>,TValue>
extends java.lang.Object

Represents a generic store of intervals and associated values. No two intervals can overlap in this representation.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	IntervalTree.EndPoint Represents a single end point (open, close or both) of a range.
class	IntervalTree.Entry Represents a range and a value in this interval tree.
protected static class	IntervalTree.State

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.NavigableMap<TKey,IntervalTree.EndPoint>	bounds

Constructor Summary

Constructors

Constructor and Description
IntervalTree()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addEndPoint(TKey key, TValue value, IntervalTree.State state)
boolean	containsKey(TKey key) Determines if the given key is within an interval.
protected abstract TKey	decrementKey(TKey key)
java.util.Set<IntervalTree.Entry>	entrySet() Enumerates over every range in this interval tree.
TValue	get(TKey key) Retrieves the value of the range that matches the given key, or NULL if nothing was found.
protected IntervalTree.EndPoint	getEndPoint(TKey key) Get the end-point composite associated with this key.
protected abstract TKey	incrementKey(TKey key)
void	put(TKey lowerBound, TKey upperBound, TValue value) Associates a given interval of keys with a certain value.
void	putAll(IntervalTree<TKey,TValue> other) Inserts every range from the given tree into the current tree.
void	remove(TKey lowerBound, TKey upperBound) Removes every interval that intersects with the given range.
protected void	removeIfNonNull(java.lang.Object key)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bounds

protected java.util.NavigableMap<TKey extends java.lang.Comparable<TKey>,IntervalTree.EndPoint> bounds

Constructor Detail

IntervalTree

public IntervalTree()

Method Detail

remove

public void remove(TKey lowerBound,
          TKey upperBound)

Removes every interval that intersects with the given range.

Parameters:

lowerBound - - lowest value to remove.

upperBound - - highest value to remove.

removeIfNonNull

protected void removeIfNonNull(java.lang.Object key)

addEndPoint

protected void addEndPoint(TKey key,
               TValue value,
               IntervalTree.State state)

put

public void put(TKey lowerBound,
       TKey upperBound,
       TValue value)

Associates a given interval of keys with a certain value. Any previous association will be overwritten in the given interval.

Overlapping intervals are not permitted. A key can only be associated with a single value.

Parameters:

lowerBound - - the minimum key (inclusive).

upperBound - - the maximum key (inclusive).

value - - the value, or NULL to reset this range.

containsKey

public boolean containsKey(TKey key)

Determines if the given key is within an interval.

Parameters:

key - - key to check.

Returns:

TRUE if the given key is within an interval in this tree, FALSE otherwise.

entrySet

public java.util.Set<IntervalTree.Entry> entrySet()

Enumerates over every range in this interval tree.

Returns:

Number of ranges.

putAll

public void putAll(IntervalTree<TKey,TValue> other)

Inserts every range from the given tree into the current tree.

Parameters:

other - - the other tree to read from.

get

public TValue get(TKey key)

Retrieves the value of the range that matches the given key, or NULL if nothing was found.

Parameters:

key - - the level to read for.

Returns:

The correct amount of experience, or NULL if nothing was recorded.

getEndPoint

protected IntervalTree.EndPoint getEndPoint(TKey key)

Get the end-point composite associated with this key.

Parameters:

key - - key to search for.

Returns:

The end point found, or NULL.

decrementKey

protected abstract TKey decrementKey(TKey key)

incrementKey

protected abstract TKey incrementKey(TKey key)