10888a09821a98ac0680fad765217302858e70fa4Paul Duffin/*
20888a09821a98ac0680fad765217302858e70fa4Paul Duffin * Copyright (C) 2011 The Guava Authors
30888a09821a98ac0680fad765217302858e70fa4Paul Duffin *
40888a09821a98ac0680fad765217302858e70fa4Paul Duffin * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
50888a09821a98ac0680fad765217302858e70fa4Paul Duffin * in compliance with the License. You may obtain a copy of the License at
60888a09821a98ac0680fad765217302858e70fa4Paul Duffin *
70888a09821a98ac0680fad765217302858e70fa4Paul Duffin * http://www.apache.org/licenses/LICENSE-2.0
80888a09821a98ac0680fad765217302858e70fa4Paul Duffin *
90888a09821a98ac0680fad765217302858e70fa4Paul Duffin * Unless required by applicable law or agreed to in writing, software distributed under the License
100888a09821a98ac0680fad765217302858e70fa4Paul Duffin * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
110888a09821a98ac0680fad765217302858e70fa4Paul Duffin * or implied. See the License for the specific language governing permissions and limitations under
120888a09821a98ac0680fad765217302858e70fa4Paul Duffin * the License.
130888a09821a98ac0680fad765217302858e70fa4Paul Duffin */
140888a09821a98ac0680fad765217302858e70fa4Paul Duffin
150888a09821a98ac0680fad765217302858e70fa4Paul Duffinpackage com.google.common.collect;
160888a09821a98ac0680fad765217302858e70fa4Paul Duffin
170888a09821a98ac0680fad765217302858e70fa4Paul Duffinimport static com.google.common.base.Preconditions.checkArgument;
180888a09821a98ac0680fad765217302858e70fa4Paul Duffinimport static com.google.common.base.Preconditions.checkNotNull;
190888a09821a98ac0680fad765217302858e70fa4Paul Duffinimport static com.google.common.collect.BoundType.CLOSED;
200888a09821a98ac0680fad765217302858e70fa4Paul Duffin
210888a09821a98ac0680fad765217302858e70fa4Paul Duffinimport com.google.common.annotations.GwtCompatible;
220888a09821a98ac0680fad765217302858e70fa4Paul Duffin
230888a09821a98ac0680fad765217302858e70fa4Paul Duffinimport java.util.Collection;
240888a09821a98ac0680fad765217302858e70fa4Paul Duffin
250888a09821a98ac0680fad765217302858e70fa4Paul Duffinimport javax.annotation.Nullable;
260888a09821a98ac0680fad765217302858e70fa4Paul Duffin
270888a09821a98ac0680fad765217302858e70fa4Paul Duffin/**
280888a09821a98ac0680fad765217302858e70fa4Paul Duffin * An implementation of {@link ContiguousSet} that contains one or more elements.
290888a09821a98ac0680fad765217302858e70fa4Paul Duffin *
300888a09821a98ac0680fad765217302858e70fa4Paul Duffin * @author Gregory Kick
310888a09821a98ac0680fad765217302858e70fa4Paul Duffin */
320888a09821a98ac0680fad765217302858e70fa4Paul Duffin@GwtCompatible(emulated = true)
330888a09821a98ac0680fad765217302858e70fa4Paul Duffin@SuppressWarnings("unchecked") // allow ungenerified Comparable types
340888a09821a98ac0680fad765217302858e70fa4Paul Duffinfinal class RegularContiguousSet<C extends Comparable> extends ContiguousSet<C> {
350888a09821a98ac0680fad765217302858e70fa4Paul Duffin  private final Range<C> range;
360888a09821a98ac0680fad765217302858e70fa4Paul Duffin
370888a09821a98ac0680fad765217302858e70fa4Paul Duffin  RegularContiguousSet(Range<C> range, DiscreteDomain<C> domain) {
380888a09821a98ac0680fad765217302858e70fa4Paul Duffin    super(domain);
390888a09821a98ac0680fad765217302858e70fa4Paul Duffin    this.range = range;
400888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
410888a09821a98ac0680fad765217302858e70fa4Paul Duffin
420888a09821a98ac0680fad765217302858e70fa4Paul Duffin  private ContiguousSet<C> intersectionInCurrentDomain(Range<C> other) {
430888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return (range.isConnected(other))
440888a09821a98ac0680fad765217302858e70fa4Paul Duffin        ? ContiguousSet.create(range.intersection(other), domain)
450888a09821a98ac0680fad765217302858e70fa4Paul Duffin        : new EmptyContiguousSet<C>(domain);
460888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
470888a09821a98ac0680fad765217302858e70fa4Paul Duffin
480888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override ContiguousSet<C> headSetImpl(C toElement, boolean inclusive) {
490888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return intersectionInCurrentDomain(Range.upTo(toElement, BoundType.forBoolean(inclusive)));
500888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
510888a09821a98ac0680fad765217302858e70fa4Paul Duffin
520888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override ContiguousSet<C> subSetImpl(C fromElement, boolean fromInclusive, C toElement,
530888a09821a98ac0680fad765217302858e70fa4Paul Duffin      boolean toInclusive) {
540888a09821a98ac0680fad765217302858e70fa4Paul Duffin    if (fromElement.compareTo(toElement) == 0 && !fromInclusive && !toInclusive) {
550888a09821a98ac0680fad765217302858e70fa4Paul Duffin      // Range would reject our attempt to create (x, x).
560888a09821a98ac0680fad765217302858e70fa4Paul Duffin      return new EmptyContiguousSet<C>(domain);
570888a09821a98ac0680fad765217302858e70fa4Paul Duffin    }
580888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return intersectionInCurrentDomain(Range.range(
590888a09821a98ac0680fad765217302858e70fa4Paul Duffin        fromElement, BoundType.forBoolean(fromInclusive),
600888a09821a98ac0680fad765217302858e70fa4Paul Duffin        toElement, BoundType.forBoolean(toInclusive)));
610888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
620888a09821a98ac0680fad765217302858e70fa4Paul Duffin
630888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override ContiguousSet<C> tailSetImpl(C fromElement, boolean inclusive) {
640888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return intersectionInCurrentDomain(Range.downTo(fromElement, BoundType.forBoolean(inclusive)));
650888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
660888a09821a98ac0680fad765217302858e70fa4Paul Duffin
670888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override public UnmodifiableIterator<C> iterator() {
680888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return new AbstractSequentialIterator<C>(first()) {
690888a09821a98ac0680fad765217302858e70fa4Paul Duffin      final C last = last();
700888a09821a98ac0680fad765217302858e70fa4Paul Duffin
710888a09821a98ac0680fad765217302858e70fa4Paul Duffin      @Override
720888a09821a98ac0680fad765217302858e70fa4Paul Duffin      protected C computeNext(C previous) {
730888a09821a98ac0680fad765217302858e70fa4Paul Duffin        return equalsOrThrow(previous, last) ? null : domain.next(previous);
740888a09821a98ac0680fad765217302858e70fa4Paul Duffin      }
750888a09821a98ac0680fad765217302858e70fa4Paul Duffin    };
760888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
770888a09821a98ac0680fad765217302858e70fa4Paul Duffin
780888a09821a98ac0680fad765217302858e70fa4Paul Duffin  private static boolean equalsOrThrow(Comparable<?> left, @Nullable Comparable<?> right) {
790888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return right != null && Range.compareOrThrow(left, right) == 0;
800888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
810888a09821a98ac0680fad765217302858e70fa4Paul Duffin
820888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override boolean isPartialView() {
830888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return false;
840888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
850888a09821a98ac0680fad765217302858e70fa4Paul Duffin
860888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override public C first() {
870888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return range.lowerBound.leastValueAbove(domain);
880888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
890888a09821a98ac0680fad765217302858e70fa4Paul Duffin
900888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override public C last() {
910888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return range.upperBound.greatestValueBelow(domain);
920888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
930888a09821a98ac0680fad765217302858e70fa4Paul Duffin
940888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override public int size() {
950888a09821a98ac0680fad765217302858e70fa4Paul Duffin    long distance = domain.distance(first(), last());
960888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return (distance >= Integer.MAX_VALUE) ? Integer.MAX_VALUE : (int) distance + 1;
970888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
980888a09821a98ac0680fad765217302858e70fa4Paul Duffin
990888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override public boolean contains(@Nullable Object object) {
1000888a09821a98ac0680fad765217302858e70fa4Paul Duffin    if (object == null) {
1010888a09821a98ac0680fad765217302858e70fa4Paul Duffin      return false;
1020888a09821a98ac0680fad765217302858e70fa4Paul Duffin    }
1030888a09821a98ac0680fad765217302858e70fa4Paul Duffin    try {
1040888a09821a98ac0680fad765217302858e70fa4Paul Duffin      return range.contains((C) object);
1050888a09821a98ac0680fad765217302858e70fa4Paul Duffin    } catch (ClassCastException e) {
1060888a09821a98ac0680fad765217302858e70fa4Paul Duffin      return false;
1070888a09821a98ac0680fad765217302858e70fa4Paul Duffin    }
1080888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
1090888a09821a98ac0680fad765217302858e70fa4Paul Duffin
1100888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override public boolean containsAll(Collection<?> targets) {
1110888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return Collections2.containsAllImpl(this, targets);
1120888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
1130888a09821a98ac0680fad765217302858e70fa4Paul Duffin
1140888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override public boolean isEmpty() {
1150888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return false;
1160888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
1170888a09821a98ac0680fad765217302858e70fa4Paul Duffin
1180888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override public ContiguousSet<C> intersection(ContiguousSet<C> other) {
1190888a09821a98ac0680fad765217302858e70fa4Paul Duffin    checkNotNull(other);
1200888a09821a98ac0680fad765217302858e70fa4Paul Duffin    checkArgument(this.domain.equals(other.domain));
1210888a09821a98ac0680fad765217302858e70fa4Paul Duffin    if (other.isEmpty()) {
1220888a09821a98ac0680fad765217302858e70fa4Paul Duffin      return other;
1230888a09821a98ac0680fad765217302858e70fa4Paul Duffin    } else {
1240888a09821a98ac0680fad765217302858e70fa4Paul Duffin      C lowerEndpoint = Ordering.natural().max(this.first(), other.first());
1250888a09821a98ac0680fad765217302858e70fa4Paul Duffin      C upperEndpoint = Ordering.natural().min(this.last(), other.last());
1260888a09821a98ac0680fad765217302858e70fa4Paul Duffin      return (lowerEndpoint.compareTo(upperEndpoint) < 0)
1270888a09821a98ac0680fad765217302858e70fa4Paul Duffin          ? ContiguousSet.create(Range.closed(lowerEndpoint, upperEndpoint), domain)
1280888a09821a98ac0680fad765217302858e70fa4Paul Duffin          : new EmptyContiguousSet<C>(domain);
1290888a09821a98ac0680fad765217302858e70fa4Paul Duffin    }
1300888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
1310888a09821a98ac0680fad765217302858e70fa4Paul Duffin
1320888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override public Range<C> range() {
1330888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return range(CLOSED, CLOSED);
1340888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
1350888a09821a98ac0680fad765217302858e70fa4Paul Duffin
1360888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override public Range<C> range(BoundType lowerBoundType, BoundType upperBoundType) {
1370888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return Range.create(range.lowerBound.withLowerBoundType(lowerBoundType, domain),
1380888a09821a98ac0680fad765217302858e70fa4Paul Duffin        range.upperBound.withUpperBoundType(upperBoundType, domain));
1390888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
1400888a09821a98ac0680fad765217302858e70fa4Paul Duffin
1410888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override public boolean equals(@Nullable Object object) {
1420888a09821a98ac0680fad765217302858e70fa4Paul Duffin    if (object == this) {
1430888a09821a98ac0680fad765217302858e70fa4Paul Duffin      return true;
1440888a09821a98ac0680fad765217302858e70fa4Paul Duffin    } else if (object instanceof RegularContiguousSet) {
1450888a09821a98ac0680fad765217302858e70fa4Paul Duffin      RegularContiguousSet<?> that = (RegularContiguousSet<?>) object;
1460888a09821a98ac0680fad765217302858e70fa4Paul Duffin      if (this.domain.equals(that.domain)) {
1470888a09821a98ac0680fad765217302858e70fa4Paul Duffin        return this.first().equals(that.first())
1480888a09821a98ac0680fad765217302858e70fa4Paul Duffin            && this.last().equals(that.last());
1490888a09821a98ac0680fad765217302858e70fa4Paul Duffin      }
1500888a09821a98ac0680fad765217302858e70fa4Paul Duffin    }
1510888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return super.equals(object);
1520888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
1530888a09821a98ac0680fad765217302858e70fa4Paul Duffin
1540888a09821a98ac0680fad765217302858e70fa4Paul Duffin  // copied to make sure not to use the GWT-emulated version
1550888a09821a98ac0680fad765217302858e70fa4Paul Duffin  @Override public int hashCode() {
1560888a09821a98ac0680fad765217302858e70fa4Paul Duffin    return Sets.hashCodeImpl(this);
1570888a09821a98ac0680fad765217302858e70fa4Paul Duffin  }
1580888a09821a98ac0680fad765217302858e70fa4Paul Duffin
1590888a09821a98ac0680fad765217302858e70fa4Paul Duffin  private static final long serialVersionUID = 0;
1600888a09821a98ac0680fad765217302858e70fa4Paul Duffin}
1610888a09821a98ac0680fad765217302858e70fa4Paul Duffin
162