ComEvent.java

/*
** Module   : ComEvent.java
** Abstract : An event generated by a COM object.
**
** Copyright (c) 2017-2019, Golden Code Development Corporation.
**
** -#- -I- --Date-- --------------------------------Description-----------------------------------
** 001 OM  20170530 First commit.
** 002 OM  20190225 Small change in constructor signature.
*/

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.comauto;

import com.goldencode.p2j.util.*;

/**
 * The COM event object is designed to identify the associated target procedure and pass it
 * the actual parameters form the COM object that originated the event.
 */
public class ComEvent
{
   /** The COM object that generated this event. */
   private final ComObject emitter;
   
   /** The name of the event. */
   private final String eventName;
   
   /** Actual parameters of the event. */
   private final BaseDataType[] params;
         
   /**
    * Create an event that was generated by a Java emulated ActiveX (JeA) object.
    * 
    * @param   emitter
    *          The JeA object that generated the event.
    * @param   eventName
    *          The event name.
    * @param   params
    *          Actual values for the (unnamed) parameters of the event.
    */
   public ComEvent(ComObject emitter, String eventName, BaseDataType... params)
   {
      this.emitter = emitter;
      this.eventName = eventName;
      this.params = params;
   }
   
   /**
    * Obtain the COM object that generated this event.
    * 
    * @return  COM object that generated this event.
    */
   public ComObject getEmitter()
   {
      return emitter;
   }
   
   /**
    * Obtain the name of the event.
    * 
    * @return  the name of the event.
    */
   public String getEventName()
   {
      return eventName;
   }
   
   /**
    * Obtain actual parameters of the event. 
    * 
    * @return  the actual parameters of the event
    */
   public BaseDataType[] getParameters()
   {
      return params;
   }
}