activemq-cpp-3.9.0
decaf::util::comparators::Equals< E > Class Template Reference

Equality comparator that utilizes the default equality comparison expression == to determine if two values are considered equal. More...

#include <src/main/decaf/util/comparators/Equals.h>

Inheritance diagram for decaf::util::comparators::Equals< E >:

Public Member Functions

 Equals ()
 
virtual ~Equals ()
 
virtual bool operator() (const E &left, const E &right) const
 Implementation of the Binary function interface as a means of allowing a Comparator to be passed to an STL Map for use as the sorting criteria. More...
 
virtual int compare (const E &o1, const E &o2) const
 Compares its two arguments for order. More...
 
- Public Member Functions inherited from decaf::util::Comparator< E >
virtual ~Comparator ()
 

Detailed Description

template<typename E>
class decaf::util::comparators::Equals< E >

Equality comparator that utilizes the default equality comparison expression == to determine if two values are considered equal.

Can be used in Collection classes as a means of comparing objects.

Constructor & Destructor Documentation

template<typename E >
decaf::util::comparators::Equals< E >::Equals ( )
inline
template<typename E >
virtual decaf::util::comparators::Equals< E >::~Equals ( )
inlinevirtual

Member Function Documentation

template<typename E >
virtual int decaf::util::comparators::Equals< E >::compare ( const E &  o1,
const E &  o2 
) const
inlinevirtual

Compares its two arguments for order.

Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that sgn( compare(x, y)) == -sgn(compare(y, x) ) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementer must ensure that compare(x, y)==0 implies that sgn(compare(x, z))==sgn(compare(y, z)) for all z.

It is generally the case, but not strictly required that (compare(x, y)==0) == ( x == y) ). Generally speaking, any comparator that violates this condition should clearly indicate this fact. The recommended language is "Note: this comparator imposes orderings that are inconsistent with equals."

Parameters
o1The first object to be compared
o2The second object to be compared
Returns
a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Implements decaf::util::Comparator< E >.

template<typename E >
virtual bool decaf::util::comparators::Equals< E >::operator() ( const E &  left,
const E &  right 
) const
inlinevirtual

Implementation of the Binary function interface as a means of allowing a Comparator to be passed to an STL Map for use as the sorting criteria.

Parameters
leftThe Left hand side operand.
rightThe Right hand side operand.
Returns
true if the vale of left is less than the value of right.

Implements decaf::util::Comparator< E >.


The documentation for this class was generated from the following file: