Module org.tquadrat.foundation.util
Package org.tquadrat.foundation.util

Interface RangeMap<T>

Type Parameters:
T - The type of the mapped value.
All Superinterfaces:
Serializable
All Known Implementing Classes:
FinalRangeMap, RangeMapImpl
@ClassVersion(sourceVersion="$Id: RangeMap.java 1017 2022-02-10 19:39:09Z tquadrat $") @API(status=STABLE, since="0.0.7") public sealed interface RangeMap<T> extends Serializable permits RangeMapImpl<T>

A range map is used to map a value to a given numerical range. The lower border of the lowest range is always -Double.MAX_VALUE.

Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: RangeMap.java 1017 2022-02-10 19:39:09Z tquadrat $
Since:
0.0.7
See Also:
UML Diagram
UML Diagram for "org.tquadrat.foundation.util.RangeMap"⁠

UML Diagram for "org.tquadrat.foundation.util.RangeMap"

UML Diagram for "org.tquadrat.foundation.util.RangeMap"⁠

  • Method Summary

    Modifier and Type
    Method
    Description
    RangeMap<T>
    addRange(double key, T value)
    Adds a range.
    void
    clear()
    Clears the range map.
    default RangeMap<T>
    copy()
    Returns a modifiable copy of this range map.
    RangeMap<T>
    copy(boolean modifiable)
    Returns a copy of this range map.
    Pair<Double,T>[]
    entries()
    Returns the entries in their order.
    T
    get(double key)
    Returns the value for the range the given key is in.
    boolean
    isEmpty()
    Returns true if the range map is empty.
    static <V> RangeMap<V>
    of(V defaultValue, boolean includes)
    The factory method for a new instance of RangeMap.
    RangeMap<T>
    removeRange(double key)
    Removes a range.
    default RangeMap<T>
    replaceRange(double key, T value)
    Replaces an already existing range.
    RangeMap<T>
    setDefault(T value)
    Sets the default value and overwrites that one that was set on creation of the range map.

  • Method Details

    • addRange

      RangeMap<T> addRange(double key, T value)

      Adds a range. If there is already a range with the given key, it will not replaced by the new one!

      The method will return a reference to the map itself; this allows to chain it with other #addRange(double, Object) method calls.

      Parameters:
      key - The upper border of the range.
      value - The mapped value.
      Returns:
      A reference to this range map instance.

    • clear

      void clear()
      Clears the range map.

    • copy

      RangeMap<T> copy(boolean modifiable)
      Returns a copy of this range map.
      Parameters:
      modifiable - true if the copy can be modified, false otherwise.
      Returns:
      The copy.

    • copy

      default RangeMap<T> copy()
      Returns a modifiable copy of this range map.
      Returns:
      The copy.

    • entries

      Pair<Double,T>[] entries()
      Returns the entries in their order.
      Returns:
      The entries; for an empty range map, an empty array will be returned.

    • get

      T get(double key) throws IllegalStateException
      Returns the value for the range the given key is in.
      Parameters:
      key - The key.
      Returns:
      The value that is mapped to the range.
      Throws:
      IllegalStateException - No entry was added to the range map; it is empty.

    • isEmpty

      boolean isEmpty()

      Returns true if the range map is empty.

      Usually, a range map is empty only after a call to clear() or when the last entry was removed by a call to removeRange(double), but special implementations of this interface can handle this differently.

      Returns:
      true if the range map is empty, false if there were already some entries added to it.

    • of

      static <V> RangeMap<V> of(V defaultValue, boolean includes)
      The factory method for a new instance of RangeMap.
      Type Parameters:
      V - The value type for the range map.
      Parameters:
      defaultValue - The default value; this is the that is returned if the key is above all range limits.
      includes - true if the limit belongs to the range, false otherwise.
      Returns:
      The new range map instance.

    • removeRange

      RangeMap<T> removeRange(double key)

      Removes a range. Nothing happens if there is no range for the given key value.

      After this operation, the range map can be empty.

      The method will return a reference to the map itself; this allows to chain it with addRange(double, Object) method calls.

      Parameters:
      key - The key for the range to remove.
      Returns:
      A reference to this range map instance.

    • replaceRange

      default RangeMap<T> replaceRange(double key, T value)

      Replaces an already existing range. If there is no range for the given key value, the method will just add a new range.

      The method will return a reference to the map itself; this allows to chain it with addRange(double, Object) method calls.

      Parameters:
      key - The upper border of the range.
      value - The mapped value.
      Returns:
      A reference to this range map instance.

    • setDefault

      RangeMap<T> setDefault(T value)

      Sets the default value and overwrites that one that was set on creation of the range map.

      The default value is that one that is returned if the key is above all range limits.

      The method will return a reference to the map itself; this allows to chain it with addRange(double, Object) method calls.

      Parameters:
      value - The mapped value.
      Returns:
      A reference to this range map instance.
      See Also: