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