io.wcm.qa.glnm.maven.freemarker.util

Class FreemarkerUtil

java.lang.Object

io.wcm.qa.glnm.maven.freemarker.util.FreemarkerUtil

public final class FreemarkerUtil
extends Object

Utility methods to build data models for use in freemarker code generation.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
static Map<String,Object>	getDataModelForInteractiveSelector(String packageRoot, String interfaceName, String className) getDataModelForInteractiveSelector.
static Map<String,Object>	getDataModelForSelector(NestedSelector selector, SpecPojo spec, String packageName, String interactiveClassName, String interactiveInterfaceName) getDataModelForSelector.
static Map<String,Object>	getDataModelForSpec(SpecPojo spec, String packagePrefixSpecs) getDataModelForSpec.
static Map<String,Object>	getDataModelForWebElement(NestedSelector selector, SpecPojo spec, String packageName, String interactiveClassName, String interactiveInterfaceName) getDataModelForWebElement.
static File	getOutputFile(File outputDir, String outputPackage, String outputClassName) getOutputFile.
static freemarker.template.Template	getTemplate(File directory, String name) getTemplate.
static void	process(freemarker.template.Template template, Map<String,Object> dataModel, File outputFile) Actually process template to generate code.

Methods inherited from class java.lang.Object

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

Method Detail

getDataModelForInteractiveSelector

public static Map<String,Object> getDataModelForInteractiveSelector(String packageRoot,
                                                                    String interfaceName,
                                                                    String className)

getDataModelForInteractiveSelector.

Parameters:

packageRoot - package for interactive selector interface

interfaceName - name of interactive selector interface to implement

className - of interactive selector class

Returns:

data model for generating interactive selector interface

getDataModelForSelector

public static Map<String,Object> getDataModelForSelector(NestedSelector selector,
                                                         SpecPojo spec,
                                                         String packageName,
                                                         String interactiveClassName,
                                                         String interactiveInterfaceName)

getDataModelForSelector.

Parameters:

selector - selector to build data model for

spec - selector is taken from

packageName - package of interactive selector interface

interactiveClassName - name of class

interactiveInterfaceName - name of interactive selector interface

Returns:

data model for use in generating selector class

getDataModelForSpec

public static Map<String,Object> getDataModelForSpec(SpecPojo spec,
                                                     String packagePrefixSpecs)

getDataModelForSpec.

Parameters:

spec - to generate Java class for

packagePrefixSpecs - root package

Returns:

data model for generating spec class

getDataModelForWebElement

public static Map<String,Object> getDataModelForWebElement(NestedSelector selector,
                                                           SpecPojo spec,
                                                           String packageName,
                                                           String interactiveClassName,
                                                           String interactiveInterfaceName)

getDataModelForWebElement.

Parameters:

selector - selector to build data model for

spec - selector is taken from

packageName - package of interactive selector interface

interactiveClassName - name of interactive selector implementation

interactiveInterfaceName - name of interactive selector interface

Returns:

data model for use in generating selector class

getOutputFile

public static File getOutputFile(File outputDir,
                                 String outputPackage,
                                 String outputClassName)

getOutputFile.

Parameters:

outputDir - directory

outputPackage - package

outputClassName - class name

Returns:

file to write generated code to

getTemplate

public static freemarker.template.Template getTemplate(File directory,
                                                       String name)

getTemplate.

Parameters:

directory - template root folder

name - name of template

Returns:

freemarker template

process

public static void process(freemarker.template.Template template,
                           Map<String,Object> dataModel,
                           File outputFile)

Actually process template to generate code.

Parameters:

template - to process

dataModel - to use

outputFile - to write to