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.reference.FieldReference; 34 35 import javax.annotation.Nonnull; 36 import javax.annotation.Nullable; 37 38 /** 39 * This class represents an encoded enum value. 40 * 41 * The enum value is represented as a FieldReference to the field on an enum class that holds the enum value. 42 */ 43 public interface EnumEncodedValue extends EncodedValue { 44 /** 45 * Gets the enum value. 46 * 47 * @return a reference to the field on the enum class that holds the enum value, as a FieldReference 48 */ 49 @Nonnull getValue()50 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 */ hashCode()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 */ equals(@ullable Object o)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 */ compareTo(@onnull EncodedValue o)85 @Override int compareTo(@Nonnull EncodedValue o); 86 } 87