src/main/decaf/util/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/concurrent/Mutex.h>

namespace decaf{
namespace util{

    template <typename K, typename V, typename COMPARATOR = std::less<K> >
    class Map : public concurrent::Synchronizable {
    public:

        class Entry {
        private:

            K key;
            V value;

        public:

            Entry() {}
            virtual ~Entry() {}

            virtual const K& getKey() const = 0;

            virtual const V& getValue() const = 0;

            virtual void setValue( const V& value ) = 0;

        };

    public:

        Map() {}

        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 void put( const K& key, const V& value ) = 0;

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

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

        // TODO

        virtual std::vector<K> keySet() const = 0;

        virtual std::vector<V> values() const = 0;

    };

}}

#endif /*_DECAF_UTIL_MAP_H_*/