/*
    *    Copyright 2006-2026 the original author or authors.
    *
    *    Licensed under the Apache License, Version 2.0 (the "License");
    *    you may not use this file except in compliance with the License.
    *    You may obtain a copy of the License at
    *
    *       https://www.apache.org/licenses/LICENSE-2.0
    *
   *    Unless required by applicable law or agreed to in writing, software
   *    distributed under the License is distributed on an "AS IS" BASIS,
   *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   *    See the License for the specific language governing permissions and
   *    limitations under the License.
   */
  package org.mybatis.generator.plugins;
  
  import java.util.List;
  import java.util.Properties;
  
  import org.mybatis.generator.api.IntrospectedTable;
  import org.mybatis.generator.api.PluginAdapter;
  import org.mybatis.generator.api.dom.java.Field;
  import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
  import org.mybatis.generator.api.dom.java.JavaVisibility;
  import org.mybatis.generator.api.dom.java.TopLevelClass;
  import org.mybatis.generator.api.dom.kotlin.KotlinFile;
  import org.mybatis.generator.api.dom.kotlin.KotlinType;
  
  /**
   * This plugin adds the java.io.Serializable marker interface to all generated
   * model objects.
   *
   * <p>This plugin demonstrates adding capabilities to generated Java artifacts, and
   * shows the proper way to add imports to a compilation unit.
   *
   * <p>Important: This is a simplistic implementation of serializable and does not
   * attempt to do any versioning of classes.
   *
   * @author Jeff Butler
   */
  public class SerializablePlugin extends PluginAdapter {
  
      private final FullyQualifiedJavaType serializable;
      private final FullyQualifiedJavaType gwtSerializable;
      private boolean addGWTInterface;
      private boolean suppressJavaInterface;
  
      public SerializablePlugin() {
          super();
          serializable = new FullyQualifiedJavaType("java.io.Serializable"); //$NON-NLS-1$
          gwtSerializable = new FullyQualifiedJavaType("com.google.gwt.user.client.rpc.IsSerializable"); //$NON-NLS-1$
      }
  
      @Override
      public boolean validate(List<String> warnings) {
          // this plugin is always valid
          return true;
      }
  
      @Override
      public void setProperties(Properties properties) {
          super.setProperties(properties);
          addGWTInterface = Boolean.parseBoolean(properties.getProperty("addGWTInterface")); //$NON-NLS-1$
          suppressJavaInterface = Boolean.parseBoolean(properties.getProperty("suppressJavaInterface")); //$NON-NLS-1$
      }
  
      @Override
      public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass,
              IntrospectedTable introspectedTable) {
          return makeSerializable(topLevelClass, introspectedTable);
      }
  
      @Override
      public boolean modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass,
              IntrospectedTable introspectedTable) {
          return makeSerializable(topLevelClass, introspectedTable);
      }
  
      @Override
      public boolean modelRecordWithBLOBsClassGenerated(
              TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
          return makeSerializable(topLevelClass, introspectedTable);
      }
  
      protected boolean makeSerializable(TopLevelClass topLevelClass,
              IntrospectedTable introspectedTable) {
          if (addGWTInterface) {
              topLevelClass.addImportedType(gwtSerializable);
              topLevelClass.addSuperInterface(gwtSerializable);
          }
  
          if (!suppressJavaInterface) {
              topLevelClass.addImportedType(serializable);
              topLevelClass.addSuperInterface(serializable);
  
              Field field = new Field("serialVersionUID", //$NON-NLS-1$
                      new FullyQualifiedJavaType("long")); //$NON-NLS-1$
              field.setFinal(true);
             field.setInitializationString("1L"); //$NON-NLS-1$
             field.setStatic(true);
             field.setVisibility(JavaVisibility.PRIVATE);
 
             commentGenerator.addFieldAnnotation(field, introspectedTable, topLevelClass.getImportedTypes());
 
             topLevelClass.addField(field);
         }
 
         return true;
     }
 
     @Override
     public boolean kotlinDataClassGenerated(KotlinFile kotlinFile, KotlinType dataClass,
             IntrospectedTable introspectedTable) {
         kotlinFile.addImport("java.io.Serializable"); //$NON-NLS-1$
         dataClass.addSuperType("Serializable"); //$NON-NLS-1$
         return true;
     }
 }