java::util::Iterator Class Reference

An iterator over a collection. More...

#include <java_util_Iterator.h>

Inheritance diagram for java::util::Iterator:

[legend]Collaboration diagram for java::util::Iterator:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::java::util::Iterator >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::util::Iterator > >	array2D
Public Member Functions
virtual bool	hasNext (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns true if the iteration has more elements.
virtual ::java::lang::Object	next (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the next element in the iteration.
virtual void	remove (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Removes from the underlying collection the last element returned by the iterator (optional operation).

---

Detailed Description

An iterator over a collection.

Iterator takes the place of Enumeration in the Java collections framework. Iterators differ from enumerations in two ways:

• Iterators allow the caller to remove elements from the underlying collection during the iteration with well-defined semantics.
• Method names have been improved.

This interface is a member of the Java Collections Framework.

Author:

Josh Bloch

---

Member Function Documentation

virtual bool java::util::Iterator::hasNext (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.) Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: true if the iterator has more elements.

virtual ::java::lang::Object java::util::Iterator::next (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns the next element in the iteration. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next element in the iteration.

virtual void java::util::Iterator::remove (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Removes from the underlying collection the last element returned by the iterator (optional operation). This method can be called only once per call to next. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

---

The documentation for this class was generated from the following file:

• java_util_Iterator.h

---