org.python.core

Class PyList

Implemented Interfaces:
List, java.io.Serializable
Known Direct Subclasses:
PyListDerived

public class PyList
extends PySequenceList

A builtin python list.
See Also:
Serialized Form

Nested Class Summary

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

PyObject.ConversionException

Field Summary

static Class
exposed_base
static String
exposed_name

Fields inherited from class org.python.core.PyObject

exposed_name

Constructor Summary

PyList()
This constructor is used by PyJavaClass.init()
PyList(Vector v)
PyList(PyObject o)
PyList(PyObject[] elements)
Creates an instance directly backed by the array of PyObject elements.
PyList(PyType type)
PyList(PyType type, Collection c)
PyList(PyType type, PyObject[] elements)

Method Summary

PyObject
__add__(PyObject o)
Equivalent to the standard Python __add__ method
PyTuple
__getnewargs__()
PyObject
__iadd__(PyObject o)
Equivalent to the standard Python __iadd__ method
PyObject
__imul__(PyObject o)
Equivalent to the standard Python __imul__ method
int
__len__()
Equivalent to the standard Python __len__ method.
PyObject
__radd__(PyObject o)
Equivalent to the standard Python __radd__ method
PyObject
__reduce__()
Used for pickling.
void
append(PyObject o)
Add a single element to the end of list.
static void
classDictInit(PyObject dict)
int
count(PyObject o)
Return the number elements in the list that equals the argument.
void
extend(PyObject o)
Append the elements in the argument sequence to the end of the list.
int
hashCode()
int
index(PyObject o)
return smallest index where an element in the list equals the argument.
int
index(PyObject o, int start)
int
index(PyObject o, int start, int stop)
void
insert(int index, PyObject o)
Insert the argument element into the list at the specified index.
PyObject
pop()
Removes and return the last element in the list.
PyObject
pop(int n)
Removes and return the n indexed element in the list.
void
remove(PyObject o)
Remove the first occurence of the argument from the list.
void
reverse()
Reverses the items of s in place.
String
safeRepr()
void
sort()
Sort the items of the list in place.
void
sort(PyObject compare)
Sort the items of the list in place.
String
toString()
static void
typeSetup(PyObject dict, PyType.Newstyle marker)

Methods inherited from class org.python.core.PySequenceList

add, add, addAll, addAll, clear, contains, containsAll, equals, get, getArray, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, pyadd, pyadd, pyget, pyset, remove, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray, toString

Methods inherited from class org.python.core.PySequence

__delitem__, __delslice__, __eq__, __finditem__, __finditem__, __ge__, __getitem__, __getslice__, __gt__, __iter__, __le__, __lt__, __ne__, __nonzero__, __setitem__, __setitem__, __setslice__, __tojava__, isMappingType, isNumberType

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__, __getnewargs__, __getslice__, __getslice__, __gt__, __hash__, __hex__, __iadd__, __iand__, __idiv__, __idivmod__, __ifloordiv__, __ilshift__, __imod__, __imul__, __int__, __invert__, __ior__, __ipow__, __irshift__, __isub__, __iter__, __iternext__, __itruediv__, __ixor__, __le__, __len__, __long__, __lshift__, __lt__, __mod__, __mul__, __ne__, __neg__, __nonzero__, __not__, __oct__, __or__, __pos__, __pow__, __pow__, __radd__, __rand__, __rdiv__, __rdivmod__, __reduce__, __repr__, __rfloordiv__, __rlshift__, __rmod__, __rmul__, __ror__, __rpow__, __rrshift__, __rshift__, __rsub__, __rtruediv__, __rxor__, __set__, __setattr__, __setattr__, __setitem__, __setitem__, __setitem__, __setslice__, __setslice__, __str__, __sub__, __tojava__, __truediv__, __unicode__, __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, delDict, delType, dispatch__init__, equals, fastGetClass, fastGetDict, getDict, getDoc, getType, hashCode, implementsDescrDelete, implementsDescrSet, invoke, invoke, invoke, invoke, invoke, isCallable, isDataDescr, isMappingType, isNumberType, isSequenceType, noAttributeError, readonlyAttributeError, safeRepr, setDict, setType, toString, typeSetup

Field Details

exposed_base

public static final Class exposed_base

exposed_name

public static final String exposed_name

Constructor Details

PyList

