Map.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_MAP_H_
#define _DECAF_UTIL_MAP_H_

#include <functional>
#include <vector>
#include <decaf/lang/exceptions/UnsupportedOperationException.h>
#include <decaf/util/NoSuchElementException.h>
#include <decaf/util/concurrent/Synchronizable.h>
#include <decaf/util/Set.h>
#include <decaf/util/Collection.h>
#include <decaf/util/MapEntry.h>

namespace decaf{
namespace util{

    template <typename K, typename V>
    class Map : public concurrent::Synchronizable {
    public:

        Map() : concurrent::Synchronizable() {}

        virtual ~Map() {}

        virtual bool equals(const Map& source) const = 0;

        virtual void copy(const Map& source) = 0;

        virtual void clear() = 0;

        virtual bool containsKey(const K& key) const = 0;

        virtual bool containsValue(const V& value) const = 0;

        virtual bool isEmpty() const = 0;

        virtual int size() const = 0;

        virtual V& get(const K& key) = 0;

        virtual const V& get(const K& key) const = 0;

        virtual bool put(const K& key, const V& value) = 0;

        virtual bool put(const K& key, const V& value, V& oldValue) = 0;

        virtual void putAll(const Map<K, V>& other) = 0;

        virtual V remove(const K& key) = 0;

        virtual Set< MapEntry<K,V> >& entrySet() = 0;
        virtual const Set< MapEntry<K,V> >& entrySet() const = 0;

        virtual Set<K>& keySet() = 0;
        virtual const Set<K>& keySet() const = 0;

        virtual Collection<V>& values() = 0;
        virtual const Collection<V>& values() const = 0;

    };

}}

#endif /*_DECAF_UTIL_MAP_H_*/