code.generators

Class CodeGenerator

java.lang.Object

code.generators.CodeGenerator

public class CodeGenerator
extends Object

Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-26 01:01:13 +0200 (Sun, 26 Jul 2015) $, @version $Revision: 1155 $, by $Author: pknoppers $, initial version okt. 2014

Author:

Peter Knoppers

Constructor Summary

Constructors

Constructor and Description
CodeGenerator(String generatorName, String buildDir, String packageBaseName, String when, Long serialVersionUID) Create a new CodeGenerator.

Method Summary

Modifier and Type	Method and Description
static String[]	arrayListToArray(ArrayList<String> code) Convert an ArrayList<String> into an array of String.
String	buildBlockComment(String indent, String comment) Generate a block comment.
String	buildBrackets(int dimensions, String contents) Build a string with the specified number of [string] (square bracket with content) pairs.
String	buildEmptyBrackets(int dimensions) Build a string with the specified number of [] (square bracket) pairs.
String	buildField(String indent, String field, String description) Create a String that describes one field.
String	buildMethod(String indent, String qualifiersTypeAndName, String description, String[] parameters, String exceptions, String pragma, String[] body, boolean constructor) Create a String that defines one method.
String	buildSerialVersionUID(String indent) Return the String that defines the serialVersionUID.
static void	closeFile(BufferedWriter writer) Close a file that was opened with openFile.
void	generateAbstractClass(String relativePackage, String name, String[] imports, String description, String[] genericParams, String typeInfo, String contents) Write a class file for an abstract class.
void	generateClass(String relativePackage, String name, String[] imports, String description, String[] genericParams, String qualifiers, String typeInfo, boolean generateSerialVersionUID, String contents) Write a class file.
void	generateFinalClass(String relativePackage, String name, String[] imports, String description, String[] genericParams, String typeInfo, String contents) Write a class file for a final class that cannot be instantiated.
void	generateInterface(String relativePackage, String name, String[] imports, String description, String[] genericParams, String typeInfo, String body) Write an interface file that defines an interface that does nothing but define it's own name.
void	generatePackageInfo(String relativePackageName, String contents) Generate a package-info.java file.
String	indent(int steps) Create an indent of N units.
BufferedWriter	openFile(String relativePackage, String name, String[] imports, String description, String[] genericParams) Open a file and write the package line and initial block comment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CodeGenerator

public CodeGenerator(String generatorName,
                     String buildDir,
                     String packageBaseName,
                     String when,
                     Long serialVersionUID)

Create a new CodeGenerator.

Parameters:

generatorName - String; name of the program that uses this CodeGenerator

buildDir - String; path to directory for generated files and sub-directories

packageBaseName - String; prepended to all package names

when - String; textual description of the date that this CodeGenerator is used

serialVersionUID - String; serialVersionID to put in the generated class files

Method Detail

openFile

public final BufferedWriter openFile(String relativePackage,
                                     String name,
                                     String[] imports,
                                     String description,
                                     String[] genericParams)

Open a file and write the package line and initial block comment.

Parameters:

relativePackage - String; the last element(s) of the package name

name - String; the name of the class file to write

imports - String[]; the imports for the new class file

description - String; the description that is inserted in the block comment at the start of the file

genericParams - String[]; descriptions of the generic parameters of the class

Returns:

BufferedWriter; the open file

closeFile

public static void closeFile(BufferedWriter writer)

Close a file that was opened with openFile.

Parameters:

writer - BufferedWriter; the result of the preceding call to openFile

buildSerialVersionUID

public final String buildSerialVersionUID(String indent)

Return the String that defines the serialVersionUID.

Parameters:

indent - String; prepended to each output line

Returns:

String

generateClass

public final void generateClass(String relativePackage,
                                String name,
                                String[] imports,
                                String description,
                                String[] genericParams,
                                String qualifiers,
                                String typeInfo,
                                boolean generateSerialVersionUID,
                                String contents)

Write a class file.

Parameters:

relativePackage - String; the last element(s) of the package name

name - String; the name of the class file to write

imports - String[]; the imports for the new class file

description - String; the description that is inserted in the block comment at the start of the file

genericParams - String[]; the descriptions of the generic parameters of the class

qualifiers - String; qualifiers that go before the class key word; e.g. public abstract

typeInfo - String; the text that goes immediately after the class name

generateSerialVersionUID - boolean; if true a serialVersionUID is put in the result

contents - String; the text that goes in the class

