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

Class RangeMapImpl<T>

java.lang.Object
org.tquadrat.foundation.util.internal.RangeMapImpl<T>
Type Parameters:
T - The type of the mapped value.
All Implemented Interfaces:
Serializable, RangeMap<T>
Direct Known Subclasses:
FinalRangeMap
@ClassVersion(sourceVersion="$Id: RangeMapImpl.java 1080 2024-01-03 11:05:21Z tquadrat $") @API(status=STABLE, since="0.0.7") public sealed class RangeMapImpl<T> extends Object implements RangeMap<T> permits FinalRangeMap<T>
The implementation of the interface RangeMap.
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: RangeMapImpl.java 1080 2024-01-03 11:05:21Z tquadrat $
Since:
0.0.7
See Also:
UML Diagram
UML Diagram for "org.tquadrat.foundation.util.internal.RangeMapImpl"⁠

UML Diagram for "org.tquadrat.foundation.util.internal.RangeMapImpl"

UML Diagram for "org.tquadrat.foundation.util.internal.RangeMapImpl"⁠

  • Field Details

    • m_Includes

      private boolean m_Includes
      This flag determines if the limit belongs to the range or not.

    • m_Ranges

      private final Set<Pair<Double,? extends T>> m_Ranges
      The Ranges.

  • Constructor Details

    • RangeMapImpl

      public RangeMapImpl()
      Creates a new RangeMap instance. For this instance, the limit does not belong to the range.
      See Also:

    • RangeMapImpl

      public RangeMapImpl(boolean includes)
      Creates a new RangeMap instance.
      Parameters:
      includes - true if the limit belongs to the range, false otherwise.

    • RangeMapImpl

      public RangeMapImpl(RangeMapImpl<? extends T> other)
      Creates a new RangeMap instance from an existing one.
      Parameters:
      other - The other instance.

    • RangeMapImpl

      public RangeMapImpl(boolean includes, Map<? extends Number,? extends T> map)
      Creates a new RangeMap instance from an instance of Map.
      Parameters:
      includes - true if the limit belongs to the range, false otherwise.
      map - The map instance.

    • RangeMapImpl

      public RangeMapImpl(boolean includes, Collection<? extends Map.Entry<? extends Number,? extends T>> nvpList)
      Creates a new RangeMap instance from a list of pairs.
      Parameters:
      includes - true if the limit belongs to the range, false otherwise.
      nvpList - The list of entries.

  • Method Details

    • addRange

      public RangeMapImpl<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.

      Specified by:
      addRange in interface RangeMap<T>
      Parameters:
      key - The upper border of the range.
      value - The mapped value.
      Returns:
      A reference to this range map instance.

    • clear

      public void clear()
      Clears the range map.
      Specified by:
      clear in interface RangeMap<T>

    • copy

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

    • entries

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

    • get

      public final T get(double key)
      Returns the value for the range the given key is in.
      Specified by:
      get in interface RangeMap<T>
      Parameters:
      key - The key.
      Returns:
      The value that is mapped to the range.

    • isEmpty

      public final boolean isEmpty()

      Returns true if the range map is empty.

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

      Specified by:
      isEmpty in interface RangeMap<T>
      Returns:
      true if the range map is empty, false if there were already some entries added to it.

    • removeRange

      public 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 RangeMap.addRange(double, Object) method calls.

      Specified by:
      removeRange in interface RangeMap<T>
      Parameters:
      key - The key for the range to remove.
      Returns:
      A reference to this range map instance.

    • setDefault

      public RangeMapImpl<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 RangeMap.addRange(double, Object) method calls.

      Specified by:
      setDefault in interface RangeMap<T>
      Parameters:
      value - The mapped value.
      Returns:
      A reference to this range map instance.
      See Also:

    • unmodifiableRangeMap

      public static <T> RangeMapImpl<T> unmodifiableRangeMap(RangeMapImpl<? extends T> other)
      Returns an immutable copy of the given RangeMapImpl.
      Type Parameters:
      T - The type of the mapped value.
      Parameters:
      other - The other Range map.
      Returns:
      The immutable copy.