Vector (DataNucleus Core 4.1.16 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - java.util.Vector<E>
    - - org.datanucleus.store.types.wrappers.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>

Direct Known Subclasses:

Vector
```
public class Vector<E>
extends Vector<E>
implements SCOList<Vector<E>,E>
```
A mutable second-class Vector object. This is the simplified form that intercepts mutators and marks the field as dirty. It also handles cascade-delete triggering for persistable elements.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Vector<E> delegate
The internal "delegate".

protected AbstractMemberMetaData ownerMmd

protected ObjectProvider ownerOP
- Fields inherited from class java.util.Vector
  capacityIncrement, elementCount, elementData
- Fields inherited from class java.util.AbstractList
  modCount

Fields
Modifier and Type	Field and Description
`protected Vector<E>`	`delegate` The internal "delegate".
`protected AbstractMemberMetaData`	`ownerMmd`
`protected ObjectProvider`	`ownerOP`

Constructor Summary

Constructors
Constructor and Description

Vector(ObjectProvider ownerOP, AbstractMemberMetaData mmd)
Constructor, using the ObjectProvider of the "owner" and the field name.

Constructors
Constructor and Description
`Vector(ObjectProvider ownerOP, AbstractMemberMetaData mmd)` Constructor, using the ObjectProvider of the "owner" and the field name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E element)` Method to add an element to the Vector.
`void`	`add(int index, E element)` Method to add an element to a position in the Vector.
`boolean`	`addAll(Collection elements)` Method to add a Collection to the Vector.
`boolean`	`addAll(int index, Collection elements)` Method to add a Collection to a position in the Vector.
`void`	`addElement(E element)` Method to add an element to the Vector.
`void`	`attachCopy(Vector value)` Method to return an attached copy of the passed (detached) value.
`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.
`Vector`	`detachCopy(FetchPlanState state)` Method to return a detached copy of the container.
`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.
`E`	`get(int index)` Method to retrieve an element no.
`String`	`getFieldName()` Accessor for the field name.
`Object`	`getOwner()` Accessor for the owner object.
`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, and allowing the SCO to be loaded from the datastore (when we have a backing store).
`void`	`initialise(Vector c)` Method to initialise the SCO for use with the provided initial 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`	`listIterator()` Method to retrieve a List iterator for the list.
`ListIterator`	`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.
`void`	`makeDirty()` Utility to mark the object as dirty
`E`	`remove(int index)` Method to remove an element from the Vector.
`boolean`	`remove(Object element)` Method to remove an element from the List
`boolean`	`remove(Object element, boolean allowCascadeDelete)` Method to remove an element from the List
`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.
`void`	`setValue(Vector<E> value)` Method to change the delegate value this wraps (to save recreating the wrapper).
`int`	`size()` Accessor for the size of the Vector.
`List<E>`	`subList(int from, int to)` Accessor for the subList of elements between from and to of the List
`Object[]`	`toArray()` Method to return the list as an array.
`Object[]`	`toArray(Object[] a)` Method to return the list as an array.
`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 java.util.Vector
capacity, copyInto, ensureCapacity, forEach, insertElementAt, removeIf, removeRange, replaceAll, setSize, sort, spliterator, toString, trimToSize

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection
parallelStream, stream

- Field Detail
  - ownerOP
```
protected transient ObjectProvider ownerOP
```
  - ownerMmd
```
protected transient AbstractMemberMetaData ownerMmd
```
  - delegate
```
protected Vector<E> delegate
```
    The internal "delegate".
- Constructor Detail
  - Vector
```
public Vector(ObjectProvider ownerOP,
              AbstractMemberMetaData mmd)
```
    Constructor, using the ObjectProvider of the "owner" and the field name.
    
    Parameters:
    
    ownerOP - The owner ObjectProvider
    
    mmd - Metadata for the member
- Method Detail
  - 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<Vector<E>>
    
    Parameters:
    
    newValue - New value (to wrap)
    
    oldValue - Old value (to use in deciding what needs deleting etc)
  - initialise
```
public void initialise(Vector c)
```
    Description copied from interface: SCO
    
    Method to initialise the SCO for use with the provided initial value. This is used, for example, when retrieving the field from the datastore and setting it in the persistable object.
    
    Specified by:
    
    initialise in interface SCO<Vector<E>>
    
    Parameters:
    
    c - the object from which to copy the value.
  - initialise
```
public void initialise()
```
    Description copied from interface: SCO
    
    Method to initialise the SCO for use, and allowing the SCO to be loaded from the datastore (when we have a backing store). This can be utilised to perform any eager loading of information from the datastore.
    
    Specified by:
    
    initialise in interface SCO<Vector<E>>
  - getValue
```
public Vector<E> getValue()
```
    Accessor for the unwrapped value that we are wrapping.
    
    Specified by:
    
    getValue in interface SCO<Vector<E>>
    
    Returns:
    
    The unwrapped value
  - setValue
```
public void setValue(Vector<E> value)
```
    Description copied from interface: SCOContainer
    
    Method to change the delegate value this wraps (to save recreating the wrapper).
    
    Specified by:
    
    setValue in interface SCOContainer<Vector<E>>
    
    Parameters:
    
    value - The new 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<Vector<E>>
  - isLoaded
