Package com.intellij.util.containers

Class DisposableWrapperList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

com.intellij.util.containers.DisposableWrapperList<E>

Type Parameters:

E - the type of elements held in this list

All Implemented Interfaces:

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

public class DisposableWrapperList<E>
extends java.util.AbstractList<E>

Similar to a list returned by ContainerUtil.createLockFreeCopyOnWriteList() with additional methods that allow some elements of the list to be associated with Disposable objects. When these disposable objects are disposed, the associated elements are removed from the list.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
DisposableWrapperList()

Method Summary

Modifier and Type	Method and Description
boolean	add(E element)
Disposable	add(E element, Disposable parentDisposable) Appends the specified element to the end of the list with automatic removal controlled by a given Disposable.
void	add(int index, E element)
Disposable	add(int index, E element, Disposable parentDisposable) Inserts the specified element at the specified position in the list with automatic removal controlled by a given Disposable.
boolean	addAll(java.util.Collection<? extends E> collection)
boolean	addAll(int index, java.util.Collection<? extends E> collection)
void	clear()
boolean	contains(java.lang.Object obj)
boolean	containsAll(java.util.Collection<?> collection)
E	get(int index)
int	indexOf(java.lang.Object obj)
boolean	isEmpty()
java.util.Iterator<E>	iterator()
int	lastIndexOf(java.lang.Object obj)
java.util.ListIterator<E>	listIterator()
java.util.ListIterator<E>	listIterator(int index)
E	remove(int index)
boolean	remove(java.lang.Object obj)
boolean	removeAll(java.util.Collection<?> objects)
boolean	removeIf(java.util.function.Predicate<? super E> filter)
boolean	retainAll(java.util.Collection<?> objects)
E	set(int index, E element)
int	size()
java.util.List<E>	subList(int fromIndex, int toIndex)
java.lang.Object []	toArray()
<T> T []	toArray(T [] array)

Methods inherited from class java.util.AbstractList

equals, hashCode, removeRange

Methods inherited from class java.util.AbstractCollection

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

of, of, of, of, of, of, of, of, of, of, of, of, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

DisposableWrapperList

public DisposableWrapperList()

Method Detail

add

public boolean add(E element)

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.List<E>

Overrides:

add in class java.util.AbstractList<E>

add

public void add(int index,
                E element)

Specified by:

add in interface java.util.List<E>

Overrides:

add in class java.util.AbstractList<E>

add

public Disposable add(E element,
                      Disposable parentDisposable)

Appends the specified element to the end of the list with automatic removal controlled by a given Disposable.

Parameters:

element - element to be added to the list

parentDisposable - triggers removal of the element from the list when disposed

Returns:

the disposable object representing the added element. Disposal of this object removes the element from the list. Conversely, removal of the element from the list triggers disposal of its disposable object.

add

public Disposable add(int index,
                      E element,
                      Disposable parentDisposable)

Inserts the specified element at the specified position in the list with automatic removal controlled by a given Disposable.

Parameters:

index - index at which the specified element is to be inserted

element - element to be inserted to the list

parentDisposable - triggers removal of the element from the list when disposed

Returns:

the disposable object representing the added element. Disposal of this object removes the element from the list. Conversely, removal of the element from the list triggers disposal of its disposable object.

addAll

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

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.List<E>

Overrides:

addAll in class java.util.AbstractCollection<E>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends E> collection)

Specified by:

addAll in interface java.util.List<E>

Overrides:

addAll in class java.util.AbstractList<E>

remove

public boolean remove(java.lang.Object obj)

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.List<E>

Overrides:

remove in class java.util.AbstractCollection<E>

remove

public E remove(int index)

Specified by:

remove in interface java.util.List<E>

Overrides:

remove in class java.util.AbstractList<E>

removeAll

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

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.List<E>

Overrides:

removeAll in class java.util.AbstractCollection<E>

removeIf

public boolean removeIf(java.util.function.Predicate<? super E> filter)

retainAll

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

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.List<E>

Overrides:

retainAll in class java.util.AbstractCollection<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.List<E>

Overrides:

clear in class java.util.AbstractList<E>

size

public int size()

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface java.util.List<E>

Specified by:

size in class java.util.AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<E>

Specified by:

isEmpty in interface java.util.List<E>

Overrides:

isEmpty in class java.util.AbstractCollection<E>

iterator

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

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.List<E>

Overrides:

iterator in class java.util.AbstractList<E>

toArray

public java.lang.Object [] toArray()

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.List<E>

Overrides:

toArray in class java.util.AbstractCollection<E>

toArray

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

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.List<E>

Overrides:

toArray in class java.util.AbstractCollection<E>

get

public E get(int index)

Specified by:

get in interface java.util.List<E>

Specified by:

get in class java.util.AbstractList<E>

set

public E set(int index,
             E element)

Specified by:

set in interface java.util.List<E>

Overrides:

set in class java.util.AbstractList<E>

contains

public boolean contains(java.lang.Object obj)

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.List<E>

Overrides:

contains in class java.util.AbstractCollection<E>

containsAll

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

Specified by:

containsAll in interface java.util.Collection<E>

Specified by:

containsAll in interface java.util.List<E>

Overrides:

containsAll in class java.util.AbstractCollection<E>

indexOf

public int indexOf(java.lang.Object obj)

Specified by:

indexOf in interface java.util.List<E>

Overrides:

indexOf in class java.util.AbstractList<E>

lastIndexOf

public int lastIndexOf(java.lang.Object obj)

Specified by:

lastIndexOf in interface java.util.List<E>

Overrides:

lastIndexOf in class java.util.AbstractList<E>

listIterator

public java.util.ListIterator<E> listIterator()

Specified by:

listIterator in interface java.util.List<E>

Overrides:

listIterator in class java.util.AbstractList<E>

listIterator

public java.util.ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface java.util.List<E>

Overrides:

listIterator in class java.util.AbstractList<E>

subList

public java.util.List<E> subList(int fromIndex,
                                 int toIndex)

Specified by:

subList in interface java.util.List<E>

Overrides:

subList in class java.util.AbstractList<E>