Jython 2.7.4 · org.python.core.PyIterator · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static PyString	__doc__next
protected PyException	stopException

Modifier and Type

Field and Description

public static PyString

__doc__next

protected PyException

stopException

Access	Constructor and Description
public	PyIterator()
public	PyIterator(PyType subType)

Access

Constructor and Description

public

PyIterator()

public

PyIterator(PyType subType)

Method Summary

Modifier and Type	Method and Description
public PyObject	__iter__() Overrides org.python.core.PyObject.__iter__. Return an iterator that is used to iterate the element of this sequence.
public abstract PyObject	__iternext__() Overrides org.python.core.PyObject.__iternext__. Return the next element of the sequence that this is an iterator for.
public Object	__tojava__(Class<?> the Class to convert this `PyObject` to. c) Overrides org.python.core.PyObject.__tojava__. Equivalent to the Jython __tojava__ method.
protected final PyObject	doNext(PyObject ret)
public Iterator<Object>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public PyObject	Returns: a PyObject result next() The exposed next method.
public boolean	refersDirectlyTo(PyObject ob) Implements org.python.core.Traverseproc.refersDirectlyTo. Optional operation.
public int	traverse(Visitproc visit, Object arg) Implements org.python.core.Traverseproc.traverse. Traverses all directly contained `PyObject`s.

Modifier and Type

Method and Description

public PyObject

__iter__()

Overrides org.python.core.PyObject.__iter__.

Return an iterator that is used to iterate the element of this sequence.

public abstract PyObject

__iternext__()

Overrides org.python.core.PyObject.__iternext__.

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

public Object

__tojava__(Class<?>

the Class to convert this PyObject to.

Overrides org.python.core.PyObject.__tojava__.

Equivalent to the Jython __tojava__ method.

protected final PyObject

doNext(PyObject ret)

public Iterator<Object>

iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

public PyObject

Returns:

a PyObject result

next()

The exposed next method.

public boolean

refersDirectlyTo(PyObject ob)

Implements org.python.core.Traverseproc.refersDirectlyTo.

Optional operation.

public int

traverse(Visitproc visit, Object arg)

Implements org.python.core.Traverseproc.traverse.

Traverses all directly contained PyObjects.

__doc__next	back to summary
public static PyString __doc__next

__doc__next

back to summary

public static PyString __doc__next

stopException	back to summary
protected PyException stopException

stopException

back to summary

protected PyException stopException

PyIterator	back to summary
public PyIterator()

PyIterator

back to summary

public PyIterator()

PyIterator	back to summary
public PyIterator(PyType subType)

PyIterator

back to summary

public PyIterator(PyType subType)

Method Detail

__iter__	back to summary
public PyObject __iter__() Overrides org.python.core.PyObject.__iter__. Doc from org.python.core.PyObject.__iter__. 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: for (PyObject item : seq.asIterable()) { // Do something with item }

__iter__

back to summary

public PyObject __iter__()

Overrides org.python.core.PyObject.__iter__.

Doc from org.python.core.PyObject.__iter__.

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:

for (PyObject item : seq.asIterable()) {
    // Do something with item
}

__iternext__	back to summary
public abstract PyObject __iternext__() Overrides org.python.core.PyObject.__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.

__iternext__

back to summary

public abstract PyObject __iternext__()

Overrides org.python.core.PyObject.__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.

__tojava__ back to summary

__tojava__	back to summary
public Object __tojava__(Class<?> c) Overrides org.python.core.PyObject.__tojava__. Doc from org.python.core.PyObject.__tojava__. Equivalent to the Jython __tojava__ method. Tries to coerce this object to an instance of the requested Java class. Returns the special object `Py.NoConversion` if this `PyObject` can not be converted to the desired Java class. Parameters c:Class<?> the Class to convert this `PyObject` to. Annotations @Override

public Object __tojava__(Class<?> c)

Overrides org.python.core.PyObject.__tojava__.

Doc from org.python.core.PyObject.__tojava__.

Equivalent to the Jython __tojava__ method. Tries to coerce this object to an instance of the requested Java class. Returns the special object Py.NoConversion if this PyObject can not be converted to the desired Java class.

Parameters

c:Class<?>: the Class to convert this PyObject to.

Annotations

@Override

doNext	back to summary
protected final PyObject doNext(PyObject ret)

iterator back to summary

iterator	back to summary
public Iterator<Object> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Returns:Iterator<Object> an Iterator.

public Iterator<Object> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<Object>: an Iterator.

next	back to summary
public PyObject 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

back to summary

public PyObject 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

refersDirectlyTo back to summary

refersDirectlyTo	back to summary
public boolean refersDirectlyTo(PyObject ob) 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

public boolean refersDirectlyTo(PyObject ob)

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

traverse back to summary

traverse	back to summary
public int traverse(Visitproc visit, Object arg) Implements org.python.core.Traverseproc.traverse. Doc from org.python.core.Traverseproc.traverse. Traverses all directly contained `PyObject`s. 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

public int traverse(Visitproc visit, Object arg)

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

public abstract Class PyIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail