Collection.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_COLLECTION_H_
#define _DECAF_UTIL_COLLECTION_H_

#include <decaf/util/Config.h>
#include <decaf/lang/exceptions/UnsupportedOperationException.h>
#include <decaf/lang/exceptions/NullPointerException.h>
#include <decaf/lang/exceptions/IllegalArgumentException.h>
#include <decaf/lang/Iterable.h>
#include <decaf/util/Iterator.h>
#include <decaf/util/concurrent/Synchronizable.h>

namespace decaf {
namespace util {

    template< typename E >
    class Collection : public virtual lang::Iterable<E>,
                       public virtual util::concurrent::Synchronizable {
    public:

        virtual ~Collection() {}

        virtual void copy(const Collection<E>& collection) = 0;

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

        virtual bool addAll(const Collection<E>& collection) = 0;

        virtual void clear() = 0;

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

        virtual bool containsAll(const Collection<E>& collection) const = 0;

        virtual bool equals(const Collection<E>& value) const = 0;

        virtual bool isEmpty() const = 0;

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

        virtual bool removeAll(const Collection<E>& collection) = 0;

        virtual bool retainAll(const Collection<E>& collection) = 0;

        virtual int size() const = 0;

        virtual std::vector<E> toArray() const = 0;

    };

}}

#endif /*_DECAF_UTIL_COLLECTION_H_*/