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 integer value.
39  */
40 public interface IntEncodedValue extends EncodedValue {
41     /**
42      * Gets the integer value.
43      *
44      * @return the int value
45      */
getValue()46     int getValue();
47 
48     /**
49      * Returns a hashcode for this EncodedIntValue.
50      *
51      * This hashCode is defined to be the following:
52      *
53      * <pre>
54      * {@code
55      * int hashCode = getValue();
56      * }</pre>
57      *
58      * @return The hash code value for this EncodedIntValue
59      */
hashCode()60     @Override int hashCode();
61 
62     /**
63      * Compares this IntEncodedValue to another IntEncodedValue for equality.
64      *
65      * This IntEncodedValue is equal to another IntEncodedValue if the values returned by getValue() are equal.
66      *
67      * @param o The object to be compared for equality with this IntEncodedValue
68      * @return true if the specified object is equal to this IntEncodedValue
69      */
equals(@ullable Object o)70     @Override boolean equals(@Nullable Object o);
71 
72     /**
73      * Compare this IntEncodedValue to another EncodedValue.
74      *
75      * The comparison is first done on the return values of getValueType(). If the other value is another
76      * IntEncodedValue, the return values of getValue() are compared.
77      *
78      * @param o The EncodedValue to compare with this IntEncodedValue
79      * @return An integer representing the result of the comparison
80      */
compareTo(@onnull EncodedValue o)81     @Override int compareTo(@Nonnull EncodedValue o);
82 }
83