AssertString.java
/*
** Module : AssertString.java
** Abstract : Implementation of the OEUnit.Assertion.AssertString class.
**
** Copyright (c) 2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 VVT 20230307 Initial version
** 002 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.oeunit.assertion;
import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.BlockManager.*;
import static com.goldencode.p2j.util.CompareOps.*;
import static com.goldencode.p2j.util.TextOps.indexOf;
import static com.goldencode.p2j.util.logical.or;
import com.goldencode.p2j.oo.lang.*;
import com.goldencode.p2j.util.*;
import com.goldencode.p2j.util.InternalEntry.*;
/**
* Implementation of the OEUnit.Assertion.AssertString class.
*/
@LegacyResource(resource = "OEUnit.Assertion.AssertString")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public class AssertString
extends BaseObject
{
/**
* Static constructor
*/
@LegacySignature(type = Type.CONSTRUCTOR)
public static void __oeunit_assertion_AssertString_constructor__static__()
{
externalProcedure(AssertString.class, new Block((Body) () -> {
onRoutineLevel(Condition.ERROR, Action.THROW);
}));
}
/**
* Assert one string is part of another one.
*
* @param source
* the value to search in
* @param fragment
* the value to search for
*/
@LegacySignature(type = Type.METHOD, name = "Contains", parameters = {
@LegacyParameter(name = "source", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "fragment", type = "CHARACTER", mode = "INPUT") })
public static void contains(final character source, final character fragment)
{
containsImpl(source, fragment, new character());
}
/**
* Assert one string is part of another one.
*
* @param source
* the value to search in
* @param fragment
* the value to search for
* @param failMessage
* the failure message
*/
@LegacySignature(type = Type.METHOD, name = "Contains", parameters = {
@LegacyParameter(name = "source", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "fragment", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "failMessage", type = "CHARACTER", mode = "INPUT") })
public static void contains(final character source,
final character fragment,
final character failMessage)
{
containsImpl(source, fragment, failMessage);
}
/**
* Assert one string is part of another one.
*
* @param source
* the value to search in
* @param fragment
* the value to search for
*/
@LegacySignature(type = Type.METHOD, name = "Contains", parameters = {
@LegacyParameter(name = "source", type = "LONGCHAR", mode = "INPUT"),
@LegacyParameter(name = "fragment", type = "CHARACTER", mode = "INPUT") })
public static void contains(final longchar source, final character fragment)
{
containsImpl(source, fragment, new character());
}
/**
* Assert one string is part of another one.
*
* @param source
* the value to search in
* @param fragment
* the value to search for
* @param failMessage
* the failure message
*/
@LegacySignature(type = Type.METHOD, name = "Contains", parameters = {
@LegacyParameter(name = "source", type = "LONGCHAR", mode = "INPUT"),
@LegacyParameter(name = "fragment", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "failMessage", type = "CHARACTER", mode = "INPUT") })
public static void contains(final longchar source,
final character fragment,
final character failMessage)
{
containsImpl(source, fragment, failMessage);
}
/**
* Assert one string is <b>not</b> part of another one.
*
* @param source
* the value to search in
* @param fragment
* the value to search for
*/
@LegacySignature(type = Type.METHOD, name = "DoesNotContain", parameters = {
@LegacyParameter(name = "source", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "fragment", type = "CHARACTER", mode = "INPUT") })
public static void doesNotContain(final character source, final character fragment)
{
doesNotContainImpl(source, fragment, new character());
}
/**
* Assert one string is <b>not</b> part of another one.
*
* @param source
* the value to search in
* @param fragment
* the value to search for
* @param failMessage
* the failure message
*/
@LegacySignature(type = Type.METHOD, name = "DoesNotContain", parameters = {
@LegacyParameter(name = "source", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "fragment", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "failMessage", type = "CHARACTER", mode = "INPUT") })
public static void doesNotContain(final character source,
final character fragment,
final character failMessage)
{
doesNotContainImpl(source, fragment, failMessage);
}
/**
* Assert one string is <b>not</b> part of another one.
*
* @param source
* the value to search in
* @param fragment
* the value to search for
*/
@LegacySignature(type = Type.METHOD, name = "DoesNotContain", parameters = {
@LegacyParameter(name = "source", type = "LONGCHAR", mode = "INPUT"),
@LegacyParameter(name = "fragment", type = "CHARACTER", mode = "INPUT") })
public static void doesNotContain(final longchar source, final character fragment)
{
doesNotContainImpl(source, fragment, new character());
}
/**
* Assert one string is <b>not</b> part of another one.
*
* @param source
* the value to search in
* @param fragment
* the value to search for
* @param failMessage
* the failure message
*/
@LegacySignature(type = Type.METHOD, name = "DoesNotContain", parameters = {
@LegacyParameter(name = "source", type = "LONGCHAR", mode = "INPUT"),
@LegacyParameter(name = "fragment", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "failMessage", type = "CHARACTER", mode = "INPUT") })
public static void doesNotContain(final longchar source,
final character fragment,
final character failMessage)
{
doesNotContainImpl(source, fragment, failMessage);
}
/**
* Assert a string is neither unknown nor empty.
*
* @param value
* the value to search in
*/
@LegacySignature(type = Type.METHOD, name = "IsNotNullOrEmpty", parameters = {
@LegacyParameter(name = "value", type = "CHARACTER", mode = "INPUT") })
public static void isNotNullOrEmpty(final character value)
{
isNotNullOrEmptyImpl(value, new character());
}
/**
* Assert a string is neither unknown nor empty.
*
* @param value
* the value to search in
* @param failMessage
* the failure message
*/
@LegacySignature(type = Type.METHOD, name = "IsNotNullOrEmpty", parameters = {
@LegacyParameter(name = "value", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "failMessage", type = "CHARACTER", mode = "INPUT") })
public static void isNotNullOrEmpty(final character value, final character failMessage)
{
isNotNullOrEmptyImpl(value, failMessage);
}
/**
* Assert a string is neither unknown nor empty.
*
* @param value
* the value to search in
*/
@LegacySignature(type = Type.METHOD, name = "IsNotNullOrEmpty", parameters = {
@LegacyParameter(name = "value", type = "LONGCHAR", mode = "INPUT") })
public static void isNotNullOrEmpty(final longchar value)
{
isNotNullOrEmptyImpl(value, new character());
}
/**
* Assert a string is neither unknown nor empty.
*
* @param value
* the value to search in
* @param failMessage
* the failure message
*/
@LegacySignature(type = Type.METHOD, name = "IsNotNullOrEmpty", parameters = {
@LegacyParameter(name = "value", type = "LONGCHAR", mode = "INPUT"),
@LegacyParameter(name = "failMessage", type = "CHARACTER", mode = "INPUT") })
public static void isNotNullOrEmpty(final longchar value, final character failMessage)
{
isNotNullOrEmptyImpl(value, failMessage);
}
/**
* Assert a value is either unknown or an empty string.
*
* @param value
* the value to test
*/
@LegacySignature(type = Type.METHOD, name = "IsNullOrEmpty", parameters = {
@LegacyParameter(name = "value", type = "CHARACTER", mode = "INPUT") })
public static void isNullOrEmpty(final character value)
{
isNulOrEmptyImpl(value, new character());
}
/**
* Assert a value is either unknown or an empty string.
*
* @param value
* the value to test
* @param failMessage
* the failure message
*/
@LegacySignature(type = Type.METHOD, name = "IsNullOrEmpty", parameters = {
@LegacyParameter(name = "value", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "failMessage", type = "CHARACTER", mode = "INPUT") })
public static void isNullOrEmpty(final character value, final character failMessage)
{
isNulOrEmptyImpl(value, failMessage);
}
/**
* Assert a value is either unknown or an empty string.
*
* @param value
* the value to test
*/
@LegacySignature(type = Type.METHOD, name = "IsNullOrEmpty", parameters = {
@LegacyParameter(name = "value", type = "LONGCHAR", mode = "INPUT") })
public static void isNullOrEmpty(final longchar value)
{
isNulOrEmptyImpl(value, new character());
}
/**
* Assert a value is either unknown or an empty string.
*
* @param value
* the value to test
* @param failMessage
* the failure message
*/
@LegacySignature(type = Type.METHOD, name = "IsNullOrEmpty", parameters = {
@LegacyParameter(name = "value", type = "LONGCHAR", mode = "INPUT"),
@LegacyParameter(name = "failMessage", type = "CHARACTER", mode = "INPUT") })
public static void isNullOrEmpty(final longchar value, final character failMessage)
{
isNulOrEmptyImpl(value, failMessage);
}
/**
* Convenience method to execute Java code as a legacy method.
*
* @param clazz
* the legacy class the method belongs to
* @param legacyName
* legacy method name
* @param body
* method body to execute
*/
private final static void call(final Class<? extends _BaseObject_> clazz,
final String legacyName,
final Body body)
{
ObjectOps.load(clazz);
internalProcedure(clazz, legacyName, new Block(body));
}
/**
* Implementation helper for all test methods in this very class.
*
* @param legacyName
* the legacy name of the method
* @param body
* the method body
*/
private static void call(final String legacyName, final Body body)
{
call(AssertString.class, legacyName, body);
}
/**
* Assert one string is part of another one.
*
* @param source
* the value to search in
* @param fragment
* the value to search for
* @param failMessage
* the failure message
*/
private static void containsImpl(final Text source,
final Text fragment,
final character failMessage)
{
call("Contains", () -> {
Assert.isTrue(isGreaterThan(indexOf(source, fragment), 0), failMessage);
});
}
/**
* Assert one string is <b>not</b> part of another one.
*
* @param source
* the value to search in
* @param fragment
* the value to search for
* @param failMessage
* the failure message
*/
private static void doesNotContainImpl(final Text source,
final Text fragment,
final character failMessage)
{
call("DoesNotContain", () -> {
Assert.isFalse(isGreaterThan(indexOf(source, fragment), 0), failMessage);
});
}
/**
* Assert a string is neither unknown nor empty.
*
* @param value
* the value to search in
* @param failMessage
* the failure message
*/
private static void isNotNullOrEmptyImpl(final Text value, final character failMessage)
{
call("IsNotNullOrEmpty", () -> {
Assert.isNotNullImpl(value, failMessage);
Assert.areNotEqualImpl(value, new character(""), failMessage);
});
}
/**
* Assert a value is either unknown or an empty string.
*
* @param value
* the value to test
* @param failMessage
* the failure message
*/
private static void isNulOrEmptyImpl(final Text value, final character failMessage)
{
call("IsNullOrEmpty", () -> {
Assert.isTrue(or(isUnknown(value), () -> isEqual(value, "")), failMessage);
});
}
/**
* The constructor
*/
@LegacySignature(type = Type.CONSTRUCTOR)
public void __oeunit_assertion_assertString_constructor__()
{
internalProcedure(AssertString.class, this, "__oeunit_assertion_assertString_constructor__",
new Block((Body) () -> {
__lang_BaseObject_constructor__();
}));
}
/**
* The 'execute' procedure method
*/
@LegacySignature(type = Type.EXECUTE)
public void __oeunit_assertion_AssertString_execute__()
{
onRoutineLevel(Condition.ERROR, Action.THROW);
}
}