# SerializationSupport.java

    /*
    ** Module   : SerializationSupport.java
    ** Abstract : Test descriptor serialization support
    **
    ** Copyright (c) 2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------Description---------------------------------
    ** 001 VVT 20230318 Created initial version.
    ** 002 VVT 20230428 Source formatting fixed.
    ** 003 VVT 20240108 Private methods serialization is now supported. See #8176.
    */
    /*
    ** 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.lang.reflect.*;
    import java.util.*;

    /**
     * Serialization support utilities
     *
     */
    public class SerializationSupport
    {
       /**
        * Read {@link Method} from binary input stream previously serialized with
        * {@link #writeMethod(Method,ObjectOutput)}.
        *
        * @param  in
        *         the input stream to read method from
        *
        * @return the method
        *
        * @throws IOException
        *         on IO error
        */
       public final static Method readMethod(final ObjectInput in)
       throws IOException
       {
          final Class<?> clazz;
          final String methodName;
          final Class[] parameterTypes;
          try
          {
             clazz = (Class<?>) in.readObject();
             methodName = (String) in.readObject();
             final int parameterCount = in.readInt();
             parameterTypes = new Class[parameterCount];
             for (int i = 0; i < parameterCount; i++)
             {
                parameterTypes[i] = (Class) in.readObject();
             }
          }
          catch (final ClassNotFoundException e)
          {
             throw new RuntimeException(e);
          }

          // First try declared methods, which allows to access private methods.
          try
          {
             return clazz.getDeclaredMethod(methodName, parameterTypes);
          }
          catch (@SuppressWarnings("unused") final NoSuchMethodException | SecurityException e)
          {
             // no-op
          }

          // If this failed, try all public methods including the inherited ones.
          try
          {
             return clazz.getMethod(methodName, parameterTypes);
          }
          catch (final NoSuchMethodException | SecurityException e)
          {
             throw new RuntimeException(e);
          }
       }

       /**
        * Read list of {@link Method} objects from binary input stream previously serialized with
        * {@link #writeMethods(List,ObjectOutput)}.
        *
        * @param  in
        *         the input stream to read method from
        *
        * @return the method list
        *
        * @throws IOException
        *         on IO error
        */
       public final static List<Method> readMethods(final ObjectInput in)
       throws IOException
       {
          final List<Method> result = new ArrayList<>();
          final int size = in.readInt();
          for (int i = 0; i < size; i++)
          {
             result.add(readMethod(in));
          }

          return result;
       }

       /**
        * Write {@link Method} to binary output stream.
        *
        * @param  method
        *         the method to write
        * @param  out
        *         the output stream to write methods to
        *
        * @throws IOException
        *         on IO error
        */
       public final static void writeMethod(final Method method, final ObjectOutput out)
       throws IOException
       {
          out.writeObject(method.getDeclaringClass());
          out.writeObject(method.getName());
          final Parameter[] parameters = method.getParameters();
          out.writeInt(parameters.length);
          for (final Parameter p : parameters)
          {
             out.writeObject(p.getType());
          }
       }

       /**
        * Write list of {@link Method} objects to binary output stream.
        *
        * @param  methods
        *         the method list to write
        * @param  out
        *         the output stream to write methods to
        *
        * @throws IOException
        *         on IO error
        */
       public final static void writeMethods(final List<Method> methods, final ObjectOutput out)
       throws IOException
       {
          out.writeInt(methods.size());
          for (final Method m : methods)
          {
             writeMethod(m, out);
          }
       }

    }