java::util::AbstractCollection Class Reference

This class provides a skeletal implementation of the Collection interface, to minimize the effort required to implement this interface. More...

#include <java_util_AbstractCollection.h>

Inheritance diagram for java::util::AbstractCollection:

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

[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::AbstractCollection >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::util::AbstractCollection > >	array2D
Public Member Functions
	AbstractCollection (::xmog_dummy _use_java_ctor,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sole constructor.
virtual bool	add (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Ensures that this collection contains the specified element (optional operation).
virtual bool	addAll (const ::java::util::Collection &c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Adds all of the elements in the specified collection to this collection (optional operation).
virtual void	clear (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Removes all of the elements from this collection (optional operation).
virtual bool	contains (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns true if this collection 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 collection contains all of the elements in the specified collection.
virtual bool	isEmpty (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns true if this collection contains no elements.
virtual ::java::util::Iterator	iterator (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an iterator over the elements contained in this collection.
virtual bool	remove (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Removes a single instance of the specified element from this collection, if it is present (optional operation).
virtual bool	removeAll (const ::java::util::Collection &c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Removes from this collection all of its 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 collection that are contained in the specified collection (optional operation).
virtual jint	size (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the number of elements in this collection.
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 collection; 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 collection.
virtual ::java::lang::String	toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a string representation of this collection.

---

Detailed Description

This class provides a skeletal implementation of the Collection interface, to minimize the effort required to implement this interface.

To implement an unmodifiable collection, the programmer needs only to extend this class and provide implementations for the iterator and size methods. (The iterator returned by the iterator method must implement hasNext and next.)

To implement a modifiable collection, the programmer must additionally override this class's add method (which otherwise throws an UnsupportedOperationException), and the iterator returned by the iterator method must additionally implement its remove method.

The programmer should generally provide a void (no argument) and Collection constructor, as per the recommendation in the Collection interface specification.

The documentation for each non-abstract methods in this class describes its implementation in detail. Each of these methods may be overridden if the collection being implemented admits a more efficient implementation.

This class is a member of the Java Collections Framework.

Author:

Josh Bloch

---

Constructor & Destructor Documentation

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

Sole constructor. (For invocation by subclass constructors, typically implicit.) 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 bool java::util::AbstractCollection::add (  const ::java::lang::Object &  o, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Ensures that this collection contains the specified element (optional operation). Returns true if the collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.) Collections that support this operation may place limitations on what elements may be added to the collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added. This implementation always throws an UnsupportedOperationException. Parameters: o  element whose presence in this collection is to be ensured. 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 collection changed as a result of the call. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::AbstractSet, java::util::ArrayList, java::util::HashSet, and java::util::Vector.

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

Adds all of the elements in the specified collection to this collection (optional operation). 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 collection, and this collection is nonempty.) This implementation iterates over the specified collection, and adds each object returned by the iterator to this collection, in turn. Note that this implementation will throw an UnsupportedOperationException unless add is overridden (assuming the specified collection is non-empty). Parameters: c  collection whose elements are to be added to this collection. 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 collection changed as a result of the call. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::AbstractSet, java::util::ArrayList, and java::util::Vector.

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

Removes all of the elements from this collection (optional operation). The collection will be empty after this call returns (unless it throws an exception). This implementation iterates over this collection, removing each element using the Iterator.remove operation. Most implementations will probably choose to override this method for efficiency. Note that this implementation will throw an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection is non-empty. 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::AbstractSet, java::util::ArrayList, java::util::HashSet, and java::util::Vector.

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

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)). This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element. Parameters: o  object to be checked for containment in this collection. 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 collection contains the specified element. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::AbstractSet, java::util::ArrayList, java::util::HashSet, and java::util::Vector.

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

Returns true if this collection contains all of the elements in the specified collection. This implementation iterates over the specified collection, checking each element returned by the iterator in turn to see if it's contained in this collection. If all elements are so contained true is returned, otherwise false. Parameters: c  collection to be checked for containment in this collection. 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 collection contains all of the elements in the specified collection. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::AbstractSet, and java::util::Vector.

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

Returns true if this collection contains no elements. This implementation returns size() == 0. 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 collection contains no elements. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::AbstractSet, java::util::ArrayList, java::util::HashSet, and java::util::Vector.

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

Returns an iterator over the elements contained in this collection. 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 contained in this collection. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::AbstractSet, and java::util::HashSet.

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

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if the collection contains one or more such elements. Returns true if the collection contained the specified element (or equivalently, if the collection changed as a result of the call). This implementation iterates over the collection looking for the specified element. If it finds the element, it removes the element from the collection using the iterator's remove method. Note that this implementation throws an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection contains the specified object. Parameters: o  element to be removed from this collection, 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 the collection contained the specified element. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::AbstractSet, java::util::HashSet, and java::util::Vector.

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

Removes from this collection all of its elements that are contained in the specified collection (optional operation). This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's so contained, it's removed from this collection with the iterator's remove method. Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements in common with the specified collection. Parameters: c  elements to be removed from this collection. 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 collection changed as a result of the call. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::AbstractSet, and java::util::Vector.

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

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection. This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's not so contained, it's removed from this collection with the iterator's remove method. Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements not present in the specified collection. Parameters: c  elements to be retained in this collection. 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 collection changed as a result of the call. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::AbstractSet, and java::util::Vector.

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

Returns the number of elements in this collection. If the collection 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 collection. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::AbstractSet, java::util::ArrayList, java::util::HashSet, and java::util::Vector.

virtual ::xmog_java_array_template< ::java::lang::Object > java::util::AbstractCollection::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 collection; the runtime type of the returned array is that of the specified array. If the collection 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 collection. If the collection fits in the specified array with room to spare (i.e., the array has more elements than the collection), 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 collection only if the caller knows that the collection does not contain any null elements.) If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. This implementation checks if the array is large enough to contain the collection; if not, it allocates a new array of the correct size and type (using reflection). Then, it iterates over the collection, storing each object reference in the next consecutive element of the array, starting with element 0. If the array is larger than the collection, a null is stored in the first location after the end of the collection. Parameters: a  the array into which the elements of the collection 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 collection. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::AbstractSet, java::util::ArrayList, and java::util::Vector.

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

Returns an array containing all of the elements in this collection. If the collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array will be "safe" in that no references to it are maintained by the collection. (In other words, this method must allocate a new array even if the collection is backed by an Array). The caller is thus free to modify the returned array. This implementation allocates the array to be returned, and iterates over the elements in the collection, storing each object reference in the next consecutive element of the array, starting with element 0. 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 collection. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractList, java::util::AbstractSet, java::util::ArrayList, and java::util::Vector.

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

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object). This implementation creates an empty string buffer, appends a left square bracket, and iterates over the collection appending the string representation of each element in turn. After appending each element except the last, the string ", " is appended. Finally a right bracket is appended. A string is obtained from the string buffer, and returned. 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 string representation of this collection. Reimplemented from java::lang::Object. Reimplemented in java::util::AbstractList, java::util::AbstractSet, java::util::ArrayList, java::util::HashSet, and java::util::Vector.

---

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

• java_util_AbstractCollection.h

---