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