com.force.i18n.commons.util.collection

Interface IntSet

All Known Implementing Classes:

AbstractIntSet, IntHashSet

@Beta
public interface IntSet

Modeled closely after the java.util.Set class, except it uses ints instead of Objects.

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. Beta class. Classes under com.force.i18n.commons package will be moved into a dedicated project.

Author:

Based on Sun's java.util.Set (modified by koliver)

See Also:

IntHashSet, IntMap

Method Summary

Modifier and Type	Method and Description
boolean	add(int o) Adds the specified element to this set if it is not already present.
void	clear() Removes all of the elements from this set.
boolean	contains(int o) Returns true if this set contains the specified element.
boolean	containsAll(IntSet set) Returns true if this set contains all of the elements in the specified set
boolean	isEmpty() Returns true if this set contains no elements.
IntIterator	iterator() Returns an iterator over the elements in this set.
IntSet	makeEmpty() Create a new empty IntSet with the same impl
boolean	remove(int o) Removes the given element from this set if it is present.
int	size() Returns the number of elements in this set (its cardinality).
int[]	toArray() Gets the ordered array of ints in the IntSet.

Method Detail

makeEmpty

IntSet makeEmpty()

Create a new empty IntSet with the same impl

Returns:

a new empty IntSet

toArray

int[] toArray()

Gets the ordered array of ints in the IntSet.

iterator

IntIterator iterator()

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).

Returns:

an iterator over the elements in this set.

size

int size()

Returns the number of elements in this set (its cardinality).

Returns:

the number of elements in this set (its cardinality).

isEmpty

boolean isEmpty()

Returns true if this set contains no elements.

Returns:

true if this set contains no elements.

contains

boolean contains(int o)

Returns true if this set contains the specified element.

Parameters:

o - element whose presence in this set is to be tested.

Returns:

true if this set contains the specified element.

containsAll

boolean containsAll(IntSet set)

Returns true if this set contains all of the elements in the specified set

Parameters:

o - set that is being tested for containment.

Returns:

true if this set is a superset of the given set

add

boolean add(int o)

Adds the specified element to this set if it is not already present.

Parameters:

o - element to be added to this set.

Returns:

true if the set did not already contain the specified element.

remove

boolean remove(int o)

Removes the given element from this set if it is present.

Parameters:

o - object to be removed from this set, if present.

Returns:

true if the set contained the specified element.

clear

void clear()

Removes all of the elements from this set.