Package io.github.thecsdev.tcdcommons.api.util.collections

Class WeakCollection<E>

java.lang.Object

java.util.AbstractCollection<E>

io.github.thecsdev.tcdcommons.api.util.collections.WeakCollection<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>

@Beta
public final class WeakCollection<E>
extends AbstractCollection<E>

A Collection that stores its elements in form of WeakReferences

Field Summary

Fields

Modifier and Type	Field	Description
protected final LinkedList<WeakReference<E>>	list

Constructor Summary

Constructors

Constructor	Description
WeakCollection()

Method Summary

Modifier and Type	Method	Description
boolean	add(E e)
final int	cleanUp()	Cleans up "expired" WeakReferences whose Objects got garbage collected.
final void	clear()
final boolean	contains(Object o)
final int	garbageSize()	Returns the number of WeakReferences that no longer have a value assigned to them.
final Iterator<E>	iterator()
final ListIterator<E>	listIterator()
final int	size()

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Field Details

list

protected final LinkedList<WeakReference<E>> list

Constructor Details

WeakCollection

public WeakCollection()

Method Details

cleanUp

public final int cleanUp()

Cleans up "expired" WeakReferences whose Objects got garbage collected.

Returns:

The number of cleaned-up entries.

garbageSize

public final int garbageSize()

Returns the number of WeakReferences that no longer have a value assigned to them.

contains

public final boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Overrides:

contains in class AbstractCollection<E>

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Overrides:

add in class AbstractCollection<E>

size

public final int size()

Specified by:

size in interface Collection<E>

Specified by:

size in class AbstractCollection<E>

clear

public final void clear()

Specified by:

clear in interface Collection<E>

Overrides:

clear in class AbstractCollection<E>

iterator

public final Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in class AbstractCollection<E>

listIterator

public final ListIterator<E> listIterator()