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