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