SortedSet.java

/*
** Module   : SortedSet.java
** Abstract : Implementation of the Progress.Collections.SortedSet builtin class.
**
** Copyright (c) 2025, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 ICP 20250224 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.collections;

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

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

/**
 * Implementation of the Progress.Collections.SortedSet builtin class.
 */
@LegacyResource(resource = "Progress.Collections.SortedSet")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
@LegacySerializable
public final class SortedSet<T extends _BaseObject_>
extends BaseObject
implements Iset<T>,
           Icollection<T>,
           Iiterable
{
   @LegacySignature(type = Type.PROPERTY, name = "Count")
   private integer count = TypeFactory.integer();

   @LegacySignature(type = Type.PROPERTY, name = "First")
   private object<? extends com.goldencode.p2j.oo.lang._BaseObject_> first = TypeFactory.object(com.goldencode.p2j.oo.lang._BaseObject_.class);

   @LegacySignature(type = Type.PROPERTY, name = "IsEmpty")
   private logical isEmpty = TypeFactory.logical();

   @LegacySignature(type = Type.PROPERTY, name = "Last")
   private object<? extends com.goldencode.p2j.oo.lang._BaseObject_> last = TypeFactory.object(com.goldencode.p2j.oo.lang._BaseObject_.class);

   @LegacySignature(type = Type.CONSTRUCTOR, name = "SortedSet")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public void __collections_sortedSet_constructor__()
   {
      internalProcedure(SortedSet.class, this, "SortedSet", new Block((Body) () -> 
      {
         __lang_BaseObject_constructor__();
      }));
   }

   @LegacySignature(type = Type.CONSTRUCTOR, name = "SortedSet", parameters = 
   {
      @LegacyParameter(name = "comparer", type = "OBJECT", qualified = "progress.collections.icomparer", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public void __collections_sortedSet_constructor__(final object<? extends com.goldencode.p2j.oo.collections.Icomparer> _comparer)
   {
      object<? extends com.goldencode.p2j.oo.collections.Icomparer> comparer = TypeFactory.initInput(_comparer);
      
      internalProcedure(SortedSet.class, this, "SortedSet", new Block((Body) () -> 
      {
         __lang_BaseObject_constructor__();
      }));
   }

   @LegacySignature(type = Type.GETTER, name = "Count", returns = "INTEGER")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public integer getCount()
   {
      return count.duplicate();
   }

   @LegacySignature(type = Type.GETTER, name = "First", returns = "OBJECT", qualified = "progress.lang.object")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public object<? extends com.goldencode.p2j.oo.lang._BaseObject_> getFirst()
   {
      return function(SortedSet.class, this, "First", object.class, new Block((Body) () -> 
      {
         storeReturnValue(first);
      }));
   }

   @LegacySignature(type = Type.GETTER, name = "IsEmpty", returns = "LOGICAL")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public logical getIsEmpty()
   {
      return isEmpty.duplicate();
   }

   @LegacySignature(type = Type.GETTER, name = "Last", returns = "OBJECT", qualified = "progress.lang.object")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public object<? extends com.goldencode.p2j.oo.lang._BaseObject_> getLast()
   {
      return function(SortedSet.class, this, "Last", object.class, new Block((Body) () -> 
      {
         storeReturnValue(last);
      }));
   }

   @LegacySignature(type = Type.METHOD, name = "Add", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "element", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   @Override
   public logical add(final object<T> _element)
   {
      object<? extends com.goldencode.p2j.oo.lang._BaseObject_> element = TypeFactory.initInput(_element);
      
      return function(SortedSet.class, this, "Add", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "AddAll", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "otherCollections", type = "OBJECT", qualified = "progress.collections.icollection", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public logical addAll(final object<? extends com.goldencode.p2j.oo.collections.Icollection> _otherCollections)
   {
      object<? extends com.goldencode.p2j.oo.collections.Icollection> otherCollections = TypeFactory.initInput(_otherCollections);
      
      return function(SortedSet.class, this, "AddAll", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Clear")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public void clear_()
   {
      internalProcedure(SortedSet.class, this, "Clear", new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Contains", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "element", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public logical contains(final object<T> _element)
   {
      object<? extends com.goldencode.p2j.oo.lang._BaseObject_> element = TypeFactory.initInput(_element);
      
      return function(SortedSet.class, this, "Contains", logical.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Get", returns = "OBJECT", qualified = "progress.lang.object", parameters = 
   {
      @LegacyParameter(name = "element", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public object<? extends com.goldencode.p2j.oo.lang._BaseObject_> get(final object<? extends com.goldencode.p2j.oo.lang._BaseObject_> _element)
   {
      object<? extends com.goldencode.p2j.oo.lang._BaseObject_> element = TypeFactory.initInput(_element);
      
      return function(SortedSet.class, this, "Get", object.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "GetIterator", returns = "OBJECT", qualified = "progress.collections.iiterator")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public object<? extends com.goldencode.p2j.oo.collections.Iiterator> getIterator()
   {
      return function(SortedSet.class, this, "GetIterator", object.class, new Block());
   }

   @LegacySignature(type = Type.METHOD, name = "Remove", returns = "LOGICAL", parameters = 
   {
      @LegacyParameter(name = "element", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_STUB)
   public logical remove(final object<? extends com.goldencode.p2j.oo.lang._BaseObject_> _element)
   {
      object<? extends com.goldencode.p2j.oo.lang._BaseObject_> element = TypeFactory.initInput(_element);
      
      return function(SortedSet.class, this, "Remove", logical.class, new Block());
   }
}