com.hazelcast.internal.util.concurrent.ConcurrentConveyorSingleQueue Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2017, Hazelcast, Inc. 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.
*/
package com.hazelcast.internal.util.concurrent;
/**
* Specialization of {@link ConcurrentConveyor} to a single queue.
*/
@SuppressWarnings("checkstyle:interfaceistype")
public final class ConcurrentConveyorSingleQueue extends ConcurrentConveyor {
private final QueuedPipe queue;
private ConcurrentConveyorSingleQueue(E submitterGoneItem, QueuedPipe queue) {
super(submitterGoneItem, queue);
this.queue = queue;
}
/**
* Creates a new concurrent conveyor with a single queue.
*
* @param submitterGoneItem the object that a submitter thread can use to signal it's done submitting
* @param queue the concurrent queue the conveyor will manage
*/
public static ConcurrentConveyorSingleQueue concurrentConveyorSingleQueue(
E1 submitterGoneItem, QueuedPipe queue
) {
return new ConcurrentConveyorSingleQueue(submitterGoneItem, queue);
}
/**
* Offers an item to the queue.
*
* @return whether the item was accepted by the queue
* @throws ConcurrentConveyorException if the draining thread has already left
*/
public boolean offer(E item) throws ConcurrentConveyorException {
return offer(queue, item);
}
/**
* Submits an item to the queue.
*
* @throws ConcurrentConveyorException if the current thread is interrupted or the draining thread has already left
*/
public void submit(E item) throws ConcurrentConveyorException {
submit(queue, item);
}
}