C++ Client API Reference for Oracle Coherence: coherence/util/AbstractMap.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_ABSTRACT_MAP_HPP
00008 #define COH_ABSTRACT_MAP_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/util/Collection.hpp"
00013 #include "coherence/util/Describable.hpp"
00014 #include "coherence/util/Iterator.hpp"
00015 #include "coherence/util/Map.hpp"
00016 #include "coherence/util/Set.hpp"
00017 
00018 
00019 
00020 COH_OPEN_NAMESPACE2(coherence,util)
00021 
00022 
00023 /**
00024 * This class provides a skeletal implementation of the <tt>Map</tt>
00025 * interface, to minimize the effort required to implement this interface.
00026 *
00027 * To implement an unmodifiable map, the programmer needs only to extend this
00028 * class and provide implementations for the entrySet() and
00029 * iterator() methods.  Method <tt>entrySet</tt> returns a set-view of
00030 * the map's mappings. Typically, the returned set will, in turn, be
00031 * implemented atop <tt>AbstractDeepSet</tt>. Method <tt>iterator</tt> returns
00032 * an entry set iterator that points to the mapping for specified key.
00033 *
00034 * To implement a modifiable map, the programmer must additionally override
00035 * this class's <tt>put</tt>, <tt>remove</tt> and <tt>clear</tt> methods
00036 * (which otherwise throw an
00037 * {@link coherence::lang::UnsupportedOperationException
00038 * UnsupportedOperationException}.
00039 *
00040 * The programmer should generally provide a void (no argument) and map
00041 * constructor, as per the recommendation in the <tt>Map</tt> interface
00042 * specification.
00043 *
00044 * @see Map
00045 *
00046 * @author nsa,mf 2008.01.30
00047 */
00048 class COH_EXPORT AbstractMap
00049     : public abstract_spec<AbstractMap,
00050         extends<Describable>,
00051         implements<Map> >
00052     {
00053     // ----- Map interface --------------------------------------------------
00054 
00055     public:
00056         /**
00057         * {@inheritDoc}
00058         */
00059         virtual size32_t size() const;
00060 
00061         /**
00062         * {@inheritDoc}
00063         */
00064         virtual bool isEmpty() const;
00065 
00066         /**
00067         * {@inheritDoc}
00068         */
00069         virtual bool containsKey(Object::View vKey) const;
00070 
00071         /**
00072         * {@inheritDoc}
00073         */
00074         virtual bool containsValue(Object::View vValue) const;
00075 
00076         /**
00077         * {@inheritDoc}
00078         */
00079         virtual Object::Holder get(Object::View vKey) const;
00080 
00081         /**
00082         * {@inheritDoc}
00083         */
00084         virtual Object::Holder get(Object::View vKey);
00085 
00086         /**
00087         * {@inheritDoc}
00088         */
00089         virtual void putAll(Map::View vMap);
00090 
00091         /**
00092         * {@inheritDoc}
00093         */
00094         virtual Set::View keySet() const;
00095 
00096         /**
00097         * {@inheritDoc}
00098         */
00099         virtual Set::Handle keySet();
00100 
00101         /**
00102         * {@inheritDoc}
00103         */
00104         virtual Collection::View values() const;
00105 
00106         /**
00107         * {@inheritDoc}
00108         */
00109         virtual Collection::Handle values();
00110 
00111 
00112     // ----- Object interface -----------------------------------------------
00113 
00114     public:
00115         /**
00116         * {@inheritDoc}
00117         */
00118         virtual bool equals(Object::View v) const;
00119 
00120         /**
00121         * {@inheritDoc}
00122         */
00123         virtual size32_t hashCode() const;
00124 
00125         /**
00126         * {@inheritDoc}
00127         */
00128         virtual TypedHandle<const String> toString() const;
00129     };
00130 
00131 COH_CLOSE_NAMESPACE2
00132 
00133 #endif // COH_ABSTRACT_MAP_HPP