1a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver/* 2a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * Copyright 2012, Google Inc. 3a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * All rights reserved. 4a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * 5a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * Redistribution and use in source and binary forms, with or without 6a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * modification, are permitted provided that the following conditions are 7a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * met: 8a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * 9a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * * Redistributions of source code must retain the above copyright 10a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * notice, this list of conditions and the following disclaimer. 11a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * * Redistributions in binary form must reproduce the above 12a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * copyright notice, this list of conditions and the following disclaimer 13a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * in the documentation and/or other materials provided with the 14a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * distribution. 15a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * * Neither the name of Google Inc. nor the names of its 16a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * contributors may be used to endorse or promote products derived from 17a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * this software without specific prior written permission. 18a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * 19a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver */ 31a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver 32a8e05220c14778d93c97911044ff5124aadbd77cBen Gruverpackage org.jf.dexlib2.iface.reference; 33a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver 34a8e05220c14778d93c97911044ff5124aadbd77cBen Gruverimport javax.annotation.Nonnull; 3522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruverimport javax.annotation.Nullable; 3622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruverimport java.util.List; 37a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver 3822c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver/** 3922c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * This class represents a reference to a method. 4022c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 4122c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruverpublic interface MethodReference extends Reference, Comparable<MethodReference> { 4222c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver /** 4322c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * Gets the type of the class that defines the referenced method. 4422c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 4522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @return The type of the class that defines the referenced method 4622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 4722c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver @Nonnull String getDefiningClass(); 4822c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver 4922c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver /** 5022c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * Gets the name of the referenced method. 5122c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 5222c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @return The name of the referenced method 5322c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 54a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver @Nonnull String getName(); 5522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver 5622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver /** 57d4b08e1b21b144a2b300564734e272e4b85a5b56Ben Gruver * Gets a list of the types of the parameters of this method. 5822c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 59d4b08e1b21b144a2b300564734e272e4b85a5b56Ben Gruver * @return A list of the parameter types of this method, as strings. 6022c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 61d4b08e1b21b144a2b300564734e272e4b85a5b56Ben Gruver @Nonnull List<? extends CharSequence> getParameterTypes(); 6222c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver 6322c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver /** 6422c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * Gets the return type of the referenced method. 6522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 6622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @return The return type of the referenced method. 6722c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 68a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver @Nonnull String getReturnType(); 6922c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver 7022c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver /** 7122c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * Returns a hashcode for this MethodReference. 7222c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 7322c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * This hashCode is defined to be the following: 7422c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 7522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * <pre> 7622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * {@code 7722c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * int hashCode = getDefiningClass().hashCode(); 7822c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * hashCode = hashCode*31 + getName().hashCode(); 7922c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * hashCode = hashCode*31 + getReturnType().hashCode(); 803d5423ed2bfa6817f668b14795aa6ba882aef44dBen Gruver * hashCode = hashCode*31 + CharSequenceUtils.listHashCode(getParameters()); 8122c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * }</pre> 8222c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 8322c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @return The hash code value for this MethodReference 8422c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 8522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver @Override int hashCode(); 8622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver 8722c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver /** 8822c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * Compares this MethodReference to another MethodReference for equality. 8922c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 9022c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * This MethodReference is equal to another MethodReference if all of it's "fields" are equal. That is, if 913d5423ed2bfa6817f668b14795aa6ba882aef44dBen Gruver * the return values of getDefiningClass(), getName(), getReturnType() and getParameterTypes() are all equal. 923d5423ed2bfa6817f668b14795aa6ba882aef44dBen Gruver * 933d5423ed2bfa6817f668b14795aa6ba882aef44dBen Gruver * Equality for getParameters() should be tested by comparing the string representation of each element. I.e. 943d5423ed2bfa6817f668b14795aa6ba882aef44dBen Gruver * CharSequenceUtils.listEquals(this.getParameterTypes(), other.getParameterTypes()) 9522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 9622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @param o The object to be compared for equality with this MethodReference 9722c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @return true if the specified object is equal to this MethodReference 9822c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 9922c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver @Override boolean equals(@Nullable Object o); 10022c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver 10122c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver /** 10222c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * Compare this MethodReference to another MethodReference. 10322c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 10422c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * The comparison is based on the comparison of the return values of getDefiningClass(), getName(), 10522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * getReturnType() and getParameters(), in that order. getParameters() should be compared using the semantics 10622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * of org.jf.util.CollectionUtils.compareAsList() 10722c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 10822c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @param o The MethodReference to compare with this MethodReference 10922c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @return An integer representing the result of the comparison 11022c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 11122c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver @Override int compareTo(@Nonnull MethodReference o); 112a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver} 113