1579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/* 2579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Copyright (C) 2007 The Android Open Source Project 3579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 4579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Licensed under the Apache License, Version 2.0 (the "License"); 5579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * you may not use this file except in compliance with the License. 6579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * You may obtain a copy of the License at 7579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 8579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * http://www.apache.org/licenses/LICENSE-2.0 9579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 10579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Unless required by applicable law or agreed to in writing, software 11579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * distributed under the License is distributed on an "AS IS" BASIS, 12579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * See the License for the specific language governing permissions and 14579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * limitations under the License. 15579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 16579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 17579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpackage com.android.dx.dex.file; 18579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 19579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.rop.cst.CstString; 20579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.util.AnnotatedOutput; 21579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.util.ToHuman; 22579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 23579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport java.io.PrintWriter; 24579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 25579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/** 26579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Representation of a member (field or method) of a class, for the 27579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * purposes of encoding it inside a {@link ClassDataItem}. 28579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 29579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpublic abstract class EncodedMember implements ToHuman { 30579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** access flags */ 31579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private final int accessFlags; 32579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 33579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 34579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Constructs an instance. 35579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 36579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param accessFlags access flags for the member 37579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 38579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public EncodedMember(int accessFlags) { 39579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.accessFlags = accessFlags; 40579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 41579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 42579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 43579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the access flags. 44579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 45579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return the access flags 46579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 47579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public final int getAccessFlags() { 48579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return accessFlags; 49579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 50579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 51579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 52579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the name. 53579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 54579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code non-null;} the name 55579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 56579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public abstract CstString getName(); 57579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 58579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 59579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Does a human-friendly dump of this instance. 60579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 61579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param out {@code non-null;} where to dump 62579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param verbose whether to be verbose with the output 63579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 64579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public abstract void debugPrint(PrintWriter out, boolean verbose); 65579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 66579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 67579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Populates a {@link DexFile} with items from within this instance. 68579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 69579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param file {@code non-null;} the file to populate 70579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 71579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public abstract void addContents(DexFile file); 72579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 73579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 74579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Encodes this instance to the given output. 75579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 76579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param file {@code non-null;} file this instance is part of 77579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param out {@code non-null;} where to write to 78579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param lastIndex {@code >= 0;} the previous member index value encoded, or 79579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code 0} if this is the first element to encode 80579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param dumpSeq {@code >= 0;} sequence number of this instance for 81579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * annotation purposes 82579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code >= 0;} the member index value that was encoded 83579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 84579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public abstract int encode(DexFile file, AnnotatedOutput out, 85579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int lastIndex, int dumpSeq); 86579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson} 87