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 float value. 38 */ 39 public interface FloatEncodedValue extends EncodedValue { 40 /** 41 * Gets the float value. 42 * 43 * @return the float value 44 */ getValue()45 float getValue(); 46 47 /** 48 * Returns a hashcode for this EncodedFloatValue. 49 * 50 * This hashCode is defined to be the following: 51 * 52 * <pre> 53 * {@code 54 * int hashCode = Float.floatToRawIntBits(getValue()); 55 * }</pre> 56 * 57 * Note: This is slightly different than the definition of Float.hashCode(). This uses floatToRawIntBits() 58 * instead of floatToIntBits(), in order to preserve as much information as possible. 59 * 60 * @return The hash code value for this EncodedFloatValue 61 */ hashCode()62 @Override int hashCode(); 63 64 /** 65 * Compares this FloatEncodedValue to another FloatEncodedValue for equality. 66 * 67 * This FloatEncodedValue is equal to another FloatEncodedValue if the values returned by 68 * getValue().floatToRawIntBits() are equal. 69 * 70 * Note: this isn't quite the same as getValue() == getValue(), due to various NaN issues and signed zero issues. 71 * 72 * @param o The object to be compared for equality with this FloatEncodedValue 73 * @return true if the specified object is equal to this FloatEncodedValue 74 */ equals(@ullable Object o)75 @Override boolean equals(@Nullable Object o); 76 77 /** 78 * Compare this FloatEncodedValue to another EncodedValue. 79 * 80 * The comparison is first done on the return values of getValueType(). If the other value is another 81 * FloatEncodedValue, the return values of getValue() are compared, using the semantics of Float.compare() 82 * 83 * @param o The EncodedValue to compare with this FloatEncodedValue 84 * @return An integer representing the result of the comparison 85 */ compareTo(@onnull EncodedValue o)86 @Override int compareTo(@Nonnull EncodedValue o); 87 } 88