org.datanucleus.store.scostore.ArrayStore 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) 2005 Andy Jefferson 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:
    ...
**********************************************************************/
package org.datanucleus.store.scostore;

import java.util.Iterator;
import java.util.List;

import org.datanucleus.state.ObjectProvider;

/**
 * Interface representation of the backing store for an array.
 **/
public interface ArrayStore extends Store
{
    /**
     * Accessor for an iterator for the array.
     * @param op ObjectProvider for the owner of the array. 
     * @return Iterator for the array.
     **/
    Iterator iterator(ObjectProvider op);

    /**
     * Method to retrieve the elements of the array.
     * @param op ObjectProvider for the owner of the array
     * @return The List of elements in the array (in the same order)
     */
    List getArray(ObjectProvider op);

    /**
     * Accessor for the size of the array.
     * @param op ObjectProvider for the owner of the array. 
     * @return The size of the array.
     */
    int size(ObjectProvider op);

    /**
     * Method to clear the array.
     * @param op ObjectProvider for the owner of the array. 
     */
    void clear(ObjectProvider op);

    /**
     * Method to set the elements in the array.
     * @param op ObjectProvider for the owner of the array.
     * @param array The array
     * @return Whether the elements were added ok
     */
	boolean set(ObjectProvider op, Object array);
}