aboutsummaryrefslogtreecommitdiff
path: root/src/jdk/nashorn/internal/runtime/arrays/ArrayLikeIterator.java
blob: 962b1f9e031fb61058d489722ac08e47f1f7d160 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/*
 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.nashorn.internal.runtime.arrays;

import java.util.Iterator;
import java.util.List;
import jdk.nashorn.api.scripting.JSObject;
import jdk.nashorn.internal.runtime.JSType;
import jdk.nashorn.internal.runtime.ScriptObject;

/**
 * Superclass for array iterators
 * TODO: rewrite these
 *
 * @param <T> element type
 */
abstract public class ArrayLikeIterator<T> implements Iterator<T> {

    /** current element index in iteration */
    protected long index;

    /** should undefined elements be included in the iteration? */
    protected final boolean includeUndefined;

    /**
     * Constructor
     *
     * @param includeUndefined should undefined elements be included in the iteration?
     */
    ArrayLikeIterator(final boolean includeUndefined) {
        this.includeUndefined = includeUndefined;
        this.index = 0;
    }

    /**
     * Is this a reverse order iteration?
     * @return true if reverse
     */
    public boolean isReverse() {
        return false;
    }

    /**
     * Go the the next valid element index of the iterator
     * @return next index
     */
    protected long bumpIndex() {
        return index++;
    }

    /**
     * Return the next valid element index of the iterator
     * @return next index
     */
    public long nextIndex() {
        return index;
    }

    @Override
    public void remove() {
        throw new UnsupportedOperationException("remove");
    }

    /**
     * Get the length of the iteration
     * @return length
     */
    public abstract long getLength();

    /**
     * ArrayLikeIterator factory
     *
     * @param object object over which to do element iteration
     * @return iterator
     */
    public static ArrayLikeIterator<Object> arrayLikeIterator(final Object object) {
        return arrayLikeIterator(object, false);
    }

    /**
     * ArrayLikeIterator factory (reverse order)
     * @param object object over which to do reverse element iteration
     * @return iterator
     */
    public static ArrayLikeIterator<Object> reverseArrayLikeIterator(final Object object) {
        return reverseArrayLikeIterator(object, false);
    }

    /**
     * ArrayLikeIterator factory
     * @param object object over which to do reverse element iteration
     * @param includeUndefined should undefined elements be included in the iteration
     * @return iterator
     */
    public static ArrayLikeIterator<Object> arrayLikeIterator(final Object object, final boolean includeUndefined) {
        Object obj = object;

        if (ScriptObject.isArray(obj)) {
            return new ScriptArrayIterator((ScriptObject) obj, includeUndefined);
        }

        obj = JSType.toScriptObject(obj);
        if (obj instanceof ScriptObject) {
            return new ScriptObjectIterator((ScriptObject)obj, includeUndefined);
        }

        if (obj instanceof JSObject) {
            return new JSObjectIterator((JSObject)obj, includeUndefined);
        }

        if (obj instanceof List) {
            return new JavaListIterator((List<?>)obj, includeUndefined);
        }

        if (obj != null && obj.getClass().isArray()) {
            return new JavaArrayIterator(obj, includeUndefined);
        }

        return new EmptyArrayLikeIterator();
    }

    /**
     * ArrayLikeIterator factory (reverse order)
     * @param object object over which to do reverse element iteration
     * @param includeUndefined should undefined elements be included in the iteration
     * @return iterator
     */
    public static ArrayLikeIterator<Object> reverseArrayLikeIterator(final Object object, final boolean includeUndefined) {
        Object obj = object;

        if (ScriptObject.isArray(obj)) {
            return new ReverseScriptArrayIterator((ScriptObject) obj, includeUndefined);
        }

        obj = JSType.toScriptObject(obj);
        if (obj instanceof ScriptObject) {
            return new ReverseScriptObjectIterator((ScriptObject)obj, includeUndefined);
        }

        if (obj instanceof JSObject) {
            return new ReverseJSObjectIterator((JSObject)obj, includeUndefined);
        }

        if (obj instanceof List) {
            return new ReverseJavaListIterator((List<?>)obj, includeUndefined);
        }

        if (obj != null && obj.getClass().isArray()) {
            return new ReverseJavaArrayIterator(obj, includeUndefined);
        }

        return new EmptyArrayLikeIterator();
    }

}