core/src/main/java/org/apache/mina/queue/QueueBackedIoQueue.java

/*
 *  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.mina.queue;

import java.util.Iterator;
import java.util.Queue;

/**
 * An {@link IoQueue} which uses the specified {@link Queue} as its backing
 * storage.
 *
 * @author The Apache MINA project (dev@mina.apache.org)
 * @version $Rev$, $Date$
 *
 * @param <E> the type of this queue's elements
 */
public class QueueBackedIoQueue<E> extends AbstractIoQueue<E> {

    private final Queue<E> q;

    /**
     * Creates a new instance which delegates necessary calls to the specified
     * queue.
     */
    public QueueBackedIoQueue(Queue<E> queue) {
        if (queue == null) {
            throw new NullPointerException("queue");
        }
        this.q = queue;
    }

    /**
     * {@inheritDoc}
     */
    public E peek() {
        return q.peek();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Iterator<E> iterator() {
        return q.iterator();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int size() {
        return q.size();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Object[] toArray() {
        return q.toArray();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public <T> T[] toArray(T[] a) {
        return q.toArray(a);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected boolean doOffer(E e) {
        return q.offer(e);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected E doPoll() {
        return q.poll();
    }
}