org.python.core
Class PyIterator

java.lang.Object
  org.python.core.PyObject
      org.python.core.PyIterator

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PyCallIter, PyEnumerate, PyGenerator, PySequenceIter

public abstract class PyIterator

extends PyObject

An abstract helper class usefull when implementing an iterator object. This implementation supply a correct __iter__() and a next() method based on the __iternext__() implementation. The __iternext__() method must be supplied by the subclass.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class org.python.core.PyObject

PyObject.ConversionException

Field Summary

static PyString

__doc__next

Fields inherited from class org.python.core.PyObject

exposed_name

Constructor Summary

PyIterator()

Method Summary

PyObject	__iter__() Return an iterator that is used to iterate the element of this sequence.
abstract PyObject	__iternext__() Return the next element of the sequence that this is an iterator for.
PyObject	next()

Methods inherited from class org.python.core.PyObject

__abs__, __add__, __and__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __cmp__, __coerce__, __coerce_ex__, __complex__, __contains__, __delattr__, __delattr__, __delete__, __delitem__, __delitem__, __delslice__, __delslice__, __dir__, __div__, __divmod__, __eq__, __findattr__, __findattr__, __finditem__, __finditem__, __finditem__, __float__, __floordiv__, __ge__, __get__, __getattr__, __getattr__, __getitem__, __getitem__, __getslice__, __getslice__, __gt__, __hash__, __hex__, __iadd__, __iand__, __idiv__, __idivmod__, __ifloordiv__, __ilshift__, __imod__, __imul__, __int__, __invert__, __ior__, __ipow__, __irshift__, __isub__, __itruediv__, __ixor__, __le__, __len__, __long__, __lshift__, __lt__, __mod__, __mul__, __ne__, __neg__, __nonzero__, __not__, __oct__, __or__, __pos__, __pow__, __pow__, __radd__, __rand__, __rdiv__, __rdivmod__, __repr__, __rfloordiv__, __rlshift__, __rmod__, __rmul__, __ror__, __rpow__, __rrshift__, __rshift__, __rsub__, __rtruediv__, __rxor__, __set__, __setattr__, __setattr__, __setitem__, __setitem__, __setitem__, __setslice__, __setslice__, __str__, __sub__, __tojava__, __truediv__, __xor__, _add, _and, _callextra, _cmp, _div, _divmod, _doget, _doget, _doset, _eq, _floordiv, _ge, _gt, _in, _is, _isnot, _jcall, _jcallexc, _jthrow, _le, _lshift, _lt, _mod, _mul, _ne, _notin, _or, _pow, _rshift, _sub, _truediv, _xor, asInt, asLong, asName, asString, asStringOrNull, dispatch__init__, equals, fastGetClass, fastGetDict, getDict, getDoc, getType, hashCode, implementsDescrDelete, implementsDescrSet, invoke, invoke, invoke, invoke, invoke, isCallable, isDataDescr, isMappingType, isNumberType, isSequenceType, noAttributeError, readonlyAttributeError, safeRepr, toString, typeSetup

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

__doc__next

public static PyString __doc__next

Constructor Detail

PyIterator

public PyIterator()

Method Detail

__iter__

public PyObject __iter__()

Description copied from class: PyObject

Return an iterator that is used to iterate the element of this sequence. From version 2.2, this method is the primary protocol for looping over sequences.

If a PyObject subclass should support iteration based in the __finditem__() method, it must supply an implementation of __iter__() like this:

    public PyObject __iter__() {
        return new PySequenceIter(this);
    }
 

When iterating over a python sequence from java code, it should be done with code like this:

    PyObject iter = seq.__iter__();
    for (PyObject item; (item = iter.__next__()) != null;  {
        // Do somting with item
    }
 

Overrides:

__iter__ in class PyObject

next

public PyObject next()

__iternext__

public abstract PyObject __iternext__()

Description copied from class: PyObject

Return the next element of the sequence that this is an iterator for. Returns null when the end of the sequence is reached.

Overrides:

__iternext__ in class PyObject