Package jadex.collection

Class WeakSet<T>

java.lang.Object

java.util.AbstractCollection<T>

java.util.AbstractSet<T>

jadex.collection.WeakSet<T>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<T>, Collection<T>, Set<T>

public class WeakSet<T>
extends AbstractSet<T>
implements Serializable, Cloneable

A weak set for entries that will be automatically removed when no references to them are existing any more.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ReferenceQueue	queue	The reference queue used to get object removal notifications.
protected Set	serialized_set
protected Set	set	The set which will be used for element storage.

Constructor Summary

Constructors

Constructor	Description
WeakSet()	Construct a WeakSet based on a HashSet.

Method Summary

Modifier and Type	Method	Description
boolean	add(Object obj)	Add an element to the set.
void	clear()	Removes all of the elements from this set.
Object	clone()	Returns a shallow copy of this WeakSet instance: the elements themselves are not cloned.
boolean	contains(Object obj)	Returns true if this set contains the specified element.
protected final void	expungeStaleEntries()	Remove garbage collected entries.
boolean	isEmpty()	Returns true if this set contains no elements.
Iterator	iterator()	Return an iteration over the elements in the set.
protected Object	readResolve()	Perform special handling on serialization.
boolean	remove(Object obj)	Removes the given element from this set if it is present.
int	size()	Return the size of the set.
Object[]	toArray()	Convert the set to an array.
Object[]	toArray(Object[] result)	Convert the set to an array.
protected Object	writeReplace()	Perform special handling on serialization.

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

addAll, containsAll, retainAll, spliterator

Field Details

set

protected transient Set set

The set which will be used for element storage.

queue

protected transient ReferenceQueue queue

The reference queue used to get object removal notifications.

serialized_set

protected Set serialized_set

Constructor Details

WeakSet

public WeakSet()

Construct a WeakSet based on a HashSet.

Method Details

size

public int size()

Return the size of the set.

Specified by:

size in interface Collection<T>

Specified by:

size in interface Set<T>

Specified by:

size in class AbstractCollection<T>

Returns:

The size of the set.

iterator

public Iterator iterator()

Return an iteration over the elements in the set.

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Set<T>

Specified by:

iterator in class AbstractCollection<T>

Returns:

An iteration over the elements in the set.

toArray

public Object[] toArray()

Convert the set to an array.

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

Overrides:

toArray in class AbstractCollection<T>

toArray

public Object[] toArray(Object[] result)

Convert the set to an array.

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

Overrides:

toArray in class AbstractCollection<T>

add

public boolean add(Object obj)

Add an element to the set.

Specified by:

add in interface Collection<T>

Specified by:

add in interface Set<T>

Overrides:

add in class AbstractCollection<T>

Parameters:

obj - Element to add to the set.

Returns:

True if the element was added.

isEmpty

public boolean isEmpty()

Returns true if this set contains no elements.

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface Set<T>

Overrides:

isEmpty in class AbstractCollection<T>

Returns:

true if this set contains no elements.

contains

public boolean contains(Object obj)

Returns true if this set contains the specified element.

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface Set<T>

Overrides:

contains in class AbstractCollection<T>

Parameters:

obj - Element whose presence in this set is to be tested.

Returns:

true if this set contains the specified element.

remove

public boolean remove(Object obj)

Removes the given element from this set if it is present.

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface Set<T>

Overrides:

remove in class AbstractCollection<T>

Parameters:

obj - Object to be removed from this set, if present.

Returns:

true if the set contained the specified element.

clear

public void clear()

Removes all of the elements from this set.

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface Set<T>

Overrides:

clear in class AbstractCollection<T>

clone

public Object clone()

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

Overrides:

clone in class Object

Returns:

A shallow copy of this set.

expungeStaleEntries

protected final void expungeStaleEntries()

Remove garbage collected entries.

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Perform special handling on serialization.

Throws:

ObjectStreamException

readResolve

protected Object readResolve()
                      throws ObjectStreamException

Perform special handling on serialization.

Throws:

ObjectStreamException