java.lang.Object
- org.python.core.PyObject
- - org.python.core.PySequence
  - - org.python.core.PySequenceList
    - - org.python.core.PyTuple

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable, java.util.Collection, java.util.List, Traverseproc

Direct Known Subclasses:

PyStatResult, PyTimeTuple, PyTupleDerived, PyVersionInfo
```
public class PyTuple
extends PySequenceList
```
A builtin python tuple.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.python.core.PyObject
  PyObject.ConversionException

Field Summary

Fields
Modifier and Type Field Description

static PyType TYPE
- Fields inherited from class org.python.core.PyObject
  gcMonitorGlobal

Constructor Summary

Constructors
Constructor	Description
`PyTuple()`
`PyTuple(PyObject... elements)`
`PyTuple(PyObject[] elements, boolean copy)`
`PyTuple(PyType subtype, PyObject[] elements)`
`PyTuple(PyType subtype, PyObject[] elements, boolean copy)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PyObject`	`__add__(PyObject generic_other)`	Equivalent to the standard Python __add__ method.
`PyTuple`	`__getnewargs__()`
`PyObject`	`__iter__()`	Return an iterator that is used to iterate the element of this sequence.
`int`	`__len__()`	Equivalent to the standard Python __len__ method.
`PyObject`	`__mul__(PyObject o)`	Equivalent to the standard Python __mul__ method.
`PyObject`	`__rmul__(PyObject o)`	Equivalent to the standard Python __rmul__ method.
`void`	`add(int index, java.lang.Object element)`
`boolean`	`add(java.lang.Object o)`
`boolean`	`addAll(int index, java.util.Collection c)`
`boolean`	`addAll(java.util.Collection coll)`
`void`	`clear()`
`boolean`	`contains(java.lang.Object o)`
`boolean`	`containsAll(java.util.Collection c)`
`int`	`count(PyObject value)`
`boolean`	`equals(java.lang.Object other)`	Should almost never be overridden.
`static PyTuple`	`fromIterable(PyObject iterable)`	Return a new PyTuple from an iterable.
`java.lang.Object`	`get(int index)`
`PyObject[]`	`getArray()`	Get the backing array.
`int`	`hashCode()`
`int`	`index(PyObject value)`
`int`	`index(PyObject value, int start)`
`int`	`index(PyObject value, int start, int stop)`
`int`	`indexOf(java.lang.Object o)`
`boolean`	`isEmpty()`
`java.util.Iterator`	`iterator()`
`int`	`lastIndexOf(java.lang.Object o)`
`java.util.ListIterator`	`listIterator()`
`java.util.ListIterator`	`listIterator(int index)`
`void`	`pyadd(int index, PyObject element)`
`boolean`	`pyadd(PyObject o)`
`PyObject`	`pyget(int index)`
`void`	`pyset(int index, PyObject value)`
`boolean`	`refersDirectlyTo(PyObject ob)`	Optional operation.
`java.lang.Object`	`remove(int index)`
`void`	`remove(int start, int stop)`
`boolean`	`remove(java.lang.Object o)`
`boolean`	`removeAll(java.util.Collection coll)`
`boolean`	`retainAll(java.util.Collection coll)`
`java.lang.Object`	`set(int index, java.lang.Object element)`
`int`	`size()`
`java.util.List`	`subList(int fromIndex, int toIndex)`
`java.lang.Object[]`	`toArray()`
`java.lang.Object[]`	`toArray(java.lang.Object[] converted)`
`java.lang.String`	`toString()`
`int`	`traverse(Visitproc visit, java.lang.Object arg)`	Traverses all directly contained `PyObject`s.
`PyObject`	`tuple___iter__()`

Methods inherited from class org.python.core.PySequence
__delitem__, __delslice__, __eq__, __finditem__, __finditem__, __ge__, __getitem__, __getslice__, __gt__, __le__, __lt__, __ne__, __nonzero__, __setitem__, __setitem__, __setslice__, __tojava__, isMappingType, isNumberType, isSequenceType

