java::util::ArrayList Class Reference

Resizable-array implementation of the List interface. More...

#include <java_util_ArrayList.h>

Inheritance diagram for java::util::ArrayList:

[legend]Collaboration diagram for java::util::ArrayList:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::java::util::ArrayList >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::util::ArrayList > >	array2D
Public Member Functions
virtual void	add (jint index, const ::java::lang::Object &element,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Inserts the specified element at the specified position in this list.
virtual bool	add (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Appends the specified element to the end of this list.
virtual bool	addAll (jint index, const ::java::util::Collection &c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Inserts all of the elements in the specified Collection into this list, starting at the specified position.
virtual bool	addAll (const ::java::util::Collection &c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator.
	ArrayList (::xmog_dummy _use_java_ctor,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs an empty list with an initial capacity of ten.
	ArrayList (const ::java::util::Collection &c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.
	ArrayList (jint initialCapacity,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs an empty list with the specified initial capacity.
virtual void	clear (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Removes all of the elements from this list.
virtual ::java::lang::Object	clone (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a shallow copy of this ArrayList instance.
virtual bool	contains (const ::java::lang::Object &elem,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns true if this list contains the specified element.
virtual void	ensureCapacity (jint minCapacity,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Increases the capacity of this ArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
virtual bool	equals (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	The method representing the Java method java.lang.Object.equals().
virtual ::java::lang::Object	get (jint index,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the element at the specified position in this list.
virtual jint	hashCode (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	The method representing the Java method java.lang.Object.hashCode().
virtual jint	indexOf (const ::java::lang::Object &elem,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Searches for the first occurence of the given argument, testing for equality using the equals method.
virtual bool	isEmpty (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Tests if this list has no elements.
virtual jint	lastIndexOf (const ::java::lang::Object &elem,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the index of the last occurrence of the specified object in this list.
virtual ::java::lang::Object	remove (jint index,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Removes the element at the specified position in this list.
virtual ::java::lang::Object	set (jint index, const ::java::lang::Object &element,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Replaces the element at the specified position in this list with the specified element.
virtual jint	size (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the number of elements in this list.
virtual ::xmog_java_array_template< ::java::lang::Object >	toArray (const ::xmog_java_array_template< ::java::lang::Object > &a,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an array containing all of the elements in this list in the correct order; the runtime type of the returned array is that of the specified array.
virtual ::xmog_java_array_template< ::java::lang::Object >	toArray (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an array containing all of the elements in this list in the correct order.
virtual ::java::lang::String	toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	The method representing the Java method java.lang.Object.toString().
virtual void	trimToSize (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Trims the capacity of this ArrayList instance to be the list's current size.

---

Detailed Description

Resizable-array implementation of the List interface.

Implements all optional list operations, and permits all elements, including null. In addition to implementing the List interface, this class provides methods to manipulate the size of the array that is used internally to store the list. (This class is roughly equivalent to Vector, except that it is unsynchronized.)

The size, isEmpty, get, set, iterator, and listIterator operations run in constant time. The add operation runs in amortized constant time, that is, adding n elements requires O(n) time. All of the other operations run in linear time (roughly speaking). The constant factor is low compared to that for the LinkedList implementation.

Each ArrayList instance has a capacity. The capacity is the size of the array used to store the elements in the list. It is always at least as large as the list size. As elements are added to an ArrayList, its capacity grows automatically. The details of the growth policy are not specified beyond the fact that adding an element has constant amortized time cost.

An application can increase the capacity of an ArrayList instance before adding a large number of elements using the ensureCapacity operation. This may reduce the amount of incremental reallocation.

Note that this implementation is not synchronized. If multiple threads access an ArrayList instance concurrently, and at least one of the threads modifies the list structurally, it must be synchronized externally. (A structural modification is any operation that adds or deletes one or more elements, or explicitly resizes the backing array; merely setting the value of an element is not a structural modification.) This is typically accomplished by synchronizing on some object that naturally encapsulates the list. If no such object exists, the list should be "wrapped" using the Collections.synchronizedList method. This is best done at creation time, to prevent accidental unsynchronized access to the list:

                List list = Collections.synchronizedList(new ArrayList(...));

The iterators returned by this class's iterator and listIterator methods are fail-fast: if list is structurally modified at any time after the iterator is created, in any way except through the iterator's own remove or add methods, the iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.

Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.

This class is a member of the Java Collections Framework.

Author:

Josh Bloch

---

Constructor & Destructor Documentation

java::util::ArrayList::ArrayList (  jint  initialCapacity, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Constructs an empty list with the specified initial capacity. Parameters: initialCapacity  the initial capacity of the list. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

java::util::ArrayList::ArrayList (  const ::java::util::Collection &  c, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator. The ArrayList instance has an initial capacity of 110% the size of the specified collection. Parameters: c  the collection whose elements are to be placed into this list. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

java::util::ArrayList::ArrayList (  ::xmog_dummy  _use_java_ctor, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Constructs an empty list with an initial capacity of ten. Parameters: _use_java_ctor  indicates that you want to delegate to a Java constructor whose natural proxy conflicts with a C++ requirement. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

---

Member Function Documentation

virtual void java::util::ArrayList::add (  jint  index, const ::java::lang::Object &  element, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices). Parameters: index  index at which the specified element is to be inserted. element  element to be inserted. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::util::AbstractList.

virtual bool java::util::ArrayList::add (  const ::java::lang::Object &  o, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Appends the specified element to the end of this list. Parameters: o  element to be appended to this list. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: true (as per the general contract of Collection.add). Reimplemented from java::util::AbstractList.

virtual bool java::util::ArrayList::addAll (  jint  index, const ::java::util::Collection &  c, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Inserts all of the elements in the specified Collection into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the list in the order that they are returned by the specified Collection's iterator. Parameters: index  index at which to insert first element from the specified collection. c  elements to be inserted into this list. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: true if this list changed as a result of the call. Reimplemented from java::util::AbstractList.

virtual bool java::util::ArrayList::addAll (  const ::java::util::Collection &  c, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator. The behavior of this operation is undefined if the specified Collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified Collection is this list, and this list is nonempty.) Parameters: c  the elements to be inserted into this list. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: true if this list changed as a result of the call. Reimplemented from java::util::AbstractList.

virtual void java::util::ArrayList::clear (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Removes all of the elements from this list. The list will be empty after this call returns. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::util::AbstractList.

virtual ::java::lang::Object java::util::ArrayList::clone (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns a shallow copy of this ArrayList instance. (The elements themselves are not copied.) Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a clone of this ArrayList instance.

virtual bool java::util::ArrayList::contains (  const ::java::lang::Object &  elem, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns true if this list contains the specified element. Parameters: elem  element whose presence in this List is to be tested. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: true if the specified element is present; false otherwise. Reimplemented from java::util::AbstractList.

virtual void java::util::ArrayList::ensureCapacity (  jint  minCapacity, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Increases the capacity of this ArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument. Parameters: minCapacity  the desired minimum capacity. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual bool java::util::ArrayList::equals (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

The method representing the Java method java.lang.Object.equals(). Parameters: obj  p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Reimplemented from java::util::AbstractList.

virtual ::java::lang::Object java::util::ArrayList::get (  jint  index, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns the element at the specified position in this list. Parameters: index  index of element to return. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the element at the specified position in this list. Reimplemented from java::util::AbstractList.

virtual jint java::util::ArrayList::hashCode (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

The method representing the Java method java.lang.Object.hashCode(). Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Reimplemented from java::util::AbstractList.

virtual jint java::util::ArrayList::indexOf (  const ::java::lang::Object &  elem, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Searches for the first occurence of the given argument, testing for equality using the equals method. Parameters: elem  an object. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the index of the first occurrence of the argument in this list; returns -1 if the object is not found. Reimplemented from java::util::AbstractList.

virtual bool java::util::ArrayList::isEmpty (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Tests if this list has no elements. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: true if this list has no elements; false otherwise. Reimplemented from java::util::AbstractList.

virtual jint java::util::ArrayList::lastIndexOf (  const ::java::lang::Object &  elem, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns the index of the last occurrence of the specified object in this list. Parameters: elem  the desired element. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the index of the last occurrence of the specified object in this list; returns -1 if the object is not found. Reimplemented from java::util::AbstractList.

virtual ::java::lang::Object java::util::ArrayList::remove (  jint  index, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices). Parameters: index  the index of the element to removed. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the element that was removed from the list. Reimplemented from java::util::AbstractList.

virtual ::java::lang::Object java::util::ArrayList::set (  jint  index, const ::java::lang::Object &  element, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Replaces the element at the specified position in this list with the specified element. Parameters: index  index of element to replace. element  element to be stored at the specified position. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the element previously at the specified position. Reimplemented from java::util::AbstractList.

virtual jint java::util::ArrayList::size (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns the number of elements in this list. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the number of elements in this list. Reimplemented from java::util::AbstractList.

virtual ::xmog_java_array_template< ::java::lang::Object > java::util::ArrayList::toArray (  const ::xmog_java_array_template< ::java::lang::Object > &  a, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns an array containing all of the elements in this list in the correct order; the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list. If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements. Parameters: a  the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: an array containing the elements of the list. Reimplemented from java::util::AbstractList.

virtual ::xmog_java_array_template< ::java::lang::Object > java::util::ArrayList::toArray (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns an array containing all of the elements in this list in the correct order. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: an array containing all of the elements in this list in the correct order. Reimplemented from java::util::AbstractList.

virtual ::java::lang::String java::util::ArrayList::toString (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

The method representing the Java method java.lang.Object.toString(). Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Reimplemented from java::util::AbstractList.

virtual void java::util::ArrayList::trimToSize (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Trims the capacity of this ArrayList instance to be the list's current size. An application can use this operation to minimize the storage of an ArrayList instance. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

---

The documentation for this class was generated from the following file:

• java_util_ArrayList.h

---