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 javax.annotation.Nonnull; 34 import javax.annotation.Nullable; 35 import java.util.List; 36 37 /** 38 * This class represents an encoded array value. 39 */ 40 public interface ArrayEncodedValue extends EncodedValue { 41 /** 42 * Gets the list of the values contained in this ArrayEncodedValue 43 * 44 * @return A list of EncodedValue instances 45 */ getValue()46 @Nonnull List<? extends EncodedValue> getValue(); 47 48 /** 49 * Returns a hashcode for this EncodedArrayValue. 50 * 51 * This hashCode is defined to be the following: 52 * 53 * <pre> 54 * {@code 55 * int hashCode = getValue().hashCode(); 56 * }</pre> 57 * 58 * @return The hash code value for this EncodedArrayValue 59 */ hashCode()60 @Override int hashCode(); 61 62 /** 63 * Compares this ArrayEncodedValue to another ArrayEncodedValue for equality. 64 * 65 * This ArrayEncodedValue is equal to another ArrayEncodedValue if the values returned by getValue() are equal. 66 * 67 * @param o The object to be compared for equality with this ArrayEncodedValue 68 * @return true if the specified object is equal to this ArrayEncodedValue 69 */ equals(@ullable Object o)70 @Override boolean equals(@Nullable Object o); 71 72 /** 73 * Compare this ArrayEncodedValue to another EncodedValue. 74 * 75 * The comparison is first done on the return values of getValueType(). If the other value is another 76 * ArrayEncodedValue, the lists returned by getValue() are compared, based on the semantics of 77 * com.android.tools.smali.util.ComparisonUtils.compareAsList(), using the natural ordering for EncodedValue. 78 * 79 * @param o The EncodedValue to compare with this ArrayEncodedValue 80 * @return An integer representing the result of the comparison 81 */ compareTo(@onnull EncodedValue o)82 @Override int compareTo(@Nonnull EncodedValue o); 83 } 84