org.apache.commons.lang.math.IntRange Maven / Gradle / Ivy
/*
* 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.lang.math;
import java.io.Serializable;
import org.apache.commons.lang.text.StrBuilder;
/**
* IntRange represents an inclusive range of ints.
*
* @author Apache Software Foundation
* @since 2.0
* @version $Id: IntRange.java 1057072 2011-01-10 01:55:57Z niallp $
*/
public final class IntRange extends Range implements Serializable {
/**
* Required for serialization support.
*
* @see java.io.Serializable
*/
private static final long serialVersionUID = 71849363892730L;
/**
* The minimum number in this range (inclusive).
*/
private final int min;
/**
* The maximum number in this range (inclusive).
*/
private final int max;
/**
* Cached output minObject (class is immutable).
*/
private transient Integer minObject = null;
/**
* Cached output maxObject (class is immutable).
*/
private transient Integer maxObject = null;
/**
* Cached output hashCode (class is immutable).
*/
private transient int hashCode = 0;
/**
* Cached output toString (class is immutable).
*/
private transient String toString = null;
/**
* Constructs a new IntRange using the specified
* number as both the minimum and maximum in this range.
*
* @param number the number to use for this range
*/
public IntRange(int number) {
super();
this.min = number;
this.max = number;
}
/**
* Constructs a new IntRange using the specified
* number as both the minimum and maximum in this range.
*
* @param number the number to use for this range, must not be null
* @throws IllegalArgumentException if the number is null
*/
public IntRange(Number number) {
super();
if (number == null) {
throw new IllegalArgumentException("The number must not be null");
}
this.min = number.intValue();
this.max = number.intValue();
if (number instanceof Integer) {
this.minObject = (Integer) number;
this.maxObject = (Integer) number;
}
}
/**
* Constructs a new IntRange with the specified
* minimum and maximum numbers (both inclusive).
*
* The arguments may be passed in the order (min,max) or (max,min). The
* getMinimum and getMaximum methods will return the correct values.
*
* @param number1 first number that defines the edge of the range, inclusive
* @param number2 second number that defines the edge of the range, inclusive
*/
public IntRange(int number1, int number2) {
super();
if (number2 < number1) {
this.min = number2;
this.max = number1;
} else {
this.min = number1;
this.max = number2;
}
}
/**
* Constructs a new IntRange with the specified
* minimum and maximum numbers (both inclusive).
*
* The arguments may be passed in the order (min,max) or (max,min). The
* getMinimum and getMaximum methods will return the correct values.
*
* @param number1 first number that defines the edge of the range, inclusive
* @param number2 second number that defines the edge of the range, inclusive
* @throws IllegalArgumentException if either number is null
*/
public IntRange(Number number1, Number number2) {
super();
if (number1 == null || number2 == null) {
throw new IllegalArgumentException("The numbers must not be null");
}
int number1val = number1.intValue();
int number2val = number2.intValue();
if (number2val < number1val) {
this.min = number2val;
this.max = number1val;
if (number2 instanceof Integer) {
this.minObject = (Integer) number2;
}
if (number1 instanceof Integer) {
this.maxObject = (Integer) number1;
}
} else {
this.min = number1val;
this.max = number2val;
if (number1 instanceof Integer) {
this.minObject = (Integer) number1;
}
if (number2 instanceof Integer) {
this.maxObject = (Integer) number2;
}
}
}
// Accessors
//--------------------------------------------------------------------
/**
* Returns the minimum number in this range.
*
* @return the minimum number in this range
*/
public Number getMinimumNumber() {
if (minObject == null) {
minObject = new Integer(min);
}
return minObject;
}
/**
* Gets the minimum number in this range as a long.
*
* @return the minimum number in this range
*/
public long getMinimumLong() {
return min;
}
/**
* Gets the minimum number in this range as a int.
*
* @return the minimum number in this range
*/
public int getMinimumInteger() {
return min;
}
/**
* Gets the minimum number in this range as a double.
*
* @return the minimum number in this range
*/
public double getMinimumDouble() {
return min;
}
/**
* Gets the minimum number in this range as a float.
*
* @return the minimum number in this range
*/
public float getMinimumFloat() {
return min;
}
/**
* Returns the maximum number in this range.
*
* @return the maximum number in this range
*/
public Number getMaximumNumber() {
if (maxObject == null) {
maxObject = new Integer(max);
}
return maxObject;
}
/**
* Gets the maximum number in this range as a long.
*
* @return the maximum number in this range
*/
public long getMaximumLong() {
return max;
}
/**
* Gets the maximum number in this range as a int.
*
* @return the maximum number in this range
*/
public int getMaximumInteger() {
return max;
}
/**
* Gets the maximum number in this range as a double.
*
* @return the maximum number in this range
*/
public double getMaximumDouble() {
return max;
}
/**
* Gets the maximum number in this range as a float.
*
* @return the maximum number in this range
*/
public float getMaximumFloat() {
return max;
}
// Tests
//--------------------------------------------------------------------
/**
* Tests whether the specified number occurs within
* this range using int comparison.
*
* null is handled and returns false.
*
* @param number the number to test, may be null
* @return true if the specified number occurs within this range
*/
public boolean containsNumber(Number number) {
if (number == null) {
return false;
}
return containsInteger(number.intValue());
}
/**
* Tests whether the specified int occurs within
* this range using int comparison.
*
* This implementation overrides the superclass for performance as it is
* the most common case.
*
* @param value the int to test
* @return true if the specified number occurs within this
* range by int comparison
*/
public boolean containsInteger(int value) {
return value >= min && value <= max;
}
// Range tests
//--------------------------------------------------------------------
/**
* Tests whether the specified range occurs entirely within this range
* using int comparison.
*
* null is handled and returns false.
*
* @param range the range to test, may be null
* @return true if the specified range occurs entirely within this range
* @throws IllegalArgumentException if the range is not of this type
*/
public boolean containsRange(Range range) {
if (range == null) {
return false;
}
return containsInteger(range.getMinimumInteger()) &&
containsInteger(range.getMaximumInteger());
}
/**
* Tests whether the specified range overlaps with this range
* using int comparison.
*
* null is handled and returns false.
*
* @param range the range to test, may be null
* @return true if the specified range overlaps with this range
*/
public boolean overlapsRange(Range range) {
if (range == null) {
return false;
}
return range.containsInteger(min) ||
range.containsInteger(max) ||
containsInteger(range.getMinimumInteger());
}
// Basics
//--------------------------------------------------------------------
/**
* Compares this range to another object to test if they are equal.
.
*
* To be equal, the class, minimum and maximum must be equal.
*
* @param obj the reference object with which to compare
* @return true if this object is equal
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj instanceof IntRange == false) {
return false;
}
IntRange range = (IntRange) obj;
return min == range.min && max == range.max;
}
/**
* Gets a hashCode for the range.
*
* @return a hash code value for this object
*/
public int hashCode() {
if (hashCode == 0) {
hashCode = 17;
hashCode = 37 * hashCode + getClass().hashCode();
hashCode = 37 * hashCode + min;
hashCode = 37 * hashCode + max;
}
return hashCode;
}
/**
* Gets the range as a String.
*
* The format of the String is 'Range[min,max]'.
*
* @return the String representation of this range
*/
public String toString() {
if (toString == null) {
StrBuilder buf = new StrBuilder(32);
buf.append("Range[");
buf.append(min);
buf.append(',');
buf.append(max);
buf.append(']');
toString = buf.toString();
}
return toString;
}
/**
* Returns an array containing all the integer values in the range.
*
* @return the int[] representation of this range
* @since 2.4
*/
public int[] toArray() {
int[] array = new int[max - min + 1];
for (int i = 0; i < array.length; i++) {
array[i] = min + i;
}
return array;
}
}