Package org.jboss.jdeparser
Class AbstractJDocComment
java.lang.Object
org.jboss.jdeparser.AbstractJComment
org.jboss.jdeparser.AbstractJHtmlComment
org.jboss.jdeparser.AbstractJDocComment
- All Implemented Interfaces:
JComment
,JDocComment
,JHtmlComment
,Writable
- Direct Known Subclasses:
ImplJDocComment
,NestedDocCommentContent
-
Field Summary
FieldsFields 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 TypeMethodDescription_return()
Add a@return
tag.Add a@throws
tag.block()
Add a comment sub-block at this location.br()
Add a line separator.docRoot()
Add the{@docRoot}
tag at this position.Add a block tag.Add a block tag.(package private) Map<String,
List<DocTagJHtmlComment>> inlineDocTag
(String tag, String body) Add an inline doc tag with simple content.nl()
Add a newline.p()
Add a paragraph separator.Add a@param
tag.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.AbstractJHtmlComment
add, htmlLink, htmlTag, preformattedCode
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, linkConstructor, linkField, linkMethod, linkMethod, linkType
Methods inherited from interface org.jboss.jdeparser.JDocComment
inlineDocTag
Methods inherited from interface org.jboss.jdeparser.JHtmlComment
htmlLink, htmlTag, preformattedCode
-
Field Details
-
docTags
-
-
Constructor Details
-
AbstractJDocComment
AbstractJDocComment()
-
-
Method Details
-
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 interfaceJDocComment
- Specified by:
block
in interfaceJHtmlComment
- Overrides:
block
in classAbstractJHtmlComment
- 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 interfaceJDocComment
- Specified by:
sp
in interfaceJHtmlComment
- Overrides:
sp
in classAbstractJHtmlComment
- Returns:
- this comment
-
nl
Description copied from interface:JComment
Add a newline.- Specified by:
nl
in interfaceJComment
- Specified by:
nl
in interfaceJDocComment
- Specified by:
nl
in interfaceJHtmlComment
- Overrides:
nl
in classAbstractJHtmlComment
- 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 interfaceJDocComment
- Specified by:
typeName
in interfaceJHtmlComment
- Overrides:
typeName
in classAbstractJHtmlComment
- 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 interfaceJDocComment
- Specified by:
text
in interfaceJHtmlComment
- Overrides:
text
in classAbstractJHtmlComment
- 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 interfaceJDocComment
- Specified by:
inlineDocTag
in interfaceJHtmlComment
- Overrides:
inlineDocTag
in classAbstractJHtmlComment
- 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 interfaceJDocComment
- Specified by:
docRoot
in interfaceJHtmlComment
- Overrides:
docRoot
in classAbstractJHtmlComment
- Returns:
- this comment
-
p
Description copied from interface:JHtmlComment
Add a paragraph separator.- Specified by:
p
in interfaceJDocComment
- Specified by:
p
in interfaceJHtmlComment
- Overrides:
p
in classAbstractJHtmlComment
- Returns:
- this HTML comment
-
br
Description copied from interface:JHtmlComment
Add a line separator.- Specified by:
br
in interfaceJDocComment
- Specified by:
br
in interfaceJHtmlComment
- Overrides:
br
in classAbstractJHtmlComment
- Returns:
- this HTML comment
-
value
Description copied from interface:JHtmlComment
Add a@value
inline tag.- Specified by:
value
in interfaceJDocComment
- Specified by:
value
in interfaceJHtmlComment
- Overrides:
value
in classAbstractJHtmlComment
- Parameters:
type
- the value typefieldName
- the value field name- Returns:
- this HTML comment
-
docTag
Description copied from interface:JDocComment
Add a block tag.- Specified by:
docTag
in interfaceJDocComment
- Parameters:
tag
- the tag name- Returns:
- the block tag comment block
-
docTag
Description copied from interface:JDocComment
Add a block tag.- Specified by:
docTag
in interfaceJDocComment
- Parameters:
tag
- the tag namefirstWord
- the tag body first word- Returns:
- the block tag comment block
-
_return
Description copied from interface:JDocComment
Add a@return
tag.- Specified by:
_return
in interfaceJDocComment
- Returns:
- the tag body
-
_throws
Description copied from interface:JDocComment
Add a@throws
tag.- Specified by:
_throws
in interfaceJDocComment
- Parameters:
exceptionType
- the type of exception- Returns:
- the tag body
-
param
Description copied from interface:JDocComment
Add a@param
tag.- Specified by:
param
in interfaceJDocComment
- Parameters:
name
- the parameter name- Returns:
- the tag body
-
getDocTags
Map<String,List<DocTagJHtmlComment>> getDocTags()
-