C++ Client API Reference for Oracle Coherence: coherence/util/Muterator.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_MUTERATOR_HPP
00008 #define COH_MUTERATOR_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/util/Iterator.hpp"
00013 
00014 COH_OPEN_NAMESPACE2(coherence,util)
00015 
00016 
00017 /**
00018 * Muterator is mutating iterator, that is it is capable of changing the
00019 * collection it iterates.
00020 *
00021 * @author mf  2008.05.05
00022 */
00023 class COH_EXPORT Muterator
00024     : public interface_spec<Muterator,
00025         implements<Iterator> >
00026     {
00027     // ----- Muterator interface --------------------------------------------
00028 
00029     public:
00030         /**
00031         * Remove from the collection associated with this iterator, the last
00032         * element returned from the iterator.
00033         *
00034         * @throws UnsupportedOperationException if removal is not supported
00035         */
00036         virtual void remove() = 0;
00037     };
00038 
00039 COH_CLOSE_NAMESPACE2
00040 
00041 #endif // COH_MUTERATOR_HPP