org.python.core

Class PyObjectArray

Implemented Interfaces:
Serializable

public class PyObjectArray
extends AbstractArray

Provides mutable behavior on a PyObject array. Supports operations for implementing java.util.List.
Author:
Clark Updike

Constructor Summary

PyObjectArray()
Create the array with the specified size.
PyObjectArray(int size)
Create the array with the specified size.
PyObjectArray(PyObjectArray toCopy)
PyObjectArray(PyObject[] rawArray)

Method Summary

void
add(int index, PyObject value)
Add a value at a specified index in the array.
int
add(PyObject value)
Add a value to the array, appending it after the current values.
Object
clone()
Duplicates the object with the generic call.
void
ensureCapacity(int minCapacity)
boolean
equals(Object o)
PyObject
get(int index)
Retrieve the value present at an index position in the array.
Object
getArray()
Get the backing array.
int
hashCode()
void
remove(int start, int stop)
PyObject
set(int index, PyObject value)
Set the value at an index position in the array.
PyObject[]
toArray()
Constructs and returns a simple array containing the same data as held in this growable array.

Methods inherited from class org.python.core.AbstractArray

appendArray, clear, copyArray, getModCountIncr, getSize, remove, remove, replaceSubArray, replaceSubArray, setSize, toString

Constructor Details

PyObjectArray

public PyObjectArray()
Create the array with the specified size.

PyObjectArray

public PyObjectArray(int size)
Create the array with the specified size.
Parameters:
size - number of int values initially allowed in array

PyObjectArray

public PyObjectArray(PyObjectArray toCopy)
Parameters:
toCopy -

PyObjectArray

public PyObjectArray(PyObject[] rawArray)

Method Details

add

public void add(int index,
                PyObject value)
Add a value at a specified index in the array.

AbstractList subclasses should update their modCount after calling this method.

Parameters:
index - index position at which to insert element
value - value to be inserted into array

add

public int add(PyObject value)
Add a value to the array, appending it after the current values.

AbstractList subclasses should update their modCount after calling this method.

Parameters:
value - value to be added
Returns:
index number of added element

clone

public Object clone()
Duplicates the object with the generic call.
Returns:
a copy of the object

ensureCapacity

public void ensureCapacity(int minCapacity)

equals

public boolean equals(Object o)

get

public PyObject get(int index)
Retrieve the value present at an index position in the array.
Parameters:
index - index position for value to be retrieved
Returns:
value from position in the array

getArray

public Object getArray()
Get the backing array. This method is used by the type-agnostic base class code to access the array used for type-specific storage. The array should generally not be modified. To get a copy of the array, see toArray() which returns a copy. Note that getSize() should be used to determine the number of elements in the array, not the array's length (which may reflect excess capacity). toArray() returns an array whose length equals the value returned by getSize().
Returns:
backing array object

hashCode

public int hashCode()

remove

public void remove(int start,
                   int stop)
Overrides:
remove in interface AbstractArray

set

public PyObject set(int index,
                    PyObject value)
Set the value at an index position in the array.
Parameters:
index - index position to be set
value - value to be set

toArray

public PyObject[] toArray()
Constructs and returns a simple array containing the same data as held in this growable array. The array's length matches the value returned by getSize()
Returns:
array containing a copy of the data

Jython homepage