org.intellimate.izou.util

Class IdentificationSet<X>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<X>

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

All Implemented Interfaces:

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

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

It has the same Properties as an normal HashSet, but (optionally) keeps an Identification for every object to identify its source.

Version:

1.0

Author:

Leander Kurscheidt

Constructor Summary

Constructors

Constructor and Description
IdentificationSet() Constructs a new, empty set;
IdentificationSet(boolean allow) Constructs a new, empty set;
IdentificationSet(int initialCapacity) Constructs a new, empty set.
IdentificationSet(int initialCapacity, boolean allow) Constructs a new, empty set.
IdentificationSet(int initialCapacity, float loadFactor) Constructs a new, empty set.
IdentificationSet(int initialCapacity, float loadFactor, boolean allow) Constructs a new, empty set.

Method Summary

Modifier and Type	Method and Description
boolean	add(X x) Adds an Element to the Set
boolean	add(X x, Identification identification) 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.
String	getID() An ID must always be unique.
Optional<Identification>	getIdentificationFor(X x) returns the associated Identification (if it was added with an identification)
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

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Constructor Detail

IdentificationSet

public IdentificationSet()

Constructs a new, empty set;

the backing HashMap instance has default initial capacity (16) and load factor (0.75).

IdentificationSet

public IdentificationSet(int initialCapacity,
                         float loadFactor)

Constructs a new, empty set.

the backing HashMap instance has the specified initial capacity and the specified load factor.

Parameters:

initialCapacity - the initial capacity of the hash map

loadFactor - the load factor of the hash map

Throws:

IllegalArgumentException - if the initial capacity is less than zero, or if the load factor is nonpositive

IdentificationSet

public IdentificationSet(int initialCapacity)

Constructs a new, empty set.

the backing HashMap instance has the specified initial capacity and default load factor (0.75).

Parameters:

initialCapacity - initialCapacity the initial capacity of the hash table

Throws:

IllegalArgumentException - if the initial capacity is less than zero

IdentificationSet

public IdentificationSet(boolean allow)

Constructs a new, empty set;

the backing HashMap instance has default initial capacity (16) and load factor (0.75).

Parameters:

allow - whether it is allowed to put Elements without Identification in this Set

IdentificationSet

public IdentificationSet(int initialCapacity,
                         float loadFactor,
                         boolean allow)

Constructs a new, empty set.

the backing HashMap instance has the specified initial capacity and the specified load factor.

Parameters:

initialCapacity - the initial capacity of the hash map

loadFactor - the load factor of the hash map

allow - whether it is allowed to put Elements without Identification in this Set

Throws:

IllegalArgumentException - if the initial capacity is less than zero, or if the load factor is nonpositive

IdentificationSet

public IdentificationSet(int initialCapacity,
                         boolean allow)

Constructs a new, empty set.

the backing HashMap instance has the specified initial capacity and default load factor (0.75).

Parameters:

initialCapacity - initialCapacity the initial capacity of the hash table

allow - whether it is allowed to put Elements without Identification in this Set

Throws:

IllegalArgumentException - if the initial capacity is less than zero

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>

Specified by:

size in interface Set<X>

Specified by:

size in class AbstractCollection<X>

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>

Specified by:

isEmpty in interface Set<X>

Overrides:

isEmpty in class AbstractCollection<X>

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>

Specified by:

contains in interface Set<X>

Overrides:

contains in class AbstractCollection<X>

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>

Specified by:

iterator in interface Collection<X>

Specified by:

iterator in interface Set<X>

Specified by:

iterator in class AbstractCollection<X>

Returns:

an Iterator over the elements in this set

getID

public String getID()

An ID must always be unique. A Class like Activator or OutputPlugin can just provide their .class.getCanonicalName() If you have to implement this interface multiple times, just concatenate unique Strings to .class.getCanonicalName()

Specified by:

getID in interface Identifiable

Returns:

A String containing an ID

add

public boolean add(X x)

Adds an Element to the Set

Specified by:

add in interface Collection<X>

Specified by:

add in interface Set<X>

Overrides:

add in class AbstractCollection<X>

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

add

public boolean add(X x,
                   Identification identification)

Adds an Element to the Set

Parameters:

x - the Element

identification - the identification

Returns:

true if this set did not already contain the specified element

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>

Specified by:

remove in interface Set<X>

Overrides:

remove in class AbstractCollection<X>

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>

Specified by:

clear in interface Set<X>

Overrides:

clear in class AbstractCollection<X>

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

getIdentificationFor

public Optional<Identification> getIdentificationFor(X x)

returns the associated Identification (if it was added with an identification)

Parameters:

x - the Element

Returns:

the identification or an Empty Optional