coherence::util::filter::PresentFilter

PresentFilter Class Reference

#include <coherence/util/filter/PresentFilter.hpp>

Inherits Object, EntryFilter, and PortableObject.

List of all members.

Detailed Description

Filter which returns true for InvocableMap::Entry objects that currently exist in a Map.

This Filter is intended to be used solely in combination with a ConditionalProcessor and is unnecessary for standard QueryMap operations.

Author:
djl 2008.04.08

Public Types

typedef spec::Handle Handle
 PresentFilter Handle definition.
typedef spec::View View
 PresentFilter View definition.
typedef spec::Holder Holder
 PresentFilter Holder definition.

Public Member Functions

virtual bool evaluateEntry (Map::Entry::View vEntry) const
 Apply the test to a Map::Entry.

Parameters:
vEntry the Map::Entry to evaluate; never NULL
Returns:
true if the test passes, false otherwise

virtual bool evaluate (Object::View v) const
 Apply the test to the object.

Parameters:
v the object to test
Returns:
true if the test passes, false otherwise

virtual void readExternal (PofReader::Handle hIn)
 
virtual void writeExternal (PofWriter::Handle hOut) const
 
virtual bool equals (Object::View v) const
 
virtual size32_t hashCode () const
 Return a hash code value for the Object.

This method is supported for the benefit of hash-based containers.

The general contract of hashCode is:

  • Whenever it is invoked on the same Object more than once during an execution of an application, the hashCode method must consistently return the same value, provided no information used in equals comparisons on the object is modified. This value need not remain consistent from one execution of an application to another execution of the same application.
  • If two Objects are equal according to the equals method, then calling the hashCode method on each of the two Objects must produce the same value.
  • It is not required that if two Objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct results. However, the programmer should be aware that producing distinct results for unequal objects may improve the performance of hash-based containers.

The default implementation is identity based.

Returns:
a hash code value for this Object

virtual void toStream (std::ostream &out) const
 Output a human-readable description of this Object to the given stream.

coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toStream method, to output Objects. If a manged String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents.

 Object::View vKey   = ...
 Object::View vValue = ...
 std::cout << vKey << " = " << vValue << std::endl;

 String::Handle hs = COH_TO_STRING(vKey << " = " << vValue);

Parameters:
out the stream used to output the description


Static Public Member Functions

static
PresentFilter::Handle 		getInstance ()
 An instance of the PresentFilter.

Protected Member Functions

 PresentFilter ()
 Construct a PresentFilter.
The documentation for this class was generated from the following file: Copyright (c) 2000-2008 Oracle. All rights reserved.