Methods inherited from class org.python.core.PyObject
__abs__, __and__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __cmp__, __coerce__, __coerce_ex__, __complex__, __contains__, __delattr__, __delattr__, __delete__, __delitem__, __delslice__, __dir__, __div__, __divmod__, __ensure_finalizer__, __findattr__, __findattr__, __findattr_ex__, __finditem__, __float__, __floordiv__, __format__, __get__, __getattr__, __getattr__, __getitem__, __getslice__, __hash__, __hex__, __iadd__, __iand__, __idiv__, __idivmod__, __ifloordiv__, __ilshift__, __imod__, __imul__, __index__, __int__, __invert__, __ior__, __ipow__, __irshift__, __isub__, __iternext__, __itruediv__, __ixor__, __long__, __lshift__, __mod__, __neg__, __not__, __oct__, __or__, __pos__, __pow__, __pow__, __radd__, __rand__, __rdiv__, __rdivmod__, __reduce__, __reduce_ex__, __reduce_ex__, __repr__, __rfloordiv__, __rlshift__, __rmod__, __ror__, __rpow__, __rrshift__, __rshift__, __rsub__, __rtruediv__, __rxor__, __set__, __setattr__, __setattr__, __setitem__, __setslice__, __str__, __sub__, __truediv__, __trunc__, __unicode__, __xor__, _add, _and, _callextra, _cmp, _div, _divmod, _doget, _doget, _doset, _eq, _floordiv, _ge, _gt, _iadd, _iand, _idiv, _idivmod, _ifloordiv, _ilshift, _imod, _imul, _in, _ior, _ipow, _irshift, _is, _isnot, _isub, _itruediv, _ixor, _jcall, _jcallexc, _jthrow, _le, _lshift, _lt, _mod, _mul, _ne, _notin, _or, _pow, _rshift, _sub, _truediv, _xor, asDouble, asIndex, asIndex, asInt, asInt, asIterable, asLong, asLong, asName, asName, asString, asString, asStringOrNull, asStringOrNull, bit_length, conjugate, delDict, delType, dispatch__init__, fastGetClass, fastGetDict, getDict, getType, implementsDescrDelete, implementsDescrGet, implementsDescrSet, invoke, invoke, invoke, invoke, invoke, invoke, isCallable, isDataDescr, isIndex, isInteger, noAttributeError, object___subclasshook__, readonlyAttributeError, setDict, setType

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.List
replaceAll, sort, spliterator

- Field Detail
  - TYPE
```
public static final PyType TYPE
```
- Constructor Detail
  - PyTuple
```
public PyTuple()
```
  - PyTuple
```
public PyTuple(PyObject... elements)
```
  - PyTuple
```
public PyTuple(PyType subtype,
               PyObject[] elements)
```
  - PyTuple
```
public PyTuple(PyObject[] elements,
               boolean copy)
```
  - PyTuple
```
public PyTuple(PyType subtype,
               PyObject[] elements,
               boolean copy)
```
- Method Detail
  - fromIterable
```
public static PyTuple fromIterable(PyObject iterable)
```
    Return a new PyTuple from an iterable. Raises a TypeError if the object is not iterable.
    
    Parameters:
    
    iterable - an iterable PyObject
    
    Returns:
    
    a PyTuple containing each item in the iterable
  - __len__
```
public int __len__()
```
    Description copied from class: PyObject
    
    Equivalent to the standard Python __len__ method. Part of the mapping discipline.
    
    Overrides:
    
    __len__ in class PyObject
    
    Returns:
    
    the length of the object
  - __add__
```
public PyObject __add__(PyObject generic_other)
```
    Description copied from class: PyObject
    
    Equivalent to the standard Python __add__ method.
    
    Overrides:
    
    __add__ in class PyObject
    
    Parameters:
    
    generic_other - the object to perform this binary operation with (the right-hand operand).
    
    Returns:
    
    the result of the add, or null if this operation is not defined.
  - __mul__
```
public PyObject __mul__(PyObject o)
```
    Description copied from class: PyObject
    
    Equivalent to the standard Python __mul__ method.
    
    Overrides:
    
    __mul__ in class PyObject
    
    Parameters:
    
    o - the object to perform this binary operation with (the right-hand operand).
    
    Returns:
    
    the result of the mul, or null if this operation is not defined
  - __rmul__
