com.google.common.util.concurrent.ForwardingBlockingQueue Maven / Gradle / Ivy

Go to download
/*
 * Original Guava code is copyright (C) 2015 The Guava Authors.
 * Modifications from Guava are copyright (C) 2015 DiffPlug.
 *
 * 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.google.common.util.concurrent;

import java.util.Collection;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.TimeUnit;

import com.google.common.collect.ForwardingQueue;

/**
 * A {@link BlockingQueue} which forwards all its method calls to another
 * {@link BlockingQueue}. Subclasses should override one or more methods to
 * modify the behavior of the backing collection as desired per the decorator pattern.
 *
 * @author Raimundo Mirisola
 *
 * @param  the type of elements held in this collection
 * @since 4.0
 */
public abstract class ForwardingBlockingQueue extends ForwardingQueue
		implements BlockingQueue {

	/** Constructor for use by subclasses. */
	protected ForwardingBlockingQueue() {}

	@Override
	protected abstract BlockingQueue delegate();

	@Override
	public int drainTo(
			Collection c, int maxElements) {
		return delegate().drainTo(c, maxElements);
	}

	@Override
	public int drainTo(Collection c) {
		return delegate().drainTo(c);
	}

	@Override
	public boolean offer(E e, long timeout, TimeUnit unit)
			throws InterruptedException {
		return delegate().offer(e, timeout, unit);
	}

	@Override
	public E poll(long timeout, TimeUnit unit)
			throws InterruptedException {
		return delegate().poll(timeout, unit);
	}

	@Override
	public void put(E e) throws InterruptedException {
		delegate().put(e);
	}

	@Override
	public int remainingCapacity() {
		return delegate().remainingCapacity();
	}

	@Override
	public E take() throws InterruptedException {
		return delegate().take();
	}
}