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; 32 33 import com.android.tools.smali.dexlib2.iface.value.EncodedValue; 34 35 import javax.annotation.Nonnull; 36 import javax.annotation.Nullable; 37 38 /** 39 * This class represents an individual name/value element in an annotation 40 */ 41 public interface AnnotationElement extends Comparable<AnnotationElement> { 42 /** 43 * Gets the name of the element. 44 * 45 * @return The name of the element. 46 */ getName()47 @Nonnull String getName(); 48 49 /** 50 * Gets the value of the element. 51 * 52 * @return The value of the element 53 */ getValue()54 @Nonnull EncodedValue getValue(); 55 56 /** 57 * Returns a hashcode for this AnnotationElement. 58 * 59 * This hashCode is defined to be the following: 60 * 61 * <pre> 62 * {@code 63 * int hashCode = getName().hashCode(); 64 * hashCode = hashCode*31 + getValue().hashCode(); 65 * }</pre> 66 * 67 * @return The hash code value for this AnnotationElement 68 */ hashCode()69 @Override int hashCode(); 70 71 /** 72 * Compares this AnnotationElement to another AnnotationElement for equality. 73 * 74 * This AnnotationElement is equal to another AnnotationElement if all of it's "fields" are equal. That is, if 75 * the return values of getName() and getValue() are both equal. 76 * 77 * @param o The object to be compared for equality with this AnnotationElement 78 * @return true if the specified object is equal to this AnnotationElement 79 */ equals(@ullable Object o)80 @Override boolean equals(@Nullable Object o); 81 82 /** 83 * Compares this AnnotationElement to another AnnotationElement. 84 * 85 * The comparison is based on the value of getName() and getValue(), in that order. 86 * 87 * @param o The AnnotationElement to compare with this AnnotationElement 88 * @return An integer representing the result of the comparison 89 */ compareTo(AnnotationElement o)90 @Override int compareTo(AnnotationElement o); 91 } 92