org.gradle.foundation.common

Class ReorderableList<E>

java.lang.Object

org.gradle.foundation.common.ReorderableList<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>

public class ReorderableList<E>
extends Object
implements List<E>

Field Summary

Fields

Modifier and Type	Field and Description
protected List<E>	elements Internal list to store the real elements.

Constructor Summary

Constructors

Constructor and Description
ReorderableList()
ReorderableList(List<E> elementList)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E object)
void	add(int index, E element) Inserts the specified element at the specified position in this list (optional operation).
boolean	addAll(Collection<? extends E> c) Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation).
boolean	addAll(int index, Collection<? extends E> c) Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
void	addAll(List<E> list)
boolean	allElementsInBack(List<E> checkList)
boolean	allElementsInFront(List<E> checkList)
void	clear() Removes all of the elements from this list (optional operation).
boolean	contains(Object object) Returns true if this list contains the specified element.
boolean	containsAll(Collection<?> c) Returns true if this list contains all of the elements of the specified collection.
E	get(int index)
int[]	getIndices(List<E> elementsToMove)
int	indexOf(Object object)
boolean	isEmpty()
Iterator<E>	iterator()
int	lastIndexOf(Object object) Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.
ListIterator<E>	listIterator() Returns a list iterator of the elements in this list (in proper sequence).
ListIterator<E>	listIterator(int index) Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.
boolean	moveAfter(E objectToMove)
void	moveAfter(List<E> elementsToMove)
boolean	moveBefore(E objectToMove)
void	moveBefore(List<E> elementsToMove)
void	moveTo(List<E> objectsToMove, int newIndex)
boolean	moveToBack(E objectToMove)
void	moveToBack(List<E> elementsToMove)
boolean	moveToFront(E objectToMove)
void	moveToFront(List<E> elementsToMove)
E	remove(int index) Removes the element at the specified position in this list (optional operation).
boolean	remove(Object object)
boolean	removeAll(Collection<?> c) Removes from this list all the elements that are contained in the specified collection (optional operation).
boolean	retainAll(Collection<?> c) Retains only the elements in this list that are contained in the specified collection (optional operation).
E	set(int index, E element) Replaces the element at the specified position in this list with the specified element (optional operation).
int	size()
List<E>	subList(int fromIndex, int toIndex) Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
Object[]	toArray() Returns an array containing all of the elements in this list in proper sequence.
<T> T[]	toArray(T[] objectArray) Returns an array containing all of the elements in this list in proper sequence; the runtime type of the returned array is that of the specified array.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode

Field Detail

elements

protected List<E> elements

Internal list to store the real elements.

Constructor Detail

ReorderableList

public ReorderableList()

ReorderableList

public ReorderableList(List<E> elementList)

Method Detail

add

public boolean add(E object)

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

get

public E get(int index)

Specified by:

get in interface List<E>

addAll

public void addAll(List<E> list)

remove

public boolean remove(Object object)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

indexOf

public int indexOf(Object object)

Specified by:

indexOf in interface List<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface List<E>

moveBefore

public boolean moveBefore(E objectToMove)

moveBefore

public void moveBefore(List<E> elementsToMove)

moveTo

public void moveTo(List<E> objectsToMove,
          int newIndex)

moveToFront

public boolean moveToFront(E objectToMove)

moveToFront

public void moveToFront(List<E> elementsToMove)

moveAfter

public boolean moveAfter(E objectToMove)

moveAfter

public void moveAfter(List<E> elementsToMove)

moveToBack

public boolean moveToBack(E objectToMove)

moveToBack

public void moveToBack(List<E> elementsToMove)

allElementsInFront

public boolean allElementsInFront(List<E> checkList)

allElementsInBack

public boolean allElementsInBack(List<E> checkList)

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface List<E>

clear

public void clear()

Removes all of the elements from this list (optional operation). This list will be empty after this call returns (unless it throws an exception).

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

Throws:

UnsupportedOperationException - if the clear method is not supported by this list.

toArray

public Object[] toArray()

Returns an array containing all of the elements in this list in proper sequence. Obeys the general contract of the Collection.toArray method.

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

Returns:

an array containing all of the elements in this list in proper sequence.

remove

public E remove(int index)

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Specified by:

remove in interface List<E>

Parameters:

index - the index of the element to removed.

Returns:

the element previously at the specified position.

Throws:

UnsupportedOperationException - if the remove method is not supported by this list.

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

add

public void add(int index,
       E element)

Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Specified by:

add in interface List<E>

Parameters:

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

element - element to be inserted.

Throws:

UnsupportedOperationException - if the add method is not supported by this list.

ClassCastException - if the class of the specified element prevents it from being added to this list.

NullPointerException - if the specified element is null and this list does not support null elements.

IllegalArgumentException - if some aspect of the specified element prevents it from being added to this list.

IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).

lastIndexOf

public int lastIndexOf(Object object)

Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:

lastIndexOf in interface List<E>

Parameters:

object - element to search for.

Returns:

the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.

Throws:

ClassCastException - if the type of the specified element is incompatible with this list (optional).

NullPointerException - if the specified element is null and this list does not support null elements (optional).

