/*
* Copyright 2012, Google Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jf.dexlib2.iface.value;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* This class represents an encoded double value.
*/
public interface DoubleEncodedValue extends EncodedValue {
/**
* Gets the double value.
*
* @return the double value
*/
double getValue();
/**
* Returns a hashcode for this EncodedDoubleValue.
*
* This hashCode is defined to be the following:
*
* <pre>
* {@code
* long v = Double.doubleToRawLongBits(getValue());
* int hashCode = (int)(v^(v>>>32));
* }</pre>
*
* Note: This is slightly different than the definition of Double.hashCode(). This uses doubleToRawLongBits()
* instead of doubleToLongBits(), in order to preserve as much information as possible.
*
* @return The hash code value for this EncodedDoubleValue
*/
@Override int hashCode();
/**
* Compares this DoubleEncodedValue to another DoubleEncodedValue for equality.
*
* This DoubleEncodedValue is equal to another DoubleEncodedValue if the values returned by
* getValue().doubleToRawLongBits() are equal.
*
* Note: this isn't quite the same as getValue() == getValue(), due to various NaN issues and signed zero issues.
*
* @param o The object to be compared for equality with this DoubleEncodedValue
* @return true if the specified object is equal to this DoubleEncodedValue
*/
@Override boolean equals(@Nullable Object o);
/**
* Compare this DoubleEncodedValue to another EncodedValue.
*
* The comparison is first done on the return values of getValueType(), and then if the other value is another
* DoubleEncodedValue, the return values of getValue() are compared, using the semantics of Double.compare()
*
* @param o The EncodedValue to compare with this DoubleEncodedValue
* @return An integer representing the result of the comparison
*/
@Override int compareTo(@Nonnull EncodedValue o);
}