org.trimou.engine.segment

Class SectionSegment

java.lang.Object

org.trimou.engine.segment.SectionSegment

All Implemented Interfaces:

Iterable<Segment>, ContainerSegment, Segment

@Internal
public class SectionSegment
extends Object

Section segment.

The content is not rendered if there is no object found in the context, or the found object is:

• a Boolean of value false,
• an Iterable with no elements,
• an empty array.

The content is rendered one or more times if there is an object found in the context. If the found object is:

• non-empty Iterable or array, the content is rendered for each element,
• a Boolean of value true, the content is rendered once,
• an instance of Lambda, the content is processed according to the lambda's specification,
• any other kind of object represents a nested context.

Author:

Martin Kouba

See Also:

Lambda, InvertedSectionSegment

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SectionSegment(String text, Origin origin)

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()
Origin	getOrigin()
protected String	getSegmentName()
List<Segment>	getSegments()
int	getSegmentsSize()
protected String	getTagLiteral(String content)
TemplateSegment	getTemplate()
String	getText()
SegmentType	getType()
protected void	checkModificationAllowed()
protected boolean	isReadOnly()
Iterator<Segment>	iterator()
void	performPostProcessing() Perform compilation post processing, e.g. optimization.
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

SectionSegment

public SectionSegment(String text,
              Origin origin)

Method Detail

getType

public SegmentType getType()

Returns:

the segment type

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

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

getContainingLiteralBlock

protected String getContainingLiteralBlock()

performPostProcessing

public void performPostProcessing()

Description copied from interface: Segment

Perform compilation post processing, e.g. optimization.

Specified by:

performPostProcessing 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

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

toString

public String toString()

Overrides:

toString in class Object

getTemplate

public TemplateSegment getTemplate()

isReadOnly

protected boolean isReadOnly()

getEngine

protected MustacheEngine getEngine()

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()