ByteOrder.java

/*
** Module   : ByteOrder.java
** Abstract : Implementation of the Progress.IO.ByteOrder builtin class.
**
** Copyright (c) 2025, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 ICP 20250307 First version.
*/

/*
** 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.io;

import com.goldencode.p2j.oo.lang.*;
import com.goldencode.p2j.util.*;

import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.InternalEntry.*;

/**
 * Implementation of the Progress.IO.ByteOrder builtin class.
 */
@LegacyResource(resource = "Progress.IO.ByteOrder")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
public final class ByteOrder
extends LegacyEnum
{
   @LegacySignature(type = Type.VARIABLE, name = "HostByteOrder")
   public static final object<? extends ByteOrder> hostByteOrder;

   @LegacySignature(type = Type.VARIABLE, name = "BigEndian")
   public static final object<? extends ByteOrder> bigEndian;

   @LegacySignature(type = Type.VARIABLE, name = "LittleEndian")
   public static final object<? extends ByteOrder> littleEndian;

   static
   {
      registerEnum(ByteOrder.class, ByteOrder::new, "Progress.IO.ByteOrder");
      
      hostByteOrder = createEnum(ByteOrder.class, "HostByteOrder", 1L);
      bigEndian = createEnum(ByteOrder.class, "BigEndian", 2L);
      littleEndian = createEnum(ByteOrder.class, "LittleEndian", 3L);
   }

   private ByteOrder(final String name, final Long value)
   {
      super(name, value);
   }

   @LegacySignature(type = Type.METHOD, name = "GetEnum", returns = "object", qualified = "progress.io.byteorder", parameters = 
   {
      @LegacyParameter(name = "val", type = "INT64", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public static object<ByteOrder> getEnum(int64 val)
   {
      return getEnum(ByteOrder.class, val);
   }

   @LegacySignature(type = Type.METHOD, name = "GetEnum", qualified = "progress.io.byteorder", parameters = 
   {
      @LegacyParameter(name = "val", type = "CHARACTER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public static object<ByteOrder> getEnum(character val)
   {
      return getEnum(ByteOrder.class, val);
   }
}