How to use

writeComment

method

in

com.yahoo.aptutils.writer.JavaFileWriter

protected void emitGettersAndSetters() throws IOException {
  if (pluginEnv.hasSquidbOption(PluginEnvironment.OPTIONS_DISABLE_DEFAULT_GETTERS_AND_SETTERS)) {
    writer.writeComment("--- getters and setters disabled by plugin flag");
  } else {
    writer.writeComment("--- getters and setters");
    for (PropertyGenerator generator : modelSpec.getPropertyGenerators()) {
      generator.emitGetter(writer);
      generator.emitSetter(writer);
    }
  }
}

private void emitUnaliasedPropertyArray() throws IOException {
  writer.writeComment("--- unaliased property references");
  Expression basePropertiesInit = Expressions.block(new Expression() {
    @Override
    public boolean writeExpression(JavaFileWriter writer) throws IOException {
      return emitPropertyReferenceArrayBody(false);
    }
  }, false, false, false, false);
  writer.writeFieldDeclaration(TypeConstants.PROPERTY_ARRAY, BASE_PROPERTY_ARRAY_NAME,
      basePropertiesInit, TypeConstants.PRIVATE_STATIC_FINAL)
      .writeNewline();
}

private void emitPropertyDeclarations() throws IOException {
  writer.writeComment("--- property declarations");
  emitAllProperties();
  emitPropertyArrayInitialization();
  writer.writeNewline();
}

protected void emitPropertiesArray() throws IOException {
  writer.writeComment("--- allocate properties array");
  writer.writeFieldDeclaration(TypeConstants.PROPERTY_ARRAY, PROPERTIES_ARRAY_NAME,
      Expressions.arrayAllocation(TypeConstants.PROPERTY, 1, getPropertiesArrayLength()),
      TypeConstants.PUBLIC_STATIC_FINAL);
  writer.writeNewline();
}

@Override
public void afterEmitSchema(JavaFileWriter writer) throws IOException {
  writer.writeComment("--- constants");
  for (VariableElement constant : constantElements) {
    writeConstantField(writer, modelSpec.getModelSpecName(), constant);
  }
  for (Map.Entry<String, List<VariableElement>> innerClassConstant : innerClassConstants.entrySet()) {
    String classNameString = innerClassConstant.getKey();
    DeclaredTypeName constClassName = new DeclaredTypeName(null,
        modelSpec.getModelSpecName().getSimpleName() + "." + classNameString);
    for (VariableElement element : innerClassConstant.getValue()) {
      writeConstantField(writer, constClassName, element);
    }
  }
  writer.writeNewline();
}

@Override
public void beforeEmitClassDeclaration(JavaFileWriter writer) throws IOException {
  String generatedJavadoc = " This class was generated from the model spec at "
      + "{@link " + modelSpec.getModelSpecName() + "}";
  String elementJavadoc = utils.getElements().getDocComment(modelSpec.getModelSpecElement());
  if (!AptUtils.isEmpty(elementJavadoc)) {
    generatedJavadoc = (generatedJavadoc + "\n <br/>\n" + elementJavadoc);
  }
  writer.writeJavadoc(generatedJavadoc);
  writer.writeComment("Generated code -- do not modify!");
}

protected void emitDefaultValues() throws IOException {
  writer.writeComment("--- default values");
  writer.writeFieldDeclaration(TypeConstants.VALUES_STORAGE, DEFAULT_VALUES_NAME,
      Expressions.callMethodOn(
          Expressions.callConstructor(modelSpec.getGeneratedClassName()), "newValuesStorage"),
      Modifier.PROTECTED, Modifier.STATIC, Modifier.FINAL);
  if (pluginEnv.hasSquidbOption(PluginEnvironment.OPTIONS_DISABLE_DEFAULT_VALUES)) {
    writer.writeComment("--- property defaults disabled by plugin flag");
  } else {
    writer.beginInitializerBlock(true, true)
        .writeComment("--- put property defaults");
    emitDefaultValuesInitializationBlock();
    writer.finishInitializerBlock(false, true).writeNewline();
  }
  writer.writeAnnotation(CoreTypes.OVERRIDE)
      .beginMethodDefinition(GET_DEFAULT_VALUES_PARAMS)
      .writeStringStatement("return " + DEFAULT_VALUES_NAME)
      .finishMethodDefinition();
}

