C++ Client API Reference for Oracle Coherence: coherence/util/MappedSet.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_MAPPED_SET_HPP
00008 #define COH_MAPPED_SET_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/util/MapKeySet.hpp"
00013 
00014 COH_OPEN_NAMESPACE2(coherence,util)
00015 
00016 
00017 /**
00018 * Set implementation which is backed by a Map.
00019 */
00020 class COH_EXPORT MappedSet
00021     : public cloneable_spec<MappedSet,
00022         extends<MapKeySet> >
00023     {
00024     friend class factory<MappedSet>;
00025 
00026     // ----- constructors ---------------------------------------------------
00027 
00028     protected:
00029         /**
00030         * Return a new MappedSet backed by the supplied Map.
00031         *
00032         * @param hMap  the map to use as storage
00033         */
00034         MappedSet(Map::Handle hMap);
00035 
00036         /**
00037         * Return a new MappedSet backed by the supplied Map.
00038         *
00039         * @param vMap  the map to use as storage
00040         */
00041         MappedSet(Map::View vMap);
00042 
00043         /**
00044         * Copy constructor.
00045         */
00046         MappedSet(const MappedSet& that);
00047 
00048 
00049     // ----- Set interface --------------------------------------------------
00050 
00051     public:
00052         /**
00053         * {@inheritDoc}
00054         */
00055         virtual bool add(Object::Holder oh);
00056 
00057         /**
00058         * {@inheritDoc}
00059         */
00060         virtual bool addAll(Collection::View vCol);
00061 
00062         /**
00063         * {@inheritDoc}
00064         */
00065         virtual Iterator::Handle iterator() const;
00066 
00067         /**
00068         * {@inheritDoc}
00069         */
00070         virtual Muterator::Handle iterator();
00071 
00072         /**
00073         * {@inheritDoc}
00074         */
00075         virtual ObjectArray::Handle toArray(
00076                 ObjectArray::Handle hoa = NULL) const;
00077     };
00078 
00079 COH_CLOSE_NAMESPACE2
00080 
00081 #endif // COH_MAPPED_SET