org.bridje.srcgen

Interface SrcGenService

public interface SrcGenService

This interface defines the services for source code generation in the bridje modules.

Field Summary

Fields

Modifier and Type	Field and Description
static Path	CLASSES_PATH The virtual path for the generated classes in the source code generation process.
static Path	DATA_PATH The virtual path for the data in the source code generation process.
static Path	RESOURCE_PATH The virtual path for the generated resources in the source code generation process.
static Path	SOURCES_PATH The virtual path for the the java sources in the code generation process.
static Path	SUPL_PATH The virtual path for the suplementary data in the source code generation process.
static Path	TEMPLATES_PATH The virtual path for the templates in the source code generation process.

Method Summary

Modifier and Type	Method and Description
void	createClass(String clsFullName, String tplPath, Object data) Create a class with the given data and the given template.
void	createResource(String resourcePath, String tplPath, Object data) Creates a new resource with the given data and the given template.
<T> Map<T,VFile>	findData(Class<T> cls) Finds the data by the given class, this method will read the data from the default virtual path in the VFS tree and parse all the files that have the content of the given class.
com.github.javaparser.ast.CompilationUnit	findJavaClass(String name) Finds a java class by its full name and parsed it, from the sources folder.
List<com.github.javaparser.ast.CompilationUnit>	findJavaClasses(Predicate<com.github.javaparser.ast.CompilationUnit> predicate) Finds all classes by the given predicate.
<T> List<T>	findSuplData(Class<T> cls) Finds the supplementary data by the given class, this method will read the data from the default virtual path in the VFS tree and parse all the files that have the content of the given class.
com.github.javaparser.ast.CompilationUnit	parseJavaClass(VFile clsFile) Parses the java code from the given file.
<T> T	readFile(VFile file, Class<T> cls) Reads the given xml file.

Field Detail

DATA_PATH

static final Path DATA_PATH

The virtual path for the data in the source code generation process.

SUPL_PATH

static final Path SUPL_PATH

The virtual path for the suplementary data in the source code generation process.

RESOURCE_PATH

static final Path RESOURCE_PATH

The virtual path for the generated resources in the source code generation process.

SOURCES_PATH

static final Path SOURCES_PATH

The virtual path for the the java sources in the code generation process.

CLASSES_PATH

static final Path CLASSES_PATH

The virtual path for the generated classes in the source code generation process.

TEMPLATES_PATH

static final Path TEMPLATES_PATH

The virtual path for the templates in the source code generation process.

Method Detail

findJavaClass

com.github.javaparser.ast.CompilationUnit findJavaClass(String name)

Finds a java class by its full name and parsed it, from the sources folder.

Parameters:

name - The name of the java class.

Returns:

The compilation unit object with the sources of the given class if found or null if not.

findJavaClasses

List<com.github.javaparser.ast.CompilationUnit> findJavaClasses(Predicate<com.github.javaparser.ast.CompilationUnit> predicate)

Finds all classes by the given predicate.

Parameters:

predicate - The predicate to test the classes.

Returns:

The result list of classes.

parseJavaClass

com.github.javaparser.ast.CompilationUnit parseJavaClass(VFile clsFile)

Parses the java code from the given file.

Parameters:

clsFile - The file to parse.

Returns:

The compilation unit with the java code loaded.

findData

<T> Map<T,VFile> findData(Class<T> cls)
                   throws IOException

Finds the data by the given class, this method will read the data from the default virtual path in the VFS tree and parse all the files that have the content of the given class.

Type Parameters:

T - The type of the data to read.

Parameters:

cls - The class of the data to read.

Returns:

A map with the data read as the key and the corresponding VFile.

Throws:

IOException - If any IO exception occurs.

readFile

<T> T readFile(VFile file,
               Class<T> cls)
        throws IOException

Reads the given xml file.

Type Parameters:

T - The type of the data to read.

Parameters:

file - The file to read.

cls - The class of the data to read.

Returns:

The read object or null if the file is not that object.

Throws:

IOException - If any IO exception occurs.

findSuplData

<T> List<T> findSuplData(Class<T> cls)
                  throws IOException

Finds the supplementary data by the given class, this method will read the data from the default virtual path in the VFS tree and parse all the files that have the content of the given class.

Type Parameters:

T - The type of the data to read.

Parameters:

cls - The class of the data to read.

Returns:

A map with the data read as the key and the corresponding VFile.

Throws:

IOException - If any IO exception occurs.

createClass

void createClass(String clsFullName,
                 String tplPath,
                 Object data)
          throws IOException

Create a class with the given data and the given template.

Parameters:

clsFullName - The full name of the class to create.

tplPath - The path of the template to use to create the class.

data - The data to use by the template to create the class.

Throws:

IOException - If any IO exception occurs.

createResource

void createResource(String resourcePath,
                    String tplPath,
                    Object data)
             throws IOException

Creates a new resource with the given data and the given template.

Parameters:

resourcePath - The path and name of the resource file to create.

tplPath - The path of the template to use to create the class.

data - The data to use by the template to create the class.

Throws:

IOException - If any IO exception occurs.