JsonError.java

/*
** Module   : JsonError.java
** Abstract : Implementation of the Progress.Json.JsonError builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 GES 20190227 First version.
** 002 CA  20190423 Added LegacyResource annotation.
** 003 GES 20191024 Added method support levels and updated the class support level.
** 004 ME  20210111 Added ctors and APIs to create new instance.
**     VVT 20210917 Javadoc fixed. 
** 005 CA  20231113 The 'execute' method must be annotated with LegacySignature Type.Execute, and also can be
**                  dropped if is a no-op.
*/

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

import com.goldencode.p2j.util.*;
import com.goldencode.p2j.oo.lang.*;

import static com.goldencode.p2j.util.BlockManager.*;
import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.InternalEntry.Type;

/**
 * Implementation of the Progress.Json.JsonError builtin class.
 */
@LegacyResource(resource = "Progress.Json.JsonError")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public class JsonError
extends SysError
{
   /**
    * Default method to duplicate the constructor.
    * <p>
    * The original 4GL version had a private access mode.
    * <p>
    * Some Progress builtin classes have all constructors with private access mode but are
    * subclassed.  Since child classes must be able to reference at least one "constructor"
    * directly, this should be impossible.  This must be some kind of special case hidden
    * inside the OO4GL implmentation.  In Java the method must be public.
    */
   @LegacySignature(type = Type.CONSTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __json_JsonError_constructor__()
   {
      internalProcedure(this, "__json_JsonError_constructor__", new Block((Body) () -> 
      {
         __lang_SysError_constructor__();
      }));
   }
   
   /**
    * Explicit method associated with a legacy constructor for the
    * <code>Progress.Json.JsonError</code> class.
    * 
    * @param    msg
    *           The message.
    * @param    num
    *           The message number.
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "msg",  type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "num",  type = "INTEGER", mode = "INPUT"),
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __json_JsonError_constructor__(character msg, integer num)
   {
      internalProcedure(this, "__json_JsonError_constructor__", new Block((Body) () -> 
      {
         // build the error message
         __lang_SysError_constructor__(new character(ErrorManager.buildErrorText((int) num.getValue(), msg.getValue(), false, false)), num);
      }));
   }
   
   /**
    * Create a new JsonError instance and return it as a legacy object. 
    * 
    * @param    msg
    *           The error message.
    * @param    num
    *           The error number.
    */
   public static object<? extends JsonError> newInstance(character msg, integer num)
   {
      return ObjectOps.newInstance(JsonError.class, "II", msg, num);
   }
   
   /**
    * Create a new JsonError instance and return it as a legacy object. 
    * 
    * @param    msg
    *           The error message.
    * @param    num
    *           The error number.
    */
   public static object<? extends JsonError> newInstance(String msg, int num)
   {
      return ObjectOps.newInstance(JsonError.class, "II", msg, num);
   }
   
}