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 Gurgul/** 20917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * An item in a Dalvik file which is referenced by index. 21917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 22917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulpublic abstract class IndexedItem extends Item { 23917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@code >= -1;} assigned index of the item, or {@code -1} if not 24917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * yet assigned */ 25917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul private int index; 26917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 27917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 28917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Constructs an instance. The index is initially unassigned. 29917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 30917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public IndexedItem() { 31917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul index = -1; 32917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 33917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 34917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 35917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Gets whether or not this instance has been assigned an index. 36917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 37917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code true} iff this instance has been assigned an index 38917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 39917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public final boolean hasIndex() { 40917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return (index >= 0); 41917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 42917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 43917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 44917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Gets the item index. 45917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 46917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code >= 0;} the index 47917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @throws RuntimeException thrown if the item index is not yet assigned 48917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 49917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public final int getIndex() { 50917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (index < 0) { 51917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throw new RuntimeException("index not yet set"); 52917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 53917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 54917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return index; 55917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 56917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 57917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 58917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Sets the item index. This method may only ever be called once 59917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * per instance, and this will throw a {@code RuntimeException} if 60917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * called a second (or subsequent) time. 61917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 62917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param index {@code >= 0;} the item index 63917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 64917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public final void setIndex(int index) { 65917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (this.index != -1) { 66917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throw new RuntimeException("index already set"); 67917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 68917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 69917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul this.index = index; 70917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 71917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 72917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 73917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Gets the index of this item as a string, suitable for including in 74917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * annotations. 75917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 76917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code non-null;} the index string 77917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 78917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public final String indexString() { 79917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return '[' + Integer.toHexString(index) + ']'; 80917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 81917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul} 82