Package org.jboss.jdeparser
Class AbstractJHtmlComment
java.lang.Object
org.jboss.jdeparser.AbstractJComment
org.jboss.jdeparser.AbstractJHtmlComment
- All Implemented Interfaces:
JComment
,JHtmlComment
,Writable
- Direct Known Subclasses:
AbstractJDocComment
,DocTagJHtmlComment
,ImplJHtmlTag
,NestedHtmlCommentContent
-
Field Summary
Fields inherited from class org.jboss.jdeparser.AbstractJComment
CLOSE_PAREN_CONTENT, COMMA_CONTENT, DOC_ROOT_CONTENT, HASH_CONTENT, NL_CONTENT, OPEN_PAREN_CONTENT
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected <T extends HtmlCommentContent>
Tadd
(T item) block()
Add a comment sub-block at this location.br()
Add a line separator.docRoot()
Add the{@docRoot}
tag at this position.Add an HTML link (<a>
tag).Add an HTML tag.inlineDocTag
(String tag, String body) Add an inline doc tag with simple content.nl()
Add a newline.p()
Add a paragraph separator.Add an inline@code
tag within a<pre></pre>
block.sp()
Add a non-trailing space.Add some text to the end of this comment.Add a type name to the end of this comment.Add a@value
inline tag.Methods inherited from class org.jboss.jdeparser.AbstractJComment
add, addItemDirectly, code, getContent, inlineDocTag, linkConstructor, linkField, linkMethod, linkMethod, linkType, write
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.jboss.jdeparser.JComment
code, inlineDocTag, linkConstructor, linkField, linkMethod, linkMethod, linkType
-
Constructor Details
-
AbstractJHtmlComment
AbstractJHtmlComment()
-
-
Method Details
-
add
-
block
Description copied from interface:JComment
Add a comment sub-block at this location. The block has no visual representation but allows text to be inserted at the point of the block even after more content was appended after it.- Specified by:
block
in interfaceJComment
- Specified by:
block
in interfaceJHtmlComment
- Overrides:
block
in classAbstractJComment
- Returns:
- the comment sub-block
-
sp
Description copied from interface:JComment
Add a non-trailing space. If no content follows, the space will be omitted.- Specified by:
sp
in interfaceJComment
- Specified by:
sp
in interfaceJHtmlComment
- Overrides:
sp
in classAbstractJComment
- Returns:
- this comment
-
nl
Description copied from interface:JComment
Add a newline.- Specified by:
nl
in interfaceJComment
- Specified by:
nl
in interfaceJHtmlComment
- Overrides:
nl
in classAbstractJComment
- Returns:
- this comment
-
typeName
Description copied from interface:JComment
Add a type name to the end of this comment. If the type is imported, it will emit as a simple name, otherwise it will emit as a qualified name.- Specified by:
typeName
in interfaceJComment
- Specified by:
typeName
in interfaceJHtmlComment
- Overrides:
typeName
in classAbstractJComment
- Parameters:
type
- the type name to add- Returns:
- this comment
-
text
Description copied from interface:JComment
Add some text to the end of this comment. No formatting or line breaks are inserted.- Specified by:
text
in interfaceJComment
- Specified by:
text
in interfaceJHtmlComment
- Overrides:
text
in classAbstractJComment
- Parameters:
text
- the text to add- Returns:
- this comment
-
inlineDocTag
Description copied from interface:JComment
Add an inline doc tag with simple content.- Specified by:
inlineDocTag
in interfaceJComment
- Specified by:
inlineDocTag
in interfaceJHtmlComment
- Overrides:
inlineDocTag
in classAbstractJComment
- Parameters:
tag
- the tag name (without the leading@
sign)body
- the complete tag body- Returns:
- this comment
-
docRoot
Description copied from interface:JComment
Add the{@docRoot}
tag at this position.- Specified by:
docRoot
in interfaceJComment
- Specified by:
docRoot
in interfaceJHtmlComment
- Overrides:
docRoot
in classAbstractJComment
- Returns:
- this comment
-
p
Description copied from interface:JHtmlComment
Add a paragraph separator.- Specified by:
p
in interfaceJHtmlComment
- Returns:
- this HTML comment
-
br
Description copied from interface:JHtmlComment
Add a line separator.- Specified by:
br
in interfaceJHtmlComment
- Returns:
- this HTML comment
-
value
Description copied from interface:JHtmlComment
Add a@value
inline tag.- Specified by:
value
in interfaceJHtmlComment
- Parameters:
type
- the value typefieldName
- the value field name- Returns:
- this HTML comment
-
htmlLink
Description copied from interface:JHtmlComment
Add an HTML link (<a>
tag).- Specified by:
htmlLink
in interfaceJHtmlComment
- Parameters:
url
- the URL to link to- Returns:
- the link tag body
-
htmlTag
Description copied from interface:JHtmlComment
Add an HTML tag. The given tag should be a valid HTML 4 or 5 tag.- Specified by:
htmlTag
in interfaceJHtmlComment
- Parameters:
tag
- the HTML tagnewLine
-true
to add a newline after the opening tag and before the closing tag- Returns:
- the tag body
-
preformattedCode
Description copied from interface:JHtmlComment
Add an inline@code
tag within a<pre></pre>
block.- Specified by:
preformattedCode
in interfaceJHtmlComment
- Returns:
- the preformatted code block content
-