AssertFile.java
/*
** Module : AssertFile.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2021-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 ME 20210908 First version, stubs taken by converting the skeleton using FWD.
** 002 VVT 20230318 The implementation added for all methods. See #3827.
** 003 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.util.*;
import com.goldencode.p2j.util.InternalEntry.Type;
/**
* Business logic (converted to Java from the 4GL source code
* in OpenEdge/Core/Assertion/AssertFile.cls).
*/
@LegacyResource(resource = "OpenEdge.Core.Assertion.AssertFile")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public class AssertFile
extends AbstractAssert
{
/**
* Static constructor
*/
@LegacySignature(type = Type.CONSTRUCTOR)
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void __core_assertion_AssertFile_constructor__static__()
{
externalProcedure(AssertFile.class, new Block((Body) () -> {
onBlockLevel(Condition.ERROR, Action.THROW);
}));
}
/**
* Asserts that a directory does not exist.
*
* @param name
* The name of the directory being checked
*/
@LegacySignature(type = Type.METHOD, name = "DirectoryDoesNotExist", parameters = {
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void directoryDoesNotExist(final character name)
{
Assert.notNullOrEmpty(name);
call("DirectoryDoesNotExist", () -> {
final String fileType = fileType(name);
if (fileType.startsWith("D"))
{
raiseError("Directory &1 must not exist", name);
}
});
}
/**
* Asserts that a directory exists.
*
* @param name
* The name of the directory being checked
*/
@LegacySignature(type = Type.METHOD, name = "DirectoryExists", parameters = {
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void directoryExists(final character name)
{
Assert.notNullOrEmpty(name);
call("DirectoryExists", () -> {
if (!fileType(name).startsWith("D"))
{
raiseError("Directory &1 must exist", name);
}
});
}
/**
* Asserts that a file does not exist.
*
* @param name
* The name of the file being checked
*/
@LegacySignature(type = Type.METHOD, name = "FileDoesNotExist", parameters = {
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void fileDoesNotExist(final character name)
{
Assert.notNullOrEmpty(name);
call("FileDoesNotExist", () -> {
final String fileType = fileType(name);
if (fileType.startsWith("F"))
{
raiseError("File &1 must not exist.", name);
}
});
}
/**
* Asserts that a file exists.
*
* @param name
* The name of the file being checked
*/
@LegacySignature(type = Type.METHOD, name = "FileExists", parameters = {
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void fileExists(final character name)
{
Assert.notNullOrEmpty(name);
call("FileExists", () -> {
final String fileType = fileType(name);
if (!fileType.startsWith("F"))
{
raiseError("File &1 must exist.", name);
}
});
}
/**
* Asserts that a file can be found in propath.
*
* @param name
* The name of the file being checked
*/
@LegacySignature(type = Type.METHOD, name = "FileInPropath", parameters = {
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void fileInPropath(final character name)
{
Assert.notNullOrEmpty(name);
call("FileInPropath", () -> {
if (FileSystemOps.searchPath(name).isUnknown())
{
raiseError("File &1 must exist in propath.", 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(AssertFile.class, legacyName, body);
}
/**
* Get file type string.
*
* @param name
*
* @return either file type string or an empty string if the file does not exist
*/
private final static String fileType(final character name)
{
FileSystemOps.initFileInfo(name);
final character type = FileSystemOps.fileInfoGetType();
return type.isUnknown() ? "" : type.toStringMessage();
}
/**
* The constructor
*/
@LegacySignature(type = Type.CONSTRUCTOR)
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public void __core_assertion_AssertFile_constructor__()
{
internalProcedure(AssertFile.class, this, "__core_assertion_AssertFile_constructor__",
new Block((Body) () -> {
__core_AbstractAssert_constructor__();
}));
}
/**
* Execute
*/
@LegacySignature(type = Type.EXECUTE)
public void __core_assertion_AssertFile_execute__()
{
onBlockLevel(Condition.ERROR, Action.THROW);
}
}