org.apache.commons.lang.math.Range Maven / Gradle / Ivy
Show all versions of commons-lang Show documentation
/*
* 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;
/**
* Range represents a range of numbers of the same type.
*
* Specific subclasses hold the range values as different types. Each
* subclass should be immutable and {@link java.io.Serializable Serializable}
* if possible.
*
* @author Stephen Colebourne
* @since 2.0
* @version $Id: Range.java 437554 2006-08-28 06:21:41Z bayard $
*/
public abstract class Range {
/**
* Constructs a new range.
*/
public Range() {
super();
}
// Accessors
//--------------------------------------------------------------------
/**
* Gets the minimum number in this range.
*
* @return the minimum number in this range
*/
public abstract Number getMinimumNumber();
/**
* Gets the minimum number in this range as a long.
*
* This implementation uses the {@link #getMinimumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the minimum number in this range
*/
public long getMinimumLong() {
return getMinimumNumber().longValue();
}
/**
* Gets the minimum number in this range as a int.
*
* This implementation uses the {@link #getMinimumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the minimum number in this range
*/
public int getMinimumInteger() {
return getMinimumNumber().intValue();
}
/**
* Gets the minimum number in this range as a double.
*
* This implementation uses the {@link #getMinimumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the minimum number in this range
*/
public double getMinimumDouble() {
return getMinimumNumber().doubleValue();
}
/**
* Gets the minimum number in this range as a float.
*
* This implementation uses the {@link #getMinimumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the minimum number in this range
*/
public float getMinimumFloat() {
return getMinimumNumber().floatValue();
}
/**
* Gets the maximum number in this range.
*
* @return the maximum number in this range
*/
public abstract Number getMaximumNumber();
/**
* Gets the maximum number in this range as a long.
*
* This implementation uses the {@link #getMaximumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the maximum number in this range
*/
public long getMaximumLong() {
return getMaximumNumber().longValue();
}
/**
* Gets the maximum number in this range as a int.
*
* This implementation uses the {@link #getMaximumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the maximum number in this range
*/
public int getMaximumInteger() {
return getMaximumNumber().intValue();
}
/**
* Gets the maximum number in this range as a double.
*
* This implementation uses the {@link #getMaximumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the maximum number in this range
*/
public double getMaximumDouble() {
return getMaximumNumber().doubleValue();
}
/**
* Gets the maximum number in this range as a float.
*
* This implementation uses the {@link #getMaximumNumber()} method.
* Subclasses may be able to optimise this.
*
* @return the maximum number in this range
*/
public float getMaximumFloat() {
return getMaximumNumber().floatValue();
}
// Include tests
//--------------------------------------------------------------------
/**
* Tests whether the specified Number occurs within
* this range.
*
* The exact comparison implementation varies by subclass. It is
* intended that an int specific subclass will compare 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
* @throws IllegalArgumentException if the Number cannot be compared
*/
public abstract boolean containsNumber(Number number);
/**
* Tests whether the specified Number occurs within
* this range using long comparison..
*
* null is handled and returns false.
*
* This implementation forwards to the {@link #containsLong(long)} method.
*
* @param value the long to test, may be null
* @return true if the specified number occurs within this
* range by long comparison
*/
public boolean containsLong(Number value) {
if (value == null) {
return false;
}
return containsLong(value.longValue());
}
/**
* Tests whether the specified long occurs within
* this range using long comparison.
*
* This implementation uses the {@link #getMinimumLong()} and
* {@link #getMaximumLong()} methods and should be good for most uses.
*
* @param value the long to test
* @return true if the specified number occurs within this
* range by long comparison
*/
public boolean containsLong(long value) {
return value >= getMinimumLong() && value <= getMaximumLong();
}
/**
* Tests whether the specified Number occurs within
* this range using int comparison..
*
* null is handled and returns false.
*
* This implementation forwards to the {@link #containsInteger(int)} method.
*
* @param value the integer to test, may be null
* @return true if the specified number occurs within this
* range by int comparison
*/
public boolean containsInteger(Number value) {
if (value == null) {
return false;
}
return containsInteger(value.intValue());
}
/**
* Tests whether the specified int occurs within
* this range using int comparison.
*
* This implementation uses the {@link #getMinimumInteger()} and
* {@link #getMaximumInteger()} methods and should be good for most uses.
*
* @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 >= getMinimumInteger() && value <= getMaximumInteger();
}
/**
* Tests whether the specified Number occurs within
* this range using double comparison..
*
* null is handled and returns false.
*
* This implementation forwards to the {@link #containsDouble(double)} method.
*
* @param value the double to test, may be null
* @return true if the specified number occurs within this
* range by double comparison
*/
public boolean containsDouble(Number value) {
if (value == null) {
return false;
}
return containsDouble(value.doubleValue());
}
/**
* Tests whether the specified double occurs within
* this range using double comparison.
*
* This implementation uses the {@link #getMinimumDouble()} and
* {@link #getMaximumDouble()} methods and should be good for most uses.
*
* @param value the double to test
* @return true if the specified number occurs within this
* range by double comparison
*/
public boolean containsDouble(double value) {
int compareMin = NumberUtils.compare(getMinimumDouble(), value);
int compareMax = NumberUtils.compare(getMaximumDouble(), value);
return compareMin <= 0 && compareMax >= 0;
}
/**
* Tests whether the specified Number occurs within
* this range using float comparison.
*
* null is handled and returns false.
*
* This implementation forwards to the {@link #containsFloat(float)} method.
*
* @param value the float to test, may be null
* @return true if the specified number occurs within this
* range by float comparison
*/
public boolean containsFloat(Number value) {
if (value == null) {
return false;
}
return containsFloat(value.floatValue());
}
/**
* Tests whether the specified float occurs within
* this range using float comparison.
*
* This implementation uses the {@link #getMinimumFloat()} and
* {@link #getMaximumFloat()} methods and should be good for most uses.
*
* @param value the float to test
* @return true if the specified number occurs within this
* range by float comparison
*/
public boolean containsFloat(float value) {
int compareMin = NumberUtils.compare(getMinimumFloat(), value);
int compareMax = NumberUtils.compare(getMaximumFloat(), value);
return compareMin <= 0 && compareMax >= 0;
}
// Range tests
//--------------------------------------------------------------------
/**
* Tests whether the specified range occurs entirely within this range.
*
* The exact comparison implementation varies by subclass. It is
* intended that an int specific subclass will compare using
* int comparison.
*
* null is handled and returns false.
*
* This implementation uses the {@link #containsNumber(Number)} method.
* Subclasses may be able to optimise this.
*
* @param range the range to test, may be null
* @return true if the specified range occurs entirely within
* this range; otherwise, false
* @throws IllegalArgumentException if the Range cannot be compared
*/
public boolean containsRange(Range range) {
if (range == null) {
return false;
}
return containsNumber(range.getMinimumNumber())
&& containsNumber(range.getMaximumNumber());
}
/**
* Tests whether the specified range overlaps with this range.
*
* The exact comparison implementation varies by subclass. It is
* intended that an int specific subclass will compare using
* int comparison.
*
* null is handled and returns false.
*
* This implementation uses the {@link #containsNumber(Number)} and
* {@link #containsRange(Range)} methods.
* Subclasses may be able to optimise this.
*
* @param range the range to test, may be null
* @return true if the specified range overlaps with this
* range; otherwise, false
* @throws IllegalArgumentException if the Range cannot be compared
*/
public boolean overlapsRange(Range range) {
if (range == null) {
return false;
}
return range.containsNumber(getMinimumNumber())
|| range.containsNumber(getMaximumNumber())
|| containsNumber(range.getMinimumNumber());
}
// Basics
//--------------------------------------------------------------------
/**
* Compares this range to another object to test if they are equal.
.
*
* To be equal, the class, minimum and maximum must be equal.
*
* This implementation uses the {@link #getMinimumNumber()} and
* {@link #getMaximumNumber()} methods.
* Subclasses may be able to optimise this.
*
* @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;
} else if (obj == null || obj.getClass() != getClass()) {
return false;
} else {
Range range = (Range) obj;
return getMinimumNumber().equals(range.getMinimumNumber()) &&
getMaximumNumber().equals(range.getMaximumNumber());
}
}
/**
* Gets a hashCode for the range.
*
* This implementation uses the {@link #getMinimumNumber()} and
* {@link #getMaximumNumber()} methods.
* Subclasses may be able to optimise this.
*
* @return a hash code value for this object
*/
public int hashCode() {
int result = 17;
result = 37 * result + getClass().hashCode();
result = 37 * result + getMinimumNumber().hashCode();
result = 37 * result + getMaximumNumber().hashCode();
return result;
}
/**
* Gets the range as a String.
*
* The format of the String is 'Range[min,max]'.
*
* This implementation uses the {@link #getMinimumNumber()} and
* {@link #getMaximumNumber()} methods.
* Subclasses may be able to optimise this.
*
* @return the String representation of this range
*/
public String toString() {
StringBuffer buf = new StringBuffer(32);
buf.append("Range[");
buf.append(getMinimumNumber());
buf.append(',');
buf.append(getMaximumNumber());
buf.append(']');
return buf.toString();
}
}