AssertObject.java
/*
** Module : AssertObject.java
** Abstract : Implementation of the OpenEdge.Core.Assertion.AssertObject
** builtin class.
**
** Copyright (c) 2020-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 ME 20200324 Created the first version, by converting the legacy skeleton .cls file and
** using that output.
** 002 ME 20201023 Added implementation for isType, notType.
** 20210908 Update equals method and error messages.
** 003 VVT 20230318 Full implementation added.
** 004 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.core.assertion;
import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.BlockManager.*;
import com.goldencode.p2j.oo.core.*;
import com.goldencode.p2j.oo.core.collections.*;
import com.goldencode.p2j.oo.lang.*;
import com.goldencode.p2j.util.*;
import com.goldencode.p2j.util.InternalEntry.*;
/**
* Business logic (converted to Java from the 4GL source code in
* OpenEdge/Core/Assertion/AssertObject.cls).
*/
@LegacyResource(resource = "OpenEdge.Core.Assertion.AssertObject")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_PARTIAL)
public class AssertObject
extends AbstractAssert
{
/**
* Static constructor
*/
@LegacySignature(type = Type.CONSTRUCTOR)
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void __core_assertion_AssertObject_constructor__static__()
{
externalProcedure(AssertObject.class, new Block((Body) () -> {
onBlockLevel(Condition.ERROR, Action.THROW);
}));
}
/**
* Check that the argument is neither unknown nor empty
*
* @param argument
* The argument to check
*/
@LegacySignature(type = Type.METHOD, name = "NotNullOrEmpty", parameters = {
@LegacyParameter(name = "argument", type = "OBJECT", qualified = "openedge.core.collections.icollection", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notNullOrEmptyCollection(final object<? extends Icollection> argument)
{
notNullUnknownOrEmptyImpl(argument, DEFAULT_ARGUMENT_NAME);
}
/**
* Check that the argument is neither unknown nor empty
*
* @param argument
* The argument to check
* @param name
* The name of the argument
*/
@LegacySignature(type = Type.METHOD, name = "NotNullOrEmpty", parameters = {
@LegacyParameter(name = "argument", type = "OBJECT", qualified = "openedge.core.collections.icollection", mode = "INPUT"),
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notNullOrEmptyCollection(final object<? extends Icollection> argument,
final character name)
{
notNullUnknownOrEmptyImpl(argument, name.toStringMessage());
}
/**
* Check that the argument is neither unknown nor empty
*
* @param argument
* The argument to check
*/
@LegacySignature(type = Type.METHOD, name = "NotNullOrEmpty", parameters = {
@LegacyParameter(name = "argument", qualified = "openedge.core.collections.imap", type = "OBJECT", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notNullOrEmptyMap(final object<? extends Imap> argument)
{
notNullUnknownOrEmptyImpl(argument, DEFAULT_ARGUMENT_NAME);
}
/**
* Check that the argument is neither unknown nor empty
*
* @param argument
* The argument to check
* @param name
* The name of the argument
*/
@LegacySignature(type = Type.METHOD, name = "NotNullOrEmpty", parameters = {
@LegacyParameter(name = "argument", type = "OBJECT", qualified = "openedge.core.collections.imap", mode = "INPUT"),
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notNullOrEmptyMap(final object<? extends Imap> argument,
final character name)
{
notNullUnknownOrEmptyImpl(argument, name.toStringMessage());
}
/**
* Check that the argument is neither unknown nor empty
*
* @param argument
* The argument to check
*/
@LegacySignature(type = Type.METHOD, name = "NotNullOrEmpty", parameters = {
@LegacyParameter(name = "argument", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notNullOrEmptyObject(final object<? extends _BaseObject_> argument)
{
notNullUnknownOrEmptyImpl(argument, DEFAULT_ARGUMENT_NAME);
}
/**
* Check that the argument is neither unknown nor empty
*
* @param argument
* The argument to check
* @param name
* The name of the argument
*/
@LegacySignature(type = Type.METHOD, name = "NotNullOrEmpty", parameters = {
@LegacyParameter(name = "argument", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT"),
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notNullOrEmptyObject(final object<? extends _BaseObject_> argument,
final character name)
{
notNullUnknownOrEmptyImpl(argument, name.toStringMessage());
}
/**
* Check that the argument is neither unknown nor empty
*
* @param argument
* The argument to check
*/
@LegacySignature(type = Type.METHOD, name = "NotNullOrEmpty", parameters = {
@LegacyParameter(name = "argument", type = "OBJECT", extent = -1, qualified = "progress.lang.object", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notNullOrEmptyObjectArray(final object<? extends _BaseObject_>[] argument)
{
notNullOrEmptyImpl(argument, DEFAULT_ARGUMENT_NAME);
}
/**
* Check that the argument is neither unknown nor empty
*
* @param argument
* The argument to check
* @param name
* The name of the argument
*/
@LegacySignature(type = Type.METHOD, name = "NotNullOrEmpty", parameters = {
@LegacyParameter(name = "argument", type = "OBJECT", extent = -1, qualified = "progress.lang.object", mode = "INPUT"),
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notNullOrEmptyObjectArray(final object<? extends _BaseObject_>[] argument,
final character name)
{
notNullOrEmptyImpl(argument, name.toStringMessage());
}
/**
* Check that the argument is not unknown
*
* @param argument
* The argument to check
*/
@LegacySignature(type = Type.METHOD, name = "NotUnknown", parameters = {
@LegacyParameter(name = "argument", qualified = "progress.lang.object", type = "OBJECT", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notUnknown(final object<? extends _BaseObject_> argument)
{
notUnknownImpl(argument, DEFAULT_ARGUMENT_NAME);
}
/**
* Check that the argument is not unknown
*
* @param argument
* The argument to check
* @param name
* The name of the argument
*/
@LegacySignature(type = Type.METHOD, name = "NotUnknown", parameters = {
@LegacyParameter(name = "argument", qualified = "progress.lang.object", type = "OBJECT", mode = "INPUT"),
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notUnknown(final object<? extends _BaseObject_> argument,
final character name)
{
notUnknownImpl(argument, name.toStringMessage());
}
/**
* Check that the argument is not unknown
*
* @param argument
* The argument to check
*/
@LegacySignature(type = Type.METHOD, name = "NotUnknown", parameters = {
@LegacyParameter(name = "argument", qualified = "progress.lang.object", type = "OBJECT", extent = -1, mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notUnknown(final object<? extends _BaseObject_>[] argument)
{
notUnknownImpl(argument, DEFAULT_ARGUMENT_NAME);
}
/**
* Check that the argument is not unknown
*
* @param argument
* The argument to check
* @param name
* The name of the argument
*/
@LegacySignature(type = Type.METHOD, name = "NotUnknown", parameters = {
@LegacyParameter(name = "argument", qualified = "progress.lang.object", type = "OBJECT", extent = -1, mode = "INPUT"),
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notUnknown(final object<? extends _BaseObject_>[] argument,
final character name)
{
notUnknownImpl(argument, name.toStringMessage());
}
/**
* Check that the argument is neither unknown nor empty
*
* @param argument
* The argument to check
* @param name
* The name of the argument
*/
@LegacySignature(type = Type.METHOD, name = "NotUnknownOrEmpty", parameters = {
@LegacyParameter(name = "argument", qualified = "progress.lang.object", type = "OBJECT", mode = "INPUT"),
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void notUnknownOrEmptyObject(final object<? extends _BaseObject_> argument,
final character name)
{
notNullUnknownOrEmptyImpl(argument, name.toStringMessage());
}
/**
* Check that the argument is neither unknown nor empty
*
* @param argument
* The argument to check
* @param name
* The name of the argument
*/
protected static void notNullOrEmptyImpl(final object<? extends _BaseObject_>[] argument,
final String name)
{
notNullImpl(argument, name);
call("NotNullOrEmpty", () -> {
if (argument.length == 0 || !argument[0].isValid().booleanValue())
{
raiseError("&1 cannot be empty: array must have at least one valid extent", name);
}
});
}
/**
* Implementation helper for all test methods.
*
* @param legacyName
* the legacy name of the method
* @param body
* the method body
*/
private static void call(final String legacyName, final Body body)
{
call(AssertObject.class, legacyName, body);
}
/**
* Constructor
*/
@LegacySignature(type = Type.CONSTRUCTOR)
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public void __core_assertion_AssertObject_constructor__()
{
internalProcedure(this, "__core_assertion_AssertObject_constructor__",
new Block((Body) () -> {
__core_AbstractAssert_constructor__();
}));
}
/**
* Execute
*/
@LegacySignature(type = Type.EXECUTE)
public void __core_assertion_AssertObject_execute__()
{
onBlockLevel(Condition.ERROR, Action.THROW);
}
}