org.trimou.engine.segment

Class TemplateSegment

java.lang.Object

org.trimou.engine.segment.TemplateSegment

All Implemented Interfaces:

Iterable<Segment>, ContainerSegment, Segment, Mustache

@Internal
public class TemplateSegment
extends Object
implements Mustache

Template segment (aka Mustache template).

Author:

Martin Kouba

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Segment>	segments

Constructor Summary

Constructors

Constructor and Description
TemplateSegment(String text, MustacheEngine engine)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSegment(Segment segment)
protected void	append(Appendable appendable, String text)
void	execute(Appendable appendable, ExecutionContext context) Execute this segment (e.g. write down some variable value).
protected String	getContainingLiteralBlock()
protected String	getDefaultEndDelimiter()
protected String	getDefaultStartDelimiter()
protected MustacheEngine	getEngine()
protected Configuration	getEngineConfiguration()
String	getLiteralBlock()
String	getName()
Origin	getOrigin()
protected String	getSegmentName()
List<Segment>	getSegments()
int	getSegmentsSize()
protected String	getTagLiteral(String content)
TemplateSegment	getTemplate()
String	getText()
SegmentType	getType()
protected void	checkModificationAllowed()
boolean	isReadOnly()
Iterator<Segment>	iterator()
void	performPostProcessing() Perform compilation post processing, e.g. optimization.
void	render(Appendable appendable, Map<String,Object> data) Render the template.
String	render(Map<String,Object> data) Render the template.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.trimou.engine.segment.Segment

getOrigin, getText

Field Detail

segments

protected List<Segment> segments

Constructor Detail

TemplateSegment

public TemplateSegment(String text,
               MustacheEngine engine)

Method Detail

render

public void render(Appendable appendable,
          Map<String,Object> data)

Description copied from interface: Mustache

Render the template. Watch out! Any appendable-specific operations (e.g. stream flushing and closing) are not performed automatically.

Specified by:

render in interface Mustache

Parameters:

appendable - The appendable to append the rendered template to

data - Optional context data (ideally immutable), may be null

render

public String render(Map<String,Object> data)

Description copied from interface: Mustache

Render the template.

Specified by:

render in interface Mustache

Parameters:

data - Optional context data (ideally immutable), may be null

Returns:

the rendered template as string

getType

public SegmentType getType()

Specified by:

getType in interface Segment

Returns:

the segment type

getLiteralBlock

public String getLiteralBlock()

Specified by:

getLiteralBlock in interface Segment

Returns:

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

See Also:

Lambda.InputType.LITERAL

getName

public String getName()

Specified by:

getName in interface Mustache

Returns:

the template name

performPostProcessing

public void performPostProcessing()

Description copied from interface: Segment

Perform compilation post processing, e.g. optimization.

Specified by:

performPostProcessing in interface Segment

isReadOnly

public boolean isReadOnly()

Returns:

true if read only, false otherwise

toString

public String toString()

getEngine

protected MustacheEngine getEngine()

execute

public void execute(Appendable appendable,
           ExecutionContext context)

Description copied from interface: Segment

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

Specified by:

execute in interface Segment

addSegment

public void addSegment(Segment segment)

Specified by:

addSegment in interface ContainerSegment

iterator

public Iterator<Segment> iterator()

Specified by:

iterator in interface Iterable<Segment>

getSegments

public List<Segment> getSegments()

Specified by:

getSegments in interface ContainerSegment

Returns:

the list of contained segments

getSegmentsSize

public int getSegmentsSize()

Specified by:

getSegmentsSize in interface ContainerSegment

Returns:

the number of contained segments

getContainingLiteralBlock

protected String getContainingLiteralBlock()

getSegmentName

protected String getSegmentName()

Returns:

the segment name

getText

public String getText()

Specified by:

getText in interface Segment

Returns:

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

getOrigin

public Origin getOrigin()

Specified by:

getOrigin in interface Segment

Returns:

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

getTemplate

public TemplateSegment getTemplate()

getEngineConfiguration

protected Configuration getEngineConfiguration()

getDefaultStartDelimiter

protected String getDefaultStartDelimiter()

getDefaultEndDelimiter

protected String getDefaultEndDelimiter()

getTagLiteral

protected String getTagLiteral(String content)

append

protected void append(Appendable appendable,
          String text)

checkModificationAllowed

protected void checkModificationAllowed()