src/main/decaf/util/List.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_LIST_H_
#define _DECAF_UTIL_LIST_H_

#include <decaf/util/NoSuchElementException.h>
#include <decaf/lang/exceptions/IndexOutOfBoundsException.h>
#include <decaf/util/concurrent/Synchronizable.h>
#include <decaf/util/Config.h>
#include <decaf/util/Iterator.h>
#include <decaf/util/Collection.h>
#include <decaf/util/AbstractCollection.h>
#include <decaf/util/ListIterator.h>

namespace decaf{
namespace util{

    template <typename E>
    class DECAF_API List : public virtual decaf::util::Collection<E> {
    public:

        // Un-hide any methods from Collection that the declarations in this interface hid.
        using decaf::util::Collection<E>::add;
        using decaf::util::Collection<E>::addAll;
        using decaf::util::Collection<E>::remove;

    public:

        List() {}

        virtual ~List() {}

        virtual ListIterator<E>* listIterator() = 0;
        virtual ListIterator<E>* listIterator() const = 0;

        virtual ListIterator<E>* listIterator( int index ) = 0;
        virtual ListIterator<E>* listIterator( int index ) const = 0;

        virtual int indexOf( const E& value ) const = 0;

        virtual int lastIndexOf( const E& value ) const = 0;

        virtual E get( int index ) const = 0;

        virtual E set( int index, const E& element ) = 0;

        virtual void add( int index, const E& element ) = 0;

        virtual bool addAll( int index, const Collection<E>& source ) = 0;

        virtual E removeAt( int index ) = 0;

    };

}}

#endif /*_DECAF_UTIL_LIST_H_*/