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_OBJECT_HPP 00008 #define COH_EVENT_OBJECT_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/util/Describable.hpp" 00013 00014 COH_OPEN_NAMESPACE2(coherence,util) 00015 00016 00017 /** 00018 * The root class from which all event state objects 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 upon. 00023 * 00024 * @author js 2008.06.04 00025 */ 00026 class COH_EXPORT EventObject 00027 : public class_spec<EventObject, 00028 extends<Describable> > 00029 { 00030 friend class factory<EventObject>; 00031 00032 // ----- constructors --------------------------------------------------- 00033 00034 protected: 00035 /** 00036 * Create a prototypical Event. 00037 * 00038 * @param hSource the object on which the Event initially occurred 00039 * 00040 * @throws IllegalArgumentException if source is NULL. 00041 */ 00042 EventObject(Object::Handle hSource); 00043 00044 00045 // ----- EventObject interface ------------------------------------------ 00046 00047 public: 00048 /** 00049 * The object on which the Event initially occurred. 00050 * 00051 * @return The object on which the Event initially occurred 00052 */ 00053 virtual Object::Handle getSource() const; 00054 00055 00056 // ----- Describable interface ------------------------------------------ 00057 00058 public: 00059 /** 00060 * {@inheritDoc} 00061 */ 00062 virtual String::View getDescription() const; 00063 00064 00065 // ----- data members --------------------------------------------------- 00066 00067 protected: 00068 /** 00069 * The object on which the Event initially occurred. 00070 */ 00071 mutable FinalHandle<Object> f_hoSource; 00072 }; 00073 00074 COH_CLOSE_NAMESPACE2 00075 00076 #endif // COH_EVENT_OBJECT_HPP 00077