1/*
2 * [The "BSD licence"]
3 * Copyright (c) 2010 Ben Gruver (JesusFreke)
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote products
15 *    derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29package org.jf.dexlib;
30
31import org.jf.dexlib.Util.ExceptionWithContext;
32import org.jf.dexlib.Util.Input;
33
34public class IndexedSection<T extends Item> extends Section<T> {
35
36    /**
37     * Create a new indexed section
38     * @param dexFile The <code>DexFile</code> that this section belongs to
39     * @param itemType The itemType that this section will hold
40     */
41    public IndexedSection(DexFile dexFile, ItemType itemType) {
42        super(dexFile, itemType);
43    }
44
45    /** {@inheritDoc} */
46    protected void readItems(Input in, ReadContext readContext) {
47        for (int i = 0; i < items.size(); i++) {
48            T item = (T)ItemFactory.makeItem(ItemType, DexFile);
49            items.set(i, item);
50            item.readFrom(in, i, readContext);
51        }
52    }
53
54    /**
55     * Gets the item at the specified index in this section, or null if the index is -1
56     * @param index the index of the item to get
57     * @return the item at the specified index in this section, or null if the index is -1
58     */
59    public T getOptionalItemByIndex(int index) {
60        if (index == -1) {
61            return null;
62        }
63
64        return getItemByIndex(index);
65    }
66
67    /**
68     * Gets the item at the specified index in this section
69     * @param index the index of the item to get
70     * @return the item at the specified index in this section
71     */
72    public T getItemByIndex(int index) {
73        try {
74            //if index is out of bounds, just let it throw an exception
75            return items.get(index);
76        } catch (Exception ex) {
77            throw ExceptionWithContext.withContext(ex, "Error occured while retrieving the " + this.ItemType.TypeName +
78                    " item at index " + index);
79        }
80    }
81}