You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ba...@apache.org on 2002/02/28 04:02:37 UTC
cvs commit: jakarta-commons-sandbox/lang/src/test/org/apache/commons/lang NumberRangeTest.java
bayard 02/02/27 19:02:37
Added: lang/src/java/org/apache/commons/lang NumberRange.java
lang/src/test/org/apache/commons/lang NumberRangeTest.java
Log:
New NumberRange class. Deals with a range of Number objects.
Submitted by: Christopher Elkins <ch...@scardini.com>
Revision Changes Path
1.1 jakarta-commons-sandbox/lang/src/java/org/apache/commons/lang/NumberRange.java
Index: NumberRange.java
===================================================================
package org.apache.commons.lang;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Commons" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Turbine", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
/**
* Represents a range of {@link Number} objects.
*
* @author <a href="mailto:chrise@esha.com">Christopher Elkins</a>
* @version $Revision: 1.1 $ $Date: 2002/02/28 03:02:37 $
*/
public final class NumberRange {
/* The minimum number in this range. */
private final Number min;
/* The maximum number in this range. */
private final Number max;
/**
* Constructs a new instance using the specified number as both the
* minimum and maximum in theis range.
*
* @param num the number to use for this range
* @throws NullPointerException if the number is <code>null</code>
*/
public NumberRange(Number num) {
if (num == null) {
throw new NullPointerException("num cannot be null");
}
this.min = this.max = num;
}
/**
* Constructs a new instance with the specified minimum and maximum
* numbers.
*
* @param min the minimum number in this range
* @param max the maximum number in this range
* @throws NullPointerException if either the minimum or maximum number is
* <code>null</code>
*/
public NumberRange(Number min, Number max) {
if (min == null) {
throw new NullPointerException("min cannot be null");
} else if (max == null) {
throw new NullPointerException("max cannot be null");
}
if (max.doubleValue() < min.doubleValue()) {
this.min = this.max = min;
} else {
this.min = min;
this.max = max;
}
}
/**
* Returns the minimum number in this range.
*
* @return the minimum number in this range
*/
public Number getMinimum() {
return min;
}
/**
* Returns the maximum number in this range.
*
* @return the maximum number in this range
*/
public Number getMaximum() {
return min;
}
/**
* Tests whether the specified number occurs within this range.
*
* @param number the number to test
* @return <code>true</code> if the specified number occurs within this
* range; otherwise, <code>false</code>
*/
public boolean includesNumber(Number number) {
if (number == null) {
return false;
} else {
return !(min.doubleValue() > number.doubleValue()) &&
!(max.doubleValue() < number.doubleValue());
}
}
/**
* Tests whether the specified range occurs entirely within this range.
*
* @param range the range to test
* @return <code>true</code> if the specified range occurs entirely within
* this range; otherwise, <code>false</code>
*/
public boolean includesRange(NumberRange range) {
if (range == null) {
return false;
} else {
return includesNumber(range.min) && includesNumber(range.max);
}
}
/**
* Tests whether the specified range overlaps with this range.
*
* @param range the range to test
* @return <code>true</code> if the specified range overlaps with this
* range; otherwise, <code>false</code>
*/
public boolean overlaps(NumberRange range) {
if (range == null) {
return false;
} else {
return range.includesNumber(min) || range.includesNumber(max) ||
includesRange(range);
}
}
/**
* Indicates whether some other object is "equal" to this one.
*
* @param obj the reference object with which to compare
* @return <code>true</code> if this object is the same as the obj
* argument; <code>false</code> otherwise
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
} else if (!(obj instanceof NumberRange)) {
return false;
} else {
NumberRange range = (NumberRange)obj;
return min.equals(range.min) && max.equals(range.max);
}
}
/**
* Returns a hash code value for this object.
*
* @return a hash code value for this object
*/
public int hashCode() {
int result = 17;
result = 37*result + min.hashCode();
result = 37*result + max.hashCode();
return result;
}
/**
* Returns the string representation of this range. This string is the
* string representation of the minimum and maximum numbers in the range,
* separated by a hyphen. If a number is negative, then it is enclosed
* in parentheses.
*
* @return the string representation of this range
*/
public String toString() {
StringBuffer sb = new StringBuffer();
if (min.intValue() < 0) {
sb.append('(')
.append(min)
.append(')');
} else {
sb.append(min);
}
sb.append('-');
if (max.intValue() < 0) {
sb.append('(')
.append(max)
.append(')');
} else {
sb.append(max);
}
return sb.toString();
}
}
1.1 jakarta-commons-sandbox/lang/src/test/org/apache/commons/lang/NumberRangeTest.java
Index: NumberRangeTest.java
===================================================================
package org.apache.commons.lang;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Commons" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Turbine", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
/**
* Test cases for the {@link NumberRange} class.
*
* @author <a href="mailto:chrise@esha.com">Christopher Elkins</a>
* @version $Revision: 1.1 $ $Date: 2002/02/28 03:02:37 $
*/
public final class NumberRangeTest extends TestCase {
private NumberRange tenToTwenty;
private Number five;
private Number ten;
private Number fifteen;
private Number twenty;
private Number twentyFive;
public NumberRangeTest(String name) {
super(name);
}
public void setUp() {
five = new Integer(5);
ten = new Integer(10);
fifteen = new Integer(15);
twenty = new Integer(20);
twentyFive = new Integer(25);
tenToTwenty = new NumberRange(ten, twenty);
}
public static Test suite() {
TestSuite suite = new TestSuite();
suite.addTest(new NumberRangeTest("testEquals"));
suite.addTest(new NumberRangeTest("testIncludesNumber"));
suite.addTest(new NumberRangeTest("testIncludesRange"));
suite.addTest(new NumberRangeTest("testToString"));
return suite;
}
public void testEquals() {
boolean expected = false;
boolean result = tenToTwenty.equals(new NumberRange(five, ten));
assertEquals(expected, result);
expected = true;
result = tenToTwenty.equals(new NumberRange(ten, twenty));
assertEquals(expected, result);
expected = false;
result = tenToTwenty.equals(new NumberRange(ten, fifteen));
assertEquals(expected, result);
expected = false;
result = tenToTwenty.equals(new NumberRange(fifteen, twenty));
assertEquals(expected, result);
}
public void testIncludesNumber() {
boolean expected = false;
boolean result = tenToTwenty.includesNumber(five);
assertEquals(expected, result);
expected = true;
result = tenToTwenty.includesNumber(ten);
assertEquals(expected, result);
expected = true;
result = tenToTwenty.includesNumber(fifteen);
assertEquals(expected, result);
expected = true;
result = tenToTwenty.includesNumber(twenty);
assertEquals(expected, result);
expected = false;
result = tenToTwenty.includesNumber(twentyFive);
assertEquals(expected, result);
}
public void testIncludesRange() {
boolean expected = false;
boolean result = tenToTwenty.includesRange(new NumberRange(five, ten));
assertEquals(expected, result);
expected = false;
result = tenToTwenty.includesRange(new NumberRange(five, fifteen));
assertEquals(expected, result);
expected = true;
result = tenToTwenty.includesRange(new NumberRange(ten, fifteen));
assertEquals(expected, result);
expected = true;
result = tenToTwenty.includesRange(new NumberRange(ten, twenty));
assertEquals(expected, result);
expected = true;
result = tenToTwenty.includesRange(new NumberRange(fifteen, twenty));
assertEquals(expected, result);
expected = false;
result =
tenToTwenty.includesRange(new NumberRange(fifteen, twentyFive));
assertEquals(expected, result);
expected = false;
result =
tenToTwenty.includesRange(new NumberRange(twenty, twentyFive));
assertEquals(expected, result);
}
public void testToString() {
String expected = "10-20";
String result = tenToTwenty.toString();
assertEquals(expected, result);
}
}
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>