public PyList()
This constructor is used by PyJavaClass.init()

PyList

public PyList(Vector v)

PyList

public PyList(PyObject o)

PyList

public PyList(PyObject[] elements)
Creates an instance directly backed by the array of PyObject elements.
Parameters:
elements -

PyList

public PyList(PyType type)

PyList

public PyList(PyType type,
              Collection c)

PyList

public PyList(PyType type,
              PyObject[] elements)

Method Details

__add__

public PyObject __add__(PyObject o)
Equivalent to the standard Python __add__ method
Overrides:
__add__ in interface PyObject
Parameters:
Returns:
the result of the add, or null if this operation is not defined

__getnewargs__

public PyTuple __getnewargs__()
Overrides:
__getnewargs__ in interface PyObject

__iadd__

public PyObject __iadd__(PyObject o)
Equivalent to the standard Python __iadd__ method
Overrides:
__iadd__ in interface PyObject
Parameters:
Returns:
the result of the add, or null if this operation is not defined

__imul__

public PyObject __imul__(PyObject o)
Equivalent to the standard Python __imul__ method
Overrides:
__imul__ in interface PyObject
Parameters:
Returns:
the result of the mul, or null if this operation is not defined

__len__

public int __len__()
Equivalent to the standard Python __len__ method. Part of the mapping discipline.
Overrides:
__len__ in interface PyObject
Returns:
the length of the object

__radd__

public PyObject __radd__(PyObject o)
Equivalent to the standard Python __radd__ method
Overrides:
__radd__ in interface PyObject
Parameters:
Returns:
the result of the add, or null if this operation is not defined.

__reduce__

public PyObject __reduce__()
Used for pickling.
Overrides:
__reduce__ in interface PyObject
Returns:
a tuple of (class, tuple)

append

public void append(PyObject o)
Add a single element to the end of list.
Parameters:
o - the element to add.

classDictInit

public static void classDictInit(PyObject dict)
            throws PyIgnoreMethodTag

count

public int count(PyObject o)
Return the number elements in the list that equals the argument.
Parameters:
o - the argument to test for. Testing is done with the == operator.

extend

public void extend(PyObject o)
Append the elements in the argument sequence to the end of the list.
Same as s[len(s):len(s)] = o.
Parameters:
o - the sequence of items to append to the list.

hashCode

public int hashCode()
Overrides:
hashCode in interface PySequenceList

index

public int index(PyObject o)
return smallest index where an element in the list equals the argument.
Parameters:
o - the argument to test for. Testing is done with the == operator.

index

public int index(PyObject o,
                 int start)

index

public int index(PyObject o,
                 int start,
                 int stop)

insert

public void insert(int index,
                   PyObject o)
Insert the argument element into the list at the specified index.
Same as s[index:index] = [o] if index >= 0.
Parameters:
index - the position where the element will be inserted.
o - the element to insert.

pop

public PyObject pop()
Removes and return the last element in the list.

pop

public PyObject pop(int n)
Removes and return the n indexed element in the list.
Parameters:
n - the index of the element to remove and return.

remove

public void remove(PyObject o)
Remove the first occurence of the argument from the list. The elements arecompared with the == operator.
Same as del s[s.index(x)]
Parameters:
o - the element to search for and remove.

reverse

public void reverse()
Reverses the items of s in place. The reverse() methods modify the list in place for economy of space when reversing a large list. It doesn't return the reversed list to remind you of this side effect.

safeRepr

public String safeRepr()
            throws PyIgnoreMethodTag
Overrides:
safeRepr in interface PyObject

sort

public void sort()
Sort the items of the list in place. Items is compared with the normal relative comparison operators.

sort

public void sort(PyObject compare)
Sort the items of the list in place. The compare argument is a function of two arguments (list items) which should return -1, 0 or 1 depending on whether the first argument is considered smaller than, equal to, or larger than the second argument. Note that this slows the sorting process down considerably; e.g. to sort a list in reverse order it is much faster to use calls to the methods sort() and reverse() than to use the built-in function sort() with a comparison function that reverses the ordering of the elements.
Parameters:
compare - the comparison function.

toString

public String toString()
Overrides:
toString in interface PySequenceList

typeSetup

public static void typeSetup(PyObject dict,
                             PyType.Newstyle marker)
Overrides:
typeSetup in interface PyObject

Jython homepage