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_EVENT_HPP 00008 #define COH_EVENT_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 00013 00014 COH_OPEN_NAMESPACE2(coherence,util) 00015 00016 00017 /** 00018 * The root class from which all event state classes shall be derived. 00019 * <p> 00020 * All Events are constructed with a reference to the object, the "source", 00021 * that is logically deemed to be the object upon which the Event in question 00022 * initially occurred. 00023 * 00024 * @author jh 2007.12.12 00025 */ 00026 class COH_EXPORT Event 00027 : public class_spec<Event> 00028 { 00029 friend class factory<Event>; 00030 00031 // ----- constructors --------------------------------------------------- 00032 00033 protected: 00034 /** 00035 * Create a new Event instance. 00036 * 00037 * @param vSource the source associated with the new Event 00038 * 00039 * @return a new Event 00040 */ 00041 Event(Object::View vSource); 00042 00043 private: 00044 /** 00045 * Blocked copy constructor. 00046 */ 00047 Event(const Event&); 00048 00049 00050 // ----- Object interface ----------------------------------------------- 00051 00052 public: 00053 /** 00054 * {@inheritDoc} 00055 */ 00056 virtual TypedHandle<const String> toString() const; 00057 00058 00059 // ----- accessors ------------------------------------------------------ 00060 00061 public: 00062 /** 00063 * Return the object on which the Event initially occurred. 00064 * 00065 * @return the object on which the Event initially occurred 00066 */ 00067 virtual Object::View getSource() const; 00068 00069 00070 // ----- data members --------------------------------------------------- 00071 00072 protected: 00073 /** 00074 * The object on which the Event initially occurred. 00075 */ 00076 FinalView<Object> f_vSource; 00077 }; 00078 00079 COH_CLOSE_NAMESPACE2 00080 00081 #endif // COH_EVENT_HPP