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