FileDocCategorySizeDatePackage
Set.javaAPI DocAndroid 1.5 API7128Wed May 06 22:41:04 BST 2009java.util

Set

public interface Set implements Collection
A {@code Set} is a data structure which does not allow duplicate elements.
since
Android 1.0

Fields Summary
Constructors Summary
Methods Summary
public booleanadd(E object)
Adds the specified object to this set. The set is not modified if it already contains the object.

param
object the object to add.
return
{@code true} if this set is modified, {@code false} otherwise.
throws
UnsupportedOperationException when adding to this set is not supported.
throws
ClassCastException when the class of the object is inappropriate for this set.
throws
IllegalArgumentException when the object cannot be added to this set.
since
Android 1.0

public booleanaddAll(java.util.Collection collection)
Adds the objects in the specified collection which do not exist yet in this set.

param
collection the collection of objects.
return
{@code true} if this set is modified, {@code false} otherwise.
throws
UnsupportedOperationException when adding to this set is not supported.
throws
ClassCastException when the class of an object is inappropriate for this set.
throws
IllegalArgumentException when an object cannot be added to this set.
since
Android 1.0

public voidclear()
Removes all elements from this set, leaving it empty.

throws
UnsupportedOperationException when removing from this set is not supported.
see
#isEmpty
see
#size
since
Android 1.0

public booleancontains(java.lang.Object object)
Searches this set for the specified object.

param
object the object to search for.
return
{@code true} if object is an element of this set, {@code false} otherwise.
since
Android 1.0

public booleancontainsAll(java.util.Collection collection)
Searches this set for all objects in the specified collection.

param
collection the collection of objects.
return
{@code true} if all objects in the specified collection are elements of this set, {@code false} otherwise.
since
Android 1.0

public booleanequals(java.lang.Object object)
Compares the specified object to this set, and returns true if they represent the same object using a class specific comparison. Equality for a set means that both sets have the same size and the same elements.

param
object the object to compare with this object.
return
boolean {@code true} if the object is the same as this object, and {@code false} if it is different from this object.
see
#hashCode
since
Android 1.0

public inthashCode()
Returns the hash code for this set. Two set which are equal must return the same value.

return
the hash code of this set.
see
#equals
since
Android 1.0

public booleanisEmpty()
Returns true if this set has no elements.

return
{@code true} if this set has no elements, {@code false} otherwise.
see
#size
since
Android 1.0

public java.util.Iteratoriterator()
Returns an iterator on the elements of this set. The elements are unordered.

return
an iterator on the elements of this set.
see
Iterator
since
Android 1.0

public booleanremove(java.lang.Object object)
Removes the specified object from this set.

param
object the object to remove.
return
{@code true} if this set was modified, {@code false} otherwise.
throws
UnsupportedOperationException when removing from this set is not supported.
since
Android 1.0

public booleanremoveAll(java.util.Collection collection)
Removes all objects in the specified collection from this set.

param
collection the collection of objects to remove.
return
{@code true} if this set was modified, {@code false} otherwise.
throws
UnsupportedOperationException when removing from this set is not supported.
since
Android 1.0

public booleanretainAll(java.util.Collection collection)
Removes all objects from this set that are not contained in the specified collection.

param
collection the collection of objects to retain.
return
{@code true} if this set was modified, {@code false} otherwise.
throws
UnsupportedOperationException when removing from this set is not supported.
since
Android 1.0

public intsize()
Returns the number of elements in this set.

return
the number of elements in this set.
since
Android 1.0

public java.lang.Object[]toArray()
Returns an array containing all elements contained in this set.

return
an array of the elements from this set.
since
Android 1.0

public T[]toArray(T[] array)
Returns an array containing all elements contained in this set. If the specified array is large enough to hold the elements, the specified array is used, otherwise an array of the same type is created. If the specified array is used and is larger than this set, the array element following the collection elements is set to null.

param
array the array.
return
an array of the elements from this set.
throws
ArrayStoreException when the type of an element in this set cannot be stored in the type of the specified array.
see
Collection#toArray(Object[])
since
Android 1.0