# AbstractBranchTestDescriptor.java

    /*
    ** Module   : AbstractBranchTestDescriptor.java
    ** Abstract : Common accessor for non-terminal test descriptors
    **
    ** Copyright (c) 2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------Description---------------------------------
    ** 001 VVT 20230318 Created initial version.
    ** 002 VVT 20230512 Source formatting fixed. Missing Javadoc added.
    **                  Tags support added to FWD engine (FWD extension).
    */
    /*
    ** 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.testengine;

    import java.io.*;
    import java.util.*;

    import org.junit.platform.commons.util.*;
    import org.junit.platform.engine.*;

    /**
     * This class provides common functions for branch test descriptors
     */
    public abstract class AbstractBranchTestDescriptor
    extends AbstractFWDTestDescriptor
    {
       /** Child descriptors */
       private Set<TestDescriptor> children = Collections.synchronizedSet(new LinkedHashSet<>(16));

       /**
        * The constructor.
        *
        * @param uniqueId
        *        this descriptor unique ID
        * @param displayName
        *        this descriptor display name
        * @param tags
        *         the tag set
        */
       public AbstractBranchTestDescriptor(final UniqueId uniqueId,
                                           final String displayName,
                                           final Set<TestTag> tags)
       {
          super(uniqueId, displayName, tags);
       }

       /**
        * Add a <em>child</em> to this descriptor.
        *
        * @param descriptor the child to add to this descriptor; never {@code null}
        */
       @Override
       public void addChild(final TestDescriptor descriptor)
       {
          Preconditions.notNull(descriptor, "child must not be null");

          descriptor.setParent(this);
          children.add(descriptor);
       }

       /**
        * Find the descriptor with the supplied unique ID.
        * <p>
        * The search algorithm begins with this descriptor and then searches
        * through its descendants.
        *
        * @param uniqueId the {@code UniqueId} to search for; never {@code null}
        */
       @Override
       public Optional<? extends TestDescriptor> findByUniqueId(final UniqueId uniqueId)
       {
          if (getUniqueId().equals(uniqueId))
          {
             return Optional.of(this);
          }

          return children.stream().map(child -> child.findByUniqueId(uniqueId))
                   .filter(Optional::isPresent).findAny().orElse(Optional.empty());
       }

       /**
        * Get the immutable set of <em>children</em> of this descriptor.
        *
        * @return the set of children of this descriptor; neither {@code null}
        *         nor mutable, but potentially empty
        *
        * @see    #getDescendants()
        */
       @Override
       public final Set<? extends TestDescriptor> getChildren()
       {
          return Collections.unmodifiableSet(children);
       }

       /**
        * Determine the {@link org.junit.platform.engine.TestDescriptor.Type} of this descriptor.
        *
        * @return the descriptor type; never {@code null}.
        *
        * @see    #isContainer()
        * @see    #isTest()
        */
       @Override
       public Type getType()
       {
          return Type.CONTAINER;
       }

       /**
        * The object implements the readExternal method to restore its
        * contents by calling the methods of DataInput for primitive
        * types and readObject for objects, strings and arrays.  The
        * readExternal method must read the values in the same sequence
        * and with the same types as were written by writeExternal.
        *
        * @param     in the stream to read data from in order to restore the object
        *
        * @exception IOException if I/O errors occur
        * @exception ClassNotFoundException If the class for an object being
        *            restored cannot be found.
        */
       @Override
       public void readExternal(ObjectInput in)
       throws IOException,
              ClassNotFoundException
       {
          super.readExternal(in);

          children = (Set<TestDescriptor>) in.readObject();

          for(final TestDescriptor child : children)
          {
             child.setParent(this);
          }
       }

       /**
        * Remove a <em>child</em> from this descriptor.
        *
        * @param descriptor the child to remove from this descriptor; never
        *        {@code null}
        */
       @Override
       public void removeChild(final TestDescriptor descriptor)
       {
          Preconditions.notNull(descriptor, "child must not be null");

          children.remove(descriptor);
          descriptor.setParent(null);
       }

       /**
        * Remove this non-root descriptor from its parent and remove all the
        * children from this descriptor.
        * <p>
        * If this method is invoked on a {@linkplain #isRoot root} descriptor,
        * this method must throw a {@link org.junit.platform.commons.JUnitException JUnitException}
        * explaining that a root cannot be removed from the
        * hierarchy.
        */
       @Override
       public void removeFromHierarchy()
       {
          super.removeFromHierarchy();

          children.forEach(child -> child.setParent(null));
          children.clear();

       }
       /**
        * The object implements the writeExternal method to save its contents
        * by calling the methods of DataOutput for its primitive values or
        * calling the writeObject method of ObjectOutput for objects, strings,
        * and arrays.
        *
        * @serialData Overriding methods should use this tag to describe
        *             the data layout of this Externalizable object.
        *             List the sequence of element types and, if possible,
        *             relate the element to a public/protected field and/or
        *             method of this Externalizable class.
        *
        * @param      out the stream to write the object to
        *
        * @exception  IOException Includes any I/O exceptions that may occur
        */
       @Override
       public void writeExternal(ObjectOutput out)
       throws IOException
       {
          super.writeExternal(out);

          out.writeObject(children);
       }

    }