Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.scenegraph / src / gnu / trove / TIntObjectIterator.java

diff --git a/bundles/org.simantics.scenegraph/src/gnu/trove/TIntObjectIterator.java b/bundles/org.simantics.scenegraph/src/gnu/trove/TIntObjectIterator.java
new file mode 100644 (file)
index 0000000..07a4db5
--- /dev/null
+++ b/bundles/org.simantics.scenegraph/src/gnu/trove/TIntObjectIterator.java
@@ -0,0 +1,151 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (c) 2001, Eric D. Friedman All Rights Reserved.
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library 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 for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this program; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+///////////////////////////////////////////////////////////////////////////////
+
+package gnu.trove;
+
+//////////////////////////////////////////////////
+// THIS IS A GENERATED CLASS. DO NOT HAND EDIT! //
+//////////////////////////////////////////////////
+
+
+/**
+ * Iterator for maps of type int and Object.
+ * <p/>
+ * <p>The iterator semantics for Trove's primitive maps is slightly different
+ * from those defined in <tt>java.util.Iterator</tt>, but still well within
+ * the scope of the pattern, as defined by Gamma, et al.</p>
+ * <p/>
+ * <p>This iterator does <b>not</b> implicitly advance to the next entry when
+ * the value at the current position is retrieved.  Rather, you must explicitly
+ * ask the iterator to <tt>advance()</tt> and then retrieve either the <tt>key()</tt>,
+ * the <tt>value()</tt> or both.  This is done so that you have the option, but not
+ * the obligation, to retrieve keys and/or values as your application requires, and
+ * without introducing wrapper objects that would carry both.  As the iteration is
+ * stateful, access to the key/value parts of the current map entry happens in
+ * constant time.</p>
+ * <p/>
+ * <p>In practice, the iterator is akin to a "search finger" that you move from
+ * position to position.  Read or write operations affect the current entry only and
+ * do not assume responsibility for moving the finger.</p>
+ * <p/>
+ * <p>Here are some sample scenarios for this class of iterator:</p>
+ * <p/>
+ * <pre>
+ * // accessing keys/values through an iterator:
+ * for (TIntObjectIterator it = map.iterator();
+ *      it.hasNext();) {
+ *   it.advance();
+ *   if (satisfiesCondition(it.key()) {
+ *     doSomethingWithValue(it.value());
+ *   }
+ * }
+ * </pre>
+ * <p/>
+ * <pre>
+ * // modifying values in-place through iteration:
+ * for (TIntObjectIterator it = map.iterator();
+ *      it.hasNext();) {
+ *   it.advance();
+ *   if (satisfiesCondition(it.key()) {
+ *     it.setValue(newValueForKey(it.key()));
+ *   }
+ * }
+ * </pre>
+ * <p/>
+ * <pre>
+ * // deleting entries during iteration:
+ * for (TIntObjectIterator it = map.iterator();
+ *      it.hasNext();) {
+ *   it.advance();
+ *   if (satisfiesCondition(it.key()) {
+ *     it.remove();
+ *   }
+ * }
+ * </pre>
+ * <p/>
+ * <pre>
+ * // faster iteration by avoiding hasNext():
+ * TIntObjectIterator iterator = map.iterator();
+ * for (int i = map.size(); i-- > 0;) {
+ *   iterator.advance();
+ *   doSomethingWithKeyAndValue(iterator.key(), iterator.value());
+ * }
+ * </pre>
+ *
+ * @author Eric D. Friedman
+ * @version $Id: P2OIterator.template,v 1.1 2006/11/10 23:28:00 robeden Exp $
+ */
+
+public class TIntObjectIterator<V> extends TPrimitiveIterator {
+    /** the collection being iterated over */
+    private final TIntObjectHashMap<V> _map;
+
+    /**
+     * Creates an iterator over the specified map
+     */
+    public TIntObjectIterator(TIntObjectHashMap<V> map) {
+        super(map);
+        this._map = map;
+    }
+
+    /**
+     * Moves the iterator forward to the next entry in the underlying map.
+     *
+     * @throws java.util.NoSuchElementException
+     *          if the iterator is already exhausted
+     */
+    public void advance() {
+        moveToNextIndex();
+    }
+
+    /**
+     * Provides access to the key of the mapping at the iterator's position.
+     * Note that you must <tt>advance()</tt> the iterator at least once
+     * before invoking this method.
+     *
+     * @return the key of the entry at the iterator's current position.
+     */
+    public int key() {
+        return _map._set[_index];
+    }
+
+    /**
+     * Provides access to the value of the mapping at the iterator's position.
+     * Note that you must <tt>advance()</tt> the iterator at least once
+     * before invoking this method.
+     *
+     * @return the value of the entry at the iterator's current position.
+     */
+    public V value() {
+        return _map._values[_index];
+    }
+
+    /**
+     * Replace the value of the mapping at the iterator's position with the
+     * specified value. Note that you must <tt>advance()</tt> the iterator at
+     * least once before invoking this method.
+     *
+     * @param val the value to set in the current entry
+     * @return the old value of the entry.
+     */
+    public V setValue(V val) {
+        V old = value();
+        _map._values[_index] = val;
+        return old;
+    }
+}// TIntObjectIterator