bayou.html

Class HtmlComment

java.lang.Object

bayou.html.HtmlComment

All Implemented Interfaces:

HtmlPiece

public class HtmlComment
extends Object
implements HtmlPiece

Html comment.

For example, `new HtmlComment("main article")` will be rendered as "<!-- main article -->".

Escaping: consecutive dashes "--" are not allowed in html comments. We escape it by inserting a backslash. For example, `new HtmlComment("xx--yy\\zz")` will be rendered as "<!-- xx-\-yy\\zz -->". Note that the backslash is also escaped to "\\".

Constructor Summary

Constructors

Constructor and Description
HtmlComment(Object... content) Create an HtmlComment.

Method Summary

Instance Methods
List<CharSequence>	getContent() Get the content of this piece.
void	render(int indent, Consumer<CharSequence> out) Render this piece as an html comment "<!-- ... -->".

Methods inherited from class java.lang.Object

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

Methods inherited from interface bayou.html.HtmlPiece

isBlock, render

Constructor Detail

HtmlComment

public HtmlComment(Object... content)

Create an HtmlComment.

See getContent().

If an `obj` in `content` is not a CharSequence, it will be converted to one by `String.valueOf(obj)`. `obj` can be `null`.

Method Detail

getContent

public List<CharSequence> getContent()

Get the content of this piece.

The returned char sequences are from `content` passed to the constructor.

No escaping is done by this method. If you want an escaped result, use `render(0)`.

render

public void render(int indent,
                   Consumer<CharSequence> out)

Render this piece as an html comment "<!-- ... -->".

Escaping is done by this method.

Specified by:

render in interface HtmlPiece