DirectAccessException.java

/*
** Module   : DirectAccessException.java
** Abstract : Exception related to the direct access of internal database structures technique.
**
** Copyright (c) 2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -----------------------------------Description-----------------------------------
** 001 AL2 20230210 Created initial version.
** 002 ES  20240626 Added expected flag and isExpected method to query this flag.
*/

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

/**
 * Exception used when anything goes wrong in the direct access attempts. This is used to
 * do recovery in case direct access doesn't work. As direct access attempts are read-only,
 * throwing such exception doesn't imply stale states. Therefore, ensure that a fallback 
 * plan is used if such exception occurs.
 */
public class DirectAccessException
extends Exception
{
   /** Flag indicating that exception was expected. */
   private boolean expected = false;
   
   /**
    * Basic constructor
    * 
    * @param   msg
    *          Exception message.
    */
   public DirectAccessException(String msg)
   {
      super(msg);
   }
   
   /**
    * Basic constructor
    * 
    * @param   msg
    *          Exception message.
    * @param   expected
    *          Flag indicating that exception was expected.
    */
   public DirectAccessException(String msg, boolean expected)
   {
      super(msg);
      this.expected = expected;
   }
   
   /**
    * Basic constructor
    * 
    * @param   msg
    *          Exception message.
    * @param   cause 
    *          Exception cause.
    */
   public DirectAccessException(String msg, Exception cause)
   {
      super(msg, cause);
   }

   /**
    * Queries the expected flag.
    *
    * @return   <code>true</code> if the exception is expected.
    */
   public boolean isExpected() 
   {
      return expected;
   }
}