jersey.repackaged.com.google.common.collect.Ranges Maven / Gradle / Ivy
/*
* Copyright (C) 2009 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 jersey.repackaged.com.google.common.collect;
import jersey.repackaged.com.google.common.annotations.Beta;
import jersey.repackaged.com.google.common.annotations.GwtCompatible;
import java.util.NoSuchElementException;
/**
* Static methods pertaining to {@link Range} instances. Each of the
* {@link Range nine types of ranges} can be constructed with a corresponding
* factory method:
*
*
* - {@code (a..b)}
*
- {@link #open}
*
- {@code [a..b]}
*
- {@link #closed}
*
- {@code [a..b)}
*
- {@link #closedOpen}
*
- {@code (a..b]}
*
- {@link #openClosed}
*
- {@code (a..+∞)}
*
- {@link #greaterThan}
*
- {@code [a..+∞)}
*
- {@link #atLeast}
*
- {@code (-∞..b)}
*
- {@link #lessThan}
*
- {@code (-∞..b]}
*
- {@link #atMost}
*
- {@code (-∞..+∞)}
*
- {@link #all}
*
*
* Additionally, {@link Range} instances can be constructed by passing the
* {@link BoundType bound types} explicitly.
*
*
* - Bounded on both ends
*
- {@link #range}
*
- Unbounded on top ({@code (a..+∞)} or {@code (a..+∞)})
*
- {@link #downTo}
*
- Unbounded on bottom ({@code (-∞..b)} or {@code (-∞..b]})
*
- {@link #upTo}
*
*
* See the Guava User Guide article on
* {@code Range}.
*
* @author Kevin Bourrillion
* @author Gregory Kick
* @since 10.0
* @deprecated Use the corresponding method in {@link Range}.
*/
@Deprecated
@GwtCompatible
@Beta
public final class Ranges {
private Ranges() {}
/**
* Returns a range that contains all values strictly greater than {@code
* lower} and strictly less than {@code upper}.
*
* @throws IllegalArgumentException if {@code lower} is greater than or
* equal to {@code upper}
*/
public static > Range open(C lower, C upper) {
return Range.open(lower, upper);
}
/**
* Returns a range that contains all values greater than or equal to
* {@code lower} and less than or equal to {@code upper}.
*
* @throws IllegalArgumentException if {@code lower} is greater than {@code
* upper}
*/
public static > Range closed(C lower, C upper) {
return Range.closed(lower, upper);
}
/**
* Returns a range that contains all values greater than or equal to
* {@code lower} and strictly less than {@code upper}.
*
* @throws IllegalArgumentException if {@code lower} is greater than {@code
* upper}
*/
public static > Range closedOpen(
C lower, C upper) {
return Range.closedOpen(lower, upper);
}
/**
* Returns a range that contains all values strictly greater than {@code
* lower} and less than or equal to {@code upper}.
*
* @throws IllegalArgumentException if {@code lower} is greater than {@code
* upper}
*/
public static > Range openClosed(
C lower, C upper) {
return Range.openClosed(lower, upper);
}
/**
* Returns a range that contains any value from {@code lower} to {@code
* upper}, where each endpoint may be either inclusive (closed) or exclusive
* (open).
*
* @throws IllegalArgumentException if {@code lower} is greater than {@code
* upper}
*/
public static > Range range(
C lower, BoundType lowerType, C upper, BoundType upperType) {
return Range.range(lower, lowerType, upper, upperType);
}
/**
* Returns a range that contains all values strictly less than {@code
* endpoint}.
*/
public static > Range lessThan(C endpoint) {
return Range.lessThan(endpoint);
}
/**
* Returns a range that contains all values less than or equal to
* {@code endpoint}.
*/
public static > Range atMost(C endpoint) {
return Range.atMost(endpoint);
}
/**
* Returns a range with no lower bound up to the given endpoint, which may be
* either inclusive (closed) or exclusive (open).
*/
public static > Range upTo(
C endpoint, BoundType boundType) {
return Range.upTo(endpoint, boundType);
}
/**
* Returns a range that contains all values strictly greater than {@code
* endpoint}.
*/
public static > Range greaterThan(C endpoint) {
return Range.greaterThan(endpoint);
}
/**
* Returns a range that contains all values greater than or equal to
* {@code endpoint}.
*/
public static > Range atLeast(C endpoint) {
return Range.atLeast(endpoint);
}
/**
* Returns a range from the given endpoint, which may be either inclusive
* (closed) or exclusive (open), with no upper bound.
*/
public static > Range downTo(
C endpoint, BoundType boundType) {
return Range.downTo(endpoint, boundType);
}
/** Returns a range that contains every value of type {@code C}. */
public static > Range all() {
return Range.all();
}
/**
* Returns a range that {@linkplain Range#contains(Comparable) contains} only
* the given value. The returned range is {@linkplain BoundType#CLOSED closed}
* on both ends.
*/
public static > Range singleton(C value) {
return Range.singleton(value);
}
/**
* Returns the minimal range that
* {@linkplain Range#contains(Comparable) contains} all of the given values.
* The returned range is {@linkplain BoundType#CLOSED closed} on both ends.
*
* @throws ClassCastException if the parameters are not mutually
* comparable
* @throws NoSuchElementException if {@code values} is empty
* @throws NullPointerException if any of {@code values} is null
*/
public static > Range encloseAll(
Iterable values) {
return Range.encloseAll(values);
}
}