```
public boolean isLoaded()
```
    Method to return if the SCO has its contents loaded. Returns true.
    
    Specified by:
    
    isLoaded in interface SCOContainer<Vector<E>>
    
    Returns:
    
    Whether it is loaded
  - 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>
    
    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.
  - getFieldName
```
public String getFieldName()
```
    Accessor for the field name.
    
    Specified by:
    
    getFieldName in interface SCO<Vector<E>>
    
    Returns:
    
    The field name
  - getOwner
```
public Object getOwner()
```
    Accessor for the owner object.
    
    Specified by:
    
    getOwner in interface SCO<Vector<E>>
    
    Returns:
    
    The owner object
  - unsetOwner
```
public void unsetOwner()
```
    Method to unset the owner and field information.
    
    Specified by:
    
    unsetOwner in interface SCO<Vector<E>>
  - makeDirty
```
public void makeDirty()
```
    Utility to mark the object as dirty
  - detachCopy
```
public Vector detachCopy(FetchPlanState state)
```
    Method to return a detached copy of the container. Recurse sthrough the elements so that they are likewise detached.
    
    Specified by:
    
    detachCopy in interface SCO<Vector<E>>
    
    Parameters:
    
    state - State for detachment process
    
    Returns:
    
    The detached container
  - attachCopy
```
public void attachCopy(Vector value)
```
    Method to return an attached copy of the passed (detached) value. The returned attached copy is a SCO wrapper. Goes through the existing elements in the store for this owner field and removes ones no longer present, and adds new elements. All elements in the (detached) value are attached.
    
    Specified by:
    
    attachCopy in interface SCO<Vector<E>>
    
    Parameters:
    
    value - The new (collection) value
  - 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<Vector<E>>
    
    Overrides:
    
    clone in class Vector<E>
    
    Returns:
    
    The cloned object
  - contains
```
public boolean contains(Object element)
```
    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)
```
    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)
```
    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)
```
    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()
```
    Method to return the elements of the List as an Enumeration.
    
    Overrides:
    
    elements in class Vector<E>
    
    Returns:
    
    The elements
  - firstElement
```
public E firstElement()
```
    Method to return the first element in the Vector.
    
    Overrides:
    
    firstElement in class Vector<E>
    
    Returns:
    
    The first element
  - get
```
public E get(int index)
```
    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()
```
    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)
```
    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)
```
    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()
```
    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()
```
    Method to retrieve an iterator for the list.
    
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface Collection<E>
    
    Specified by:
    
    iterator in interface List<E>
    
    Overrides:
    
    iterator in class Vector<E>
    
    Returns:
    
    The iterator
  - lastElement
```
public E lastElement()
```
    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)
```
    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)
```
    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 listIterator()
```
    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 listIterator(int index)
```
    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()
```
    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)
```
    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()
```
    Method to return the list as an array.
    
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface List<E>
    
    Overrides:
    
    toArray in class Vector<E>
    
    Returns:
    
    The array
  - toArray
```
public Object[] toArray(Object[] a)
```
    Method to return the list as an array.
    
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface List<E>
    
    Overrides:
    
    toArray in class Vector<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)
```
    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)
```
    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 elements)
```
    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)
```
    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)
```
    Method to add an element to the Vector.
    
    Overrides:
    
    addElement in class Vector<E>
    
    Parameters:
    
    element - The new element
  - clear
```
public void clear()
```
    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)
```
    Method to remove an element from the List
    
    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)
```
    Method to remove an element from the List
    
    Specified by:
    
    remove in interface SCOCollection<Vector<E>,E>
    
    Parameters:
    
    element - The Element to remove
    
    allowCascadeDelete - Whether to allow cascade delete
    
    Returns:
    
    Whether it was removed successfully.
  - remove
```
public E remove(int index)
```
    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)
```
    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)
```
    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)
```
    Method to remove an element from the Vector.
    
    Overrides:
    
    removeElementAt in class Vector<E>
    
    Parameters:
    
    index - The element position.
  - removeAllElements
```
public void removeAllElements()
```
    Method to remove all elements from the Vector.
    
    Overrides:
    
    removeAllElements in class Vector<E>
  - retainAll
```
public boolean retainAll(Collection c)
```
    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)
```
    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>
    
    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)
```
    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)
```
    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
```
    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.
    
    Returns:
    
    the replaced object
    
    Throws:
    
    ObjectStreamException - if an error occurs

Class Vector<E>

Field Summary

Fields inherited from class java.util.Vector

Fields inherited from class java.util.AbstractList

Constructor Summary

Method Summary

Methods inherited from class java.util.Vector

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Field Detail

ownerOP

ownerMmd

delegate

Constructor Detail

Vector

Method Detail

initialise

initialise

initialise

getValue

setValue

load

isLoaded

updateEmbeddedElement

getFieldName

getOwner

unsetOwner

makeDirty

detachCopy

attachCopy

clone

contains

containsAll

elementAt

equals

elements

firstElement

get

hashCode

indexOf

indexOf

isEmpty

iterator

lastElement

lastIndexOf

lastIndexOf

listIterator

listIterator

size

subList

toArray

toArray

add

add

addAll

addAll

addElement

clear

remove

remove

remove

removeAll

removeElement

removeElementAt

removeAllElements

retainAll

set

set

setElementAt

writeReplace