1 /* 2 * Copyright 20116, 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 import java.util.List; 37 38 /** 39 * This class represents a reference to a method prototype. 40 */ 41 public interface MethodProtoReference extends Reference, Comparable<MethodProtoReference> { 42 /** 43 * Gets a list of the types of the parameters of this method prototype. 44 * 45 * @return A list of the parameter types of this method prototype, as strings. 46 */ getParameterTypes()47 @Nonnull List<? extends CharSequence> getParameterTypes(); 48 49 /** 50 * Gets the return type of the referenced method prototype. 51 * 52 * @return The return type of the referenced method prototype. 53 */ getReturnType()54 @Nonnull String getReturnType(); 55 56 /** 57 * Returns a hashcode for this MethodProtoReference. 58 * 59 * This hashCode is defined to be the following: 60 * 61 * <pre> 62 * {@code 63 * int hashCode = getReturnType().hashCode(); 64 * hashCode = hashCode*31 + CharSequenceUtils.listHashCode(getParameters()); 65 * }</pre> 66 * 67 * @return The hash code value for this ProtoReference 68 */ hashCode()69 @Override int hashCode(); 70 71 /** 72 * Compares this MethodTypeReference to another MethodProtoReference for equality. 73 * 74 * This MethodTypeReference is equal to another MethodProtoReference if all of it's "fields" are equal. That is, if 75 * the return values of getReturnType() and getParameterTypes() are all equal. 76 * 77 * Equality for getParameters() should be tested by comparing the string representation of each element. I.e. 78 * CharSequenceUtils.listEquals(this.getParameterTypes(), other.getParameterTypes()) 79 * 80 * @param o The object to be compared for equality with this MethodProtoReference 81 * @return true if the specified object is equal to this MethodProtoReference 82 */ equals(@ullable Object o)83 @Override boolean equals(@Nullable Object o); 84 85 /** 86 * Compare this MethodTypeReference to another MethodProtoReference. 87 * 88 * The comparison is based on the comparison of the return values of getReturnType() and getParameters(), 89 * in that order. getParameters() should be compared using the semantics of 90 * org.jf.util.CollectionUtils.compareAsList() 91 * 92 * @param o The MethodReference to compare with this MethodProtoReference 93 * @return An integer representing the result of the comparison 94 */ compareTo(@onnull MethodProtoReference o)95 @Override int compareTo(@Nonnull MethodProtoReference o); 96 } 97