net.java.sip.communicator.impl.protocol.irc.collection

Class DynamicDifferenceSet<E>

java.lang.Object

net.java.sip.communicator.impl.protocol.irc.collection.DynamicDifferenceSet<E>

Type Parameters:

E - The type of element that is stored in the set.

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>

public class DynamicDifferenceSet<E>
extends java.lang.Object
implements java.util.Set<E>

Dynamic difference set. A custom implementation that constructs a (dynamic) difference set from 2 input instances. The first input instance is the 'source' which is used as the base data set. The second input is the 'removals', which are then removed from the source set. The dynamic set is computed each time a method call is executed. This set is immutable. That is, the modifier methods are unsupported. Changes that do happen are derived from changes in the 'source' set or the 'removals' set. Keep in mind that any operation on this dynamic returns a result that is only valid in the moment. Even calling two subsequent methods can result in difference or conflicting results.

Author:

Danny van Heumen

Constructor Summary

Constructors

Constructor and Description
DynamicDifferenceSet(java.util.Set<E> source, java.util.Set<E> removals) Constructor for creating a difference set instance.

Method Summary

Modifier and Type	Method and Description
boolean	add(E e) Adding elements to a difference set is unsupported.
boolean	addAll(java.util.Collection<? extends E> c) Adding elements to a difference set is unsupported.
void	clear() Modifying a difference set is unsupported.
boolean	contains(java.lang.Object o) Check if an element is contained in the difference set.
boolean	containsAll(java.util.Collection<?> c) Check if all provided elements are contained in the difference set of the moment.
boolean	isEmpty() Check if the difference set of the moment is empty.
java.util.Iterator<E>	iterator() Get an iterator for the difference set of the moment.
boolean	remove(java.lang.Object o) Removing elements from a difference set is unsupported.
boolean	removeAll(java.util.Collection<?> c) Removing elements from a difference set is unsupported.
boolean	retainAll(java.util.Collection<?> c) Modifying a difference set is unsupported.
int	size() Get the size of the difference set.
java.lang.Object[]	toArray() Get an array of the current difference set.
<T> T[]	toArray(T[] a) Get an array of the current difference set.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

DynamicDifferenceSet

public DynamicDifferenceSet(java.util.Set<E> source,
                            java.util.Set<E> removals)

Constructor for creating a difference set instance.

Parameters:

source - The source data set.

removals - The removals data set which will be used to create the difference.

Method Detail

size

public int size()

Get the size of the difference set. (Keep in mind that these numbers are only momentary and may be obsolete as soon as they are calculated.)

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface java.util.Set<E>

isEmpty

public boolean isEmpty()

Check if the difference set of the moment is empty. (Keep in mind that the result may be obsolete as soon as it is calculated.)

Specified by:

isEmpty in interface java.util.Collection<E>

Specified by:

isEmpty in interface java.util.Set<E>

contains

public boolean contains(java.lang.Object o)

Check if an element is contained in the difference set.

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.Set<E>

iterator

public java.util.Iterator<E> iterator()

Get an iterator for the difference set of the moment.

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in interface java.util.Set<E>

toArray

public java.lang.Object[] toArray()

Get an array of the current difference set.

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.Set<E>

toArray

public <T> T[] toArray(T[] a)

Get an array of the current difference set.

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.Set<E>

add

public boolean add(E e)

Adding elements to a difference set is unsupported.

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.Set<E>

remove

public boolean remove(java.lang.Object o)

Removing elements from a difference set is unsupported.

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.Set<E>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Check if all provided elements are contained in the difference set of the moment.

Specified by:

containsAll in interface java.util.Collection<E>

Specified by:

containsAll in interface java.util.Set<E>

addAll

public boolean addAll(java.util.Collection<? extends E> c)

Adding elements to a difference set is unsupported.

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.Set<E>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Removing elements from a difference set is unsupported.

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.Set<E>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Modifying a difference set is unsupported.

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.Set<E>

clear

public void clear()

Modifying a difference set is unsupported.

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.Set<E>