abstract class AbstractJHtmlComment extends AbstractJComment implements JHtmlComment
CLOSE_PAREN_CONTENT, COMMA_CONTENT, DOC_ROOT_CONTENT, HASH_CONTENT, NL_CONTENT, OPEN_PAREN_CONTENT
Constructor and Description |
---|
AbstractJHtmlComment() |
Modifier and Type | Method and Description |
---|---|
protected <T extends HtmlCommentContent> |
add(T item) |
JHtmlComment |
block()
Add a comment sub-block at this location.
|
JHtmlComment |
br()
Add a line separator.
|
JHtmlComment |
docRoot()
Add the
{@docRoot} tag at this position. |
JHtmlTag |
htmlLink(java.lang.String url)
Add an HTML link (
<a> tag). |
JHtmlTag |
htmlTag(java.lang.String tag,
boolean newLine)
Add an HTML tag.
|
JHtmlComment |
inlineDocTag(java.lang.String tag,
java.lang.String body)
Add an inline doc tag with simple content.
|
JHtmlComment |
nl()
Add a newline.
|
JHtmlComment |
p()
Add a paragraph separator.
|
JComment |
preformattedCode()
Add an inline
@code tag within a {@code |
JHtmlComment |
sp()
Add a non-trailing space.
|
JHtmlComment |
text(java.lang.String text)
Add some text to the end of this comment.
|
JHtmlComment |
typeName(JType type)
Add a type name to the end of this comment.
|
JHtmlComment |
value(JType type,
java.lang.String fieldName)
Add a
@value inline tag. |
add, addItemDirectly, code, getContent, inlineDocTag, linkConstructor, linkField, linkMethod, linkMethod, linkType, write
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
code, inlineDocTag, linkConstructor, linkField, linkMethod, linkMethod, linkType
protected <T extends HtmlCommentContent> T add(T item)
public JHtmlComment block()
JComment
block
in interface JComment
block
in interface JHtmlComment
block
in class AbstractJComment
public JHtmlComment sp()
JComment
sp
in interface JComment
sp
in interface JHtmlComment
sp
in class AbstractJComment
public JHtmlComment nl()
JComment
nl
in interface JComment
nl
in interface JHtmlComment
nl
in class AbstractJComment
public JHtmlComment typeName(JType type)
JComment
typeName
in interface JComment
typeName
in interface JHtmlComment
typeName
in class AbstractJComment
type
- the type name to addpublic JHtmlComment text(java.lang.String text)
JComment
text
in interface JComment
text
in interface JHtmlComment
text
in class AbstractJComment
text
- the text to addpublic JHtmlComment inlineDocTag(java.lang.String tag, java.lang.String body)
JComment
inlineDocTag
in interface JComment
inlineDocTag
in interface JHtmlComment
inlineDocTag
in class AbstractJComment
tag
- the tag name (without the leading @
sign)body
- the complete tag bodypublic JHtmlComment docRoot()
JComment
{@docRoot}
tag at this position.docRoot
in interface JComment
docRoot
in interface JHtmlComment
docRoot
in class AbstractJComment
public JHtmlComment p()
JHtmlComment
p
in interface JHtmlComment
public JHtmlComment br()
JHtmlComment
br
in interface JHtmlComment
public JHtmlComment value(JType type, java.lang.String fieldName)
JHtmlComment
@value
inline tag.value
in interface JHtmlComment
type
- the value typefieldName
- the value field namepublic JHtmlTag htmlLink(java.lang.String url)
JHtmlComment
<a>
tag).htmlLink
in interface JHtmlComment
url
- the URL to link topublic JHtmlTag htmlTag(java.lang.String tag, boolean newLine)
JHtmlComment
htmlTag
in interface JHtmlComment
tag
- the HTML tagnewLine
- true
to add a newline after the opening tag and before the closing tagpublic JComment preformattedCode()
JHtmlComment
@code
tag within a <pre></pre>
block.preformattedCode
in interface JHtmlComment