AbstractCollection.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_ABSTRACTCOLLECTION_H_
#define _DECAF_UTIL_ABSTRACTCOLLECTION_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/Collection.h>
#include <decaf/util/concurrent/Synchronizable.h>
#include <decaf/util/concurrent/Mutex.h>
#include <memory>

namespace decaf {
namespace util {

    template< typename E >
    class AbstractCollection : public virtual decaf::util::Collection<E> {
    protected:

        mutable util::concurrent::Mutex mutex;

    public:

        AbstractCollection() : Collection<E>(), mutex() {}

        AbstractCollection(const AbstractCollection& other) : Collection<E>(), mutex() {
            if (other.isEmpty()) {
                return;
            }
            std::auto_ptr<Iterator<E> > iter(other.iterator());
            while (iter->hasNext()) {
                this->add(iter->next());
            }
        }

        virtual ~AbstractCollection() {}

        AbstractCollection<E>& operator= (const AbstractCollection<E>& collection) {
            this->clear();

            std::auto_ptr<Iterator<E> > iter(collection.iterator());
            while (iter->hasNext()) {
                this->add(iter->next());
            }

            return *this;
        }

        virtual void clear() {
            std::auto_ptr<Iterator<E> > iter(this->iterator());
            while (iter->hasNext()) {
                iter->next();
                iter->remove();
            }
        }

        virtual bool contains(const E& value) const {
            bool result = false;
            std::auto_ptr<Iterator<E> > iter(this->iterator());
            while (iter->hasNext()) {
                if (iter->next() == value) {
                    result = true;
                }
            }

            return result;
        }

        virtual bool containsAll(const Collection<E>& collection) const {

            std::auto_ptr<Iterator<E> > iter(collection.iterator());
            while (iter->hasNext()) {
                if (!this->contains(iter->next())) {
                    return false;
                }
            }

            return true;
        }

        virtual bool equals(const Collection<E>& collection) const {

            if (this == &collection) {
                return true;
            }

            if (this->size() == collection.size() && this->containsAll(collection)) {
                return true;
            }

            return false;
        }

        virtual void copy(const Collection<E>& collection) {
            this->clear();

            std::auto_ptr<Iterator<E> > iter(collection.iterator());
            while (iter->hasNext()) {
                this->add(iter->next());
            }
        }

        virtual bool isEmpty() const {
            return this->size() == 0;
        }

        virtual bool add(const E& value DECAF_UNUSED) {
            throw decaf::lang::exceptions::UnsupportedOperationException(
                __FILE__, __LINE__, "AbstractCollection add is not implemented.");
        }

        virtual bool addAll(const Collection<E>& collection) {

            bool result = false;
            std::auto_ptr<Iterator<E> > iter(collection.iterator());
            while (iter->hasNext()) {
                result = this->add(iter->next()) || result;
            }

            return result;
        }

        virtual bool remove(const E& value) {

            std::auto_ptr<Iterator<E> > iter(this->iterator());
            while (iter->hasNext()) {
                if (value == iter->next()) {
                    iter->remove();
                    return true;
                }
            }

            return false;
        }

        virtual bool removeAll(const Collection<E>& collection) {

            bool result = false;
            std::auto_ptr<Iterator<E> > iter(this->iterator());
            while (iter->hasNext()) {
                if (collection.contains(iter->next())) {
                    iter->remove();
                    result = true;
                }
            }

            return result;
        }

        virtual bool retainAll(const Collection<E>& collection) {

            bool result = false;
            std::auto_ptr<Iterator<E> > iter(this->iterator());
            while (iter->hasNext()) {
                if (!collection.contains(iter->next())) {
                    iter->remove();
                    result = true;
                }
            }

            return result;
        }

        virtual std::vector<E> toArray() const {
            std::vector<E> valueArray;
            valueArray.reserve((std::size_t) this->size());

            std::auto_ptr<Iterator<E> > iter(this->iterator());
            while (iter->hasNext()) {
                valueArray.push_back(iter->next());
            }

            return valueArray;
        }

    public:

        virtual void lock() {
            mutex.lock();
        }

        virtual bool tryLock() {
            return mutex.tryLock();
        }

        virtual void unlock() {
            mutex.unlock();
        }

        virtual void wait()  {
            mutex.wait();
        }

        virtual void wait(long long millisecs) {
            mutex.wait(millisecs);
        }

        virtual void wait(long long millisecs, int nanos) {
            mutex.wait(millisecs, nanos);
        }

        virtual void notify() {
            mutex.notify();
        }

        virtual void notifyAll() {
            mutex.notifyAll();
        }

    };

}}

#endif /*_DECAF_UTIL_ABSTRACTCOLLECTION_H_*/