org.trimou.handlebars

Interface HelperDefinition

All Known Subinterfaces:

Options

public interface HelperDefinition

A helper definition metadata.

Since:

1.5

Author:

Martin Kouba

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HelperDefinition.ValuePlaceholder A value placeholder represents an expression which will be evaluated right before the helper execution.

Method Summary

Modifier and Type	Method and Description
String	getContentLiteralBlock() Note that the text is reconstructed and will not be an exact copy when "Set Delimiter" tags are used.
Map<String,Object>	getHash() The map may contain HelperDefinition.ValuePlaceholder instances during validation.
default Object	getParameter(int index, Object defaultValue)
List<Object>	getParameters() The list may contain HelperDefinition.ValuePlaceholder instances during validation.
MustacheTagInfo	getTagInfo()

Method Detail

getTagInfo

MustacheTagInfo getTagInfo()

Returns:

the info about the associated tag

getParameters

List<Object> getParameters()

The list may contain HelperDefinition.ValuePlaceholder instances during validation.

Returns:

an immutable list of parameters

getParameter

default Object getParameter(int index,
                            Object defaultValue)

Parameters:

index -

defaultValue -

Returns:

the parameter at the specified position or the default value if not found

Since:

2.2.1

getHash

Map<String,Object> getHash()

The map may contain HelperDefinition.ValuePlaceholder instances during validation.

Returns:

an immutable "hash" map

getContentLiteralBlock

String getContentLiteralBlock()

Note that the text is reconstructed and will not be an exact copy when "Set Delimiter" tags are used.

Returns:

the reconstructed literal block (original text before compilation) the helper contains, or an empty string for variable tag helpers

Since:

1.7

See Also:

Segment.getLiteralBlock()