contains

public boolean contains(Object object)

Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface List<E>

Parameters:

object - element whose presence in this list is to be tested.

Returns:

true if this list contains the specified element.

Throws:

ClassCastException - if the type of the specified element is incompatible with this list (optional).

NullPointerException - if the specified element is null and this list does not support null elements (optional).

addAll

public boolean addAll(int index,
             Collection<? extends E> c)

Inserts all of the elements in the specified collection into this list at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Specified by:

addAll in interface List<E>

Parameters:

index - index at which to insert first element from the specified collection.

c - elements to be inserted into this list.

Returns:

true if this list changed as a result of the call.

Throws:

UnsupportedOperationException - if the addAll method is not supported by this list.

ClassCastException - if the class of one of elements of the specified collection prevents it from being added to this list.

NullPointerException - if the specified collection contains one or more null elements and this list does not support null elements, or if the specified collection is null.

IllegalArgumentException - if some aspect of one of elements of the specified collection prevents it from being added to this list.

IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).

addAll

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

Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface List<E>

Parameters:

c - collection whose elements are to be added to this list.

Returns:

true if this list changed as a result of the call.

Throws:

UnsupportedOperationException - if the addAll method is not supported by this list.

ClassCastException - if the class of an element in the specified collection prevents it from being added to this list.

NullPointerException - if the specified collection contains one or more null elements and this list does not support null elements, or if the specified collection is null.

IllegalArgumentException - if some aspect of an element in the specified collection prevents it from being added to this list.

See Also:

add(Object)

containsAll

public boolean containsAll(Collection<?> c)

Returns true if this list contains all of the elements of the specified collection.

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface List<E>

Parameters:

c - collection to be checked for containment in this list.

Returns:

true if this list contains all of the elements of the specified collection.

Throws:

ClassCastException - if the types of one or more elements in the specified collection are incompatible with this list (optional).

NullPointerException - if the specified collection contains one or more null elements and this list does not support null elements (optional).

NullPointerException - if the specified collection is null.

See Also:

contains(Object)

removeAll

public boolean removeAll(Collection<?> c)

Removes from this list all the elements that are contained in the specified collection (optional operation).

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface List<E>

Parameters:

c - collection that defines which elements will be removed from this list.

Returns:

true if this list changed as a result of the call.

Throws:

UnsupportedOperationException - if the removeAll method is not supported by this list.

ClassCastException - if the types of one or more elements in this list are incompatible with the specified collection (optional).

NullPointerException - if this list contains one or more null elements and the specified collection does not support null elements (optional).

NullPointerException - if the specified collection is null.

See Also:

remove(Object), contains(Object)

retainAll

public boolean retainAll(Collection<?> c)

Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all the elements that are not contained in the specified collection.

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface List<E>

Parameters:

c - collection that defines which elements this set will retain.

Returns:

true if this list changed as a result of the call.

Throws:

UnsupportedOperationException - if the retainAll method is not supported by this list.

ClassCastException - if the types of one or more elements in this list are incompatible with the specified collection (optional).

NullPointerException - if this list contains one or more null elements and the specified collection does not support null elements (optional).

NullPointerException - if the specified collection is null.

See Also:

remove(Object), contains(Object)

subList

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

Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.

This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:

     list.subList(from, to).clear();
 

Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList.

The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

Specified by:

subList in interface List<E>

Parameters:

fromIndex - low endpoint (inclusive) of the subList.

toIndex - high endpoint (exclusive) of the subList.

Returns:

a view of the specified range within this list.

Throws:

IndexOutOfBoundsException - for an illegal endpoint index value (fromIndex < 0 || toIndex > size || fromIndex > toIndex).

listIterator

public ListIterator<E> listIterator()

Returns a list iterator of the elements in this list (in proper sequence).

Specified by:

listIterator in interface List<E>

Returns:

a list iterator of the elements in this list (in proper sequence).

listIterator

public ListIterator<E> listIterator(int index)

Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. The specified index indicates the first element that would be returned by an initial call to the next method. An initial call to the previous method would return the element with the specified index minus one.

Specified by:

listIterator in interface List<E>

Parameters:

index - index of first element to be returned from the list iterator (by a call to the next method).

Returns:

a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).

set

public E set(int index,
    E element)

Replaces the element at the specified position in this list with the specified element (optional operation).

Specified by:

set in interface List<E>

Parameters:

index - index of element to replace.

element - element to be stored at the specified position.

Returns:

the element previously at the specified position.

Throws:

UnsupportedOperationException - if the set method is not supported by this list.

ClassCastException - if the class of the specified element prevents it from being added to this list.

NullPointerException - if the specified element is null and this list does not support null elements.

IllegalArgumentException - if some aspect of the specified element prevents it from being added to this list.

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

toArray

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

Returns an array containing all of the elements in this list in proper sequence; the runtime type of the returned array is that of the specified array. Obeys the general contract of the Collection.toArray(Object[]) method.

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

Parameters:

objectArray - the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of this list.

Throws:

ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this list.

NullPointerException - if the specified array is null.

getIndices

public int[] getIndices(List<E> elementsToMove)