ParameterizedTypeSerializer.java

/*
** Module   : ParameterizedTypeSerializer.java
** Abstract : A serializer and parser for types which are parameterized (like Java collections).
**
** Copyright (c) 2022, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA  20220323 Created initial 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.rest.serializers;

import java.util.Collection;

/**
 * A parser and serializer for types which are parameterized (like Java {@link Collection}.
 * <p>
 * The parameters are optional, if not set, on serialization they will be assumed from the element's type
 * and on parse, they will be assumed from the JSON node's type.
 */
public abstract class ParameterizedTypeSerializer<T>
extends JavaTypeSerializer<T>
{
   /** The generic parameters for this type, as it appears at the method's parameter definition. */
   private JavaTypeSerializer[] parameters = null;

   /**
    * Create a new generic type.
    *  
    * @param    type
    *           A type which supports generics.
    */
   public ParameterizedTypeSerializer(Class<T> type)
   {
      super(type);
   }

   /**
    * Set the serializer for each generic parameters.
    * 
    * @param    parameters
    *           The serializer for each generic parameter.
    */
   public void setParameters(JavaTypeSerializer[] parameters)
   {
      this.parameters = parameters;
   }
   
   /**
    * Get the serializer for the generic parameter on the specified index.
    * 
    * @param    idx
    *           The index in the {@link #parameters}.
    *           
    * @return   The serializer, or <code>null</code> if the {@link #parameters} are not set or the index is
    *           outside of the array.
    */
   protected JavaTypeSerializer getSafeParameter(int idx)
   {
      if (parameters == null || idx < 0 || idx >= parameters.length)
      {
         return null;
      }
      
      return parameters[idx];
   }
}