001/*
002 * Copyright (C) 2011 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
005 * in compliance with the License. You may obtain a copy of the License at
006 *
007 * http://www.apache.org/licenses/LICENSE-2.0
008 *
009 * Unless required by applicable law or agreed to in writing, software distributed under the
010 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
011 * express or implied. See the License for the specific language governing permissions and
012 * limitations under the License.
013 */
014
015package com.google.common.collect;
016
017import com.google.common.annotations.Beta;
018import com.google.common.annotations.GwtIncompatible;
019import com.google.errorprone.annotations.DoNotMock;
020import java.util.NoSuchElementException;
021import java.util.Set;
022import javax.annotation.CheckForNull;
023
024/**
025 * A set comprising zero or more {@linkplain Range#isEmpty nonempty}, {@linkplain
026 * Range#isConnected(Range) disconnected} ranges of type {@code C}.
027 *
028 * <p>Implementations that choose to support the {@link #add(Range)} operation are required to
029 * ignore empty ranges and coalesce connected ranges. For example:
030 *
031 * <pre>{@code
032 * RangeSet<Integer> rangeSet = TreeRangeSet.create();
033 * rangeSet.add(Range.closed(1, 10)); // {[1, 10]}
034 * rangeSet.add(Range.closedOpen(11, 15)); // disconnected range; {[1, 10], [11, 15)}
035 * rangeSet.add(Range.closedOpen(15, 20)); // connected range; {[1, 10], [11, 20)}
036 * rangeSet.add(Range.openClosed(0, 0)); // empty range; {[1, 10], [11, 20)}
037 * rangeSet.remove(Range.open(5, 10)); // splits [1, 10]; {[1, 5], [10, 10], [11, 20)}
038 * }</pre>
039 *
040 * <p>Note that the behavior of {@link Range#isEmpty()} and {@link Range#isConnected(Range)} may not
041 * be as expected on discrete ranges. See the Javadoc of those methods for details.
042 *
043 * <p>For a {@link Set} whose contents are specified by a {@link Range}, see {@link ContiguousSet}.
044 *
045 * <p>See the Guava User Guide article on <a href=
046 * "https://github.com/google/guava/wiki/NewCollectionTypesExplained#rangeset">RangeSets</a>.
047 *
048 * @author Kevin Bourrillion
049 * @author Louis Wasserman
050 * @since 14.0
051 */
052@Beta
053@DoNotMock("Use ImmutableRangeSet or TreeRangeSet")
054@GwtIncompatible
055@ElementTypesAreNonnullByDefault
056public interface RangeSet<C extends Comparable> {
057
058  // Query methods
059
060  /** Determines whether any of this range set's member ranges contains {@code value}. */
061  boolean contains(C value);
062
063  /**
064   * Returns the unique range from this range set that {@linkplain Range#contains contains} {@code
065   * value}, or {@code null} if this range set does not contain {@code value}.
066   */
067  @CheckForNull
068  Range<C> rangeContaining(C value);
069
070  /**
071   * Returns {@code true} if there exists a non-empty range enclosed by both a member range in this
072   * range set and the specified range. This is equivalent to calling {@code
073   * subRangeSet(otherRange)} and testing whether the resulting range set is non-empty.
074   *
075   * @since 20.0
076   */
077  boolean intersects(Range<C> otherRange);
078
079  /**
080   * Returns {@code true} if there exists a member range in this range set which {@linkplain
081   * Range#encloses encloses} the specified range.
082   */
083  boolean encloses(Range<C> otherRange);
084
085  /**
086   * Returns {@code true} if for each member range in {@code other} there exists a member range in
087   * this range set which {@linkplain Range#encloses encloses} it. It follows that {@code
088   * this.contains(value)} whenever {@code other.contains(value)}. Returns {@code true} if {@code
089   * other} is empty.
090   *
091   * <p>This is equivalent to checking if this range set {@link #encloses} each of the ranges in
092   * {@code other}.
093   */
094  boolean enclosesAll(RangeSet<C> other);
095
096  /**
097   * Returns {@code true} if for each range in {@code other} there exists a member range in this
098   * range set which {@linkplain Range#encloses encloses} it. Returns {@code true} if {@code other}
099   * is empty.
100   *
101   * <p>This is equivalent to checking if this range set {@link #encloses} each range in {@code
102   * other}.
103   *
104   * @since 21.0
105   */
106  boolean enclosesAll(Iterable<Range<C>> other);
107
108  /** Returns {@code true} if this range set contains no ranges. */
109  boolean isEmpty();
110
111  /**
112   * Returns the minimal range which {@linkplain Range#encloses(Range) encloses} all ranges in this
113   * range set.
114   *
115   * @throws NoSuchElementException if this range set is {@linkplain #isEmpty() empty}
116   */
117  Range<C> span();
118
119  // Views
120
121  /**
122   * Returns a view of the {@linkplain Range#isConnected disconnected} ranges that make up this
123   * range set. The returned set may be empty. The iterators returned by its {@link
124   * Iterable#iterator} method return the ranges in increasing order of lower bound (equivalently,
125   * of upper bound).
126   */
127  Set<Range<C>> asRanges();
128
129  /**
130   * Returns a descending view of the {@linkplain Range#isConnected disconnected} ranges that make
131   * up this range set. The returned set may be empty. The iterators returned by its {@link
132   * Iterable#iterator} method return the ranges in decreasing order of lower bound (equivalently,
133   * of upper bound).
134   *
135   * @since 19.0
136   */
137  Set<Range<C>> asDescendingSetOfRanges();
138
139  /**
140   * Returns a view of the complement of this {@code RangeSet}.
141   *
142   * <p>The returned view supports the {@link #add} operation if this {@code RangeSet} supports
143   * {@link #remove}, and vice versa.
144   */
145  RangeSet<C> complement();
146
147  /**
148   * Returns a view of the intersection of this {@code RangeSet} with the specified range.
149   *
150   * <p>The returned view supports all optional operations supported by this {@code RangeSet}, with
151   * the caveat that an {@link IllegalArgumentException} is thrown on an attempt to {@linkplain
152   * #add(Range) add} any range not {@linkplain Range#encloses(Range) enclosed} by {@code view}.
153   */
154  RangeSet<C> subRangeSet(Range<C> view);
155
156  // Modification
157
158  /**
159   * Adds the specified range to this {@code RangeSet} (optional operation). That is, for equal
160   * range sets a and b, the result of {@code a.add(range)} is that {@code a} will be the minimal
161   * range set for which both {@code a.enclosesAll(b)} and {@code a.encloses(range)}.
162   *
163   * <p>Note that {@code range} will be {@linkplain Range#span(Range) coalesced} with any ranges in
164   * the range set that are {@linkplain Range#isConnected(Range) connected} with it. Moreover, if
165   * {@code range} is empty, this is a no-op.
166   *
167   * @throws UnsupportedOperationException if this range set does not support the {@code add}
168   *     operation
169   */
170  void add(Range<C> range);
171
172  /**
173   * Removes the specified range from this {@code RangeSet} (optional operation). After this
174   * operation, if {@code range.contains(c)}, {@code this.contains(c)} will return {@code false}.
175   *
176   * <p>If {@code range} is empty, this is a no-op.
177   *
178   * @throws UnsupportedOperationException if this range set does not support the {@code remove}
179   *     operation
180   */
181  void remove(Range<C> range);
182
183  /**
184   * Removes all ranges from this {@code RangeSet} (optional operation). After this operation,
185   * {@code this.contains(c)} will return false for all {@code c}.
186   *
187   * <p>This is equivalent to {@code remove(Range.all())}.
188   *
189   * @throws UnsupportedOperationException if this range set does not support the {@code clear}
190   *     operation
191   */
192  void clear();
193
194  /**
195   * Adds all of the ranges from the specified range set to this range set (optional operation).
196   * After this operation, this range set is the minimal range set that {@linkplain
197   * #enclosesAll(RangeSet) encloses} both the original range set and {@code other}.
198   *
199   * <p>This is equivalent to calling {@link #add} on each of the ranges in {@code other} in turn.
200   *
201   * @throws UnsupportedOperationException if this range set does not support the {@code addAll}
202   *     operation
203   */
204  void addAll(RangeSet<C> other);
205
206  /**
207   * Adds all of the specified ranges to this range set (optional operation). After this operation,
208   * this range set is the minimal range set that {@linkplain #enclosesAll(RangeSet) encloses} both
209   * the original range set and each range in {@code other}.
210   *
211   * <p>This is equivalent to calling {@link #add} on each of the ranges in {@code other} in turn.
212   *
213   * @throws UnsupportedOperationException if this range set does not support the {@code addAll}
214   *     operation
215   * @since 21.0
216   */
217  void addAll(Iterable<Range<C>> ranges);
218
219  /**
220   * Removes all of the ranges from the specified range set from this range set (optional
221   * operation). After this operation, if {@code other.contains(c)}, {@code this.contains(c)} will
222   * return {@code false}.
223   *
224   * <p>This is equivalent to calling {@link #remove} on each of the ranges in {@code other} in
225   * turn.
226   *
227   * @throws UnsupportedOperationException if this range set does not support the {@code removeAll}
228   *     operation
229   */
230  void removeAll(RangeSet<C> other);
231
232  /**
233   * Removes all of the specified ranges from this range set (optional operation).
234   *
235   * <p>This is equivalent to calling {@link #remove} on each of the ranges in {@code other} in
236   * turn.
237   *
238   * @throws UnsupportedOperationException if this range set does not support the {@code removeAll}
239   *     operation
240   * @since 21.0
241   */
242  void removeAll(Iterable<Range<C>> ranges);
243
244  // Object methods
245
246  /**
247   * Returns {@code true} if {@code obj} is another {@code RangeSet} that contains the same ranges
248   * according to {@link Range#equals(Object)}.
249   */
250  @Override
251  boolean equals(@CheckForNull Object obj);
252
253  /** Returns {@code asRanges().hashCode()}. */
254  @Override
255  int hashCode();
256
257  /**
258   * Returns a readable string representation of this range set. For example, if this {@code
259   * RangeSet} consisted of {@code Range.closed(1, 3)} and {@code Range.greaterThan(4)}, this might
260   * return {@code " [1..3](4..+∞)}"}.
261   */
262  @Override
263  String toString();
264}