private void emitTableModelMapper() throws IOException {
  writer.writeComment("--- mappers");
  writer.writeFieldDeclaration(TypeConstants.TABLE_MAPPING_VISITORS, "tableMappingInfo",
      Expressions.callMethod("generateTableMappingVisitors",
          PROPERTIES_ARRAY_NAME, ALIASED_PROPERTY_ARRAY_NAME, BASE_PROPERTY_ARRAY_NAME),
      TypeConstants.PRIVATE_STATIC_FINAL)
      .writeNewline();
  writer.writeAnnotation(CoreTypes.OVERRIDE)
      .beginMethodDefinition(GET_TABLE_MAPPING_VISITORS)
      .writeStringStatement("return tableMappingInfo")
      .finishMethodDefinition();
}

  @Override
  public void afterEmitMethods(JavaFileWriter writer) throws IOException {
    // emit creator for parcelable
    writer.writeComment("--- parcelable helpers");
    List<DeclaredTypeName> genericList = Collections.singletonList(modelSpec.getGeneratedClassName());
    DeclaredTypeName creatorType = TypeConstants.CREATOR.clone();
    DeclaredTypeName modelCreatorType = TypeConstants.MODEL_CREATOR.clone();
    creatorType.setTypeArgs(genericList);
    modelCreatorType.setTypeArgs(genericList);

    writer.writeFieldDeclaration(creatorType,
        "CREATOR", Expressions.callConstructor(modelCreatorType,
            Expressions.classObject(modelSpec.getGeneratedClassName())),
        TypeConstants.PUBLIC_STATIC_FINAL)
        .writeNewline();
  }
}

private void emitTableDeclaration() throws IOException {
  writer.writeComment("--- table declaration");
  List<Object> arguments = new ArrayList<>();
  arguments.add(Expressions.classObject(modelSpec.getGeneratedClassName())); // modelClass
  arguments.add(PROPERTIES_ARRAY_NAME); // properties
  arguments.add("\"" + modelSpec.getSpecAnnotation().tableName().trim() + "\""); // name
  arguments.add(null); // database name, null by default
  if (modelSpec.isVirtualTable()) {
    if (AptUtils.isEmpty(modelSpec.getSpecAnnotation().virtualModule())) {
      modelSpec.logError("virtualModule should be non-empty for virtual table models",
          modelSpec.getModelSpecElement());
    }
    arguments.add("\"" + modelSpec.getSpecAnnotation().virtualModule() + "\"");
  } else if (!AptUtils.isEmpty(modelSpec.getSpecAnnotation().tableConstraint())) {
    arguments.add("\"" + modelSpec.getSpecAnnotation().tableConstraint() + "\"");
  }
  writer.writeFieldDeclaration(modelSpec.getTableType(), TABLE_NAME,
      Expressions.callConstructor(modelSpec.getTableType(), arguments), TypeConstants.PUBLIC_STATIC_FINAL);
  writer.writeFieldDeclaration(TypeConstants.TABLE_MODEL_NAME, TABLE_MODEL_NAME,
      Expressions.callConstructor(TypeConstants.TABLE_MODEL_NAME,
          Expressions.classObject(modelSpec.getGeneratedClassName()),
          Expressions.callMethodOn(TableModelFileWriter.TABLE_NAME, "getName")),
      TypeConstants.PUBLIC_STATIC_FINAL);
  writer.writeNewline();
}

private void emitSqlTableDeclaration(boolean view) throws IOException {
  writer.writeComment("--- " + (view ? "view" : "subquery") + " declaration");
  String name = "\"" + modelSpec.getSpecAnnotation().viewName().trim() + "\"";
  if (modelSpec.getQueryElement() != null) {
    Expression queryReference = Expressions.staticReference(modelSpec.getModelSpecName(),
        modelSpec.getQueryElement().getSimpleName().toString())
        .callMethod("selectMore", ALIASED_PROPERTY_ARRAY_NAME);
    if (modelSpec.getViewQueryAnnotation().freeze()) {
      queryReference = queryReference.callMethod("freeze");
    }
    writer.writeFieldDeclaration(TypeConstants.QUERY, QUERY_NAME, queryReference,
        TypeConstants.PUBLIC_STATIC_FINAL);
    Expression initializer = constructInitializer(name, view);
    writer.writeFieldDeclaration(view ? TypeConstants.VIEW : TypeConstants.SUBQUERY_TABLE,
        view ? VIEW_NAME : SUBQUERY_NAME, initializer, TypeConstants.PUBLIC_STATIC_FINAL);
  } else {
    writer.writeFieldDeclaration(CoreTypes.JAVA_STRING, view ? "VIEW_NAME" : "SUBQUERY_NAME",
        Expressions.fromString(name), TypeConstants.PUBLIC_STATIC_FINAL);
  }
  writer.writeNewline();
}

