Module org.datanucleus

Package org.datanucleus.store.types.scostore

Interface ListStore<E>

Type Parameters:

E - Element type for this list

All Superinterfaces:

CollectionStore<E>, Store

public interface ListStore<E>
extends CollectionStore<E>

Interface representation of the backing store for a List. Takes the collection methods and extends them for lists.

Method Summary

Modifier and Type	Method	Description
void	add(DNStateManager sm, E element, int index, int size)	Method to add an element to the List.
boolean	addAll(DNStateManager sm, Collection<E> c, int index, int size)	Method to add a collection of elements to the List.
E	get(DNStateManager sm, int index)	Method to retrieve an element from a position in the List.
int	indexOf(DNStateManager sm, Object element)	Method to return the position of an element in the List.
int	lastIndexOf(DNStateManager sm, Object element)	Method to return the last position of an element in the List.
ListIterator<E>	listIterator(DNStateManager sm)	Accessor for a list iterator for the List.
E	remove(DNStateManager sm, int index, int size)	Method to remove an element from the List.
Object	set(DNStateManager sm, int index, Object element, boolean allowDependentField)	Method to update an element at a position in the List.
List	subList(DNStateManager sm, int from, int to)	Accessor for a sublist of elements between from and to indices.

Methods inherited from interface org.datanucleus.store.types.scostore.CollectionStore

add, addAll, clear, contains, hasOrderMapping, iterator, remove, removeAll, size, update, updateEmbeddedElement

Methods inherited from interface org.datanucleus.store.types.scostore.Store

getOwnerMemberMetaData, getStoreManager

Method Detail

add

void add(DNStateManager sm,
         E element,
         int index,
         int size)

Method to add an element to the List.

Parameters:

sm - StateManager for the owner of the List.

element - Element to add

index - Position to add the element.

size - Current size of list (if known). -1 if not known

addAll

boolean addAll(DNStateManager sm,
               Collection<E> c,
               int index,
               int size)

Method to add a collection of elements to the List.

Parameters:

sm - StateManager for the owner of the List.

c - Collection of elements to add

index - Position to add the elements.

size - Current size of the list (if known). -1 if not known

Returns:

Whether the elements were added ok

remove

E remove(DNStateManager sm,
         int index,
         int size)

Method to remove an element from the List.

Parameters:

sm - StateManager for the owner of the List.

index - Position to remove the element.

size - Current size of the list (if known). -1 if not known

Returns:

The element that was removed.

get

E get(DNStateManager sm,
      int index)

Method to retrieve an element from a position in the List.

Parameters:

sm - StateManager for the owner of the List.

index - Position of the element.

Returns:

The element at that position.

set

Object set(DNStateManager sm,
           int index,
           Object element,
           boolean allowDependentField)

Method to update an element at a position in the List.

Parameters:

sm - StateManager for the owner of the List.

index - Position of the element.

element - The element value

allowDependentField - Whether to enable dependent field during this operation

Returns:

The previous element at that position.

subList

List subList(DNStateManager sm,
             int from,
             int to)

Accessor for a sublist of elements between from and to indices.

Parameters:

sm - StateManager for the owner of the List.

from - Start position (inclusive)

to - End position (exclusive)

Returns:

List of elements in this range.

indexOf

int indexOf(DNStateManager sm,
            Object element)

Method to return the position of an element in the List.

Parameters:

sm - StateManager for the owner of the List.

element - The element value

Returns:

The position of the element.

lastIndexOf

int lastIndexOf(DNStateManager sm,
                Object element)

Method to return the last position of an element in the List.

Parameters:

sm - StateManager for the owner of the List.

element - The element value

Returns:

The last position of the element.

listIterator

ListIterator<E> listIterator(DNStateManager sm)

Accessor for a list iterator for the List.

Parameters:

sm - StateManager for the owner of the List.

Returns:

List iterator for the List.