com.vaadin.generator

Class ComponentGeneratorUtils

java.lang.Object

com.vaadin.generator.ComponentGeneratorUtils

public final class ComponentGeneratorUtils
extends Object

Utility methods for the code generation process.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
static org.jboss.forge.roaster.model.source.ParameterSource<org.jboss.forge.roaster.model.source.JavaClassSource>	addMethodParameter(org.jboss.forge.roaster.model.source.JavaClassSource javaClass, org.jboss.forge.roaster.model.source.MethodSource<org.jboss.forge.roaster.model.source.JavaClassSource> method, Class<?> type, String name) Adds a parameter with the specified type and name to the given method, considering simple name for java.lang package.
static String	convertCamelCaseToHyphens(String text) Converts a string in camel-case to a lower case string where each term is separated by an hyphen.
static String	convertFilePathToPackage(String path) Generates a package name based on a file path structure.
static File	convertPackageToDirectory(File basePath, String packageName, boolean createDirectories) Generates the directory structure based on a package name.
static String	formatStringToJavaComment(String input) Formats and ordinary String as a multi-line Java comment, that can be safely added to any part of a Java code.
static String	formatStringToValidJavaIdentifier(String name) Same as calling formatStringToValidJavaIdentifier(String, boolean) with false - not ignoring Java reserved words.
static String	formatStringToValidJavaIdentifier(String name, boolean ignoreReservedWords) Formats a given name (which can be a property name, function name or event name) to a valid Java identifier.
static String	generateElementApiGetterForType(ComponentBasicType basicType, String propertyName) Generates a code snippet that uses the Element API to retrieve properties from the client model.
static String	generateElementApiSetterForType(ComponentBasicType basicType, String propertyName, String parameterName, boolean nullable) Generates a code snippet that uses the Element API to set properties to the client model.
static String	generateElementApiValueGetterForType(ComponentBasicType basicType, String propertyName) Generates a code snippet that uses the Element API to retrieve properties from the client model when it implements the HasValue contract.
static String	generateMethodNameForProperty(String prefix, String propertyName) Formats property name to valid java identifier with CamelCase
static String	generateValidJavaClassName(String webcomponentClassName) Creates a valid Java class name based on the ES6 class name.
static Class<?>	toJavaType(ComponentBasicType type) Converts a javascript basic type to a Java type.

Methods inherited from class java.lang.Object

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

Method Detail

generateValidJavaClassName

public static String generateValidJavaClassName(String webcomponentClassName)

Creates a valid Java class name based on the ES6 class name.

Parameters:

webcomponentClassName - The ES6 class name.

Returns:

A valid Java class name.

generateMethodNameForProperty

public static String generateMethodNameForProperty(String prefix,
                                                   String propertyName)

Formats property name to valid java identifier with CamelCase

Parameters:

prefix - property prefix (e.g. set, get, is etc.), not null

propertyName - property name to convert

Returns:

property method name

formatStringToValidJavaIdentifier

public static String formatStringToValidJavaIdentifier(String name)

Same as calling formatStringToValidJavaIdentifier(String, boolean) with false - not ignoring Java reserved words.

Parameters:

name - The name of the property that would be exposed to Java code.

Returns:

A valid Java identifier based on the input name.

formatStringToValidJavaIdentifier

public static String formatStringToValidJavaIdentifier(String name,
                                                       boolean ignoreReservedWords)

Formats a given name (which can be a property name, function name or event name) to a valid Java identifier.

If the end result is a Java reserved word, and the flag ignoreReservedWords is false, the identifier is suffixed with the _ character.

Parameters:

name - The name of the property that would be exposed to Java code.

ignoreReservedWords - true to ignore Java reserved words, such as "if" and "for", false otherwise.

Returns:

A valid Java identifier based on the input name.

See Also:

Character.isJavaIdentifierStart(char), Character.isJavaIdentifierPart(char)

convertPackageToDirectory

public static File convertPackageToDirectory(File basePath,
                                             String packageName,
                                             boolean createDirectories)
                                      throws IOException

Generates the directory structure based on a package name.

Parameters:

basePath - The base path of the directory to be generated.

packageName - The name of the package to be converted to directories.

createDirectories - true to actually create the directories on the disk, false to just generate the File objects without creating them.

Returns:

a new File that represents the final directory of the package, with basePath as root.

Throws:

IOException - When createDirectories is true and the target directory cannot be created.

convertFilePathToPackage

public static String convertFilePathToPackage(String path)

Generates a package name based on a file path structure. The names are converted to lowercase, and each folder of the file path is converted to a package (split by ".").

Parameters:

path - The file path to be converted to a package name, such as "/components/vaadin-button/vaadin-button.html".

Returns:

A valid package name based on the input file path.

formatStringToJavaComment

public static String formatStringToJavaComment(String input)

Formats and ordinary String as a multi-line Java comment, that can be safely added to any part of a Java code.

Parameters:

input - The text to be converted as a comment. Should not be null.

Returns:

The text ready to be added as a comment in a Java file.

generateElementApiGetterForType

public static String generateElementApiGetterForType(ComponentBasicType basicType,
                                                     String propertyName)

Generates a code snippet that uses the Element API to retrieve properties from the client model.

Parameters:

basicType - The javascript basic type of the property.

propertyName - The name of the property in the javascript model.

Returns:

the code snippet ready to be added in a Java source code.

generateElementApiValueGetterForType

public static String generateElementApiValueGetterForType(ComponentBasicType basicType,
                                                          String propertyName)

Generates a code snippet that uses the Element API to retrieve properties from the client model when it implements the HasValue contract.

The getter checks whether the return value is null, and returns HasValue.getEmptyValue().

Parameters:

basicType - The javascript basic type of the property.

propertyName - The name of the property in the javascript model.

Returns:

the code snippet ready to be added in a Java source code.

generateElementApiSetterForType

public static String generateElementApiSetterForType(ComponentBasicType basicType,
                                                     String propertyName,
                                                     String parameterName,
                                                     boolean nullable)

Generates a code snippet that uses the Element API to set properties to the client model.

Parameters:

basicType - The javascript basic type of the property.

propertyName - The name of the property in the javascript model.

parameterName - The name of the parameter in the Java source code.

nullable - whether the value can be null or not

Returns:

the code snippet ready to be added in a Java source code.

toJavaType

public static Class<?> toJavaType(ComponentBasicType type)

Converts a javascript basic type to a Java type.

Parameters:

type - The javascript basic type.

Returns:

the corresponding Java type.

convertCamelCaseToHyphens

public static String convertCamelCaseToHyphens(String text)

Converts a string in camel-case to a lower case string where each term is separated by an hyphen.

For instance: hasValue would be converted to has-value.

Parameters:

text - the text to be converted

Returns:

the converted text

addMethodParameter

public static org.jboss.forge.roaster.model.source.ParameterSource<org.jboss.forge.roaster.model.source.JavaClassSource> addMethodParameter(org.jboss.forge.roaster.model.source.JavaClassSource javaClass,
                                                                                                                                            org.jboss.forge.roaster.model.source.MethodSource<org.jboss.forge.roaster.model.source.JavaClassSource> method,
                                                                                                                                            Class<?> type,
                                                                                                                                            String name)

Adds a parameter with the specified type and name to the given method, considering simple name for java.lang package.

Parameters:

javaClass - the java class

method - the method to add the parameter to

type - the parameter type

name - the parameter name

Returns:

the added parameter