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