Class TreeRangeSet<C extends Comparable<?>>

java.lang.Object
com.google.common.collect.AbstractRangeSet<C>
com.google.common.collect.TreeRangeSet<C>
All Implemented Interfaces:
RangeSet<C>, Serializable
Direct Known Subclasses:
TreeRangeSet.Complement, TreeRangeSet.SubRangeSet

public class TreeRangeSet<C extends Comparable<?>> extends AbstractRangeSet<C> implements Serializable
An implementation of RangeSet backed by a TreeMap.
Since:
14.0
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • create

      public static <C extends Comparable<?>> TreeRangeSet<C> create()
      Creates an empty TreeRangeSet instance.
    • create

      public static <C extends Comparable<?>> TreeRangeSet<C> create(RangeSet<C> rangeSet)
      Returns a TreeRangeSet initialized with the ranges in the specified range set.
    • create

      public static <C extends Comparable<?>> TreeRangeSet<C> create(Iterable<Range<C>> ranges)
      Returns a TreeRangeSet representing the union of the specified ranges.

      This is the smallest RangeSet which encloses each of the specified ranges. An element will be contained in this RangeSet if and only if it is contained in at least one Range in ranges.

      Since:
      21.0
    • asRanges

      public Set<Range<C>> asRanges()
      Description copied from interface: RangeSet
      Returns a view of the disconnected ranges that make up this range set. The returned set may be empty. The iterators returned by its Iterable.iterator() method return the ranges in increasing order of lower bound (equivalently, of upper bound).
      Specified by:
      asRanges in interface RangeSet<C extends Comparable<?>>
    • asDescendingSetOfRanges

      public Set<Range<C>> asDescendingSetOfRanges()
      Description copied from interface: RangeSet
      Returns a descending view of the disconnected ranges that make up this range set. The returned set may be empty. The iterators returned by its Iterable.iterator() method return the ranges in decreasing order of lower bound (equivalently, of upper bound).
      Specified by:
      asDescendingSetOfRanges in interface RangeSet<C extends Comparable<?>>
    • rangeContaining

      @CheckForNull public Range<C> rangeContaining(C value)
      Description copied from interface: RangeSet
      Returns the unique range from this range set that contains value, or null if this range set does not contain value.
      Specified by:
      rangeContaining in interface RangeSet<C extends Comparable<?>>
      Specified by:
      rangeContaining in class AbstractRangeSet<C extends Comparable<?>>
    • intersects

      public boolean intersects(Range<C> range)
      Description copied from interface: RangeSet
      Returns true if there exists a non-empty range enclosed by both a member range in this range set and the specified range. This is equivalent to calling subRangeSet(otherRange) and testing whether the resulting range set is non-empty.
      Specified by:
      intersects in interface RangeSet<C extends Comparable<?>>
      Overrides:
      intersects in class AbstractRangeSet<C extends Comparable<?>>
    • encloses

      public boolean encloses(Range<C> range)
      Description copied from interface: RangeSet
      Returns true if there exists a member range in this range set which encloses the specified range.
      Specified by:
      encloses in interface RangeSet<C extends Comparable<?>>
      Specified by:
      encloses in class AbstractRangeSet<C extends Comparable<?>>
    • rangeEnclosing

      @CheckForNull private Range<C> rangeEnclosing(Range<C> range)
    • span

      public Range<C> span()
      Description copied from interface: RangeSet
      Returns the minimal range which encloses all ranges in this range set.
      Specified by:
      span in interface RangeSet<C extends Comparable<?>>
    • add

      public void add(Range<C> rangeToAdd)
      Description copied from interface: RangeSet
      Adds the specified range to this RangeSet (optional operation). That is, for equal range sets a and b, the result of a.add(range) is that a will be the minimal range set for which both a.enclosesAll(b) and a.encloses(range).

      Note that range will be coalesced with any ranges in the range set that are connected with it. Moreover, if range is empty, this is a no-op.

      Specified by:
      add in interface RangeSet<C extends Comparable<?>>
      Overrides:
      add in class AbstractRangeSet<C extends Comparable<?>>
    • remove

      public void remove(Range<C> rangeToRemove)
      Description copied from interface: RangeSet
      Removes the specified range from this RangeSet (optional operation). After this operation, if range.contains(c), this.contains(c) will return false.

      If range is empty, this is a no-op.

      Specified by:
      remove in interface RangeSet<C extends Comparable<?>>
      Overrides:
      remove in class AbstractRangeSet<C extends Comparable<?>>
    • replaceRangeWithSameLowerBound

      private void replaceRangeWithSameLowerBound(Range<C> range)
    • complement

      public RangeSet<C> complement()
      Description copied from interface: RangeSet
      Returns a view of the complement of this RangeSet.

      The returned view supports the RangeSet.add(com.google.common.collect.Range<C>) operation if this RangeSet supports RangeSet.remove(com.google.common.collect.Range<C>), and vice versa.

      Specified by:
      complement in interface RangeSet<C extends Comparable<?>>
    • subRangeSet

      public RangeSet<C> subRangeSet(Range<C> view)
      Description copied from interface: RangeSet
      Returns a view of the intersection of this RangeSet with the specified range.

      The returned view supports all optional operations supported by this RangeSet, with the caveat that an IllegalArgumentException is thrown on an attempt to add any range not enclosed by view.

      Specified by:
      subRangeSet in interface RangeSet<C extends Comparable<?>>