generateAbstractClass

public final void generateAbstractClass(String relativePackage,
                                        String name,
                                        String[] imports,
                                        String description,
                                        String[] genericParams,
                                        String typeInfo,
                                        String contents)

Write a class file for an abstract class.

Parameters:

relativePackage - String; the last element(s) of the package name

name - String; the name of the class file to write

imports - String[]; the imports for the new class file

description - String; the description that is inserted in the block comment at the start of the file

genericParams - String[]; the descriptions of the generic parameters of the class

typeInfo - String; the text that goes immediately after the class name

contents - String; the text that goes in the class

generateFinalClass

public final void generateFinalClass(String relativePackage,
                                     String name,
                                     String[] imports,
                                     String description,
                                     String[] genericParams,
                                     String typeInfo,
                                     String contents)

Write a class file for a final class that cannot be instantiated.

Parameters:

relativePackage - String; the last element(s) of the package name

name - String; the name of the class file to write

imports - String[]; the imports for the new class file

description - String; the description that is inserted in the block comment at the start of the file

genericParams - String[]; the descriptions of the generic parameters of the class

typeInfo - String; the text that goes immediately after the class name

contents - String; the text that goes in the class

buildField

public final String buildField(String indent,
                               String field,
                               String description)

Create a String that describes one field.

Parameters:

indent - String; prepended to each output line

field - String; the type and name of the field

description - String; the description of the field

Returns:

String

buildBlockComment

public final String buildBlockComment(String indent,
                                      String comment)

Generate a block comment.

Parameters:

indent - String; prefix of all output lines

comment - String; the text to center in the block comment

Returns:

String; java code

indent

public final String indent(int steps)

Create an indent of N units.

Parameters:

steps - int; the number N

Returns:

String

buildMethod

public final String buildMethod(String indent,
                                String qualifiersTypeAndName,
                                String description,
                                String[] parameters,
                                String exceptions,
                                String pragma,
                                String[] body,
                                boolean constructor)

Create a String that defines one method.

Parameters:

indent - String; prefix for all output lines

qualifiersTypeAndName - String; the qualifiers, the type and the name of the method separated by vertical bars, e.g. final public|double|getDoubleValue. If the method that must be generated overrides a method in a parent class set this parameter to null.

description - String; description of the method

parameters - String[]; one String for each parameter of the method. Each parameter string consists of qualifiers, type, name separated by vertical bars, e.g. final int|index|index of the entry. Null entries in the parameters array are silently ignored.

exceptions - String; exception type and description separated by a vertical bar, or null if this method does not throw exceptions

pragma - String; text that goes after the JavaDoc, but before the start of the method code

body - String[]; the lines of the body of the method. Lines on the outermost level should start with 0 spaces. Null entries in the body array are silently ignored

constructor - boolean; if true; the new method is a constructor; if false; the new method is not a constructor

Returns:

String; the Java source code of the method.

generateInterface

public final void generateInterface(String relativePackage,
                                    String name,
                                    String[] imports,
                                    String description,
                                    String[] genericParams,
                                    String typeInfo,
                                    String body)

Write an interface file that defines an interface that does nothing but define it's own name.

Parameters:

relativePackage - String; the last element(s) of the package name

name - String; the name of the class file to write

imports - String[]; the imports for the new class file

description - String; the description that is inserted in the block comment at the start of the file

genericParams - String[]; the descriptions of the generic parameters of the class

typeInfo - String; the text that goes immediately after the class name

body - String; the body of the interface file

generatePackageInfo

public final void generatePackageInfo(String relativePackageName,
                                      String contents)

Generate a package-info.java file.

Parameters:

relativePackageName - String; relative package name

contents - String; contents of the package-info file

buildEmptyBrackets

public String buildEmptyBrackets(int dimensions)

Build a string with the specified number of [] (square bracket) pairs.

Parameters:

dimensions - int; the number of bracket pairs to concatenate

Returns:

String

buildBrackets

public String buildBrackets(int dimensions,
                            String contents)

Build a string with the specified number of [string] (square bracket with content) pairs.

Parameters:

dimensions - int; the number of bracket pairs with contents to concatenate

contents - String; the text that goes between each pair of brackets

Returns:

String

arrayListToArray

public static String[] arrayListToArray(ArrayList<String> code)

Convert an ArrayList<String> into an array of String.

Parameters:

code - ArrayList<String>; the lines to convert to an array of string

Returns:

String[]; array containing the strings from the ArrayList