CompileException.java

/*
** Module   : CompileException.java
** Abstract : Indicates an error was encountered during conversion
**
** Copyright (c) 2015-2017, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description---------------------------------
** 001 OM  20150617 Created initial version With basic support for id, message and AST that 
**                  caused the error.
*/
/*
** 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.convert;

import com.goldencode.ast.*;
import com.goldencode.p2j.*;

/**
 * Indicates an error was encountered during conversion. The exception is equivalent to a P4GL
 * compiler error. It has an id and a message to display to user.
 * 
 * TODO: In order to better emulate the P4GL compiler messages, this class keeps a reference to
 *       the AST that caused the error. It should be used to detect a few tokens that P4GL 
 *       displays in some cases in the message {@code "Unable to understand after -- ..."}
 */
public class CompileException
extends NumberedException
{
   /** The AST that caused the failure to occur. */
   private final Aast source;
   
   /** 
    * The only constructor initiate the internal state of the immutable object.
    * 
    * @param   id
    *          The error code of the error to be handled. 
    * @param   message
    *          The message that describes the error to be handled.
    * @param   source
    *          The location where the error occurred. Used for debugging or future improvement in
    *          message rendering (to match P4GL pattern).
    */
   public CompileException(int id, String message, Aast source)
   {
      super(message, id, true);
      this.source = source;
   }
}