private void emitAliasedPropertyArray() throws IOException {
  writer.writeComment("--- aliased property references");
  Expression aliasedPropertiesInit = Expressions.block(new Expression() {
    @Override
    public boolean writeExpression(JavaFileWriter writer) throws IOException {
      return emitPropertyReferenceArrayBody(true);
    }
  }, false, false, false, false);
  writer.writeFieldDeclaration(TypeConstants.PROPERTY_ARRAY, ALIASED_PROPERTY_ARRAY_NAME,
      aliasedPropertiesInit, TypeConstants.PUBLIC_STATIC_FINAL)
      .writeNewline();
  writer.beginInitializerBlock(true, true);
  writer.writeStatement(Expressions.callMethod("validateAliasedProperties", ALIASED_PROPERTY_ARRAY_NAME));
  writer.finishInitializerBlock(false, true);
  writer.writeNewline();
}

@Override
public void emitAdditionalJava(JavaFileWriter writer) throws IOException {
  List<ErrorInfo> errors = modelSpec.getLoggedErrors();
  if (errors.size() > 0) {
    writer.writeExpression(new ModelGenErrorsExpression(errors))
        .writeNewline();
    TypeDeclarationParameters dummyErrorClass = new TypeDeclarationParameters()
        .setModifiers(Modifier.STATIC, Modifier.FINAL)
        .setName(new DeclaredTypeName(modelSpec.getGeneratedClassName().toString(), "LoggedErrors"))
        .setKind(JavaFileWriter.Type.CLASS);
    writer.beginTypeDefinition(dummyErrorClass);
    writer.writeComment("Dummy class for holding logged error annotations");
    writer.finishTypeDefinition();
  }
}

@Override
public void emitConstructors(JavaFileWriter writer) throws IOException {
  writer.writeComment("--- default constructors");
  MethodDeclarationParameters params = new MethodDeclarationParameters()
      .setModifiers(Modifier.PUBLIC)

protected void emitGettersAndSetters() throws IOException {
  if (pluginEnv.hasSquidbOption(PluginEnvironment.OPTIONS_DISABLE_DEFAULT_GETTERS_AND_SETTERS)) {
    writer.writeComment("--- getters and setters disabled by plugin flag");
  } else {
    writer.writeComment("--- getters and setters");
    for (PropertyGenerator generator : modelSpec.getPropertyGenerators()) {
      generator.emitGetter(writer);
      generator.emitSetter(writer);
    }
  }
}

private void emitUnaliasedPropertyArray() throws IOException {
  writer.writeComment("--- unaliased property references");
  Expression basePropertiesInit = Expressions.block(new Expression() {
    @Override
    public boolean writeExpression(JavaFileWriter writer) throws IOException {
      return emitPropertyReferenceArrayBody(false);
    }
  }, false, false, false, false);
  writer.writeFieldDeclaration(TypeConstants.PROPERTY_ARRAY, BASE_PROPERTY_ARRAY_NAME,
      basePropertiesInit, TypeConstants.PRIVATE_STATIC_FINAL)
      .writeNewline();
}

private void emitPropertyDeclarations() throws IOException {
  writer.writeComment("--- property declarations");
  emitAllProperties();
  emitPropertyArrayInitialization();
  writer.writeNewline();
}

protected void emitPropertiesArray() throws IOException {
  writer.writeComment("--- allocate properties array");
  writer.writeFieldDeclaration(TypeConstants.PROPERTY_ARRAY, PROPERTIES_ARRAY_NAME,
      Expressions.arrayAllocation(TypeConstants.PROPERTY, 1, getPropertiesArrayLength()),
      TypeConstants.PUBLIC_STATIC_FINAL);
  writer.writeNewline();
}

@Override
public void beforeEmitClassDeclaration(JavaFileWriter writer) throws IOException {
  String generatedJavadoc = " This class was generated from the model spec at "
      + "{@link " + modelSpec.getModelSpecName() + "}";
  String elementJavadoc = utils.getElements().getDocComment(modelSpec.getModelSpecElement());
  if (!AptUtils.isEmpty(elementJavadoc)) {
    generatedJavadoc = (generatedJavadoc + "\n <br/>\n" + elementJavadoc);
  }
  writer.writeJavadoc(generatedJavadoc);
  writer.writeComment("Generated code -- do not modify!");
}

private void emitTableModelMapper() throws IOException {
  writer.writeComment("--- mappers");
  writer.writeFieldDeclaration(TypeConstants.TABLE_MAPPING_VISITORS, "tableMappingInfo",
      Expressions.callMethod("generateTableMappingVisitors",
          PROPERTIES_ARRAY_NAME, ALIASED_PROPERTY_ARRAY_NAME, BASE_PROPERTY_ARRAY_NAME),
      TypeConstants.PRIVATE_STATIC_FINAL)
      .writeNewline();
  writer.writeAnnotation(CoreTypes.OVERRIDE)
      .beginMethodDefinition(GET_TABLE_MAPPING_VISITORS)
      .writeStringStatement("return tableMappingInfo")
      .finishMethodDefinition();
}