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