valueclasses.generator

Class Generator

java.lang.Object

valueclasses.generator.Generator

public class Generator
extends Object

Generate the Java code for the value classes.

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

Version:

24 sep. 2014

Author:

Peter Knoppers

Field Summary

Fields

Modifier and Type	Field and Description
static valueclasses.generator.Generator.MathFunctionEntry[]	mathFunctions The math functions

Constructor Summary

Constructors

Constructor and Description
Generator()

Method Summary

Methods

Modifier and Type	Method and Description
static String	buildField(String indent, String field, String description) Create a String that describes one field.
static String	buildMethod(String indent, String qualifiersTypeAndName, String description, String[] params, String exceptions, String pragma, String[] body, boolean constructor) Create a String that defines one method.
static void	closeFile(BufferedWriter writer) Close a file that was opened with openFile.
static 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.
static void	main(String[] args) Generate the code for the value classes.
static 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

Field Detail

mathFunctions

public static valueclasses.generator.Generator.MathFunctionEntry[] mathFunctions

The math functions

Constructor Detail

Generator

public Generator()

Method Detail

openFile

public static 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

generateInterface

public static 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

buildMethod

public static String buildMethod(String indent,
                 String qualifiersTypeAndName,
                 String description,
                 String[] params,
                 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 this method overrides a method in a parent class set this parameter to null.

description - String; description of the method

params - 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

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

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.

buildField

public static 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

main

public static void main(String[] args)

Generate the code for the value classes.

Parameters:

args - String[]; the command line arguments (not used)