SysError.java
/*
** Module : SysError.java
** Abstract : Implementation of the Progress.Lang.SysError builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 CA 20190201 First version.
** 002 CA 20190527 Added annotations for property accessors and class event methods.
** 003 CA 20191024 Added method support levels and updated the class support level.
** 004 CA 20200330 Added constructor to build a new error with message and number and APIs to
** create new instances.
** ME 20210111 Fix method signature for new instances static APIs.
** ME 20210204 Add API to create instances using 'build message' (prefix, dot).
** 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.lang;
import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.BlockManager.externalProcedure;
import static com.goldencode.p2j.util.BlockManager.internalProcedure;
import com.goldencode.p2j.util.*;
import com.goldencode.p2j.util.InternalEntry.Type;
/**
* Implementation of the Progress.Lang.SysError builtin class.
*/
@LegacyResource(resource = "Progress.Lang.SysError")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public class SysError
extends ProError
{
/**
* Implicit, no parameter, method associated with the implicit legacy constructor for the
* <code>Progress.Lang.SysError</code> class.
*/
@LegacySignature(type = Type.CONSTRUCTOR)
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_BASIC)
public void __lang_SysError_constructor__()
{
internalProcedure(this, "__lang_SysError_constructor__", new Block((Body) () ->
{
__lang_ProError_constructor__();
}));
}
/**
* Explicit method associated with a legacy constructor for the
* <code>Progress.Lang.SysError</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 __lang_SysError_constructor__(character _msg, integer _num)
{
character msg = TypeFactory.initInput(_msg);
integer num = TypeFactory.initInput(_num);
internalProcedure(this, "__lang_SysError_constructor__", new Block((Body) () ->
{
__lang_ProError_constructor__(msg, num);
}));
}
/**
* Create a new SysError instance and return it as a legacy object.
*
* @param msg
* The error message.
* @param num
* The error number.
*/
public static object<? extends SysError> newInstance(character msg, integer num)
{
return ObjectOps.newInstance(SysError.class, "II", msg, num);
}
/**
* Create a new SysError instance and return it as a legacy object.
*
* @param msg
* The error message.
* @param num
* The error number.
*/
public static object<? extends SysError> newInstance(String msg, int num)
{
return ObjectOps.newInstance(SysError.class, "II", msg, num);
}
/**
* Create a new SysError instance and return it as a legacy object.
*
* @param msg
* The error message.
* @param num
* The error number.
* @param prefix
* Prefix with two stars when building the error message.
* @param addDot
* The dot when building the error message.
*/
public static object<? extends SysError> newInstance(String msg, int num, boolean prefix, boolean addDot)
{
return ObjectOps.newInstance(SysError.class, "II", ErrorManager.buildErrorText(num, msg, prefix, addDot), num);
}
}