Home | History | Annotate | Download | only in value 
      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.reference.MethodReference;
     35 
     36 import javax.annotation.Nonnull;
     37 import javax.annotation.Nullable;
     38 
     39 /**
     40  * This class represents an encoded method value.
     41  */
     42 public interface MethodEncodedValue extends EncodedValue {
     43     /**
     44      * Gets the method value.
     45      *
     46      * @return the method value as a MethodReference
     47      */
     48     MethodReference getValue();
     49 
     50     /**
     51      * Returns a hashcode for this EncodedMethodValue.
     52      *
     53      * This hashCode is defined to be the following:
     54      *
     55      * <pre>
     56      * {@code
     57      * int hashCode = getValue.hashCode();
     58      * }</pre>
     59      *
     60      * @return The hash code value for this EncodedMethodValue
     61      */
     62     @Override int hashCode();
     63 
     64     /**
     65      * Compares this MethodEncodedValue to another MethodEncodedValue for equality.
     66      *
     67      * This MethodEncodedValue is equal to another MethodEncodedValue if the values returned by getValue() are equal.
     68      *
     69      * @param o The object to be compared for equality with this MethodEncodedValue
     70      * @return true if the specified object is equal to this MethodEncodedValue
     71      */
     72     @Override boolean equals(@Nullable Object o);
     73 
     74     /**
     75      * Compare this MethodEncodedValue to another EncodedValue.
     76      *
     77      * The comparison is first done on the return values of getValueType(). If the other value is another
     78      * MethodEncodedValue, the return values of getValue() are compared.
     79      *
     80      * @param o The EncodedValue to compare with this MethodEncodedValue
     81      * @return An integer representing the result of the comparison
     82      */
     83     @Override int compareTo(@Nonnull EncodedValue o);
     84 }
     85