org.neo4j.codegen.source.JavaSourceClassWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-codegen Show documentation
Simple library for generating code.
There is a newer version: 2025.02.0
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.codegen.source;

import java.lang.reflect.Modifier;
import java.util.List;
import org.neo4j.codegen.ClassWriter;
import org.neo4j.codegen.Expression;
import org.neo4j.codegen.FieldReference;
import org.neo4j.codegen.MethodDeclaration;
import org.neo4j.codegen.MethodWriter;
import org.neo4j.codegen.Parameter;
import org.neo4j.codegen.TypeReference;

/**
 * Writes java source classes.
 */
class JavaSourceClassWriter implements ClassWriter {
    private final StringBuilder target;
    final Configuration configuration;

    JavaSourceClassWriter(StringBuilder target, Configuration configuration) {
        this.target = target;
        this.configuration = configuration;
    }

    void declarePackage(TypeReference type) {
        append("package ").append(type.packageName()).append(";\n");
    }

    void declareImport(TypeReference type) {
        append("// TODO: We need to make sure compiled source files for extra classes are loadable at compile time.\n");
        append("//       But if you keep the generated source files and run again it should work.\n");
        append("import ")
                .append(type.packageName())
                .append(".")
                .append(type.name())
                .append(";\n");
    }

    void javadoc(String javadoc) {
        append("/** ").append(javadoc).append(" */\n");
    }

    void publicClass(TypeReference type) {
        append("public class ").append(type.name());
    }

    void extendClass(TypeReference base) {
        append(" extends ").append(base.fullName()).append("\n");
    }

    void implement(TypeReference[] interfaces) {
        String prefix = "    implements ";
        for (TypeReference iFace : interfaces) {
            append(prefix).append(iFace.fullName());
            prefix = ", ";
        }
        if (prefix.length() == 2) {
            append("\n");
        }
    }

    void begin() {
        append("{\n");
    }

    @Override
    public MethodWriter method(MethodDeclaration signature) {
        StringBuilder target = new StringBuilder();
        if (signature.isConstructor()) {
            if (signature.isStatic()) {
                target.append("    static\n    {\n");
                return new JavaSourceMethodWriter(target, this, signature.isStatic());
            } else {
                target.append("    ")
                        .append(Modifier.toString(signature.modifiers()))
                        .append(' ');
                typeParameters(target, signature);
                target.append(signature.declaringClass().name());
            }
        } else {
            target.append("    ")
                    .append(Modifier.toString(signature.modifiers()))
                    .append(' ');
            typeParameters(target, signature);
            target.append(signature.returnType().fullName()).append(' ').append(signature.name());
        }
        target.append('(');
        String prefix = " ";
        for (Parameter parameter : signature.parameters()) {
            target.append(prefix)
                    .append(parameter.type().fullName())
                    .append(' ')
                    .append(parameter.name());
            prefix = ", ";
        }
        if (prefix.length() > 1) {
            target.append(' ');
        }
        target.append(')');
        String sep = " throws ";
        for (TypeReference thrown : signature.throwsList()) {
            target.append(sep).append(thrown.fullName());
            sep = ", ";
        }
        target.append("\n    {\n");
        return new JavaSourceMethodWriter(target, this, signature.isStatic());
    }

    private static void typeParameters(StringBuilder target, MethodDeclaration method) {
        List parameters = method.typeParameters();
        if (!parameters.isEmpty()) {
            target.append('<');
            String sep = "";
            for (MethodDeclaration.TypeParameter parameter : parameters) {
                target.append(sep).append(parameter.name());
                TypeReference ext = parameter.extendsBound();
                TypeReference sup = parameter.superBound();
                if (ext != null) {
                    target.append(" extends ").append(ext.fullName());
                } else if (sup != null) {
                    target.append(" super ").append(sup.fullName());
                }
                sep = ", ";
            }
            target.append("> ");
        }
    }

    @Override
    public void done() {
        append("}\n");
    }

    @Override
    public void field(FieldReference field, Expression value) {
        String modifiers = Modifier.toString(field.modifiers());
        append("    ").append(modifiers);
        if (!modifiers.isEmpty()) {
            append(" ");
        }
        append(field.type().fullName()).append(' ').append(field.name());
        if (value != null) {
            append(" = ");
            value.accept(new JavaSourceMethodWriter(target, this, false));
        }
        append(";\n");
    }

    StringBuilder append(CharSequence chars) {
        return target.append(chars);
    }
}