com.blacklocus.qs.QueueItemProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of qs-core Show documentation

An in-jvm processing pattern for parallelized work off of a queue.

There is a newer version: 0.5.1

/**
 * Copyright 2013 BlackLocus
 *
 * 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.
 */
package com.blacklocus.qs;

import java.util.Collection;
import java.util.Iterator;

/**
 * More generalized version of {@link MessageProvider}
 *
 * @author Jason Dunkelberger (dirkraft)
 */
public interface QueueItemProvider extends Iterator>, Iterable> {

    /**
     * Generally returns this. QueueItemProviders are not generally reusable/resettable since the
     * underlying message source will often not be reversible. Mashing the two interfaces together simplifies
     * implementations a bit, and also supports any typical Iterable usage.
     */
    @Override
    Iterator> iterator();
}