src/main/decaf/util/Deque.h

Go to the documentation of this file.

/*
 * 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.
 */

#ifndef _DECAF_UTIL_DEQUE_H_
#define _DECAF_UTIL_DEQUE_H_

#include <decaf/util/NoSuchElementException.h>
#include <decaf/lang/exceptions/NullPointerException.h>
#include <decaf/lang/exceptions/IllegalArgumentException.h>
#include <decaf/lang/exceptions/IllegalStateException.h>
#include <decaf/util/Config.h>
#include <decaf/util/Queue.h>

namespace decaf {
namespace util {

    template<typename E>
    class Deque : public Queue<E> {
    public:

        virtual ~Deque() {}

        virtual void addFirst( const E& element ) = 0;

        virtual void addLast( const E& element ) = 0;

        virtual bool offerFirst( const E& element ) = 0;

        virtual bool offerLast( const E& element ) = 0;

        virtual E removeFirst() = 0;

        virtual E removeLast() = 0;

        virtual bool pollFirst( E& element ) = 0;

        virtual bool pollLast( E& element ) = 0;

        virtual E& getFirst() = 0;
        virtual const E& getFirst() const = 0;

        virtual E& getLast() = 0;
        virtual const E& getLast() const = 0;

        virtual bool peekFirst( E& value ) const = 0;

        virtual bool peekLast( E& value ) const = 0;

        virtual bool removeFirstOccurrence( const E& value ) = 0;

        virtual bool removeLastOccurrence( const E& value ) = 0;

        virtual void push( const E& element ) = 0;

        virtual E pop() = 0;

        virtual Iterator<E>* descendingIterator() = 0;
        virtual Iterator<E>* descendingIterator() const = 0;

    };

}}

#endif /* _DECAF_UTIL_DEQUE_H_ */