com.querydsl.codegen.GroovyBeanSerializer Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015, The Querydsl Team (http://www.querydsl.com/team)
 *
 * 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
 * http://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 com.querydsl.codegen;

import com.querydsl.codegen.utils.CodeWriter;
import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * {@code GroovyBeanSerializer} is a {@link Serializer} implementation which serializes {@link
 * EntityType} instances into Groovy classes
 *
 * @author tiwe
 */
public class GroovyBeanSerializer implements Serializer {

  private final boolean propertyAnnotations;

  private final String javadocSuffix;

  private boolean printSupertype = false;

  /** Create a new {@code GroovyBeanSerializer} instance */
  public GroovyBeanSerializer() {
    this(true, " is a Querydsl bean type");
  }

  /**
   * Create a new {@code GroovyBeanSerializer} instance
   *
   * @param javadocSuffix suffix to be used after the simple name in class level javadoc
   */
  public GroovyBeanSerializer(String javadocSuffix) {
    this(true, javadocSuffix);
  }

  /**
   * Create a new {@code GroovyBeanSerializer} instance
   *
   * @param propertyAnnotations true, to serialize property annotations
   */
  public GroovyBeanSerializer(boolean propertyAnnotations) {
    this(propertyAnnotations, " is a Querydsl bean type");
  }

  /**
   * Create a new {@code GroovyBeanSerializer} instance
   *
   * @param propertyAnnotations true, to serialize property annotations
   * @param javadocSuffix suffix to be used after the simple name in class level javadoc
   */
  public GroovyBeanSerializer(boolean propertyAnnotations, String javadocSuffix) {
    this.propertyAnnotations = propertyAnnotations;
    this.javadocSuffix = javadocSuffix;
  }

  @Override
  public void serialize(EntityType model, SerializerConfig serializerConfig, CodeWriter writer)
      throws IOException {
    var simpleName = model.getSimpleName();

    // package
    if (!model.getPackageName().isEmpty()) {
      writer.packageDecl(model.getPackageName());
    }

    // imports
    var importedClasses = getAnnotationTypes(model);
    if (model.hasLists()) {
      importedClasses.add(List.class.getName());
    }
    if (model.hasCollections()) {
      importedClasses.add(Collection.class.getName());
    }
    if (model.hasSets()) {
      importedClasses.add(Set.class.getName());
    }
    if (model.hasMaps()) {
      importedClasses.add(Map.class.getName());
    }
    writer.importClasses(importedClasses.toArray(new String[0]));

    // javadoc
    writer.javadoc(simpleName + javadocSuffix);

    // header
    for (Annotation annotation : model.getAnnotations()) {
      writer.annotation(annotation);
    }
    if (printSupertype && model.getSuperType() != null) {
      writer.beginClass(model, model.getSuperType().getType());
    } else {
      writer.beginClass(model);
    }

    bodyStart(model, writer);

    // fields
    for (Property property : model.getProperties()) {
      if (propertyAnnotations) {
        for (Annotation annotation : property.getAnnotations()) {
          writer.annotation(annotation);
        }
      }
      writer.field(property.getType(), property.getEscapedName());
    }

    bodyEnd(model, writer);

    writer.end();
  }

  protected void bodyStart(EntityType model, CodeWriter writer) throws IOException {
    // template method
  }

  protected void bodyEnd(EntityType model, CodeWriter writer) throws IOException {
    // template method
  }

  private Set getAnnotationTypes(EntityType model) {
    Set imports = new HashSet<>();
    for (Annotation annotation : model.getAnnotations()) {
      imports.add(annotation.annotationType().getName());
    }
    if (propertyAnnotations) {
      for (Property property : model.getProperties()) {
        for (Annotation annotation : property.getAnnotations()) {
          imports.add(annotation.annotationType().getName());
        }
      }
    }
    return imports;
  }

  public void setPrintSupertype(boolean printSupertype) {
    this.printSupertype = printSupertype;
  }
}