Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright (C) 2011 The Guava Authors
   *
   * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
   * in compliance with the License. You may obtain a copy of the License at
   *
   * http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software distributed under the
  * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 package com.google.common.collect;
 
 
 import java.util.Set;
 
 import  javax.annotation.Nullable;

A set comprising zero or more nonempty, disconnected ranges of type C.

Implementations that choose to support the add(Range) operation are required to ignore empty ranges and coalesce connected ranges. For example:

   RangeSet<Integer> rangeSet = TreeRangeSet.create();
   rangeSet.add(Range.closed(1, 10)); // {[1, 10]
   rangeSet.add(Range.closedOpen(11, 15)); // {[1, 10], [11, 15)} 
   rangeSet.add(Range.open(15, 20)); // disconnected range; {[1, 10], [11, 20)}
   rangeSet.add(Range.openClosed(0, 0)); // empty range; {[1, 10], [11, 20)}
   rangeSet.remove(Range.open(5, 10)); // splits [1, 10]; {[1, 5], [10, 10], [11, 20)}}

Note that the behavior of Range.isEmpty() and Range.isConnected(Range) may not be as expected on discrete ranges. See the Javadoc of those methods for details.

For a Set whose contents are specified by a Range, see ContiguousSet.

Author(s):
Kevin Bourrillion
Louis Wasserman
Since:
14.0
 
 public interface RangeSet<C extends Comparable> {
   
   // Query methods
 
  
Determines whether any of this range set's member ranges contains value.
 
   boolean contains(C value);

  
Returns the unique range from this range set that contains value, or null if this range set does not contain value.
 
   Range<C> rangeContaining(C value);

  
Returns true if there exists a member range in this range set which encloses the specified range.
 
   boolean encloses(Range<C> otherRange);

  
Returns true if for each member range in other there exists a member range in this range set which encloses it. It follows that this.contains(value) whenever other.contains(value). Returns true if other is empty.

This is equivalent to checking if this range set encloses each of the ranges in other.

 
   boolean enclosesAll(RangeSet<C> other);

  
Returns true if this range set contains no ranges.
 
   boolean isEmpty();

  
Returns the minimal range which encloses all ranges in this range set.

Throws:
NoSuchElementException if this range set is empty
 
   Range<C> span();
 
   // Views
   
  
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).
  Set<Range<C>> asRanges();

  
Returns a view of the complement of this RangeSet.

The returned view supports the add operation if this RangeSet supports remove, and vice versa.

  RangeSet<C> complement();
  
  
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.

  RangeSet<C> subRangeSet(Range<C> view);
  
  // Modification

  
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.

Throws:
UnsupportedOperationException if this range set does not support the add operation
  void add(Range<C> range);

  
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.

Throws:
UnsupportedOperationException if this range set does not support the remove operation
  void remove(Range<C> range);
  
  
Removes all ranges from this RangeSet (optional operation). After this operation, this.contains(c) will return false for all c.

This is equivalent to remove(Range.all()).

Throws:
UnsupportedOperationException if this range set does not support the clear operation
  void clear();

  
Adds all of the ranges from the specified range set to this range set (optional operation). After this operation, this range set is the minimal range set that encloses both the original range set and other.

This is equivalent to calling add on each of the ranges in other in turn.

Throws:
UnsupportedOperationException if this range set does not support the addAll operation
  void addAll(RangeSet<C> other);

  
Removes all of the ranges from the specified range set from this range set (optional operation). After this operation, if other.contains(c), this.contains(c) will return false.

This is equivalent to calling remove on each of the ranges in other in turn.

Throws:
UnsupportedOperationException if this range set does not support the removeAll operation
  void removeAll(RangeSet<C> other);
  
  // Object methods

  
Returns true if obj is another RangeSet that contains the same ranges according to Range.equals(Object).
  boolean equals(@Nullable Object obj);
  
  
Returns asRanges().hashCode().
  int hashCode();

  
Returns a readable string representation of this range set. For example, if this RangeSet consisted of Ranges.closed(1, 3) and Ranges.greaterThan(4), this might return " [1‥3](4‥+∞)"}.
New to GrepCode? Check out our FAQ X