```
public PyObject __rmul__(PyObject o)
```
    Description copied from class: PyObject
    
    Equivalent to the standard Python __rmul__ method.
    
    Overrides:
    
    __rmul__ in class PyObject
    
    Parameters:
    
    o - the object to perform this binary operation with (the left-hand operand).
    
    Returns:
    
    the result of the mul, or null if this operation is not defined.
  - __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:
    for (PyObject item : seq.asIterable()) { // Do something with item }
    Overrides:
    
    __iter__ in class PySequence
  - tuple___iter__
```
public PyObject tuple___iter__()
```
  - __getnewargs__
```
public PyTuple __getnewargs__()
```
    Overrides:
    
    __getnewargs__ in class PyObject
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Collection
    
    Specified by:
    
    hashCode in interface java.util.List
    
    Specified by:
    
    hashCode in class PySequenceList
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in class PySequenceList
  - subList
```
public java.util.List subList(int fromIndex,
                              int toIndex)
```
    Specified by:
    
    subList in interface java.util.List
    
    Specified by:
    
    subList in class PySequenceList
  - iterator
```
public java.util.Iterator iterator()
```
    Specified by:
    
    iterator in interface java.util.Collection
    
    Specified by:
    
    iterator in interface java.lang.Iterable
    
    Specified by:
    
    iterator in interface java.util.List
    
    Specified by:
    
    iterator in class PySequenceList
  - add
```
public boolean add(java.lang.Object o)
```
    Specified by:
    
    add in interface java.util.Collection
    
    Specified by:
    
    add in interface java.util.List
    
    Specified by:
    
    add in class PySequenceList
  - remove
```
public boolean remove(java.lang.Object o)
```
    Specified by:
    
    remove in interface java.util.Collection
    
    Specified by:
    
    remove in interface java.util.List
    
    Specified by:
    
    remove in class PySequenceList
  - addAll
```
public boolean addAll(java.util.Collection coll)
```
    Specified by:
    
    addAll in interface java.util.Collection
    
    Specified by:
    
    addAll in interface java.util.List
    
    Specified by:
    
    addAll in class PySequenceList
  - removeAll
```
public boolean removeAll(java.util.Collection coll)
```
    Specified by:
    
    removeAll in interface java.util.Collection
    
    Specified by:
    
    removeAll in interface java.util.List
    
    Specified by:
    
    removeAll in class PySequenceList
  - retainAll
```
public boolean retainAll(java.util.Collection coll)
```
    Specified by:
    
    retainAll in interface java.util.Collection
    
    Specified by:
    
    retainAll in interface java.util.List
    
    Specified by:
    
    retainAll in class PySequenceList
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection
    
    Specified by:
    
    clear in interface java.util.List
    
    Specified by:
    
    clear in class PySequenceList
  - set
```
public java.lang.Object set(int index,
                            java.lang.Object element)
```
    Specified by:
    
    set in interface java.util.List
    
    Specified by:
    
    set in class PySequenceList
  - add
```
public void add(int index,
                java.lang.Object element)
```
    Specified by:
    
    add in interface java.util.List
    
    Specified by:
    
    add in class PySequenceList
  - remove
```
public java.lang.Object remove(int index)
```
    Specified by:
    
    remove in interface java.util.List
    
    Specified by:
    
    remove in class PySequenceList
  - addAll
```
public boolean addAll(int index,
                      java.util.Collection c)
```
    Specified by:
    
    addAll in interface java.util.List
    
    Specified by:
    
    addAll in class PySequenceList
  - listIterator
```
public java.util.ListIterator listIterator()
```
    Specified by:
    
    listIterator in interface java.util.List
    
    Specified by:
    
    listIterator in class PySequenceList
  - listIterator
```
public java.util.ListIterator listIterator(int index)
```
    Specified by:
    
    listIterator in interface java.util.List
    
    Specified by:
    
    listIterator in class PySequenceList
  - pyset
```
public void pyset(int index,
                  PyObject value)
```
    Specified by:
    
    pyset in class PySequenceList
  - contains
```
public boolean contains(java.lang.Object o)
```
    Specified by:
    
    contains in interface java.util.Collection
    
    Specified by:
    
    contains in interface java.util.List
    
    Specified by:
    
    contains in class PySequenceList
  - containsAll
```
public boolean containsAll(java.util.Collection c)
```
    Specified by:
    
    containsAll in interface java.util.Collection
    
    Specified by:
    
    containsAll in interface java.util.List
    
    Specified by:
    
    containsAll in class PySequenceList
  - count
```
public int count(PyObject value)
```
  - index
```
public int index(PyObject value)
```
  - index
```
public int index(PyObject value,
                 int start)
```
  - index
```
public int index(PyObject value,
                 int start,
                 int stop)
```
  - equals
```
public boolean equals(java.lang.Object other)
```
    Description copied from class: PyObject
    
    Should almost never be overridden. If overridden, it is the subclasses responsibility to ensure that a.equals(b) == true iff cmp(a,b) == 0
    
    Specified by:
    
    equals in interface java.util.Collection
    
    Specified by:
    
    equals in interface java.util.List
    
    Specified by:
    
    equals in class PySequenceList
  - get
```
public java.lang.Object get(int index)
```
    Specified by:
    
    get in interface java.util.List
    
    Specified by:
    
    get in class PySequenceList
  - getArray
```
public PyObject[] getArray()
```
    Description copied from class: PySequenceList
    
    Get the backing array. The array should not be modified. To get a copy of the array, see PySequenceList.toArray().
    
    Specified by:
    
    getArray in class PySequenceList
  - indexOf
```
public int indexOf(java.lang.Object o)
```
    Specified by:
    
    indexOf in interface java.util.List
    
    Specified by:
    
    indexOf in class PySequenceList
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Collection
    
    Specified by:
    
    isEmpty in interface java.util.List
    
    Specified by:
    
    isEmpty in class PySequenceList
  - lastIndexOf
```
public int lastIndexOf(java.lang.Object o)
```
    Specified by:
    
    lastIndexOf in interface java.util.List
    
    Specified by:
    
    lastIndexOf in class PySequenceList
  - pyadd
```
public void pyadd(int index,
                  PyObject element)
```
    Specified by:
    
    pyadd in class PySequenceList
  - pyadd
```
public boolean pyadd(PyObject o)
```
    Specified by:
    
    pyadd in class PySequenceList
  - pyget
```
public PyObject pyget(int index)
```
    Specified by:
    
    pyget in class PySequenceList
  - remove
```
public void remove(int start,
                   int stop)
```
    Specified by:
    
    remove in class PySequenceList
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection
    
    Specified by:
    
    size in interface java.util.List
    
    Specified by:
    
    size in class PySequenceList
  - toArray
```
public java.lang.Object[] toArray()
```
    Specified by:
    
    toArray in interface java.util.Collection
    
    Specified by:
    
    toArray in interface java.util.List
    
    Specified by:
    
    toArray in class PySequenceList
  - toArray
```
public java.lang.Object[] toArray(java.lang.Object[] converted)
```
    Specified by:
    
    toArray in interface java.util.Collection
    
    Specified by:
    
    toArray in interface java.util.List
    
    Specified by:
    
    toArray in class PySequenceList
  - traverse
```
public int traverse(Visitproc visit,
                    java.lang.Object arg)
```
    Description copied from interface: Traverseproc
    
    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.
    
    Specified by:
    
    traverse in interface Traverseproc
    
    Overrides:
    
    traverse in class PySequenceList
  - refersDirectlyTo
```
public boolean refersDirectlyTo(PyObject ob)
```
    Description copied from interface: Traverseproc
    
    Optional operation. Should only be implemented if it is more efficient than calling Traverseproc.traverse(Visitproc, Object) with a visitproc that just watches out for ob. Must return false if ob is null.
    
    Specified by:
    
    refersDirectlyTo in interface Traverseproc
    
    Overrides:
    
    refersDirectlyTo in class PySequenceList

Class PyTuple

Nested Class Summary

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

Field Summary

Fields inherited from class org.python.core.PyObject

Constructor Summary

Method Summary

Methods inherited from class org.python.core.PySequence

Methods inherited from class org.python.core.PyObject

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.List

Field Detail

TYPE

Constructor Detail

PyTuple

PyTuple

PyTuple

PyTuple

PyTuple

Method Detail

fromIterable

__len__

__add__

__mul__

__rmul__

__iter__

tuple___iter__

__getnewargs__

hashCode

toString

subList

iterator

add

remove

addAll

removeAll

retainAll

clear

set

add

remove

addAll

listIterator

listIterator

pyset

contains

containsAll

count

index

index

index

equals

get

getArray

indexOf

isEmpty

lastIndexOf

pyadd

pyadd

pyget

remove

size

toArray

toArray

traverse

refersDirectlyTo

len

add

mul

rmul

iter

tuple_iter

getnewargs