java::util::AbstractSet Class Reference

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

#include <java_util_AbstractSet.h>

Inheritance diagram for java::util::AbstractSet:

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

[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::AbstractSet >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::util::AbstractSet > >	array2D
Public Member Functions
	AbstractSet (::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)
	The method representing the Java method java.util.Collection.add().
virtual bool	addAll (const ::java::util::Collection &c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	The method representing the Java method java.util.Collection.addAll().
virtual void	clear (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	The method representing the Java method java.util.Collection.clear().
virtual bool	contains (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	The method representing the Java method java.util.Collection.contains().
virtual bool	containsAll (const ::java::util::Collection &c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	The method representing the Java method java.util.Collection.containsAll().
virtual bool	equals (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares the specified object with this set for equality.
virtual jint	hashCode (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the hash code value for this set.
virtual bool	isEmpty (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	The method representing the Java method java.util.Collection.isEmpty().
virtual ::java::util::Iterator	iterator (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	The method representing the Java method java.util.Collection.iterator().
virtual bool	remove (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	The method representing the Java method java.util.Collection.remove().
virtual bool	removeAll (const ::java::util::Collection &c,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Removes from this set 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)
	The method representing the Java method java.util.Collection.retainAll().
virtual jint	size (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	The method representing the Java method java.util.Collection.size().
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)
	The method representing the Java method java.util.Collection.toArray().
virtual ::xmog_java_array_template< ::java::lang::Object >	toArray (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	The method representing the Java method java.util.Collection.toArray().
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().

---

Detailed Description

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

The process of implementing a set by extending this class is identical to that of implementing a Collection by extending AbstractCollection, except that all of the methods and constructors in subclasses of this class must obey the additional constraints imposed by the Set interface (for instance, the add method must not permit addition of multiple intances of an object to a set).

Note that this class does not override any of the implementations from the AbstractCollection class. It merely adds implementations for equals and hashCode.

This class is a member of the Java Collections Framework.

Author:

Josh Bloch

---

Constructor & Destructor Documentation

java::util::AbstractSet::AbstractSet (  ::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::AbstractSet::add (  const ::java::lang::Object &  o, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

The method representing the Java method java.util.Collection.add(). Parameters: o  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::AbstractCollection. Reimplemented in java::util::HashSet.

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

The method representing the Java method java.util.Collection.addAll(). Parameters: c  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::AbstractCollection.

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

The method representing the Java method java.util.Collection.clear(). 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::AbstractCollection. Reimplemented in java::util::HashSet.

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

The method representing the Java method java.util.Collection.contains(). Parameters: o  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::AbstractCollection. Reimplemented in java::util::HashSet.

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

The method representing the Java method java.util.Collection.containsAll(). Parameters: c  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::AbstractCollection.

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

Compares the specified object with this set for equality. Returns true if the given object is also a set, the two sets have the same size, and every member of the given set is contained in this set. This ensures that the equals method works properly across different implementations of the Set interface. This implementation first checks if the specified object is this set; if so it returns true. Then, it checks if the specified object is a set whose size is identical to the size of this set; if not, it it returns false. If so, it returns containsAll((Collection) o). Parameters: o  Object to be compared for equality with this set. 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 set. Reimplemented from java::util::Set. Reimplemented in java::util::HashSet.

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

Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object.hashCode. This implementation enumerates over the set, calling the hashCode method on each element in the collection, and adding up the results. 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 set. Reimplemented from java::util::Set. Reimplemented in java::util::HashSet.

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

The method representing the Java method java.util.Collection.isEmpty(). 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::AbstractCollection. Reimplemented in java::util::HashSet.

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

The method representing the Java method java.util.Collection.iterator(). 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::AbstractCollection. Reimplemented in java::util::HashSet.

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

The method representing the Java method java.util.Collection.remove(). Parameters: o  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::AbstractCollection. Reimplemented in java::util::HashSet.

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

Removes from this set all of its elements that are contained in the specified collection (optional operation). This implementation determines which is the smaller of this set and the specified collection, by invoking the size method on each. If this set has fewer elements, then the implementation iterates over this set, checking each element returned by the iterator in turn to see if it is contained in the specified collection. If it is so contained, it is removed from this set with the iterator's remove method. If the specified collection has fewer elements, then the implementation iterates over the specified collection, removing from this set each element returned by the iterator, using this set'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. Parameters: c  elements to be removed from this set. 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 set changed as a result of the call. Reimplemented from java::util::AbstractCollection.

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

The method representing the Java method java.util.Collection.retainAll(). Parameters: c  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::AbstractCollection.

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

The method representing the Java method java.util.Collection.size(). 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::AbstractCollection. Reimplemented in java::util::HashSet.

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

The method representing the Java method java.util.Collection.toArray(). Parameters: a  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::AbstractCollection.

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

The method representing the Java method java.util.Collection.toArray(). 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::AbstractCollection.

virtual ::java::lang::String java::util::AbstractSet::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::AbstractCollection. Reimplemented in java::util::HashSet.

---

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

• java_util_AbstractSet.h

---