1 /* 2 * Copyright 2012, Google LLC 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google LLC nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 package com.android.tools.smali.dexlib2.iface.reference; 32 33 import javax.annotation.Nonnull; 34 import javax.annotation.Nullable; 35 36 /** 37 * This class represents a reference to a field. 38 */ 39 public interface FieldReference extends Reference, Comparable<FieldReference> { 40 /** 41 * Gets the type of the class that defines the referenced field. 42 * 43 * @return The type of the class that defines the referenced field 44 */ getDefiningClass()45 @Nonnull String getDefiningClass(); 46 47 /** 48 * Gets the name of the referenced field. 49 * 50 * @return The name of the referenced field 51 */ getName()52 @Nonnull String getName(); 53 54 /** 55 * Gets the type of the referenced field. 56 * 57 * @return The type of the referenced field 58 */ getType()59 @Nonnull String getType(); 60 61 /** 62 * Returns a hashcode for this FieldReference. 63 * 64 * This hashCode is defined to be the following: 65 * 66 * <pre> 67 * {@code 68 * int hashCode = getDefiningClass().hashCode(); 69 * hashCode = hashCode*31 + getName().hashCode(); 70 * hashCode = hashCode*31 + getType().hashCode(); 71 * }</pre> 72 * 73 * @return The hash code value for this FieldReference 74 */ hashCode()75 @Override int hashCode(); 76 77 /** 78 * Compares this FieldReference to another FieldReference for equality. 79 * 80 * This FieldReference is equal to another FieldReference if all of it's "fields" are equal. That is, if 81 * the return values of getDefiningClass(), getName() and getType() are all equal. 82 * 83 * @param o The object to be compared for equality with this FieldReference 84 * @return true if the specified object is equal to this FieldReference 85 */ equals(@ullable Object o)86 @Override boolean equals(@Nullable Object o); 87 88 /** 89 * Compare this FieldReference to another FieldReference. 90 * 91 * The comparison is based on the comparison of the return values of getDefiningClass(), getName() and 92 * getType(), in that order. 93 * 94 * @param o The FieldReference to compare with this FieldReference 95 * @return An integer representing the result of the comparison 96 */ compareTo(@onnull FieldReference o)97 @Override int compareTo(@Nonnull FieldReference o); 98 } 99