JsonParserError.java
/*
** Module : JsonParserError.java
** Abstract : Implementation of the Progress.Json.JsonParserError builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 GES 20190307 First version.
** 002 CA 20190423 Added LegacyResource annotation.
** 003 CA 20190527 Added annotations for property accessors and class event methods.
** 004 GES 20191024 Added method support levels and updated the class support level.
** 005 ME 20210111 Added ctors and APIs to create new instance.
** 006 CA 20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
** signature.
** VVT 20210917 Javadoc fixed.
** 007 VVT 20221221 Serialization support added (see #4658).
** 008 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 static com.goldencode.p2j.util.BlockManager.*;
import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.InternalEntry.Type;
import java.io.*;
/**
* The replacement for the built-in Progress.Json.JsonParserError.
*/
@LegacyResource(resource = "Progress.Json.JsonParserError")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public class JsonParserError
extends JsonError
{
/** Offset flag. */
private integer offset = TypeFactory.integer();
/**
* 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_JsonParserError_constructor__()
{
internalProcedure(this, "__json_JsonParserError_constructor__", new Block((Body) () ->
{
__json_JsonError_constructor__();
}));
}
/**
* Explicit method associated with a legacy constructor for the
* <code>Progress.Json.JsonParserError</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_JsonParserError_constructor__(character msg, integer num)
{
internalProcedure(this, "__json_JsonError_constructor__", new Block((Body) () ->
{
__json_JsonError_constructor__(msg, num);
}));
}
/**
* Reads the offset property.
*
* @return The offset property.
*/
@LegacySignature(returns = "INTEGER", type = Type.GETTER, name = "Offset")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public integer getOffset()
{
return function(this, "Offset", integer.class, new Block((Body) () ->
{
returnNormal(offset);
}));
}
/**
* Sets the offset property.
*
* @param _var
* The new offset value.
*/
@LegacySignature(type = Type.SETTER, name = "Offset", parameters =
{
@LegacyParameter(name = "var", type = "INTEGER", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void setOffset(final integer _var)
{
integer var = TypeFactory.initInput(_var);
internalProcedure(this, "Offset", new Block((Body) () ->
{
offset.assign(var);
}));
}
/**
* Create a new JsonParserError instance and return it as a legacy object.
*
* @param msg
* The error message.
* @param num
* The error number.
*/
public static object<? extends JsonParserError> newInstance(character msg, integer num)
{
return ObjectOps.newInstance(JsonParserError.class, "II", msg, num);
}
/**
* Create a new JsonParserError instance and return it as a legacy object.
*
* @param msg
* The error message.
* @param num
* The error number.
*/
public static object<? extends JsonParserError> newInstance(String msg, int num)
{
return ObjectOps.newInstance(JsonParserError.class, "II", 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(ObjectOutput out)
throws IOException
{
super.writeExternal(out);
out.writeObject(offset);
}
/**
* 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);
offset = (integer) in.readObject();
}
}