org.jaitools.media.jai.rangelookup.LookupItem Maven / Gradle / Ivy
/*
* Copyright (c) 2011, Michael Bedward. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* - 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.
*
* 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 org.jaitools.media.jai.rangelookup;
import org.jaitools.numeric.Range;
/**
* Used by {@link RangeLookupTable} to define a single lookup range and return value.
*
* @param type of the source range
* @param type of the return value
*
* @author Michael Bedward
* @author Simone Giannecchini, GeoSolutions
* @since 1.1
* @version $Id$
*/
public class LookupItem, U extends Number & Comparable super U>> {
/** Lookup range. Package-access field. */
Range range;
/** Return value. Package-access field. */
U value;
/**
* Creates a new instance.
*
* @param range the lookup range
* @param value the return value
* @throws IllegalArgumentException if either arg is {@code null}
*/
public LookupItem(Range range, U value) {
if (range == null || value == null) {
throw new IllegalArgumentException("Both range and value must be non-null");
}
this.range = range;
this.value = value;
}
/**
* Gets a copy of this item's range.
*
* @return the range
*/
public Range getRange() {
return new Range(range);
}
/**
* Gets this item's return value.
* @return
*/
public U getValue() {
return value;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((value == null) ? 0 : value.hashCode());
result = prime * result + ((range == null) ? 0 : range.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
LookupItem other = (LookupItem) obj;
if (value == null) {
if (other.value != null) {
return false;
}
} else if (!value.equals(other.value)) {
return false;
}
if (range == null) {
if (other.range != null) {
return false;
}
} else if (!range.equals(other.range)) {
return false;
}
return true;
}
@Override
public String toString() {
return range.toString() + " => " + value;
}
}