Oracle® Fusion Middleware C++ API Reference for Oracle Coherence
12c (12.2.1.3.0)

E80355-01

Event Class Reference

#include <coherence/util/Event.hpp>

Inherits Object.

Inherited by MemberEvent, and ServiceEvent.

List of all members.


Detailed Description

The root class from which all event state classes shall be derived.

All Events are constructed with a reference to the object, the "source", that is logically deemed to be the object upon which the Event in question initially occurred.

Author:
jh 2007.12.12

Public Types

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

Public Member Functions

virtual TypedHandle
< const String
toString () const
 Output a human-readable description of this Object to the given stream.

Note that when overriding this method the return type must be TypedHandle<const String> rather then String::View. These two types are assignment compatible but not equivalent and declaring the override with String::View will not be a compatible override.

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

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

 String::View vs = COH_TO_STRING(vKey << " = " << vValue);

The COH_TO_STRING macro is also the most common way to implement the toString method. For example:

 virtual TypedHandle<const String> Person::toString() const
     {
     return COH_TO_STRING("Name: " << f_sName << " SSN: " << f_nSSN);
     }

Returns:
a string representation of this object

virtual Object::View getSource () const
 Return the object on which the Event initially occurred.

Protected Member Functions

 Event (Object::View vSource)
 Create a new Event instance.

Protected Attributes

FinalView< Objectf_vSource
 The object on which the Event initially occurred.

Constructor & Destructor Documentation

Event ( Object::View  vSource  )  [protected]

Create a new Event instance.

Parameters:
vSource the source associated with the new Event
Returns:
a new Event


Member Function Documentation

virtual Object::View getSource (  )  const [virtual]

Return the object on which the Event initially occurred.

Returns:
the object on which the Event initially occurred


The documentation for this class was generated from the following file:
Copyright © 2000, 2017, Oracle and/or its affiliates. All rights reserved.