UserGeneratedException.java

/*
** Module   : UserGeneratedException.java
** Abstract : An user-defined exception for reporting parsing issues.
**
** Copyright (c) 2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 OM  20240416 Extracted the class from CommonAstSupport to allow make it accessible for checking a
**                  failure in dynamic query conversion.
*/

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

import com.goldencode.ast.*;

/**
 * Indicates a P2J internal error was encountered during pattern engine processing.
 */
public class UserGeneratedException
extends RuntimeException
{
   /**
    * Constructor which accepts an error message.
    *
    * @param   message
    *          Error message.
    */
   public UserGeneratedException(String message)
   {
      super(message);
   }
   
   /**
    * Constructor which accepts an error message.
    *
    * @param   message
    *          Error message.
    * @param   ast
    *          AST at which failure occurred.
    */
   public UserGeneratedException(String message, Aast ast)
   {
      super(formatMessage(message, ast));
   }
   
   /**
    * Create a string which includes an arbitrary error message and a
    * brief, formatted descriptor of an AST (token type, line and column
    * number).
    *
    * @param   message
    *          Error message.
    * @param   ast
    *          AST at which failure occurred.
    */
   private static String formatMessage(String message, Aast ast)
   {
      StringBuilder buf = new StringBuilder(message);
      if (ast != null)
      {
         buf.append(" [");
         buf.append(ast.getSymbolicTokenType());
         buf.append(" id <");
         buf.append(ast.getId());
         buf.append("> ");
         buf.append(ast.getLine());
         buf.append(":");
         buf.append(ast.getColumn());
         buf.append("]");
      }
      else
      {
         buf.append(" [NULL] ast");
      }
      
      return buf.toString();
   }
}