SetSerializer.java

/*
** Module   : SetSerializer.java
** Abstract : A serializer and parser for java.util.Set instances.
**
** Copyright (c) 2022, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA  20220323 Created initial version.
**     TJD 20220504 Java 11 compatibility minor changes
*/
/*
** 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.*;

import com.fasterxml.jackson.databind.*;
import com.goldencode.p2j.rest.*;

/**
 * A parser and serializer for {@link Set} instances.
 */
public class SetSerializer
extends ParameterizedTypeSerializer<Set>
{
   /**
    * Create a new serializer for {@link Set} type.
    */
   public SetSerializer()
   {
      super(Set.class);
   }

   /**
    * Create an initial (default) instance for this serializer.
    * <p>
    * Can be null for non-mutable instances.
    * 
    * @param    definitionType
    *           The type as it appears at the parameter's definition.
    *           
    * @return   <code>null</code> for immutable types, a Java native value for native types or a new instance,
    *           for mutable types.
    * 
    * @throws   ReflectiveOperationException
    */
   @Override
   public Set initialize(Class<? extends Set> definitionType) 
   throws ReflectiveOperationException
   {
      return newInstance(definitionType, () -> new HashSet<>());
   }

   /**
    * Parse the string JSON representation and assign it to the given argument.  If null or not mutable, a 
    * new instance will be created.
    *  
    * @param    arg
    *           The argument (obtained via {@link #initialize}.
    * @param    sval
    *           The string JSON representation of this argument.
    *           
    * @return   The argument instance.
    * 
    * @throws   RequestArgumentError
    *           If the argument can't be parsed.
    */
   @Override
   public Set fromJson(Set arg, String sval) 
   throws RequestArgumentError
   {
      return (Set) readArray(getSafeParameter(0), sval, arg.getClass());
   }

   /**
    * Serialize the given instance to JSON.
    * 
    * @param    val
    *           The instance to serialize.
    *           
    * @return   The JSON representation of this instance.
    */
   @Override
   public JsonNode toJson(Set val)
   {
      return toJsonArray(val, getSafeParameter(0));
   }
}