Class LinkedList<E>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractList<E>
-
- java.util.AbstractSequentialList<E>
-
- java.util.LinkedList<E>
-
- org.datanucleus.store.types.wrappers.LinkedList<E>
-
- org.datanucleus.store.types.wrappers.backed.LinkedList<E>
-
- All Implemented Interfaces:
Serializable,Cloneable,Iterable<E>,Collection<E>,Deque<E>,List<E>,Queue<E>,SCO<LinkedList<E>>,SCOCollection<LinkedList<E>,E>,SCOContainer<LinkedList<E>>,SCOList<LinkedList<E>,E>,BackedSCO
public class LinkedList<E> extends LinkedList<E> implements BackedSCO
A mutable second-class LinkedList object. This class extends LinkedList, using that class to contain the current objects, and the backing ListStore to be the interface to the datastore. A "backing store" is not present for datastores that dont use DatastoreClass, or if the container is serialised or non-persistent.Modes of Operation
The user can operate the list in 2 modes. The cached mode will use an internal cache of the elements (in the "delegate") reading them at the first opportunity and then using the cache thereafter. The non-cached mode will just go direct to the "backing store" each call.Mutators
When the "backing store" is present any updates are passed direct to the datastore as well as to the "delegate". If the "backing store" isn't present the changes are made to the "delegate" only.Accessors
When any accessor method is invoked, it typically checks whether the container has been loaded from its "backing store" (where present) and does this as necessary. Some methods (size()) just check if everything is loaded and use the delegate if possible, otherwise going direct to the datastore.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected booleanallowNullsprotected ListStore<E>backingStoreprotected booleanisCacheLoadedprotected booleanuseCache-
Fields inherited from class org.datanucleus.store.types.wrappers.LinkedList
delegate, ownerMmd, ownerSM, sorting
-
Fields inherited from class java.util.AbstractList
modCount
-
-
Constructor Summary
Constructors Constructor Description LinkedList(DNStateManager ownerSM, AbstractMemberMetaData mmd)Constructor, using StateManager of the "owner" and the field name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidadd(int index, E element)Method to add an element to a position in the LinkedList.booleanadd(E element)Method to add an element to the LinkedList.booleanaddAll(int index, Collection elements)Method to add a Collection to a position in the LinkedList.booleanaddAll(Collection elements)Method to add a Collection to the LinkedList.voidaddFirst(E element)Method to add an element as first in the LinkedList.voidaddLast(E element)Method to add an element as last in the LinkedList.voidclear()Method to clear the LinkedList.Objectclone()Clone operator to return a copy of this object.booleancontains(Object element)Method to return if the list contains this element.booleancontainsAll(Collection c)Accessor for whether a collection of elements are contained here.booleanequals(Object o)voidforEach(Consumer action)Eget(int index)Method to retrieve an element no.StoregetBackingStore()EgetFirst()Method to retrieve the first element.EgetLast()Method to retrieve the last element.LinkedListgetValue()Accessor for the unwrapped value that we are wrapping.inthashCode()intindexOf(Object element)Method to the position of an element.voidinitialise()Method to initialise the SCO for use.voidinitialise(LinkedList c)Method to initialise the SCO from an existing value.voidinitialise(LinkedList newValue, Object oldValue)Method to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new value.booleanisEmpty()Accessor for whether the LinkedList is empty.booleanisLoaded()Method to return if the SCO has its contents loaded.Iterator<E>iterator()Method to retrieve an iterator for the list.intlastIndexOf(Object element)Method to retrieve the last position of the element.ListIterator<E>listIterator(int index)Method to retrieve a List iterator for the list from the index.voidload()Method to effect the load of the data in the SCO.protected voidloadFromStore()Method to load all elements from the "backing store" where appropriate.StreamparallelStream()Eremove(int index)Method to remove an element from the LinkedList.booleanremove(Object element)Method to remove (the first occurrence of) an element from the collectionbooleanremove(Object element, boolean allowCascadeDelete)Method to remove (the first occurrence of) an element from the collectionbooleanremoveAll(Collection elements)Method to remove a Collection from the LinkedList.EremoveFirst()Method to remove the first element from the LinkedList.EremoveLast()Method to remove the last element from the LinkedList.booleanretainAll(Collection c)Method to retain a Collection of elements (and remove all others).Eset(int index, E element)Method to set the element at a position in the LinkedList.Eset(int index, E element, boolean allowDependentField)Wrapper addition that allows turning off of the dependent-field checks when doing the position setting.intsize()Accessor for the size of the LinkedList.Spliteratorspliterator()Streamstream()List<E>subList(int from, int to)Accessor for the subList of elements between from and to of the ListObject[]toArray()Method to return the list as an array.Object[]toArray(Object[] a)Method to return the list as an array.voidunsetOwner()Method to unset the owner and field information.voidupdateEmbeddedElement(E element, int fieldNumber, Object value, boolean makeDirty)Method to update an embedded element in this collection.protected ObjectwriteReplace()The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream.-
Methods inherited from class org.datanucleus.store.types.wrappers.LinkedList
attachCopy, detachCopy, getFieldName, getOwner, makeDirty, setValue, sort
-
Methods inherited from class java.util.LinkedList
descendingIterator, element, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, removeFirstOccurrence, removeLastOccurrence
-
Methods inherited from class java.util.AbstractList
listIterator, removeRange
-
Methods inherited from class java.util.AbstractCollection
toString
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Collection
removeIf, toArray
-
Methods inherited from interface java.util.List
listIterator, replaceAll
-
-
-
-
Constructor Detail
-
LinkedList
public LinkedList(DNStateManager ownerSM, AbstractMemberMetaData mmd)
Constructor, using StateManager of the "owner" and the field name.- Parameters:
ownerSM- The owner StateManagermmd- Metadata for the member
-
-
Method Detail
-
initialise
public void initialise(LinkedList newValue, Object oldValue)
Description copied from interface:SCOMethod to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new value. Note that oldValue is marked as Object since for cases where the member type is Collection the newValue could be, for example, ArrayList, and the oldValue of type Collection (representing null).- Specified by:
initialisein interfaceSCO<E>- Overrides:
initialisein classLinkedList<E>- Parameters:
newValue- New value (to wrap)oldValue- Old value (to use in deciding what needs deleting etc)
-
initialise
public void initialise(LinkedList c)
Method to initialise the SCO from an existing value.- Specified by:
initialisein interfaceSCO<E>- Overrides:
initialisein classLinkedList<E>- Parameters:
c- The object to set from
-
initialise
public void initialise()
Method to initialise the SCO for use.- Specified by:
initialisein interfaceSCO<E>- Overrides:
initialisein classLinkedList<E>
-
getValue
public LinkedList getValue()
Accessor for the unwrapped value that we are wrapping.
-
load
public void load()
Method to effect the load of the data in the SCO. Used when the SCO supports lazy-loading to tell it to load all now.- Specified by:
loadin interfaceSCOContainer<E>- Overrides:
loadin classLinkedList<E>
-
isLoaded
public boolean isLoaded()
Method to return if the SCO has its contents loaded. If the SCO doesn't support lazy loading will just return true.- Specified by:
isLoadedin interfaceBackedSCO- Specified by:
isLoadedin interfaceSCOContainer<E>- Overrides:
isLoadedin classLinkedList<E>- Returns:
- Whether it is loaded
-
loadFromStore
protected void loadFromStore()
Method to load all elements from the "backing store" where appropriate.
-
getBackingStore
public Store getBackingStore()
- Specified by:
getBackingStorein interfaceBackedSCO
-
updateEmbeddedElement
public void updateEmbeddedElement(E element, int fieldNumber, Object value, boolean makeDirty)
Method to update an embedded element in this collection.- Specified by:
updateEmbeddedElementin interfaceSCOCollection<LinkedList<E>,E>- Overrides:
updateEmbeddedElementin classLinkedList<E>- Parameters:
element- The elementfieldNumber- Number of field in the elementvalue- New value for this fieldmakeDirty- Whether to make the SCO field dirty.
-
unsetOwner
public void unsetOwner()
Method to unset the owner and field information.- Specified by:
unsetOwnerin interfaceSCO<E>- Overrides:
unsetOwnerin classLinkedList<E>
-
clone
public Object clone()
Clone operator to return a copy of this object.Mutable second-class Objects are required to provide a public clone method in order to allow for copying persistable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException.
-
contains
public boolean contains(Object element)
Description copied from class:LinkedListMethod to return if the list contains this element.
-
containsAll
public boolean containsAll(Collection c)
Description copied from class:LinkedListAccessor for whether a collection of elements are contained here.- Specified by:
containsAllin interfaceCollection<E>- Specified by:
containsAllin interfaceList<E>- Overrides:
containsAllin classLinkedList<E>- Parameters:
c- The collection of elements.- Returns:
- Whether they are contained.
-
equals
public boolean equals(Object o)
- Specified by:
equalsin interfaceCollection<E>- Specified by:
equalsin interfaceList<E>- Overrides:
equalsin classLinkedList<E>
-
forEach
public void forEach(Consumer action)
-
get
public E get(int index)
Description copied from class:LinkedListMethod to retrieve an element no.
-
getFirst
public E getFirst()
Description copied from class:LinkedListMethod to retrieve the first element.
-
getLast
public E getLast()
Description copied from class:LinkedListMethod to retrieve the last element.
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfaceCollection<E>- Specified by:
hashCodein interfaceList<E>- Overrides:
hashCodein classLinkedList<E>
-
indexOf
public int indexOf(Object element)
Description copied from class:LinkedListMethod to the position of an element.
-
isEmpty
public boolean isEmpty()
Description copied from class:LinkedListAccessor for whether the LinkedList is empty.- Specified by:
isEmptyin interfaceCollection<E>- Specified by:
isEmptyin interfaceList<E>- Overrides:
isEmptyin classLinkedList<E>- Returns:
- Whether it is empty.
-
iterator
public Iterator<E> iterator()
Description copied from class:LinkedListMethod to retrieve an iterator for the list.
-
listIterator
public ListIterator<E> listIterator(int index)
Description copied from class:LinkedListMethod to retrieve a List iterator for the list from the index.- Specified by:
listIteratorin interfaceList<E>- Overrides:
listIteratorin classLinkedList<E>- Parameters:
index- The start point- Returns:
- The iterator
-
lastIndexOf
public int lastIndexOf(Object element)
Description copied from class:LinkedListMethod to retrieve the last position of the element.- Specified by:
lastIndexOfin interfaceList<E>- Overrides:
lastIndexOfin classLinkedList<E>- Parameters:
element- The element- Returns:
- The last position of this element in the List.
-
size
public int size()
Description copied from class:LinkedListAccessor for the size of the LinkedList.
-
subList
public List<E> subList(int from, int to)
Description copied from class:LinkedListAccessor for the subList of elements between from and to of the List
-
toArray
public Object[] toArray()
Description copied from class:LinkedListMethod to return the list as an array.- Specified by:
toArrayin interfaceCollection<E>- Specified by:
toArrayin interfaceList<E>- Overrides:
toArrayin classLinkedList<E>- Returns:
- The array
-
toArray
public Object[] toArray(Object[] a)
Description copied from class:LinkedListMethod to return the list as an array.- Specified by:
toArrayin interfaceCollection<E>- Specified by:
toArrayin interfaceList<E>- Overrides:
toArrayin classLinkedList<E>- Parameters:
a- The runtime types of the array being defined by this param- Returns:
- The array
-
add
public void add(int index, E element)Description copied from class:LinkedListMethod to add an element to a position in the LinkedList.
-
add
public boolean add(E element)
Description copied from class:LinkedListMethod to add an element to the LinkedList.
-
addAll
public boolean addAll(Collection elements)
Description copied from class:LinkedListMethod to add a Collection to the LinkedList.
-
addAll
public boolean addAll(int index, Collection elements)Description copied from class:LinkedListMethod to add a Collection to a position in the LinkedList.
-
addFirst
public void addFirst(E element)
Description copied from class:LinkedListMethod to add an element as first in the LinkedList.
-
addLast
public void addLast(E element)
Description copied from class:LinkedListMethod to add an element as last in the LinkedList.
-
clear
public void clear()
Description copied from class:LinkedListMethod to clear the LinkedList.- Specified by:
clearin interfaceCollection<E>- Specified by:
clearin interfaceList<E>- Overrides:
clearin classLinkedList<E>
-
remove
public E remove(int index)
Description copied from class:LinkedListMethod to remove an element from the LinkedList.
-
remove
public boolean remove(Object element)
Description copied from class:LinkedListMethod to remove (the first occurrence of) an element from the collection
-
remove
public boolean remove(Object element, boolean allowCascadeDelete)
Description copied from class:LinkedListMethod to remove (the first occurrence of) an element from the collection- Specified by:
removein interfaceSCOCollection<LinkedList<E>,E>- Overrides:
removein classLinkedList<E>- Parameters:
element- The Element to removeallowCascadeDelete- Whether to cascade delete- Returns:
- Whether it was removed successfully.
-
removeAll
public boolean removeAll(Collection elements)
Description copied from class:LinkedListMethod to remove a Collection from the LinkedList.- Specified by:
removeAllin interfaceCollection<E>- Specified by:
removeAllin interfaceList<E>- Overrides:
removeAllin classLinkedList<E>- Parameters:
elements- The collection- Returns:
- Whether it was removed ok.
-
removeFirst
public E removeFirst()
Description copied from class:LinkedListMethod to remove the first element from the LinkedList.- Specified by:
removeFirstin interfaceDeque<E>- Overrides:
removeFirstin classLinkedList<E>- Returns:
- The object that was removed
-
removeLast
public E removeLast()
Description copied from class:LinkedListMethod to remove the last element from the LinkedList.- Specified by:
removeLastin interfaceDeque<E>- Overrides:
removeLastin classLinkedList<E>- Returns:
- The object that was removed
-
retainAll
public boolean retainAll(Collection c)
Description copied from class:LinkedListMethod to retain a Collection of elements (and remove all others).- Specified by:
retainAllin interfaceCollection<E>- Specified by:
retainAllin interfaceList<E>- Overrides:
retainAllin classLinkedList<E>- Parameters:
c- The collection to retain- Returns:
- Whether they were retained successfully.
-
set
public E set(int index, E element, boolean allowDependentField)
Description copied from class:LinkedListWrapper addition that allows turning off of the dependent-field checks when doing the position setting. This means that we can prevent the deletion of the object that was previously in that position. This particular feature is used when attaching a list field and where some elements have changed positions.- Specified by:
setin interfaceSCOList<LinkedList<E>,E>- Overrides:
setin classLinkedList<E>- Parameters:
index- The positionelement- The new elementallowDependentField- Whether to allow dependent-field deletes- Returns:
- The element previously at that position
-
set
public E set(int index, E element)
Description copied from class:LinkedListMethod to set the element at a position in the LinkedList.
-
writeReplace
protected Object writeReplace() throws ObjectStreamException
Description copied from class:LinkedListThe writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream. The ObjectOutputStream checks whether the class defines the writeReplace method. If the method is defined, the writeReplace method is called to allow the object to designate its replacement in the stream. The object returned should be either of the same type as the object passed in or an object that when read and resolved will result in an object of a type that is compatible with all references to the object.- Overrides:
writeReplacein classLinkedList<E>- Returns:
- the replaced object
- Throws:
ObjectStreamException- if an error occurs
-
spliterator
public Spliterator spliterator()
- Specified by:
spliteratorin interfaceCollection<E>- Specified by:
spliteratorin interfaceIterable<E>- Specified by:
spliteratorin interfaceList<E>- Overrides:
spliteratorin classLinkedList<E>
-
stream
public Stream stream()
- Specified by:
streamin interfaceCollection<E>- Overrides:
streamin classLinkedList<E>
-
parallelStream
public Stream parallelStream()
- Specified by:
parallelStreamin interfaceCollection<E>- Overrides:
parallelStreamin classLinkedList<E>
-
-