Module io.helidon.pico.tools

Package io.helidon.pico.tools

Class TemplateHelper

java.lang.Object

io.helidon.pico.tools.TemplateHelper

public class TemplateHelper
extends Object

Helper tools for dealing with Pico-related Handlebar templates.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TEMPLATE_NAME	The default template name to use.
static final String	TAG_TEMPLATE_NAME	The tag that us used to represent the template name to use.

Method Summary

Modifier and Type	Method	Description
String	applySubstitutions(CharSequence target, Map<String,Object> props, boolean logErr)	Apply substitutions.
static TemplateHelper	create()	Creates a template helper utility using the global bootstrap configuration.
String	generatedStickerFor(String generatorClassTypeName)	Produces the generated sticker annotation attribute contents.
String	loadTemplate(String templateName, String name)	Same as safeLoadTemplate(String, String) but will return null if the template name is not found.
Set<String>	requiredArguments(String target)	Determine the arguments needed for template evaluation.

Methods inherited from class java.lang.Object

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

Field Details

TAG_TEMPLATE_NAME

public static final String TAG_TEMPLATE_NAME

The tag that us used to represent the template name to use.

See Also:

• Constant Field Values

DEFAULT_TEMPLATE_NAME

public static final String DEFAULT_TEMPLATE_NAME

The default template name to use.

See Also:

• Constant Field Values

Method Details

create

public static TemplateHelper create()

Creates a template helper utility using the global bootstrap configuration.

Returns:

the template helper initialized with the bootstrap configuration

generatedStickerFor

public String generatedStickerFor(String generatorClassTypeName)

Produces the generated sticker annotation attribute contents.

Parameters:

generatorClassTypeName - the generator class type name

Returns:

the generated sticker

applySubstitutions

public String applySubstitutions(CharSequence target,
 Map<String,Object> props,
 boolean logErr)

Apply substitutions.

Parameters:

target - the target string to find substitutions for

props - the replacements

logErr - flag indicating whether logger should be written for errors and warnings

Returns:

the new string, fully resolved with substitutions

requiredArguments

public Set<String> requiredArguments(String target)

Determine the arguments needed for template evaluation.

Parameters:

target - the target template

Returns:

the set of attributes that are required for substitution

loadTemplate

public String loadTemplate(String templateName,
 String name)

Same as safeLoadTemplate(String, String) but will return null if the template name is not found.

Parameters:

templateName - the template profile/directory

name - the template name to use

Returns:

the template, or null if not found