kodkod.util.ints

Interface IntCollection

All Known Subinterfaces:

IntSet, IntVector

All Known Implementing Classes:

AbstractIntCollection, AbstractIntSet, AbstractIntVector, ArrayIntSet, ArrayIntVector, IntBitSet, IntTreeSet

public interface IntCollection

The root interface in the int collection hierarchy. A collection represents a group of integers, known as its elements. Some collections allow duplicate elements and others do not. Some are ordered and others unordered. Some allow all integers and others only integers in a certain range.

Author:

Emina Torlak

Method Summary

Modifier and Type	Method and Description
boolean	add(int i) Ensures that this collection contains the given integer, and returns true if this collection has changed as a result of the call.
boolean	addAll(IntCollection c) Adds all of the elements in the specified collection to this collection.
void	clear() Removes all elements from this collection.
boolean	contains(int i) Returns true if i is an element in this collection.
boolean	containsAll(IntCollection c) Returns true if this collection contains all of the elements in the specified collection.
boolean	isEmpty() Returns true if this collection has no elements; otherwise returns false.
IntIterator	iterator() Returns an iterator over the elements in this collection.
boolean	remove(int i) Removes a single instance of the given integer from this collection, and returns true if this collection has changed as a result of the call.
boolean	removeAll(IntCollection c) Removes all of this collection's elements that are also contained in the specified collection.
boolean	retainAll(IntCollection c) Retains only the elements in this collection that are contained in the specified collection.
int	size() Returns the number of elements in this collection.
int[]	toArray() Returns an array containing all of the elements in this collection.
int[]	toArray(int[] array) Copies the elements of this collection into the specified array, provided that it is large enough, and returns it.

Method Detail

add

boolean add(int i)

Ensures that this collection contains the given integer, and returns true if this collection has changed as a result of the call.

Returns:

true if this collection has changed as a result of the call

Throws:

UnsupportedOperationException - this is an unmodifiable collection

IllegalArgumentException - some aspect of the element prevents it from being added to this collection.

addAll

boolean addAll(IntCollection c)

Adds all of the elements in the specified collection to this collection. Returns true if this collection has changed as a result of the call.

Returns:

true if this collection has changed as a result of the call

Throws:

NullPointerException - c = null

UnsupportedOperationException - this is an unmodifiable collection

IllegalArgumentException - some aspect of an element of the specified collection prevents it from being added to this collection.

clear

void clear()

Removes all elements from this collection.

Throws:

UnsupportedOperationException - this is an unmodifiable collection

contains

boolean contains(int i)

Returns true if i is an element in this collection.

Returns:

true if i is an element in this collection.

containsAll

boolean containsAll(IntCollection c)

Returns true if this collection contains all of the elements in the specified collection.

Returns:

true if this collection contains all of the elements in the specified collection.

Throws:

NullPointerException - c = null

isEmpty

boolean isEmpty()

Returns true if this collection has no elements; otherwise returns false.

Returns:

true if this collection has no elements, false otherwise.

iterator

IntIterator iterator()

Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee).

Returns:

an iterator over the elements in this collection

remove

boolean remove(int i)

Removes a single instance of the given integer from this collection, and returns true if this collection has changed as a result of the call.

Returns:

true if this collection has changed as a result of the call

Throws:

UnsupportedOperationException - this is an unmodifiable collection

removeAll

boolean removeAll(IntCollection c)

Removes all of this collection's elements that are also contained in the specified collection. After this call returns, this collection will contain no elements in common with the specified collection. Returns true if this collection has changed as a result of the call.

Returns:

true if this collection has changed as a result of the call

Throws:

NullPointerException - c = null

UnsupportedOperationException - this is an unmodifiable collection

retainAll

boolean retainAll(IntCollection c)

Retains only the elements in this collection that are contained in the specified collection. In other words, removes from this collection all of its elements that are not contained in the specified collection. Returns true if this collection has changed as a result of the call.

Returns:

rue if this collection has changed as a result of the call

Throws:

NullPointerException - c = null

UnsupportedOperationException - this is an unmodifiable collection

size

int size()

Returns the number of elements in this collection.

Returns:

number of elements in this collection.

toArray

int[] toArray()

Returns an array containing all of the elements in this collection.

Returns:

an array containing all of the elements in this collection.

toArray

int[] toArray(int[] array)

Copies the elements of this collection into the specified array, provided that it is large enough, and returns it. If the array is not large enough, the effect of this method is the same as calling toArray().

Returns:

the given array, filled with the elements from this collection, if the it is large enough; otherwise a new array containing all of the elements in this collection.

Throws:

NullPointerException - array = null