com.vaadin.generator

Class ComponentGenerator

java.lang.Object

com.vaadin.generator.ComponentGenerator

public class ComponentGenerator
extends Object

Base class of the component generation process. It takes a ComponentMetadata as input and generates the corresponding Java class that can interacts with the original webcomponent. The metadata can also be set as a JSON format.

Since:

1.0

See Also:

generateClass(ComponentMetadata, String, String), generateClass(File, File, String, String)

Constructor Summary

Constructors

Constructor and Description
ComponentGenerator()

Method Summary

Modifier and Type	Method and Description
void	build() Generate the class according to the set values.
void	generateClass(ComponentMetadata metadata, File targetPath, String basePackage, String licenseNote) Generates the Java class by using the ComponentMetadata object.
String	generateClass(ComponentMetadata metadata, String basePackage, String licenseNote) Generates and returns the Java class based on the ComponentMetadata.
void	generateClass(File jsonFile, File targetPath, String basePackage, String licenseNote) Generates the Java class by reading the webcomponent metadata from a JSON file.
String	generateClass(File jsonFile, String basePackage, String licenseNote) Generates and returns the Java class based on the JSON file provide.
protected ComponentMetadata	toMetadata(File jsonFile) Converts the JSON file to ComponentMetadata.
ComponentGenerator	withAbstractClass(boolean abstractClass) When set to true, the generated class will be marked as abstract.
ComponentGenerator	withBasePackage(String basePackage) Set the base package that will be used.
ComponentGenerator	withClassNamePrefix(String classNamePrefix) Set a prefix for the name of all generated classes.
ComponentGenerator	withFluentMethods(boolean fluentMethods) Set whether the generator should use fluent Methods - methods that return the own object so it's possible to use method chaining.
ComponentGenerator	withFrontendDirectory(String frontendDirectory) Set the import frontend base package.
ComponentGenerator	withJsonFile(File jsonFile) Set the input JSON file.
ComponentGenerator	withLicenseNote(String licenseNote) Set the license header notice for the file.
ComponentGenerator	withProtectedMethods(boolean protectedMethods) When set to true, all generated methods will be protected.
ComponentGenerator	withTargetPath(File targetPath) Set the target output directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentGenerator

public ComponentGenerator()

Method Detail

toMetadata

protected ComponentMetadata toMetadata(File jsonFile)

Converts the JSON file to ComponentMetadata.

Parameters:

jsonFile - The input JSON file.

Returns:

the converted ComponentMetadata.

Throws:

ComponentGenerationException - If an error occurs when reading the file.

withFluentMethods

public ComponentGenerator withFluentMethods(boolean fluentMethods)

Set whether the generator should use fluent Methods - methods that return the own object so it's possible to use method chaining.

Parameters:

fluentMethods - true to enable fluent setters, false to disable them.

Returns:

this

withJsonFile

public ComponentGenerator withJsonFile(File jsonFile)

Set the input JSON file.

Parameters:

jsonFile - The input JSON file.

Returns:

this

withTargetPath

public ComponentGenerator withTargetPath(File targetPath)

Set the target output directory.

Parameters:

targetPath - The output base directory for the generated Java file.

Returns:

this

withBasePackage

public ComponentGenerator withBasePackage(String basePackage)

Set the base package that will be used.

Parameters:

basePackage - The base package to be used for the generated Java class. The final package of the class is basePackage plus the ComponentMetadata.getBaseUrl().

Returns:

this

withLicenseNote

public ComponentGenerator withLicenseNote(String licenseNote)

Set the license header notice for the file.

Parameters:

licenseNote - A note to be added on top of the class as a comment. Usually used for license headers.

Returns:

this

withFrontendDirectory

public ComponentGenerator withFrontendDirectory(String frontendDirectory)

Set the import frontend base package. e.g. bower_components

Parameters:

frontendDirectory - frontend base package

Returns:

this

withProtectedMethods

public ComponentGenerator withProtectedMethods(boolean protectedMethods)

When set to true, all generated methods will be protected. Use this flag to create classes that will be extended afterwards. The default is false.

Parameters:

protectedMethods - true to make all methods protected, false to allow public methods in the generated code.

Returns:

this

withAbstractClass

public ComponentGenerator withAbstractClass(boolean abstractClass)

When set to true, the generated class will be marked as abstract.

Parameters:

abstractClass - true to make the generated class abstract, false to make it concrete.

Returns:

this

withClassNamePrefix

public ComponentGenerator withClassNamePrefix(String classNamePrefix)

Set a prefix for the name of all generated classes. e.g. "Generated"

Parameters:

classNamePrefix - the class name prefix

Returns:

this

build

public void build()

Generate the class according to the set values.

generateClass

public void generateClass(File jsonFile,
                          File targetPath,
                          String basePackage,
                          String licenseNote)

Generates the Java class by reading the webcomponent metadata from a JSON file.

Parameters:

jsonFile - The input JSON file.

targetPath - The output base directory for the generated Java file.

basePackage - The base package to be used for the generated Java class. The final package of the class is basePackage plus the ComponentMetadata.getBaseUrl().

licenseNote - A note to be added on top of the class as a comment. Usually used for license headers.

Throws:

ComponentGenerationException - If an error occurs when generating the class.

See Also:

toMetadata(File), generateClass(ComponentMetadata, File, String, String)

generateClass

public String generateClass(ComponentMetadata metadata,
                            String basePackage,
                            String licenseNote)

Generates and returns the Java class based on the ComponentMetadata. Doesn't write anything to the disk.

Parameters:

metadata - The webcomponent metadata.

basePackage - The base package to be used for the generated Java class. The final package of the class is basePackage plus the ComponentMetadata.getBaseUrl().

licenseNote - A note to be added on top of the class as a comment. Usually used for license headers.

Returns:

The generated Java class in String format.

Throws:

ComponentGenerationException - If an error occurs when generating the class.

generateClass

public String generateClass(File jsonFile,
                            String basePackage,
                            String licenseNote)

Generates and returns the Java class based on the JSON file provide. Doesn't write anything to the disk.

Parameters:

jsonFile - The webcomponent JSON metadata.

basePackage - The base package to be used for the generated Java class. The final package of the class is basePackage plus the ComponentMetadata.getBaseUrl().

licenseNote - A note to be added on top of the class as a comment. Usually used for license headers.

Returns:

The generated Java class in String format.

Throws:

ComponentGenerationException - If an error occurs when generating the class.

See Also:

generateClass(ComponentMetadata, String, String)

generateClass

public void generateClass(ComponentMetadata metadata,
                          File targetPath,
                          String basePackage,
                          String licenseNote)

Generates the Java class by using the ComponentMetadata object.

Parameters:

metadata - The webcomponent metadata.

targetPath - The output base directory for the generated Java file.

basePackage - The base package to be used for the generated Java class. The final package of the class is basePackage plus the ComponentMetadata.getBaseUrl().

licenseNote - A note to be added on top of the class as a comment. Usually used for license headers.

Throws:

ComponentGenerationException - If an error occurs when generating the class.