1 /* 2 * Copyright 2016, 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; 33 34 import org.jf.dexlib2.Opcodes; 35 36 import javax.annotation.Nonnull; 37 import javax.annotation.Nullable; 38 import java.io.IOException; 39 import java.util.List; 40 41 /** 42 * This class represents a dex container that can contain multiple, named dex files 43 */ 44 public interface MultiDexContainer<T extends DexFile> { 45 /** 46 * @return A list of the names of dex entries in this container 47 */ getDexEntryNames()48 @Nonnull List<String> getDexEntryNames() throws IOException; 49 50 /** 51 * Gets the dex entry with the given name 52 * 53 * @param entryName The name of the entry 54 * @return A DexFile, or null if no entry with that name is found 55 */ getEntry(@onnull String entryName)56 @Nullable T getEntry(@Nonnull String entryName) throws IOException; 57 58 /** 59 * @return the Opcodes instance associated with this MultiDexContainer 60 */ getOpcodes()61 @Nonnull Opcodes getOpcodes(); 62 63 /** 64 * This class represents a dex file that is contained in a MultiDexContainer 65 */ 66 interface MultiDexFile extends DexFile { 67 /** 68 * @return The name of this entry within its container 69 */ getEntryName()70 @Nonnull String getEntryName(); 71 72 /** 73 * @return The MultiDexContainer that contains this dex file 74 */ getContainer()75 @Nonnull MultiDexContainer<? extends MultiDexFile> getContainer(); 76 } 77 } 78