java::util::List Class Reference

An ordered collection (also known as a sequence). More...

#include <java_util_List.h>

Inheritance diagram for java::util::List:

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

[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::List >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::util::List > >	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 (optional operation).
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 (optional operation).
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 at the specified position (optional operation).
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 (optional operation).
virtual void	clear (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Removes all of the elements from this list (optional operation).
virtual bool	contains (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns true if this list contains the specified element.
virtual bool	containsAll (const ::java::util::Collection &c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns true if this list contains all of the elements of the specified collection.
virtual bool	equals (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares the specified object with this list for equality.
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)
	Returns the hash code value for this list.
virtual jint	indexOf (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.
virtual bool	isEmpty (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns true if this list contains no elements.
virtual ::java::util::Iterator	iterator (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an iterator over the elements in this list in proper sequence.
virtual jint	lastIndexOf (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.
virtual bool	remove (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Removes the first occurrence in this list of the specified element (optional operation).
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 (optional operation).
virtual bool	removeAll (const ::java::util::Collection &c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Removes from this list all the elements that are contained in the specified collection (optional operation).
virtual bool	retainAll (const ::java::util::Collection &c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Retains only the elements in this list that are contained in the specified collection (optional operation).
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 (optional operation).
virtual jint	size (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the number of elements in this list.
virtual ::java::util::List	subList (jint fromIndex, jint toIndex,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
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 proper sequence; 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 proper sequence.

---

Detailed Description

An ordered collection (also known as a sequence).

The user of this interface has precise control over where in the list each element is inserted. The user can access elements by their integer index (position in the list), and search for elements in the list.

Unlike sets, lists typically allow duplicate elements. More formally, lists typically allow pairs of elements e1 and e2 such that e1.equals(e2), and they typically allow multiple null elements if they allow null elements at all. It is not inconceivable that someone might wish to implement a list that prohibits duplicates, by throwing runtime exceptions when the user attempts to insert them, but we expect this usage to be rare.

The List interface places additional stipulations, beyond those specified in the Collection interface, on the contracts of the iterator, add, remove, equals, and hashCode methods. Declarations for other inherited methods are also included here for convenience.

The List interface provides four methods for positional (indexed) access to list elements. Lists (like Java arrays) are zero based. Note that these operations may execute in time proportional to the index value for some implementations (the LinkedList class, for example). Thus, iterating over the elements in a list is typically preferable to indexing through it if the caller does not know the implementation.

The List interface provides a special iterator, called a ListIterator, that allows element insertion and replacement, and bidirectional access in addition to the normal operations that the Iterator interface provides. A method is provided to obtain a list iterator that starts at a specified position in the list.

The List interface provides two methods to search for a specified object. From a performance standpoint, these methods should be used with caution. In many implementations they will perform costly linear searches.

The List interface provides two methods to efficiently insert and remove multiple elements at an arbitrary point in the list.

Note: While it is permissible for lists to contain themselves as elements, extreme caution is advised: the equals and hashCode methods are no longer well defined on a such a list.

Some list implementations have restrictions on the elements that they may contain. For example, some implementations prohibit null elements, and some have restrictions on the types of their elements. Attempting to add an ineligible element throws an unchecked exception, typically NullPointerException or ClassCastException. Attempting to query the presence of an ineligible element may throw an exception, or it may simply return false; some implementations will exhibit the former behavior and some will exhibit the latter. More generally, attempting an operation on an ineligible element whose completion would not result in the insertion of an ineligible element into the list may throw an exception or it may succeed, at the option of the implementation. Such exceptions are marked as "optional" in the specification for this interface.

This interface is a member of the Java Collections Framework.

Author:

Josh Bloch

---

Member Function Documentation

virtual void java::util::List::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 (optional operation). 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 in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

virtual bool java::util::List::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 (optional operation). Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added. 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 the Collection.add method). Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

virtual bool java::util::List::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 at the specified position (optional operation). 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 this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.) 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 in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

virtual bool java::util::List::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 (optional operation). The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.) Parameters: c  collection whose elements are to be added 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 if this list changed as a result of the call. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

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

Removes all of the elements from this list (optional operation). This list will be empty after this call returns (unless it throws an exception). 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::Collection. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

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

Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)). Parameters: o  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 this list contains the specified element. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

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

Returns true if this list contains all of the elements of the specified collection. Parameters: c  collection to be checked for containment in 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 contains all of the elements of the specified collection. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, and java::util::Vector.

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

Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both lists have the same size, and all corresponding pairs of elements in the two lists are equal. (Two elements e1 and e2 are equal if (e1==null ? e2==null : e1.equals(e2)).) In other words, two lists are defined to be equal if they contain the same elements in the same order. This definition ensures that the equals method works properly across different implementations of the List interface. Parameters: o  the object to be compared for equality with 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 the specified object is equal to this list. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

virtual ::java::lang::Object java::util::List::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 in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

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

Returns the hash code value for this list. The hash code of a list is defined to be the result of the following calculation: hashCode = 1; Iterator i = list.iterator(); while (i.hasNext()) { Object obj = i.next(); hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode()); } This ensures that list1.equals(list2) implies that list1.hashCode()==list2.hashCode() for any two lists, list1 and list2, as required by the general contract of 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. Returns: the hash code value for this list. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

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

Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index. Parameters: o  element to search for. 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 in this list of the first occurrence of the specified element, or -1 if this list does not contain this element. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

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

Returns true if this list contains 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 contains no elements. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

virtual ::java::util::Iterator java::util::List::iterator (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns an iterator over the elements in this list in proper sequence. 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 iterator over the elements in this list in proper sequence. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList.

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

Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index. Parameters: o  element to search for. 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 in this list of the last occurrence of the specified element, or -1 if this list does not contain this element. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

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

Removes the first occurrence in this list of the specified element (optional operation). If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))) (if such an element exists). Parameters: o  element to be removed from this list, if present. 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 contained the specified element. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, and java::util::Vector.

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

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list. 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 previously at the specified position. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

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

Removes from this list all the elements that are contained in the specified collection (optional operation). Parameters: c  collection that defines which elements will be removed from 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::Collection. Reimplemented in java::util::AbstractList, and java::util::Vector.

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

Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all the elements that are not contained in the specified collection. Parameters: c  collection that defines which elements this set will retain. 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::Collection. Reimplemented in java::util::AbstractList, and java::util::Vector.

virtual ::java::lang::Object java::util::List::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 (optional operation). 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 in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

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

Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE. 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::Collection. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

virtual ::java::util::List java::util::List::subList (  jint  fromIndex, jint  toIndex, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list. This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list: list.subList(from, to).clear(); Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList. The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.) Parameters: fromIndex  low endpoint (inclusive) of the subList. toIndex  high endpoint (exclusive) of the subList. 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 view of the specified range within this list. Reimplemented in java::util::AbstractList, and java::util::Vector.

virtual ::xmog_java_array_template< ::java::lang::Object > java::util::List::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 proper sequence; the runtime type of the returned array is that of the specified array. Obeys the general contract of the Collection.toArray(Object[]) method. Parameters: a  the array into which the elements of this 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 this list. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

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

Returns an array containing all of the elements in this list in proper sequence. Obeys the general contract of the Collection.toArray method. 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 proper sequence. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::ArrayList, and java::util::Vector.

---

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

• java_util_List.h

---