blbutil

Class IndexSet

java.lang.Object

blbutil.IndexSet

public class IndexSet
extends java.lang.Object

Class IndexSet is a set that stores non-negative indices that are less than or equal to a specified maximum value.

Class IndexSet supports a clear() method, but it does not support a remove() method.

Class IndexSet is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
IndexSet(int max) Creates a new instance of IndexSet that can contain non-negative integer indices that are less than or equal to the specified maximum value.

Method Summary

Modifier and Type	Method and Description
boolean	add(int element) Adds the specified element to the set.
void	clear() Removes all elements from the set.
boolean	contains(int element) Returns true if the set contains the specified element, and returns false otherwise.
int	enumeratedValue(int enumIndex) Returns the specified element in an enumeration of the elements in the set.
int	maxPermittedElement() Returns the maximum permitted element in the set.
int	size() Returns the number of elements in this set.
int[]	toArray() Returns an array containing the elements in this set.
java.lang.String	toString() Returns java.util.Arrays.toString(this.toArray()).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexSet

public IndexSet(int max)

Creates a new instance of IndexSet that can contain non-negative integer indices that are less than or equal to the specified maximum value.

Parameters:

max - the maximum element that is permitted in the set.

Throws:

java.lang.IllegalArgumentException - if max < 0

Method Detail

add

public boolean add(int element)

Adds the specified element to the set.

Parameters:

element - an element to add to this set.

Returns:

true if the set was changed by the operation, and false otherwise.

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 || index > this.maxPermittedIndex()

contains

public boolean contains(int element)

Returns true if the set contains the specified element, and returns false otherwise.

Parameters:

element - an element

Returns:

true if the set contains the specified element

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 || index > this.maxPermittedIndex()

size

public int size()

Returns the number of elements in this set.

Returns:

the number of elements in this set

maxPermittedElement

public int maxPermittedElement()

Returns the maximum permitted element in the set.

Returns:

the maximum permitted element in the set

clear

public void clear()

Removes all elements from the set.

enumeratedValue

public int enumeratedValue(int enumIndex)

Returns the specified element in an enumeration of the elements in the set.

Parameters:

enumIndex - an index of an element in the enumeration

Returns:

the specified element in an enumeration of the elements in the set

Throws:

java.lang.IndexOutOfBoundsException - if enumIndex < 0 || enumIndex >= this.size()

toArray

public int[] toArray()

Returns an array containing the elements in this set.

Returns:

an array containing the elements in this set

toString

public java.lang.String toString()

Returns java.util.Arrays.toString(this.toArray()).

Overrides:

toString in class java.lang.Object

Returns:

java.util.Arrays.toString(this.toArray())