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.value; 32 33 import com.android.tools.smali.dexlib2.iface.AnnotationElement; 34 import com.android.tools.smali.dexlib2.iface.BasicAnnotation; 35 36 import javax.annotation.Nonnull; 37 import javax.annotation.Nullable; 38 import java.util.Set; 39 40 /** 41 * This class represents an encoded annotation value. 42 */ 43 public interface AnnotationEncodedValue extends EncodedValue, BasicAnnotation { 44 /** 45 * Gets the type of this annotation. 46 * 47 * This will be the type descriptor of the class that defines this annotation. 48 * 49 * @return The type of this annotation 50 */ getType()51 @Nonnull String getType(); 52 53 /** 54 * Gets a set of the name/value elements associated with this annotation. 55 * 56 * The elements in the returned set will be unique by name. 57 * 58 * @return A set of AnnotationElements 59 */ getElements()60 @Nonnull Set<? extends AnnotationElement> getElements(); 61 62 /** 63 * Returns a hashcode for this AnnotationEncodedValue. 64 * 65 * This hashCode is defined to be the following: 66 * 67 * <pre> 68 * {@code 69 * int hashCode = getType().hashCode(); 70 * hashCode = hashCode*31 + getElements().hashCode(); 71 * }</pre> 72 * 73 * @return The hash code value for this AnnotationEncodedValue 74 */ hashCode()75 @Override int hashCode(); 76 77 /** 78 * Compares this AnnotationEncodedValue to another AnnotationEncodedValue for equality. 79 * 80 * This AnnotationEncodedValue is equal to another AnnotationEncodedValue if all of it's "fields" are equal. That 81 * is, if the return values getType() and getElements() are both equal. 82 * 83 * @param o The object to be compared for equality with this AnnotationEncodedValue 84 * @return true if the specified object is equal to this AnnotationEncodedValue 85 */ equals(@ullable Object o)86 @Override boolean equals(@Nullable Object o); 87 88 /** 89 * Compare this AnnotationEncodedValue to another EncodedValue. 90 * 91 * The comparison is based on the value of getType() and getElements(), in that order. When 92 * comparing the set of elements, the comparison is done with the semantics of 93 * com.android.tools.smali.util.CollectionUtils.compareAsSet(), using the natural ordering of AnnotationElement. 94 * 95 * @param o The EncodedValue to compare with this AnnotationEncodedValue 96 * @return An integer representing the result of the comparison 97 */ compareTo(@onnull EncodedValue o)98 @Override int compareTo(@Nonnull EncodedValue o); 99 } 100