1 /* 2 * Copyright 2018, 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.reference; 33 34 import javax.annotation.Nonnull; 35 import javax.annotation.Nullable; 36 37 /** 38 * This class represents a reference to a method handle 39 */ 40 public interface MethodHandleReference extends Reference, Comparable<MethodHandleReference> { 41 /** 42 * Gets the method handle type. 43 * 44 * @return One of the MethodHandleType values 45 */ getMethodHandleType()46 int getMethodHandleType(); 47 48 /** 49 * Gets the member that is being referenced by this method handle. 50 * 51 * @return A MethodReference or FieldReference, depending on the method handle type 52 */ getMemberReference()53 @Nonnull Reference getMemberReference(); 54 55 /** 56 * Returns a hashcode for this MethodHandleReference. 57 * 58 * This hashCode is defined to be the following: 59 * 60 * <pre> 61 * {@code 62 * int hashCode = getMethodHandleType(); 63 * hashCode = hashCode*31 + getMemberReference().hashCode(); 64 * }</pre> 65 * 66 * @return The hash code value for this MethodHandleReference 67 */ hashCode()68 @Override int hashCode(); 69 70 /** 71 * Compares this MethodHandleReference to another MethodHandleReference for equality. 72 * 73 * This MethodHandleReference is equal to another MethodHandleReference if all of its fields are equal. That is, if 74 * the return values of getMethodHandleType() and getMemberReference() are all equal. 75 * 76 * @param o The object to be compared for equality with this MethodHandleReference 77 * @return true if the specified object is equal to this MethodHandleReference 78 */ equals(@ullable Object o)79 @Override boolean equals(@Nullable Object o); 80 81 /** 82 * Compare this MethodHandleReference to another MethodHandleReference. 83 * 84 * The comparison is based on the comparison of the return values of getMethodHandleType() and getMemberReference() 85 * in that order. 86 * 87 * @param o The MethodHandleReference to compare with this MethodHandleReference 88 * @return An integer representing the result of the comparison 89 */ compareTo(@onnull MethodHandleReference o)90 @Override int compareTo(@Nonnull MethodHandleReference o); 91 } 92