MethodReference.java revision 22c3185bb7c8618437eabe6c597549e0989ec4e6 
1/*
2 * Copyright 2012, 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
32package org.jf.dexlib2.iface.reference;
33
34import javax.annotation.Nonnull;
35import javax.annotation.Nullable;
36import java.util.List;
37
38/**
39 * This class represents a reference to a method.
40 */
41public interface MethodReference extends Reference, Comparable<MethodReference> {
42    /**
43     * Gets the type of the class that defines the referenced method.
44     *
45     * @return The type of the class that defines the referenced method
46     */
47    @Nonnull String getDefiningClass();
48
49    /**
50     * Gets the name of the referenced method.
51     *
52     * @return The name of the referenced method
53     */
54    @Nonnull String getName();
55
56    /**
57     * Gets a list of the types of the parameters of the referenced method.
58     *
59     * Note: In some implementations, the returned list is likely to *not* provide efficient random access.
60     *
61     * @return A list of the types of the parameters of the referenced method
62     */
63    @Nonnull List<? extends TypeReference> getParameters();
64
65    /**
66     * Gets the return type of the referenced method.
67     *
68     * @return The return type of the referenced method.
69     */
70    @Nonnull String getReturnType();
71
72    /**
73     * Returns a hashcode for this MethodReference.
74     *
75     * This hashCode is defined to be the following:
76     *
77     * <pre>
78     * {@code
79     * int hashCode =  getDefiningClass().hashCode();
80     * hashCode = hashCode*31 + getName().hashCode();
81     * hashCode = hashCode*31 + getReturnType().hashCode();
82     * hashCode = hashCode*31 + getParameters().hashCode();
83     * }</pre>
84     *
85     * @return The hash code value for this MethodReference
86     */
87    @Override int hashCode();
88
89    /**
90     * Compares this MethodReference to another MethodReference for equality.
91     *
92     * This MethodReference is equal to another MethodReference if all of it's "fields" are equal. That is, if
93     * the return values of getDefiningClass(), getName(), getReturnType() and getParameters() are all equal.
94     *
95     * @param o The object to be compared for equality with this MethodReference
96     * @return true if the specified object is equal to this MethodReference
97     */
98    @Override boolean equals(@Nullable Object o);
99
100    /**
101     * Compare this MethodReference to another MethodReference.
102     *
103     * The comparison is based on the comparison of the return values of getDefiningClass(), getName(),
104     * getReturnType() and getParameters(), in that order. getParameters() should be compared using the semantics
105     * of org.jf.util.CollectionUtils.compareAsList()
106     *
107     * @param o The MethodReference to compare with this MethodReference
108     * @return An integer representing the result of the comparison
109     */
110    @Override int compareTo(@Nonnull MethodReference o);
111}
112