org.trimou.engine.segment

Interface Segment

All Known Subinterfaces:

ContainerSegment

All Known Implementing Classes:

CommentSegment, ExtendSectionSegment, ExtendSegment, InvertedSectionSegment, LineSeparatorSegment, PartialSegment, RootSegment, SectionSegment, SetDelimitersSegment, TextSegment, ValueSegment

@Internal
public interface Segment

Compiled template segment. Any segment is considered thread-safe (most often immutable) once the compilation is finished.

Author:

Martin Kouba

Method Summary

Modifier and Type	Method and Description
Appendable	execute(Appendable appendable, ExecutionContext context) Execute this segment (e.g. write down some variable value).
String	getLiteralBlock() Note that the text is reconstructed and will not be an exact copy when "Set Delimiter" tags are used.
Origin	getOrigin()
MustacheTagInfo	getTagInfo()
String	getText()
SegmentType	getType()

Method Detail

getType

SegmentType getType()

Returns:

the segment type

getText

String getText()

Returns:

the segment text (a tag key, a line separator text, etc.)

getOrigin

Origin getOrigin()

Returns:

the origin of this segment or null in case of this segment is a template

getTagInfo

MustacheTagInfo getTagInfo()

Returns:

the info about the original tag or null if the segment does not represent a tag (e.g. SegmentType.TEXT)

getLiteralBlock

String getLiteralBlock()

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

Returns:

the reconstructed literal block this segment represents (original text before compilation)

See Also:

Lambda.InputType.LITERAL, HelperDefinition.getContentLiteralBlock()

execute

Appendable execute(Appendable appendable,
                   ExecutionContext context)

Execute this segment (e.g. write down some variable value).

Parameters:

appendable -

context -

Returns:

the appendable which should be used for the next executions