1 /* 2 * Copyright 2012, Google LLC 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google LLC nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 package com.android.tools.smali.dexlib2.iface.value; 32 33 import javax.annotation.Nonnull; 34 import javax.annotation.Nullable; 35 36 /** 37 * This class represents an encoded double value. 38 */ 39 public interface DoubleEncodedValue extends EncodedValue { 40 /** 41 * Gets the double value. 42 * 43 * @return the double value 44 */ getValue()45 double getValue(); 46 47 /** 48 * Returns a hashcode for this EncodedDoubleValue. 49 * 50 * This hashCode is defined to be the following: 51 * 52 * <pre> 53 * {@code 54 * long v = Double.doubleToRawLongBits(getValue()); 55 * int hashCode = (int)(v^(v>>>32)); 56 * }</pre> 57 * 58 * Note: This is slightly different than the definition of Double.hashCode(). This uses doubleToRawLongBits() 59 * instead of doubleToLongBits(), in order to preserve as much information as possible. 60 * 61 * @return The hash code value for this EncodedDoubleValue 62 */ hashCode()63 @Override int hashCode(); 64 65 /** 66 * Compares this DoubleEncodedValue to another DoubleEncodedValue for equality. 67 * 68 * This DoubleEncodedValue is equal to another DoubleEncodedValue if the values returned by 69 * getValue().doubleToRawLongBits() are equal. 70 * 71 * Note: this isn't quite the same as getValue() == getValue(), due to various NaN issues and signed zero issues. 72 * 73 * @param o The object to be compared for equality with this DoubleEncodedValue 74 * @return true if the specified object is equal to this DoubleEncodedValue 75 */ equals(@ullable Object o)76 @Override boolean equals(@Nullable Object o); 77 78 /** 79 * Compare this DoubleEncodedValue to another EncodedValue. 80 * 81 * The comparison is first done on the return values of getValueType(), and then if the other value is another 82 * DoubleEncodedValue, the return values of getValue() are compared, using the semantics of Double.compare() 83 * 84 * @param o The EncodedValue to compare with this DoubleEncodedValue 85 * @return An integer representing the result of the comparison 86 */ compareTo(@onnull EncodedValue o)87 @Override int compareTo(@Nonnull EncodedValue o); 88 } 89