diff options
author | Andrew Vuong <akvuong@google.com> | 2023-02-13 22:56:43 +0000 |
---|---|---|
committer | Andrew Vuong <akvuong@google.com> | 2023-02-14 00:40:02 +0000 |
commit | ff344be6c0384630de66ca1a0f5955e41c32a627 (patch) | |
tree | 8e1380b130c548b03135010a952574030e77ada9 /src/main/java/org/apache/commons/lang3/IntegerRange.java | |
parent | 2a77099c93be7bbf4d56b677d968bfca258b558f (diff) | |
parent | eaff7e0a693455081932b53688029f0700447305 (diff) | |
download | apache-commons-lang-ff344be6c0384630de66ca1a0f5955e41c32a627.tar.gz |
Initial import of apache-commons-lang from upstream masterplatform-tools-34.0.1
Bug: 262898801
Test: mma
Change-Id: Ib169804396e5bbe17b10609b3754d8473c637c2e
Diffstat (limited to 'src/main/java/org/apache/commons/lang3/IntegerRange.java')
-rw-r--r-- | src/main/java/org/apache/commons/lang3/IntegerRange.java | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/lang3/IntegerRange.java b/src/main/java/org/apache/commons/lang3/IntegerRange.java new file mode 100644 index 000000000..f3666ae89 --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/IntegerRange.java @@ -0,0 +1,84 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.commons.lang3; + +/** + * Specializes {@link NumberRange} for {@link Integer}s. + * + * <p> + * This class is not designed to interoperate with other NumberRanges + * </p> + * + * @since 3.13.0 + */ +public final class IntegerRange extends NumberRange<Integer> { + + private static final long serialVersionUID = 1L; + + /** + * Creates a range with the specified minimum and maximum values (both inclusive). + * + * <p> + * The range uses the natural ordering of the elements to determine where values lie in the range. + * </p> + * + * <p> + * The arguments may be passed in the order (min,max) or (max,min). The getMinimum and getMaximum methods will return the correct values. + * </p> + * + * @param fromInclusive the first value that defines the edge of the range, inclusive. + * @param toInclusive the second value that defines the edge of the range, inclusive. + * @return the range object, not null. + */ + public static IntegerRange of(final int fromInclusive, final int toInclusive) { + return of(Integer.valueOf(fromInclusive), Integer.valueOf(toInclusive)); + } + + /** + * Creates a range with the specified minimum and maximum values (both inclusive). + * + * <p> + * The range uses the natural ordering of the elements to determine where values lie in the range. + * </p> + * + * <p> + * The arguments may be passed in the order (min,max) or (max,min). The getMinimum and getMaximum methods will return the correct values. + * </p> + * + * @param fromInclusive the first value that defines the edge of the range, inclusive. + * @param toInclusive the second value that defines the edge of the range, inclusive. + * @return the range object, not null. + * @throws IllegalArgumentException if either element is null. + */ + public static IntegerRange of(final Integer fromInclusive, final Integer toInclusive) { + return new IntegerRange(fromInclusive, toInclusive); + } + + /** + * Creates an instance. + * + * @param number1 the first element, not null + * @param number2 the second element, not null + * @throws NullPointerException when element1 is null. + * @throws NullPointerException when element2 is null. + */ + private IntegerRange(final Integer number1, final Integer number2) { + super(number1, number2, null); + } + +} |