Top Fields Constructors Methods
org.python.modules.itertools

public Class chain

extends PyIterator
Class Inheritance
Known Direct Subclasses
org.python.modules.itertools.chainDerived
Annotations
@ExposedType
name:itertools.chain
base:PyObject
doc:chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.
Imports
org.python.core.ArgParser, .PyIterator, .PyObject, .PyTuple, .PyType, .Visitproc, org.python.expose.ExposedClassMethod, .ExposedNew, .ExposedMethod, .ExposedType

Field Summary

Modifier and TypeField and Description
public static final String
chain_doc

private itertools.ItertoolsIterator
iter

public static final PyType
TYPE

Hides org.python.core.PyObject.TYPE.

Inherited from org.python.core.PyIterator:
__doc__nextstopException

Constructor Summary

AccessConstructor and Description
public
chain()

public
chain(PyType subType)

public
chain(PyObject iterable)

Method Summary

Modifier and TypeMethod and Description
public PyObject
__iternext__()

Implements abstract org.python.core.PyIterator.__iternext__.

Return the next element of the sequence that this is an iterator for.

pack-priv final void
chain___init__(final PyObject[] args, String[] kwds)

Creates an iterator that iterates over a chain of iterables.

private void
chain___init__(final PyObject superIterator)

public static final PyObject
from_iterable(PyType type, PyObject iterable)

public PyObject
next()

Overrides org.python.core.PyIterator.next.

The exposed next method.

public boolean
refersDirectlyTo(PyObject ob)

Overrides org.python.core.PyIterator.refersDirectlyTo.

Implements org.python.core.Traverseproc.refersDirectlyTo.

Optional operation.

public int
traverse(Visitproc visit, Object arg)

Overrides org.python.core.PyIterator.traverse.

Implements org.python.core.Traverseproc.traverse.

Traverses all directly contained PyObjects.

Inherited from org.python.core.PyIterator:
__iter____tojava__doNextiterator

Field Detail

chain_docback to summary
public static final String chain_doc
iterback to summary
private itertools.ItertoolsIterator iter
TYPEback to summary
public static final PyType TYPE

Hides org.python.core.PyObject.TYPE.

Constructor Detail

chainback to summary
public chain()
chainback to summary
public chain(PyType subType)
chainback to summary
public chain(PyObject iterable)

Method Detail

__iternext__back to summary
public PyObject __iternext__()

Implements abstract org.python.core.PyIterator.__iternext__.

Doc from org.python.core.PyObject.__iternext__.

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

chain___init__back to summary
pack-priv final void chain___init__(final PyObject[] args, String[] kwds)

Creates an iterator that iterates over a chain of iterables.

Annotations
@ExposedNew
@ExposedMethod
chain___init__back to summary
private void chain___init__(final PyObject superIterator)
from_iterableback to summary
public static final PyObject from_iterable(PyType type, PyObject iterable)
Annotations
@ExposedClassMethod
nextback to summary
public PyObject next()

Overrides org.python.core.PyIterator.next.

Doc from org.python.core.PyIterator.next.

The exposed next method. Note that exposed derivable subclasses of PyIterator should override next to call doNext(custom___iternext__), as __iternext__ is overridden by the Derived classes.

Returns:PyObject

a PyObject result

Annotations
@ExposedMethod
@Override

refersDirectlyToback to summary
public boolean refersDirectlyTo(PyObject ob)

Overrides org.python.core.PyIterator.refersDirectlyTo.

Implements org.python.core.Traverseproc.refersDirectlyTo.

Doc from org.python.core.Traverseproc.refersDirectlyTo.

Optional operation. Should only be implemented if it is more efficient than calling traverse(Visitproc, Object) with a visitproc that just watches out for ob. Must return false if ob is null.

Annotations
@Override
traverseback to summary
public int traverse(Visitproc visit, Object arg)

Overrides org.python.core.PyIterator.traverse.

Implements org.python.core.Traverseproc.traverse.

Doc from org.python.core.Traverseproc.traverse.

Traverses all directly contained PyObjects. Like in CPython, arg must be passed unmodified to visit as its second parameter. If Visitproc#visit(PyObject, Object) returns nonzero, this return value must be returned immediately by traverse. Visitproc#visit(PyObject, Object) must not be called with a null PyObject-argument.

Annotations
@Override