org.intellimate.izou.util

Class IdentifiableSet<X extends Identifiable>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<X>

org.intellimate.izou.util.IdentifiableSet<X>

All Implemented Interfaces:

Cloneable, Iterable<X>, Collection<X>, Set<X>

public class IdentifiableSet<X extends Identifiable>
extends AbstractSet<X>
implements Set<X>, Cloneable

Use this class if you want to store a Set of AddOnModules permanently.

The reason for this class is that in the future it might be needed to unregister an AddOn and with this class it is easy to introduce this feature.

Version:

1.0

Author:

Leander Kurscheidt

Constructor Summary

Constructors

Constructor and Description
IdentifiableSet()
IdentifiableSet(Set<X> set)

Method Summary

Modifier and Type	Method and Description
boolean	add(X x) Adds an Element to the Set
void	clear()
Object	clone() Returns a shallow copy of this HashSet instance: the elements themselves are not cloned.
boolean	contains(Object o) Returns true if this set contains the specified element.
boolean	isEmpty() Returns true if this set contains no elements.
Iterator<X>	iterator() Returns an iterator over the elements in this set.
boolean	remove(Object o)
int	size() Returns the number of elements in this set (its cardinality).

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, removeAll, retainAll, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

IdentifiableSet

public IdentifiableSet(Set<X> set)

IdentifiableSet

public IdentifiableSet()

Method Detail

size

public int size()

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Collection<X extends Identifiable>

Specified by:

size in interface Set<X extends Identifiable>

Specified by:

size in class AbstractCollection<X extends Identifiable>

Returns:

the number of elements in this set (its cardinality)

isEmpty

public boolean isEmpty()

Returns true if this set contains no elements.

Specified by:

isEmpty in interface Collection<X extends Identifiable>

Specified by:

isEmpty in interface Set<X extends Identifiable>

Overrides:

isEmpty in class AbstractCollection<X extends Identifiable>

Returns:

true if this set contains no elements

contains

public boolean contains(Object o)

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface Collection<X extends Identifiable>

Specified by:

contains in interface Set<X extends Identifiable>

Overrides:

contains in class AbstractCollection<X extends Identifiable>

Parameters:

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

Returns:

true if this set contains the specified element

Throws:

ClassCastException - if the type of the specified element is incompatible with this set (optional)

NullPointerException - if the specified element is null and this set does not permit null elements (optional)

iterator

public Iterator<X> iterator()

Returns an iterator over the elements in this set. The elements are returned in no particular order.

Specified by:

iterator in interface Iterable<X extends Identifiable>

Specified by:

iterator in interface Collection<X extends Identifiable>

Specified by:

iterator in interface Set<X extends Identifiable>

Specified by:

iterator in class AbstractCollection<X extends Identifiable>

Returns:

an Iterator over the elements in this set

add

public boolean add(X x)

Adds an Element to the Set

Specified by:

add in interface Collection<X extends Identifiable>

Specified by:

add in interface Set<X extends Identifiable>

Overrides:

add in class AbstractCollection<X extends Identifiable>

Parameters:

x - the Element

Returns:

true if this set did not already contain the specified element

Throws:

IllegalArgumentException - if it is not allowed to put Elements without Identification in this Set

remove

public boolean remove(Object o)

This implementation iterates over the collection looking for the specified element. If it finds the element, it removes the element from the collection using the iterator's remove method.

Specified by:

remove in interface Collection<X extends Identifiable>

Specified by:

remove in interface Set<X extends Identifiable>

Overrides:

remove in class AbstractCollection<X extends Identifiable>

Parameters:

o - the object to remove

Throws:

ClassCastException

NullPointerException

clear

public void clear()

This implementation iterates over this collection, removing each element using the Iterator.remove operation. Most implementations will probably choose to override this method for efficiency.

Specified by:

clear in interface Collection<X extends Identifiable>

Specified by:

clear in interface Set<X extends Identifiable>

Overrides:

clear in class AbstractCollection<X extends Identifiable>

clone

public Object clone()

Returns a shallow copy of this HashSet instance: the elements themselves are not cloned.

Overrides:

clone in class Object

Returns:

a shallow copy of this set