AppError.java
/*
** Module : AppError.java
** Abstract : Implementation of the Progress.Lang.AppError builtin class.
**
** Copyright (c) 2018-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 OM 20181218 First version.
** 002 CA 20190219 Runtime implementation.
** 003 CA 20190527 Added annotations for property accessors and class event methods.
** 004 CA 20190628 Track if this AppError instance is from a RETURN ERROR statement.
** 005 CA 20190720 Emit the 'this' reference for the BlockManager APIs.
** 006 CA 20191024 Added method support levels and updated the class support level.
** 007 CA 20200324 Error message access is 0-based, not 1-based.
** 20200330 Some refactoring to allow a generic way to build errors with messages.
** 008 ME 20200409 Add new static factory methods to create AppError.
** 009 CA 20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
** signature.
** 010 VVT 20220830 Missing Javadoc added; missing @Override annotations added.
** VVT 20221221 Serialization support added (see #4658).
** 011 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.*;
import java.io.*;
import com.goldencode.p2j.util.*;
import com.goldencode.p2j.util.InternalEntry.*;
/**
* Implementation of the Progress.Lang.AppError builtin class.
*/
@LegacyResource(resource = "Progress.Lang.AppError")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public class AppError
extends ProError
{
/** The return value. */
private character returnValue = new character("");
/** Flag indicating if this originates from a RETURN ERROR statement. */
private boolean fromReturn = false;
/**
* Create a new AppError instance and return it as a legacy object.
*
* @param retVal
* The return value.
* @return new object instance
*/
public static object<AppError> newInstance(character retVal)
{
return ObjectOps.newInstance(AppError.class, "I", retVal);
}
/**
* Create a new AppError instance and return it as a legacy object.
*
* @param msg
* The message.
* @param num
* The message number.
* @return new object instance
*/
public static object<AppError> newInstance(character msg, integer num)
{
return ObjectOps.newInstance(AppError.class, "II", msg, num);
}
/**
* Create a new AppError instance and return it as a legacy object.
*
* @param msg
* The message.
* @param num
* The message number.
* @return new object instance
*/
public static object<AppError> newInstance(String msg, int num)
{
return ObjectOps.newInstance(AppError.class, "II", new character(msg), new integer(num));
}
/**
* Implicit, no parameter, method associated with the implicit legacy constructor for the
* <code>Progress.Lang.AppError</code> class.
*/
@LegacySignature(type = Type.CONSTRUCTOR)
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void __lang_AppError_constructor__()
{
internalProcedure(this, "__lang_AppError_constructor__", new Block((Body) () ->
{
__lang_ProError_constructor__();
}));
}
/**
* Explicit method associated with a legacy constructor for the
* <code>Progress.Lang.AppError</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_AppError_constructor__(character _msg, integer _num)
{
character msg = TypeFactory.initInput(_msg);
integer num = TypeFactory.initInput(_num);
internalProcedure(this, "__lang_AppError_constructor__", new Block((Body) () ->
{
__lang_ProError_constructor__(msg, num);
}));
}
/**
* Explicit method associated with a legacy constructor for the
* <code>Progress.Lang.AppError</code> class.
*
* @param _retVal
* The return value.
*/
@LegacySignature(type = Type.CONSTRUCTOR, parameters =
{
@LegacyParameter(name = "retVal", type = "CHARACTER", mode = "INPUT"),
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void __lang_AppError_constructor__(character _retVal)
{
character retVal = TypeFactory.initInput(_retVal);
internalProcedure(this, "__lang_AppError_constructor__", new Block((Body) () ->
{
__lang_ProError_constructor__();
returnValue.assign(retVal);
}));
}
/**
* Get the state of the {@link #fromReturn} flag.
*
* @return See above.
*/
public boolean isFromReturn()
{
return fromReturn;
}
/**
* Set the state of the {@link #fromReturn} flag.
*
* @param state
* <code>true</code> if this error is raised via RETURN ERROR statement.
*/
public void setFromReturn(boolean state)
{
this.fromReturn = state;
}
/**
* Get the {@link #returnValue} property.
*
* @return See above.
*/
@LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "ReturnValue")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public character getReturnValue()
{
return new character(returnValue);
}
/**
* Set the {@link #returnValue} property.
*
* @param val
* The return value.
*/
@LegacySignature(type = Type.SETTER, name = "ReturnValue", parameters =
{
@LegacyParameter(name = "var", type = "CHARACTER", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void setReturnValue(character val)
{
returnValue.assign(val);
}
/**
* Implementation of the RemoveMessage legacy method.
*
* @param idx
* The message index to be removed.
*/
@LegacySignature(type = Type.METHOD, name = "RemoveMessage", parameters =
{
@LegacyParameter(name = "idx", type = "INTEGER", mode = "INPUT"),
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void removeMessage(integer idx)
{
if (validIndex(idx))
{
errors.remove(idx.intValue() - 1);
}
}
/**
* Implementation of the AddMessage legacy method.
*
* @param msg
* The error message.
* @param num
* The error message number.
*/
@Override
@LegacySignature(type = Type.METHOD, name = "AddMessage", 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 addMessage(character msg, integer num)
{
super.addMessage(msg, num);
}
/**
* The object implements the writeExternal method to save its contents
* by calling the methods of DataOutput for its primitive values or
* calling the writeObject method of ObjectOutput for objects, strings,
* and arrays.
*
* @serialData Overriding methods should use this tag to describe
* the data layout of this Externalizable object.
* List the sequence of element types and, if possible,
* relate the element to a public/protected field and/or
* method of this Externalizable class.
*
* @param out the stream to write the object to
* @exception IOException Includes any I/O exceptions that may occur
*/
@Override
public void writeExternal(final ObjectOutput out)
throws IOException
{
super.writeExternal(out);
out.writeObject(returnValue);
out.writeBoolean(fromReturn);
}
/**
* The object implements the readExternal method to restore its
* contents by calling the methods of DataInput for primitive
* types and readObject for objects, strings and arrays. The
* readExternal method must read the values in the same sequence
* and with the same types as were written by writeExternal.
*
* @param in the stream to read data from in order to restore the object
* @exception IOException if I/O errors occur
* @exception ClassNotFoundException If the class for an object being
* restored cannot be found.
*/
@Override
public void readExternal(final ObjectInput in)
throws IOException,
ClassNotFoundException
{
super.readExternal(in);
returnValue = (character) in.readObject();
fromReturn = in.readBoolean();
}
}