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