com.comphenix.protocol.concurrency

Class SortedCopyOnWriteArray<T extends java.lang.Comparable<T>>

java.lang.Object

com.comphenix.protocol.concurrency.SortedCopyOnWriteArray<T>

Type Parameters:

T - - type of the elements in the list.

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>

public class SortedCopyOnWriteArray<T extends java.lang.Comparable<T>>
extends java.lang.Object
implements java.lang.Iterable<T>, java.util.Collection<T>

An implicitly sorted array list that preserves insertion order and maintains duplicates.

Constructor Summary

Constructors

Constructor and Description
SortedCopyOnWriteArray() Construct an empty sorted array.
SortedCopyOnWriteArray(java.util.Collection<T> wrapped) Create a sorted array from the given list.
SortedCopyOnWriteArray(java.util.Collection<T> wrapped, boolean sort) Create a sorted array from the given list.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(T value) Inserts the given element in the proper location.
boolean	addAll(java.util.Collection<? extends T> values)
void	clear()
boolean	contains(java.lang.Object value)
boolean	containsAll(java.util.Collection<?> values)
T	get(int index) Retrieves an element by index.
boolean	isEmpty()
java.util.Iterator<T>	iterator() Retrieves an iterator over the elements in the given list.
void	remove(int index) Removes from the list by making a copy of every element except the one with the given index.
boolean	remove(java.lang.Object value) Removes from the list by making a new list with every element except the one given.
boolean	removeAll(java.util.Collection<?> values)
boolean	retainAll(java.util.Collection<?> values)
int	size() Retrieve the size of the list.
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
java.lang.String	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

Constructor Detail

SortedCopyOnWriteArray

public SortedCopyOnWriteArray()

Construct an empty sorted array.

SortedCopyOnWriteArray

public SortedCopyOnWriteArray(java.util.Collection<T> wrapped)

Create a sorted array from the given list. The elements will be automatically sorted.

Parameters:

wrapped - - the collection whose elements are to be placed into the list.

SortedCopyOnWriteArray

public SortedCopyOnWriteArray(java.util.Collection<T> wrapped,
                      boolean sort)

Create a sorted array from the given list.

Parameters:

wrapped - - the collection whose elements are to be placed into the list.

sort - - TRUE to automatically sort the collection, FALSE if it is already sorted.

Method Detail

add

public boolean add(T value)

Inserts the given element in the proper location.

Specified by:

add in interface java.util.Collection<T extends java.lang.Comparable<T>>

Parameters:

value - - element to insert.

addAll

public boolean addAll(java.util.Collection<? extends T> values)

Specified by:

addAll in interface java.util.Collection<T extends java.lang.Comparable<T>>

remove

public boolean remove(java.lang.Object value)

Removes from the list by making a new list with every element except the one given.

Objects will be compared using the given objects equals() method.

Specified by:

remove in interface java.util.Collection<T extends java.lang.Comparable<T>>

Parameters:

value - - value to remove.

removeAll

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

Specified by:

removeAll in interface java.util.Collection<T extends java.lang.Comparable<T>>

retainAll

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

Specified by:

retainAll in interface java.util.Collection<T extends java.lang.Comparable<T>>

remove

public void remove(int index)

Removes from the list by making a copy of every element except the one with the given index.

Parameters:

index - - index of the element to remove.

get

public T get(int index)

Retrieves an element by index.

Parameters:

index - - index of element to retrieve.

Returns:

The element at the given location.

size

public int size()

Retrieve the size of the list.

Specified by:

size in interface java.util.Collection<T extends java.lang.Comparable<T>>

Returns:

Size of the list.

iterator

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

Retrieves an iterator over the elements in the given list. Warning: No not attempt to remove elements using the iterator.

Specified by:

iterator in interface java.lang.Iterable<T extends java.lang.Comparable<T>>

Specified by:

iterator in interface java.util.Collection<T extends java.lang.Comparable<T>>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T extends java.lang.Comparable<T>>

contains

public boolean contains(java.lang.Object value)

Specified by:

contains in interface java.util.Collection<T extends java.lang.Comparable<T>>

containsAll

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

Specified by:

containsAll in interface java.util.Collection<T extends java.lang.Comparable<T>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<T extends java.lang.Comparable<T>>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<T extends java.lang.Comparable<T>>

toArray

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

Specified by:

toArray in interface java.util.Collection<T extends java.lang.Comparable<T>>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object