com.augustbonds.foundation

Class Set<E>

java.lang.Object

com.augustbonds.foundation.Set<E>

Type Parameters:

E - The type of elements this Set holds

All Implemented Interfaces:

Iterable<E>

public class Set<E>
extends Object
implements Iterable<E>

The Set class is used to hold a number of unique items of type E. The type E must implement hashCode() and a corresponding equals().

Constructor Summary

Constructors

Constructor and Description
Set() The default constructor.

Method Summary

Modifier and Type	Method and Description
void	add(E element) Add an element to the Set.
boolean	contains(E element) Check whether the specified element exists in the Set.
Iterator<E>	iterator() An iterator for the elements in the Set.
void	remove(E element) Remove an element from the Set.
int	size() The number of elements currently in the Set.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Set

public Set()

The default constructor.

Method Detail

add

public void add(E element)

Add an element to the Set.

Parameters:

element - The element to add.

remove

public void remove(E element)

Remove an element from the Set.

Parameters:

element - The element to remove.

contains

public boolean contains(E element)

Check whether the specified element exists in the Set.

Parameters:

element -

Returns:

size

public int size()

The number of elements currently in the Set.

Returns:

The number of elements.

iterator

public Iterator<E> iterator()

An iterator for the elements in the Set.

Specified by:

iterator in interface Iterable<E>