1917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul/* 2917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Copyright (C) 2007 The Android Open Source Project 3917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 4917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Licensed under the Apache License, Version 2.0 (the "License"); 5917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * you may not use this file except in compliance with the License. 6917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * You may obtain a copy of the License at 7917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 8917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * http://www.apache.org/licenses/LICENSE-2.0 9917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 10917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Unless required by applicable law or agreed to in writing, software 11917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * distributed under the License is distributed on an "AS IS" BASIS, 12917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * See the License for the specific language governing permissions and 14917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * limitations under the License. 15917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 16917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 17917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulpackage com.android.dexgen.dex.file; 18917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 19917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.util.AnnotatedOutput; 20917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 21917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul/** 22917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Base class for any structurally-significant and (potentially) 23917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * repeated piece of a Dalvik file. 24917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 25917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulpublic abstract class Item { 26917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 27917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Constructs an instance. 28917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 29917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public Item() { 30917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul // This space intentionally left blank. 31917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 32917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 33917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 34917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Returns the item type for this instance. 35917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 36917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code non-null;} the item type 37917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 38917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public abstract ItemType itemType(); 39917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 40917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 41917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Returns the human name for the particular type of item this 42917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * instance is. 43917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 44917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code non-null;} the name 45917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 46917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public final String typeName() { 47917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return itemType().toHuman(); 48917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 49917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 50917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 51917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Gets the size of this instance when written, in bytes. 52917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 53917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code >= 0;} the write size 54917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 55917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public abstract int writeSize(); 56917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 57917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 58917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Populates a {@link DexFile} with items from within this instance. 59917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * This will <i>not</i> add an item to the file for this instance itself 60917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * (which should have been done by whatever refers to this instance). 61917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 62917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * <p><b>Note:</b> Subclasses must override this to do something 63917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * appropriate.</p> 64917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 65917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param file {@code non-null;} the file to populate 66917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 67917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public abstract void addContents(DexFile file); 68917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 69917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 70917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Writes the representation of this instance to the given data section, 71917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * using the given {@link DexFile} to look things up as needed. 72917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * If this instance keeps track of its offset, then this method will 73917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * note the written offset and will also throw an exception if this 74917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * instance has already been written. 75917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 76917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param file {@code non-null;} the file to use for reference 77917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param out {@code non-null;} where to write to 78917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 79917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public abstract void writeTo(DexFile file, AnnotatedOutput out); 80917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul} 81