Top Description Fields Constructors Methods
org.eclipse.persistence.internal.helper.linkedlist

public Class ExposedNodeLinkedList

extends Object
implements List
Class Inheritance
All Implemented Interfaces
java.util.List, java.util.SequencedCollection, java.util.Collection, java.lang.Iterable
Imports
java.util.Collection, .Iterator, .List, .ListIterator, .NoSuchElementException, org.eclipse.persistence.exceptions.ValidationException

INTERNAL: A custom implementation of a linked list. This list exposes the linked nodes directly to the developer. It allows nodes to be referenced in code for quick list manipulation (ie reshuffle, remove, or queuing) It is specifically used in the EclipseLink cache write lock mechanism in order to allow quick removal of objects from the list while still providing the getFirst() addLast() functionality of a queue. The alternative java classes LinkedList, LinkedHashMap do not provide both functional requirements.
Author
Gordon Yorke
Since
10.0.3
See Also
org.eclipse.persistence.internal.helper.linkedlist.LinkedNode

Field Summary

Modifier and TypeField and Description
private transient LinkedNode
private transient int

Constructor Summary

AccessConstructor and Description
public
ExposedNodeLinkedList()

Constructs an empty list.

Method Summary

Modifier and TypeMethod and Description
public boolean
add(Object
element to be appended to this list
object
)

Implements java.util.List.add.

Appends the specified element to the end of this list (optional operation).
public void
add(int
index at which the specified element is to be inserted
index
,
Object
element to be inserted
object
)

Implements java.util.List.add.

Inserts the specified element at the specified position in this list (optional operation).
private LinkedNode
public boolean
addAll(Collection<E>
collection containing elements to be added to this list
collection
)

Implements java.util.List.addAll.

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).
public boolean
addAll(int
index at which to insert the first element from the specified collection
index
,
Collection<E>
collection containing elements to be added to this list
collection
)

Implements java.util.List.addAll.

Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
public LinkedNode
addFirst(Object
the contents to be inserted at the beginning of this list.
o
)

Overrides default java.util.List.addFirst.

Inserts the given contents at the beginning of this list.
public LinkedNode
addLast(Object
the contents to be inserted at the end of this list.
o
)

Overrides default java.util.List.addLast.

Appends the given contents to the end of this list.
public void
clear()

Implements java.util.List.clear.

Removes all of the contents from this list.
public boolean

Returns:

true if this list contains the specified contents.
contains
(Object
contents whose presence in this list is to be tested.
o
)

Implements java.util.List.contains.

Returns true if this list contains the specified contents.
public boolean
containsAll(Collection<E>
collection to be checked for containment in this list
collection
)

Implements java.util.List.containsAll.

Returns true if this list contains all of the elements of the specified collection.
public Object
get(int
index of the element to return
index
)

Implements java.util.List.get.

Returns the element at the specified position in this list.
public Object

Returns:

the first contents in this list. Null if this list is empty.
getFirst
()

Overrides default java.util.List.getFirst.

Returns the first contents in this list.
public Object

Returns:

the last contents in this list. Null if this list is empty.
getLast
()

Overrides default java.util.List.getLast.

Returns the last contents in this list.
public int

Returns:

the index in this list of the first occurrence of the specified contents, or -1 if the list does not contain this contents.
indexOf
(Object
contents to search for.
o
)

Implements java.util.List.indexOf.

Returns the index in this list of the first occurrence of the specified contents, or -1 if the List does not contain this contents.
public boolean
isEmpty()

Implements java.util.List.isEmpty.

Returns true if this list contains no elements.
public Iterator<E>
iterator()

Implements java.util.List.iterator.

Returns an iterator over the elements in this list in proper sequence.
public int
lastIndexOf(Object
element to search for
object
)

Implements java.util.List.lastIndexOf.

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
public ListIterator<E>
listIterator(int
index of the first element to be returned from the list iterator (by a call to next)
index
)

Implements java.util.List.listIterator.

Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
public ListIterator<E>
listIterator()

Implements java.util.List.listIterator.

Returns a list iterator over the elements in this list (in proper sequence).
public void
moveFirst(LinkedNode node)

Allows a node to be efficiently moved first.

public boolean
remove(Object
element to be removed from this list, if present
object
)

Implements java.util.List.remove.

Removes the first occurrence of the specified element from this list, if it is present (optional operation).
public Object
remove(int
the index of the element to be removed
index
)

Implements java.util.List.remove.

Removes the element at the specified position in this list (optional operation).
public void
remove(LinkedNode n)

Allows a node to be efficiently removed.

