Oracle Coherence for C++ API
Release 3.6.0.0
E15728-01
coherence::util::processor::ConditionalRemove

ConditionalRemove Class Reference

#include <coherence/util/processor/ConditionalRemove.hpp>

Inherits AbstractProcessor, and PortableObject.

List of all members.

Detailed Description

ConditionalRemove is an EntryProcessor that performs an InvocableMap::Entry::remove Entry.remove operation if the specified condition is satisfied.
Author:
tb 2008.04.28

Public Types
typedef spec::Handle  Handle
  ConditionalRemove Handle definition.
typedef spec::View  View
  ConditionalRemove View definition.
typedef spec::Holder  Holder
  ConditionalRemove Holder definition.

Public Member Functions
virtual Object::Holder  process (InvocableMap::Entry::Handle hEntry) const
  Process a Map::Entry object.
Parameters:
hEntry  the Entry to process
Returns:
the result of the processing, if any
virtual Map::View  processAll (Set::View vsetEntries) const
  {
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

Protected Member Functions
  ConditionalRemove ()
  Construct a ConditionalRemove.
  ConditionalRemove (Filter::View vFilter, bool fReturn=false)
  Construct a ConditionalRemove processor that removes an InvocableMap entry if and only if the filter applied to the entry evaluates to true.

Protected Attributes
MemberView< Filter >  m_vFilter
  The underlying filter.
bool  m_fReturn
  Specifies whether or not a return value is required.

Constructor & Destructor Documentation

ConditionalRemove ( Filter::View  vFilter,
bool  fReturn = false  
) [protected]

Construct a ConditionalRemove processor that removes an InvocableMap entry if and only if the filter applied to the entry evaluates to true.

This processor may optionally return the current value as a result of the invocation if it has not been removed (the filter evaluated to false).

Parameters:
vFilter  the filter to evaluate an entry
fReturn  specifies whether or not the processor should return the current value if it has not been removed
The documentation for this class was generated from the following file:
Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.