DatabaseEventType.java

/*
** Module   : DatabaseEventType.java
** Abstract : Database trigger event type.
**
** Copyright (c) 2013-2021, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
** 001 SVL 20130213 Created initial version.
** 002 OM  20131128 Added Assign and replication constants.
** 003 ECF 20140801 Added mask.
** 004 OM  20210512 Overridden the toString() methods of replication triggers to match the event names from
**                  DMO interface annotations.
*/

/*
** 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.persist.trigger;

/**
 * Database trigger event type. Each value has a unique mask value <code>&gt;= 0x01 and &lt;=
 * 0x80</code>, which allows multiple event types to be represented in an integral bit field.
 */
public enum DatabaseEventType
{
   ASSIGN(0x01),
   CREATE(0x02),
   DELETE(0x04),
   FIND(0x08),
   WRITE(0x10),
   REPLICATION_CREATE(0x20) { @Override public String toString() { return "REPLICATION-CREATE"; } },
   REPLICATION_DELETE(0x40) { @Override public String toString() { return "REPLICATION-DELETE"; } },
   REPLICATION_WRITE(0x80)  { @Override public String toString() { return "REPLICATION-WRITE";  } };
   
   /** Unique mask associated with this event type */
   private final int mask;
   
   /**
    * Constructor to set event type mask.
    * 
    * @param   mask
    *          Unique mask associated with this event type.
    */
   private DatabaseEventType(int mask)
   {
      this.mask = mask;
   }
   
   /**
    * Get the unique mask associated with this event type. This is used by {@link TriggerTracker}
    * to maintain state in a compact and fast storage mechanism about which trigger types are
    * registered for a record buffer at a given block level.
    * 
    * @return  Mask value (<code>&gt;= 0x01 and &lt;= 0x80</code>).
    */
   public int getMask()
   {
      return mask;
   }
}