com.github.rholder.moar.concurrent.StrategicQueues Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of moar-concurrent Show documentation

This module contains a collection of useful builders and concurrency classes to assist in modeling complex or overly tweakable concurrent processing pipelines.

There is a newer version: 1.0.3

Show newest version

/*
 * Copyright 2012-2013 Ray Holder
 *
 * 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.github.rholder.moar.concurrent;

import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;

/**
 * This is a helper class for instantiating StrategicBlockingQueue's.
 *
 * @author rholder
 */
public class StrategicQueues {

    /**
     * Return a StrategicBlockingQueue backed by a LinkedBlockingQueue using
     * the given QueueingStrategy.
     *
     * @param queueingStrategy the QueueingStrategy to use
     * @param               the type of elements held in this collection
     */
    public static  StrategicBlockingQueue newStrategicLinkedBlockingQueue(QueueingStrategy queueingStrategy) {
        return new StrategicBlockingQueue(new LinkedBlockingQueue(), queueingStrategy);
    }

    /**
     * Return a StrategicBlockingQueue backed by an ArrayBlockingQueue of the
     * given capacity using the given QueueingStrategy.
     *
     * @param capacity         the capacity of the ArrayBlockingQueue
     * @param queueingStrategy the QueueingStrategy to use
     * @param               the type of elements held in this collection
     */
    public static  StrategicBlockingQueue newStrategicArrayBlockingQueue(int capacity, QueueingStrategy queueingStrategy) {
        return new StrategicBlockingQueue(new ArrayBlockingQueue(capacity), queueingStrategy);
    }

    /**
     * Return a StrategicBlockingQueue backed by the given BlockingQueue using
     * the given QueueingStrategy.
     *
     * @param blockingQueue    the BlockingQueue to back the returned instance
     * @param queueingStrategy the QueueingStrategy to use
     * @param               the type of elements held in this collection
     */
    public static  StrategicBlockingQueue newStrategicBlockingQueue(BlockingQueue blockingQueue, QueueingStrategy queueingStrategy) {
        return new StrategicBlockingQueue(blockingQueue, queueingStrategy);
    }
}