org.nuxeo.launcher.commons.text

Class TextTemplate

java.lang.Object

org.nuxeo.launcher.commons.text.TextTemplate

public class TextTemplate
extends Object

Text template processing.

Copy files or directories replacing parameters matching pattern '${[a-zA-Z_0-9\-\.]+}' with values from a Map (deprecated) or a Properties.

Method setTextParsingExtensions(String) allow to set list of files being processed when using processDirectory(File, File) or #pro, others are simply copied.

Author:

Bogdan Stefanescu

Constructor Summary

Constructors

Constructor and Description
TextTemplate()
TextTemplate(Map<String,String> vars) Deprecated. prefer use of TextTemplate(Properties)
TextTemplate(Properties vars)

Method Summary

Methods

Modifier and Type	Method and Description
String	getVariable(String name)
Properties	getVariables()
void	initFreeMarker()
boolean	isTrim()
Properties	preprocessVars(Properties unprocessedVars)
List<String>	processDirectory(File in, File out) Recursive call #process(InputStream, OutputStream, boolean) on each file from "in" directory to "out" directory.
void	processFreemarker(File in, File out)
String	processText(CharSequence text)
String	processText(InputStream in)
void	processText(InputStream is, OutputStream os)
void	setFreemarkerParsingExtensions(String extensionsList)
void	setTextParsingExtensions(String extensionsList)
void	setTrim(boolean trim) Set to true in order to trim invisible characters (spaces) from values.
void	setVariable(String name, String value)
void	setVariables(Map<String,String> vars) Deprecated. prefer use of getVariables() then Properties .load()

Methods inherited from class java.lang.Object

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

Constructor Detail

TextTemplate

public TextTemplate()

TextTemplate

@Deprecated
public TextTemplate(Map<String,String> vars)

Deprecated. prefer use of TextTemplate(Properties)

TextTemplate

public TextTemplate(Properties vars)

Parameters:

vars - Properties containing keys and values for template processing

Method Detail

isTrim

public boolean isTrim()

setTrim

public void setTrim(boolean trim)

Set to true in order to trim invisible characters (spaces) from values.

setVariables

@Deprecated
public void setVariables(Map<String,String> vars)

Deprecated. prefer use of getVariables() then Properties .load()

setVariable

public void setVariable(String name,
               String value)

getVariable

public String getVariable(String name)

getVariables

public Properties getVariables()

preprocessVars

public Properties preprocessVars(Properties unprocessedVars)

processText

public String processText(CharSequence text)

processText

public String processText(InputStream in)
                   throws IOException

Throws:

IOException

processText

public void processText(InputStream is,
               OutputStream os)
                 throws IOException

Throws:

IOException

initFreeMarker

public void initFreeMarker()

processFreemarker

public void processFreemarker(File in,
                     File out)
                       throws IOException,
                              freemarker.template.TemplateException

Throws:

IOException

freemarker.template.TemplateException

processDirectory

public List<String> processDirectory(File in,
                            File out)
                              throws FileNotFoundException,
                                     IOException,
                                     freemarker.template.TemplateException

Recursive call #process(InputStream, OutputStream, boolean) on each file from "in" directory to "out" directory.

Parameters:

in - Directory to read files from

out - Directory to write files to

Returns:

copied files list

Throws:

FileNotFoundException

IOException

freemarker.template.TemplateException

setTextParsingExtensions

public void setTextParsingExtensions(String extensionsList)

Parameters:

extensionsList - comma-separated list of files extensions to parse

setFreemarkerParsingExtensions

public void setFreemarkerParsingExtensions(String extensionsList)