C++ Client API Reference for Oracle Coherence: coherence/util/comparator/EntryAwareComparator.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_ENTRY_AWARE_COMPARATOR_HPP
00008 #define COH_ENTRY_AWARE_COMPARATOR_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/util/Comparator.hpp"
00013 
00014 COH_OPEN_NAMESPACE3(coherence,util,comparator)
00015 
00016 
00017 /**
00018 * EntryAwareComparator is an extension to the Comparator interface that
00019 * allows the EntryComparator to know whether the underlying  comparator
00020 * expects to compare the corresponding Entries' keys or values.
00021 *
00022 * @author djl  2008.05.05
00023 */
00024 class COH_EXPORT EntryAwareComparator
00025     : public interface_spec<EntryAwareComparator,
00026         implements<Comparator> >
00027     {
00028     // ----- EntryAwareComparator interface ---------------------------------
00029 
00030     public:
00031         /**
00032         * Specifies whether this comparator expects to compare keys or values.
00033         *
00034         * @return true if Entry keys are expected; false otherwise
00035         */
00036         virtual bool isKeyComparator() const = 0;
00037     };
00038 
00039 COH_CLOSE_NAMESPACE3
00040 
00041 #endif // COH_ENTRY_AWARE_COMPARATOR_HPP