Class Vector<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.Vector<E>

org.datanucleus.store.types.wrappers.Vector<E>

org.datanucleus.store.types.wrappers.backed.Vector<E>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, RandomAccess, SCO<Vector<E>>, SCOCollection<Vector<E>, E>, SCOContainer<Vector<E>>, SCOList<Vector<E>, E>, BackedSCO

public class Vector<E>
extends Vector<E>
implements BackedSCO

A mutable second-class Vector object. This class extends Vector, 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 boolean	allowNulls
protected ListStore<E>	backingStore
protected boolean	isCacheLoaded
protected boolean	useCache

Fields inherited from class Vector

delegate, ownerMmd, ownerSM, sorting

Fields inherited from class Vector

capacityIncrement, elementCount, elementData

Fields inherited from class AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
Vector(DNStateManager sm, AbstractMemberMetaData mmd)	Constructor, using StateManager of the "owner" and the field name.

Method Summary

Modifier and Type	Method	Description
void	add(int index, E element)	Method to add an element to a position in the Vector.
boolean	add(E element)	Method to add an element to the Vector.
boolean	addAll(int index, Collection elements)	Method to add a Collection to a position in the Vector.
boolean	addAll(Collection<? extends E> elements)	Method to add a Collection to the Vector.
void	addElement(E element)	Method to add an element to the Vector.
void	clear()	Method to clear the Vector.
Object	clone()	Clone operator to return a copy of this object.
boolean	contains(Object element)	Method to return if the list contains this element.
boolean	containsAll(Collection c)	Accessor for whether a collection of elements are contained here.
E	elementAt(int index)	Method to retrieve an element no.
Enumeration	elements()	Method to return the elements of the List as an Enumeration.
boolean	equals(Object o)	Equality operator.
E	firstElement()	Method to return the first element in the Vector.
void	forEach(Consumer<? super E> action)
E	get(int index)	Method to retrieve an element no.
Store	getBackingStore()
Vector<E>	getValue()	Accessor for the unwrapped value that we are wrapping.
int	hashCode()	Hashcode operator.
int	indexOf(Object element)	Method to the position of an element.
int	indexOf(Object element, int startIndex)	Method to the position of an element.
void	initialise()	Method to initialise the SCO for use.
void	initialise(Vector<E> c)	Method to initialise the SCO from an existing value.
void	initialise(Vector<E> 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.
boolean	isEmpty()	Accessor for whether the Vector is empty.
boolean	isLoaded()	Method to return if the SCO has its contents loaded.
Iterator<E>	iterator()	Method to retrieve an iterator for the list.
E	lastElement()	Method to return the last element in the Vector.
int	lastIndexOf(Object element)	Method to retrieve the last position of the element.
int	lastIndexOf(Object element, int startIndex)	Method to retrieve the last position of the element.
ListIterator<E>	listIterator()	Method to retrieve a List iterator for the list.
ListIterator<E>	listIterator(int index)	Method to retrieve a List iterator for the list from the index.
void	load()	Method to effect the load of the data in the SCO.
protected void	loadFromStore()	Method to load all elements from the "backing store" where appropriate.
Stream<E>	parallelStream()
E	remove(int index)	Method to remove an element from the Vector.
boolean	remove(Object element)	Method to remove (the first occurrence of) an element from the collection
boolean	remove(Object element, boolean allowCascadeDelete)	Method to remove (the first occurrence of) an element from the collection
boolean	removeAll(Collection elements)	Method to remove a Collection of elements from the Vector.
void	removeAllElements()	Method to remove all elements from the Vector.
boolean	removeElement(Object element)	Method to remove an element from the Vector.
void	removeElementAt(int index)	Method to remove an element from the Vector.
boolean	retainAll(Collection c)	Method to retain a Collection of elements (and remove all others).
E	set(int index, E element)	Method to set the element at a position in the Vector.
E	set(int index, E element, boolean allowDependentField)	Wrapper addition that allows turning off of the dependent-field checks when doing the position setting.
void	setElementAt(E element, int index)	Method to set the element at a position in the Vector.
int	size()	Accessor for the size of the Vector.
Spliterator<E>	spliterator()
Stream<E>	stream()
List<E>	subList(int from, int to)	Accessor for the subList of elements between from and to of the List
Object[]	toArray()
<T> T[]	toArray(T[] a)
void	unsetOwner()	Method to unset the owner and field information.
void	updateEmbeddedElement(E element, int fieldNumber, Object value, boolean makeDirty)	Method to update an embedded element in this collection.
protected Object	writeReplace()	The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream.

Methods inherited from class Vector

attachCopy, detachCopy, ensureCapacity, getFieldName, getOwner, makeDirty, setValue, sort, trimToSize

Methods inherited from class Vector

capacity, copyInto, insertElementAt, removeIf, removeRange, replaceAll, setSize, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

backingStore

protected transient ListStore<E> backingStore

allowNulls

protected transient boolean allowNulls

useCache

protected transient boolean useCache

isCacheLoaded

protected transient boolean isCacheLoaded

Constructor Details

Vector

public Vector(DNStateManager sm,
 AbstractMemberMetaData mmd)

Constructor, using StateManager of the "owner" and the field name.

Parameters:

sm - The owner StateManager

mmd - Metadata for the member

Method Details

initialise

public void initialise(Vector<E> newValue,
 Object oldValue)

Description copied from interface: SCO

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

initialise in interface SCO<E>

Overrides:

initialise in class Vector<E>

Parameters:

newValue - New value (to wrap)

oldValue - Old value (to use in deciding what needs deleting etc)

initialise

public void initialise(Vector<E> c)

Method to initialise the SCO from an existing value.

Specified by:

initialise in interface SCO<E>

Overrides:

initialise in class Vector<E>

Parameters:

c - The object to set from

initialise

public void initialise()

Method to initialise the SCO for use.

Specified by:

initialise in interface SCO<E>

Overrides:

initialise in class Vector<E>

getValue

public Vector<E> getValue()

Accessor for the unwrapped value that we are wrapping.

Specified by:

getValue in interface SCO<E>

Overrides:

getValue in class Vector<E>

Returns:

The unwrapped value

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:

load in interface SCOContainer<E>

Overrides:

load in class Vector<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:

isLoaded in interface BackedSCO

Specified by:

isLoaded in interface SCOContainer<E>

Overrides:

isLoaded in class Vector<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:

getBackingStore in interface BackedSCO

updateEmbeddedElement

public void updateEmbeddedElement(E element,
 int fieldNumber,
 Object value,
 boolean makeDirty)

Method to update an embedded element in this collection.

Specified by:

updateEmbeddedElement in interface SCOCollection<Vector<E>, E>

Overrides:

updateEmbeddedElement in class Vector<E>

Parameters:

element - The element

fieldNumber - Number of field in the element

value - New value for this field

makeDirty - Whether to make the SCO field dirty.

unsetOwner

public void unsetOwner()

Method to unset the owner and field information.

Specified by:

unsetOwner in interface SCO<E>

Overrides:

unsetOwner in class Vector<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.

Specified by:

clone in interface SCO<E>

Overrides:

clone in class Vector<E>

Returns:

The cloned object

contains

public boolean contains(Object element)

Description copied from class: Vector

Method to return if the list contains this element.

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface List<E>

Overrides:

contains in class Vector<E>

Parameters:

element - The element

Returns:

Whether it is contained

containsAll

public boolean containsAll(Collection c)

Description copied from class: Vector

Accessor for whether a collection of elements are contained here.

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface List<E>

Overrides:

containsAll in class Vector<E>

Parameters:

c - The collection of elements.

Returns:

Whether they are contained.

elementAt

public E elementAt(int index)

Description copied from class: Vector

Method to retrieve an element no.

Overrides:

elementAt in class Vector<E>

Parameters:

index - The item to retrieve

Returns:

The element at that position.

equals

public boolean equals(Object o)

Description copied from class: Vector

Equality operator.

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface List<E>

Overrides:

equals in class Vector<E>

Parameters:

o - The object to compare against.

Returns:

Whether this object is the same.

elements

public Enumeration elements()

Description copied from class: Vector

Method to return the elements of the List as an Enumeration.

Overrides:

elements in class Vector<E>

Returns:

The elements

firstElement

public E firstElement()

Description copied from class: Vector

Method to return the first element in the Vector.

Overrides:

firstElement in class Vector<E>

Returns:

The first element

forEach

public void forEach(Consumer<? super E> action)

Specified by:

forEach in interface Iterable<E>

Overrides:

forEach in class Vector<E>

get

public E get(int index)

Description copied from class: Vector

Method to retrieve an element no.

Specified by:

get in interface List<E>

Overrides:

get in class Vector<E>

Parameters:

index - The item to retrieve

Returns:

The element at that position.

hashCode

public int hashCode()

Description copied from class: Vector

Hashcode operator.

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface List<E>

Overrides:

hashCode in class Vector<E>

Returns:

The Hash code.

indexOf

public int indexOf(Object element)

Description copied from class: Vector

Method to the position of an element.

Specified by:

indexOf in interface List<E>

Overrides:

indexOf in class Vector<E>

Parameters:

element - The element.

Returns:

The position.

indexOf

public int indexOf(Object element,
 int startIndex)

Description copied from class: Vector

Method to the position of an element.

Overrides:

indexOf in class Vector<E>

Parameters:

element - The element.

startIndex - The start position

Returns:

The position.

isEmpty

public boolean isEmpty()

Description copied from class: Vector

Accessor for whether the Vector is empty.

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface List<E>

Overrides:

isEmpty in class Vector<E>

Returns:

Whether it is empty.

iterator

public Iterator<E> iterator()

Description copied from class: Vector

Method to retrieve an iterator for the list.

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface List<E>

Overrides:

iterator in class Vector<E>

Returns:

The iterator

lastElement

public E lastElement()

Description copied from class: Vector

Method to return the last element in the Vector.

Overrides:

lastElement in class Vector<E>

Returns:

The last element

lastIndexOf

public int lastIndexOf(Object element)

Description copied from class: Vector

Method to retrieve the last position of the element.

Specified by:

lastIndexOf in interface List<E>

Overrides:

lastIndexOf in class Vector<E>

Parameters:

element - The element

Returns:

The last position of this element in the List.

lastIndexOf

public int lastIndexOf(Object element,
 int startIndex)

Description copied from class: Vector

Method to retrieve the last position of the element.

Overrides:

lastIndexOf in class Vector<E>

Parameters:

element - The element

startIndex - The start position

Returns:

The last position of this element in the List.

listIterator

public ListIterator<E> listIterator()

Description copied from class: Vector

Method to retrieve a List iterator for the list.

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class Vector<E>

Returns:

The iterator

listIterator

public ListIterator<E> listIterator(int index)

Description copied from class: Vector

Method to retrieve a List iterator for the list from the index.

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class Vector<E>

Parameters:

index - The start point

Returns:

The iterator

size

public int size()

Description copied from class: Vector

Accessor for the size of the Vector.

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

Overrides:

size in class Vector<E>

Returns:

The size.

subList

public List<E> subList(int from,
 int to)

Description copied from class: Vector

Accessor for the subList of elements between from and to of the List

Specified by:

subList in interface List<E>

Overrides:

subList in class Vector<E>

Parameters:

from - Start index (inclusive)

to - End index (exclusive)

Returns:

The subList

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

Overrides:

toArray in class Vector<E>

toArray

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

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface List<E>

Overrides:

toArray in class Vector<E>

add

public void add(int index,
 E element)

Description copied from class: Vector

Method to add an element to a position in the Vector.

Specified by:

add in interface List<E>

Overrides:

add in class Vector<E>

Parameters:

index - The position

element - The new element

add

public boolean add(E element)

Description copied from class: Vector

Method to add an element to the Vector.

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

Overrides:

add in class Vector<E>

Parameters:

element - The new element

Returns:

Whether it was added ok.

addAll

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

Description copied from class: Vector

Method to add a Collection to the Vector.

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface List<E>

Overrides:

addAll in class Vector<E>

Parameters:

elements - The collection

Returns:

Whether it was added ok.

addAll

public boolean addAll(int index,
 Collection elements)

Description copied from class: Vector

Method to add a Collection to a position in the Vector.

Specified by:

addAll in interface List<E>

Overrides:

addAll in class Vector<E>

Parameters:

index - Position to insert the collection.

elements - The collection

Returns:

Whether it was added ok.

addElement

public void addElement(E element)

Description copied from class: Vector

Method to add an element to the Vector.

Overrides:

addElement in class Vector<E>

Parameters:

element - The new element

clear

public void clear()

Description copied from class: Vector

Method to clear the Vector.

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

Overrides:

clear in class Vector<E>

remove

public boolean remove(Object element)

Description copied from class: Vector

Method to remove (the first occurrence of) an element from the collection

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

Overrides:

remove in class Vector<E>

Parameters:

element - The Element to remove

Returns:

Whether it was removed successfully.

remove

public boolean remove(Object element,
 boolean allowCascadeDelete)

Description copied from class: Vector

Method to remove (the first occurrence of) an element from the collection

Specified by:

remove in interface SCOCollection<Vector<E>, E>

Overrides:

remove in class Vector<E>

Parameters:

element - The Element to remove

allowCascadeDelete - Whether to cascade delete

Returns:

Whether it was removed successfully.

remove

public E remove(int index)

Description copied from class: Vector

Method to remove an element from the Vector.

Specified by:

remove in interface List<E>

Overrides:

remove in class Vector<E>

Parameters:

index - The element position.

Returns:

The object that was removed

removeAll

public boolean removeAll(Collection elements)

Description copied from class: Vector

Method to remove a Collection of elements from the Vector.

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface List<E>

Overrides:

removeAll in class Vector<E>

Parameters:

elements - The collection

Returns:

Whether it was removed ok.

removeElement

public boolean removeElement(Object element)

Description copied from class: Vector

Method to remove an element from the Vector.

Overrides:

removeElement in class Vector<E>

Parameters:

element - The element

Returns:

Whether the element was removed

removeElementAt

public void removeElementAt(int index)

Description copied from class: Vector

Method to remove an element from the Vector.

Overrides:

removeElementAt in class Vector<E>

Parameters:

index - The element position.

removeAllElements

public void removeAllElements()

Description copied from class: Vector

Method to remove all elements from the Vector.

Overrides:

removeAllElements in class Vector<E>

retainAll

public boolean retainAll(Collection c)

Description copied from class: Vector

Method to retain a Collection of elements (and remove all others).

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface List<E>

Overrides:

retainAll in class Vector<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: Vector

Wrapper 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:

set in interface SCOList<Vector<E>, E>

Overrides:

set in class Vector<E>

Parameters:

index - The position

element - The new element

allowDependentField - 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: Vector

Method to set the element at a position in the Vector.

Specified by:

set in interface List<E>

Overrides:

set in class Vector<E>

Parameters:

index - The position

element - The new element

Returns:

The element previously at that position

setElementAt

public void setElementAt(E element,
 int index)

Description copied from class: Vector

Method to set the element at a position in the Vector.

Overrides:

setElementAt in class Vector<E>

Parameters:

element - The new element

index - The position

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Description copied from class: Vector

The 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:

writeReplace in class Vector<E>

Returns:

the replaced object

Throws:

ObjectStreamException - if an error occurs

spliterator

public Spliterator<E> spliterator()

Specified by:

spliterator in interface Collection<E>

Specified by:

spliterator in interface Iterable<E>

Specified by:

spliterator in interface List<E>

Overrides:

spliterator in class Vector<E>

stream

public Stream<E> stream()

Specified by:

stream in interface Collection<E>

Overrides:

stream in class Vector<E>

parallelStream

public Stream<E> parallelStream()

Specified by:

parallelStream in interface Collection<E>

Overrides:

parallelStream in class Vector<E>