1/*
2 * Copyright 2012, 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
32package org.jf.dexlib2.dexbacked.util;
33
34import javax.annotation.Nonnull;
35import java.util.AbstractSet;
36import java.util.Iterator;
37import java.util.NoSuchElementException;
38
39/**
40 * This provides a wrapper around AbstractSet to allow easy implementation when backed by a list that can be randomly
41 * accessed.
42 */
43public abstract class FixedSizeSet<T> extends AbstractSet<T> {
44    @Override
45    public Iterator<T> iterator() {
46        return new Iterator<T>() {
47            int index = 0;
48
49            @Override public boolean hasNext() { return index < size(); }
50            @Override public void remove() { throw new UnsupportedOperationException(); }
51            @Override
52            public T next() {
53                if (!hasNext()) {
54                    throw new NoSuchElementException();
55                }
56                return readItem(index++);
57            }
58        };
59    }
60
61    /**
62     * Reads the item at {@code index}
63     * @param index The index of the item. This is guaranteed to be in [0, size)
64     * @return The item at the given index
65     */
66    @Nonnull
67    public abstract T readItem(int index);
68}
69