public class XLinkedList<E> extends XCollection<E> implements List<E>
This class represents a linked list with real-time behavior; smooth capacity increase and no memory allocation as long as the list size does not exceed its initial capacity.
All of the operations perform as could be expected for a doubly-linked
list (insertion/deletion
at the end of the list are nonetheless the fastest).
Operations that index into the list will traverse the list from
the begining or the end whichever is closer to the specified index.
Random access operations can be significantly accelerated by
splitting the list into smaller ones.
XLinkedList (as for any XCollection sub-class) supports
fast iterations without using iterators.[code]
XLinkedList
Alternatively The list can be iterated over using XCollection.reusableIterator(). Utilization of
these iterators does not introduce garbage because they are created once. However,
these iterators may not be used concurrently by multiple threads as they are
single instance by nature.
Custom list implementations may override the newNode() method
in order to return their own XLinkedList.Node implementation (with
additional fields for example).
This class was based on collections code from http://javolution.org, but modified for use outside of realtime jvms.
| Modifier and Type | Class and Description |
|---|---|
static class |
XLinkedList.Node<E>
This class represents a
XLinkedList node; it allows for direct
iteration over the list values. |
XCollection.Record| Constructor and Description |
|---|
XLinkedList()
Creates a list of small initial capacity.
|
XLinkedList(Collection<? extends E> values)
Creates a list containing the specified values, in the order they
are returned by the collection's iterator.
|
XLinkedList(int capacity)
Creates a list of specified initial capacity; unless the list size
reaches the specified capacity, operations on this list will not allocate
memory (no lazy object creation).
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
add(E value)
Appends the specified value to the end of this list
(equivalent to
addLast(E)). |
void |
add(int index,
E value)
Inserts the specified value at the specified position in this list.
|
boolean |
addAll(int index,
Collection<? extends E> values)
Inserts all of the values in the specified collection into this
list at the specified position.
|
void |
addBefore(XLinkedList.Node<E> next,
E value)
Inserts the specified value before the specified Node.
|
void |
addFirst(E value)
Inserts the specified value at the beginning of this list.
|
void |
addLast(E value)
Appends the specified value to the end of this list (fast).
|
void |
clear()
Removes all of the values from this collection (optional operation).
|
boolean |
contains(Object value)
Indicates if this collection contains the specified value.
|
void |
delete(XCollection.Record record)
Deletes the specified record from this collection.
|
E |
get(int index)
Returns the value at the specified position in this list.
|
E |
getFirst()
Returns the first value of this list.
|
E |
getLast()
Returns the last value of this list.
|
XLinkedList.Node<E> |
head()
Returns the head record of this collection; it is the record such as
head().getNext() holds the first collection value. |
int |
indexOf(Object value)
Returns the index in this list of the first occurrence of the specified
value, or -1 if this list does not contain this value.
|
XIterator<E> |
iterator()
Returns a simple iterator over the elements in this list
|
int |
lastIndexOf(Object value)
Returns the index in this list of the last occurrence of the specified
value, or -1 if this list does not contain this value.
|
com.neeve.lang.XLinkedList.XLinkedListIterator<E> |
listIterator()
Returns a list iterator over the elements in this list.
|
ListIterator<E> |
listIterator(int index)
Returns a list iterator from the specified position
The specified index indicates the first value that would be returned by
an initial call to the
next method. |
static <E> XLinkedList<E> |
newInstance()
Returns a new list instance.
|
E |
remove(int index)
Removes the value at the specified position in this list.
|
E |
removeFirst()
Removes and returns the first value of this list.
|
E |
removeLast()
Removes and returns the last value of this list (fast).
|
void |
reset() |
E |
set(int index,
E value)
Replaces the value at the specified position in this list with the
specified value.
|
int |
size()
Returns the number of values in this collection.
|
List<E> |
subList(int fromIndex,
int toIndex)
Returns a view of the portion of this list between the specified
indexes
If the specified indexes are equal, the returned list is empty.
|
XLinkedList.Node<E> |
tail()
Returns the tail record of this collection; it is the record such as
tail().getPrevious() holds the last collection value. |
List<E> |
unmodifiable()
Returns the unmodifiable view associated to this collection.
|
E |
valueOf(XCollection.Record record)
Returns the collection value for the specified record.
|
addAll, containsAll, copyTo, equals, hashCode, isEmpty, remove, removeAll, retainAll, reusableIterator, shared, supportsIteratorModifications, toArray, toArray, toStringpublic XLinkedList()
public XLinkedList(int capacity)
capacity - the initial capacity.public XLinkedList(Collection<? extends E> values)
values - the values to be placed into this list.public static <E> XLinkedList<E> newInstance()
public final boolean add(E value)
addLast(E)).add in interface Collection<E>add in interface List<E>add in class XCollection<E>value - the value to be appended to this list.true (as per the general contract of the
Collection.add method).public final E get(int index)
get in interface List<E>index - the index of value to return.IndexOutOfBoundsException - if (index < 0) ||
(index >= size())public final E set(int index, E value)
set in interface List<E>index - the index of value to replace.value - the value to be stored at the specified position.IndexOutOfBoundsException - if (index < 0) ||
(index >= size())public final void add(int index,
E value)
add in interface List<E>index - the index at which the specified value is to be inserted.value - the value to be inserted.IndexOutOfBoundsException - if (index < 0) ||
(index > size())public final boolean addAll(int index,
Collection<? extends E> values)
addAll in interface List<E>index - the index at which to insert first value from the specified
collection.values - the values to be inserted into this list.true if this list changed as a result of the call;
false otherwise.IndexOutOfBoundsException - if (index < 0) ||
(index > size())public final E remove(int index)
remove in interface List<E>index - the index of the value to removed.IndexOutOfBoundsException - if (index < 0) ||
(index >= size())public final int indexOf(Object value)
public final int lastIndexOf(Object value)
lastIndexOf in interface List<E>value - the value to search for.public com.neeve.lang.XLinkedList.XLinkedListIterator<E> listIterator()
listIterator in interface List<E>public ListIterator<E> listIterator(int index)
next method. An initial call to
the previous method would return the value with the
specified index minus one.listIterator in interface List<E>index - index of first value to be returned from the
list iterator (by a call to the next method).IndexOutOfBoundsException - if the index is out of range
[code](index < 0 || index > size())[/code].public final List<E> subList(int fromIndex, int toIndex)
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).subList in interface List<E>fromIndex - low endpoint (inclusive) of the subList.toIndex - high endpoint (exclusive) of the subList.IndexOutOfBoundsException - if [code](fromIndex < 0 ||
toIndex > size || fromIndex < toIndex)[/code]public final E getFirst()
NoSuchElementException - if this list is empty.public final E getLast()
NoSuchElementException - if this list is empty.public final void addFirst(E value)
value - the value to be inserted.public void addLast(E value)
value - the value to be inserted.public final E removeFirst()
NoSuchElementException - if this list is empty.public final E removeLast()
NoSuchElementException - if this list is empty.public final void addBefore(XLinkedList.Node<E> next, E value)
next - the Node before which this value is inserted.value - the value to be inserted.public final XLinkedList.Node<E> head()
XCollectionhead().getNext() holds the first collection value.head in class XCollection<E>public final XLinkedList.Node<E> tail()
XCollectiontail().getPrevious() holds the last collection value.tail in class XCollection<E>public final E valueOf(XCollection.Record record)
XCollectionvalueOf in class XCollection<E>record - the record whose current value is returned.public final void delete(XCollection.Record record)
XCollectionImplementation must ensure that removing a record from the collection does not affect in any way the records preceding the record being removed (it might affect the next records though, e.g. in a list collection, the indices of the subsequent records will change).
delete in class XCollection<E>record - the record to be removed.public final boolean contains(Object value)
XCollectioncontains in interface Collection<E>contains in interface List<E>contains in class XCollection<E>value - the value whose presence in this collection
is to be tested.true if this collection contains the specified
value;false otherwise.public final int size()
XCollectionsize in interface Collection<E>size in interface List<E>size in class XCollection<E>public final void clear()
XCollectionclear in interface Collection<E>clear in interface List<E>clear in class XCollection<E>public List<E> unmodifiable()
XCollectionUnsupportedOperationException being thrown.unmodifiable in class XCollection<E>public void reset()
Copyright © 2019 Neeve Research, LLC. All Rights Reserved.