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 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 field. 39 */ 40 public interface FieldReference extends Reference, Comparable<FieldReference> { 41 /** 42 * Gets the type of the class that defines the referenced field. 43 * 44 * @return The type of the class that defines the referenced field 45 */ getDefiningClass()46 @Nonnull String getDefiningClass(); 47 48 /** 49 * Gets the name of the referenced field. 50 * 51 * @return The name of the referenced field 52 */ getName()53 @Nonnull String getName(); 54 55 /** 56 * Gets the type of the referenced field. 57 * 58 * @return The type of the referenced field 59 */ getType()60 @Nonnull String getType(); 61 62 /** 63 * Returns a hashcode for this FieldReference. 64 * 65 * This hashCode is defined to be the following: 66 * 67 * <pre> 68 * {@code 69 * int hashCode = getDefiningClass().hashCode(); 70 * hashCode = hashCode*31 + getName().hashCode(); 71 * hashCode = hashCode*31 + getType().hashCode(); 72 * }</pre> 73 * 74 * @return The hash code value for this FieldReference 75 */ hashCode()76 @Override int hashCode(); 77 78 /** 79 * Compares this FieldReference to another FieldReference for equality. 80 * 81 * This FieldReference is equal to another FieldReference if all of it's "fields" are equal. That is, if 82 * the return values of getDefiningClass(), getName() and getType() are all equal. 83 * 84 * @param o The object to be compared for equality with this FieldReference 85 * @return true if the specified object is equal to this FieldReference 86 */ equals(@ullable Object o)87 @Override boolean equals(@Nullable Object o); 88 89 /** 90 * Compare this FieldReference to another FieldReference. 91 * 92 * The comparison is based on the comparison of the return values of getDefiningClass(), getName() and 93 * getType(), in that order. 94 * 95 * @param o The FieldReference to compare with this FieldReference 96 * @return An integer representing the result of the comparison 97 */ compareTo(@onnull FieldReference o)98 @Override int compareTo(@Nonnull FieldReference o); 99 } 100