org.datanucleus.store.scostore.ListStore Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of datanucleus-core Show documentation
DataNucleus Core provides the primary components of a heterogenous Java persistence solution. It supports persistence API's being layered on top of the core functionality.
There is a newer version: 6.0.7
Show newest version
/**********************************************************************
Copyright (c) 2003 David Jencks and others. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Contributors:
2003 Andy Jefferson - coding standards
2003 Andy Jefferson - commented
2004 Andy Jefferson - changed to extend CollectionStore
2004 Andy Jefferson - added subList
    ...
**********************************************************************/
package org.datanucleus.store.scostore;

import java.util.Collection;
import java.util.ListIterator;

import org.datanucleus.state.ObjectProvider;

/**
 * Interface representation of the backing store for a List.
 * Takes the collection methods and extends them for lists.
 */
public interface ListStore extends CollectionStore
{
    /**
     * Method to add an element to the List.
     * @param op ObjectProvider for the owner of the List. 
     * @param element Element to add
     * @param index Position to add the element. 
     * @param size Current size of list (if known). -1 if not known
     */
    void add(ObjectProvider op, Object element, int index, int size);

    /**
     * Method to add a collection of elements to the List.
     * @param op ObjectProvider for the owner of the List.
     * @param c Collection of elements to add
     * @param index Position to add the elements.
     * @param size Current size of the list (if known). -1 if not known
     * @return Whether the elements were added ok
     */
	boolean addAll(ObjectProvider op, Collection c, int index, int size);

    /**
     * Method to remove an element from the List.
     * @param op ObjectProvider for the owner of the List.
     * @param index Position to remove the element.
     * @param size Current size of the list (if known). -1 if not known
     * @return The element that was removed.
     */
	Object remove(ObjectProvider op, int index, int size);

    /**
     * Method to retrieve an element from a position in the List.
     * @param op ObjectProvider for the owner of the List.
     * @param index Position of the element.
     * @return The element at that position.
     */
	Object get(ObjectProvider op, int index);

    /**
     * Method to update an element at a position in the List.
     * @param op ObjectProvider for the owner of the List.
     * @param index Position of the element.
     * @param element The element value
     * @param allowDependentField Whether to enable dependent field during this operation
     * @return The previous element at that position.
     */
	Object set(ObjectProvider op, int index, Object element, boolean allowDependentField);

    /**
     * Accessor for a sublist of elements between from and to indices.
     * @param op ObjectProvider for the owner of the List.
     * @param from Start position (inclusive)
     * @param to End position (exclusive)
     * @return List of elements in this range.
     */
	java.util.List subList(ObjectProvider op, int from, int to);

    /**
     * Method to return the position of an element in the List.
     * @param op ObjectProvider for the owner of the List.
     * @param element The element value
     * @return The position of the element.
     */
	int indexOf(ObjectProvider op, Object element);

    /**
     * Method to return the last position of an element in the List.
     * @param op ObjectProvider for the owner of the List.
     * @param element The element value
     * @return The last position of the element.
     **/
	int lastIndexOf(ObjectProvider op, Object element);

    /**
     * Accessor for a list iterator for the List.
     * @param op ObjectProvider for the owner of the List. 
     * @return List iterator for the List.
     */
	ListIterator listIterator(ObjectProvider op);
}