tec.units.ri.util.Range Maven / Gradle / Ivy
Show all versions of unit-ri Show documentation
/**
* Unit-API - Units of Measurement API for Java
* Copyright (c) 2005-2014, Jean-Marie Dautelle, Werner Keil, V2COM.
*
* 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. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS 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 COPYRIGHT HOLDER OR 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.
*/
package tec.units.ri.util;
import java.util.Objects;
import tec.units.ri.function.MaximumSupplier;
import tec.units.ri.function.MinimumSupplier;
/**
* A Range is a pair of T items that represent a range
* of values.
*
* Subclasses of Range should be immutable.
*
* @param
* The value of the range.
*
* @author Werner Keil
* @version 0.8.8, November 29, 2014
*/
public abstract class Range implements MinimumSupplier, MaximumSupplier {
// TODO do we keep null for min and max to represent infinity?
// Java 8 Optional was evaluated, but caused conflict with the type-safe
// Quantity feature of this API, plus it won't work in CLDC8
private final T min;
private final T max;
/**
* Construct an instance of Range with a min and max value.
*
* @param min
* The minimum value for the measurement range.
* @param max
* The maximum value for the measurement range.
*/
protected Range(T min, T max) {
this.min = min;
this.max = max;
}
/**
* Returns the smallest value of the range. The value is the same as that
* given as the constructor parameter for the smallest value.
*
* @return the minimum value
*/
public T getMinimum() {
return min;
}
/**
* Returns the largest value of the measurement range. The value is the same
* as that given as the constructor parameter for the largest value.
*
* @return the maximum value
*/
public T getMaximum() {
return max;
}
/**
* Method to easily check if {@link #getMinimum()} is not {@code null}.
*
* @return {@code true} if {@link #getMinimum()} is not {@code null} .
*/
public boolean hasMinimum() {
return min != null;
}
/**
* Method to easily check if {@link #getMaximum()} is not {@code null}.
*
* @return {@code true} if {@link #getMaximum()} is not {@code null}.
*/
public boolean hasMaximum() {
return max != null;
}
/**
* Checks whether the given T is within this range
* @param t
* @return true if the value is within the range
*/
public abstract boolean contains(T t);
/*
* (non-Javadoc)
*
* @see java.lang.Object#equals()
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj instanceof Range) {
@SuppressWarnings("unchecked")
final Range other = (Range) obj;
return Objects.equals(getMinimum(), other.getMinimum()) &&
Objects.equals(getMaximum(), other.getMaximum());
}
return false;
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
return Objects.hash(min, max);
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
final StringBuilder sb = new StringBuilder().append("min= ")
.append(getMinimum()).append(", max= ").append(getMaximum());
return sb.toString();
}
}