001/* 002 * Units of Measurement Reference Implementation 003 * Copyright (c) 2005-2017, Jean-Marie Dautelle, Werner Keil, V2COM. 004 * 005 * All rights reserved. 006 * 007 * Redistribution and use in source and binary forms, with or without modification, 008 * are permitted provided that the following conditions are met: 009 * 010 * 1. Redistributions of source code must retain the above copyright notice, 011 * this list of conditions and the following disclaimer. 012 * 013 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions 014 * and the following disclaimer in the documentation and/or other materials provided with the distribution. 015 * 016 * 3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products 017 * derived from this software without specific prior written permission. 018 * 019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 021 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 022 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 023 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 026 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 028 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 029 */ 030package tec.units.ri.function; 031 032import javax.measure.UnitConverter; 033 034import tec.units.ri.AbstractConverter; 035import tec.uom.lib.common.function.ValueSupplier; 036 037/** 038 * <p> 039 * This class represents a converter adding a constant offset to numeric values (<code>double</code> based). 040 * </p> 041 * 042 * @author <a href="mailto:jean-marie@dautelle.com">Jean-Marie Dautelle</a> 043 * @author Werner Keil 044 * @version 1.0, Oct 5, 2016 045 * @since 1.0 046 */ 047public final class AddConverter extends AbstractConverter implements ValueSupplier<Double> { 048 049 /** 050 * 051 */ 052 // private static final long serialVersionUID = -2981335308595652284L; 053 /** 054 * Holds the offset. 055 */ 056 private double offset; 057 058 /** 059 * Creates an additive converter having the specified offset. 060 * 061 * @param offset 062 * the offset value. 063 * @throws IllegalArgumentException 064 * if offset is <code>0.0</code> (would result in identity converter). 065 */ 066 public AddConverter(double offset) { 067 if (offset == 0.0) 068 throw new IllegalArgumentException("Would result in identity converter"); 069 this.offset = offset; 070 } 071 072 /** 073 * Returns the offset value for this add converter. 074 * 075 * @return the offset value. 076 */ 077 public double getOffset() { 078 return offset; 079 } 080 081 @Override 082 public UnitConverter concatenate(UnitConverter converter) { 083 if (!(converter instanceof AddConverter)) 084 return super.concatenate(converter); 085 double newOffset = offset + ((AddConverter) converter).offset; 086 return newOffset == 0.0 ? IDENTITY : new AddConverter(newOffset); 087 } 088 089 @Override 090 public AddConverter inverse() { 091 return new AddConverter(-offset); 092 } 093 094 @Override 095 public double convert(double value) { 096 return value + offset; 097 } 098 099 @Override 100 public final String toString() { 101 return "AddConverter(" + offset + ")"; 102 } 103 104 @Override 105 public boolean equals(Object obj) { 106 if (!(obj instanceof AddConverter)) { 107 return false; 108 } 109 AddConverter that = (AddConverter) obj; 110 return this.offset == that.offset; 111 } 112 113 @Override 114 public int hashCode() { 115 long bits = Double.doubleToLongBits(offset); 116 return (int) (bits ^ (bits >>> 32)); 117 } 118 119 public boolean isLinear() { 120 return false; 121 } 122 123 public Double getValue() { 124 return offset; 125 } 126 127}