/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
package org.apache.curator.framework.recipes.queue;

/**
 * Abstraction for multiple items.
 * @see DistributedQueue#putMulti(MultiItem)
 * @see DistributedPriorityQueue#putMulti(MultiItem, int)
 */
public interface MultiItem<T>
{
    /**
     * Called repeatedly to get the items to add to the queue. This method
     * should return <code>null</code> when there are no more items to add.
     *
     * @return item or null
     * @throws Exception any errors
     */
    public T    nextItem() throws Exception;
}
