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

Constructor Summary

Constructors

Constructor and Description
SectionSegment(String text, Origin origin, List<Segment> segments)

Method Summary

Modifier and Type	Method and Description
protected Appendable	append(Appendable appendable, String text)
protected Appendable	appendText(Appendable appendable)
Appendable	execute(Appendable appendable, ExecutionContext context) Execute this segment (e.g. write down some variable value).
Appendable	fn(Appendable appendable, ExecutionContext context)
String	getContentLiteralBlock()
protected String	getDefaultEndDelimiter()
protected String	getDefaultStartDelimiter()
protected List<MustacheTagInfo>	getDirectChildTags()
protected MustacheEngine	getEngine()
protected Configuration	getEngineConfiguration()
String	getLiteralBlock() Note that the text is reconstructed and will not be an exact copy when "Set Delimiter" tags are used.
Origin	getOrigin()
protected String	getSegmentName()
List<Segment>	getSegments()
int	getSegmentsSize(boolean recursive)
MustacheTagInfo	getTagInfo()
protected String	getTagLiteral(String content)
protected MustacheTagType	getTagType()
protected Template	getTemplate()
String	getText()
SegmentType	getType()
protected boolean	isHandlebarsSupportEnabled()
Iterator<Segment>	iterator()
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, getTagInfo, getText

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SectionSegment

public SectionSegment(String text,
                      Origin origin,
                      List<Segment> segments)

Parameters:

text -

origin -

segments -

Method Detail

getType

public SegmentType getType()

Specified by:

getType in interface Segment

Returns:

the segment type

execute

public Appendable 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

Returns:

the appendable which should be used for the next executions

fn

public Appendable fn(Appendable appendable,
                     ExecutionContext context)

Returns:

the appendable which should be used for the next executions

See Also:

Options.fn(), Options.fn(Appendable)

getLiteralBlock

public String getLiteralBlock()

Description copied from interface: Segment

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

Specified by:

getLiteralBlock in interface Segment

Returns:

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

See Also:

Lambda.InputType.LITERAL, HelperDefinition.getContentLiteralBlock()

getContentLiteralBlock

public String getContentLiteralBlock()

Specified by:

getContentLiteralBlock in interface ContainerSegment

Returns:

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

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 immutable list of segments

getSegmentsSize

public int getSegmentsSize(boolean recursive)

Specified by:

getSegmentsSize in interface ContainerSegment

Returns:

the number of segments

getSegmentName

protected String getSegmentName()

Returns:

the segment name

getDirectChildTags

protected List<MustacheTagInfo> getDirectChildTags()

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

getTagInfo

public MustacheTagInfo getTagInfo()

Specified by:

getTagInfo in interface Segment

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

getTemplate

protected Template getTemplate()

getEngine

protected MustacheEngine getEngine()

getEngineConfiguration

protected Configuration getEngineConfiguration()

getDefaultStartDelimiter

protected String getDefaultStartDelimiter()

getDefaultEndDelimiter

protected String getDefaultEndDelimiter()

getTagLiteral

protected String getTagLiteral(String content)

isHandlebarsSupportEnabled

protected boolean isHandlebarsSupportEnabled()

append

protected Appendable append(Appendable appendable,
                            String text)

appendText

protected Appendable appendText(Appendable appendable)

getTagType

protected MustacheTagType getTagType()