net.roboconf.dm.templating.internal.templates

Class TemplateUtils

java.lang.Object

net.roboconf.dm.templating.internal.templates.TemplateUtils

public final class TemplateUtils
extends Object

Author:

Vincent Zurczak - Linagora

Method Summary

Modifier and Type	Method and Description
static void	deleteGeneratedFiles(net.roboconf.core.model.beans.Application app, File outputDirectory) Deletes the generated files for a given application.
static String	findApplicationName(File templateDir, File templateFile) Finds an application name from a template file.
static Collection<TemplateEntry>	findTemplatesForApplication(String appName, Collection<TemplateEntry> templates) Finds the templates that can apply to a given application.
static void	generate(net.roboconf.core.model.beans.Application app, File outputDirectory, Collection<TemplateEntry> templates, Logger logger) Generates files from templates for a given application.

Methods inherited from class java.lang.Object

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

Method Detail

findApplicationName

public static String findApplicationName(File templateDir,
                                         File templateFile)

Finds an application name from a template file.

Parameters:

templateDir - the templates root directory, the one being watched by the TemplateWatcher

templateFile - the template file

Returns:

name of the application targeted by the given template file, or null for a template global to all applications

Throws:

IllegalStateException - if the provided templateFile does not match

generate

public static void generate(net.roboconf.core.model.beans.Application app,
                            File outputDirectory,
                            Collection<TemplateEntry> templates,
                            Logger logger)
                     throws IOException

Generates files from templates for a given application.

All the generated files for a given application are located under outputDirectory/application-name. Even global templates are output there.

Parameters:

app - an application (not null)

outputDirectory - the output directory (not null)

templates - a non-null collection of templates

logger - a logger

Throws:

IOException - if something went wrong

deleteGeneratedFiles

public static void deleteGeneratedFiles(net.roboconf.core.model.beans.Application app,
                                        File outputDirectory)

Deletes the generated files for a given application.

Parameters:

app - an application (not null)

outputDirectory - the output directory (not null)

findTemplatesForApplication

public static Collection<TemplateEntry> findTemplatesForApplication(String appName,
                                                                    Collection<TemplateEntry> templates)

Finds the templates that can apply to a given application.

Parameters:

appName - an application name (can be null to match all)

templates - a non-null collection of templates

Returns:

a non-null collection of templates