java::util::Set Class Reference

A collection that contains no duplicate elements. More...

#include <java_util_Set.h>

Inheritance diagram for java::util::Set:

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

[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::Set >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::util::Set > >	array2D
Public Member Functions
virtual bool	add (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Adds the specified element to this set if it is not already present (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 set if they're not already present (optional operation).
virtual void	clear (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Removes all of the elements from this set (optional operation).
virtual bool	contains (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns true if this set 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 set 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 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)
	Returns true if this set 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 set.
virtual bool	remove (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Removes the specified element from this set 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 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)
	Retains only the elements in this set 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 set (its cardinality).
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 set; 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 set.

---

Detailed Description

A collection that contains no duplicate elements.

More formally, sets contain no pair of elements e1 and e2 such that e1.equals(e2), and at most one null element. As implied by its name, this interface models the mathematical set abstraction.

The Set interface places additional stipulations, beyond those inherited from the Collection interface, on the contracts of all constructors and on the contracts of the add, equals and hashCode methods. Declarations for other inherited methods are also included here for convenience. (The specifications accompanying these declarations have been tailored to the Set interface, but they do not contain any additional stipulations.)

The additional stipulation on constructors is, not surprisingly, that all constructors must create a set that contains no duplicate elements (as defined above).

Note: Great care must be exercised if mutable objects are used as set elements. The behavior of a set is not specified if the value of an object is changed in a manner that affects equals comparisons while the object is an element in the set. A special case of this prohibition is that it is not permissible for a set to contain itself as an element.

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

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element, o, to this set if this set contains no element e such that (o==null ? e==null : o.equals(e)). If this set already contains the specified element, the call leaves this set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements. The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throwing an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the the elements that they may contain. Parameters: o  element to be added to 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 did not already contain the specified element. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractSet, and java::util::HashSet.

virtual bool java::util::Set::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 set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. Parameters: c  collection whose elements are to be added to 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::Collection. Reimplemented in java::util::AbstractSet.

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

Removes all of the elements from this set (optional operation). This set 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::AbstractSet, and java::util::HashSet.

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

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that (o==null ? e==null : o.equals(e)). Parameters: o  element whose presence in this set 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 set contains the specified element. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractSet, and java::util::HashSet.

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

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set. Parameters: c  collection to be checked for containment in 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 contains all of the elements of the specified collection. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractSet.

virtual bool java::util::Set::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 specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface. 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::Collection. Reimplemented in java::util::AbstractSet, and java::util::HashSet.

virtual jint java::util::Set::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, where the hashcode of a null element is defined to be zero. 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 the Object.hashCode 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: the hash code value for this set. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractSet, and java::util::HashSet.

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

Returns true if this set 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 set contains no elements. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractSet, and java::util::HashSet.

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

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee). 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 set. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractSet, and java::util::HashSet.

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

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if the set contains such an element. Returns true if the set contained the specified element (or equivalently, if the set changed as a result of the call). (The set will not contain the specified element once the call returns.) Parameters: o  object to be removed from this set, 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 set contained the specified element. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractSet, and java::util::HashSet.

virtual bool java::util::Set::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). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets. Parameters: c  collection that defines which elements will 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::Collection. Reimplemented in java::util::AbstractSet.

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

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets. 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 collection changed as a result of the call. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractSet.

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

Returns the number of elements in this set (its cardinality). If this set 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 set (its cardinality). Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractSet, and java::util::HashSet.

virtual ::xmog_java_array_template< ::java::lang::Object > java::util::Set::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 set; 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 set 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 set. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractSet.

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

Returns an array containing all of the elements in this set. 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 set. Reimplemented from java::util::Collection. Reimplemented in java::util::AbstractSet.

---

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

• java_util_Set.h

---