public boolean
removeAll(Collection<E>
collection containing elements to be removed from this list
collection
)

Implements java.util.List.removeAll.

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

Returns:

the first contents from this list.
removeFirst
()

Overrides default java.util.List.removeFirst.

Removes and returns the first contents from this list.
public Object

Returns:

the last contents from this list.
removeLast
()

Overrides default java.util.List.removeLast.

Removes and returns the last contents from this list.
public boolean
retainAll(Collection<E>
collection containing elements to be retained in this list
collection
)

Implements java.util.List.retainAll.

Retains only the elements in this list that are contained in the specified collection (optional operation).
public Object
set(int
index of the element to replace
index
,
Object
element to be stored at the specified position
value
)

Implements java.util.List.set.

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

Returns:

the number of contents in this list.
size
()

Implements java.util.List.size.

Returns the number of contents in this list.
public List<E>
subList(int
low endpoint (inclusive) of the subList
start
,
int
high endpoint (exclusive) of the subList
end
)

Implements java.util.List.subList.

Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
public Object[]
toArray(Object[]
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.
array
)

Implements java.util.List.toArray.

Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.
public Object[]
toArray()

Implements java.util.List.toArray.

Returns an array containing all of the elements in this list in proper sequence (from first to last element).
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

sizeback to summary
private transient int size

Constructor Detail

ExposedNodeLinkedListback to summary
public ExposedNodeLinkedList()

Constructs an empty list.

Method Detail

addback to summary
public boolean add(Object object)

Implements java.util.List.add.

Doc from java.util.List.add.

Appends the specified element to the end of this list (optional operation).

Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added.

Parameters
object:Object

element to be appended to this list

Returns:boolean

true (as specified by Collection#add)

Annotations
@Override
addback to summary
public void add(int index, Object object)

Implements java.util.List.add.

Doc from java.util.List.add.

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).

Parameters
index:int

index at which the specified element is to be inserted

object:Object

element to be inserted

Annotations
@Override
addAfterback to summary
private LinkedNode addAfter(Object o, LinkedNode n)
addAllback to summary
public boolean addAll(Collection<E> collection)

Implements java.util.List.addAll.

Doc from java.util.List.addAll.

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 undefined 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.)

Parameters
collection:Collection<E>

collection containing elements to be added to this list

Returns:boolean

true if this list changed as a result of the call

Annotations
@Override
addAllback to summary
public boolean addAll(int index, Collection<E> collection)

Implements java.util.List.addAll.

Doc from java.util.List.addAll.

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 undefined 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.)

Parameters
index:int

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

collection:Collection<E>

collection containing elements to be added to this list

Returns:boolean

true if this list changed as a result of the call

Annotations
@Override
addFirstback to summary
public LinkedNode addFirst(Object o)

Overrides default java.util.List.addFirst.

Inserts the given contents at the beginning of this list.

Parameters
o:Object

the contents to be inserted at the beginning of this list.

addLastback to summary
public LinkedNode addLast(Object o)

Overrides default java.util.List.addLast.

Appends the given contents to the end of this list. (Identical in function to the add method; included only for consistency.)

Parameters
o:Object

the contents to be inserted at the end of this list.

clearback to summary
public void clear()

Implements java.util.List.clear.

Removes all of the contents from this list.

Annotations
@Override
containsback to summary
public boolean contains(Object o)

Implements java.util.List.contains.

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

Parameters
o:Object

contents whose presence in this list is to be tested.

Returns:boolean

true if this list contains the specified contents.

Annotations
@Override
containsAllback to summary
public boolean containsAll(Collection<E> collection)

Implements java.util.List.containsAll.

Doc from java.util.List.containsAll.

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

Parameters
collection:Collection<E>

collection to be checked for containment in this list

Returns:boolean

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

Annotations
@Override
getback to summary
public Object get(int index)

Implements java.util.List.get.

Doc from java.util.List.get.

Returns the element at the specified position in this list.

Parameters
index:int

index of the element to return

Returns:Object

the element at the specified position in this list

Annotations
@Override
getFirstback to summary
public Object getFirst()

Overrides default java.util.List.getFirst.

Returns the first contents in this list.

Returns:Object

the first contents in this list. Null if this list is empty.

getLastback to summary
public Object getLast()

Overrides default java.util.List.getLast.

Returns the last contents in this list.

Returns:Object

the last contents in this list. Null if this list is empty.

indexOfback to summary
public int indexOf(Object o)

Implements java.util.List.indexOf.

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

Parameters
o:Object

contents to search for.

Returns:int

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

