Package org.thymeleaf.engine

Class Comment

java.lang.Object

org.thymeleaf.engine.AbstractTemplateEvent

org.thymeleaf.engine.AbstractTextualTemplateEvent

org.thymeleaf.engine.Comment

All Implemented Interfaces:

CharSequence, IEngineTemplateEvent, IComment, ITemplateEvent

final class Comment
extends AbstractTextualTemplateEvent
implements IComment

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	COMMENT_PREFIX
private static final String	COMMENT_SUFFIX
private String	computedCommentStr
(package private) final String	prefix
(package private) final String	suffix

Fields inherited from class org.thymeleaf.engine.AbstractTemplateEvent

col, line, templateName

Constructor Summary

Constructors

Constructor	Description
Comment(CharSequence content)
Comment(CharSequence content, String templateName, int line, int col)
Comment(String prefix, CharSequence content, String suffix)
Comment(String prefix, CharSequence content, String suffix, String templateName, int line, int col)

Method Summary

Modifier and Type	Method	Description
void	accept(IModelVisitor visitor)	Accept a visitor, implementation of IModelVisitor.
(package private) static Comment	asEngineComment(IComment comment)
void	beHandled(ITemplateHandler handler)
char	charAt(int index)
String	getComment()	Returns the whole Comment, including the <!--...--> prefix and suffix.
String	getContent()	Returns the content of the Comment, without the prefix or suffix.
int	length()
CharSequence	subSequence(int start, int end)
String	toString()
void	write(Writer writer)	Writes this event to the specified Writer.

Methods inherited from class org.thymeleaf.engine.AbstractTextualTemplateEvent

charAtContent, contentSubSequence, getContentLength, getContentText, isInlineable, isWhitespace, writeContent

Methods inherited from class org.thymeleaf.engine.AbstractTemplateEvent

getCol, getLine, getTemplateName, hasLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Methods inherited from interface org.thymeleaf.model.ITemplateEvent

getCol, getLine, getTemplateName, hasLocation

Field Details

COMMENT_PREFIX

private static final String COMMENT_PREFIX

See Also:

• Constant Field Values

COMMENT_SUFFIX

private static final String COMMENT_SUFFIX

See Also:

• Constant Field Values

prefix

final String prefix

suffix

final String suffix

computedCommentStr

private volatile String computedCommentStr

Constructor Details

Comment

Comment(CharSequence content)

Comment

Comment(String prefix,
 CharSequence content,
 String suffix)

Comment

Comment(CharSequence content,
 String templateName,
 int line,
 int col)

Comment

Comment(String prefix,
 CharSequence content,
 String suffix,
 String templateName,
 int line,
 int col)

Method Details

getComment

public String getComment()

Description copied from interface: IComment

Returns the whole Comment, including the <!--...--> prefix and suffix.

Specified by:

getComment in interface IComment

Returns:

the Comment.

getContent

public String getContent()

Description copied from interface: IComment

Returns the content of the Comment, without the prefix or suffix.

Specified by:

getContent in interface IComment

Returns:

the content of the Comment.

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
 int end)

Specified by:

subSequence in interface CharSequence

accept

public void accept(IModelVisitor visitor)

Description copied from interface: ITemplateEvent

Accept a visitor, implementation of IModelVisitor.

Specified by:

accept in interface ITemplateEvent

Parameters:

visitor - the visitor.

write

public void write(Writer writer)
           throws IOException

Description copied from interface: ITemplateEvent

Writes this event to the specified Writer.

Template output performed at OutputTemplateHandler is done by calling these methods at each of the events resulting from template processing.

Specified by:

write in interface ITemplateEvent

Parameters:

writer - the writer this event should be written to.

Throws:

IOException - if an input/output exception occurs.

asEngineComment

static Comment asEngineComment(IComment comment)

beHandled

public void beHandled(ITemplateHandler handler)

Specified by:

beHandled in interface IEngineTemplateEvent

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class AbstractTextualTemplateEvent