Annotations
@Override
isEmptyback to summary
public boolean isEmpty()

Implements java.util.List.isEmpty.

Doc from java.util.List.isEmpty.

Returns true if this list contains no elements.

Returns:boolean

true if this list contains no elements

Annotations
@Override
iteratorback to summary
public Iterator<E> iterator()

Implements java.util.List.iterator.

Doc from java.util.List.iterator.

Returns an iterator over the elements in this list in proper sequence.

Returns:Iterator<E>

an iterator over the elements in this list in proper sequence

Annotations
@Override
lastIndexOfback to summary
public int lastIndexOf(Object object)

Implements java.util.List.lastIndexOf.

Doc from java.util.List.lastIndexOf.

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

Parameters
object:Object

element to search for

Returns:int

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

Annotations
@Override
listIteratorback to summary
public ListIterator<E> listIterator(int index)

Implements java.util.List.listIterator.

Doc from java.util.List.listIterator.

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

Parameters
index:int

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

Returns:ListIterator<E>

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

Annotations
@Override
listIteratorback to summary
public ListIterator<E> listIterator()

Implements java.util.List.listIterator.

Doc from java.util.List.listIterator.

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

Returns:ListIterator<E>

a list iterator over the elements in this list (in proper sequence)

Annotations
@Override
moveFirstback to summary
public void moveFirst(LinkedNode node)

Allows a node to be efficiently moved first.

removeback to summary
public boolean remove(Object object)

Implements java.util.List.remove.

Doc from java.util.List.remove.

Removes the first occurrence of the specified element from this list, if it is present (optional operation). If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that Objects.equals(o, get(i)) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).

Parameters
object:Object

element to be removed from this list, if present

Returns:boolean

true if this list contained the specified element

Annotations
@Override
removeback to summary
public Object remove(int index)

Implements java.util.List.remove.

Doc from java.util.List.remove.

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.

Parameters
index:int

the index of the element to be removed

Returns:Object

the element previously at the specified position

Annotations
@Override
removeback to summary
public void remove(LinkedNode n)

Allows a node to be efficiently removed.

removeAllback to summary
public boolean removeAll(Collection<E> collection)

Implements java.util.List.removeAll.

Doc from java.util.List.removeAll.

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

Parameters
collection:Collection<E>

collection containing elements to be removed from this list

Returns:boolean

true if this list changed as a result of the call

Annotations
@Override
removeFirstback to summary
public Object removeFirst()

Overrides default java.util.List.removeFirst.

Removes and returns the first contents from this list.

Returns:Object

the first contents from this list.

Exceptions
NoSuchElementException:
if this list is empty.
removeLastback to summary
public Object removeLast()

Overrides default java.util.List.removeLast.

Removes and returns the last contents from this list.

Returns:Object

the last contents from this list.

Exceptions
NoSuchElementException:
if this list is empty.
retainAllback to summary
public boolean retainAll(Collection<E> collection)

Implements java.util.List.retainAll.

Doc from java.util.List.retainAll.

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

Parameters
collection:Collection<E>

collection containing elements to be retained in this list

Returns:boolean

true if this list changed as a result of the call

Annotations
@Override
setback to summary
public Object set(int index, Object value)

Implements java.util.List.set.

Doc from java.util.List.set.

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

Parameters
index:int

index of the element to replace

value:Object

element to be stored at the specified position

Returns:Object

the element previously at the specified position

Annotations
@Override
sizeback to summary
public int size()

Implements java.util.List.size.

Returns the number of contents in this list.

Returns:int

the number of contents in this list.

Annotations
@Override
subListback to summary
public List<E> subList(int start, int end)

Implements java.util.List.subList.

Doc from java.util.List.subList.

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.)

Parameters
start:int

low endpoint (inclusive) of the subList

end:int

high endpoint (exclusive) of the subList

Returns:List<E>

a view of the specified range within this list

Annotations
@Override
toArrayback to summary
public Object[] toArray(Object[] array)

Implements java.util.List.toArray.

Doc from java.util.List.toArray.

Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list.

If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the list is set to null. (This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.)

Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a list known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

String[] y = x.toArray(new String[0]);
Note that toArray(new Object[0]) is identical in function to toArray().
Parameters
array:Object[]

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:Object[]

an array containing the elements of this list

Annotations
@Override
toArrayback to summary
public Object[] toArray()

Implements java.util.List.toArray.

Doc from java.util.List.toArray.

Returns an array containing all of the elements in this list in proper sequence (from first to last element).

The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array even if this list is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Returns:Object[]

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

Annotations
@Override